@sanity/client 6.27.3-canary.1 → 6.28.0-instruct.0

package/dist/index.browser.js

@@ -1,7 +1,7 @@
 import { getIt } from "get-it";
 import { adapter, environment } from "get-it";
 import { retry, jsonRequest, jsonResponse, progress, observable } from "get-it/middleware";
-import { Observable, defer, isObservable, of, mergeMap, from, lastValueFrom, shareReplay, catchError, concat, timer, throwError, tap, finalize, share, merge, EMPTY } from "rxjs";
+import { Observable, defer, of, isObservable, mergeMap, from, lastValueFrom, shareReplay, catchError, concat, throwError, timer, tap, finalize, share, merge, EMPTY } from "rxjs";
 import { stegaClean } from "./_chunks-es/stegaClean.js";
 import { combineLatestWith, map, filter, finalize as finalize$1 } from "rxjs/operators";
 class ClientError extends Error {
@@ -171,8 +171,10 @@ const createWarningPrinter = (message) => (
   "global, edge-cached API-CDN. If you wish to have content delivered faster, set",
   "`useCdn: false` to use the Live API. Note: You may incur higher costs using the live API."
 ]), printCdnPreviewDraftsWarning = createWarningPrinter([
-  "The Sanity client is configured with the `perspective` set to `previewDrafts`, which doesn't support the API-CDN.",
+  "The Sanity client is configured with the `perspective` set to `drafts` or `previewDrafts`, which doesn't support the API-CDN.",
   "The Live API will be used instead. Set `useCdn: false` in your configuration to hide this warning."
+]), printPreviewDraftsDeprecationWarning = createWarningPrinter([
+  "The `previewDrafts` perspective has been renamed to  `drafts` and will be removed in a future API version"
 ]), printBrowserTokenWarning = createWarningPrinter([
   "You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.",
   `See ${generateHelpUrl(
@@ -870,10 +872,11 @@ function _requestObservable(client, httpRequest, options) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap;
     resultSourceMap !== void 0 && resultSourceMap !== !1 && (options.query = { resultSourceMap, ...options.query });
     const perspectiveOption = options.perspective || config.perspective;
-    typeof perspectiveOption < "u" && (validateApiPerspective(perspectiveOption), options.query = {
+    typeof perspectiveOption < "u" && (perspectiveOption === "previewDrafts" && printPreviewDraftsDeprecationWarning(), validateApiPerspective(perspectiveOption), options.query = {
       perspective: Array.isArray(perspectiveOption) ? perspectiveOption.join(",") : perspectiveOption,
       ...options.query
-    }, perspectiveOption === "previewDrafts" && useCdn && (useCdn = !1, printCdnPreviewDraftsWarning())), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === !1 && (options.query = { returnQuery: "false", ...options.query }), useCdn && options.cacheMode == "noStale" && (options.query = { cacheMode: "noStale", ...options.query });
+    }, (Array.isArray(perspectiveOption) && perspectiveOption.length > 0 || // previewDrafts was renamed to drafts, but keep for backwards compat
+    perspectiveOption === "previewDrafts" || perspectiveOption === "drafts") && useCdn && (useCdn = !1, printCdnPreviewDraftsWarning())), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === !1 && (options.query = { returnQuery: "false", ...options.query }), useCdn && options.cacheMode == "noStale" && (options.query = { cacheMode: "noStale", ...options.query });
   }
   const reqOptions = requestOptions(
     config,
@@ -978,6 +981,42 @@ function optionsFromFile(opts, file) {
     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(() => import("@sanity/eventsource")).pipe(
   map(({ default: EventSource2 }) => EventSource2),
@@ -994,6 +1033,7 @@ const MAX_URL_LENGTH = 14800, possibleOptions = [
   "includePreviousRevision",
   "includeResult",
   "includeMutations",
+  "includeAllVersions",
   "visibility",
   "effectFormat",
   "tag"
@@ -1309,6 +1349,7 @@ class ObservableSanityClient {
   live;
   projects;
   users;
+  assist;
   /**
    * Private properties
    */
@@ -1319,7 +1360,7 @@ class ObservableSanityClient {
    */
   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.assist = new ObservableAssistClient(this, this.#httpRequest);
   }
   /**
    * Clone the client - returns a new instance
@@ -1458,6 +1499,7 @@ class SanityClient {
   live;
   projects;
   users;
+  assist;
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -1472,7 +1514,7 @@ class SanityClient {
    */
   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.assist = new AssistClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
   }
   /**
    * Clone the client - returns a new instance