@veriko-mx/sdk 0.4.3

package/dist/cjs/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,mEAAmE;AAEnE,OAAO,EAAiB,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EACL,OAAO,EACP,aAAa,EACb,OAAO,EACP,OAAO,EACP,SAAS,EACT,OAAO,EACP,QAAQ,EACR,KAAK,EACL,KAAK,EACL,WAAW,EACX,QAAQ,EACT,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,sBAAsB,EACtB,UAAU,EACV,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,gBAAgB,6BAA6B,CAAC;AAC3D,eAAO,MAAM,kBAAkB,QAAS,CAAC;AACzC,eAAO,MAAM,eAAe,mBAAmB,CAAC;AAChD,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAElD,oGAAoG;AACpG,eAAO,MAAM,OAAO,UAAU,CAAC;AAE/B,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qEAAqE;IACrE,KAAK,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IAEtC,kDAAkD;IAClD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,2DAA2D;IAC3D,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,+DAA+D;IAC/D,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,8CAA8C;IAC9C,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,sDAAsD;IACtD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,yBAAyB;IACzB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,kCAAkC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,yCAAyC;IACzC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAEd,OAAO,GAAE,aAAkB;IA+BvC,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;IAIrE;;;;;;;OAOG;IACH,aAAa,CACX,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,kBAAkB,CAAC;IAI9B;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,WAAW,CAAC;CAGzF"}

package/dist/cjs/client.js

@@ -0,0 +1,145 @@
+"use strict";
+/** El cliente: la entrada al SDK y las familias de operaciones. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Veriko = exports.VERSION = exports.BASE_URL_ENV_VAR = exports.API_KEY_ENV_VAR = exports.DEFAULT_TIMEOUT_MS = exports.DEFAULT_BASE_URL = void 0;
+const http_js_1 = require("./http.js");
+const resources_js_1 = require("./resources.js");
+exports.DEFAULT_BASE_URL = 'https://api.veriko.mx/v1';
+exports.DEFAULT_TIMEOUT_MS = 30_000;
+exports.API_KEY_ENV_VAR = 'VERIKO_API_KEY';
+exports.BASE_URL_ENV_VAR = 'VERIKO_BASE_URL';
+/** La versión que viaja en el `User-Agent`. `test/client.test.ts` la compara con `package.json`. */
+exports.VERSION = '0.4.3';
+/**
+ * Cliente de la API de Veriko.
+ *
+ * La clave de API se lee de `options.apiKey` o, si no se pasa, de la variable de
+ * entorno `VERIKO_API_KEY`. Empieza con `veriko_` y se obtiene en el panel:
+ * https://app.veriko.mx
+ *
+ * Las operaciones se agrupan por familia:
+ *
+ * - `client.validations`: validar, consultar, reintentar y descargar.
+ * - `client.webhooks`: endpoints y su historial de entregas.
+ * - `client.catalog`: bancos y estado del servicio de Banxico.
+ * - `client.beneficiaries`: cuentas guardadas y su importación masiva.
+ * - `client.usage`: cuota, límites y registro de actividad.
+ * - `client.account`: perfil y política de reintentos predeterminada.
+ * - `client.dashboard`: resumen del panel.
+ * - `client.plans`: catálogo y comparación de planes públicos.
+ * - `client.insights`: métricas agregadas de la cuenta.
+ * - `client.finance`: resúmenes y descargas financieras.
+ * - `client.billing`: suscripción activa.
+ *
+ * Las tres de uso más frecuente están también en la raíz, como atajo:
+ *
+ * ```ts
+ * const client = new Veriko();
+ *
+ * const validation = await client.validateTransfer({
+ *   fecha: '2025-03-15',
+ *   monto: 15000.5,
+ *   claveRastreo: 'MXBA20250315001234',
+ *   cuentaBeneficiaria: '012180004412345678',
+ * });
+ * ```
+ */
+class Veriko {
+    transport;
+    /** Validar, consultar, reintentar y descargar. */
+    validations;
+    /** Endpoints de webhook y su historial de entregas. */
+    webhooks;
+    /** Catálogo de bancos y estado del servicio de Banxico. */
+    catalog;
+    /** Cuentas beneficiarias guardadas y su importación masiva. */
+    beneficiaries;
+    /** Cuota, límites y registro de actividad. */
+    usage;
+    /** Perfil y preferencias de la cuenta autenticada. */
+    account;
+    /** Resumen del panel. */
+    dashboard;
+    /** Catálogo público de planes. */
+    plans;
+    /** Métricas agregadas de la cuenta. */
+    insights;
+    /** Resúmenes y descargas financieras. */
+    finance;
+    /** Suscripción activa de la cuenta. */
+    billing;
+    constructor(options = {}) {
+        const apiKey = options.apiKey ?? process.env[exports.API_KEY_ENV_VAR] ?? '';
+        const suffix = options.userAgentSuffix ? ` ${options.userAgentSuffix}` : '';
+        this.transport =
+            options.transport ??
+                new http_js_1.Transport({
+                    baseUrl: options.baseUrl ?? process.env[exports.BASE_URL_ENV_VAR] ?? exports.DEFAULT_BASE_URL,
+                    apiKey,
+                    timeoutMs: options.timeoutMs ?? exports.DEFAULT_TIMEOUT_MS,
+                    retry: {
+                        ...http_js_1.DEFAULT_RETRY,
+                        ...(options.maxRetries !== undefined ? { maxRetries: options.maxRetries } : {}),
+                        ...options.retry,
+                    },
+                    userAgent: `veriko-js/${exports.VERSION} (+https://github.com/veriko-mx-labs/veriko-js)${suffix}`,
+                    acceptLanguage: options.acceptLanguage,
+                });
+        this.validations = new resources_js_1.Validations(this.transport);
+        this.webhooks = new resources_js_1.Webhooks(this.transport);
+        this.catalog = new resources_js_1.Catalog(this.transport);
+        this.beneficiaries = new resources_js_1.Beneficiaries(this.transport);
+        this.usage = new resources_js_1.Usage(this.transport);
+        this.account = new resources_js_1.Account(this.transport);
+        this.dashboard = new resources_js_1.Dashboard(this.transport);
+        this.plans = new resources_js_1.Plans(this.transport);
+        this.insights = new resources_js_1.Insights(this.transport);
+        this.finance = new resources_js_1.Finance(this.transport);
+        this.billing = new resources_js_1.Billing(this.transport);
+    }
+    get baseUrl() {
+        return this.transport.baseUrl;
+    }
+    /**
+     * Atajo de `client.validations.validate()`.
+     *
+     * Valida una transferencia SPEI contra el CEP de Banxico. `POST /v1/validate`.
+     * Devuelve el veredicto en `attributes.status`: `valid`, `not_found`,
+     * `cep_unavailable`, `returned` o `error`.
+     *
+     * La operación exige `claveRastreo` o `referenciaNumerica`. Enviar las dos
+     * precisa la búsqueda. La fecha es la de envío, en `YYYY-MM-DD`.
+     *
+     * Un `not_found` inmediato no equivale a una transferencia inexistente: un
+     * CEP tarda en publicarse. `retryPolicy` deja a la API consultando de nuevo y
+     * avisando por webhook cuando el veredicto cambia.
+     *
+     * Cada llamada consume cuota del plan, y se descuenta al aceptar la petición.
+     */
+    validateTransfer(params) {
+        return this.validations.validate(params);
+    }
+    /**
+     * Atajo de `client.validations.get()`.
+     *
+     * Lee una validación por su identificador. `GET /v1/validations/{id}`. Es la
+     * operación con la que se sigue una validación que quedó reintentando: el
+     * veredicto final aparece cuando `attributes.status` alcanza un estado
+     * terminal.
+     */
+    getValidation(validationId, options = {}) {
+        return this.validations.get(validationId, options);
+    }
+    /**
+     * Atajo de `client.validations.cep()`.
+     *
+     * Descarga el CEP oficial de una validación. `GET /v1/validations/{id}/cep`.
+     * Devuelve el archivo: el XML que emitió Banxico, con su sello digital y su
+     * cadena original, o el PDF equivalente.
+     */
+    getCep(validationId, options = {}) {
+        return this.validations.cep(validationId, options);
+    }
+}
+exports.Veriko = Veriko;
+//# sourceMappingURL=client.js.map

package/dist/cjs/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";AAAA,mEAAmE;;;AAEnE,uCAAuE;AACvE,iDAYwB;AAUX,QAAA,gBAAgB,GAAG,0BAA0B,CAAC;AAC9C,QAAA,kBAAkB,GAAG,MAAM,CAAC;AAC5B,QAAA,eAAe,GAAG,gBAAgB,CAAC;AACnC,QAAA,gBAAgB,GAAG,iBAAiB,CAAC;AAElD,oGAAoG;AACvF,QAAA,OAAO,GAAG,OAAO,CAAC;AAuB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,MAAM;IACA,SAAS,CAAY;IAEtC,kDAAkD;IACzC,WAAW,CAAc;IAClC,uDAAuD;IAC9C,QAAQ,CAAW;IAC5B,2DAA2D;IAClD,OAAO,CAAU;IAC1B,+DAA+D;IACtD,aAAa,CAAgB;IACtC,8CAA8C;IACrC,KAAK,CAAQ;IACtB,sDAAsD;IAC7C,OAAO,CAAU;IAC1B,yBAAyB;IAChB,SAAS,CAAY;IAC9B,kCAAkC;IACzB,KAAK,CAAQ;IACtB,uCAAuC;IAC9B,QAAQ,CAAW;IAC5B,yCAAyC;IAChC,OAAO,CAAU;IAC1B,uCAAuC;IAC9B,OAAO,CAAU;IAE1B,YAAY,UAAyB,EAAE;QACrC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAe,CAAC,IAAI,EAAE,CAAC;QACpE,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,IAAI,CAAC,SAAS;YACZ,OAAO,CAAC,SAAS;gBACjB,IAAI,mBAAS,CAAC;oBACZ,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAgB,CAAC,IAAI,wBAAgB;oBAC7E,MAAM;oBACN,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,0BAAkB;oBAClD,KAAK,EAAE;wBACL,GAAG,uBAAa;wBAChB,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC/E,GAAG,OAAO,CAAC,KAAK;qBACjB;oBACD,SAAS,EAAE,aAAa,eAAO,kDAAkD,MAAM,EAAE;oBACzF,cAAc,EAAE,OAAO,CAAC,cAAc;iBACvC,CAAC,CAAC;QAEL,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,GAAG,IAAI,4BAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,IAAI,wBAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,MAA8B;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACX,YAAoB,EACpB,UAAgC,EAAE;QAElC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,YAAoB,EAAE,UAAkC,EAAE;QAC/D,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;CACF;AA1GD,wBA0GC"}

package/dist/cjs/errors.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Errores del SDK.
+ *
+ * La API devuelve los errores en un arreglo `errors`, y `code` es el campo estable
+ * de cada entrada. `detail` se traduce según `Accept-Language` y puede reformularse
+ * entre versiones. Por eso todas las excepciones exponen `code` y la
+ * lista completa de `errors`: ramificar sobre el texto es el error más silencioso
+ * al integrar esta API.
+ *
+ * @see https://docs.veriko.mx/es/concepts/errors
+ */
+/** Una entrada del arreglo `errors` de la API. */
+export interface ApiErrorEntry {
+    status?: string;
+    code?: string;
+    detail?: string;
+    source?: {
+        pointer?: string;
+    };
+    meta?: Record<string, unknown>;
+}
+/** Raíz de todo lo que lanza el SDK. */
+export declare class VerikoError extends Error {
+    constructor(message: string);
+}
+/** Falta la clave de API, o un argumento del cliente es inservible. */
+export declare class ConfigurationError extends VerikoError {
+}
+/** No hubo respuesta: DNS, TLS, socket o tiempo agotado, con los reintentos ya agotados. */
+export declare class ConnectionError extends VerikoError {
+    readonly attempts: number;
+    constructor(message: string, attempts: number, options?: {
+        cause?: unknown;
+    });
+}
+export interface ApiErrorInit {
+    status: number;
+    code?: string | undefined;
+    detail?: string | undefined;
+    pointer?: string | undefined;
+    errors?: ApiErrorEntry[] | undefined;
+    requestId?: string | undefined;
+    meta?: Record<string, unknown> | undefined;
+    headers?: Record<string, string> | undefined;
+}
+/** La API respondió, y la respuesta fue un error. */
+export declare class ApiError extends VerikoError {
+    /** Estado HTTP. */
+    readonly status: number;
+    /** `errors[0].code`, el contrato estable sobre el que ramificar. */
+    readonly code: string | undefined;
+    /** `errors[0].detail`, texto legible y traducido. */
+    readonly detail: string | undefined;
+    /** `errors[0].source.pointer` cuando el rechazo señala un campo. */
+    readonly pointer: string | undefined;
+    /** El arreglo completo. Un `422` trae una entrada por campo inválido. */
+    readonly errors: ApiErrorEntry[];
+    /** `meta.request_id`, el dato con el que se investiga un caso puntual. */
+    readonly requestId: string | undefined;
+    readonly meta: Record<string, unknown>;
+    /** Cabeceras de la respuesta, con el nombre en minúsculas. */
+    readonly headers: Record<string, string>;
+    constructor(message: string, init: ApiErrorInit);
+}
+/** `401`. Falta la clave de API o ya no es válida. */
+export declare class AuthenticationError extends ApiError {
+}
+/** `403`. Autenticado, pero sin permiso para esa operación. */
+export declare class ForbiddenError extends ApiError {
+}
+/** `404`. El recurso no existe, o el CEP no está disponible (`cep_not_available`). */
+export declare class NotFoundError extends ApiError {
+}
+/** `409`. Conflicto de estado; con `Idempotency-Key`, la petición anterior sigue en curso. */
+export declare class ConflictError extends ApiError {
+}
+/** `400`, `413` y `422`. La petición hay que corregirla antes de repetirla. */
+export declare class InvalidRequestError extends ApiError {
+}
+/** `429`. Límite de tasa superado, o cuota del plan agotada. */
+export declare class RateLimitError extends ApiError {
+    /**
+     * Segundos que la respuesta pide esperar, cuando los trae. Es el único dato
+     * necesario para reintentar sin adivinar.
+     */
+    readonly retryAfter: number | undefined;
+    constructor(message: string, init: ApiErrorInit & {
+        retryAfter?: number | undefined;
+    });
+}
+/** `5xx`. Admite reintento; el SDK ya lo hizo si quedaban intentos. */
+export declare class ServerError extends ApiError {
+}
+/** La firma de un webhook no cuadra con el cuerpo recibido. */
+export declare class SignatureVerificationError extends VerikoError {
+}
+/**
+ * `waitFor()` o `importWait()` agotaron su tiempo sin que el recurso llegara a un
+ * estado firme.
+ */
+export declare class TimeoutError extends VerikoError {
+    /** El recurso que se esperaba: una validación o una importación. */
+    readonly resourceId: string;
+    /** El tiempo de espera que se agotó, en milisegundos. */
+    readonly timeoutMs: number;
+    constructor(message: string, resourceId: string, timeoutMs: number);
+    /** Es `resourceId` cuando lo que se esperaba era una validación. */
+    get validationId(): string;
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/cjs/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,wCAAwC;AACxC,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM;CAI5B;AAED,uEAAuE;AACvE,qBAAa,kBAAmB,SAAQ,WAAW;CAAG;AAEtD,4FAA4F;AAC5F,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAEd,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;CAO7E;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,MAAM,CAAC,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;IACrC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CAC9C;AAED,qDAAqD;AACrD,qBAAa,QAAS,SAAQ,WAAW;IACvC,mBAAmB;IACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,qDAAqD;IACrD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,oEAAoE;IACpE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,yEAAyE;IACzE,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;IACjC,0EAA0E;IAC1E,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAE7B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;CAchD;AAED,sDAAsD;AACtD,qBAAa,mBAAoB,SAAQ,QAAQ;CAAG;AAEpD,+DAA+D;AAC/D,qBAAa,cAAe,SAAQ,QAAQ;CAAG;AAE/C,sFAAsF;AACtF,qBAAa,aAAc,SAAQ,QAAQ;CAAG;AAE9C,8FAA8F;AAC9F,qBAAa,aAAc,SAAQ,QAAQ;CAAG;AAE9C,+EAA+E;AAC/E,qBAAa,mBAAoB,SAAQ,QAAQ;CAAG;AAEpD,gEAAgE;AAChE,qBAAa,cAAe,SAAQ,QAAQ;IAC1C;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE5B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;CAItF;AAED,uEAAuE;AACvE,qBAAa,WAAY,SAAQ,QAAQ;CAAG;AAE5C,+DAA+D;AAC/D,qBAAa,0BAA2B,SAAQ,WAAW;CAAG;AAE9D;;;GAGG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C,oEAAoE;IACpE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAEf,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAMlE,oEAAoE;IACpE,IAAI,YAAY,IAAI,MAAM,CAEzB;CACF"}

package/dist/cjs/errors.js

@@ -0,0 +1,133 @@
+"use strict";
+/**
+ * Errores del SDK.
+ *
+ * La API devuelve los errores en un arreglo `errors`, y `code` es el campo estable
+ * de cada entrada. `detail` se traduce según `Accept-Language` y puede reformularse
+ * entre versiones. Por eso todas las excepciones exponen `code` y la
+ * lista completa de `errors`: ramificar sobre el texto es el error más silencioso
+ * al integrar esta API.
+ *
+ * @see https://docs.veriko.mx/es/concepts/errors
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeoutError = exports.SignatureVerificationError = exports.ServerError = exports.RateLimitError = exports.InvalidRequestError = exports.ConflictError = exports.NotFoundError = exports.ForbiddenError = exports.AuthenticationError = exports.ApiError = exports.ConnectionError = exports.ConfigurationError = exports.VerikoError = void 0;
+/** Raíz de todo lo que lanza el SDK. */
+class VerikoError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = new.target.name;
+    }
+}
+exports.VerikoError = VerikoError;
+/** Falta la clave de API, o un argumento del cliente es inservible. */
+class ConfigurationError extends VerikoError {
+}
+exports.ConfigurationError = ConfigurationError;
+/** No hubo respuesta: DNS, TLS, socket o tiempo agotado, con los reintentos ya agotados. */
+class ConnectionError extends VerikoError {
+    attempts;
+    constructor(message, attempts, options) {
+        super(message);
+        this.attempts = attempts;
+        if (options?.cause !== undefined) {
+            this.cause = options.cause;
+        }
+    }
+}
+exports.ConnectionError = ConnectionError;
+/** La API respondió, y la respuesta fue un error. */
+class ApiError extends VerikoError {
+    /** Estado HTTP. */
+    status;
+    /** `errors[0].code`, el contrato estable sobre el que ramificar. */
+    code;
+    /** `errors[0].detail`, texto legible y traducido. */
+    detail;
+    /** `errors[0].source.pointer` cuando el rechazo señala un campo. */
+    pointer;
+    /** El arreglo completo. Un `422` trae una entrada por campo inválido. */
+    errors;
+    /** `meta.request_id`, el dato con el que se investiga un caso puntual. */
+    requestId;
+    meta;
+    /** Cabeceras de la respuesta, con el nombre en minúsculas. */
+    headers;
+    constructor(message, init) {
+        const status = String(init.status);
+        const head = init.code ? `HTTP ${status} ${init.code}` : `HTTP ${status}`;
+        const suffix = init.requestId ? ` (request_id=${init.requestId})` : '';
+        super(`${head}: ${message}${suffix}`);
+        this.status = init.status;
+        this.code = init.code;
+        this.detail = init.detail;
+        this.pointer = init.pointer;
+        this.errors = init.errors ?? [];
+        this.requestId = init.requestId;
+        this.meta = init.meta ?? {};
+        this.headers = init.headers ?? {};
+    }
+}
+exports.ApiError = ApiError;
+/** `401`. Falta la clave de API o ya no es válida. */
+class AuthenticationError extends ApiError {
+}
+exports.AuthenticationError = AuthenticationError;
+/** `403`. Autenticado, pero sin permiso para esa operación. */
+class ForbiddenError extends ApiError {
+}
+exports.ForbiddenError = ForbiddenError;
+/** `404`. El recurso no existe, o el CEP no está disponible (`cep_not_available`). */
+class NotFoundError extends ApiError {
+}
+exports.NotFoundError = NotFoundError;
+/** `409`. Conflicto de estado; con `Idempotency-Key`, la petición anterior sigue en curso. */
+class ConflictError extends ApiError {
+}
+exports.ConflictError = ConflictError;
+/** `400`, `413` y `422`. La petición hay que corregirla antes de repetirla. */
+class InvalidRequestError extends ApiError {
+}
+exports.InvalidRequestError = InvalidRequestError;
+/** `429`. Límite de tasa superado, o cuota del plan agotada. */
+class RateLimitError extends ApiError {
+    /**
+     * Segundos que la respuesta pide esperar, cuando los trae. Es el único dato
+     * necesario para reintentar sin adivinar.
+     */
+    retryAfter;
+    constructor(message, init) {
+        super(message, init);
+        this.retryAfter = init.retryAfter;
+    }
+}
+exports.RateLimitError = RateLimitError;
+/** `5xx`. Admite reintento; el SDK ya lo hizo si quedaban intentos. */
+class ServerError extends ApiError {
+}
+exports.ServerError = ServerError;
+/** La firma de un webhook no cuadra con el cuerpo recibido. */
+class SignatureVerificationError extends VerikoError {
+}
+exports.SignatureVerificationError = SignatureVerificationError;
+/**
+ * `waitFor()` o `importWait()` agotaron su tiempo sin que el recurso llegara a un
+ * estado firme.
+ */
+class TimeoutError extends VerikoError {
+    /** El recurso que se esperaba: una validación o una importación. */
+    resourceId;
+    /** El tiempo de espera que se agotó, en milisegundos. */
+    timeoutMs;
+    constructor(message, resourceId, timeoutMs) {
+        super(message);
+        this.resourceId = resourceId;
+        this.timeoutMs = timeoutMs;
+    }
+    /** Es `resourceId` cuando lo que se esperaba era una validación. */
+    get validationId() {
+        return this.resourceId;
+    }
+}
+exports.TimeoutError = TimeoutError;
+//# sourceMappingURL=errors.js.map

package/dist/cjs/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAWH,wCAAwC;AACxC,MAAa,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;IAC9B,CAAC;CACF;AALD,kCAKC;AAED,uEAAuE;AACvE,MAAa,kBAAmB,SAAQ,WAAW;CAAG;AAAtD,gDAAsD;AAEtD,4FAA4F;AAC5F,MAAa,eAAgB,SAAQ,WAAW;IACrC,QAAQ,CAAS;IAE1B,YAAY,OAAe,EAAE,QAAgB,EAAE,OAA6B;QAC1E,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC7B,CAAC;IACH,CAAC;CACF;AAVD,0CAUC;AAaD,qDAAqD;AACrD,MAAa,QAAS,SAAQ,WAAW;IACvC,mBAAmB;IACV,MAAM,CAAS;IACxB,oEAAoE;IAC3D,IAAI,CAAqB;IAClC,qDAAqD;IAC5C,MAAM,CAAqB;IACpC,oEAAoE;IAC3D,OAAO,CAAqB;IACrC,yEAAyE;IAChE,MAAM,CAAkB;IACjC,0EAA0E;IACjE,SAAS,CAAqB;IAC9B,IAAI,CAA0B;IACvC,8DAA8D;IACrD,OAAO,CAAyB;IAEzC,YAAY,OAAe,EAAE,IAAkB;QAC7C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,MAAM,EAAE,CAAC;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,KAAK,CAAC,GAAG,IAAI,KAAK,OAAO,GAAG,MAAM,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IACpC,CAAC;CACF;AA/BD,4BA+BC;AAED,sDAAsD;AACtD,MAAa,mBAAoB,SAAQ,QAAQ;CAAG;AAApD,kDAAoD;AAEpD,+DAA+D;AAC/D,MAAa,cAAe,SAAQ,QAAQ;CAAG;AAA/C,wCAA+C;AAE/C,sFAAsF;AACtF,MAAa,aAAc,SAAQ,QAAQ;CAAG;AAA9C,sCAA8C;AAE9C,8FAA8F;AAC9F,MAAa,aAAc,SAAQ,QAAQ;CAAG;AAA9C,sCAA8C;AAE9C,+EAA+E;AAC/E,MAAa,mBAAoB,SAAQ,QAAQ;CAAG;AAApD,kDAAoD;AAEpD,gEAAgE;AAChE,MAAa,cAAe,SAAQ,QAAQ;IAC1C;;;OAGG;IACM,UAAU,CAAqB;IAExC,YAAY,OAAe,EAAE,IAAwD;QACnF,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACpC,CAAC;CACF;AAXD,wCAWC;AAED,uEAAuE;AACvE,MAAa,WAAY,SAAQ,QAAQ;CAAG;AAA5C,kCAA4C;AAE5C,+DAA+D;AAC/D,MAAa,0BAA2B,SAAQ,WAAW;CAAG;AAA9D,gEAA8D;AAE9D;;;GAGG;AACH,MAAa,YAAa,SAAQ,WAAW;IAC3C,oEAAoE;IAC3D,UAAU,CAAS;IAC5B,yDAAyD;IAChD,SAAS,CAAS;IAE3B,YAAY,OAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,oEAAoE;IACpE,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AAhBD,oCAgBC"}