@sanity/client 6.28.3-resources.1 → 6.28.3-resources.3

package/dist/index.browser.d.cts

@@ -401,10 +401,23 @@ export declare interface ClientConfig {
   stega?: StegaConfig | boolean
 }
 
-declare type ClientConfigResource = {
-  type: string
-  id: string
-}
+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 {

package/dist/index.browser.d.ts

@@ -401,10 +401,23 @@ export declare interface ClientConfig {
   stega?: StegaConfig | boolean
 }
 
-declare type ClientConfigResource = {
-  type: string
-  id: string
-}
+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 {

package/dist/index.browser.js

@@ -155,17 +155,23 @@ const VALID_ASSET_TYPES = ["image", "file"], VALID_INSERT_LOCATIONS = ["before",
       "Tag can only contain alphanumeric characters, underscores, dashes and dots, and be between one and 75 characters long."
     );
   return tag;
-}, resourceBase = (config) => {
+}, resourceConfig = (config) => {
   if (!config["~experimental_resource"])
-    throw new Error("`resource` must be provided to perform queries");
-  const resourceConfig = config["~experimental_resource"];
-  if (resourceConfig.type === "dataset") {
-    const segments = resourceConfig.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]}`;
-  }
-  return `/${resourceConfig.type}/${resourceConfig.id}`;
+    throw new Error("`resource` must be provided to perform resource queries");
+  const { type, id } = config["~experimental_resource"];
+  switch (type) {
+    case "dataset": {
+      if (id.split(".").length !== 2)
+        throw new Error('Dataset resource ID must be in the format "project.dataset"');
+      return;
+    }
+    case "dashboard":
+    case "media-library":
+    case "canvas":
+      return;
+    default:
+      throw new Error(`Unsupported resource type: ${type.toString()}`);
+  }
 }, resourceGuard = (service, config) => {
   if (config["~experimental_resource"])
     throw new Error(`\`${service}\` does not support resource-based operations`);
@@ -241,7 +247,7 @@ const initConfig = (config, prevConfig) => {
   }
   if (projectBased && !newConfig.projectId)
     throw new Error("Configuration must contain `projectId`");
-  if (newConfig["~experimental_resource"] && resourceBase(newConfig), typeof newConfig.perspective < "u" && validateApiPerspective(newConfig.perspective), "encodeSourceMap" in newConfig)
+  if (newConfig["~experimental_resource"] && resourceConfig(newConfig), typeof newConfig.perspective < "u" && validateApiPerspective(newConfig.perspective), "encodeSourceMap" in newConfig)
     throw new Error(
       "It looks like you're using options meant for '@sanity/preview-kit/client'. 'encodeSourceMap' is not supported in '@sanity/client'. Did you mean 'stega.enabled'?"
     );
@@ -871,21 +877,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 resourceDatasetRegex = /^\/projects\/([^/]+)\/datasets\/([^/]+)\/([^/^?]+)\/?/, isResourceDataEndpoint = (config, uri, endpoint) => {
-  if (!config["~experimental_resource"])
-    return !1;
-  if (uri.startsWith(
-    `/${config["~experimental_resource"].type}/${config["~experimental_resource"].id}/${endpoint}`
-  ))
-    return !0;
-  const match = uri.match(resourceDatasetRegex);
-  return match ? match[3] === endpoint : !1;
-}, isQuery = (config, uri) => uri.startsWith("/data/query/") || isResourceDataEndpoint(config, uri, "query"), isMutate = (config, uri) => uri.startsWith("/data/mutate/") || isResourceDataEndpoint(config, uri, "mutate"), isDoc = (config, uri) => uri.startsWith("/data/doc/") || isResourceDataEndpoint(config, uri, "doc"), isListener = (config, uri) => uri.startsWith("/data/listen/") || isResourceDataEndpoint(config, uri, "listen"), isHistory = (config, uri) => uri.startsWith("/data/history/") || isResourceDataEndpoint(config, uri, "history"), isData = (config, uri) => uri.startsWith("/data/") || isQuery(config, uri) || isMutate(config, uri) || isDoc(config, uri) || isListener(config, uri) || isHistory(config, uri);
+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 && isData(config, uri) : 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 && isQuery(config, uri)) {
+  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;
@@ -914,11 +911,12 @@ function _request(client, httpRequest, options) {
 function _getDataUrl(client, operation, path) {
   const config = client.config();
   if (config["~experimental_resource"]) {
-    const resourceBase$1 = resourceBase(config), uri2 = path ? `${operation}/${path}` : operation;
-    return `${resourceBase$1}/${uri2}`.replace(/\/($|\?)/, "$1");
+    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 ? `${baseUri}/${path}` : baseUri}`.replace(/\/($|\?)/, "$1");
+  return `/data${path !== void 0 ? `${baseUri}/${path}` : baseUri}`.replace(/\/($|\?)/, "$1");
 }
 function _getUrl(client, uri, canUseCdn = !1) {
   const { url, cdnUrl } = client.config();
@@ -944,6 +942,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;
@@ -996,8 +1015,23 @@ function _upload(client, httpRequest, assetType, body, opts = {}) {
 }
 function buildAssetUploadUrl(config, assetType) {
   const assetTypeEndpoint = assetType === "image" ? "images" : "files";
-  if (config["~experimental_resource"])
-    return `${config["~experimental_resource"].type}/${config["~experimental_resource"].id}/assets/${assetTypeEndpoint}`;
+  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}`;
 }