SDK de Midaz para TypeScript

​

¿Por qué usar el Midaz SDK for TypeScript?

• Seguro por diseño: Construido con soporte completo de TypeScript y definiciones de tipo precisas.
• Builder pattern: Interfaces fluidas y legibles para ayudarte a construir objetos complejos con facilidad.
• Manejo robusto de errores: Estrategias de recuperación inteligentes y señales de error claras, para que mantengas el control.
• Observabilidad incluida: Tracing, métricas y logs, listos desde el inicio.
• Arquitectura en capas: Separación limpia entre cliente, entidades, API y modelos. Organizado, predecible, escalable.
• Reintentos automáticos: Maneja contratiempos transitorios con políticas de reintento configurables.
• Controles de concurrencia: Herramientas incorporadas para ejecutar tareas en paralelo, sin perder el control del throughput.
• Rápido con caché: Caché en memoria para mejorar el rendimiento donde cuenta.
• Validación estricta: Captura entrada inválida temprano con mensajes de error claros y accionables.

​

Empezando

​

Prerequisito

• El Midaz SDK for TypeScript requiere TypeScript v5.8 o posterior.

​

Instalando el SDK

npm install midaz-sdk

​

Autenticación

​

API key

const client = createClient({
  apiKey: 'your-api-key',
  environment: 'sandbox',
});

​

Autenticación con Access Manager

const client = createClient({
  accessManager: {
    enabled: true,
    address: 'https://auth.example.com',
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret',
  },
  environment: 'sandbox',
});

​

Guía de inicio rápido

​

Crear un cliente

import { createClient } from 'midaz-sdk';

const client = createClient({
  apiKey: 'your-api-key',
  environment: 'sandbox', // Options: 'development', 'sandbox', 'production'
});

​

Crear un Activo

import { createAssetBuilder } from '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);

​

Crear una Cuenta

import { createAccountBuilder } from '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);

​

Crear una Transacción

import { createTransactionBuilder } from '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();

​

Recuperación de errores

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

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

​

Limpiar recursos

client.close();

​

Usando Access Manager para autenticación

import { createClientConfigWithAccessManager, MidazClient } from '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();

​

Arquitectura del SDK

• Client interface: Este es el punto de entrada principal para los usuarios del SDK. Gestiona configuraciones como claves API y entornos, inicializa servicios de manera lazy y expone toda la funcionalidad disponible de manera unificada y descubrible.
• Entity services layer: Esta capa contiene servicios específicos de dominio (por ejemplo, Accounts, Assets y Transactions) y ofrece métodos consistentes para operaciones como create, get, update, delete y list. Además, se incluyen operaciones especializadas basadas en las necesidades específicas de cada entidad.
• Core services layer: Estas utilidades fundamentales son usadas por todos los servicios de entidades. Manejan solicitudes HTTP, validación de entrada, procesamiento de errores, observabilidad, configuración y caché.

Figura 1. La arquitectura en capas del Midaz SDK for TypeScript.

• Consistencia a través de patrones compartidos entre servicios.
• Escalabilidad vía inyección de dependencias y factories de servicio.
• Confiabilidad a través de manejo mejorado de errores y respuestas tipadas.
• Testabilidad con soporte para pruebas de mock, integración y contrato.

​

Builder pattern

• Te asisten informándote de los parámetros por adelantado.
• Te permiten modificar campos opcionales usando métodos .with*() y encadenarlos.
• Ayudan a evitar estados inválidos a través de una estructura guiada.
• Ocultan la complejidad interna, lo que conduce a mejor legibilidad.

​

Ejemplo

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

​

Trabajando con entidades

​

Usando utilidades

​

Manejo de errores

• code: Un identificador corto y consistente para el tipo de error.
• message: Una descripción legible para humanos.
• details: (Opcional) Contexto adicional o metadata.
• status: El código de estado HTTP, cuando esté disponible.

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

​

Códigos de error comunes

​

Mejores prácticas

• Valida entrada antes de llamar métodos del SDK para evitar invalid_input.
• Verifica autenticación cuando enfrentes unauthorized o forbidden.
• Reintenta en problemas transitorios como internal_error o service_unavailable.
• Usa details para mostrar información útil de depuración en logs de desarrollo.

​

Pipeline CI/CD

• Ejecuta pruebas en múltiples versiones de Node.js.
• Aplica calidad de código con ESLint y Prettier.
• Mantiene las dependencias actualizadas con Dependabot.
• Maneja releases automáticamente usando versionado semántico.
• Genera changelogs para transparencia completa.

​

¿Quieres contribuir?

​

Licencia