@sanity/client 7.6.0 → 7.8.0

package/dist/index.browser.d.cts

@@ -698,6 +698,30 @@ export declare interface ClientConfig {
    */
   headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
+  /**
+   * Ignore specific warning messages from the client.
+   *
+   * @remarks
+   * - String values perform substring matching (not exact matching) against warning messages
+   * - RegExp values are tested against the full warning message
+   * - Array values allow multiple patterns to be specified
+   *
+   * @example
+   * ```typescript
+   * // Ignore warnings containing "experimental"
+   * ignoreWarnings: 'experimental'
+   *
+   * // Ignore multiple warning types
+   * ignoreWarnings: ['experimental', 'deprecated']
+   *
+   * // Use regex for exact matching
+   * ignoreWarnings: /^This is an experimental API version$/
+   *
+   * // Mix strings and regex patterns
+   * ignoreWarnings: ['rate limit', /^deprecated/i]
+   * ```
+   */
+  ignoreWarnings?: string | RegExp | Array<string | RegExp>
   withCredentials?: boolean
   allowReconfigure?: boolean
   timeout?: number
@@ -981,16 +1005,29 @@ export declare interface CreateReleaseAction {
 }
 
 /**
- * Creates a new version of an existing document, attached to the release as given
- * by `document._id`
+ * Creates a new version of an existing document.
+ *
+ * If the `document` is provided, the version is created from the document
+ * attached to the release as given by `document._id`
+ *
+ * If the `baseId` and `versionId` are provided, the version is created from the base document
+ * and the version is attached to the release as given by `publishedId` and `versionId`
  *
  * @public
  */
-export declare interface CreateVersionAction {
+export declare type CreateVersionAction = {
   actionType: 'sanity.action.document.version.create'
   publishedId: string
-  document: IdentifiedSanityDocumentStub
-}
+} & (
+  | {
+      document: IdentifiedSanityDocumentStub
+    }
+  | {
+      baseId: string
+      versionId: string
+      ifBaseRevisionId?: string
+    }
+)
 
 /** @public */
 export declare interface CurrentSanityUser {
@@ -1274,6 +1311,26 @@ export declare type EventSourceEvent<Name extends string> = ServerSentEvent<Name
  */
 export declare type EventSourceInstance = InstanceType<typeof globalThis.EventSource>
 
+/**
+ * A string constant containing the experimental API version warning message.
+ * Use this with the `ignoreWarnings` option to suppress warnings when using experimental API versions.
+ *
+ * @example
+ * ```typescript
+ * import { createClient, EXPERIMENTAL_API_WARNING } from '@sanity/client'
+ *
+ * const client = createClient({
+ *   projectId: 'your-project-id',
+ *   dataset: 'production',
+ *   apiVersion: 'vX', // experimental version
+ *   ignoreWarnings: EXPERIMENTAL_API_WARNING
+ * })
+ * ```
+ *
+ * @public
+ */
+export declare const EXPERIMENTAL_API_WARNING = 'This is an experimental API version'
+
 /**
  *
  *
@@ -1689,6 +1746,25 @@ export declare interface GroqAgentActionParam {
   params?: Record<string, string>
 }
 
+/**
+ * Shared properties for HTTP errors (eg both ClientError and ServerError)
+ * Use `isHttpError` for type narrowing and accessing response properties.
+ *
+ * @public
+ */
+export declare interface HttpError {
+  statusCode: number
+  message: string
+  response: {
+    body: unknown
+    url: string
+    method: string
+    headers: Record<string, string>
+    statusCode: number
+    statusMessage: string | null
+  }
+}
+
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1798,6 +1874,15 @@ export declare type InsertPatch =
       items: Any[]
     }
 
+/**
+ * Checks if the provided error is an HTTP error.
+ *
+ * @param error - The error to check.
+ * @returns `true` if the error is an HTTP error, `false` otherwise.
+ * @public
+ */
+export declare function isHttpError(error: unknown): error is HttpError
+
 /** @internal */
 export declare function isQueryParseError(error: object): error is QueryParseError
 
@@ -3047,6 +3132,15 @@ export declare class ObservableSanityClient {
     },
     options?: BaseActionOptions,
   ): Observable<SingleActionResult | MultipleActionResult>
+  createVersion(
+    args: {
+      baseId: string
+      releaseId: string
+      publishedId: string
+      ifBaseRevisionId?: string
+    },
+    options?: BaseActionOptions,
+  ): Observable<SingleActionResult | MultipleActionResult>
   /**
    * Deletes a document with the given document ID.
    * Returns an observable that resolves to the deleted document.
@@ -4762,7 +4856,8 @@ export declare class SanityClient {
    * Creates a new version of a published document.
    *
    * @remarks
-   * * Requires a document with a `_type` property.
+   * * The preferred approach is to use `baseId` to refer to the existing published document, but it is also possible to provide a complete `document` instead.
+   * * If `document` is provided, it must have a `_type` property.
    * * Creating a version with no `releaseId` will create a new draft version of the published document.
    * * If the `document._id` is defined, it should be a draft or release version ID that matches the version ID generated from `publishedId` and `releaseId`.
    * * If the `document._id` is not defined, it will be generated from `publishedId` and `releaseId`.
@@ -4771,17 +4866,18 @@ export declare class SanityClient {
    * @category Versions
    *
    * @param params - Version action parameters:
+   *   - `baseId` - The ID of the published document from which to create a new version from.
+   *   - `ifBaseRevisionId` - If `baseId` is provided, this ensures the `baseId`'s revision Id is as expected before creating the new version from it.
    *   - `document` - The document to create as a new version (must include `_type`).
    *   - `publishedId` - The ID of the published document being versioned.
    *   - `releaseId` - The ID of the release to create the version for.
    * @param options - Additional action options.
    * @returns A promise that resolves to the `transactionId`.
    *
-   * @example Creating a new version of a published document with a generated version ID
+   * @example Creating a new version of a published document
    * ```ts
    * const transactionId = await client.createVersion({
-   *   // The document does not need to include an `_id` property since it will be generated from `publishedId` and `releaseId`
-   *   document: {_type: 'myDocument', title: 'My Document'},
+   *   baseId: 'myDocument',
    *   publishedId: 'myDocument',
    *   releaseId: 'myRelease',
    * })
@@ -4794,25 +4890,11 @@ export declare class SanityClient {
    * // }
    * ```
    *
-   * @example Creating a new version of a published document with a specified version ID
-   * ```ts
-   * const transactionId = await client.createVersion({
-   *   document: {_type: 'myDocument', _id: 'versions.myRelease.myDocument', title: 'My Document'},
-   *   // `publishedId` and `releaseId` are not required since `document._id` has been specified
-   * })
-   *
-   * // The following document will be created:
-   * // {
-   * //   _id: 'versions.myRelease.myDocument',
-   * //   _type: 'myDocument',
-   * //   title: 'My Document',
-   * // }
-   * ```
    *
    * @example Creating a new draft version of a published document
    * ```ts
    * const transactionId = await client.createVersion({
-   *   document: {_type: 'myDocument', title: 'My Document'},
+   *   baseId: 'myDocument',
    *   publishedId: 'myDocument',
    * })
    *
@@ -4840,6 +4922,15 @@ export declare class SanityClient {
     },
     options?: BaseActionOptions,
   ): Promise<SingleActionResult | MultipleActionResult>
+  createVersion(
+    args: {
+      publishedId: string
+      baseId: string
+      releaseId: string
+      ifBaseRevisionId?: string
+    },
+    options?: BaseActionOptions,
+  ): Promise<SingleActionResult | MultipleActionResult>
   /**
    * Deletes a document with the given document ID.
    * Returns a promise that resolves to the deleted document.

package/dist/index.browser.d.ts

@@ -698,6 +698,30 @@ export declare interface ClientConfig {
    */
   headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
+  /**
+   * Ignore specific warning messages from the client.
+   *
+   * @remarks
+   * - String values perform substring matching (not exact matching) against warning messages
+   * - RegExp values are tested against the full warning message
+   * - Array values allow multiple patterns to be specified
+   *
+   * @example
+   * ```typescript
+   * // Ignore warnings containing "experimental"
+   * ignoreWarnings: 'experimental'
+   *
+   * // Ignore multiple warning types
+   * ignoreWarnings: ['experimental', 'deprecated']
+   *
+   * // Use regex for exact matching
+   * ignoreWarnings: /^This is an experimental API version$/
+   *
+   * // Mix strings and regex patterns
+   * ignoreWarnings: ['rate limit', /^deprecated/i]
+   * ```
+   */
+  ignoreWarnings?: string | RegExp | Array<string | RegExp>
   withCredentials?: boolean
   allowReconfigure?: boolean
   timeout?: number
@@ -981,16 +1005,29 @@ export declare interface CreateReleaseAction {
 }
 
 /**
- * Creates a new version of an existing document, attached to the release as given
- * by `document._id`
+ * Creates a new version of an existing document.
+ *
+ * If the `document` is provided, the version is created from the document
+ * attached to the release as given by `document._id`
+ *
+ * If the `baseId` and `versionId` are provided, the version is created from the base document
+ * and the version is attached to the release as given by `publishedId` and `versionId`
  *
  * @public
  */
-export declare interface CreateVersionAction {
+export declare type CreateVersionAction = {
   actionType: 'sanity.action.document.version.create'
   publishedId: string
-  document: IdentifiedSanityDocumentStub
-}
+} & (
+  | {
+      document: IdentifiedSanityDocumentStub
+    }
+  | {
+      baseId: string
+      versionId: string
+      ifBaseRevisionId?: string
+    }
+)
 
 /** @public */
 export declare interface CurrentSanityUser {
@@ -1274,6 +1311,26 @@ export declare type EventSourceEvent<Name extends string> = ServerSentEvent<Name
  */
 export declare type EventSourceInstance = InstanceType<typeof globalThis.EventSource>
 
+/**
+ * A string constant containing the experimental API version warning message.
+ * Use this with the `ignoreWarnings` option to suppress warnings when using experimental API versions.
+ *
+ * @example
+ * ```typescript
+ * import { createClient, EXPERIMENTAL_API_WARNING } from '@sanity/client'
+ *
+ * const client = createClient({
+ *   projectId: 'your-project-id',
+ *   dataset: 'production',
+ *   apiVersion: 'vX', // experimental version
+ *   ignoreWarnings: EXPERIMENTAL_API_WARNING
+ * })
+ * ```
+ *
+ * @public
+ */
+export declare const EXPERIMENTAL_API_WARNING = 'This is an experimental API version'
+
 /**
  *
  *
@@ -1689,6 +1746,25 @@ export declare interface GroqAgentActionParam {
   params?: Record<string, string>
 }
 
+/**
+ * Shared properties for HTTP errors (eg both ClientError and ServerError)
+ * Use `isHttpError` for type narrowing and accessing response properties.
+ *
+ * @public
+ */
+export declare interface HttpError {
+  statusCode: number
+  message: string
+  response: {
+    body: unknown
+    url: string
+    method: string
+    headers: Record<string, string>
+    statusCode: number
+    statusMessage: string | null
+  }
+}
+
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1798,6 +1874,15 @@ export declare type InsertPatch =
       items: Any[]
     }
 
+/**
+ * Checks if the provided error is an HTTP error.
+ *
+ * @param error - The error to check.
+ * @returns `true` if the error is an HTTP error, `false` otherwise.
+ * @public
+ */
+export declare function isHttpError(error: unknown): error is HttpError
+
 /** @internal */
 export declare function isQueryParseError(error: object): error is QueryParseError
 
@@ -3047,6 +3132,15 @@ export declare class ObservableSanityClient {
     },
     options?: BaseActionOptions,
   ): Observable<SingleActionResult | MultipleActionResult>
+  createVersion(
+    args: {
+      baseId: string
+      releaseId: string
+      publishedId: string
+      ifBaseRevisionId?: string
+    },
+    options?: BaseActionOptions,
+  ): Observable<SingleActionResult | MultipleActionResult>
   /**
    * Deletes a document with the given document ID.
    * Returns an observable that resolves to the deleted document.
@@ -4762,7 +4856,8 @@ export declare class SanityClient {
    * Creates a new version of a published document.
    *
    * @remarks
-   * * Requires a document with a `_type` property.
+   * * The preferred approach is to use `baseId` to refer to the existing published document, but it is also possible to provide a complete `document` instead.
+   * * If `document` is provided, it must have a `_type` property.
    * * Creating a version with no `releaseId` will create a new draft version of the published document.
    * * If the `document._id` is defined, it should be a draft or release version ID that matches the version ID generated from `publishedId` and `releaseId`.
    * * If the `document._id` is not defined, it will be generated from `publishedId` and `releaseId`.
@@ -4771,17 +4866,18 @@ export declare class SanityClient {
    * @category Versions
    *
    * @param params - Version action parameters:
+   *   - `baseId` - The ID of the published document from which to create a new version from.
+   *   - `ifBaseRevisionId` - If `baseId` is provided, this ensures the `baseId`'s revision Id is as expected before creating the new version from it.
    *   - `document` - The document to create as a new version (must include `_type`).
    *   - `publishedId` - The ID of the published document being versioned.
    *   - `releaseId` - The ID of the release to create the version for.
    * @param options - Additional action options.
    * @returns A promise that resolves to the `transactionId`.
    *
-   * @example Creating a new version of a published document with a generated version ID
+   * @example Creating a new version of a published document
    * ```ts
    * const transactionId = await client.createVersion({
-   *   // The document does not need to include an `_id` property since it will be generated from `publishedId` and `releaseId`
-   *   document: {_type: 'myDocument', title: 'My Document'},
+   *   baseId: 'myDocument',
    *   publishedId: 'myDocument',
    *   releaseId: 'myRelease',
    * })
@@ -4794,25 +4890,11 @@ export declare class SanityClient {
    * // }
    * ```
    *
-   * @example Creating a new version of a published document with a specified version ID
-   * ```ts
-   * const transactionId = await client.createVersion({
-   *   document: {_type: 'myDocument', _id: 'versions.myRelease.myDocument', title: 'My Document'},
-   *   // `publishedId` and `releaseId` are not required since `document._id` has been specified
-   * })
-   *
-   * // The following document will be created:
-   * // {
-   * //   _id: 'versions.myRelease.myDocument',
-   * //   _type: 'myDocument',
-   * //   title: 'My Document',
-   * // }
-   * ```
    *
    * @example Creating a new draft version of a published document
    * ```ts
    * const transactionId = await client.createVersion({
-   *   document: {_type: 'myDocument', title: 'My Document'},
+   *   baseId: 'myDocument',
    *   publishedId: 'myDocument',
    * })
    *
@@ -4840,6 +4922,15 @@ export declare class SanityClient {
     },
     options?: BaseActionOptions,
   ): Promise<SingleActionResult | MultipleActionResult>
+  createVersion(
+    args: {
+      publishedId: string
+      baseId: string
+      releaseId: string
+      ifBaseRevisionId?: string
+    },
+    options?: BaseActionOptions,
+  ): Promise<SingleActionResult | MultipleActionResult>
   /**
    * Deletes a document with the given document ID.
    * Returns a promise that resolves to the deleted document.

package/dist/index.browser.js

@@ -75,6 +75,12 @@ function columnToLine(column, lines) {
   };
 }
 const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
+function isHttpError(error) {
+  if (!isRecord(error))
+    return !1;
+  const response = error.response;
+  return !(typeof error.statusCode != "number" || typeof error.message != "string" || !isRecord(response) || typeof response.body > "u" || typeof response.url != "string" || typeof response.method != "string" || typeof response.headers != "object" || typeof response.statusCode != "number");
+}
 class ClientError extends Error {
   response;
   statusCode = 400;
@@ -175,22 +181,22 @@ const httpError = {
     return res;
   }
 };
-function printWarnings() {
-  const seen = {};
+function printWarnings(config = {}) {
+  const seen = {}, shouldIgnoreWarning = (message) => config.ignoreWarnings === void 0 ? !1 : (Array.isArray(config.ignoreWarnings) ? config.ignoreWarnings : [config.ignoreWarnings]).some((pattern) => typeof pattern == "string" ? message.includes(pattern) : pattern instanceof RegExp ? pattern.test(message) : !1);
   return {
     onResponse: (res) => {
       const warn = res.headers["x-sanity-warning"], warnings = Array.isArray(warn) ? warn : [warn];
       for (const msg of warnings)
-        !msg || seen[msg] || (seen[msg] = !0, console.warn(msg));
+        !msg || seen[msg] || shouldIgnoreWarning(msg) || (seen[msg] = !0, console.warn(msg));
       return res;
     }
   };
 }
-function defineHttpRequest(envMiddleware2) {
+function defineHttpRequest(envMiddleware2, config = {}) {
   return getIt([
     retry({ shouldRetry }),
     ...envMiddleware2,
-    printWarnings(),
+    printWarnings(config),
     jsonRequest(),
     jsonResponse(),
     progress(),
@@ -280,7 +286,7 @@ const VALID_ASSET_TYPES = ["image", "file"], VALID_INSERT_LOCATIONS = ["before",
 }, resourceGuard = (service, config) => {
   if (config["~experimental_resource"])
     throw new Error(`\`${service}\` does not support resource-based operations`);
-};
+}, EXPERIMENTAL_API_WARNING = "This is an experimental API version";
 function once(fn) {
   let didCall = !1, returnValue;
   return (...args) => (didCall || (returnValue = fn(...args), didCall = !0), returnValue);
@@ -313,6 +319,8 @@ const createWarningPrinter = (message) => (
   `See ${generateHelpUrl("js-client-api-version")}`
 ]), printNoDefaultExport = createWarningPrinter([
   "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."
 ]), defaultCdnHost = "apicdn.sanity.io", defaultConfig = {
   apiHost: "https://api.sanity.io",
   apiVersion: "1",
@@ -948,12 +956,27 @@ function _createOrReplace(client, httpRequest, doc, options) {
   return requireDocumentId("createOrReplace", doc), _create(client, httpRequest, doc, "createOrReplace", options);
 }
 function _createVersion(client, httpRequest, doc, publishedId, options) {
-  return requireDocumentId("createVersion", doc), requireDocumentType("createVersion", doc), _action(client, httpRequest, {
+  return requireDocumentId("createVersion", doc), requireDocumentType("createVersion", doc), printCreateVersionWithBaseIdWarning(), _action(client, httpRequest, {
     actionType: "sanity.action.document.version.create",
     publishedId,
     document: doc
   }, options);
 }
+function _createVersionFromBase(client, httpRequest, publishedId, baseId, releaseId, ifBaseRevisionId, options) {
+  if (!baseId)
+    throw new Error("`createVersion()` requires `baseId` when no `document` is provided");
+  if (!publishedId)
+    throw new Error("`createVersion()` requires `publishedId` when `baseId` is provided");
+  validateDocumentId("createVersion", baseId), validateDocumentId("createVersion", publishedId);
+  const createVersionAction = {
+    actionType: "sanity.action.document.version.create",
+    publishedId,
+    baseId,
+    versionId: releaseId ? getVersionId(publishedId, releaseId) : getDraftId(publishedId),
+    ifBaseRevisionId
+  };
+  return _action(client, httpRequest, createVersionAction, options);
+}
 function _delete(client, httpRequest, selection, options) {
   return _dataRequest(
     client,
@@ -2239,8 +2262,20 @@ class ObservableSanityClient {
   createVersion({
     document,
     publishedId,
-    releaseId
+    releaseId,
+    baseId,
+    ifBaseRevisionId
   }, options) {
+    if (!document)
+      return _createVersionFromBase(
+        this,
+        this.#httpRequest,
+        publishedId,
+        baseId,
+        releaseId,
+        ifBaseRevisionId,
+        options
+      );
     const documentVersionId = deriveDocumentVersionId("createVersion", {
       document,
       publishedId,
@@ -2491,8 +2526,22 @@ class SanityClient {
   createVersion({
     document,
     publishedId,
-    releaseId
+    releaseId,
+    baseId,
+    ifBaseRevisionId
   }, options) {
+    if (!document)
+      return firstValueFrom(
+        _createVersionFromBase(
+          this,
+          this.#httpRequest,
+          publishedId,
+          baseId,
+          releaseId,
+          ifBaseRevisionId,
+          options
+        )
+      );
     const documentVersionId = deriveDocumentVersionId("createVersion", {
       document,
       publishedId,
@@ -2661,7 +2710,9 @@ class SanityClient {
 }
 function defineCreateClientExports(envMiddleware2, ClassConstructor) {
   return { requester: defineHttpRequest(envMiddleware2), createClient: (config) => {
-    const clientRequester = defineHttpRequest(envMiddleware2);
+    const clientRequester = defineHttpRequest(envMiddleware2, {
+      ignoreWarnings: config.ignoreWarnings
+    });
     return new ClassConstructor(
       (options, requester2) => (requester2 || clientRequester)({
         maxRedirects: 0,
@@ -2688,6 +2739,7 @@ export {
   ConnectionFailedError,
   CorsOriginError,
   DisconnectError,
+  EXPERIMENTAL_API_WARNING,
   MessageError,
   MessageParseError,
   ObservablePatch,
@@ -2701,6 +2753,7 @@ export {
   createClient,
   deprecatedCreateClient as default,
   formatQueryParseError,
+  isHttpError,
   isQueryParseError,
   requester,
   adapter as unstable__adapter,