@sanity/client 7.7.0 → 7.8.0

package/dist/index.browser.d.cts

@@ -1005,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 {
@@ -3119,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.
@@ -4834,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`.
@@ -4843,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',
    * })
@@ -4866,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',
    * })
    *
@@ -4912,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

@@ -1005,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 {
@@ -3119,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.
@@ -4834,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`.
@@ -4843,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',
    * })
@@ -4866,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',
    * })
    *
@@ -4912,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

@@ -319,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",
@@ -954,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,
@@ -2245,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,
@@ -2497,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,