@sanity/client 7.13.2 → 7.14.0

package/dist/index.browser.d.cts

@@ -429,6 +429,7 @@ export declare type AssetMetadataType =
   | 'palette'
   | 'lqip'
   | 'blurhash'
+  | 'thumbhash'
   | 'none'
 
 /** @internal */
@@ -696,7 +697,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}
@@ -5573,6 +5593,7 @@ export declare interface SanityImageAssetDocument extends SanityAssetDocument {
     isOpaque: boolean
     lqip?: string
     blurHash?: string
+    thumbHash?: string
     dimensions: {
       _type: 'sanity.imageDimensions'
       aspectRatio: number

package/dist/index.browser.d.ts

@@ -429,6 +429,7 @@ export declare type AssetMetadataType =
   | 'palette'
   | 'lqip'
   | 'blurhash'
+  | 'thumbhash'
   | 'none'
 
 /** @internal */
@@ -696,7 +697,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}
@@ -5573,6 +5593,7 @@ export declare interface SanityImageAssetDocument extends SanityAssetDocument {
     isOpaque: boolean
     lqip?: string
     blurHash?: string
+    thumbHash?: string
     dimensions: {
       _type: 'sanity.imageDimensions'
       aspectRatio: number

package/dist/index.browser.js

@@ -257,9 +257,16 @@ const VALID_ASSET_TYPES = ["image", "file"], VALID_INSERT_LOCATIONS = ["before",
   if (!Array.isArray(items))
     throw new Error(`${signature} takes an "items"-argument which must be an array`);
 }, hasDataset = (config) => {
-  if (!config.dataset)
-    throw new Error("`dataset` must be provided to perform queries");
-  return config.dataset || "";
+  if (config.dataset)
+    return config.dataset;
+  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];
+  }
+  throw new Error("`dataset` must be provided to perform queries");
 }, requestTag = (tag) => {
   if (typeof tag != "string" || !/^[a-z0-9._-]{1,75}$/i.test(tag))
     throw new Error(
@@ -267,9 +274,10 @@ const VALID_ASSET_TYPES = ["image", "file"], VALID_INSERT_LOCATIONS = ["before",
     );
   return tag;
 }, resourceConfig = (config) => {
-  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": {
       if (id.split(".").length !== 2)
@@ -284,7 +292,7 @@ const VALID_ASSET_TYPES = ["image", "file"], VALID_INSERT_LOCATIONS = ["before",
       throw new Error(`Unsupported resource type: ${type.toString()}`);
   }
 }, resourceGuard = (service, config) => {
-  if (config["~experimental_resource"])
+  if (config.resource)
     throw new Error(`\`${service}\` does not support resource-based operations`);
 }, EXPERIMENTAL_API_WARNING = "This is an experimental API version";
 function once(fn) {
@@ -321,6 +329,9 @@ const createWarningPrinter = (message) => (
   "The default export of @sanity/client has been deprecated. Use the named export `createClient` instead."
 ]), printCreateVersionWithBaseIdWarning = createWarningPrinter([
   "You have called `createVersion()` with a defined `document`. The recommended approach is to provide a `baseId` and `releaseId` instead."
+]), 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."
 ]), defaultCdnHost = "apicdn.sanity.io", defaultConfig = {
   apiHost: "https://api.sanity.io",
   apiVersion: "1",
@@ -353,14 +364,16 @@ const initConfig = (config, prevConfig) => {
   const newConfig = {
     ...defaultConfig,
     ...specifiedConfig
-  }, projectBased = newConfig.useProjectHostname && !newConfig["~experimental_resource"];
+  };
+  newConfig["~experimental_resource"] && !newConfig.resource && (printDeprecatedResourceConfigWarning(), newConfig.resource = newConfig["~experimental_resource"]);
+  const resourceConfig$1 = newConfig.resource, projectBased = newConfig.useProjectHostname && !resourceConfig$1;
   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 (newConfig["~experimental_resource"] && resourceConfig(newConfig), typeof newConfig.perspective < "u" && validateApiPerspective(newConfig.perspective), "encodeSourceMap" in newConfig)
+  if (resourceConfig$1 && 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'?"
     );
@@ -1074,7 +1087,10 @@ function _create(client, httpRequest, doc, op, options = {}) {
   const mutation = { [op]: doc }, opts = Object.assign({ returnFirst: !0, returnDocuments: !0 }, 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);
+const hasDataConfig = (client) => {
+  const config = client.config();
+  return config.dataset !== void 0 && config.projectId !== void 0 || config.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 && isData(client, uri) : options.canUseCdn;
   let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn;
@@ -1107,7 +1123,7 @@ function _request(client, httpRequest, options) {
 }
 function _getDataUrl(client, operation, path) {
   const config = client.config();
-  if (config["~experimental_resource"]) {
+  if (config.resource) {
     resourceConfig(config);
     const resourceBase = resourceDataBase(config), uri2 = path !== void 0 ? `${operation}/${path}` : operation;
     return `${resourceBase}/${uri2}`.replace(/\/($|\?)/, "$1");
@@ -1140,9 +1156,10 @@ function _createAbortError(signal) {
   return error.name = "AbortError", error;
 }
 const resourceDataBase = (config) => {
-  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": {
       const segments = id.split(".");
@@ -1303,7 +1320,12 @@ function _upload(client, httpRequest, assetType, body, opts = {}) {
   validateAssetType(assetType);
   let meta = opts.extract || void 0;
   meta && !meta.length && (meta = ["none"]);
-  const config = client.config(), 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, isMediaLibrary = config.resource?.type === "media-library", query = isMediaLibrary ? {
+    // Media Library only supports basic parameters
+    title,
+    filename
+  } : {
+    // Content Lake supports full set of parameters
     label,
     title,
     description,
@@ -1311,7 +1333,7 @@ function _upload(client, httpRequest, assetType, body, opts = {}) {
     meta,
     creditLine
   };
-  return source && (query.sourceId = source.id, query.sourceName = source.name, query.sourceUrl = source.url), _requestObservable(client, httpRequest, {
+  return source && !isMediaLibrary && (query.sourceId = source.id, query.sourceName = source.name, query.sourceUrl = source.url), _requestObservable(client, httpRequest, {
     tag,
     method: "POST",
     timeout: options.timeout || 0,
@@ -1322,9 +1344,9 @@ function _upload(client, httpRequest, assetType, body, opts = {}) {
   });
 }
 function buildAssetUploadUrl(config, assetType) {
-  const assetTypeEndpoint = assetType === "image" ? "images" : "files";
-  if (config["~experimental_resource"]) {
-    const { type, id } = config["~experimental_resource"];
+  const assetTypeEndpoint = assetType === "image" ? "images" : "files", resource = config.resource;
+  if (resource) {
+    const { type, id } = resource;
     switch (type) {
       case "dataset":
         throw new Error(
@@ -1624,7 +1646,7 @@ class ObservableMediaLibraryVideoClient {
    * @param options - Options for transformations and expiration
    */
   getPlaybackInfo(assetIdentifier, options = {}) {
-    const configMediaLibraryId = this.#client.config()["~experimental_resource"]?.id, { instanceId, libraryId } = parseAssetInstanceId(assetIdentifier), effectiveLibraryId = libraryId || configMediaLibraryId;
+    const config = this.#client.config(), configMediaLibraryId = (config.resource || config["~experimental_resource"])?.id, { instanceId, libraryId } = parseAssetInstanceId(assetIdentifier), effectiveLibraryId = libraryId || configMediaLibraryId;
     if (!effectiveLibraryId)
       throw new Error(
         "Could not determine Media Library ID - you need to provide a valid Media Library ID in the client config or a Media Library GDR"