@sanity/client 7.0.1-canary.1 → 7.1.0

package/src/assets/AssetsClient.ts

@@ -16,104 +16,8 @@ import type {
 } from '../types'
 import * as validators from '../validators'
 
-/**
- * The interface implemented by the `ObservableAssetsClient` class.
- * When writing code that wants to take an instance of `ObservableAssetsClient` as input it's better to use this type,
- * as the `ObservableAssetsClient` class has private properties and thus TypeScript will consider the type incompatible
- * in cases where you might have multiple `@sanity/client` instances in your node_modules.
- * @public
- */
-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}>>
-}
-
-/**
- * The interface implemented by the `AssetsClient` class.
- * When writing code that wants to take an instance of `AssetsClient` as input it's better to use this type,
- * as the `AssetsClient` class has private properties and thus TypeScript will consider the type incompatible
- * in cases where you might have multiple `@sanity/client` instances in your node_modules.
- * @public
- */
-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) {
@@ -168,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

@@ -549,7 +549,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/projects/ProjectsClient.ts

@@ -18,7 +18,7 @@ export class ObservableProjectsClient {
    * 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'>[]>
@@ -54,7 +54,7 @@ export class ProjectsClient {
    * 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'>[]>

package/src/types.ts

@@ -963,7 +963,7 @@ export interface ListenOptions {
    */
   includePreviousRevision?: boolean
 
-  /**
+  /*
    * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
    * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
    * If you need events from drafts and versions, set this to `true`.
@@ -1372,6 +1372,35 @@ export type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
+export type {
+  AgentActionParam,
+  AgentActionParams,
+  AgentActionPath,
+  AgentActionPathSegment,
+  AgentActionTarget,
+  ConstantAgentActionParam,
+  DocumentAgentActionParam,
+  FieldAgentActionParam,
+  GroqAgentActionParam,
+} from './agent/actions/commonTypes'
+export type {
+  GenerateInstruction,
+  GenerateOperation,
+  GenerateTarget,
+  GenerateTargetDocument,
+  GenerateTargetInclude,
+} from './agent/actions/generate'
+export type {
+  TransformDocument,
+  TransformTarget,
+  TransformTargetDocument,
+  TransformTargetInclude,
+} from './agent/actions/transform'
+export type {
+  TranslateDocument,
+  TranslateTarget,
+  TranslateTargetInclude,
+} from './agent/actions/translate'
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/umd/sanityClient.js

@@ -2871,6 +2871,86 @@ ${selectionOpts}`);
         throw new Error(`Unsupported resource type: ${type.toString()}`);
     }
   };
+  function _generate(client, httpRequest, request) {
+    const dataset2 = hasDataset(client.config());
+    return _request(client, httpRequest, {
+      method: "POST",
+      uri: `/agent/action/generate/${dataset2}`,
+      body: request
+    });
+  }
+  function _transform(client, httpRequest, request) {
+    const dataset2 = hasDataset(client.config());
+    return _request(client, httpRequest, {
+      method: "POST",
+      uri: `/agent/action/transform/${dataset2}`,
+      body: request
+    });
+  }
+  function _translate(client, httpRequest, request) {
+    const dataset2 = hasDataset(client.config());
+    return _request(client, httpRequest, {
+      method: "POST",
+      uri: `/agent/action/translate/${dataset2}`,
+      body: request
+    });
+  }
+  class ObservableAgentsActionClient {
+    #client;
+    #httpRequest;
+    constructor(client, httpRequest) {
+      this.#client = client, this.#httpRequest = httpRequest;
+    }
+    /**
+     * Run an instruction to generate content in a target document.
+     * @param request - instruction request
+     */
+    generate(request) {
+      return _generate(this.#client, this.#httpRequest, request);
+    }
+    /**
+     * Transform a target document based on a source.
+     * @param request - translation request
+     */
+    transform(request) {
+      return _transform(this.#client, this.#httpRequest, request);
+    }
+    /**
+     * Translate a target document based on a source.
+     * @param request - translation request
+     */
+    translate(request) {
+      return _translate(this.#client, this.#httpRequest, request);
+    }
+  }
+  class AgentActionsClient {
+    #client;
+    #httpRequest;
+    constructor(client, httpRequest) {
+      this.#client = client, this.#httpRequest = httpRequest;
+    }
+    /**
+     * Run an instruction to generate content in a target document.
+     * @param request - instruction request
+     */
+    generate(request) {
+      return lastValueFrom(_generate(this.#client, this.#httpRequest, request));
+    }
+    /**
+     * Transform a target document based on a source.
+     * @param request - translation request
+     */
+    transform(request) {
+      return lastValueFrom(_transform(this.#client, this.#httpRequest, request));
+    }
+    /**
+     * Translate a target document based on a source.
+     * @param request - translation request
+     */
+    translate(request) {
+      return lastValueFrom(_translate(this.#client, this.#httpRequest, request));
+    }
+  }
   class ObservableAssetsClient {
     #client;
     #httpRequest;
@@ -3291,11 +3371,20 @@ ${selectionOpts}`);
     live;
     projects;
     users;
+    agent;
+    /**
+     * Private properties
+     */
     #clientConfig;
     #httpRequest;
+    /**
+     * Instance properties
+     */
     listen = _listen;
     constructor(httpRequest, config = defaultConfig) {
-      this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest);
+      this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.agent = {
+        action: new ObservableAgentsActionClient(this, this.#httpRequest)
+      };
     }
     /**
      * Clone the client - returns a new instance
@@ -3434,15 +3523,24 @@ ${selectionOpts}`);
     live;
     projects;
     users;
+    agent;
     /**
      * Observable version of the Sanity client, with the same configuration as the promise-based one
      */
     observable;
+    /**
+     * Private properties
+     */
     #clientConfig;
     #httpRequest;
+    /**
+     * Instance properties
+     */
     listen = _listen;
     constructor(httpRequest, config = defaultConfig) {
-      this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
+      this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.agent = {
+        action: new AgentActionsClient(this, this.#httpRequest)
+      }, this.observable = new ObservableSanityClient(httpRequest, config);
     }
     /**
      * Clone the client - returns a new instance
@@ -3536,8 +3634,8 @@ ${selectionOpts}`);
      * @param operations - Optional object of patch operations to initialize the patch instance with
      * @returns Patch instance - call `.commit()` to perform the operations defined
      */
-    patch(selection, operations) {
-      return new Patch(selection, operations, this);
+    patch(documentId, operations) {
+      return new Patch(documentId, operations, this);
     }
     /**
      * Create a new transaction of mutations