@sanity/client 7.7.0 → 7.8.1

package/src/SanityClient.ts

@@ -543,18 +543,43 @@ export class ObservableSanityClient {
     },
     options?: BaseActionOptions,
   ): Observable<SingleActionResult | MultipleActionResult>
+  createVersion(
+    args: {
+      baseId: string
+      releaseId: string
+      publishedId: string
+      ifBaseRevisionId?: string
+    },
+    options?: BaseActionOptions,
+  ): Observable<SingleActionResult | MultipleActionResult>
   createVersion<R extends Record<string, Any>>(
     {
       document,
       publishedId,
       releaseId,
+      baseId,
+      ifBaseRevisionId,
     }: {
-      document: SanityDocumentStub<R> | IdentifiedSanityDocumentStub<R>
+      document?: SanityDocumentStub<R> | IdentifiedSanityDocumentStub<R>
       publishedId?: string
       releaseId?: string
+      baseId?: string
+      ifBaseRevisionId?: string
     },
     options?: BaseActionOptions,
   ): Observable<SingleActionResult | MultipleActionResult> {
+    if (!document) {
+      return dataMethods._createVersionFromBase(
+        this,
+        this.#httpRequest,
+        publishedId,
+        baseId,
+        releaseId,
+        ifBaseRevisionId,
+        options,
+      )
+    }
+
     const documentVersionId = deriveDocumentVersionId('createVersion', {
       document,
       publishedId,
@@ -1446,7 +1471,8 @@ export 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`.
@@ -1455,17 +1481,18 @@ export 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',
    * })
@@ -1478,25 +1505,11 @@ export 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',
    * })
    *
@@ -1524,18 +1537,45 @@ export class SanityClient {
     },
     options?: BaseActionOptions,
   ): Promise<SingleActionResult | MultipleActionResult>
+  createVersion(
+    args: {
+      publishedId: string
+      baseId: string
+      releaseId: string
+      ifBaseRevisionId?: string
+    },
+    options?: BaseActionOptions,
+  ): Promise<SingleActionResult | MultipleActionResult>
   createVersion<R extends Record<string, Any>>(
     {
       document,
       publishedId,
       releaseId,
+      baseId,
+      ifBaseRevisionId,
     }: {
-      document: SanityDocumentStub<R> | IdentifiedSanityDocumentStub<R>
+      document?: SanityDocumentStub<R> | IdentifiedSanityDocumentStub<R>
       publishedId?: string
       releaseId?: string
+      baseId?: string
+      ifBaseRevisionId?: string
     },
     options?: BaseActionOptions,
   ): Promise<SingleActionResult | MultipleActionResult> {
+    if (!document) {
+      return firstValueFrom(
+        dataMethods._createVersionFromBase(
+          this,
+          this.#httpRequest,
+          publishedId,
+          baseId,
+          releaseId,
+          ifBaseRevisionId,
+          options,
+        ),
+      )
+    }
+
     const documentVersionId = deriveDocumentVersionId('createVersion', {
       document,
       publishedId,

package/src/data/dataMethods.ts

@@ -1,4 +1,4 @@
-import {getVersionFromId, getVersionId, isDraftId} from '@sanity/client/csm'
+import {getDraftId, getVersionFromId, getVersionId, isDraftId} from '@sanity/client/csm'
 import {from, type MonoTypeOperatorFunction, Observable} from 'rxjs'
 import {combineLatestWith, filter, map} from 'rxjs/operators'
 
@@ -39,7 +39,11 @@ import type {
 import {getSelection} from '../util/getSelection'
 import * as validate from '../validators'
 import * as validators from '../validators'
-import {printCdnPreviewDraftsWarning, printPreviewDraftsDeprecationWarning} from '../warnings'
+import {
+  printCdnPreviewDraftsWarning,
+  printCreateVersionWithBaseIdWarning,
+  printPreviewDraftsDeprecationWarning,
+} from '../warnings'
 import {encodeQueryString} from './encodeQueryString'
 import {ObservablePatch, Patch} from './patch'
 import {ObservableTransaction, Transaction} from './transaction'
@@ -266,6 +270,7 @@ export function _createVersion<R extends Record<string, Any>>(
 ): Observable<SingleActionResult> {
   validators.requireDocumentId('createVersion', doc)
   validators.requireDocumentType('createVersion', doc)
+  printCreateVersionWithBaseIdWarning()
 
   const createVersionAction: CreateVersionAction = {
     actionType: 'sanity.action.document.version.create',
@@ -276,6 +281,38 @@ export function _createVersion<R extends Record<string, Any>>(
   return _action(client, httpRequest, createVersionAction, options)
 }
 
+/** @internal */
+export function _createVersionFromBase(
+  client: ObservableSanityClient | SanityClient,
+  httpRequest: HttpRequest,
+  publishedId?: string,
+  baseId?: string,
+  releaseId?: string,
+  ifBaseRevisionId?: string,
+  options?: BaseActionOptions,
+): Observable<SingleActionResult> {
+  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')
+  }
+
+  validators.validateDocumentId('createVersion', baseId)
+  validators.validateDocumentId('createVersion', publishedId)
+
+  const createVersionAction: CreateVersionAction = {
+    actionType: 'sanity.action.document.version.create',
+    publishedId,
+    baseId,
+    versionId: releaseId ? getVersionId(publishedId, releaseId) : getDraftId(publishedId),
+    ifBaseRevisionId,
+  }
+
+  return _action(client, httpRequest, createVersionAction, options)
+}
+
 /** @internal */
 export function _delete<R extends Record<string, Any>>(
   client: Client,

package/src/types.ts

@@ -508,6 +508,7 @@ export interface CurrentSanityUser {
   email: string
   profileImage: string | null
   role: string
+  provider: string
 }
 
 /** @public */
@@ -725,16 +726,29 @@ export interface DeleteReleaseAction {
 }
 
 /**
- * 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 interface CreateVersionAction {
+export type CreateVersionAction = {
   actionType: 'sanity.action.document.version.create'
   publishedId: string
-  document: IdentifiedSanityDocumentStub
-}
+} & (
+  | {
+      document: IdentifiedSanityDocumentStub
+    }
+  | {
+      baseId: string
+      versionId: string
+      ifBaseRevisionId?: string
+    }
+)
 
 /**
  * Delete a version of a document.

package/src/warnings.ts

@@ -46,3 +46,7 @@ export const printNoApiVersionSpecifiedWarning = createWarningPrinter([
 export const printNoDefaultExport = createWarningPrinter([
   'The default export of @sanity/client has been deprecated. Use the named export `createClient` instead.',
 ])
+
+export const printCreateVersionWithBaseIdWarning = createWarningPrinter([
+  'You have called `createVersion()` with a defined `document`. The recommended approach is to provide a `baseId` and `releaseId` instead.',
+])

package/umd/sanityClient.js

@@ -2293,6 +2293,8 @@ ${codeFrame(query, { start, end }, description)}${withTag}`;
     `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",
@@ -2928,12 +2930,27 @@ ${selectionOpts}`);
     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,
@@ -4219,8 +4236,20 @@ ${selectionOpts}`);
     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,
@@ -4471,8 +4500,22 @@ ${selectionOpts}`);
     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,