@sanity/client 6.28.3-instruct.0 → 6.28.3-resources.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.28.3-instruct.0",
+  "version": "6.28.3-resources.0",
   "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/SanityClient.ts

@@ -1,7 +1,6 @@
 import {lastValueFrom, Observable} from 'rxjs'
 
 import {AssetsClient, ObservableAssetsClient} from './assets/AssetsClient'
-import {AssistClient, ObservableAssistClient} from './assist/AssistClient'
 import {defaultConfig, initConfig} from './config'
 import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
@@ -66,7 +65,7 @@ export class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  assist: ObservableAssistClient
+
   /**
    * Private properties
    */
@@ -88,7 +87,6 @@ export class ObservableSanityClient {
     this.live = new LiveClient(this)
     this.projects = new ObservableProjectsClient(this, this.#httpRequest)
     this.users = new ObservableUsersClient(this, this.#httpRequest)
-    this.assist = new ObservableAssistClient(this, this.#httpRequest)
   }
 
   /**
@@ -735,7 +733,6 @@ export class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
-  assist: AssistClient
 
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
@@ -763,7 +760,6 @@ export class SanityClient {
     this.live = new LiveClient(this)
     this.projects = new ProjectsClient(this, this.#httpRequest)
     this.users = new UsersClient(this, this.#httpRequest)
-    this.assist = new AssistClient(this, this.#httpRequest)
 
     this.observable = new ObservableSanityClient(httpRequest, config)
   }

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,29 @@ 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']) {
+    return `${config['~experimental_resource'].type}/${config['~experimental_resource'].id}/assets/${assetTypeEndpoint}`
+  }
+
+  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.resourceBase(newConfig)
+  }
+
   if (typeof newConfig.perspective !== 'undefined') {
     validateApiPerspective(newConfig.perspective)
   }
@@ -122,7 +111,13 @@ export const initConfig = (
   const isBrowser = typeof window !== 'undefined' && window.location && window.location.hostname
   const isLocalhost = isBrowser && isLocal(window.location.hostname)
 
-  if (isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== true) {
+  const hasToken = Boolean(newConfig.token)
+  if (newConfig.withCredentials && hasToken) {
+    warnings.printCredentialedTokenWarning()
+    newConfig.withCredentials = false
+  }
+
+  if (isBrowser && isLocalhost && hasToken && newConfig.ignoreBrowserTokenWarning !== true) {
     warnings.printBrowserTokenWarning()
   } else if (typeof newConfig.useCdn === 'undefined') {
     warnings.printCdnWarning()
@@ -160,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

@@ -12,6 +12,7 @@ import type {
   Any,
   BaseActionOptions,
   BaseMutationOptions,
+  ClientConfig,
   FirstDocumentIdMutationOptions,
   FirstDocumentMutationOptions,
   HttpRequest,
@@ -366,6 +367,43 @@ 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 isQuery = (config: ClientConfig, uri: string) =>
+  uri.startsWith('/data/query/') ||
+  (config['~experimental_resource'] &&
+    uri.startsWith(
+      `/${config['~experimental_resource'].type}/${config['~experimental_resource'].id}/query`,
+    ))
+const isMutate = (config: ClientConfig, uri: string) =>
+  uri.startsWith('/data/mutate/') ||
+  (config['~experimental_resource'] &&
+    uri.startsWith(
+      `/${config['~experimental_resource'].type}/${config['~experimental_resource'].id}/mutate`,
+    ))
+const isDoc = (config: ClientConfig, uri: string) =>
+  uri.startsWith('/data/doc/') ||
+  (config['~experimental_resource'] &&
+    uri.startsWith(
+      `/${config['~experimental_resource'].type}/${config['~experimental_resource'].id}/doc/`,
+    ))
+const isListener = (config: ClientConfig, uri: string) =>
+  uri.startsWith('/data/listen/') ||
+  (config['~experimental_resource'] &&
+    uri.startsWith(
+      `/${config['~experimental_resource'].type}/${config['~experimental_resource'].id}/listen`,
+    ))
+const isHistory = (config: ClientConfig, uri: string) =>
+  uri.startsWith('/data/history/') ||
+  (config['~experimental_resource'] &&
+    uri.startsWith(
+      `/${config['~experimental_resource'].type}/${config['~experimental_resource'].id}/history/`,
+    ))
+const isData = (config: ClientConfig, uri: string) =>
+  uri.startsWith('/data/') ||
+  isQuery(config, uri) ||
+  isMutate(config, uri) ||
+  isDoc(config, uri) ||
+  isListener(config, uri) ||
+  isHistory(config, uri)
 
 /**
  * @internal
@@ -382,7 +420,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(config, uri)
       : options.canUseCdn
 
   let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn
@@ -397,10 +435,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(config, uri)) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap
     if (resultSourceMap !== undefined && resultSourceMap !== false) {
       options.query = {resultSourceMap, ...options.query}
@@ -482,6 +517,11 @@ export function _getDataUrl(
   path?: string,
 ): string {
   const config = client.config()
+  if (config['~experimental_resource']) {
+    const resourceBase = validators.resourceBase(config)
+    const uri = path ? `${operation}/${path}` : operation
+    return `${resourceBase}/${uri}`.replace(/\/($|\?)/, '$1')
+  }
   const catalog = validators.hasDataset(config)
   const baseUri = `/${operation}/${catalog}`
   const uri = path ? `${baseUri}/${path}` : baseUri

package/src/data/listen.ts

@@ -84,7 +84,7 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
   const listenFor = options.events ? options.events : ['mutation']
 
   const esOptions: EventSourceInit & {headers?: Record<string, string>} = {}
-  if (token || withCredentials) {
+  if (withCredentials) {
     esOptions.withCredentials = true
   }
 

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/http/requestOptions.ts

@@ -18,7 +18,7 @@ export function requestOptions(config: Any, overrides: Any = {}): Omit<RequestOp
 
   const withCredentials = Boolean(
     typeof overrides.withCredentials === 'undefined'
-      ? config.token || config.withCredentials
+      ? config.withCredentials
       : overrides.withCredentials,
   )
 

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,11 @@ export type ClientPerspective =
   | 'raw'
   | StackablePerspective[]
 
+type ClientConfigResource = {
+  type: string
+  id: string
+}
+
 /** @public */
 export interface ClientConfig {
   projectId?: string
@@ -61,6 +66,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
@@ -1336,16 +1344,6 @@ export type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
-export type {
-  AssistAsyncInstruction,
-  AssistInstruction,
-  AssistSyncInstruction,
-  ConstantInstructionParam,
-  FieldInstructionParam,
-  GroqInstructionParam,
-  InstructionParam,
-  InstructionParams,
-} from './assist/types'
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/src/validators.ts

@@ -76,3 +76,26 @@ export const requestTag = (tag: string) => {
 
   return tag
 }
+
+export const resourceBase = (config: InitializedClientConfig): string => {
+  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}`
+}
+
+export const resourceGuard = (service: string, config: InitializedClientConfig): void => {
+  if (config['~experimental_resource']) {
+    throw new Error(`\`${service}\` does not support resource-based operations`)
+  }
+}

package/src/warnings.ts

@@ -33,6 +33,11 @@ export const printBrowserTokenWarning = createWarningPrinter([
   )} for more information and how to hide this warning.`,
 ])
 
+export const printCredentialedTokenWarning = createWarningPrinter([
+  'You have configured Sanity client to use a token, but also provided `withCredentials: true`.',
+  'This is no longer supported - only token will be used - remove `withCredentials: true`.',
+])
+
 export const printNoApiVersionSpecifiedWarning = createWarningPrinter([
   'Using the Sanity client without specifying an API version is deprecated.',
   `See ${generateHelpUrl('js-client-api-version')}`,