Midaz SDK para TypeScript

​

Por que usar o Midaz SDK para TypeScript?

• Type-safe por design: Construído com suporte completo a TypeScript e definições de tipos precisas.
• Builder pattern: Interfaces fluentes e legíveis para ajudar você a construir objetos complexos com facilidade.
• Tratamento de erros robusto: Estratégias de recuperação inteligentes e sinais de erro claros, para que você mantenha o controle.
• Observabilidade incluída: Tracing, métricas e logs, prontos para uso.
• Arquitetura em camadas: Separação clara entre client, entities, API e models. Organizado, previsível, escalável.
• Retries automáticos: Lide com falhas transitórias com políticas de retry configuráveis.
• Controles de concorrência: Ferramentas integradas para executar tarefas em paralelo sem perder o controle do throughput.
• Rápido com caching: Cache em memória para melhorar o desempenho onde mais importa.
• Validação rigorosa: Detecte inputs inválidos cedo com mensagens de erro claras e acionáveis.

​

Primeiros passos

​

Pré-requisito

• O Midaz SDK para TypeScript requer TypeScript v5.8 ou posterior.

​

Instalando o SDK

npm install @lerianstudio/midaz-sdk

yarn add @lerianstudio/midaz-sdk

​

Autenticação

​

Autenticação com Access Manager

import { createClientConfigWithAccessManager, MidazClient } from '@lerianstudio/midaz-sdk';

const client = new MidazClient(
  createClientConfigWithAccessManager({
    address: 'https://auth.example.com',
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret',
  }).withEnvironment('sandbox')
);

​

Desenvolvimento local (sem autenticação)

import { createClientConfigBuilder, MidazClient } from '@lerianstudio/midaz-sdk';

const client = new MidazClient(
  createClientConfigBuilder().withEnvironment('development')
);

​

Guia de início rápido

​

Crie um client

import { createClientConfigBuilder, MidazClient } from '@lerianstudio/midaz-sdk';

const client = new MidazClient(
  createClientConfigBuilder().withEnvironment('sandbox') // Options: 'development', 'sandbox', 'production'
);

​

Crie um Asset

import { createAssetBuilder } from '@lerianstudio/midaz-sdk';

const assetInput = createAssetBuilder('US Dollar', 'USD')
  .withType('currency')
  .withMetadata({ precision: 2, symbol: '$' })
  .build();

const asset = await client.entities.assets.createAsset('org_123', 'ledger_456', assetInput);

​

Crie uma Account

import { createAccountBuilder } from '@lerianstudio/midaz-sdk';

const accountInput = createAccountBuilder('Savings Account', 'USD')
  .withType('savings')
  .withAlias('personal-savings')
  .build();

const account = await client.entities.accounts.createAccount('org_123', 'ledger_456', accountInput);

​

Crie uma Transaction

import { createTransactionBuilder } from '@lerianstudio/midaz-sdk';

const transactionInput = createTransactionBuilder()
  .withCode('payment_001')
  .withOperations([
    {
      accountId: 'source_account_id',
      assetCode: 'USD',
      amount: 100 * 100, // $100.00
      type: 'debit',
    },
    {
      accountId: 'destination_account_id',
      assetCode: 'USD',
      amount: 100 * 100, // $100.00
      type: 'credit',
    },
  ])
  .withMetadata({ purpose: 'Monthly payment' })
  .build();

​

Recuperação de erros

import { withEnhancedRecovery } from '@lerianstudio/midaz-sdk/util/error';

const result = await withEnhancedRecovery(
  () => client.entities.transactions.createTransaction('org_123', 'ledger_456', transactionInput),
  {
    maxRetries: 3,
    enableSmartRecovery: true,
  }
);

​

Limpar recursos

client.close();

​

Usando Access Manager para autenticação

import { createClientConfigWithAccessManager, MidazClient } from '@lerianstudio/midaz-sdk';

// Initialize the client with Access Manager authentication
const client = new MidazClient(
  createClientConfigWithAccessManager({
    address: 'https://auth.example.com', // Identity provider address
    clientId: 'your-client-id', // OAuth client ID
    clientSecret: 'your-client-secret', // OAuth client secret
    tokenEndpoint: '/oauth/token', // Optional, defaults to '/oauth/token'
    refreshThresholdSeconds: 300, // Optional, defaults to 300 (5 minutes)
  })
    .withEnvironment('sandbox')
    .withApiVersion('v1')
);

// The SDK will automatically handle token acquisition and renewal
// You can now use the client as normal
const organizations = await client.entities.organizations.listOrganizations();

// For environment-specific configurations with Access Manager
const sandboxClient = new MidazClient(
  createSandboxConfigWithAccessManager({
    address: 'https://auth.example.com',
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret',
  })
);

// Clean up resources when done
client.close();

​

Arquitetura do SDK

• Interface do Client: Este é o ponto de entrada principal para os usuários do SDK. Ele gerencia configurações como API keys e ambientes, inicializa serviços de forma lazy e expõe toda a funcionalidade disponível de maneira unificada e descobrível.
• Camada de Entity Services: Esta camada contém serviços específicos de domínio (ex.: Accounts, Assets e Transactions) e oferece métodos consistentes para operações como create, get, update, delete e list. Além disso, operações especializadas são incluídas com base nas necessidades específicas de cada entidade.
• Camada de Core Services: Esses utilitários fundamentais são usados por todos os entity services. Eles lidam com requisições HTTP, validação de input, processamento de erros, observabilidade, configuração e caching.

• Consistência através de padrões compartilhados entre serviços.
• Escalabilidade via injeção de dependência e factories de serviços.
• Confiabilidade através de tratamento aprimorado de erros e respostas tipadas.
• Testabilidade com suporte para mocking, integração e testes de contrato.

​

Builder pattern

• Ajudam informando os parâmetros antecipadamente.
• Permitem modificar campos opcionais usando métodos .with*() e encadeá-los.
• Ajudam a evitar estados inválidos através de uma estrutura guiada.
• Ocultam complexidade interna, resultando em melhor legibilidade.

​

Exemplo

const assetInput = createAssetBuilder('USD Currency', 'USD')
  .withType('currency')
  .withMetadata({ precision: 2 })
  .build();

​

Trabalhando com entidades

​

Usando utilitários

​

Tratamento de erros

• code: Um identificador curto e consistente para o tipo de erro.
• message: Uma descrição legível.
• details: (Opcional) Contexto ou metadados adicionais.
• status: O código de status HTTP, quando disponível.

try {
  await client.transactions.create(transaction);
} catch (err) {
  console.error(`Error (${err.code}): ${err.message}`);
  // Optionally: inspect err.details or err.status
}

​

Códigos de erro comuns

​

Boas práticas

• Valide o input antes de chamar métodos do SDK para evitar invalid_input.
• Verifique a autenticação ao enfrentar unauthorized ou forbidden.
• Faça retry em problemas transitórios como internal_error ou service_unavailable.
• Use details para exibir informações úteis de depuração nos logs de desenvolvimento.

​

Pipeline CI/CD

• Executa testes em múltiplas versões do Node.js.
• Aplica qualidade de código com ESLint e Prettier.
• Mantém dependências atualizadas com Dependabot.
• Lida com releases automaticamente usando versionamento semântico.
• Gera changelogs para total transparência.

​

Quer contribuir?

​

Licença