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

package/src/config.ts

@@ -28,15 +28,30 @@ 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) && perspective.length > 1 && perspective.includes('raw')) {
+  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))
     throw new TypeError(
-      `Invalid API perspective value: "raw". The raw-perspective can not be combined with other perspectives`,
+      `Invalid API perspective value${invalid.length === 1 ? '' : 's'}: ${formatted.join(', ')}, expected \`published\`, \`drafts\`, \`raw\` or a release identifier string`,
     )
   }
 }
@@ -108,9 +123,11 @@ export const initConfig = (
   const isLocalhost = isBrowser && isLocal(window.location.hostname)
 
   const hasToken = Boolean(newConfig.token)
-  if (newConfig.withCredentials && hasToken) {
+  let withCredentials = Boolean(newConfig.withCredentials)
+
+  if (withCredentials && hasToken) {
     warnings.printCredentialedTokenWarning()
-    newConfig.withCredentials = false
+    withCredentials = false
   }
 
   if (isBrowser && isLocalhost && hasToken && newConfig.ignoreBrowserTokenWarning !== true) {
@@ -137,12 +154,12 @@ export const initConfig = (
   newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, '')
   newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost
 
-  if (newConfig.useCdn === true && newConfig.withCredentials) {
+  if (newConfig.useCdn === true && withCredentials) {
     warnings.printCdnAndWithCredentialsWarning()
   }
 
   // If `useCdn` is undefined, we treat it as `true`
-  newConfig.useCdn = newConfig.useCdn !== false && !newConfig.withCredentials
+  newConfig.useCdn = newConfig.useCdn !== false && !withCredentials
 
   validateApiVersion(newConfig.apiVersion)
 

package/src/types.ts

@@ -1336,16 +1336,6 @@ export type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
-export type {
-  InstructAsyncInstruction,
-  InstructConstantInstructionParam,
-  InstructFieldInstructionParam,
-  InstructGroqInstructionParam,
-  InstructInstruction,
-  InstructInstructionParam,
-  InstructInstructionParams,
-  InstructSyncInstruction,
-} from './ai/types'
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/umd/sanityClient.js

@@ -2109,11 +2109,21 @@
     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.length > 1 && perspective.includes("raw"))
+    if (Array.isArray(perspective) && 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 = {
@@ -2152,7 +2162,8 @@
         `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), 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);
+    let withCredentials = !!newConfig.withCredentials;
+    withCredentials && hasToken && (printCredentialedTokenWarning(), 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 && withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== false && !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;
   };
@@ -2823,42 +2834,6 @@ ${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;
@@ -3253,7 +3228,6 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    ai;
     /**
      * Private properties
      */
@@ -3264,7 +3238,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.ai = new ObservableAiClient(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);
     }
     /**
      * Clone the client - returns a new instance
@@ -3403,7 +3377,6 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    ai;
     /**
      * Observable version of the Sanity client, with the same configuration as the promise-based one
      */
@@ -3418,7 +3391,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.ai = new AiClient(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.observable = new ObservableSanityClient(httpRequest, config);
     }
     /**
      * Clone the client - returns a new instance