@sanity/client 6.28.4-beta.1 → 6.28.4-resources.4

package/dist/index.d.cts

@@ -339,6 +339,8 @@ export declare interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
+  /** @internal */
+  '~experimental_resource'?: ClientConfigResource
   /**
    * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
    * @remarks
@@ -399,6 +401,24 @@ export declare interface ClientConfig {
   stega?: StegaConfig | boolean
 }
 
+declare type ClientConfigResource =
+  | {
+      type: 'canvas'
+      id: string
+    }
+  | {
+      type: 'media-library'
+      id: string
+    }
+  | {
+      type: 'dataset'
+      id: string
+    }
+  | {
+      type: 'dashboard'
+      id: string
+    }
+
 /** @public */
 export declare class ClientError extends Error {
   response: ErrorProps['response']

package/dist/index.d.ts

@@ -339,6 +339,8 @@ export declare interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
+  /** @internal */
+  '~experimental_resource'?: ClientConfigResource
   /**
    * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
    * @remarks
@@ -399,6 +401,24 @@ export declare interface ClientConfig {
   stega?: StegaConfig | boolean
 }
 
+declare type ClientConfigResource =
+  | {
+      type: 'canvas'
+      id: string
+    }
+  | {
+      type: 'media-library'
+      id: string
+    }
+  | {
+      type: 'dataset'
+      id: string
+    }
+  | {
+      type: 'dashboard'
+      id: string
+    }
+
 /** @public */
 export declare class ClientError extends Error {
   response: ErrorProps['response']

package/dist/index.js

@@ -4,7 +4,7 @@ import { retry, jsonRequest, jsonResponse, progress, observable, debug, headers,
 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";
-import { validateObject, validateInsert, requireDocumentId, validateDocumentId, hasDataset, requestTag, printPreviewDraftsDeprecationWarning, validateApiPerspective, printCdnPreviewDraftsWarning, validateAssetType, dataset, defaultConfig, initConfig, printNoDefaultExport } from "./_chunks-es/config.js";
+import { validateObject, validateInsert, requireDocumentId, validateDocumentId, resourceConfig, hasDataset, requestTag, printPreviewDraftsDeprecationWarning, validateApiPerspective, printCdnPreviewDraftsWarning, validateAssetType, resourceGuard, dataset, defaultConfig, initConfig, printNoDefaultExport } from "./_chunks-es/config.js";
 class ClientError extends Error {
   response;
   statusCode = 400;
@@ -108,8 +108,8 @@ function defineHttpRequest(envMiddleware) {
 }
 function shouldRetry(err, attempt, options) {
   if (options.maxRetries === 0) return !1;
-  const isSafe = options.method === "GET" || options.method === "HEAD", isQuery = (options.uri || options.url).startsWith("/data/query"), isRetriableResponse = err.response && (err.response.statusCode === 429 || err.response.statusCode === 502 || err.response.statusCode === 503);
-  return (isSafe || isQuery) && isRetriableResponse ? !0 : retry.shouldRetry(err, attempt, options);
+  const isSafe = options.method === "GET" || options.method === "HEAD", isQuery2 = (options.uri || options.url).startsWith("/data/query"), isRetriableResponse = err.response && (err.response.statusCode === 429 || err.response.statusCode === 502 || err.response.statusCode === 503);
+  return (isSafe || isQuery2) && isRetriableResponse ? !0 : retry.shouldRetry(err, attempt, options);
 }
 class ConnectionFailedError extends Error {
   name = "ConnectionFailedError";
@@ -677,7 +677,7 @@ function _action(client, httpRequest, actions, options) {
   );
 }
 function _dataRequest(client, httpRequest, endpoint, body, options = {}) {
-  const isMutation = endpoint === "mutate", isAction = endpoint === "actions", isQuery = endpoint === "query", strQuery = isMutation || isAction ? "" : encodeQueryString(body), useGet = !isMutation && !isAction && strQuery.length < getQuerySizeLimit, stringQuery = useGet ? strQuery : "", returnFirst = options.returnFirst, { timeout, token, tag, headers: headers2, returnQuery, lastLiveEventId, cacheMode } = options, uri = _getDataUrl(client, endpoint, stringQuery), reqOptions = {
+  const isMutation = endpoint === "mutate", isAction = endpoint === "actions", isQuery2 = endpoint === "query", strQuery = isMutation || isAction ? "" : encodeQueryString(body), useGet = !isMutation && !isAction && strQuery.length < getQuerySizeLimit, stringQuery = useGet ? strQuery : "", returnFirst = options.returnFirst, { timeout, token, tag, headers: headers2, returnQuery, lastLiveEventId, cacheMode } = options, uri = _getDataUrl(client, endpoint, stringQuery), reqOptions = {
     method: useGet ? "GET" : "POST",
     uri,
     json: !0,
@@ -692,7 +692,7 @@ function _dataRequest(client, httpRequest, endpoint, body, options = {}) {
     resultSourceMap: options.resultSourceMap,
     lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
     cacheMode,
-    canUseCdn: isQuery,
+    canUseCdn: isQuery2,
     signal: options.signal,
     fetch: options.fetch,
     useAbortSignal: options.useAbortSignal,
@@ -720,11 +720,12 @@ 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);
 }
+const hasDataConfig = (client) => client.config().dataset !== void 0 && client.config().projectId !== void 0 || client.config()["~experimental_resource"] !== void 0, isQuery = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "query")), isMutate = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "mutate")), isDoc = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "doc", "")), isListener = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "listen")), isHistory = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "history", "")), isData = (client, uri) => uri.startsWith("/data/") || isQuery(client, uri) || isMutate(client, uri) || isDoc(client, uri) || isListener(client, uri) || isHistory(client, uri);
 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 && isData(client, uri) : 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 && isQuery(client, uri)) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap;
     resultSourceMap !== void 0 && resultSourceMap !== !1 && (options.query = { resultSourceMap, ...options.query });
     const perspectiveOption = options.perspective || config.perspective;
@@ -751,8 +752,14 @@ function _request(client, httpRequest, options) {
   );
 }
 function _getDataUrl(client, operation, path) {
-  const config = client.config(), catalog = hasDataset(config), baseUri = `/${operation}/${catalog}`;
-  return `/data${path ? `${baseUri}/${path}` : baseUri}`.replace(/\/($|\?)/, "$1");
+  const config = client.config();
+  if (config["~experimental_resource"]) {
+    resourceConfig(config);
+    const resourceBase = resourceDataBase(config), uri2 = path !== void 0 ? `${operation}/${path}` : operation;
+    return `${resourceBase}/${uri2}`.replace(/\/($|\?)/, "$1");
+  }
+  const catalog = hasDataset(config), baseUri = `/${operation}/${catalog}`;
+  return `/data${path !== void 0 ? `${baseUri}/${path}` : baseUri}`.replace(/\/($|\?)/, "$1");
 }
 function _getUrl(client, uri, canUseCdn = !1) {
   const { url, cdnUrl } = client.config();
@@ -778,6 +785,27 @@ function _createAbortError(signal) {
   const error = new Error(signal?.reason ?? "The operation was aborted.");
   return error.name = "AbortError", error;
 }
+const resourceDataBase = (config) => {
+  if (!config["~experimental_resource"])
+    throw new Error("`resource` must be provided to perform resource queries");
+  const { type, id } = config["~experimental_resource"];
+  switch (type) {
+    case "dataset": {
+      const segments = id.split(".");
+      if (segments.length !== 2)
+        throw new Error('Dataset ID must be in the format "project.dataset"');
+      return `/projects/${segments[0]}/datasets/${segments[1]}`;
+    }
+    case "canvas":
+      return `/canvases/${id}`;
+    case "media-library":
+      return `/media-libraries/${id}`;
+    case "dashboard":
+      return `/dashboards/${id}`;
+    default:
+      throw new Error(`Unsupported resource type: ${type.toString()}`);
+  }
+};
 class ObservableAssetsClient {
   #client;
   #httpRequest;
@@ -810,7 +838,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(), options = optionsFromFile(opts, body), { tag, label, title, description, creditLine, filename, source } = options, query = {
     label,
     title,
     description,
@@ -822,12 +850,34 @@ function _upload(client, httpRequest, assetType, body, opts = {}) {
     tag,
     method: "POST",
     timeout: options.timeout || 0,
-    uri: `/assets/${assetEndpoint}/${dataset2}`,
+    uri: buildAssetUploadUrl(config, assetType),
     headers: options.contentType ? { "Content-Type": options.contentType } : {},
     query,
     body
   });
 }
+function buildAssetUploadUrl(config, assetType) {
+  const assetTypeEndpoint = assetType === "image" ? "images" : "files";
+  if (config["~experimental_resource"]) {
+    const { type, id } = config["~experimental_resource"];
+    switch (type) {
+      case "dataset":
+        throw new Error(
+          "Assets are not supported for dataset resources, yet. Configure the client with `{projectId: <projectId>, dataset: <datasetId>}` instead."
+        );
+      case "canvas":
+        return `/canvases/${id}/assets/${assetTypeEndpoint}`;
+      case "media-library":
+        return `/media-libraries/${id}/upload`;
+      case "dashboard":
+        return `/dashboards/${id}/assets/${assetTypeEndpoint}`;
+      default:
+        throw new Error(`Unsupported resource type: ${type.toString()}`);
+    }
+  }
+  const dataset2 = hasDataset(config);
+  return `assets/${assetTypeEndpoint}/${dataset2}`;
+}
 function optionsFromFile(opts, file) {
   return typeof File > "u" || !(file instanceof File) ? opts : Object.assign(
     {
@@ -919,6 +969,7 @@ class LiveClient {
     includeDrafts = !1,
     tag: _tag
   } = {}) {
+    resourceGuard("live", this.#client.config());
     const {
       projectId,
       apiVersion: _apiVersion,
@@ -1048,7 +1099,7 @@ class DatasetsClient {
    * @param options - Options for the dataset
    */
   create(name2, options) {
-    return lastValueFrom(
+    return resourceGuard("dataset", this.#client.config()), lastValueFrom(
       _modify(this.#client, this.#httpRequest, "PUT", name2, options)
     );
   }
@@ -1059,7 +1110,7 @@ class DatasetsClient {
    * @param options - New options for the dataset
    */
   edit(name2, options) {
-    return lastValueFrom(
+    return resourceGuard("dataset", this.#client.config()), lastValueFrom(
       _modify(this.#client, this.#httpRequest, "PATCH", name2, options)
     );
   }
@@ -1069,19 +1120,19 @@ class DatasetsClient {
    * @param name - Name of the dataset to delete
    */
   delete(name2) {
-    return lastValueFrom(_modify(this.#client, this.#httpRequest, "DELETE", name2));
+    return resourceGuard("dataset", this.#client.config()), lastValueFrom(_modify(this.#client, this.#httpRequest, "DELETE", name2));
   }
   /**
    * Fetch a list of datasets for the configured project
    */
   list() {
-    return lastValueFrom(
+    return resourceGuard("dataset", this.#client.config()), lastValueFrom(
       _request(this.#client, this.#httpRequest, { uri: "/datasets", tag: null })
     );
   }
 }
 function _modify(client, httpRequest, method, name2, options) {
-  return dataset(name2), _request(client, httpRequest, {
+  return resourceGuard("dataset", client.config()), dataset(name2), _request(client, httpRequest, {
     method,
     uri: `/datasets/${name2}`,
     body: options,
@@ -1095,6 +1146,7 @@ class ObservableProjectsClient {
     this.#client = client, this.#httpRequest = httpRequest;
   }
   list(options) {
+    resourceGuard("projects", this.#client.config());
     const uri = options?.includeMembers === !1 ? "/projects?includeMembers=false" : "/projects";
     return _request(this.#client, this.#httpRequest, { uri });
   }
@@ -1104,7 +1156,7 @@ class ObservableProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId) {
-    return _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId}` });
+    return resourceGuard("projects", this.#client.config()), _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId}` });
   }
 }
 class ProjectsClient {
@@ -1114,6 +1166,7 @@ class ProjectsClient {
     this.#client = client, this.#httpRequest = httpRequest;
   }
   list(options) {
+    resourceGuard("projects", this.#client.config());
     const uri = options?.includeMembers === !1 ? "/projects?includeMembers=false" : "/projects";
     return lastValueFrom(_request(this.#client, this.#httpRequest, { uri }));
   }
@@ -1123,7 +1176,7 @@ class ProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId) {
-    return lastValueFrom(
+    return resourceGuard("projects", this.#client.config()), lastValueFrom(
       _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId}` })
     );
   }
@@ -1511,7 +1564,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "6.28.4-beta.1";
+var name = "@sanity/client", version = "6.28.4-resources.4";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),