@sanity/client 7.0.1-canary.2 → 7.2.0

package/src/assets/AssetsClient.ts

@@ -17,91 +17,7 @@ import type {
 import * as validators from '../validators'
 
 /** @internal */
-export interface ObservableAssetsClientType {
-  /**
-   * Uploads a file asset to the configured dataset
-   *
-   * @param assetType - Asset type (file)
-   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options - Options to use for the upload
-   */
-  upload(
-    assetType: 'file',
-    body: UploadBody,
-    options?: UploadClientConfig,
-  ): Observable<HttpRequestEvent<{document: SanityAssetDocument}>>
-
-  /**
-   * Uploads an image asset to the configured dataset
-   *
-   * @param assetType - Asset type (image)
-   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options - Options to use for the upload
-   */
-  upload(
-    assetType: 'image',
-    body: UploadBody,
-    options?: UploadClientConfig,
-  ): Observable<HttpRequestEvent<{document: SanityImageAssetDocument}>>
-
-  /**
-   * Uploads a file or an image asset to the configured dataset
-   *
-   * @param assetType - Asset type (file/image)
-   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options - Options to use for the upload
-   */
-  upload(
-    assetType: 'file' | 'image',
-    body: UploadBody,
-    options?: UploadClientConfig,
-  ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>>
-}
-
-/** @internal */
-export interface AssetsClientType {
-  /**
-   * Uploads a file asset to the configured dataset
-   *
-   * @param assetType - Asset type (file)
-   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options - Options to use for the upload
-   */
-  upload(
-    assetType: 'file',
-    body: UploadBody,
-    options?: UploadClientConfig,
-  ): Promise<SanityAssetDocument>
-
-  /**
-   * Uploads an image asset to the configured dataset
-   *
-   * @param assetType - Asset type (image)
-   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options - Options to use for the upload
-   */
-  upload(
-    assetType: 'image',
-    body: UploadBody,
-    options?: UploadClientConfig,
-  ): Promise<SanityImageAssetDocument>
-
-  /**
-   * Uploads a file or an image asset to the configured dataset
-   *
-   * @param assetType - Asset type (file/image)
-   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options - Options to use for the upload
-   */
-  upload(
-    assetType: 'file' | 'image',
-    body: UploadBody,
-    options?: UploadClientConfig,
-  ): Promise<SanityAssetDocument | SanityImageAssetDocument>
-}
-
-/** @internal */
-export class ObservableAssetsClient implements ObservableAssetsClientType {
+export class ObservableAssetsClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
@@ -156,7 +72,7 @@ export class ObservableAssetsClient implements ObservableAssetsClientType {
 }
 
 /** @internal */
-export class AssetsClient implements AssetsClientType {
+export class AssetsClient {
   #client: SanityClient
   #httpRequest: HttpRequest
   constructor(client: SanityClient, httpRequest: HttpRequest) {

package/src/data/dataMethods.ts

@@ -1,3 +1,4 @@
+import {getVersionFromId, getVersionId, isDraftId} from '@sanity/client/csm'
 import {from, type MonoTypeOperatorFunction, Observable} from 'rxjs'
 import {combineLatestWith, filter, map} from 'rxjs/operators'
 
@@ -12,6 +13,8 @@ import type {
   Any,
   BaseActionOptions,
   BaseMutationOptions,
+  CreateVersionAction,
+  DiscardVersionAction,
   FirstDocumentIdMutationOptions,
   FirstDocumentMutationOptions,
   HttpRequest,
@@ -25,11 +28,13 @@ import type {
   MutationSelection,
   QueryOptions,
   RawQueryResponse,
+  ReplaceVersionAction,
   RequestObservableOptions,
   RequestOptions,
   SanityDocument,
   SingleActionResult,
   SingleMutationResult,
+  UnpublishVersionAction,
 } from '../types'
 import {getSelection} from '../util/getSelection'
 import * as validate from '../validators'
@@ -132,10 +137,36 @@ export function _getDocument<R extends Record<string, Any>>(
   client: Client,
   httpRequest: HttpRequest,
   id: string,
-  opts: {signal?: AbortSignal; tag?: string} = {},
+  opts: {signal?: AbortSignal; tag?: string; releaseId?: string} = {},
 ): Observable<SanityDocument<R> | undefined> {
+  const getDocId = () => {
+    if (!opts.releaseId) {
+      return id
+    }
+
+    const versionId = getVersionFromId(id)
+    if (!versionId) {
+      if (isDraftId(id)) {
+        throw new Error(
+          `The document ID (\`${id}\`) is a draft, but \`options.releaseId\` is set as \`${opts.releaseId}\``,
+        )
+      }
+
+      return getVersionId(id, opts.releaseId)
+    }
+
+    if (versionId !== opts.releaseId) {
+      throw new Error(
+        `The document ID (\`${id}\`) is already a version of \`${versionId}\` release, but this does not match the provided \`options.releaseId\` (\`${opts.releaseId}\`)`,
+      )
+    }
+
+    return id
+  }
+  const docId = getDocId()
+
   const options = {
-    uri: _getDataUrl(client, 'doc', id),
+    uri: _getDataUrl(client, 'doc', docId),
     json: true,
     tag: opts.tag,
     signal: opts.signal,
@@ -168,6 +199,27 @@ export function _getDocuments<R extends Record<string, Any>>(
   )
 }
 
+/** @internal */
+export function _getReleaseDocuments<R extends Record<string, Any>>(
+  client: ObservableSanityClient | SanityClient,
+  httpRequest: HttpRequest,
+  releaseId: string,
+  opts: BaseMutationOptions = {},
+): Observable<RawQueryResponse<SanityDocument<R>[]>> {
+  return _dataRequest(
+    client,
+    httpRequest,
+    'query',
+    {
+      query: '*[sanity::partOfRelease($releaseId)]',
+      params: {
+        releaseId,
+      },
+    },
+    opts,
+  )
+}
+
 /** @internal */
 export function _createIfNotExists<R extends Record<string, Any>>(
   client: Client,
@@ -204,6 +256,26 @@ export function _createOrReplace<R extends Record<string, Any>>(
   return _create<R>(client, httpRequest, doc, 'createOrReplace', options)
 }
 
+/** @internal */
+export function _createVersion<R extends Record<string, Any>>(
+  client: ObservableSanityClient | SanityClient,
+  httpRequest: HttpRequest,
+  doc: IdentifiedSanityDocumentStub<R>,
+  publishedId: string,
+  options?: BaseActionOptions,
+): Observable<SingleActionResult> {
+  validators.requireDocumentId('createVersion', doc)
+  validators.requireDocumentType('createVersion', doc)
+
+  const createVersionAction: CreateVersionAction = {
+    actionType: 'sanity.action.document.version.create',
+    publishedId,
+    document: doc,
+  }
+
+  return _action(client, httpRequest, createVersionAction, options)
+}
+
 /** @internal */
 export function _delete<R extends Record<string, Any>>(
   client: Client,
@@ -227,6 +299,58 @@ export function _delete<R extends Record<string, Any>>(
   )
 }
 
+/** @internal */
+export function _discardVersion(
+  client: ObservableSanityClient | SanityClient,
+  httpRequest: HttpRequest,
+  versionId: string,
+  purge: boolean = false,
+  options?: BaseActionOptions,
+): Observable<SingleActionResult> {
+  const discardVersionAction: DiscardVersionAction = {
+    actionType: 'sanity.action.document.version.discard',
+    versionId,
+    purge,
+  }
+
+  return _action(client, httpRequest, discardVersionAction, options)
+}
+
+/** @internal */
+export function _replaceVersion<R extends Record<string, Any>>(
+  client: ObservableSanityClient | SanityClient,
+  httpRequest: HttpRequest,
+  doc: IdentifiedSanityDocumentStub<R>,
+  options?: BaseActionOptions,
+): Observable<SingleActionResult> {
+  validators.requireDocumentId('replaceVersion', doc)
+  validators.requireDocumentType('replaceVersion', doc)
+
+  const replaceVersionAction: ReplaceVersionAction = {
+    actionType: 'sanity.action.document.version.replace',
+    document: doc,
+  }
+
+  return _action(client, httpRequest, replaceVersionAction, options)
+}
+
+/** @internal */
+export function _unpublishVersion(
+  client: ObservableSanityClient | SanityClient,
+  httpRequest: HttpRequest,
+  versionId: string,
+  publishedId: string,
+  options?: BaseActionOptions,
+): Observable<SingleActionResult> {
+  const unpublishVersionAction: UnpublishVersionAction = {
+    actionType: 'sanity.action.document.version.unpublish',
+    versionId,
+    publishedId,
+  }
+
+  return _action(client, httpRequest, unpublishVersionAction, options)
+}
+
 /** @internal */
 export function _mutate<R extends Record<string, Any>>(
   client: Client,
@@ -549,7 +673,7 @@ const isDomExceptionSupported = Boolean(globalThis.DOMException)
 
 /**
  * @internal
- * @param signal
+ * @param signal - The abort signal to use.
  * Original source copied from https://github.com/sindresorhus/ky/blob/740732c78aad97e9aec199e9871bdbf0ae29b805/source/errors/DOMException.ts
  * TODO: When targeting Node.js 18, use `signal.throwIfAborted()` (https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/throwIfAborted)
  */

package/src/data/transaction.ts

@@ -253,7 +253,7 @@ export class Transaction extends BaseTransaction {
       return this._add({patch: patch.serialize()})
     }
 
-    /**
+    /*
      * transaction.patch(
      *   {query: "*[_type == 'person' && points >= $threshold]", params: { threshold: 100 }},
      *   {dec: { points: 100 }, inc: { bonuses: 1 }}

package/src/datasets/DatasetsClient.ts

@@ -6,69 +6,7 @@ import type {DatasetAclMode, DatasetResponse, DatasetsResponse, HttpRequest} fro
 import * as validate from '../validators'
 
 /** @internal */
-export interface ObservableDatasetsClientType {
-  /**
-   * Create a new dataset with the given name
-   *
-   * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
-   */
-  create(name: string, options?: {aclMode?: DatasetAclMode}): Observable<DatasetResponse>
-
-  /**
-   * Edit a dataset with the given name
-   *
-   * @param name - Name of the dataset to edit
-   * @param options - New options for the dataset
-   */
-  edit(name: string, options?: {aclMode?: DatasetAclMode}): Observable<DatasetResponse>
-
-  /**
-   * Delete a dataset with the given name
-   *
-   * @param name - Name of the dataset to delete
-   */
-  delete(name: string): Observable<{deleted: true}>
-
-  /**
-   * Fetch a list of datasets for the configured project
-   */
-  list(): Observable<DatasetsResponse>
-}
-
-/** @internal */
-export interface DatasetsClientType {
-  /**
-   * Create a new dataset with the given name
-   *
-   * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
-   */
-  create(name: string, options?: {aclMode?: DatasetAclMode}): Promise<DatasetResponse>
-
-  /**
-   * Edit a dataset with the given name
-   *
-   * @param name - Name of the dataset to edit
-   * @param options - New options for the dataset
-   */
-  edit(name: string, options?: {aclMode?: DatasetAclMode}): Promise<DatasetResponse>
-
-  /**
-   * Delete a dataset with the given name
-   *
-   * @param name - Name of the dataset to delete
-   */
-  delete(name: string): Promise<{deleted: true}>
-
-  /**
-   * Fetch a list of datasets for the configured project
-   */
-  list(): Promise<DatasetsResponse>
-}
-
-/** @internal */
-export class ObservableDatasetsClient implements ObservableDatasetsClientType {
+export class ObservableDatasetsClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
@@ -117,7 +55,7 @@ export class ObservableDatasetsClient implements ObservableDatasetsClientType {
 }
 
 /** @internal */
-export class DatasetsClient implements DatasetsClientType {
+export class DatasetsClient {
   #client: SanityClient
   #httpRequest: HttpRequest
   constructor(client: SanityClient, httpRequest: HttpRequest) {

package/src/projects/ProjectsClient.ts

@@ -6,49 +6,7 @@ import type {HttpRequest, SanityProject} from '../types'
 import * as validate from '../validators'
 
 /** @internal */
-export interface ObservableProjectsClientType {
-  /**
-   * Fetch a list of projects the authenticated user has access to.
-   *
-   * @param options - Options for the list request
-   * @param options.includeMembers - Whether to include members in the response (default: true)
-   */
-  list(options?: {includeMembers?: true}): Observable<SanityProject[]>
-  list(options?: {includeMembers?: false}): Observable<Omit<SanityProject, 'members'>[]>
-  list(options?: {
-    includeMembers?: boolean
-  }): Observable<SanityProject[] | Omit<SanityProject, 'members'>[]>
-
-  /**
-   * Fetch a project by project ID
-   *
-   * @param projectId - ID of the project to fetch
-   */
-  getById(projectId: string): Observable<SanityProject>
-}
-
-/** @internal */
-export interface ProjectsClientType {
-  /**
-   * Fetch a list of projects the authenticated user has access to.
-   *
-   * @param options - Options for the list request
-   * @param options.includeMembers - Whether to include members in the response (default: true)
-   */
-  list(options?: {includeMembers?: true}): Promise<SanityProject[]>
-  list(options?: {includeMembers?: false}): Promise<Omit<SanityProject, 'members'>[]>
-  list(options?: {includeMembers?: boolean}): Promise<SanityProject[]>
-
-  /**
-   * Fetch a project by project ID
-   *
-   * @param projectId - ID of the project to fetch
-   */
-  getById(projectId: string): Promise<SanityProject>
-}
-
-/** @internal */
-export class ObservableProjectsClient implements ObservableProjectsClientType {
+export class ObservableProjectsClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
@@ -60,7 +18,7 @@ export class ObservableProjectsClient implements ObservableProjectsClientType {
    * Fetch a list of projects the authenticated user has access to.
    *
    * @param options - Options for the list request
-   * @param options.includeMembers - Whether to include members in the response (default: true)
+   *   - `includeMembers` - Whether to include members in the response (default: true)
    */
   list(options?: {includeMembers?: true}): Observable<SanityProject[]>
   list(options?: {includeMembers?: false}): Observable<Omit<SanityProject, 'members'>[]>
@@ -84,7 +42,7 @@ export class ObservableProjectsClient implements ObservableProjectsClientType {
 }
 
 /** @internal */
-export class ProjectsClient implements ProjectsClientType {
+export class ProjectsClient {
   #client: SanityClient
   #httpRequest: HttpRequest
   constructor(client: SanityClient, httpRequest: HttpRequest) {
@@ -96,7 +54,7 @@ export class ProjectsClient implements ProjectsClientType {
    * Fetch a list of projects the authenticated user has access to.
    *
    * @param options - Options for the list request
-   * @param options.includeMembers - Whether to include members in the response (default: true)
+   *   - `includeMembers` - Whether to include members in the response (default: true)
    */
   list(options?: {includeMembers?: true}): Promise<SanityProject[]>
   list(options?: {includeMembers?: false}): Promise<Omit<SanityProject, 'members'>[]>