Um SDK estabelece a fronteira entre um serviço e os aplicativos que o usam. Essa fronteira fica mais simples quando os objetos descrevem operações úteis, em vez de refletir a estrutura interna do armazenamento. O IaGenify SDK 0.2 deixa essa distinção mais clara para arquivos e armazenamento conectado.
Um arquivo é um recurso, não um caminho do servidor
Um aplicativo precisa identificar, ler, atualizar ou remover um arquivo. Não precisa saber em qual diretório de uma máquina do serviço seus bytes estão guardados. O objeto de arquivo usa seu identificador de origem e as operações compatíveis.
const file = await api.files.get(sourceId);
console.log(file.sourceId);
file.content = "Revised note";
await file.update();Identificadores estáveis tornam o código portátil. A mesma referência funciona em uma ferramenta local, interface web ou automação, sem conhecer o sistema de arquivos do servidor.
O armazenamento conectado oferece operações úteis
Um recurso de armazenamento conectado deve permitir que o aplicativo o utilize. O objeto público expõe sua identidade e as operações disponíveis; não é necessário inspecionar credenciais para listar ou usar o armazenamento.
const storage = await api.storage.get({ id: storageId });
console.log(storage.id);
const files = await storage.run({ action: "list", path: "/reports" });Assim, cada lado tem uma responsabilidade clara: o aplicativo escolhe a operação, e o serviço usa a conexão configurada para executá-la. O código não precisa copiar os dados da conexão para seu próprio estado.
Uma interface pública mais enxuta é mais fácil de manter
Se o SDK retorna detalhes internos, aplicativos podem depender deles mesmo que nunca tenham feito parte do contrato estável. Removê-los depois se torna uma quebra. Objetos mais focados facilitam documentar e evoluir o SDK entre runtimes.
Não se trata de esconder comportamentos úteis, mas de expô-los no nível certo: identificadores para recursos, métodos para operações compatíveis e resultados que o aplicativo possa usar.
O princípio por trás da versão 0.2
O IaGenify SDK 0.2 é uma versão pequena com um princípio importante: objetos públicos contêm o que o aplicativo precisa, sem exigir conhecimento dos detalhes internos do serviço.
Um SDK confiável oferece referências estáveis e ações claras, enquanto o serviço mantém o controle de sua implementação.
Perguntas frequentes
Por que usar um identificador em vez de um caminho de arquivo?
O identificador continua válido entre runtimes e mudanças no armazenamento; um caminho descreve apenas uma implementação.
O aplicativo precisa das credenciais do armazenamento conectado?
O serviço usa a conexão configurada. O aplicativo chama as operações sem copiar as credenciais.
O SDK 0.2 muda o conteúdo dos arquivos?
Não. Ele esclarece os objetos públicos e as referências usadas pelos aplicativos.
Qual é o princípio geral?
Manter o contrato do SDK focado em recursos identificáveis e operações compatíveis.