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

package/dist/stega.browser.d.cts

@@ -395,10 +395,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/stega.browser.d.ts

@@ -395,10 +395,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/stega.d.cts

@@ -395,10 +395,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/stega.d.ts

@@ -395,10 +395,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/package.json

@@ -1,8 +1,17 @@
 {
   "name": "@sanity/client",
-  "version": "6.28.3-resources.1",
+  "version": "6.28.3-resources.3",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
-  "keywords": ["sanity", "cms", "headless", "realtime", "content", "client", "fetch", "api"],
+  "keywords": [
+    "sanity",
+    "cms",
+    "headless",
+    "realtime",
+    "content",
+    "client",
+    "fetch",
+    "api"
+  ],
   "homepage": "https://www.sanity.io/",
   "bugs": {
     "url": "https://github.com/sanity-io/client/issues"
@@ -66,11 +75,19 @@
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
-      "csm": ["./dist/csm.d.ts"],
-      "stega": ["./dist/stega.d.ts"]
+      "csm": [
+        "./dist/csm.d.ts"
+      ],
+      "stega": [
+        "./dist/stega.d.ts"
+      ]
     }
   },
-  "files": ["dist", "src", "umd"],
+  "files": [
+    "dist",
+    "src",
+    "umd"
+  ],
   "scripts": {
     "benchmark": "npm test -- bench",
     "prebuild": "npm run clean",
@@ -93,7 +110,9 @@
   "browserslist": "extends @sanity/browserslist-config",
   "prettier": {
     "bracketSpacing": false,
-    "plugins": ["prettier-plugin-packagejson"],
+    "plugins": [
+      "prettier-plugin-packagejson"
+    ],
     "printWidth": 100,
     "semi": false,
     "singleQuote": true

package/src/assets/AssetsClient.ts

@@ -182,7 +182,26 @@ function buildAssetUploadUrl(config: InitializedClientConfig, assetType: 'image'
   const assetTypeEndpoint = assetType === 'image' ? 'images' : 'files'
 
   if (config['~experimental_resource']) {
-    return `${config['~experimental_resource'].type}/${config['~experimental_resource'].id}/assets/${assetTypeEndpoint}`
+    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:
+        // @ts-expect-error - handle all supported resource types
+        throw new Error(`Unsupported resource type: ${type.toString()}`)
+    }
   }
 
   const dataset = validators.hasDataset(config)

package/src/config.ts

@@ -75,7 +75,7 @@ export const initConfig = (
   }
 
   if (newConfig['~experimental_resource']) {
-    validate.resourceBase(newConfig)
+    validate.resourceConfig(newConfig)
   }
 
   if (typeof newConfig.perspective !== 'undefined') {

package/src/data/dataMethods.ts

@@ -12,12 +12,12 @@ import type {
   Any,
   BaseActionOptions,
   BaseMutationOptions,
-  ClientConfig,
   FirstDocumentIdMutationOptions,
   FirstDocumentMutationOptions,
   HttpRequest,
   HttpRequestEvent,
   IdentifiedSanityDocumentStub,
+  InitializedClientConfig,
   InitializedStegaConfig,
   MultipleActionResult,
   MultipleMutationResult,
@@ -367,41 +367,27 @@ export function _create<R extends Record<string, Any>>(
   const opts = Object.assign({returnFirst: true, returnDocuments: true}, options)
   return _dataRequest(client, httpRequest, 'mutate', {mutations: [mutation]}, opts)
 }
-const resourceDatasetRegex = /^\/projects\/([^/]+)\/datasets\/([^/]+)\/([^/^?]+)\/?/
-const isResourceDataEndpoint = (config: ClientConfig, uri: string, endpoint: string) => {
-  if (!config['~experimental_resource']) {
-    return false
-  }
-  if (
-    uri.startsWith(
-      `/${config['~experimental_resource'].type}/${config['~experimental_resource'].id}/${endpoint}`,
-    )
-  ) {
-    return true
-  }
-  const match = uri.match(resourceDatasetRegex)
-  if (!match) {
-    return false
-  }
-  return match[3] === endpoint
-}
-const isQuery = (config: ClientConfig, uri: string) =>
-  uri.startsWith('/data/query/') || isResourceDataEndpoint(config, uri, 'query')
-const isMutate = (config: ClientConfig, uri: string) =>
-  uri.startsWith('/data/mutate/') || isResourceDataEndpoint(config, uri, 'mutate')
-const isDoc = (config: ClientConfig, uri: string) =>
-  uri.startsWith('/data/doc/') || isResourceDataEndpoint(config, uri, 'doc')
-const isListener = (config: ClientConfig, uri: string) =>
-  uri.startsWith('/data/listen/') || isResourceDataEndpoint(config, uri, 'listen')
-const isHistory = (config: ClientConfig, uri: string) =>
-  uri.startsWith('/data/history/') || isResourceDataEndpoint(config, uri, 'history')
-const isData = (config: ClientConfig, uri: string) =>
+
+const hasDataConfig = (client: SanityClient | ObservableSanityClient) =>
+  (client.config().dataset !== undefined && client.config().projectId !== undefined) ||
+  client.config()['~experimental_resource'] !== undefined
+const isQuery = (client: SanityClient | ObservableSanityClient, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'query'))
+const isMutate = (client: SanityClient | ObservableSanityClient, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'mutate'))
+const isDoc = (client: SanityClient | ObservableSanityClient, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'doc', ''))
+const isListener = (client: SanityClient | ObservableSanityClient, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'listen'))
+const isHistory = (client: SanityClient | ObservableSanityClient, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'history', ''))
+const isData = (client: SanityClient | ObservableSanityClient, uri: string) =>
   uri.startsWith('/data/') ||
-  isQuery(config, uri) ||
-  isMutate(config, uri) ||
-  isDoc(config, uri) ||
-  isListener(config, uri) ||
-  isHistory(config, uri)
+  isQuery(client, uri) ||
+  isMutate(client, uri) ||
+  isDoc(client, uri) ||
+  isListener(client, uri) ||
+  isHistory(client, uri)
 
 /**
  * @internal
@@ -418,7 +404,7 @@ export function _requestObservable<R>(
   // Only the /data endpoint is currently available through API-CDN.
   const canUseCdn =
     typeof options.canUseCdn === 'undefined'
-      ? ['GET', 'HEAD'].indexOf(options.method || 'GET') >= 0 && isData(config, uri)
+      ? ['GET', 'HEAD'].indexOf(options.method || 'GET') >= 0 && isData(client, uri)
       : options.canUseCdn
 
   let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn
@@ -433,7 +419,7 @@ export function _requestObservable<R>(
   }
 
   // GROQ query-only parameters
-  if (['GET', 'HEAD', 'POST'].indexOf(options.method || 'GET') >= 0 && isQuery(config, uri)) {
+  if (['GET', 'HEAD', 'POST'].indexOf(options.method || 'GET') >= 0 && isQuery(client, uri)) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap
     if (resultSourceMap !== undefined && resultSourceMap !== false) {
       options.query = {resultSourceMap, ...options.query}
@@ -516,13 +502,14 @@ export function _getDataUrl(
 ): string {
   const config = client.config()
   if (config['~experimental_resource']) {
-    const resourceBase = validators.resourceBase(config)
-    const uri = path ? `${operation}/${path}` : operation
+    validators.resourceConfig(config)
+    const resourceBase = resourceDataBase(config)
+    const uri = path !== undefined ? `${operation}/${path}` : operation
     return `${resourceBase}/${uri}`.replace(/\/($|\?)/, '$1')
   }
   const catalog = validators.hasDataset(config)
   const baseUri = `/${operation}/${catalog}`
-  const uri = path ? `${baseUri}/${path}` : baseUri
+  const uri = path !== undefined ? `${baseUri}/${path}` : baseUri
   return `/data${uri}`.replace(/\/($|\?)/, '$1')
 }
 
@@ -585,3 +572,32 @@ function _createAbortError(signal?: AbortSignal) {
 
   return error
 }
+
+const resourceDataBase = (config: InitializedClientConfig): string => {
+  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:
+      // @ts-expect-error - handle all supported resource types
+      throw new Error(`Unsupported resource type: ${type.toString()}`)
+  }
+}

package/src/types.ts

@@ -53,10 +53,23 @@ export type ClientPerspective =
   | 'raw'
   | StackablePerspective[]
 
-type ClientConfigResource = {
-  type: string
-  id: string
-}
+type ClientConfigResource =
+  | {
+      type: 'canvas'
+      id: string
+    }
+  | {
+      type: 'media-library'
+      id: string
+    }
+  | {
+      type: 'dataset'
+      id: string
+    }
+  | {
+      type: 'dashboard'
+      id: string
+    }
 
 /** @public */
 export interface ClientConfig {

package/src/validators.ts

@@ -77,21 +77,29 @@ export const requestTag = (tag: string) => {
   return tag
 }
 
-export const resourceBase = (config: InitializedClientConfig): string => {
+export const resourceConfig = (config: InitializedClientConfig): void => {
   if (!config['~experimental_resource']) {
-    throw new Error('`resource` must be provided to perform queries')
+    throw new Error('`resource` must be provided to perform resource 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"')
+  const {type, id} = config['~experimental_resource']
+
+  switch (type) {
+    case 'dataset': {
+      const segments = id.split('.')
+      if (segments.length !== 2) {
+        throw new Error('Dataset resource ID must be in the format "project.dataset"')
+      }
+      return
+    }
+    case 'dashboard':
+    case 'media-library':
+    case 'canvas': {
+      return
     }
-    return `/projects/${segments[0]}/datasets/${segments[1]}`
+    default:
+      // @ts-expect-error - handle all supported resource types
+      throw new Error(`Unsupported resource type: ${type.toString()}`)
   }
-
-  return `/${resourceConfig.type}/${resourceConfig.id}`
 }
 
 export const resourceGuard = (service: string, config: InitializedClientConfig): void => {

package/umd/sanityClient.js

@@ -2063,17 +2063,23 @@
         "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`);
@@ -2149,7 +2155,7 @@
     }
     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'?"
       );
@@ -2779,21 +2785,12 @@ ${selectionOpts}`);
     const mutation = { [op]: doc }, opts = Object.assign({ returnFirst: true, returnDocuments: true }, options);
     return _dataRequest(client, httpRequest, "mutate", { mutations: [mutation] }, opts);
   }
-  const resourceDatasetRegex = /^\/projects\/([^/]+)\/datasets\/([^/]+)\/([^/^?]+)\/?/, isResourceDataEndpoint = (config, uri, endpoint) => {
-    if (!config["~experimental_resource"])
-      return false;
-    if (uri.startsWith(
-      `/${config["~experimental_resource"].type}/${config["~experimental_resource"].id}/${endpoint}`
-    ))
-      return true;
-    const match = uri.match(resourceDatasetRegex);
-    return match ? match[3] === endpoint : false;
-  }, 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 !== false && (options.query = { resultSourceMap, ...options.query });
       const perspectiveOption = options.perspective || config.perspective;
@@ -2822,11 +2819,12 @@ ${selectionOpts}`);
   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 = false) {
     const { url, cdnUrl } = client.config();
@@ -2852,6 +2850,27 @@ ${selectionOpts}`);
     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;
@@ -2904,8 +2923,23 @@ ${selectionOpts}`);
   }
   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}`;
   }