@sanity/client 6.28.4 → 6.28.5-goaway.0

package/dist/stega.browser.d.cts

@@ -333,6 +333,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
@@ -393,6 +395,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']
@@ -1209,6 +1229,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/stega.browser.d.ts

@@ -333,6 +333,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
@@ -393,6 +395,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']
@@ -1209,6 +1229,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/stega.d.cts

@@ -333,6 +333,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
@@ -393,6 +395,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']
@@ -1209,6 +1229,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/stega.d.ts

@@ -333,6 +333,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
@@ -393,6 +395,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']
@@ -1209,6 +1229,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.28.4",
+  "version": "6.28.5-goaway.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -125,41 +125,41 @@
   "devDependencies": {
     "@edge-runtime/types": "^4.0.0",
     "@edge-runtime/vm": "^5.0.0",
-    "@eslint/eslintrc": "^3.3.0",
-    "@eslint/js": "^9.22.0",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.24.0",
     "@rollup/plugin-commonjs": "^28.0.3",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@sanity/client-latest": "npm:@sanity/client@latest",
-    "@sanity/pkg-utils": "^7.1.1",
+    "@sanity/pkg-utils": "^7.2.2",
     "@types/json-diff": "^1.0.3",
     "@types/node": "^22.9.0",
-    "@typescript-eslint/eslint-plugin": "^8.26.1",
-    "@typescript-eslint/parser": "^8.26.1",
+    "@typescript-eslint/eslint-plugin": "^8.29.1",
+    "@typescript-eslint/parser": "^8.29.1",
     "@vercel/stega": "0.1.2",
-    "@vitest/coverage-v8": "3.0.9",
-    "eslint": "^9.22.0",
+    "@vitest/coverage-v8": "3.1.1",
+    "eslint": "^9.24.0",
     "eslint-config-prettier": "^10.1.1",
     "eslint-formatter-compact": "^8.40.0",
-    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-prettier": "^5.2.6",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "faucet": "^0.0.4",
-    "globals": "^15.15.0",
+    "globals": "^16.0.0",
     "happy-dom": "^12.10.3",
     "json-diff": "^1.0.6",
     "ls-engines": "^0.9.3",
     "msw": "^2.7.3",
-    "next": "^15.2.3",
+    "next": "^15.3.0",
     "nock": "^13.5.6",
     "prettier": "^3.5.3",
     "prettier-plugin-packagejson": "^2.5.10",
     "rimraf": "^5.0.7",
-    "rollup": "^4.36.0",
+    "rollup": "^4.39.0",
     "sse-channel": "^4.0.0",
     "terser": "^5.39.0",
-    "typescript": "5.8.2",
-    "vitest": "3.0.9"
+    "typescript": "5.8.3",
+    "vitest": "3.1.1"
   },
-  "packageManager": "npm@11.0.0",
+  "packageManager": "npm@11.3.0",
   "engines": {
     "node": ">=14.18"
   }

package/src/assets/AssetsClient.ts

@@ -7,6 +7,7 @@ import type {
   Any,
   HttpRequest,
   HttpRequestEvent,
+  InitializedClientConfig,
   ResponseEvent,
   SanityAssetDocument,
   SanityImageAssetDocument,
@@ -149,8 +150,7 @@ function _upload(
     meta = ['none']
   }
 
-  const dataset = validators.hasDataset(client.config())
-  const assetEndpoint = assetType === 'image' ? 'images' : 'files'
+  const config = client.config()
   const options = optionsFromFile(opts, body)
   const {tag, label, title, description, creditLine, filename, source} = options
   const query: Any = {
@@ -166,17 +166,48 @@ function _upload(
     query.sourceName = source.name
     query.sourceUrl = source.url
   }
+
   return _requestObservable(client, httpRequest, {
     tag,
     method: 'POST',
     timeout: options.timeout || 0,
-    uri: `/assets/${assetEndpoint}/${dataset}`,
+    uri: buildAssetUploadUrl(config, assetType),
     headers: options.contentType ? {'Content-Type': options.contentType} : {},
     query,
     body,
   })
 }
 
+function buildAssetUploadUrl(config: InitializedClientConfig, assetType: 'image' | 'file'): string {
+  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:
+        // @ts-expect-error - handle all supported resource types
+        throw new Error(`Unsupported resource type: ${type.toString()}`)
+    }
+  }
+
+  const dataset = validators.hasDataset(config)
+  return `assets/${assetTypeEndpoint}/${dataset}`
+}
+
 function optionsFromFile(opts: Record<string, Any>, file: Any) {
   if (typeof File === 'undefined' || !(file instanceof File)) {
     return opts

package/src/config.ts

@@ -63,7 +63,7 @@ export const initConfig = (
     ...defaultConfig,
     ...specifiedConfig,
   } as InitializedClientConfig
-  const projectBased = newConfig.useProjectHostname
+  const projectBased = newConfig.useProjectHostname && !newConfig['~experimental_resource']
 
   if (typeof Promise === 'undefined') {
     const helpUrl = generateHelpUrl('js-client-promise-polyfill')
@@ -74,6 +74,10 @@ export const initConfig = (
     throw new Error('Configuration must contain `projectId`')
   }
 
+  if (newConfig['~experimental_resource']) {
+    validate.resourceConfig(newConfig)
+  }
+
   if (typeof newConfig.perspective !== 'undefined') {
     validateApiPerspective(newConfig.perspective)
   }
@@ -151,7 +155,7 @@ export const initConfig = (
   const host = hostParts[1]
   const cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host
 
-  if (newConfig.useProjectHostname) {
+  if (projectBased) {
     newConfig.url = `${protocol}://${newConfig.projectId}.${host}/v${newConfig.apiVersion}`
     newConfig.cdnUrl = `${protocol}://${newConfig.projectId}.${cdnHost}/v${newConfig.apiVersion}`
   } else {

package/src/data/dataMethods.ts

@@ -17,6 +17,7 @@ import type {
   HttpRequest,
   HttpRequestEvent,
   IdentifiedSanityDocumentStub,
+  InitializedClientConfig,
   InitializedStegaConfig,
   MultipleActionResult,
   MultipleMutationResult,
@@ -38,6 +39,8 @@ import {encodeQueryString} from './encodeQueryString'
 import {ObservablePatch, Patch} from './patch'
 import {ObservableTransaction, Transaction} from './transaction'
 
+type Client = SanityClient | ObservableSanityClient
+
 const excludeFalsey = (param: Any, defValue: Any) => {
   const value = typeof param === 'undefined' ? defValue : param
   return param === false ? undefined : value
@@ -67,7 +70,7 @@ const getQuerySizeLimit = 11264
 
 /** @internal */
 export function _fetch<R, Q>(
-  client: ObservableSanityClient | SanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   _stega: InitializedStegaConfig,
   query: string,
@@ -126,7 +129,7 @@ export function _fetch<R, Q>(
 
 /** @internal */
 export function _getDocument<R extends Record<string, Any>>(
-  client: ObservableSanityClient | SanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   id: string,
   opts: {signal?: AbortSignal; tag?: string} = {},
@@ -145,7 +148,7 @@ export function _getDocument<R extends Record<string, Any>>(
 
 /** @internal */
 export function _getDocuments<R extends Record<string, Any>>(
-  client: ObservableSanityClient | SanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   ids: string[],
   opts: {signal?: AbortSignal; tag?: string} = {},
@@ -167,7 +170,7 @@ export function _getDocuments<R extends Record<string, Any>>(
 
 /** @internal */
 export function _createIfNotExists<R extends Record<string, Any>>(
-  client: ObservableSanityClient | SanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   doc: IdentifiedSanityDocumentStub<R>,
   options?:
@@ -185,7 +188,7 @@ export function _createIfNotExists<R extends Record<string, Any>>(
 
 /** @internal */
 export function _createOrReplace<R extends Record<string, Any>>(
-  client: ObservableSanityClient | SanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   doc: IdentifiedSanityDocumentStub<R>,
   options?:
@@ -203,7 +206,7 @@ export function _createOrReplace<R extends Record<string, Any>>(
 
 /** @internal */
 export function _delete<R extends Record<string, Any>>(
-  client: ObservableSanityClient | SanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   selection: string | MutationSelection,
   options?:
@@ -226,7 +229,7 @@ export function _delete<R extends Record<string, Any>>(
 
 /** @internal */
 export function _mutate<R extends Record<string, Any>>(
-  client: SanityClient | ObservableSanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   mutations: Mutation<R>[] | Patch | ObservablePatch | Transaction | ObservableTransaction,
   options?:
@@ -256,7 +259,7 @@ export function _mutate<R extends Record<string, Any>>(
  * @internal
  */
 export function _action(
-  client: SanityClient | ObservableSanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   actions: Action | Action[],
   options?: BaseActionOptions,
@@ -280,7 +283,7 @@ export function _action(
  * @internal
  */
 export function _dataRequest(
-  client: SanityClient | ObservableSanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   endpoint: string,
   body: Any,
@@ -354,7 +357,7 @@ export function _dataRequest(
  * @internal
  */
 export function _create<R extends Record<string, Any>>(
-  client: SanityClient | ObservableSanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   doc: Any,
   op: Any,
@@ -367,11 +370,38 @@ export function _create<R extends Record<string, Any>>(
   return _dataRequest(client, httpRequest, 'mutate', {mutations: [mutation]}, opts)
 }
 
+const hasDataConfig = (client: Client) =>
+  (client.config().dataset !== undefined && client.config().projectId !== undefined) ||
+  client.config()['~experimental_resource'] !== undefined
+
+const isQuery = (client: Client, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'query'))
+
+const isMutate = (client: Client, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'mutate'))
+
+const isDoc = (client: Client, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'doc', ''))
+
+const isListener = (client: Client, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'listen'))
+
+const isHistory = (client: Client, uri: string) =>
+  hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'history', ''))
+
+const isData = (client: Client, uri: string) =>
+  uri.startsWith('/data/') ||
+  isQuery(client, uri) ||
+  isMutate(client, uri) ||
+  isDoc(client, uri) ||
+  isListener(client, uri) ||
+  isHistory(client, uri)
+
 /**
  * @internal
  */
 export function _requestObservable<R>(
-  client: SanityClient | ObservableSanityClient,
+  client: Client,
   httpRequest: HttpRequest,
   options: RequestObservableOptions,
 ): Observable<HttpRequestEvent<R>> {
@@ -382,7 +412,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 && uri.indexOf('/data/') === 0
+      ? ['GET', 'HEAD'].indexOf(options.method || 'GET') >= 0 && isData(client, uri)
       : options.canUseCdn
 
   let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn
@@ -397,10 +427,7 @@ export function _requestObservable<R>(
   }
 
   // GROQ query-only parameters
-  if (
-    ['GET', 'HEAD', 'POST'].indexOf(options.method || 'GET') >= 0 &&
-    uri.indexOf('/data/query/') === 0
-  ) {
+  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}
@@ -460,11 +487,7 @@ export function _requestObservable<R>(
 /**
  * @internal
  */
-export function _request<R>(
-  client: SanityClient | ObservableSanityClient,
-  httpRequest: HttpRequest,
-  options: Any,
-): Observable<R> {
+export function _request<R>(client: Client, httpRequest: HttpRequest, options: Any): Observable<R> {
   const observable = _requestObservable<R>(client, httpRequest, options).pipe(
     filter((event: Any) => event.type === 'response'),
     map((event: Any) => event.body),
@@ -476,26 +499,24 @@ export function _request<R>(
 /**
  * @internal
  */
-export function _getDataUrl(
-  client: SanityClient | ObservableSanityClient,
-  operation: string,
-  path?: string,
-): string {
+export function _getDataUrl(client: Client, operation: string, path?: string): string {
   const config = client.config()
+  if (config['~experimental_resource']) {
+    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')
 }
 
 /**
  * @internal
  */
-export function _getUrl(
-  client: SanityClient | ObservableSanityClient,
-  uri: string,
-  canUseCdn = false,
-): string {
+export function _getUrl(client: Client, uri: string, canUseCdn = false): string {
   const {url, cdnUrl} = client.config()
   const base = canUseCdn ? cdnUrl : url
   return `${base}/${uri.replace(/^\//, '')}`
@@ -547,3 +568,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/data/live.ts

@@ -5,6 +5,7 @@ import {CorsOriginError} from '../http/errors'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {
   LiveEvent,
+  LiveEventGoAway,
   LiveEventMessage,
   LiveEventReconnect,
   LiveEventRestart,
@@ -12,6 +13,7 @@ import type {
   SyncTag,
 } from '../types'
 import {shareReplayLatest} from '../util/shareReplayLatest'
+import * as validate from '../validators'
 import {_getDataUrl} from './dataMethods'
 import {connectEventSource} from './eventsource'
 import {eventSourcePolyfill} from './eventsourcePolyfill'
@@ -43,6 +45,7 @@ export class LiveClient {
      */
     tag?: string
   } = {}): Observable<LiveEvent> {
+    validate.resourceGuard('live', this.#client.config())
     const {
       projectId,
       apiVersion: _apiVersion,
@@ -101,6 +104,7 @@ export class LiveClient {
       'restart',
       'welcome',
       'reconnect',
+      'goaway',
     ]).pipe(
       reconnectOnConnectionFailure(),
       map((event) => {
@@ -109,7 +113,7 @@ export class LiveClient {
           // Splat data properties from the eventsource message onto the returned event
           return {...rest, tags: (data as {tags: SyncTag[]}).tags} as LiveEventMessage
         }
-        return event as LiveEventRestart | LiveEventReconnect | LiveEventWelcome
+        return event as LiveEventRestart | LiveEventReconnect | LiveEventWelcome | LiveEventGoAway
       }),
     )