strapi-typed-client 1.6.0 → 2.0.0

package/dist/index.d.ts

@@ -1,102 +0,0 @@
-/**
- * A single validation issue inside a `ValidationError`.
- * Mirrors the Yup-style errors Strapi propagates from schema validation.
- */
-export interface StrapiValidationIssue {
-    path: string[];
-    message: string;
-    name: string;
-}
-/**
- * Known Strapi v5 error names. Other strings still pass through at
- * runtime (for plugin or future-version errors) via the `(string & {})`
- * fallback.
- */
-export type StrapiErrorName = 'ValidationError' | 'BadRequestError' | 'PaginationError' | 'UnauthorizedError' | 'ForbiddenError' | 'PolicyError' | 'NotFoundError' | 'ConflictError' | 'PayloadTooLargeError' | 'RateLimitError' | 'ApplicationError' | (string & {});
-/**
- * Maps each known `StrapiErrorName` to its `details` payload shape.
- * Used by `isStrapiErrorOf` to narrow `details` after the discriminator
- * check. Wrapped in `Partial` because Strapi may omit `details` even
- * when the error name is known.
- */
-export type StrapiErrorDetailsMap = Partial<{
-    ValidationError: {
-        errors: StrapiValidationIssue[];
-    };
-    BadRequestError: Record<string, unknown>;
-    PaginationError: Record<string, unknown>;
-    UnauthorizedError: undefined;
-    ForbiddenError: undefined;
-    PolicyError: {
-        policy?: string;
-        message?: string;
-    };
-    NotFoundError: undefined;
-    ConflictError: Record<string, unknown>;
-    PayloadTooLargeError: undefined;
-    RateLimitError: Record<string, unknown>;
-    ApplicationError: Record<string, unknown>;
-}>;
-/**
- * Fallback shape when `errorName` is not in `StrapiErrorDetailsMap`
- * (e.g. 3rd-party plugin errors or Strapi versions newer than this client).
- */
-export interface UnknownStrapiErrorDetails {
-    errorName: string;
-    details?: Record<string, unknown>;
-}
-/**
- * Error thrown for non-2xx responses from Strapi. Use `isStrapiErrorOf`
- * to narrow `details` to its typed shape.
- *
- * @example
- * try { await strapi.articles.create({ title: '' }) }
- * catch (e) {
- *   if (isStrapiErrorOf(e, 'ValidationError')) {
- *     for (const issue of e.details?.errors ?? []) {
- *       console.log(issue.path.join('.'), issue.message)
- *     }
- *   }
- * }
- */
-export declare class StrapiError extends Error {
-    userMessage: string;
-    status: number;
-    statusText: string;
-    /**
-     * Strapi-side error name (e.g. "ValidationError"). `Error.name`
-     * itself remains "StrapiError" so Sentry/sourcemap contracts are
-     * unchanged.
-     */
-    errorName: StrapiErrorName;
-    /** Narrow via `isStrapiErrorOf` for typed access. */
-    details?: unknown;
-    constructor(message: string, userMessage: string, status: number, statusText: string, details?: unknown, errorName?: StrapiErrorName);
-}
-export declare class StrapiConnectionError extends Error {
-    url: string;
-    cause?: Error;
-    constructor(message: string, url: string, cause?: Error);
-}
-/** Type guard: is the value a StrapiError instance? */
-export declare function isStrapiError(err: unknown): err is StrapiError;
-/**
- * Type guard that narrows both `errorName` and `details` for a specific
- * Strapi error type.
- *
- * @example
- * if (isStrapiErrorOf(err, 'ValidationError')) {
- *   err.details?.errors?.[0]?.path // string[] | undefined
- * }
- */
-export declare function isStrapiErrorOf<N extends keyof StrapiErrorDetailsMap>(err: unknown, name: N): err is StrapiError & {
-    errorName: N;
-    details: StrapiErrorDetailsMap[N];
-};
-export declare class StrapiClient {
-    constructor(_config: {
-        baseURL: string;
-        token?: string;
-    });
-}
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GACrB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,GACnB,gBAAgB,GAChB,aAAa,GACb,eAAe,GACf,eAAe,GACf,sBAAsB,GACtB,gBAAgB,GAChB,kBAAkB,GAClB,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;IACxC,eAAe,EAAE;QAAE,MAAM,EAAE,qBAAqB,EAAE,CAAA;KAAE,CAAA;IACpD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxC,iBAAiB,EAAE,SAAS,CAAA;IAC5B,cAAc,EAAE,SAAS,CAAA;IACzB,WAAW,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAClD,aAAa,EAAE,SAAS,CAAA;IACxB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACtC,oBAAoB,EAAE,SAAS,CAAA;IAC/B,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC5C,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACpC;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAY,SAAQ,KAAK;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,SAAS,EAAE,eAAe,CAAA;IAC1B,qDAAqD;IACrD,OAAO,CAAC,EAAE,OAAO,CAAA;gBAGb,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO,EACjB,SAAS,GAAE,eAAgC;CAUlD;AAED,qBAAa,qBAAsB,SAAQ,KAAK;IAC5C,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,KAAK,CAAA;gBAED,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;CAM1D;AAED,uDAAuD;AACvD,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW,CAE9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,qBAAqB,EACjE,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,CAAC,GACR,GAAG,IAAI,WAAW,GAAG;IACpB,SAAS,EAAE,CAAC,CAAA;IACZ,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACpC,CAEA;AAED,qBAAa,YAAY;gBACT,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;CAG3D"}

package/dist/index.js

@@ -1,79 +0,0 @@
-// Stub file — compiled to dist/index.js by `tsc`.
-// When the user runs `npx strapi-types generate`, the generator overwrites
-// dist/index.js (and .d.ts) with real, schema-aware code.
-// Until then this stub provides importable symbols that throw at runtime
-// with a helpful message explaining what to do.
-//
-// IMPORTANT: keep this file in lockstep with what the generator emits in
-// `src/generator/client-generator.ts`. Pre-generation imports must compile.
-const NOT_GENERATED_MESSAGE = '[strapi-typed-client] Types have not been generated yet.\n' +
-    'Run: npx strapi-types generate --url <your-strapi-url>\n' +
-    'Docs: https://github.com/BoxLab-Ltd/strapi-typed-client#quick-start';
-/**
- * Error thrown for non-2xx responses from Strapi. Use `isStrapiErrorOf`
- * to narrow `details` to its typed shape.
- *
- * @example
- * try { await strapi.articles.create({ title: '' }) }
- * catch (e) {
- *   if (isStrapiErrorOf(e, 'ValidationError')) {
- *     for (const issue of e.details?.errors ?? []) {
- *       console.log(issue.path.join('.'), issue.message)
- *     }
- *   }
- * }
- */
-export class StrapiError extends Error {
-    userMessage;
-    status;
-    statusText;
-    /**
-     * Strapi-side error name (e.g. "ValidationError"). `Error.name`
-     * itself remains "StrapiError" so Sentry/sourcemap contracts are
-     * unchanged.
-     */
-    errorName;
-    /** Narrow via `isStrapiErrorOf` for typed access. */
-    details;
-    constructor(message, userMessage, status, statusText, details, errorName = 'UnknownError') {
-        super(message);
-        this.name = 'StrapiError';
-        this.userMessage = userMessage;
-        this.status = status;
-        this.statusText = statusText;
-        this.errorName = errorName;
-        this.details = details;
-    }
-}
-export class StrapiConnectionError extends Error {
-    url;
-    cause;
-    constructor(message, url, cause) {
-        super(message);
-        this.name = 'StrapiConnectionError';
-        this.url = url;
-        this.cause = cause;
-    }
-}
-/** Type guard: is the value a StrapiError instance? */
-export function isStrapiError(err) {
-    return err instanceof StrapiError;
-}
-/**
- * Type guard that narrows both `errorName` and `details` for a specific
- * Strapi error type.
- *
- * @example
- * if (isStrapiErrorOf(err, 'ValidationError')) {
- *   err.details?.errors?.[0]?.path // string[] | undefined
- * }
- */
-export function isStrapiErrorOf(err, name) {
-    return isStrapiError(err) && err.errorName === name;
-}
-export class StrapiClient {
-    constructor(_config) {
-        throw new Error(NOT_GENERATED_MESSAGE);
-    }
-}
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,2EAA2E;AAC3E,0DAA0D;AAC1D,yEAAyE;AACzE,gDAAgD;AAChD,EAAE;AACF,yEAAyE;AACzE,4EAA4E;AAE5E,MAAM,qBAAqB,GACvB,4DAA4D;IAC5D,0DAA0D;IAC1D,qEAAqE,CAAA;AA4DzE;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IAClC,WAAW,CAAQ;IACnB,MAAM,CAAQ;IACd,UAAU,CAAQ;IAClB;;;;OAIG;IACH,SAAS,CAAiB;IAC1B,qDAAqD;IACrD,OAAO,CAAU;IAEjB,YACI,OAAe,EACf,WAAmB,EACnB,MAAc,EACd,UAAkB,EAClB,OAAiB,EACjB,YAA6B,cAAc;QAE3C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,aAAa,CAAA;QACzB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IAC1B,CAAC;CACJ;AAED,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC5C,GAAG,CAAQ;IACX,KAAK,CAAQ;IAEb,YAAY,OAAe,EAAE,GAAW,EAAE,KAAa;QACnD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAA;QACnC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACtB,CAAC;CACJ;AAED,uDAAuD;AACvD,MAAM,UAAU,aAAa,CAAC,GAAY;IACtC,OAAO,GAAG,YAAY,WAAW,CAAA;AACrC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC3B,GAAY,EACZ,IAAO;IAKP,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,SAAS,KAAK,IAAI,CAAA;AACvD,CAAC;AAED,MAAM,OAAO,YAAY;IACrB,YAAY,OAA4C;QACpD,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;IAC1C,CAAC;CACJ"}