@sanity/client 6.27.1 → 6.27.2-resources.0

package/dist/index.browser.d.cts

@@ -388,6 +388,13 @@ export declare interface ClientConfig {
    * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
    */
   stega?: StegaConfig | boolean
+  /**
+   * @deprecated Don't use
+   */
+  experimental_resource?: {
+    id: string
+    type: string
+  }
 }
 
 /** @public */
@@ -993,13 +1000,12 @@ export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts,
     tag: _tag,
   }?: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -1007,9 +1013,16 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
+  }): Observable<LiveEvent>
 }
 
+/** @public */
+export declare type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+
 /** @public */
 export declare interface LiveEventMessage {
   type: 'message'
@@ -2177,7 +2190,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 

package/dist/index.browser.d.ts

@@ -388,6 +388,13 @@ export declare interface ClientConfig {
    * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
    */
   stega?: StegaConfig | boolean
+  /**
+   * @deprecated Don't use
+   */
+  experimental_resource?: {
+    id: string
+    type: string
+  }
 }
 
 /** @public */
@@ -993,13 +1000,12 @@ export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts,
     tag: _tag,
   }?: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -1007,9 +1013,16 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
+  }): Observable<LiveEvent>
 }
 
+/** @public */
+export declare type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+
 /** @public */
 export declare interface LiveEventMessage {
   type: 'message'
@@ -2177,7 +2190,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 

package/dist/index.browser.js

@@ -230,7 +230,9 @@ const initConfig = (config, prevConfig) => {
   const newConfig = {
     ...defaultConfig,
     ...specifiedConfig
-  }, projectBased = newConfig.useProjectHostname;
+  }, experimentalResource = newConfig.experimental_resource;
+  experimentalResource && (newConfig.useProjectHostname = !1);
+  const projectBased = newConfig.useProjectHostname;
   if (typeof Promise > "u") {
     const helpUrl = generateHelpUrl("js-client-promise-polyfill");
     throw new Error(`No native Promise-implementation found, polyfill needed - see ${helpUrl}`);
@@ -256,7 +258,11 @@ const initConfig = (config, prevConfig) => {
   const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname);
   isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== !0 ? 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 === !0 && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== !1 && !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;
+  if (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), experimentalResource) {
+    const resourceSuffix = `${experimentalResource.type}/${experimentalResource.id}`;
+    newConfig.url = `${newConfig.url}/${resourceSuffix}`, newConfig.cdnUrl = `${newConfig.cdnUrl}/${resourceSuffix}`;
+  }
+  return newConfig;
 };
 class ConnectionFailedError extends Error {
   name = "ConnectionFailedError";
@@ -867,11 +873,20 @@ function _create(client, httpRequest, doc, op, options = {}) {
   const mutation = { [op]: doc }, opts = Object.assign({ returnFirst: !0, returnDocuments: !0 }, options);
   return _dataRequest(client, httpRequest, "mutate", { mutations: [mutation] }, opts);
 }
+function _resourceBase(resource) {
+  return `/${resource.type}/${resource.id}`;
+}
+function isDataRequestUri(uri, resource) {
+  return resource ? uri.indexOf(`/${_resourceBase(resource)}/data/`) === 0 : uri.indexOf("/data/") === 0;
+}
+function isDataQueryRequestUri(uri, resource) {
+  return resource ? uri.indexOf(`/${_resourceBase(resource)}/data/query`) === 0 : uri.indexOf("/data/query") === 0;
+}
 function _requestObservable(client, httpRequest, options) {
-  const uri = options.url || options.uri, config = client.config(), canUseCdn = typeof options.canUseCdn > "u" ? ["GET", "HEAD"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/") === 0 : options.canUseCdn;
+  const uri = options.url || options.uri, config = client.config(), canUseCdn = typeof options.canUseCdn > "u" ? ["GET", "HEAD"].indexOf(options.method || "GET") >= 0 && isDataRequestUri(uri, config.experimental_resource) : options.canUseCdn;
   let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn;
   const tag = options.tag && config.requestTagPrefix ? [config.requestTagPrefix, options.tag].join(".") : options.tag || config.requestTagPrefix;
-  if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/query/") === 0) {
+  if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && isDataQueryRequestUri(uri, config.experimental_resource)) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap;
     resultSourceMap !== void 0 && resultSourceMap !== !1 && (options.query = { resultSourceMap, ...options.query });
     const perspectiveOption = options.perspective || config.perspective;
@@ -897,12 +912,18 @@ function _request(client, httpRequest, options) {
   );
 }
 function _getDataUrl(client, operation, path) {
-  const config = client.config(), catalog = hasDataset(config), baseUri = `/${operation}/${catalog}`;
+  const config = client.config();
+  if (config.experimental_resource) {
+    const baseUri2 = `/${operation}`;
+    return (path ? `${baseUri2}/${path}` : baseUri2).replace(/\/($|\?)/, "$1");
+  }
+  const catalog = hasDataset(config), baseUri = `/${operation}/${catalog}`;
   return `/data${path ? `${baseUri}/${path}` : baseUri}`.replace(/\/($|\?)/, "$1");
 }
 function _getUrl(client, uri, canUseCdn = !1) {
-  const { url, cdnUrl } = client.config();
-  return `${canUseCdn ? cdnUrl : url}/${uri.replace(/^\//, "")}`;
+  const { url, cdnUrl, experimental_resource } = client.config();
+  let base = canUseCdn ? cdnUrl : url;
+  return experimental_resource && uri.indexOf("/users") !== -1 && (base = base.replace(_resourceBase(experimental_resource), "")), `${base}/${uri.replace(/^\//, "")}`;
 }
 function _withAbortSignal(signal) {
   return (input) => new Observable((observer) => {
@@ -956,7 +977,7 @@ function _upload(client, httpRequest, assetType, body, opts = {}) {
   validateAssetType(assetType);
   let meta = opts.extract || void 0;
   meta && !meta.length && (meta = ["none"]);
-  const dataset2 = hasDataset(client.config()), assetEndpoint = assetType === "image" ? "images" : "files", options = optionsFromFile(opts, body), { tag, label, title, description, creditLine, filename, source } = options, query = {
+  const config = client.config(), dataset2 = config.experimental_resource ? void 0 : hasDataset(config), assetEndpoint = assetType === "image" ? "images" : "files", options = optionsFromFile(opts, body), { tag, label, title, description, creditLine, filename, source } = options, query = {
     label,
     title,
     description,
@@ -968,7 +989,7 @@ function _upload(client, httpRequest, assetType, body, opts = {}) {
     tag,
     method: "POST",
     timeout: options.timeout || 0,
-    uri: `/assets/${assetEndpoint}/${dataset2}`,
+    uri: dataset2 ? `/assets/${assetEndpoint}/${dataset2}` : `/assets/${assetEndpoint}`,
     headers: options.contentType ? { "Content-Type": options.contentType } : {},
     query,
     body
@@ -1026,14 +1047,14 @@ function _listen(query, params, opts = {}) {
     )
   );
 }
-const requiredApiVersion = "2021-03-26";
+const requiredApiVersion = "2021-03-25";
 class LiveClient {
   #client;
   constructor(client) {
     this.#client = client;
   }
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts = !1,
@@ -1054,10 +1075,6 @@ class LiveClient {
       throw new Error(
         "The live events API requires a token or withCredentials when 'includeDrafts: true'. Please update your client configuration. The token should have the lowest possible access role."
       );
-    if (includeDrafts && apiVersion !== "X")
-      throw new Error(
-        "The live events API requires API version X when 'includeDrafts: true'. This API is experimental and may change or even be removed."
-      );
     const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, !1)), tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join(".") : _tag;
     tag && url.searchParams.set("tag", tag), includeDrafts && url.searchParams.set("includeDrafts", "true");
     const esOptions = {};
@@ -1195,6 +1212,23 @@ class DatasetsClient {
     );
   }
 }
+class ThrowingDatasetsClient extends DatasetsClient {
+  constructor(client, httpRequest) {
+    super(client, httpRequest);
+  }
+  create() {
+    throw new Error("cannot create dataset with the current client configuration");
+  }
+  edit() {
+    throw new Error("cannot edit dataset with the current client configuration");
+  }
+  delete() {
+    throw new Error("cannot delete dataset with the current client configuration");
+  }
+  list() {
+    throw new Error("cannot list dataset with the current client configuration");
+  }
+}
 function _modify(client, httpRequest, method, name, options) {
   return dataset(name), _request(client, httpRequest, {
     method,
@@ -1450,7 +1484,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 = this.#clientConfig.experimental_resource ? new ThrowingDatasetsClient(this, this.#httpRequest) : 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