@dyrected/sdk 2.5.60 → 2.5.61

package/dist/index.cjs

@@ -22,7 +22,9 @@ var index_exports = {};
 __export(index_exports, {
   DyrectedClient: () => DyrectedClient,
   DyrectedError: () => DyrectedError,
-  createClient: () => createClient
+  PREVIEW_TOKEN_PARAM: () => PREVIEW_TOKEN_PARAM,
+  createClient: () => createClient,
+  getPreviewToken: () => getPreviewToken
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -163,6 +165,13 @@ var DyrectedClient = class {
   getBaseUrl() {
     return this.baseUrl;
   }
+  /**
+   * Inject the client's configured `defaultDepth` when a read did not specify
+   * its own `depth`. A per-call `depth` (including `0`) always wins.
+   */
+  applyDefaultDepth(args) {
+    return args.depth === void 0 ? { ...args, depth: this.defaultDepth } : args;
+  }
   async getSchemas() {
     return this.request("/api/schemas");
   }
@@ -197,7 +206,20 @@ var DyrectedClient = class {
    * Used in "token" preview mode.
    */
   async getPreviewData(token) {
-    return this.request(`/api/preview-data?token=${token}`);
+    return this.request(`/api/preview-data?token=${encodeURIComponent(token)}`);
+  }
+  /**
+   * Mint a short-lived preview token that carries the current (unsaved) draft
+   * data. Used by the Admin in `previewMode: "token"` to hand draft content to
+   * a server-rendered frontend that cannot receive it over `postMessage`.
+   *
+   * Requires an authenticated request (the Admin is logged in).
+   */
+  async createPreviewToken(input) {
+    return this.request(`/api/preview-token`, {
+      method: "POST",
+      body: JSON.stringify(input)
+    });
   }
   async find(collection, args = {}) {
     const { initialData, ...queryArgs } = args;
@@ -205,7 +227,7 @@ var DyrectedClient = class {
     if (queryArgs.where && typeof queryArgs.where === "object") {
       normalizedArgs.where = JSON.stringify(queryArgs.where);
     }
-    const query = stringifyQuery(normalizedArgs, { addQueryPrefix: true });
+    const query = stringifyQuery(this.applyDefaultDepth(normalizedArgs), { addQueryPrefix: true });
     const res = await this.request(`/api/collections/${collection}${query}`);
     if (res.docs.length === 0 && initialData && initialData.length > 0) {
       this.request(`/api/collections/${collection}/seed`, {
@@ -239,7 +261,7 @@ var DyrectedClient = class {
           if (args.sort) qb.sort(args.sort);
           if (args.limit) qb.limit(args.limit);
           if (args.page) qb.page(args.page);
-          if (args.depth) qb.depth(args.depth);
+          if (args.depth !== void 0) qb.depth(args.depth);
           if (args.initialData) qb.seed(args.initialData);
         }
         return qb;
@@ -362,7 +384,7 @@ var DyrectedClient = class {
   }
   async findOne(collection, id, args = {}) {
     const { initialData, ...queryArgs } = args;
-    const query = stringifyQuery(queryArgs, { addQueryPrefix: true });
+    const query = stringifyQuery(this.applyDefaultDepth(queryArgs), { addQueryPrefix: true });
     try {
       return await this.request(`/api/collections/${collection}/${id}${query}`);
     } catch (err) {
@@ -454,7 +476,7 @@ var DyrectedClient = class {
   }
   async getGlobal(slug, args = {}) {
     const { initialData, ...queryArgs } = args;
-    const query = stringifyQuery(queryArgs, { addQueryPrefix: true });
+    const query = stringifyQuery(this.applyDefaultDepth(queryArgs), { addQueryPrefix: true });
     try {
       const res = await this.request(`/api/globals/${slug}${query}`);
       if ((!res || isFunctionallyEmpty(res)) && !isFunctionallyEmpty(initialData)) {
@@ -484,7 +506,7 @@ var DyrectedClient = class {
     });
   }
   async listMedia(args = {}, collection = "media") {
-    const query = stringifyQuery(normalizeQueryArgs(args), { addQueryPrefix: true });
+    const query = stringifyQuery(this.applyDefaultDepth(normalizeQueryArgs(args)), { addQueryPrefix: true });
     return this.request(`/api/collections/${collection}${query}`);
   }
   /** @deprecated Use client.collection('media').upload(file, data) instead */
@@ -596,6 +618,20 @@ var DyrectedClient = class {
 function createClient(config) {
   return new DyrectedClient(config);
 }
+var PREVIEW_TOKEN_PARAM = "dyPreview";
+function getPreviewToken(search) {
+  if (!search) return null;
+  let value;
+  if (typeof search === "string") {
+    value = new URLSearchParams(search.startsWith("?") ? search.slice(1) : search).get(PREVIEW_TOKEN_PARAM);
+  } else if (search instanceof URLSearchParams) {
+    value = search.get(PREVIEW_TOKEN_PARAM);
+  } else {
+    value = search[PREVIEW_TOKEN_PARAM];
+  }
+  if (Array.isArray(value)) value = value[0];
+  return typeof value === "string" && value.length > 0 ? value : null;
+}
 function isFunctionallyEmpty(obj) {
   if (obj === null || obj === void 0 || obj === "") return true;
   if (Array.isArray(obj)) {
@@ -639,5 +675,7 @@ function normalizeQueryArgs(args) {
 0 && (module.exports = {
   DyrectedClient,
   DyrectedError,
-  createClient
+  PREVIEW_TOKEN_PARAM,
+  createClient,
+  getPreviewToken
 });

package/dist/index.d.cts

@@ -129,7 +129,11 @@ interface DyrectedClientConfig {
     siteId?: string;
     headers?: Record<string, string>;
     fetch?: typeof fetch;
-    /** Default depth for relationship population. Applied to every request unless overridden per-call. */
+    /**
+     * Default relationship population depth applied to document reads
+     * (`find`, `findOne`, `global().get()`, and media listing) when a call
+     * does not pass its own `depth`. Defaults to `1`.
+     */
     defaultDepth?: number;
 }
 interface BaseSchema {
@@ -171,6 +175,11 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
      */
     getAuthHeaders(): Record<string, string>;
     getBaseUrl(): string;
+    /**
+     * Inject the client's configured `defaultDepth` when a read did not specify
+     * its own `depth`. A per-call `depth` (including `0`) always wins.
+     */
+    private applyDefaultDepth;
     getSchemas(): Promise<SchemaResponse>;
     getAdminAuthConfig(): Promise<PublicAdminAuthConfig>;
     exchangeAdminAuth(providerId: string, body: Record<string, unknown>): Promise<{
@@ -200,6 +209,21 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
      * Used in "token" preview mode.
      */
     getPreviewData<T = unknown>(token: string): Promise<T>;
+    /**
+     * Mint a short-lived preview token that carries the current (unsaved) draft
+     * data. Used by the Admin in `previewMode: "token"` to hand draft content to
+     * a server-rendered frontend that cannot receive it over `postMessage`.
+     *
+     * Requires an authenticated request (the Admin is logged in).
+     */
+    createPreviewToken(input: {
+        collectionSlug: string;
+        documentId?: string;
+        data: unknown;
+    }): Promise<{
+        token: string;
+        expiresAt: string;
+    }>;
     find<K extends keyof TSchema["collections"]>(collection: K & string, args?: QueryArgs<TSchema["collections"][K]>): Promise<PaginatedResult<TSchema["collections"][K]>>;
     /**
      * Returns a fluent query builder for a collection.
@@ -413,5 +437,23 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
     private request;
 }
 declare function createClient<TSchema extends BaseSchema = BaseSchema>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
+/**
+ * The query-string parameter the Admin appends to a preview URL in
+ * `previewMode: "token"`. Read it on your frontend to decide whether to fetch
+ * draft data instead of published content.
+ */
+declare const PREVIEW_TOKEN_PARAM = "dyPreview";
+/**
+ * Extract the preview token from a request's query string. Accepts a raw query
+ * string, a `URLSearchParams`, or a plain params object (e.g. Nuxt's
+ * `route.query` or Next's `searchParams`). Returns `null` when absent.
+ *
+ * @example
+ *   const token = getPreviewToken(route.query);
+ *   const doc = token
+ *     ? (await client.getPreviewData(token)).data
+ *     : (await client.find("pages", { where })).docs[0];
+ */
+declare function getPreviewToken(search: string | URLSearchParams | Record<string, unknown> | undefined | null): string | null;
 
-export { type AuditEntry, type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };
+export { type AuditEntry, type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, PREVIEW_TOKEN_PARAM, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient, getPreviewToken };

package/dist/index.d.ts

@@ -129,7 +129,11 @@ interface DyrectedClientConfig {
     siteId?: string;
     headers?: Record<string, string>;
     fetch?: typeof fetch;
-    /** Default depth for relationship population. Applied to every request unless overridden per-call. */
+    /**
+     * Default relationship population depth applied to document reads
+     * (`find`, `findOne`, `global().get()`, and media listing) when a call
+     * does not pass its own `depth`. Defaults to `1`.
+     */
     defaultDepth?: number;
 }
 interface BaseSchema {
@@ -171,6 +175,11 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
      */
     getAuthHeaders(): Record<string, string>;
     getBaseUrl(): string;
+    /**
+     * Inject the client's configured `defaultDepth` when a read did not specify
+     * its own `depth`. A per-call `depth` (including `0`) always wins.
+     */
+    private applyDefaultDepth;
     getSchemas(): Promise<SchemaResponse>;
     getAdminAuthConfig(): Promise<PublicAdminAuthConfig>;
     exchangeAdminAuth(providerId: string, body: Record<string, unknown>): Promise<{
@@ -200,6 +209,21 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
      * Used in "token" preview mode.
      */
     getPreviewData<T = unknown>(token: string): Promise<T>;
+    /**
+     * Mint a short-lived preview token that carries the current (unsaved) draft
+     * data. Used by the Admin in `previewMode: "token"` to hand draft content to
+     * a server-rendered frontend that cannot receive it over `postMessage`.
+     *
+     * Requires an authenticated request (the Admin is logged in).
+     */
+    createPreviewToken(input: {
+        collectionSlug: string;
+        documentId?: string;
+        data: unknown;
+    }): Promise<{
+        token: string;
+        expiresAt: string;
+    }>;
     find<K extends keyof TSchema["collections"]>(collection: K & string, args?: QueryArgs<TSchema["collections"][K]>): Promise<PaginatedResult<TSchema["collections"][K]>>;
     /**
      * Returns a fluent query builder for a collection.
@@ -413,5 +437,23 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
     private request;
 }
 declare function createClient<TSchema extends BaseSchema = BaseSchema>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
+/**
+ * The query-string parameter the Admin appends to a preview URL in
+ * `previewMode: "token"`. Read it on your frontend to decide whether to fetch
+ * draft data instead of published content.
+ */
+declare const PREVIEW_TOKEN_PARAM = "dyPreview";
+/**
+ * Extract the preview token from a request's query string. Accepts a raw query
+ * string, a `URLSearchParams`, or a plain params object (e.g. Nuxt's
+ * `route.query` or Next's `searchParams`). Returns `null` when absent.
+ *
+ * @example
+ *   const token = getPreviewToken(route.query);
+ *   const doc = token
+ *     ? (await client.getPreviewData(token)).data
+ *     : (await client.find("pages", { where })).docs[0];
+ */
+declare function getPreviewToken(search: string | URLSearchParams | Record<string, unknown> | undefined | null): string | null;
 
-export { type AuditEntry, type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };
+export { type AuditEntry, type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, PREVIEW_TOKEN_PARAM, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient, getPreviewToken };

package/dist/index.js

@@ -135,6 +135,13 @@ var DyrectedClient = class {
   getBaseUrl() {
     return this.baseUrl;
   }
+  /**
+   * Inject the client's configured `defaultDepth` when a read did not specify
+   * its own `depth`. A per-call `depth` (including `0`) always wins.
+   */
+  applyDefaultDepth(args) {
+    return args.depth === void 0 ? { ...args, depth: this.defaultDepth } : args;
+  }
   async getSchemas() {
     return this.request("/api/schemas");
   }
@@ -169,7 +176,20 @@ var DyrectedClient = class {
    * Used in "token" preview mode.
    */
   async getPreviewData(token) {
-    return this.request(`/api/preview-data?token=${token}`);
+    return this.request(`/api/preview-data?token=${encodeURIComponent(token)}`);
+  }
+  /**
+   * Mint a short-lived preview token that carries the current (unsaved) draft
+   * data. Used by the Admin in `previewMode: "token"` to hand draft content to
+   * a server-rendered frontend that cannot receive it over `postMessage`.
+   *
+   * Requires an authenticated request (the Admin is logged in).
+   */
+  async createPreviewToken(input) {
+    return this.request(`/api/preview-token`, {
+      method: "POST",
+      body: JSON.stringify(input)
+    });
   }
   async find(collection, args = {}) {
     const { initialData, ...queryArgs } = args;
@@ -177,7 +197,7 @@ var DyrectedClient = class {
     if (queryArgs.where && typeof queryArgs.where === "object") {
       normalizedArgs.where = JSON.stringify(queryArgs.where);
     }
-    const query = stringifyQuery(normalizedArgs, { addQueryPrefix: true });
+    const query = stringifyQuery(this.applyDefaultDepth(normalizedArgs), { addQueryPrefix: true });
     const res = await this.request(`/api/collections/${collection}${query}`);
     if (res.docs.length === 0 && initialData && initialData.length > 0) {
       this.request(`/api/collections/${collection}/seed`, {
@@ -211,7 +231,7 @@ var DyrectedClient = class {
           if (args.sort) qb.sort(args.sort);
           if (args.limit) qb.limit(args.limit);
           if (args.page) qb.page(args.page);
-          if (args.depth) qb.depth(args.depth);
+          if (args.depth !== void 0) qb.depth(args.depth);
           if (args.initialData) qb.seed(args.initialData);
         }
         return qb;
@@ -334,7 +354,7 @@ var DyrectedClient = class {
   }
   async findOne(collection, id, args = {}) {
     const { initialData, ...queryArgs } = args;
-    const query = stringifyQuery(queryArgs, { addQueryPrefix: true });
+    const query = stringifyQuery(this.applyDefaultDepth(queryArgs), { addQueryPrefix: true });
     try {
       return await this.request(`/api/collections/${collection}/${id}${query}`);
     } catch (err) {
@@ -426,7 +446,7 @@ var DyrectedClient = class {
   }
   async getGlobal(slug, args = {}) {
     const { initialData, ...queryArgs } = args;
-    const query = stringifyQuery(queryArgs, { addQueryPrefix: true });
+    const query = stringifyQuery(this.applyDefaultDepth(queryArgs), { addQueryPrefix: true });
     try {
       const res = await this.request(`/api/globals/${slug}${query}`);
       if ((!res || isFunctionallyEmpty(res)) && !isFunctionallyEmpty(initialData)) {
@@ -456,7 +476,7 @@ var DyrectedClient = class {
     });
   }
   async listMedia(args = {}, collection = "media") {
-    const query = stringifyQuery(normalizeQueryArgs(args), { addQueryPrefix: true });
+    const query = stringifyQuery(this.applyDefaultDepth(normalizeQueryArgs(args)), { addQueryPrefix: true });
     return this.request(`/api/collections/${collection}${query}`);
   }
   /** @deprecated Use client.collection('media').upload(file, data) instead */
@@ -568,6 +588,20 @@ var DyrectedClient = class {
 function createClient(config) {
   return new DyrectedClient(config);
 }
+var PREVIEW_TOKEN_PARAM = "dyPreview";
+function getPreviewToken(search) {
+  if (!search) return null;
+  let value;
+  if (typeof search === "string") {
+    value = new URLSearchParams(search.startsWith("?") ? search.slice(1) : search).get(PREVIEW_TOKEN_PARAM);
+  } else if (search instanceof URLSearchParams) {
+    value = search.get(PREVIEW_TOKEN_PARAM);
+  } else {
+    value = search[PREVIEW_TOKEN_PARAM];
+  }
+  if (Array.isArray(value)) value = value[0];
+  return typeof value === "string" && value.length > 0 ? value : null;
+}
 function isFunctionallyEmpty(obj) {
   if (obj === null || obj === void 0 || obj === "") return true;
   if (Array.isArray(obj)) {
@@ -610,5 +644,7 @@ function normalizeQueryArgs(args) {
 export {
   DyrectedClient,
   DyrectedError,
-  createClient
+  PREVIEW_TOKEN_PARAM,
+  createClient,
+  getPreviewToken
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dyrected/sdk",
-  "version": "2.5.60",
+  "version": "2.5.61",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -30,7 +30,7 @@
     "tsup": "^8.5.1",
     "typescript": "^5.4.5",
     "vitest": "^1.0.0",
-    "@dyrected/core": "2.5.60"
+    "@dyrected/core": "2.5.61"
   },
   "license": "BSL-1.1",
   "author": "Busola Okeowo <busolaokemoney@gmail.com>",