@sanity/client 6.28.4 → 6.28.5-goaway.0

package/dist/index.browser.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']
@@ -1039,6 +1059,18 @@ export declare type LiveEvent =
   | LiveEventReconnect
   | LiveEventMessage
   | LiveEventWelcome
+  | LiveEventGoAway
+
+/**
+ * The `id` field is the position at which the connection was rejected or closed.
+ * The `reason` field will specify why the connection rejected/closed.
+ * @public
+ */
+export declare interface LiveEventGoAway {
+  type: 'goaway'
+  id: string
+  reason: string
+}
 
 /** @public */
 export declare interface LiveEventMessage {

package/dist/index.browser.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']
@@ -1039,6 +1059,18 @@ export declare type LiveEvent =
   | LiveEventReconnect
   | LiveEventMessage
   | LiveEventWelcome
+  | LiveEventGoAway
+
+/**
+ * The `id` field is the position at which the connection was rejected or closed.
+ * The `reason` field will specify why the connection rejected/closed.
+ * @public
+ */
+export declare interface LiveEventGoAway {
+  type: 'goaway'
+  id: string
+  reason: string
+}
 
 /** @public */
 export declare interface LiveEventMessage {

package/dist/index.browser.js

@@ -107,8 +107,8 @@ function defineHttpRequest(envMiddleware2) {
 }
 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);
 }
 const BASE_URL = "https://www.sanity.io/help/";
 function generateHelpUrl(slug) {
@@ -155,6 +155,26 @@ 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;
+}, resourceConfig = (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": {
+      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`);
 };
 function once(fn) {
   let didCall = !1, returnValue;
@@ -220,14 +240,14 @@ const initConfig = (config, prevConfig) => {
   const newConfig = {
     ...defaultConfig,
     ...specifiedConfig
-  }, projectBased = newConfig.useProjectHostname;
+  }, projectBased = newConfig.useProjectHostname && !newConfig["~experimental_resource"];
   if (typeof Promise > "u") {
     const helpUrl = generateHelpUrl("js-client-promise-polyfill");
     throw new Error(`No native Promise-implementation found, polyfill needed - see ${helpUrl}`);
   }
   if (projectBased && !newConfig.projectId)
     throw new Error("Configuration must contain `projectId`");
-  if (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'?"
     );
@@ -246,7 +266,7 @@ const initConfig = (config, prevConfig) => {
   const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname), hasToken = !!newConfig.token;
   newConfig.withCredentials && hasToken && (printCredentialedTokenWarning(), newConfig.withCredentials = !1), isBrowser && isLocalhost && hasToken && 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;
+  return projectBased ? (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;
 };
 class ConnectionFailedError extends Error {
   name = "ConnectionFailedError";
@@ -814,7 +834,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, 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, returnQuery, lastLiveEventId, cacheMode } = options, uri = _getDataUrl(client, endpoint, stringQuery), reqOptions = {
     method: useGet ? "GET" : "POST",
     uri,
     json: !0,
@@ -829,7 +849,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,
@@ -857,11 +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 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;
@@ -888,8 +909,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();
@@ -915,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;
@@ -947,7 +995,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,
@@ -959,12 +1007,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(
     {
@@ -1056,6 +1126,7 @@ class LiveClient {
     includeDrafts = !1,
     tag: _tag
   } = {}) {
+    resourceGuard("live", this.#client.config());
     const {
       projectId: projectId2,
       apiVersion: _apiVersion,
@@ -1087,7 +1158,8 @@ class LiveClient {
       "message",
       "restart",
       "welcome",
-      "reconnect"
+      "reconnect",
+      "goaway"
     ]).pipe(
       reconnectOnConnectionFailure(),
       map((event) => {
@@ -1185,7 +1257,7 @@ class DatasetsClient {
    * @param options - Options for the dataset
    */
   create(name, options) {
-    return lastValueFrom(
+    return resourceGuard("dataset", this.#client.config()), lastValueFrom(
       _modify(this.#client, this.#httpRequest, "PUT", name, options)
     );
   }
@@ -1196,7 +1268,7 @@ class DatasetsClient {
    * @param options - New options for the dataset
    */
   edit(name, options) {
-    return lastValueFrom(
+    return resourceGuard("dataset", this.#client.config()), lastValueFrom(
       _modify(this.#client, this.#httpRequest, "PATCH", name, options)
     );
   }
@@ -1206,19 +1278,19 @@ class DatasetsClient {
    * @param name - Name of the dataset to delete
    */
   delete(name) {
-    return lastValueFrom(_modify(this.#client, this.#httpRequest, "DELETE", name));
+    return resourceGuard("dataset", this.#client.config()), lastValueFrom(_modify(this.#client, this.#httpRequest, "DELETE", name));
   }
   /**
    * 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, name, options) {
-  return dataset(name), _request(client, httpRequest, {
+  return resourceGuard("dataset", client.config()), dataset(name), _request(client, httpRequest, {
     method,
     uri: `/datasets/${name}`,
     body: options,
@@ -1232,6 +1304,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 });
   }
@@ -1241,7 +1314,7 @@ class ObservableProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId2) {
-    return _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId2}` });
+    return resourceGuard("projects", this.#client.config()), _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId2}` });
   }
 }
 class ProjectsClient {
@@ -1251,6 +1324,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 }));
   }
@@ -1260,7 +1334,7 @@ class ProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId2) {
-    return lastValueFrom(
+    return resourceGuard("projects", this.#client.config()), lastValueFrom(
       _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId2}` })
     );
   }