@sanity/client 6.28.3-instruct.0 → 6.28.3-instruct.1

package/src/{assist → ai}/types.ts

@@ -3,7 +3,7 @@
 import type {Any, SanityDocumentStub} from '@sanity/client'
 
 /** @beta */
-export interface ConstantInstructionParam {
+export interface InstructConstantInstructionParam {
   type: 'constant'
   value: string
 }
@@ -13,10 +13,10 @@ export interface ConstantInstructionParam {
  * Includes a LLM-friendly version of the field value in the instruction
  * @beta
  * */
-export interface FieldInstructionParam {
+export interface InstructFieldInstructionParam {
   type: 'field'
   /**
-   * Examples: 'title', 'array[_key=="key"].field
+   * Examples: 'title', 'array[_key=="key"].field'
    */
   path: string
   /**
@@ -38,31 +38,34 @@ export interface DocumentInstructionParam {
   documentId?: string
 }
 
-/** @beta */
-export interface GroqInstructionParam {
+/**
+ * Includes a LLM-friendly version of GROQ query result in the instruction
+ * @beta
+ * */
+export interface InstructGroqInstructionParam {
   type: 'groq'
   query: string
   params?: Record<string, string>
 }
 
 /** @beta */
-export type InstructionParam =
+export type InstructInstructionParam =
   | string
-  | ConstantInstructionParam
-  | FieldInstructionParam
+  | InstructConstantInstructionParam
+  | InstructFieldInstructionParam
   | DocumentInstructionParam
-  | GroqInstructionParam
+  | InstructGroqInstructionParam
 
 /** @beta */
-export type InstructionParams = Record<string, InstructionParam>
+export type InstructInstructionParams = Record<string, InstructInstructionParam>
 
-interface AssistRequestBase {
+interface InstructRequestBase {
   /** schemaId as reported by sanity deploy / sanity schema store */
   schemaId: string
   /** string template using $variable – more on this below under "Dynamic instruction" */
   instruction: string
   /** param values for the string template, keys are the variable name, ie if the template has "$variable", one key must be "variable" */
-  instructionParams?: InstructionParams
+  instructionParams?: InstructInstructionParams
   /**
    *  Optional document path output target for the instruction.
    *  When provided, the instruction will apply to this path in the document and its children.
@@ -81,23 +84,23 @@ interface AssistRequestBase {
    * Note: these path strings are less strictly validated than the `path` param itself:
    * if an relative-path does not exist or is invalid, it will be silently ignored.
    *
-   * @see AssistRequestBase#conditionalPaths
-   * @see AssistRequestBase#outputTypes
+   * @see InstructRequestBase#conditionalPaths
+   * @see InstructRequestBase#outputTypes
    */
   relativeOutputPaths?: {include: string[]} | {exclude: string[]}
 
   /**
    * Controls which types the instruction is allowed to output to.
    *
-   * @see AssistRequestBase#relativeOutputPaths
-   * @see AssistRequestBase#conditionalPaths
+   * @see InstructRequestBase#relativeOutputPaths
+   * @see InstructRequestBase#conditionalPaths
    */
   outputTypes?: {include: string[]} | {exclude: string[]}
 
   /**
    * When a type or field in the schema has a function set for `hidden` or `readOnly`, it is conditional.
    *
-   * By default, AI Assist will not output to conditional `readOnly` and `hidden` fields,
+   * By default, AI Instruct will not output to conditional `readOnly` and `hidden` fields,
    * ie, they are considered to resolve to `readOnly: true` / `hidden: true`.
    *
    * `conditionalPaths` param allows setting the default conditional value for
@@ -105,13 +108,13 @@ interface AssistRequestBase {
    * or individually set `hidden` and `readOnly` state for individual document paths.
    *
    *
-   * Note: fields and types with explicit readOnly: true or hidden: true in the schema, are not available to AI Assist,
+   * Note: fields and types with explicit readOnly: true or hidden: true in the schema, are not available to AI Instruct,
    * and cannot be changed via conditionalPaths.
    *
    * conditionalPaths state only apply to fields and types that have conditional `hidden` or `readOnly` in their schema definition.
    *
-   * @see AssistRequestBase#relativeOutputPaths
-   * @see AssistRequestBase#outputTypes
+   * @see InstructRequestBase#relativeOutputPaths
+   * @see InstructRequestBase#outputTypes
    */
   conditionalPaths?: {
     defaultReadOnly?: boolean
@@ -182,22 +185,22 @@ interface CreateDocumentRequest<T extends Record<string, Any> = Record<string, A
 }
 
 /** @beta */
-export type AssistSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+export type InstructSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
   | ExistingDocumentRequest
   | CreateDocumentRequest<T>
 ) &
-  AssistRequestBase &
+  InstructRequestBase &
   Sync
 
 /** @beta */
-export type AssistAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+export type InstructAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
   | ExistingDocumentRequest
   | CreateDocumentRequest<T>
 ) &
-  AssistRequestBase &
+  InstructRequestBase &
   Async
 
 /** @beta */
-export type AssistInstruction<T extends Record<string, Any> = Record<string, Any>> =
-  | AssistSyncInstruction<T>
-  | AssistAsyncInstruction<T>
+export type InstructInstruction<T extends Record<string, Any> = Record<string, Any>> =
+  | InstructSyncInstruction<T>
+  | InstructAsyncInstruction<T>

package/src/config.ts

@@ -28,30 +28,15 @@ function validateApiVersion(apiVersion: string) {
   }
 }
 
-const VALID_PERSPECTIVE = /^[a-z0-9_]+$/i
-
 /**
  * @internal - it may have breaking changes in any release
  */
 export function validateApiPerspective(
   perspective: unknown,
 ): asserts perspective is ClientPerspective {
-  if (Array.isArray(perspective)) {
-    if (perspective.includes('raw')) {
-      throw new TypeError(
-        `Invalid API perspective value: "raw". The raw-perspective can not be combined with other perspectives`,
-      )
-    }
-  }
-
-  const invalid = (Array.isArray(perspective) ? perspective : [perspective]).filter(
-    (perspectiveName) =>
-      typeof perspectiveName !== 'string' || !VALID_PERSPECTIVE.test(perspectiveName),
-  )
-  if (invalid.length > 0) {
-    const formatted = invalid.map((v) => JSON.stringify(v))
+  if (Array.isArray(perspective) && perspective.length > 1 && perspective.includes('raw')) {
     throw new TypeError(
-      `Invalid API perspective value${invalid.length === 1 ? '' : 's'}: ${formatted.join(', ')}, expected \`published\`, \`drafts\`, \`raw\` or a release identifier string`,
+      `Invalid API perspective value: "raw". The raw-perspective can not be combined with other perspectives`,
     )
   }
 }
@@ -122,7 +107,13 @@ export const initConfig = (
   const isBrowser = typeof window !== 'undefined' && window.location && window.location.hostname
   const isLocalhost = isBrowser && isLocal(window.location.hostname)
 
-  if (isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== true) {
+  const hasToken = Boolean(newConfig.token)
+  if (newConfig.withCredentials && hasToken) {
+    warnings.printCredentialedTokenWarning()
+    newConfig.withCredentials = false
+  }
+
+  if (isBrowser && isLocalhost && hasToken && newConfig.ignoreBrowserTokenWarning !== true) {
     warnings.printBrowserTokenWarning()
   } else if (typeof newConfig.useCdn === 'undefined') {
     warnings.printCdnWarning()

package/src/data/listen.ts

@@ -84,7 +84,7 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
   const listenFor = options.events ? options.events : ['mutation']
 
   const esOptions: EventSourceInit & {headers?: Record<string, string>} = {}
-  if (token || withCredentials) {
+  if (withCredentials) {
     esOptions.withCredentials = true
   }
 

package/src/http/requestOptions.ts

@@ -18,7 +18,7 @@ export function requestOptions(config: Any, overrides: Any = {}): Omit<RequestOp
 
   const withCredentials = Boolean(
     typeof overrides.withCredentials === 'undefined'
-      ? config.token || config.withCredentials
+      ? config.withCredentials
       : overrides.withCredentials,
   )
 

package/src/types.ts

@@ -1337,15 +1337,15 @@ export type ClientReturn<
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
 export type {
-  AssistAsyncInstruction,
-  AssistInstruction,
-  AssistSyncInstruction,
-  ConstantInstructionParam,
-  FieldInstructionParam,
-  GroqInstructionParam,
-  InstructionParam,
-  InstructionParams,
-} from './assist/types'
+  InstructAsyncInstruction,
+  InstructConstantInstructionParam,
+  InstructFieldInstructionParam,
+  InstructGroqInstructionParam,
+  InstructInstruction,
+  InstructInstructionParam,
+  InstructInstructionParams,
+  InstructSyncInstruction,
+} from './ai/types'
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/src/warnings.ts

@@ -33,6 +33,11 @@ export const printBrowserTokenWarning = createWarningPrinter([
   )} for more information and how to hide this warning.`,
 ])
 
+export const printCredentialedTokenWarning = createWarningPrinter([
+  'You have configured Sanity client to use a token, but also provided `withCredentials: true`.',
+  'This is no longer supported - only token will be used - remove `withCredentials: true`.',
+])
+
 export const printNoApiVersionSpecifiedWarning = createWarningPrinter([
   'Using the Sanity client without specifying an API version is deprecated.',
   `See ${generateHelpUrl('js-client-api-version')}`,

package/umd/sanityClient.js

@@ -1465,11 +1465,13 @@
       return !!obj && (obj instanceof Observable || (isFunction(obj.lift) && isFunction(obj.subscribe)));
   }
 
-  var EmptyError = createErrorClass(function (_super) { return function EmptyErrorImpl() {
-      _super(this);
-      this.name = 'EmptyError';
-      this.message = 'no elements in sequence';
-  }; });
+  var EmptyError = createErrorClass(function (_super) {
+      return function EmptyErrorImpl() {
+          _super(this);
+          this.name = 'EmptyError';
+          this.message = 'no elements in sequence';
+      };
+  });
 
   function lastValueFrom(source, config) {
       return new Promise(function (resolve, reject) {
@@ -2086,6 +2088,9 @@
     `See ${generateHelpUrl(
     "js-client-browser-token"
   )} for more information and how to hide this warning.`
+  ]), printCredentialedTokenWarning = createWarningPrinter([
+    "You have configured Sanity client to use a token, but also provided `withCredentials: true`.",
+    "This is no longer supported - only token will be used - remove `withCredentials: true`."
   ]), printNoApiVersionSpecifiedWarning = createWarningPrinter([
     "Using the Sanity client without specifying an API version is deprecated.",
     `See ${generateHelpUrl("js-client-api-version")}`
@@ -2104,21 +2109,11 @@
     if (!(/^\d{4}-\d{2}-\d{2}$/.test(apiVersion) && apiDate instanceof Date && apiDate.getTime() > 0))
       throw new Error("Invalid API version string, expected `1` or date in format `YYYY-MM-DD`");
   }
-  const VALID_PERSPECTIVE = /^[a-z0-9_]+$/i;
   function validateApiPerspective(perspective) {
-    if (Array.isArray(perspective) && perspective.includes("raw"))
+    if (Array.isArray(perspective) && perspective.length > 1 && perspective.includes("raw"))
       throw new TypeError(
         'Invalid API perspective value: "raw". The raw-perspective can not be combined with other perspectives'
       );
-    const invalid = (Array.isArray(perspective) ? perspective : [perspective]).filter(
-      (perspectiveName) => typeof perspectiveName != "string" || !VALID_PERSPECTIVE.test(perspectiveName)
-    );
-    if (invalid.length > 0) {
-      const formatted = invalid.map((v) => JSON.stringify(v));
-      throw new TypeError(
-        `Invalid API perspective value${invalid.length === 1 ? "" : "s"}: ${formatted.join(", ")}, expected \`published\`, \`drafts\`, \`raw\` or a release identifier string`
-      );
-    }
   }
   const initConfig = (config, prevConfig) => {
     const specifiedConfig = {
@@ -2156,8 +2151,8 @@
       throw new Error(
         `stega.studioUrl must be a string or a function, received ${newConfig.stega.studioUrl}`
       );
-    const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname);
-    isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== true ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn === true && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== false && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
+    const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname), hasToken = !!newConfig.token;
+    newConfig.withCredentials && hasToken && (printCredentialedTokenWarning(), newConfig.withCredentials = false), isBrowser && isLocalhost && hasToken && newConfig.ignoreBrowserTokenWarning !== true ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn === true && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== false && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
     const hostParts = newConfig.apiHost.split("://", 2), protocol = hostParts[0], host = hostParts[1], cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
     return newConfig.useProjectHostname ? (newConfig.url = `${protocol}://${newConfig.projectId}.${host}/v${newConfig.apiVersion}`, newConfig.cdnUrl = `${protocol}://${newConfig.projectId}.${cdnHost}/v${newConfig.apiVersion}`) : (newConfig.url = `${newConfig.apiHost}/v${newConfig.apiVersion}`, newConfig.cdnUrl = newConfig.url), newConfig;
   };
@@ -2605,7 +2600,7 @@ ${selectionOpts}`);
   function requestOptions(config, overrides = {}) {
     const headers = {}, token = overrides.token || config.token;
     token && (headers.Authorization = `Bearer ${token}`), !overrides.useGlobalApi && !config.useProjectHostname && config.projectId && (headers[projectHeader] = config.projectId);
-    const withCredentials = !!(typeof overrides.withCredentials > "u" ? config.token || config.withCredentials : overrides.withCredentials), timeout = typeof overrides.timeout > "u" ? config.timeout : overrides.timeout;
+    const withCredentials = !!(typeof overrides.withCredentials > "u" ? config.withCredentials : overrides.withCredentials), timeout = typeof overrides.timeout > "u" ? config.timeout : overrides.timeout;
     return Object.assign({}, overrides, {
       headers: Object.assign({}, headers, overrides.headers || {}),
       timeout: typeof timeout > "u" ? 5 * 60 * 1e3 : timeout,
@@ -2828,6 +2823,42 @@ ${selectionOpts}`);
     const error = new Error(signal?.reason ?? "The operation was aborted.");
     return error.name = "AbortError", error;
   }
+  function _instruct(client, httpRequest, request) {
+    const dataset2 = hasDataset(client.config());
+    return _request(client, httpRequest, {
+      method: "POST",
+      uri: `/assist/tasks/instruct/${dataset2}`,
+      body: request
+    });
+  }
+  class ObservableAiClient {
+    #client;
+    #httpRequest;
+    constructor(client, httpRequest) {
+      this.#client = client, this.#httpRequest = httpRequest;
+    }
+    /**
+     * Run an ad-hoc instruction for a target document.
+     * @param request instruction request
+     */
+    instruct(request) {
+      return _instruct(this.#client, this.#httpRequest, request);
+    }
+  }
+  class AiClient {
+    #client;
+    #httpRequest;
+    constructor(client, httpRequest) {
+      this.#client = client, this.#httpRequest = httpRequest;
+    }
+    /**
+     * Run an ad-hoc instruction for a target document.
+     * @param request instruction request
+     */
+    instruct(request) {
+      return lastValueFrom(_instruct(this.#client, this.#httpRequest, request));
+    }
+  }
   class ObservableAssetsClient {
     #client;
     #httpRequest;
@@ -2887,42 +2918,6 @@ ${selectionOpts}`);
       opts
     );
   }
-  function _instruct(client, httpRequest, request) {
-    const dataset2 = hasDataset(client.config());
-    return _request(client, httpRequest, {
-      method: "POST",
-      uri: `/assist/tasks/instruct/${dataset2}`,
-      body: request
-    });
-  }
-  class ObservableAssistClient {
-    #client;
-    #httpRequest;
-    constructor(client, httpRequest) {
-      this.#client = client, this.#httpRequest = httpRequest;
-    }
-    /**
-     * Run an ad-hoc instruction for a target document.
-     * @param request instruction request
-     */
-    instruct(request) {
-      return _instruct(this.#client, this.#httpRequest, request);
-    }
-  }
-  class AssistClient {
-    #client;
-    #httpRequest;
-    constructor(client, httpRequest) {
-      this.#client = client, this.#httpRequest = httpRequest;
-    }
-    /**
-     * Run an ad-hoc instruction for a target document.
-     * @param request instruction request
-     */
-    instruct(request) {
-      return lastValueFrom(_instruct(this.#client, this.#httpRequest, request));
-    }
-  }
   var defaults = (obj, defaults2) => Object.keys(defaults2).concat(Object.keys(obj)).reduce((target, prop) => (target[prop] = typeof obj[prop] > "u" ? defaults2[prop] : obj[prop], target), {});
   const pick = (obj, props) => props.reduce((selection, prop) => (typeof obj[prop] > "u" || (selection[prop] = obj[prop]), selection), {}), eventSourcePolyfill = defer(() => Promise.resolve().then(function () { return browser$1; })).pipe(
     map(({ default: EventSource2 }) => EventSource2),
@@ -2951,7 +2946,7 @@ ${selectionOpts}`);
     if (uri.length > MAX_URL_LENGTH)
       return throwError(() => new Error("Query too large for listener"));
     const listenFor = options.events ? options.events : ["mutation"], esOptions = {};
-    return (token || withCredentials) && (esOptions.withCredentials = true), token && (esOptions.headers = {
+    return withCredentials && (esOptions.withCredentials = true), token && (esOptions.headers = {
       Authorization: `Bearer ${token}`
     }), connectEventSource(() => (
       // use polyfill if there is no global EventSource or if we need to set headers
@@ -3258,7 +3253,7 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    assist;
+    ai;
     /**
      * Private properties
      */
@@ -3269,7 +3264,7 @@ ${selectionOpts}`);
      */
     listen = _listen;
     constructor(httpRequest, config = defaultConfig) {
-      this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.assist = new ObservableAssistClient(this, this.#httpRequest);
+      this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.ai = new ObservableAiClient(this, this.#httpRequest);
     }
     /**
      * Clone the client - returns a new instance
@@ -3408,7 +3403,7 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    assist;
+    ai;
     /**
      * Observable version of the Sanity client, with the same configuration as the promise-based one
      */
@@ -3423,7 +3418,7 @@ ${selectionOpts}`);
      */
     listen = _listen;
     constructor(httpRequest, config = defaultConfig) {
-      this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.assist = new AssistClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
+      this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.ai = new AiClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
     }
     /**
      * Clone the client - returns a new instance