@eleva-io/erp-sdk 0.1.147 → 0.1.149

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

@@ -3,6 +3,7 @@ import { ErrorCode, type ErrorDetails } from './catalog';
 import { ErrorKind } from './catalog_types';
 import { BASE_ERROR_CODES } from './catalog_base';
 import { API_ERROR_CODES } from './catalog_api';
+/** Plain-object representation of an `ElevaError`, suitable for serialisation. */
 export interface ElevaErrorJSON<C extends ErrorCode = ErrorCode> {
     code: C | string;
     kind: ErrorKind;
@@ -10,83 +11,188 @@ export interface ElevaErrorJSON<C extends ErrorCode = ErrorCode> {
     message: string;
     details: ErrorDetails<C>;
 }
+/**
+ * Slim response payload for API consumers.
+ * `SYSTEM` errors omit `details`; `DOMAIN` errors include it.
+ */
 export interface ElevaErrorResponse<C extends ErrorCode = ErrorCode> {
     code: ElevaErrorJSON<C>['code'];
     message: ElevaErrorJSON<C>['message'];
     details?: ElevaErrorJSON<C>['details'];
 }
+/** Constructor arguments for `ElevaError`. Adds optional `cause` for error chaining. */
 export type ElevaErrorArgs<C extends ErrorCode> = ElevaErrorJSON<C> & {
+    /** The original error forwarded to `Error.cause`. */
     cause?: unknown;
 };
+/**
+ * Central error class for the Eleva ERP SDK.
+ *
+ * Extends `Error` with structured metadata: `code`, `kind`, `status`, and typed `details`.
+ *
+ * ```ts
+ * // Create
+ * throw ElevaError.notFound({ entity: 'Invoice' })
+ * throw ElevaError.conflict({ details: [{ key: 'email', value: 'a@b.com', cause: 'duplicate' }] })
+ *
+ * // Narrow
+ * if (err instanceof ElevaError && err.is(ERROR_CODES.NOT_FOUND)) {
+ *   console.log(err.details.entity) // string
+ * }
+ * ```
+ *
+ * Serialisation: `toJSON()` for logging, `toResponse()` for sanitised API output.
+ */
 export declare class ElevaError<C extends ErrorCode = ErrorCode> extends Error {
+    /** Error code constant identifying the failure condition. */
     readonly code: C | string;
+    /** `DOMAIN` (safe to expose) or `SYSTEM` (sanitised before sending to clients). */
     readonly kind: ErrorKind;
+    /** HTTP status code for this error. */
     readonly status: number;
+    /** Structured, code-specific failure context. */
     readonly details: ErrorDetails<C>;
     constructor(args: ElevaErrorArgs<C>);
-    is<K extends ErrorCode>(code: K): this is ElevaError<K>;
+    /**
+     * Type-guard: narrows to `ElevaError<K>` when `this.code === code`.
+     * After a positive check `this.details` is fully typed for `K`.
+     * @example
+     * if (err.is(ERROR_CODES.NOT_FOUND)) console.log(err.details.entity)
+     */
+    is<K extends ErrorCode>(code: K | string): this is ElevaError<K>;
+    /** Full serialised representation for logging / diagnostics. */
     toJSON(): ElevaErrorJSON<C>;
     toString(): string;
+    /**
+     * Sanitised payload safe for API responses.
+     * `SYSTEM` errors replace the message with a generic string; `DOMAIN` errors include `details`.
+     */
     toResponse(): ElevaErrorResponse<C>;
+    /**
+     * Parses an unknown value into `ElevaErrorArgs`. Shared by `parse()` and `RemoteElevaError.from()`.
+     *
+     * Strategy: validate against `errorSchema` → look up known codes in the catalog →
+     * fall back to `INTERNAL_SERVER_ERROR` for unrecognised codes or malformed payloads →
+     * accept legacy `errors` field as a fallback for `details`.
+     */
     protected static _parsePayload(value: unknown): ElevaErrorArgs<ErrorCode>;
+    /** Deserialises an unknown value into an `ElevaError`. Unrecognised payloads become `INTERNAL_SERVER_ERROR`. */
     static parse(value: unknown): ElevaError<ErrorCode>;
+    /** Converts a `ZodError` into a `VALIDATION` error, preserving field paths and rule codes. */
     static fromZodError<T>(error: z.ZodError<T>): ElevaError<BASE_ERROR_CODES.VALIDATION>;
+    /** Creates a `VALIDATION` error from a pre-built array of issue descriptors. */
     static validation(args: {
         errors: ErrorDetails<BASE_ERROR_CODES.VALIDATION>['errors'];
         message?: string;
     }): ElevaError<BASE_ERROR_CODES.VALIDATION>;
+    /** Creates a `VALIDATION` error for a single invalid field. Convenience wrapper around `validation()`. */
     static invalidField(args: {
         error: ErrorDetails<BASE_ERROR_CODES.VALIDATION>['errors'][number];
         message?: string;
     }): ElevaError<BASE_ERROR_CODES.VALIDATION>;
-    static badRequest(args?: {
+    /** HTTP 400 — request is malformed or has invalid parameters outside of validation. */
+    static readonly badRequest: (args?: {
         message?: string;
-        details?: ErrorDetails<BASE_ERROR_CODES.BAD_REQUEST>;
-    }): ElevaError<BASE_ERROR_CODES.BAD_REQUEST>;
-    static authentication(args?: {
+        details?: {
+            field?: string | undefined;
+            reason?: string | undefined;
+        } | undefined;
+    } | undefined) => ElevaError<BASE_ERROR_CODES.BAD_REQUEST>;
+    /** HTTP 401 — credentials are missing, expired, or invalid. Caller must re-authenticate. */
+    static readonly authentication: (args?: {
         message?: string;
-        details?: ErrorDetails<BASE_ERROR_CODES.AUTHENTICATION>;
-    }): ElevaError<BASE_ERROR_CODES.AUTHENTICATION>;
-    static unauthorized(args?: {
+        details?: {
+            reason?: string | undefined;
+        } | undefined;
+    } | undefined) => ElevaError<BASE_ERROR_CODES.AUTHENTICATION>;
+    /** HTTP 403 — authenticated but lacks the required scope or permission. */
+    static readonly unauthorized: (args?: {
         message?: string;
-        details?: ErrorDetails<BASE_ERROR_CODES.UNAUTHORIZED>;
-    }): ElevaError<BASE_ERROR_CODES.UNAUTHORIZED>;
-    static notFound(args: {
-        entity: string;
+        details?: {
+            requiredScope?: string | undefined;
+            resource?: string | undefined;
+        } | undefined;
+    } | undefined) => ElevaError<BASE_ERROR_CODES.UNAUTHORIZED>;
+    /**
+     * HTTP 404 — no resource found for the given identifier.
+     * @param args.entity - Entity type that was not found (e.g. `"Invoice"`).
+     */
+    static readonly notFound: (args: Record<"entity", string> & {
         message?: string;
-    }): ElevaError<BASE_ERROR_CODES.NOT_FOUND>;
-    static notAcceptable(args?: {
+    }) => ElevaError<BASE_ERROR_CODES.NOT_FOUND>;
+    /** HTTP 406 — server cannot produce a response matching the `Accept` header. */
+    static readonly notAcceptable: (args?: {
         message?: string;
-        details?: ErrorDetails<BASE_ERROR_CODES.NOT_ACCEPTABLE>;
-    }): ElevaError<BASE_ERROR_CODES.NOT_ACCEPTABLE>;
-    static conflict(args: {
-        details: ErrorDetails<BASE_ERROR_CODES.CONFLICT>;
+        details?: {
+            acceptedTypes?: string[] | undefined;
+        } | undefined;
+    } | undefined) => ElevaError<BASE_ERROR_CODES.NOT_ACCEPTABLE>;
+    /** HTTP 409 — operation violates a uniqueness or integrity constraint. */
+    static readonly conflict: (args: {
+        details: {
+            value: string;
+            key: string;
+            cause: string;
+        }[];
         message?: string;
-    }): ElevaError<BASE_ERROR_CODES.CONFLICT>;
-    static gone(args?: {
+    }) => ElevaError<BASE_ERROR_CODES.CONFLICT>;
+    /** HTTP 410 — resource permanently removed; retrying will never succeed. */
+    static readonly gone: (args?: {
         message?: string;
-        details?: ErrorDetails<BASE_ERROR_CODES.GONE>;
-    }): ElevaError<BASE_ERROR_CODES.GONE>;
-    static unprocessableEntity(args?: {
+        details?: {
+            since?: string | undefined;
+        } | undefined;
+    } | undefined) => ElevaError<BASE_ERROR_CODES.GONE>;
+    /** HTTP 422 — request is syntactically valid but semantically unprocessable. */
+    static readonly unprocessableEntity: (args?: {
         message?: string;
-        details?: ErrorDetails<BASE_ERROR_CODES.UNPROCESSABLE_ENTITY>;
-    }): ElevaError<BASE_ERROR_CODES.UNPROCESSABLE_ENTITY>;
-    static serviceUnavailable(args?: {
+        details?: {
+            field?: string | undefined;
+            reason?: string | undefined;
+        } | undefined;
+    } | undefined) => ElevaError<BASE_ERROR_CODES.UNPROCESSABLE_ENTITY>;
+    /**
+     * HTTP 502 — upstream service returned an invalid response (`SYSTEM`).
+     * @param args.details.upstream - Name of the misbehaving upstream service.
+     */
+    static readonly badGateway: (args?: {
         message?: string;
-        details?: ErrorDetails<BASE_ERROR_CODES.SERVICE_UNAVAILABLE>;
-    }): ElevaError<BASE_ERROR_CODES.SERVICE_UNAVAILABLE>;
-    static mandatoryField(args: {
-        field: string;
+        details?: {
+            upstream?: string | undefined;
+        } | undefined;
+    } | undefined) => ElevaError<BASE_ERROR_CODES.BAD_GATEWAY>;
+    /** HTTP 503 — service temporarily unavailable (`SYSTEM`). Pass `retryAfter` (seconds) if known. */
+    static readonly serviceUnavailable: (args?: {
         message?: string;
-    }): ElevaError<BASE_ERROR_CODES.MANDATORY_FIELD>;
+        details?: {
+            retryAfter?: number | undefined;
+        } | undefined;
+    } | undefined) => ElevaError<BASE_ERROR_CODES.SERVICE_UNAVAILABLE>;
+    /**
+     * HTTP 400 — a required field was missing from the request.
+     * @param args.field - Name of the missing field.
+     */
+    static readonly mandatoryField: (args: Record<"field", string> & {
+        message?: string;
+    }) => ElevaError<BASE_ERROR_CODES.MANDATORY_FIELD>;
+    /**
+     * HTTP 500 — unexpected server error (`SYSTEM`).
+     * Pass the original exception as `cause` to preserve the full stack chain for logging.
+     */
     static internal(args?: {
         message?: string;
         cause?: unknown;
         details?: ErrorDetails<BASE_ERROR_CODES.INTERNAL_SERVER_ERROR>;
     }): ElevaError<BASE_ERROR_CODES.INTERNAL_SERVER_ERROR>;
-    static forbiddenContact(args: {
+    /**
+     * HTTP 403 — caller is not authorised to access the given contact person.
+     * @param args.details.contactId - UUID of the blocked contact.
+     */
+    static readonly forbiddenContact: (args: {
+        details: {
+            contactId: string;
+        };
         message?: string;
-        details: ErrorDetails<API_ERROR_CODES.FORBIDDEN_CONTACT>;
-    }): ElevaError<API_ERROR_CODES.FORBIDDEN_CONTACT>;
+    }) => ElevaError<API_ERROR_CODES>;
 }
 //# sourceMappingURL=errors.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/errors/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAA+B,SAAS,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAA;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAe/C,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC7D,IAAI,EAAE,CAAC,GAAG,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;CACzB;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IACjE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;IAC/B,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IACrC,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;CACvC;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG;IACpE,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAsBD,qBAAa,UAAU,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,KAAK;IACpE,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,MAAM,CAAA;IAEzB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IAExB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IAEvB,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;gBAErB,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;IAcnC,EAAE,CAAC,CAAC,SAAS,SAAS,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC;IAIvD,MAAM,IAAI,cAAc,CAAC,CAAC,CAAC;IAU3B,QAAQ,IAAI,MAAM;IAIlB,UAAU,IAAI,kBAAkB,CAAC,CAAC,CAAC;IAgBnC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC;IA8BzE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC;IAInD,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC;IAcrF,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE;QACtB,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAA;QAC3D,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,GAAG,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC;IAO3C,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE;QACxB,KAAK,EAAE,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAA;QAClE,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,GAAG,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC;IAI3C,MAAM,CAAC,UAAU,CACf,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;KAAO,GACpF,UAAU,CAAC,gBAAgB,CAAC,WAAW,CAAC;IAO3C,MAAM,CAAC,cAAc,CACnB,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAA;KAAO,GACvF,UAAU,CAAC,gBAAgB,CAAC,cAAc,CAAC;IAO9C,MAAM,CAAC,YAAY,CACjB,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAA;KAAO,GACrF,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAO5C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,UAAU,CAAC,gBAAgB,CAAC,SAAS,CAAC;IAOnG,MAAM,CAAC,aAAa,CAClB,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAA;KAAO,GACvF,UAAU,CAAC,gBAAgB,CAAC,cAAc,CAAC;IAO9C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;QACpB,OAAO,EAAE,YAAY,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;QAChD,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,GAAG,UAAU,CAAC,gBAAgB,CAAC,QAAQ,CAAC;IAOzC,MAAM,CAAC,IAAI,CACT,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;KAAO,GAC7E,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC;IAOpC,MAAM,CAAC,mBAAmB,CACxB,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAA;KAAO,GAC7F,UAAU,CAAC,gBAAgB,CAAC,oBAAoB,CAAC;IAOpD,MAAM,CAAC,kBAAkB,CACvB,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAA;KAAO,GAC5F,UAAU,CAAC,gBAAgB,CAAC,mBAAmB,CAAC;IAOnD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,UAAU,CAAC,gBAAgB,CAAC,eAAe,CAAC;IAO9G,MAAM,CAAC,QAAQ,CACb,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAA;KAAO,GAC/G,UAAU,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;IAQrD,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE;QAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,YAAY,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAA;KACzD,GAAG,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAAC;CAMlD"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/errors/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAA+B,SAAS,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAA;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAuB/C,kFAAkF;AAClF,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC7D,IAAI,EAAE,CAAC,GAAG,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IACjE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;IAC/B,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IACrC,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;CACvC;AAED,wFAAwF;AACxF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG;IACpE,qDAAqD;IACrD,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AA4DD;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,UAAU,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,KAAK;IACpE,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,MAAM,CAAA;IAEzB,mFAAmF;IACnF,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IAExB,uCAAuC;IACvC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IAEvB,iDAAiD;IACjD,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;gBAErB,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;IAenC;;;;;OAKG;IACH,EAAE,CAAC,CAAC,SAAS,SAAS,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC;IAIhE,gEAAgE;IAChE,MAAM,IAAI,cAAc,CAAC,CAAC,CAAC;IAU3B,QAAQ,IAAI,MAAM;IAIlB;;;OAGG;IACH,UAAU,IAAI,kBAAkB,CAAC,CAAC,CAAC;IAenC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC;IA8BzE,gHAAgH;IAChH,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC;IAInD,8FAA8F;IAC9F,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC;IAUrF,gFAAgF;IAChF,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE;QACtB,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAA;QAC3D,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,GAAG,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC;IAO3C,0GAA0G;IAC1G,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE;QACxB,KAAK,EAAE,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAA;QAClE,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,GAAG,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC;IAI3C,uFAAuF;IACvF,MAAM,CAAC,QAAQ,CAAC,UAAU;kBA/LJ,MAAM;;;;;+DA+L+C;IAE3E,4FAA4F;IAC5F,MAAM,CAAC,QAAQ,CAAC,cAAc;kBAlMR,MAAM;;;;kEAkMsD;IAElF,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,CAAC,YAAY;kBArMN,MAAM;;;;;gEAqMkD;IAE9E;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,QAAQ;kBA/LiB,MAAM;iDA+LoC;IAEnF,gFAAgF;IAChF,MAAM,CAAC,QAAQ,CAAC,aAAa;kBA9MP,MAAM;;;;kEA8MqD;IAEjF,0EAA0E;IAC1E,MAAM,CAAC,QAAQ,CAAC,QAAQ;;;;;;kBA1LuB,MAAM;gDA0LwB;IAE7E,4EAA4E;IAC5E,MAAM,CAAC,QAAQ,CAAC,IAAI;kBApNE,MAAM;;;;wDAoNkC;IAE9D,gFAAgF;IAChF,MAAM,CAAC,QAAQ,CAAC,mBAAmB;kBAvNb,MAAM;;;;;wEAuNiE;IAE7F;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAU;kBA7NJ,MAAM;;;;+DA6N+C;IAE3E,mGAAmG;IACnG,MAAM,CAAC,QAAQ,CAAC,kBAAkB;kBAhOZ,MAAM;;;;uEAgO+D;IAE3F;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc;kBA1NW,MAAM;uDA0N+C;IAE9F;;;OAGG;IACH,MAAM,CAAC,QAAQ,CACb,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAA;KAAO,GAC/G,UAAU,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;IAQrD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB;;;;kBAnOe,MAAM;sCAmOwC;CAC9F"}

package/dist/cjs/errors/errors.js

@@ -6,6 +6,11 @@ const catalog_1 = require("./catalog");
 const catalog_types_1 = require("./catalog_types");
 const catalog_base_1 = require("./catalog_base");
 const catalog_api_1 = require("./catalog_api");
+/**
+ * Permissive schema for parsing unknown error payloads. All fields except `code`
+ * are optional so malformed responses always produce a valid result.
+ * `errors` is the legacy name for `details` (kept for backwards compatibility).
+ */
 const errorSchema = zod_1.z.object({
     code: zod_1.z.string(),
     kind: zod_1.z.string().optional(),
@@ -15,8 +20,14 @@ const errorSchema = zod_1.z.object({
     /** @deprecated Use `details` instead */
     errors: zod_1.z.unknown().optional(),
 });
+/** Pre-computed set of all valid error code strings for O(1) membership checks. */
 const KNOWN_CODES = new Set(Object.keys(catalog_1.ERROR_CODES));
+/** Pre-computed set of all valid `ErrorKind` values for O(1) membership checks. */
 const VALID_KINDS = new Set(Object.values(catalog_types_1.ErrorKind));
+/**
+ * Looks up the catalog entry for `code` and builds an `ElevaError`.
+ * Module-private — use the static factory methods on `ElevaError` instead.
+ */
 const _newElevaErrorFromCode = (code, args) => {
     const entry = catalog_1.ERRORS_CATALOG[code];
     return new ElevaError({
@@ -28,10 +39,53 @@ const _newElevaErrorFromCode = (code, args) => {
         cause: args.cause,
     });
 };
+/**
+ * Factory for codes whose `details` are entirely optional (every field is `.partial()`).
+ * Returns a function with signature `(args?: { message?, details? }) => ElevaError<C>`.
+ */
+const _optionalFactory = (code) => {
+    return (args = {}) => _newElevaErrorFromCode(code, { details: args.details ?? {}, message: args.message });
+};
+/**
+ * Factory for codes where `details` is built from a single required string argument.
+ * The argument key mirrors the `details` key (e.g. `'entity'` → `{ entity }`).
+ */
+const _namedFieldFactory = (code, key) => {
+    return (args) => _newElevaErrorFromCode(code, { details: { [key]: args[key] }, message: args.message });
+};
+/**
+ * Factory for codes where `details` is required and passed through directly.
+ * Returns a function with signature `(args: { details, message? }) => ElevaError<C>`.
+ */
+const _requiredDetailsFactory = (code) => {
+    return (args) => _newElevaErrorFromCode(code, { details: args.details, message: args.message });
+};
+/**
+ * Central error class for the Eleva ERP SDK.
+ *
+ * Extends `Error` with structured metadata: `code`, `kind`, `status`, and typed `details`.
+ *
+ * ```ts
+ * // Create
+ * throw ElevaError.notFound({ entity: 'Invoice' })
+ * throw ElevaError.conflict({ details: [{ key: 'email', value: 'a@b.com', cause: 'duplicate' }] })
+ *
+ * // Narrow
+ * if (err instanceof ElevaError && err.is(ERROR_CODES.NOT_FOUND)) {
+ *   console.log(err.details.entity) // string
+ * }
+ * ```
+ *
+ * Serialisation: `toJSON()` for logging, `toResponse()` for sanitised API output.
+ */
 class ElevaError extends Error {
+    /** Error code constant identifying the failure condition. */
     code;
+    /** `DOMAIN` (safe to expose) or `SYSTEM` (sanitised before sending to clients). */
     kind;
+    /** HTTP status code for this error. */
     status;
+    /** Structured, code-specific failure context. */
     details;
     constructor(args) {
         super(args.message, { cause: args.cause });
@@ -40,13 +94,21 @@ class ElevaError extends Error {
         this.kind = args.kind;
         this.status = args.status;
         this.details = args.details;
+        // Removes the constructor frame from V8 stack traces.
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
     }
+    /**
+     * Type-guard: narrows to `ElevaError<K>` when `this.code === code`.
+     * After a positive check `this.details` is fully typed for `K`.
+     * @example
+     * if (err.is(ERROR_CODES.NOT_FOUND)) console.log(err.details.entity)
+     */
     is(code) {
         return this.code === code;
     }
+    /** Full serialised representation for logging / diagnostics. */
     toJSON() {
         return {
             code: this.code,
@@ -57,8 +119,12 @@ class ElevaError extends Error {
         };
     }
     toString() {
-        return JSON.stringify(this.toJSON());
+        return JSON.stringify(this);
     }
+    /**
+     * Sanitised payload safe for API responses.
+     * `SYSTEM` errors replace the message with a generic string; `DOMAIN` errors include `details`.
+     */
     toResponse() {
         const resp = {
             code: this.code,
@@ -67,11 +133,18 @@ class ElevaError extends Error {
         if (this.kind === catalog_types_1.ErrorKind.SYSTEM) {
             resp.message = 'Houston, we have a problem';
         }
-        if (this.kind === catalog_types_1.ErrorKind.DOMAIN) {
+        else if (this.kind === catalog_types_1.ErrorKind.DOMAIN) {
             resp.details = this.details;
         }
         return resp;
     }
+    /**
+     * Parses an unknown value into `ElevaErrorArgs`. Shared by `parse()` and `RemoteElevaError.from()`.
+     *
+     * Strategy: validate against `errorSchema` → look up known codes in the catalog →
+     * fall back to `INTERNAL_SERVER_ERROR` for unrecognised codes or malformed payloads →
+     * accept legacy `errors` field as a fallback for `details`.
+     */
     static _parsePayload(value) {
         const result = errorSchema.safeParse(value);
         if (!result.success) {
@@ -98,90 +171,65 @@ class ElevaError extends Error {
             details: (result.data.details ?? result.data.errors ?? {}),
         };
     }
+    /** Deserialises an unknown value into an `ElevaError`. Unrecognised payloads become `INTERNAL_SERVER_ERROR`. */
     static parse(value) {
         return new ElevaError(ElevaError._parsePayload(value));
     }
+    /** Converts a `ZodError` into a `VALIDATION` error, preserving field paths and rule codes. */
     static fromZodError(error) {
         const errors = error.issues.map((issue) => {
             const path = issue.path.map(String);
-            return {
-                validation: path.join('.') || 'root',
-                code: issue.code,
-                message: issue.message,
-                path,
-            };
+            const validation = path.join('.') || 'root';
+            return { validation, code: issue.code, message: issue.message, path };
         });
         return ElevaError.validation({ errors, message: error.message });
     }
+    /** Creates a `VALIDATION` error from a pre-built array of issue descriptors. */
     static validation(args) {
         return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.VALIDATION, {
             details: { errors: args.errors },
             message: args.message,
         });
     }
+    /** Creates a `VALIDATION` error for a single invalid field. Convenience wrapper around `validation()`. */
     static invalidField(args) {
         return ElevaError.validation({ errors: [args.error], message: args.message });
     }
-    static badRequest(args = {}) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.BAD_REQUEST, {
-            details: args.details ?? {},
-            message: args.message,
-        });
-    }
-    static authentication(args = {}) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.AUTHENTICATION, {
-            details: args.details ?? {},
-            message: args.message,
-        });
-    }
-    static unauthorized(args = {}) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.UNAUTHORIZED, {
-            details: args.details ?? {},
-            message: args.message,
-        });
-    }
-    static notFound(args) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.NOT_FOUND, {
-            details: { entity: args.entity },
-            message: args.message,
-        });
-    }
-    static notAcceptable(args = {}) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.NOT_ACCEPTABLE, {
-            details: args.details ?? {},
-            message: args.message,
-        });
-    }
-    static conflict(args) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.CONFLICT, {
-            details: args.details,
-            message: args.message,
-        });
-    }
-    static gone(args = {}) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.GONE, {
-            details: args.details ?? {},
-            message: args.message,
-        });
-    }
-    static unprocessableEntity(args = {}) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.UNPROCESSABLE_ENTITY, {
-            details: args.details ?? {},
-            message: args.message,
-        });
-    }
-    static serviceUnavailable(args = {}) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.SERVICE_UNAVAILABLE, {
-            details: args.details ?? {},
-            message: args.message,
-        });
-    }
-    static mandatoryField(args) {
-        return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.MANDATORY_FIELD, {
-            details: { field: args.field },
-            message: args.message,
-        });
-    }
+    /** HTTP 400 — request is malformed or has invalid parameters outside of validation. */
+    static badRequest = _optionalFactory(catalog_base_1.BASE_ERROR_CODES.BAD_REQUEST);
+    /** HTTP 401 — credentials are missing, expired, or invalid. Caller must re-authenticate. */
+    static authentication = _optionalFactory(catalog_base_1.BASE_ERROR_CODES.AUTHENTICATION);
+    /** HTTP 403 — authenticated but lacks the required scope or permission. */
+    static unauthorized = _optionalFactory(catalog_base_1.BASE_ERROR_CODES.UNAUTHORIZED);
+    /**
+     * HTTP 404 — no resource found for the given identifier.
+     * @param args.entity - Entity type that was not found (e.g. `"Invoice"`).
+     */
+    static notFound = _namedFieldFactory(catalog_base_1.BASE_ERROR_CODES.NOT_FOUND, 'entity');
+    /** HTTP 406 — server cannot produce a response matching the `Accept` header. */
+    static notAcceptable = _optionalFactory(catalog_base_1.BASE_ERROR_CODES.NOT_ACCEPTABLE);
+    /** HTTP 409 — operation violates a uniqueness or integrity constraint. */
+    static conflict = _requiredDetailsFactory(catalog_base_1.BASE_ERROR_CODES.CONFLICT);
+    /** HTTP 410 — resource permanently removed; retrying will never succeed. */
+    static gone = _optionalFactory(catalog_base_1.BASE_ERROR_CODES.GONE);
+    /** HTTP 422 — request is syntactically valid but semantically unprocessable. */
+    static unprocessableEntity = _optionalFactory(catalog_base_1.BASE_ERROR_CODES.UNPROCESSABLE_ENTITY);
+    /**
+     * HTTP 502 — upstream service returned an invalid response (`SYSTEM`).
+     * @param args.details.upstream - Name of the misbehaving upstream service.
+     */
+    static badGateway = _optionalFactory(catalog_base_1.BASE_ERROR_CODES.BAD_GATEWAY);
+    /** HTTP 503 — service temporarily unavailable (`SYSTEM`). Pass `retryAfter` (seconds) if known. */
+    static serviceUnavailable = _optionalFactory(catalog_base_1.BASE_ERROR_CODES.SERVICE_UNAVAILABLE);
+    /**
+     * HTTP 400 — a required field was missing from the request.
+     * @param args.field - Name of the missing field.
+     */
+    static mandatoryField = _namedFieldFactory(catalog_base_1.BASE_ERROR_CODES.MANDATORY_FIELD, 'field');
+    /**
+     * HTTP 500 — unexpected server error (`SYSTEM`).
+     * Pass the original exception as `cause` to preserve the full stack chain for logging.
+     */
     static internal(args = {}) {
         return _newElevaErrorFromCode(catalog_base_1.BASE_ERROR_CODES.INTERNAL_SERVER_ERROR, {
             details: args.details ?? {},
@@ -189,12 +237,11 @@ class ElevaError extends Error {
             cause: args.cause,
         });
     }
-    static forbiddenContact(args) {
-        return _newElevaErrorFromCode(catalog_api_1.API_ERROR_CODES.FORBIDDEN_CONTACT, {
-            details: args.details,
-            message: args.message,
-        });
-    }
+    /**
+     * HTTP 403 — caller is not authorised to access the given contact person.
+     * @param args.details.contactId - UUID of the blocked contact.
+     */
+    static forbiddenContact = _requiredDetailsFactory(catalog_api_1.API_ERROR_CODES.FORBIDDEN_CONTACT);
 }
 exports.ElevaError = ElevaError;
 //# sourceMappingURL=errors.js.map

package/dist/cjs/errors/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/errors/errors.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AACvB,uCAAqF;AACrF,mDAA2C;AAC3C,iDAAiD;AACjD,+CAA+C;AAE/C,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,wCAAwC;IACxC,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAA;AAEF,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAW,CAAC,CAAC,CAAA;AACrD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAS,CAAC,CAAC,CAAA;AAoBrD,MAAM,sBAAsB,GAAG,CAC7B,IAAO,EACP,IAIC,EACc,EAAE;IACjB,MAAM,KAAK,GAAG,wBAAc,CAAC,IAAiB,CAAC,CAAA;IAE/C,OAAO,IAAI,UAAU,CAAC;QACpB,IAAI;QACJ,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;QAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO;QACtC,KAAK,EAAE,IAAI,CAAC,KAAK;KAClB,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAa,UAA4C,SAAQ,KAAK;IAC3D,IAAI,CAAY;IAEhB,IAAI,CAAW;IAEf,MAAM,CAAQ;IAEd,OAAO,CAAiB;IAEjC,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;QAE1C,IAAI,CAAC,IAAI,GAAG,YAAY,CAAA;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE3B,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;QACjD,CAAC;IACH,CAAC;IAED,EAAE,CAAsB,IAAO;QAC7B,OAAQ,IAAI,CAAC,IAAkB,KAAK,IAAI,CAAA;IAC1C,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;IACH,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACtC,CAAC;IAED,UAAU;QACR,MAAM,IAAI,GAA0B;YAClC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAS,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,GAAG,4BAA4B,CAAA;QAC7C,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAS,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC7B,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAES,MAAM,CAAC,aAAa,CAAC,KAAc;QAC3C,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;QAE3C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,qBAAW,CAAC,qBAAqB,CAAA;YAC9C,MAAM,KAAK,GAAG,wBAAc,CAAC,IAAI,CAAC,CAAA;YAClC,OAAO;gBACL,IAAI;gBACJ,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,OAAO,EAAE,kCAAkC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE;gBACjE,OAAO,EAAE,EAA6B;gBACtC,KAAK,EAAE,KAAK;aACb,CAAA;QACH,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;QAC7B,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAiB,CAAC,CAAA;QACxF,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,wBAAc,CAAC,IAAiB,CAAC,CAAC,CAAC,CAAC,wBAAc,CAAC,qBAAW,CAAC,qBAAqB,CAAC,CAAA;QAEjH,OAAO;YACL,IAAI;YACJ,IAAI,EAAE,WAAW,CAAC,CAAC,CAAE,MAAM,CAAC,IAAI,CAAC,IAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;YAChE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM;YAC1C,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO;YAC7C,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAA4B;SACtF,CAAA;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAc;QACzB,OAAO,IAAI,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,CAAC,YAAY,CAAI,KAAoB;QACzC,MAAM,MAAM,GAAwD,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7F,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACnC,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM;gBACpC,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,IAAI;aACL,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;IAClE,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,IAGjB;QACC,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,UAAU,EAAE;YACzD,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;YAChC,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,IAGnB;QACC,OAAO,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IAC/E,CAAC;IAED,MAAM,CAAC,UAAU,CACf,OAAmF,EAAE;QAErF,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,WAAW,EAAE;YAC1D,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,cAAc,CACnB,OAAsF,EAAE;QAExF,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,cAAc,EAAE;YAC7D,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CACjB,OAAoF,EAAE;QAEtF,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,YAAY,EAAE;YAC3D,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAA0C;QACxD,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,SAAS,EAAE;YACxD,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;YAChC,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,aAAa,CAClB,OAAsF,EAAE;QAExF,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,cAAc,EAAE;YAC7D,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAGf;QACC,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,QAAQ,EAAE;YACvD,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,IAAI,CACT,OAA4E,EAAE;QAE9E,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,IAAI,EAAE;YACnD,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,mBAAmB,CACxB,OAA4F,EAAE;QAE9F,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,oBAAoB,EAAE;YACnE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,kBAAkB,CACvB,OAA2F,EAAE;QAE7F,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,mBAAmB,EAAE;YAClE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,IAAyC;QAC7D,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,eAAe,EAAE;YAC9D,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE;YAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,OAA8G,EAAE;QAEhH,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,qBAAqB,EAAE;YACpE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,IAGvB;QACC,OAAO,sBAAsB,CAAC,6BAAe,CAAC,iBAAiB,EAAE;YAC/D,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;CACF;AApOD,gCAoOC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/errors/errors.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AACvB,uCAAqF;AACrF,mDAA2C;AAC3C,iDAAiD;AACjD,+CAA+C;AAE/C;;;;GAIG;AACH,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,wCAAwC;IACxC,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAA;AAEF,mFAAmF;AACnF,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAW,CAAC,CAAC,CAAA;AAErD,mFAAmF;AACnF,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAS,CAAC,CAAC,CAAA;AA2BrD;;;GAGG;AACH,MAAM,sBAAsB,GAAG,CAC7B,IAAO,EACP,IAIC,EACc,EAAE;IACjB,MAAM,KAAK,GAAG,wBAAc,CAAC,IAAiB,CAAC,CAAA;IAE/C,OAAO,IAAI,UAAU,CAAC;QACpB,IAAI;QACJ,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;QAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO;QACtC,KAAK,EAAE,IAAI,CAAC,KAAK;KAClB,CAAC,CAAA;AACJ,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,gBAAgB,GAAG,CACvB,IAAO,EACsE,EAAE;IAC/E,OAAO,CAAC,OAAwD,EAAE,EAAiB,EAAE,CACnF,sBAAsB,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAK,EAAsB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;AAC7G,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,kBAAkB,GAAG,CACzB,IAAO,EACP,GAAM,EAC+D,EAAE;IACvE,OAAO,CAAC,IAA8C,EAAiB,EAAE,CACvE,sBAAsB,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAqB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;AAC7G,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,uBAAuB,GAAG,CAC9B,IAAO,EACoE,EAAE;IAC7E,OAAO,CAAC,IAAoD,EAAiB,EAAE,CAC7E,sBAAsB,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;AAClF,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,UAA4C,SAAQ,KAAK;IACpE,6DAA6D;IACpD,IAAI,CAAY;IAEzB,mFAAmF;IAC1E,IAAI,CAAW;IAExB,uCAAuC;IAC9B,MAAM,CAAQ;IAEvB,iDAAiD;IACxC,OAAO,CAAiB;IAEjC,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;QAE1C,IAAI,CAAC,IAAI,GAAG,YAAY,CAAA;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE3B,sDAAsD;QACtD,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;QACjD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,EAAE,CAAsB,IAAgB;QACtC,OAAQ,IAAI,CAAC,IAAkB,KAAK,IAAI,CAAA;IAC1C,CAAC;IAED,gEAAgE;IAChE,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;IACH,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,MAAM,IAAI,GAA0B;YAClC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAS,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,GAAG,4BAA4B,CAAA;QAC7C,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAS,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC7B,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;OAMG;IACO,MAAM,CAAC,aAAa,CAAC,KAAc;QAC3C,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;QAE3C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,qBAAW,CAAC,qBAAqB,CAAA;YAC9C,MAAM,KAAK,GAAG,wBAAc,CAAC,IAAI,CAAC,CAAA;YAClC,OAAO;gBACL,IAAI;gBACJ,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,OAAO,EAAE,kCAAkC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE;gBACjE,OAAO,EAAE,EAA6B;gBACtC,KAAK,EAAE,KAAK;aACb,CAAA;QACH,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;QAC7B,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAiB,CAAC,CAAA;QACxF,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,wBAAc,CAAC,IAAiB,CAAC,CAAC,CAAC,CAAC,wBAAc,CAAC,qBAAW,CAAC,qBAAqB,CAAC,CAAA;QAEjH,OAAO;YACL,IAAI;YACJ,IAAI,EAAE,WAAW,CAAC,CAAC,CAAE,MAAM,CAAC,IAAI,CAAC,IAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;YAChE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM;YAC1C,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO;YAC7C,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAA4B;SACtF,CAAA;IACH,CAAC;IAED,gHAAgH;IAChH,MAAM,CAAC,KAAK,CAAC,KAAc;QACzB,OAAO,IAAI,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,8FAA8F;IAC9F,MAAM,CAAC,YAAY,CAAI,KAAoB;QACzC,MAAM,MAAM,GAAwD,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7F,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACnC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAA;YAC3C,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,CAAA;QACvE,CAAC,CAAC,CAAA;QAEF,OAAO,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;IAClE,CAAC;IAED,gFAAgF;IAChF,MAAM,CAAC,UAAU,CAAC,IAGjB;QACC,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,UAAU,EAAE;YACzD,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;YAChC,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAED,0GAA0G;IAC1G,MAAM,CAAC,YAAY,CAAC,IAGnB;QACC,OAAO,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IAC/E,CAAC;IAED,uFAAuF;IACvF,MAAM,CAAU,UAAU,GAAG,gBAAgB,CAAC,+BAAgB,CAAC,WAAW,CAAC,CAAA;IAE3E,4FAA4F;IAC5F,MAAM,CAAU,cAAc,GAAG,gBAAgB,CAAC,+BAAgB,CAAC,cAAc,CAAC,CAAA;IAElF,2EAA2E;IAC3E,MAAM,CAAU,YAAY,GAAG,gBAAgB,CAAC,+BAAgB,CAAC,YAAY,CAAC,CAAA;IAE9E;;;OAGG;IACH,MAAM,CAAU,QAAQ,GAAG,kBAAkB,CAAC,+BAAgB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;IAEnF,gFAAgF;IAChF,MAAM,CAAU,aAAa,GAAG,gBAAgB,CAAC,+BAAgB,CAAC,cAAc,CAAC,CAAA;IAEjF,0EAA0E;IAC1E,MAAM,CAAU,QAAQ,GAAG,uBAAuB,CAAC,+BAAgB,CAAC,QAAQ,CAAC,CAAA;IAE7E,4EAA4E;IAC5E,MAAM,CAAU,IAAI,GAAG,gBAAgB,CAAC,+BAAgB,CAAC,IAAI,CAAC,CAAA;IAE9D,gFAAgF;IAChF,MAAM,CAAU,mBAAmB,GAAG,gBAAgB,CAAC,+BAAgB,CAAC,oBAAoB,CAAC,CAAA;IAE7F;;;OAGG;IACH,MAAM,CAAU,UAAU,GAAG,gBAAgB,CAAC,+BAAgB,CAAC,WAAW,CAAC,CAAA;IAE3E,mGAAmG;IACnG,MAAM,CAAU,kBAAkB,GAAG,gBAAgB,CAAC,+BAAgB,CAAC,mBAAmB,CAAC,CAAA;IAE3F;;;OAGG;IACH,MAAM,CAAU,cAAc,GAAG,kBAAkB,CAAC,+BAAgB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAA;IAE9F;;;OAGG;IACH,MAAM,CAAC,QAAQ,CACb,OAA8G,EAAE;QAEhH,OAAO,sBAAsB,CAAC,+BAAgB,CAAC,qBAAqB,EAAE;YACpE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAU,gBAAgB,GAAG,uBAAuB,CAAC,6BAAe,CAAC,iBAAiB,CAAC,CAAA;;AA5M/F,gCA6MC"}

package/dist/cjs/errors/errors.spec.js

@@ -70,6 +70,18 @@ describe('ElevaError', () => {
             const entity = err.is(_1.ERROR_CODES.NOT_FOUND) ? err.details.entity : null;
             expect(entity).toBe('User');
         });
+        it('returns true when a plain string matches the code', () => {
+            const error = _1.ElevaError.notFound(notFoundDetails);
+            expect(error.is('NOT_FOUND')).toBe(true);
+        });
+        it('returns false when a plain string does not match the code', () => {
+            const error = _1.ElevaError.notFound(notFoundDetails);
+            expect(error.is('CONFLICT')).toBe(false);
+        });
+        it('returns true for uncatalogued codes matched by string', () => {
+            const error = _1.ElevaError.parse({ code: 'CUSTOM_CODE', message: 'custom' });
+            expect(error.is('CUSTOM_CODE')).toBe(true);
+        });
     });
     describe('toJSON() / toString()', () => {
         it('toJSON returns a plain object with all fields', () => {