strapi-typed-client 1.6.1 → 2.0.1

package/dist/shared/client-header.js

@@ -0,0 +1,58 @@
+/**
+ * Read a constant baked into the generated client header — SCHEMA_HASH and
+ * GENERATOR_VERSION are emitted as the first exports of client.ts/client.js, so
+ * reading the file head is enough and avoids parsing the whole client.
+ *
+ * Node-only (uses `fs`). Shared by the CLI file-writer and the Next.js plugin
+ * so the two readers can't drift. Do NOT re-export from the shared barrel —
+ * keep `fs` out of any browser bundle (same rule as `shared/version`).
+ *
+ * @module shared/client-header
+ */
+import * as fs from 'fs';
+import * as path from 'path';
+const HEADER_HEAD_BYTES = 512;
+/**
+ * Read the first N bytes of a file without loading the whole thing.
+ */
+function readFileHead(filePath, bytes) {
+    let fd;
+    try {
+        fd = fs.openSync(filePath, 'r');
+        const buf = Buffer.alloc(bytes);
+        const read = fs.readSync(fd, buf, 0, bytes, 0);
+        return buf.subarray(0, read).toString('utf-8');
+    }
+    catch {
+        return null;
+    }
+    finally {
+        if (fd !== undefined) {
+            try {
+                fs.closeSync(fd);
+            }
+            catch {
+                /* ignore */
+            }
+        }
+    }
+}
+/**
+ * Read a `export const <NAME> = '<value>'` baked into the generated client
+ * header. Tries client.ts (raw, .ts mode) first, then client.js (compiled, .js
+ * mode). Returns null when not generated or the constant is absent (e.g. a
+ * client produced before that constant was stamped).
+ */
+export function readClientHeaderConst(outputDir, name) {
+    const re = new RegExp(`${name}\\s*=\\s*['"]([^'"]*)['"]`);
+    for (const file of ['client.ts', 'client.js']) {
+        const head = readFileHead(path.join(outputDir, file), HEADER_HEAD_BYTES);
+        if (!head)
+            continue;
+        const match = head.match(re);
+        if (match)
+            return match[1];
+    }
+    return null;
+}
+//# sourceMappingURL=client-header.js.map

package/dist/shared/client-header.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-header.js","sourceRoot":"","sources":["../../src/shared/client-header.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAA;AACxB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAE5B,MAAM,iBAAiB,GAAG,GAAG,CAAA;AAE7B;;GAEG;AACH,SAAS,YAAY,CAAC,QAAgB,EAAE,KAAa;IACjD,IAAI,EAAsB,CAAA;IAC1B,IAAI,CAAC;QACD,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAC/B,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAC9C,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IAClD,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,IAAI,CAAA;IACf,CAAC;YAAS,CAAC;QACP,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC;gBACD,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YACpB,CAAC;YAAC,MAAM,CAAC;gBACL,YAAY;YAChB,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACjC,SAAiB,EACjB,IAAY;IAEZ,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,GAAG,IAAI,2BAA2B,CAAC,CAAA;IACzD,KAAK,MAAM,IAAI,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAA;QACxE,IAAI,CAAC,IAAI;YAAE,SAAQ;QACnB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAC5B,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAA;IAC9B,CAAC;IACD,OAAO,IAAI,CAAA;AACf,CAAC"}

package/package.json

@@ -1,16 +1,13 @@
 {
     "name": "strapi-typed-client",
-    "version": "1.6.1",
+    "version": "2.0.1",
     "type": "module",
     "description": "Type-safe Strapi v5 client with automatic TypeScript codegen and populate type inference",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
     "bin": {
         "strapi-types": "./dist/cli/index.js"
     },
     "files": [
         "dist",
-        "src/generator/templates/**/*.ts",
         "strapi-server.js",
         "strapi-admin.js"
     ],
@@ -42,11 +39,6 @@
         ]
     },
     "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js",
-            "default": "./dist/index.js"
-        },
         "./plugin": {
             "types": "./dist/plugin/index.d.ts",
             "import": "./dist/plugin/index.js",
@@ -111,14 +103,12 @@
         "@strapi/design-system": "^2.0.0",
         "@strapi/icons": "^2.0.0",
         "@types/node": "^25.6.0",
-        "@types/qs": "^6.14.0",
         "@types/react": "^18.0.0",
         "@types/react-dom": "^18.0.0",
         "eslint": "^10.0.0",
         "husky": "^9.1.7",
         "lint-staged": "^16.2.7",
         "prettier": "^3.0.0",
-        "qs": "^6.14.2",
         "react": "^18.0.0",
         "react-dom": "^18.0.0",
         "styled-components": "^6.0.0",
@@ -127,7 +117,7 @@
         "typescript-eslint": "^8.55.0",
         "vitepress": "^1.6.4",
         "vitepress-plugin-llms": "^1.11.0",
-        "vitest": "^3.2.0"
+        "vitest": "^4.1.9"
     },
     "peerDependencies": {
         "@strapi/design-system": "^2.0.0",
@@ -150,14 +140,18 @@
         }
     },
     "engines": {
-        "node": ">=18.0.0"
+        "node": ">=22.0.0"
     },
     "resolutions": {
-        "esbuild": ">=0.25.0",
+        "brace-expansion": ">=5.0.6",
+        "esbuild": ">=0.28.1",
         "flatted": ">=3.4.2",
         "lodash": ">=4.17.23",
         "minimatch": ">=10.2.3",
-        "rollup": ">=4.59.0"
+        "picomatch": ">=4.0.4",
+        "postcss": ">=8.5.10",
+        "rollup": ">=4.59.0",
+        "vite": ">=7.3.2"
     },
     "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

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"}

package/src/generator/templates/stringify-query.ts

@@ -1,36 +0,0 @@
-export function stringifyQuery(obj: Record<string, unknown>): string {
-    const pairs: string[] = []
-    for (const key of Object.keys(obj)) {
-        appendEntry(obj[key], key, pairs)
-    }
-    return pairs.join('&')
-}
-
-export function appendEntry(
-    value: unknown,
-    prefix: string,
-    pairs: string[],
-): void {
-    if (value === null || value === undefined) return
-    if (Array.isArray(value)) {
-        for (let i = 0; i < value.length; i++) {
-            appendEntry(value[i], `${prefix}[${i}]`, pairs)
-        }
-        return
-    }
-    if (value instanceof Date) {
-        pairs.push(`${prefix}=${encodeURIComponent(value.toISOString())}`)
-        return
-    }
-    if (typeof value === 'object') {
-        for (const key of Object.keys(value as Record<string, unknown>)) {
-            appendEntry(
-                (value as Record<string, unknown>)[key],
-                `${prefix}[${key}]`,
-                pairs,
-            )
-        }
-        return
-    }
-    pairs.push(`${prefix}=${encodeURIComponent(String(value))}`)
-}