@veriko-mx/sdk 0.4.3

package/dist/esm/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/esm/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/esm/errors.js

@@ -0,0 +1,117 @@
+/**
+ * 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
+ */
+/** Raíz de todo lo que lanza el SDK. */
+export class VerikoError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = new.target.name;
+    }
+}
+/** Falta la clave de API, o un argumento del cliente es inservible. */
+export class ConfigurationError extends VerikoError {
+}
+/** No hubo respuesta: DNS, TLS, socket o tiempo agotado, con los reintentos ya agotados. */
+export class ConnectionError extends VerikoError {
+    attempts;
+    constructor(message, attempts, options) {
+        super(message);
+        this.attempts = attempts;
+        if (options?.cause !== undefined) {
+            this.cause = options.cause;
+        }
+    }
+}
+/** La API respondió, y la respuesta fue un error. */
+export 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 ?? {};
+    }
+}
+/** `401`. Falta la clave de API o ya no es válida. */
+export class AuthenticationError extends ApiError {
+}
+/** `403`. Autenticado, pero sin permiso para esa operación. */
+export class ForbiddenError extends ApiError {
+}
+/** `404`. El recurso no existe, o el CEP no está disponible (`cep_not_available`). */
+export class NotFoundError extends ApiError {
+}
+/** `409`. Conflicto de estado; con `Idempotency-Key`, la petición anterior sigue en curso. */
+export class ConflictError extends ApiError {
+}
+/** `400`, `413` y `422`. La petición hay que corregirla antes de repetirla. */
+export class InvalidRequestError extends ApiError {
+}
+/** `429`. Límite de tasa superado, o cuota del plan agotada. */
+export 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;
+    }
+}
+/** `5xx`. Admite reintento; el SDK ya lo hizo si quedaban intentos. */
+export class ServerError extends ApiError {
+}
+/** La firma de un webhook no cuadra con el cuerpo recibido. */
+export class SignatureVerificationError extends VerikoError {
+}
+/**
+ * `waitFor()` o `importWait()` agotaron su tiempo sin que el recurso llegara a un
+ * estado firme.
+ */
+export 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;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/esm/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAWH,wCAAwC;AACxC,MAAM,OAAO,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;AAED,uEAAuE;AACvE,MAAM,OAAO,kBAAmB,SAAQ,WAAW;CAAG;AAEtD,4FAA4F;AAC5F,MAAM,OAAO,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;AAaD,qDAAqD;AACrD,MAAM,OAAO,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;AAED,sDAAsD;AACtD,MAAM,OAAO,mBAAoB,SAAQ,QAAQ;CAAG;AAEpD,+DAA+D;AAC/D,MAAM,OAAO,cAAe,SAAQ,QAAQ;CAAG;AAE/C,sFAAsF;AACtF,MAAM,OAAO,aAAc,SAAQ,QAAQ;CAAG;AAE9C,8FAA8F;AAC9F,MAAM,OAAO,aAAc,SAAQ,QAAQ;CAAG;AAE9C,+EAA+E;AAC/E,MAAM,OAAO,mBAAoB,SAAQ,QAAQ;CAAG;AAEpD,gEAAgE;AAChE,MAAM,OAAO,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;AAED,uEAAuE;AACvE,MAAM,OAAO,WAAY,SAAQ,QAAQ;CAAG;AAE5C,+DAA+D;AAC/D,MAAM,OAAO,0BAA2B,SAAQ,WAAW;CAAG;AAE9D;;;GAGG;AACH,MAAM,OAAO,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"}