@sanity/client 6.28.2 → 6.28.3-instruct.1

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;
@@ -2915,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
@@ -2948,7 +2979,10 @@ ${selectionOpts}`);
         }),
         share(shareConfig)
       ), emitLatest = new Observable((subscriber) => {
-        emitted && subscriber.next(latest), subscriber.complete();
+        emitted && subscriber.next(
+          // this cast is safe because of the emitted check which asserts that we got T from the source
+          latest
+        ), subscriber.complete();
       });
       return merge(wrapped, emitLatest);
     };
@@ -3219,6 +3253,7 @@ ${selectionOpts}`);
     live;
     projects;
     users;
+    ai;
     /**
      * Private properties
      */
@@ -3229,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.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
@@ -3368,6 +3403,7 @@ ${selectionOpts}`);
     live;
     projects;
     users;
+    ai;
     /**
      * Observable version of the Sanity client, with the same configuration as the promise-based one
      */
@@ -3382,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.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