@sanity/client 6.28.4 → 6.28.5-goaway.0

package/src/datasets/DatasetsClient.ts

@@ -70,6 +70,7 @@ export class DatasetsClient {
    * @param options - Options for the dataset
    */
   create(name: string, options?: {aclMode?: DatasetAclMode}): Promise<DatasetResponse> {
+    validate.resourceGuard('dataset', this.#client.config())
     return lastValueFrom(
       _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PUT', name, options),
     )
@@ -82,6 +83,7 @@ export class DatasetsClient {
    * @param options - New options for the dataset
    */
   edit(name: string, options?: {aclMode?: DatasetAclMode}): Promise<DatasetResponse> {
+    validate.resourceGuard('dataset', this.#client.config())
     return lastValueFrom(
       _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PATCH', name, options),
     )
@@ -93,6 +95,7 @@ export class DatasetsClient {
    * @param name - Name of the dataset to delete
    */
   delete(name: string): Promise<{deleted: true}> {
+    validate.resourceGuard('dataset', this.#client.config())
     return lastValueFrom(_modify<{deleted: true}>(this.#client, this.#httpRequest, 'DELETE', name))
   }
 
@@ -100,6 +103,7 @@ export class DatasetsClient {
    * Fetch a list of datasets for the configured project
    */
   list(): Promise<DatasetsResponse> {
+    validate.resourceGuard('dataset', this.#client.config())
     return lastValueFrom(
       _request<DatasetsResponse>(this.#client, this.#httpRequest, {uri: '/datasets', tag: null}),
     )
@@ -113,6 +117,7 @@ function _modify<R = unknown>(
   name: string,
   options?: {aclMode?: DatasetAclMode},
 ) {
+  validate.resourceGuard('dataset', client.config())
   validate.dataset(name)
   return _request<R>(client, httpRequest, {
     method,

package/src/projects/ProjectsClient.ts

@@ -3,6 +3,7 @@ import {lastValueFrom, type Observable} from 'rxjs'
 import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {HttpRequest, SanityProject} from '../types'
+import * as validate from '../validators'
 
 /** @internal */
 export class ObservableProjectsClient {
@@ -24,6 +25,7 @@ export class ObservableProjectsClient {
   list(options?: {
     includeMembers?: boolean
   }): Observable<SanityProject[] | Omit<SanityProject, 'members'>[]> {
+    validate.resourceGuard('projects', this.#client.config())
     const uri = options?.includeMembers === false ? '/projects?includeMembers=false' : '/projects'
     return _request<SanityProject[]>(this.#client, this.#httpRequest, {uri})
   }
@@ -34,6 +36,7 @@ export class ObservableProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId: string): Observable<SanityProject> {
+    validate.resourceGuard('projects', this.#client.config())
     return _request<SanityProject>(this.#client, this.#httpRequest, {uri: `/projects/${projectId}`})
   }
 }
@@ -56,6 +59,7 @@ export class ProjectsClient {
   list(options?: {includeMembers?: true}): Promise<SanityProject[]>
   list(options?: {includeMembers?: false}): Promise<Omit<SanityProject, 'members'>[]>
   list(options?: {includeMembers?: boolean}): Promise<SanityProject[]> {
+    validate.resourceGuard('projects', this.#client.config())
     const uri = options?.includeMembers === false ? '/projects?includeMembers=false' : '/projects'
     return lastValueFrom(_request<SanityProject[]>(this.#client, this.#httpRequest, {uri}))
   }
@@ -66,6 +70,7 @@ export class ProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId: string): Promise<SanityProject> {
+    validate.resourceGuard('projects', this.#client.config())
     return lastValueFrom(
       _request<SanityProject>(this.#client, this.#httpRequest, {uri: `/projects/${projectId}`}),
     )

package/src/types.ts

@@ -53,6 +53,24 @@ export type ClientPerspective =
   | 'raw'
   | StackablePerspective[]
 
+type ClientConfigResource =
+  | {
+      type: 'canvas'
+      id: string
+    }
+  | {
+      type: 'media-library'
+      id: string
+    }
+  | {
+      type: 'dataset'
+      id: string
+    }
+  | {
+      type: 'dashboard'
+      id: string
+    }
+
 /** @public */
 export interface ClientConfig {
   projectId?: string
@@ -61,6 +79,9 @@ export interface ClientConfig {
   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
@@ -1324,8 +1345,23 @@ export interface LiveEventMessage {
 export interface LiveEventWelcome {
   type: 'welcome'
 }
+/**
+ * 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 interface LiveEventGoAway {
+  type: 'goaway'
+  id: string
+  reason: string
+}
 /** @public */
-export type LiveEvent = LiveEventRestart | LiveEventReconnect | LiveEventMessage | LiveEventWelcome
+export type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+  | LiveEventGoAway
 
 /** @public */
 export interface SanityQueries {}

package/src/validators.ts

@@ -76,3 +76,34 @@ export const requestTag = (tag: string) => {
 
   return tag
 }
+
+export const resourceConfig = (config: InitializedClientConfig): void => {
+  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 resource ID must be in the format "project.dataset"')
+      }
+      return
+    }
+    case 'dashboard':
+    case 'media-library':
+    case 'canvas': {
+      return
+    }
+    default:
+      // @ts-expect-error - handle all supported resource types
+      throw new Error(`Unsupported resource type: ${type.toString()}`)
+  }
+}
+
+export const resourceGuard = (service: string, config: InitializedClientConfig): void => {
+  if (config['~experimental_resource']) {
+    throw new Error(`\`${service}\` does not support resource-based operations`)
+  }
+}

package/umd/sanityClient.js

@@ -2015,8 +2015,8 @@
   }
   function shouldRetry(err, attempt, options) {
     if (options.maxRetries === 0) return false;
-    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 ? true : P.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 ? true : P.shouldRetry(err, attempt, options);
   }
   const BASE_URL = "https://www.sanity.io/help/";
   function generateHelpUrl(slug) {
@@ -2063,6 +2063,26 @@
         "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 = false, returnValue;
@@ -2128,14 +2148,14 @@
     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'?"
       );
@@ -2154,7 +2174,7 @@
     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 = false), isBrowser && isLocalhost && hasToken && newConfig.ignoreBrowserTokenWarning !== true ? 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 === true && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== false && !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";
@@ -2722,7 +2742,7 @@ ${selectionOpts}`);
     );
   }
   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: true,
@@ -2737,7 +2757,7 @@ ${selectionOpts}`);
       resultSourceMap: options.resultSourceMap,
       lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
       cacheMode,
-      canUseCdn: isQuery,
+      canUseCdn: isQuery2,
       signal: options.signal,
       fetch: options.fetch,
       useAbortSignal: options.useAbortSignal,
@@ -2765,11 +2785,12 @@ ${selectionOpts}`);
     const mutation = { [op]: doc }, opts = Object.assign({ returnFirst: true, returnDocuments: true }, 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 !== false && (options.query = { resultSourceMap, ...options.query });
       const perspectiveOption = options.perspective || config.perspective;
@@ -2796,8 +2817,14 @@ ${selectionOpts}`);
     );
   }
   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 = false) {
     const { url, cdnUrl } = client.config();
@@ -2823,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;
@@ -2855,7 +2903,7 @@ ${selectionOpts}`);
     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,
@@ -2867,12 +2915,34 @@ ${selectionOpts}`);
       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(
       {
@@ -2964,6 +3034,7 @@ ${selectionOpts}`);
       includeDrafts = false,
       tag: _tag
     } = {}) {
+      resourceGuard("live", this.#client.config());
       const {
         projectId: projectId2,
         apiVersion: _apiVersion,
@@ -2995,7 +3066,8 @@ ${selectionOpts}`);
         "message",
         "restart",
         "welcome",
-        "reconnect"
+        "reconnect",
+        "goaway"
       ]).pipe(
         reconnectOnConnectionFailure(),
         map((event) => {
@@ -3093,7 +3165,7 @@ ${selectionOpts}`);
      * @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)
       );
     }
@@ -3104,7 +3176,7 @@ ${selectionOpts}`);
      * @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)
       );
     }
@@ -3114,19 +3186,19 @@ ${selectionOpts}`);
      * @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,
@@ -3140,6 +3212,7 @@ ${selectionOpts}`);
       this.#client = client, this.#httpRequest = httpRequest;
     }
     list(options) {
+      resourceGuard("projects", this.#client.config());
       const uri = options?.includeMembers === false ? "/projects?includeMembers=false" : "/projects";
       return _request(this.#client, this.#httpRequest, { uri });
     }
@@ -3149,7 +3222,7 @@ ${selectionOpts}`);
      * @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 {
@@ -3159,6 +3232,7 @@ ${selectionOpts}`);
       this.#client = client, this.#httpRequest = httpRequest;
     }
     list(options) {
+      resourceGuard("projects", this.#client.config());
       const uri = options?.includeMembers === false ? "/projects?includeMembers=false" : "/projects";
       return lastValueFrom(_request(this.#client, this.#httpRequest, { uri }));
     }
@@ -3168,7 +3242,7 @@ ${selectionOpts}`);
      * @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}` })
       );
     }