@sanity/client 6.28.3-instruct.4 → 6.28.3-instruct.5

package/dist/index.browser.d.cts

@@ -1076,7 +1076,7 @@ declare interface InstructRequestBase {
   }
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -1101,6 +1101,19 @@ declare interface InstructRequestBase {
      */
     timeZone: string
   }
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 /** @beta */

package/dist/index.browser.d.ts

@@ -1076,7 +1076,7 @@ declare interface InstructRequestBase {
   }
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -1101,6 +1101,19 @@ declare interface InstructRequestBase {
      */
     timeZone: string
   }
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 /** @beta */

package/dist/index.cjs

@@ -1550,7 +1550,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return config.printNoDefaultExport(), createClient2(config$1);
   };
 }
-var name = "@sanity/client", version = "6.28.3-instruct.4";
+var name = "@sanity/client", version = "6.28.3-instruct.5";
 const middleware = [
   middleware$1.debug({ verbose: !0, namespace: "sanity:client" }),
   middleware$1.headers({ "User-Agent": `${name} ${version}` }),

package/dist/index.d.cts

@@ -1076,7 +1076,7 @@ declare interface InstructRequestBase {
   }
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -1101,6 +1101,19 @@ declare interface InstructRequestBase {
      */
     timeZone: string
   }
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 /** @beta */

package/dist/index.d.ts

@@ -1076,7 +1076,7 @@ declare interface InstructRequestBase {
   }
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -1101,6 +1101,19 @@ declare interface InstructRequestBase {
      */
     timeZone: string
   }
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 /** @beta */

package/dist/index.js

@@ -1533,7 +1533,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "6.28.3-instruct.4";
+var name = "@sanity/client", version = "6.28.3-instruct.5";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),

package/dist/stega.browser.d.cts

@@ -1239,7 +1239,7 @@ declare interface InstructRequestBase {
   }
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -1264,6 +1264,19 @@ declare interface InstructRequestBase {
      */
     timeZone: string
   }
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 /** @beta */

package/dist/stega.browser.d.ts

@@ -1239,7 +1239,7 @@ declare interface InstructRequestBase {
   }
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -1264,6 +1264,19 @@ declare interface InstructRequestBase {
      */
     timeZone: string
   }
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 /** @beta */

package/dist/stega.d.cts

@@ -1239,7 +1239,7 @@ declare interface InstructRequestBase {
   }
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -1264,6 +1264,19 @@ declare interface InstructRequestBase {
      */
     timeZone: string
   }
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 /** @beta */

package/dist/stega.d.ts

@@ -1239,7 +1239,7 @@ declare interface InstructRequestBase {
   }
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -1264,6 +1264,19 @@ declare interface InstructRequestBase {
      */
     timeZone: string
   }
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 /** @beta */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.28.3-instruct.4",
+  "version": "6.28.3-instruct.5",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/instruct/types.ts

@@ -129,7 +129,7 @@ interface InstructRequestBase {
 
   /**
    * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
+   * Otherwise, such<> fields will be ignored.
    */
   localeSettings?: {
     /**
@@ -155,6 +155,20 @@ interface InstructRequestBase {
      */
     timeZone: string
   }
+
+  /**
+   * The max depth for document paths instruction can write to.
+   *
+   * Depth is based on field path segments:
+   * - `title` has depth 1
+   * - `array[_key="no"].title` has depth 3
+   *
+   * Be careful not to set this too high in studios with recursive document schemas, as it could have
+   * negative impact on performance; both runtime and quality of responses.
+   *
+   * Default: 4
+   */
+  maxPathDepth?: number
 }
 
 interface Sync {