@sanity/client 6.28.4-beta.0 → 6.28.4-resources.4

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']

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']

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']

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']

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.28.4-beta.0",
+  "version": "6.28.4-resources.4",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -125,39 +125,39 @@
   "devDependencies": {
     "@edge-runtime/types": "^4.0.0",
     "@edge-runtime/vm": "^5.0.0",
-    "@eslint/eslintrc": "^3.2.0",
-    "@eslint/js": "^9.20.0",
-    "@rollup/plugin-commonjs": "^28.0.2",
-    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.22.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.0.4",
+    "@sanity/pkg-utils": "^7.1.1",
     "@types/json-diff": "^1.0.3",
     "@types/node": "^22.9.0",
-    "@typescript-eslint/eslint-plugin": "^8.24.0",
-    "@typescript-eslint/parser": "^8.24.0",
+    "@typescript-eslint/eslint-plugin": "^8.26.1",
+    "@typescript-eslint/parser": "^8.26.1",
     "@vercel/stega": "0.1.2",
-    "@vitest/coverage-v8": "3.0.5",
-    "eslint": "^9.20.0",
-    "eslint-config-prettier": "^10.0.1",
+    "@vitest/coverage-v8": "3.0.9",
+    "eslint": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
     "eslint-formatter-compact": "^8.40.0",
     "eslint-plugin-prettier": "^5.2.3",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "faucet": "^0.0.4",
-    "globals": "^15.14.0",
+    "globals": "^15.15.0",
     "happy-dom": "^12.10.3",
     "json-diff": "^1.0.6",
     "ls-engines": "^0.9.3",
-    "msw": "^2.7.0",
-    "next": "^15.1.7",
+    "msw": "^2.7.3",
+    "next": "^15.2.3",
     "nock": "^13.5.6",
-    "prettier": "^3.5.0",
-    "prettier-plugin-packagejson": "^2.5.8",
+    "prettier": "^3.5.3",
+    "prettier-plugin-packagejson": "^2.5.10",
     "rimraf": "^5.0.7",
-    "rollup": "^4.34.6",
+    "rollup": "^4.36.0",
     "sse-channel": "^4.0.0",
-    "terser": "^5.38.2",
-    "typescript": "5.7.3",
-    "vitest": "3.0.5"
+    "terser": "^5.39.0",
+    "typescript": "5.8.2",
+    "vitest": "3.0.9"
   },
   "packageManager": "npm@11.0.0",
   "engines": {

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

@@ -28,30 +28,15 @@ function validateApiVersion(apiVersion: string) {
   }
 }
 
-const VALID_PERSPECTIVE = /^[a-z0-9_]+$/i
-
 /**
  * @internal - it may have breaking changes in any release
  */
 export function validateApiPerspective(
   perspective: unknown,
 ): asserts perspective is ClientPerspective {
-  if (Array.isArray(perspective)) {
-    if (perspective.includes('raw')) {
-      throw new TypeError(
-        `Invalid API perspective value: "raw". The raw-perspective can not be combined with other perspectives`,
-      )
-    }
-  }
-
-  const invalid = (Array.isArray(perspective) ? perspective : [perspective]).filter(
-    (perspectiveName) =>
-      typeof perspectiveName !== 'string' || !VALID_PERSPECTIVE.test(perspectiveName),
-  )
-  if (invalid.length > 0) {
-    const formatted = invalid.map((v) => JSON.stringify(v))
+  if (Array.isArray(perspective) && perspective.length > 1 && perspective.includes('raw')) {
     throw new TypeError(
-      `Invalid API perspective value${invalid.length === 1 ? '' : 's'}: ${formatted.join(', ')}, expected \`published\`, \`drafts\`, \`raw\` or a release identifier string`,
+      `Invalid API perspective value: "raw". The raw-perspective can not be combined with other perspectives`,
     )
   }
 }
@@ -78,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')
@@ -89,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)
   }
@@ -123,11 +112,9 @@ export const initConfig = (
   const isLocalhost = isBrowser && isLocal(window.location.hostname)
 
   const hasToken = Boolean(newConfig.token)
-  let withCredentials = Boolean(newConfig.withCredentials)
-
-  if (withCredentials && hasToken) {
+  if (newConfig.withCredentials && hasToken) {
     warnings.printCredentialedTokenWarning()
-    withCredentials = false
+    newConfig.withCredentials = false
   }
 
   if (isBrowser && isLocalhost && hasToken && newConfig.ignoreBrowserTokenWarning !== true) {
@@ -154,12 +141,12 @@ export const initConfig = (
   newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, '')
   newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost
 
-  if (newConfig.useCdn === true && withCredentials) {
+  if (newConfig.useCdn === true && newConfig.withCredentials) {
     warnings.printCdnAndWithCredentialsWarning()
   }
 
   // If `useCdn` is undefined, we treat it as `true`
-  newConfig.useCdn = newConfig.useCdn !== false && !withCredentials
+  newConfig.useCdn = newConfig.useCdn !== false && !newConfig.withCredentials
 
   validateApiVersion(newConfig.apiVersion)
 
@@ -168,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,
@@ -367,6 +368,27 @@ export function _create<R extends Record<string, Any>>(
   return _dataRequest(client, httpRequest, 'mutate', {mutations: [mutation]}, opts)
 }
 
+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(client, uri) ||
+  isMutate(client, uri) ||
+  isDoc(client, uri) ||
+  isListener(client, uri) ||
+  isHistory(client, uri)
+
 /**
  * @internal
  */
@@ -382,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 && 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 +419,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}
@@ -482,9 +501,15 @@ export function _getDataUrl(
   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')
 }
 
@@ -547,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/data/live.ts

@@ -12,6 +12,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 +44,7 @@ export class LiveClient {
      */
     tag?: string
   } = {}): Observable<LiveEvent> {
+    validate.resourceGuard('live', this.#client.config())
     const {
       projectId,
       apiVersion: _apiVersion,

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

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`)
+  }
+}