@sanity/client 7.13.1 → 7.14.0

package/dist/stega.browser.d.cts

@@ -423,6 +423,7 @@ export declare type AssetMetadataType =
   | 'palette'
   | 'lqip'
   | 'blurhash'
+  | 'thumbhash'
   | 'none'
 
 /** @internal */
@@ -690,7 +691,26 @@ export declare interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
-  /** @internal */
+  /**
+   * Configure the client to work with a specific Sanity resource (Media Library, Canvas, etc.)
+   * @remarks
+   * This allows the client to interact with resources beyond traditional project datasets.
+   * When configured, methods like `fetch()`, `assets.upload()`, and mutations will operate on the specified resource.
+   * @example
+   * ```ts
+   * createClient({
+   *   resource: {
+   *     type: 'media-library',
+   *     id: 'your-media-library-id'
+   *   }
+   * })
+   * ```
+   */
+  resource?: ClientConfigResource
+  /**
+   * @deprecated Use `resource` instead
+   * @internal
+   */
   '~experimental_resource'?: ClientConfigResource
   /**
    * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
@@ -5749,6 +5769,7 @@ export declare interface SanityImageAssetDocument extends SanityAssetDocument {
     isOpaque: boolean
     lqip?: string
     blurHash?: string
+    thumbHash?: string
     dimensions: {
       _type: 'sanity.imageDimensions'
       aspectRatio: number

package/dist/stega.browser.d.ts

@@ -423,6 +423,7 @@ export declare type AssetMetadataType =
   | 'palette'
   | 'lqip'
   | 'blurhash'
+  | 'thumbhash'
   | 'none'
 
 /** @internal */
@@ -690,7 +691,26 @@ export declare interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
-  /** @internal */
+  /**
+   * Configure the client to work with a specific Sanity resource (Media Library, Canvas, etc.)
+   * @remarks
+   * This allows the client to interact with resources beyond traditional project datasets.
+   * When configured, methods like `fetch()`, `assets.upload()`, and mutations will operate on the specified resource.
+   * @example
+   * ```ts
+   * createClient({
+   *   resource: {
+   *     type: 'media-library',
+   *     id: 'your-media-library-id'
+   *   }
+   * })
+   * ```
+   */
+  resource?: ClientConfigResource
+  /**
+   * @deprecated Use `resource` instead
+   * @internal
+   */
   '~experimental_resource'?: ClientConfigResource
   /**
    * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
@@ -5749,6 +5769,7 @@ export declare interface SanityImageAssetDocument extends SanityAssetDocument {
     isOpaque: boolean
     lqip?: string
     blurHash?: string
+    thumbHash?: string
     dimensions: {
       _type: 'sanity.imageDimensions'
       aspectRatio: number

package/dist/stega.d.cts

@@ -423,6 +423,7 @@ export declare type AssetMetadataType =
   | 'palette'
   | 'lqip'
   | 'blurhash'
+  | 'thumbhash'
   | 'none'
 
 /** @internal */
@@ -690,7 +691,26 @@ export declare interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
-  /** @internal */
+  /**
+   * Configure the client to work with a specific Sanity resource (Media Library, Canvas, etc.)
+   * @remarks
+   * This allows the client to interact with resources beyond traditional project datasets.
+   * When configured, methods like `fetch()`, `assets.upload()`, and mutations will operate on the specified resource.
+   * @example
+   * ```ts
+   * createClient({
+   *   resource: {
+   *     type: 'media-library',
+   *     id: 'your-media-library-id'
+   *   }
+   * })
+   * ```
+   */
+  resource?: ClientConfigResource
+  /**
+   * @deprecated Use `resource` instead
+   * @internal
+   */
   '~experimental_resource'?: ClientConfigResource
   /**
    * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
@@ -5749,6 +5769,7 @@ export declare interface SanityImageAssetDocument extends SanityAssetDocument {
     isOpaque: boolean
     lqip?: string
     blurHash?: string
+    thumbHash?: string
     dimensions: {
       _type: 'sanity.imageDimensions'
       aspectRatio: number

package/dist/stega.d.ts

@@ -423,6 +423,7 @@ export declare type AssetMetadataType =
   | 'palette'
   | 'lqip'
   | 'blurhash'
+  | 'thumbhash'
   | 'none'
 
 /** @internal */
@@ -690,7 +691,26 @@ export declare interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
-  /** @internal */
+  /**
+   * Configure the client to work with a specific Sanity resource (Media Library, Canvas, etc.)
+   * @remarks
+   * This allows the client to interact with resources beyond traditional project datasets.
+   * When configured, methods like `fetch()`, `assets.upload()`, and mutations will operate on the specified resource.
+   * @example
+   * ```ts
+   * createClient({
+   *   resource: {
+   *     type: 'media-library',
+   *     id: 'your-media-library-id'
+   *   }
+   * })
+   * ```
+   */
+  resource?: ClientConfigResource
+  /**
+   * @deprecated Use `resource` instead
+   * @internal
+   */
   '~experimental_resource'?: ClientConfigResource
   /**
    * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
@@ -5749,6 +5769,7 @@ export declare interface SanityImageAssetDocument extends SanityAssetDocument {
     isOpaque: boolean
     lqip?: string
     blurHash?: string
+    thumbHash?: string
     dimensions: {
       _type: 'sanity.imageDimensions'
       aspectRatio: number

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "7.13.1",
+  "version": "7.14.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -130,7 +130,7 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^5.0.2",
-    "get-it": "^8.6.9",
+    "get-it": "^8.7.0",
     "nanoid": "^3.3.11",
     "rxjs": "^7.0.0"
   },
@@ -161,7 +161,7 @@
     "json-diff": "^1.0.6",
     "ls-engines": "^0.9.3",
     "msw": "^2.7.3",
-    "next": "^15.3.0",
+    "next": "15.5.8",
     "nock": "^13.5.6",
     "pkg-pr-new": "^0.0.60",
     "prettier": "^3.5.3",

package/src/assets/AssetsClient.ts

@@ -153,15 +153,28 @@ function _upload(
   const config = client.config()
   const options = optionsFromFile(opts, body)
   const {tag, label, title, description, creditLine, filename, source} = options
-  const query: Any = {
-    label,
-    title,
-    description,
-    filename,
-    meta,
-    creditLine,
-  }
-  if (source) {
+  const resource = config.resource
+  const isMediaLibrary = resource?.type === 'media-library'
+
+  // Media Library has a simpler upload API with fewer supported parameters
+  const query: Any = isMediaLibrary
+    ? {
+        // Media Library only supports basic parameters
+        title,
+        filename,
+      }
+    : {
+        // Content Lake supports full set of parameters
+        label,
+        title,
+        description,
+        filename,
+        meta,
+        creditLine,
+      }
+
+  // Source parameters are only for Content Lake
+  if (source && !isMediaLibrary) {
     query.sourceId = source.id
     query.sourceName = source.name
     query.sourceUrl = source.url
@@ -180,9 +193,10 @@ function _upload(
 
 function buildAssetUploadUrl(config: InitializedClientConfig, assetType: 'image' | 'file'): string {
   const assetTypeEndpoint = assetType === 'image' ? 'images' : 'files'
+  const resource = config.resource
 
-  if (config['~experimental_resource']) {
-    const {type, id} = config['~experimental_resource']
+  if (resource) {
+    const {type, id} = resource
     switch (type) {
       case 'dataset': {
         throw new Error(

package/src/config.ts

@@ -63,7 +63,15 @@ export const initConfig = (
     ...defaultConfig,
     ...specifiedConfig,
   } as InitializedClientConfig
-  const projectBased = newConfig.useProjectHostname && !newConfig['~experimental_resource']
+
+  // Normalize resource configuration - prefer `resource` over deprecated `~experimental_resource`
+  if (newConfig['~experimental_resource'] && !newConfig.resource) {
+    warnings.printDeprecatedResourceConfigWarning()
+    newConfig.resource = newConfig['~experimental_resource']
+  }
+
+  const resourceConfig = newConfig.resource
+  const projectBased = newConfig.useProjectHostname && !resourceConfig
 
   if (typeof Promise === 'undefined') {
     const helpUrl = generateHelpUrl('js-client-promise-polyfill')
@@ -74,7 +82,7 @@ export const initConfig = (
     throw new Error('Configuration must contain `projectId`')
   }
 
-  if (newConfig['~experimental_resource']) {
+  if (resourceConfig) {
     validate.resourceConfig(newConfig)
   }
 

package/src/csm/resolveMapping.ts

@@ -28,7 +28,7 @@ export function resolveMapping(
   }
 
   const resultMappingPathArray = jsonPathArray(jsonPathToMappingPath(resultPath))
-  for (let i = resultMappingPathArray.length - 1; i > 0; i--) {
+  for (let i = resultMappingPathArray.length - 1; i >= 0; i--) {
     const key = `$${resultMappingPathArray.slice(0, i).join('')}`
     const mappingFound = csm.mappings[key]
     if (mappingFound) {

package/src/data/dataMethods.ts

@@ -559,9 +559,13 @@ 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 hasDataConfig = (client: Client) => {
+  const config = client.config()
+  return (
+    (config.dataset !== undefined && config.projectId !== undefined) ||
+    config.resource !== undefined
+  )
+}
 
 const isQuery = (client: Client, uri: string) =>
   hasDataConfig(client) && uri.startsWith(_getDataUrl(client, 'query'))
@@ -690,7 +694,8 @@ export function _request<R>(client: Client, httpRequest: HttpRequest, options: A
  */
 export function _getDataUrl(client: Client, operation: string, path?: string): string {
   const config = client.config()
-  if (config['~experimental_resource']) {
+  const resource = config.resource
+  if (resource) {
     validators.resourceConfig(config)
     const resourceBase = resourceDataBase(config)
     const uri = path !== undefined ? `${operation}/${path}` : operation
@@ -759,10 +764,11 @@ function _createAbortError(signal?: AbortSignal) {
 }
 
 const resourceDataBase = (config: InitializedClientConfig): string => {
-  if (!config['~experimental_resource']) {
+  const resource = config.resource
+  if (!resource) {
     throw new Error('`resource` must be provided to perform resource queries')
   }
-  const {type, id} = config['~experimental_resource']
+  const {type, id} = resource
 
   switch (type) {
     case 'dataset': {

package/src/mediaLibrary/MediaLibraryVideoClient.ts

@@ -29,7 +29,9 @@ export class ObservableMediaLibraryVideoClient {
     assetIdentifier: MediaLibraryAssetInstanceIdentifier,
     options: MediaLibraryPlaybackInfoOptions = {},
   ): Observable<VideoPlaybackInfo> {
-    const configMediaLibraryId = this.#client.config()['~experimental_resource']?.id
+    const config = this.#client.config()
+    const resource = config.resource || config['~experimental_resource']
+    const configMediaLibraryId = resource?.id
 
     const {instanceId, libraryId} = parseAssetInstanceId(assetIdentifier)
     const effectiveLibraryId = libraryId || configMediaLibraryId

package/src/types.ts

@@ -79,7 +79,27 @@ export interface ClientConfig {
   useCdn?: boolean
   token?: string
 
-  /** @internal */
+  /**
+   * Configure the client to work with a specific Sanity resource (Media Library, Canvas, etc.)
+   * @remarks
+   * This allows the client to interact with resources beyond traditional project datasets.
+   * When configured, methods like `fetch()`, `assets.upload()`, and mutations will operate on the specified resource.
+   * @example
+   * ```ts
+   * createClient({
+   *   resource: {
+   *     type: 'media-library',
+   *     id: 'your-media-library-id'
+   *   }
+   * })
+   * ```
+   */
+  resource?: ClientConfigResource
+
+  /**
+   * @deprecated Use `resource` instead
+   * @internal
+   */
   '~experimental_resource'?: ClientConfigResource
 
   /**
@@ -225,6 +245,7 @@ export type AssetMetadataType =
   | 'palette'
   | 'lqip'
   | 'blurhash'
+  | 'thumbhash'
   | 'none'
 
 /** @public */
@@ -349,6 +370,7 @@ export interface SanityImageAssetDocument extends SanityAssetDocument {
     isOpaque: boolean
     lqip?: string
     blurHash?: string
+    thumbHash?: string
     dimensions: {
       _type: 'sanity.imageDimensions'
       aspectRatio: number

package/src/validators.ts

@@ -82,11 +82,23 @@ export const validateInsert = (at: string, selector: string, items: Any[]) => {
 }
 
 export const hasDataset = (config: InitializedClientConfig): string => {
-  if (!config.dataset) {
-    throw new Error('`dataset` must be provided to perform queries')
+  // Check if dataset is directly on the config
+  if (config.dataset) {
+    return config.dataset
+  }
+
+  // Check if dataset is in resource configuration
+  // Note: ~experimental_resource is normalized to resource during client initialization
+  const resource = config.resource
+  if (resource && resource.type === 'dataset') {
+    const segments = resource.id.split('.')
+    if (segments.length !== 2) {
+      throw new Error('Dataset resource ID must be in the format "project.dataset"')
+    }
+    return segments[1]
   }
 
-  return config.dataset || ''
+  throw new Error('`dataset` must be provided to perform queries')
 }
 
 export const requestTag = (tag: string) => {
@@ -100,10 +112,12 @@ export const requestTag = (tag: string) => {
 }
 
 export const resourceConfig = (config: InitializedClientConfig): void => {
-  if (!config['~experimental_resource']) {
+  // Note: ~experimental_resource is normalized to resource during client initialization
+  const resource = config.resource
+  if (!resource) {
     throw new Error('`resource` must be provided to perform resource queries')
   }
-  const {type, id} = config['~experimental_resource']
+  const {type, id} = resource
 
   switch (type) {
     case 'dataset': {
@@ -125,7 +139,9 @@ export const resourceConfig = (config: InitializedClientConfig): void => {
 }
 
 export const resourceGuard = (service: string, config: InitializedClientConfig): void => {
-  if (config['~experimental_resource']) {
+  // Note: ~experimental_resource is normalized to resource during client initialization
+  const resource = config.resource
+  if (resource) {
     throw new Error(`\`${service}\` does not support resource-based operations`)
   }
 }

package/src/warnings.ts

@@ -50,3 +50,8 @@ export const printNoDefaultExport = createWarningPrinter([
 export const printCreateVersionWithBaseIdWarning = createWarningPrinter([
   'You have called `createVersion()` with a defined `document`. The recommended approach is to provide a `baseId` and `releaseId` instead.',
 ])
+
+export const printDeprecatedResourceConfigWarning = createWarningPrinter([
+  'The `~experimental_resource` configuration property has been renamed to `resource`.',
+  'Please update your client configuration to use `resource` instead. Support for `~experimental_resource` will be removed in a future version.',
+])