SDK TinyERP (Olist)

Instalação Rápida ​

npm install sdk-tinyerp

yarn add sdk-tinyerp

pnpm add sdk-tinyerp

Exemplo de Uso ​

import TinySDK from "sdk-tinyerp";

const sdk = new TinySDK("seu-token-aqui");

// Obter informações da conta
const accountInfo = await sdk.account.getInfo();
console.log("Empresa:", accountInfo.razao_social);

// Pesquisar produtos
const products = await sdk.product.search("notebook", {
  situacao: "A", // Apenas ativos
  pagina: 1,
});

console.log(`Encontrados ${products.produtos.length} produtos`);
products.produtos.forEach((p) => {
  console.log(`${p.nome} - R$ ${p.preco}`);
});

// Criar um contato
const result = await sdk.contact.create([
  {
    sequencia: 1,
    contato: {
      nome: "João Silva",
      tipo_pessoa: "F",
      cpf_cnpj: "12345678901",
      email: "joao@example.com",
    },
  },
]);

if (result[0].status === "OK") {
  console.log("Contato criado com ID:", result[0].id);
}

Por Que Usar? ​

🎯 Foco em Developer Experience ​

O SDK TinyERP foi desenvolvido pensando na experiência do desenvolvedor:

• Autocomplete Inteligente: IntelliSense completo em todas as propriedades
• Validação em Tempo de Desenvolvimento: Erros de tipo detectados antes da execução
• Exemplos Inline: JSDoc com exemplos práticos em cada método
• Erros Descritivos: Mensagens claras e detalhadas quando algo dá errado

🔒 Confiável e Seguro ​

• Zero dependências externas = menos superfície de ataque
• Classe de erro customizada com todos os detalhes da API
• Testes unitários em todos os resources
• TypeScript strict mode habilitado

🚀 Produtivo ​

• Operações em lote para melhor performance
• Transformação automática de dados ("wrapping/unwrapping")
• Suporte a filtros avançados em pesquisas
• Paginação transparente

Recursos Disponíveis ​

Próximos Passos ​

Suporte ​

• 📖 Documentação Completa
• 🐛 Reportar Issues
• 💬 Discussões
• 📝 Changelog

Licença ​

Este projeto é um SDK não oficial e não possui afiliação com o TinyERP ou Olist.

Lançado sob a licença MIT.