@sanity/client 6.29.0-generate.2 → 6.29.0-generate.3

package/dist/index.d.cts

@@ -71,24 +71,45 @@ export declare type AgentActionPathSegment =
 declare class AgentActionsClient {
   #private
   constructor(client: SanityClient, httpRequest: HttpRequest)
-  generate(request: GenerateAsyncInstruction): Promise<{
-    _id: string
-  }>
+  /**
+   * Run an instruction to generate content in a target document.
+   * @param request instruction request
+   */
   generate<DocumentShape extends Record<string, Any>>(
-    request: GenerateSyncInstruction<DocumentShape>,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-  transform(request: TransformDocumentAsync): Promise<{
-    _id: string
-  }>
+    request: GenerateInstruction<DocumentShape>,
+  ): Promise<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
+  /**
+   * Transform a target document based on a source.
+   * @param request translation request
+   */
   transform<DocumentShape extends Record<string, Any>>(
-    request: TransformDocumentSync,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-  translate(request: TranslateDocumentAsync): Promise<{
-    _id: string
-  }>
+    request: TransformDocument<DocumentShape>,
+  ): Promise<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
+  /**
+   * Translate a target document based on a source.
+   * @param request translation request
+   */
   translate<DocumentShape extends Record<string, Any>>(
-    request: TranslateDocumentSync,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
+    request: TranslateDocument<DocumentShape>,
+  ): Promise<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
 }
 
 /**
@@ -1589,24 +1610,45 @@ export declare type MutationSelectionQueryParams = {
 declare class ObservableAgentsActionClient {
   #private
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  generate(request: GenerateAsyncInstruction): Observable<{
-    _id: string
-  }>
+  /**
+   * Run an instruction to generate content in a target document.
+   * @param request instruction request
+   */
   generate<DocumentShape extends Record<string, Any>>(
-    request: GenerateSyncInstruction<DocumentShape>,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-  transform(request: TransformDocumentAsync): Observable<{
-    _id: string
-  }>
+    request: GenerateInstruction<DocumentShape>,
+  ): Observable<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
+  /**
+   * Transform a target document based on a source.
+   * @param request translation request
+   */
   transform<DocumentShape extends Record<string, Any>>(
-    request: TransformDocumentSync,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-  translate(request: TranslateDocumentAsync): Observable<{
-    _id: string
-  }>
+    request: TransformDocument<DocumentShape>,
+  ): Observable<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
+  /**
+   * Translate a target document based on a source.
+   * @param request translation request
+   */
   translate<DocumentShape extends Record<string, Any>>(
-    request: TranslateDocumentSync,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
+    request: TranslateDocument<DocumentShape>,
+  ): Observable<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
 }
 
 /** @internal */
@@ -3526,13 +3568,16 @@ export declare type TransactionMutationOptions =
   | TransactionAllDocumentIdsMutationOptions
 
 /** @beta */
-export declare type TransformDocument = TransformDocumentSync | TransformDocumentAsync
+export declare type TransformDocument<T extends Record<string, Any> = Record<string, Any>> =
+  | TransformDocumentSync<T>
+  | TransformDocumentAsync
 
 /** @beta */
 declare type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
 
 /** @beta */
-declare type TransformDocumentSync = TransformRequestBase & AgentActionSync
+declare type TransformDocumentSync<T extends Record<string, Any> = Record<string, Any>> =
+  TransformRequestBase & AgentActionSync
 
 /**  @beta */
 declare interface TransformRequestBase extends AgentActionRequestBase {
@@ -3608,13 +3653,16 @@ export declare interface TransformTargetInclude extends AgentActionTargetInclude
 }
 
 /** @beta */
-export declare type TranslateDocument = TranslateDocumentSync | TranslateDocumentAsync
+export declare type TranslateDocument<T extends Record<string, Any> = Record<string, Any>> =
+  | TranslateDocumentSync<T>
+  | TranslateDocumentAsync
 
 /** @beta */
 declare type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync
 
 /** @beta */
-declare type TranslateDocumentSync = TranslateRequestBase & AgentActionSync
+declare type TranslateDocumentSync<T extends Record<string, Any> = Record<string, Any>> =
+  TranslateRequestBase & AgentActionSync
 
 /**  @beta */
 declare interface TranslateLanguage {

package/dist/index.d.ts

@@ -71,24 +71,45 @@ export declare type AgentActionPathSegment =
 declare class AgentActionsClient {
   #private
   constructor(client: SanityClient, httpRequest: HttpRequest)
-  generate(request: GenerateAsyncInstruction): Promise<{
-    _id: string
-  }>
+  /**
+   * Run an instruction to generate content in a target document.
+   * @param request instruction request
+   */
   generate<DocumentShape extends Record<string, Any>>(
-    request: GenerateSyncInstruction<DocumentShape>,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-  transform(request: TransformDocumentAsync): Promise<{
-    _id: string
-  }>
+    request: GenerateInstruction<DocumentShape>,
+  ): Promise<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
+  /**
+   * Transform a target document based on a source.
+   * @param request translation request
+   */
   transform<DocumentShape extends Record<string, Any>>(
-    request: TransformDocumentSync,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-  translate(request: TranslateDocumentAsync): Promise<{
-    _id: string
-  }>
+    request: TransformDocument<DocumentShape>,
+  ): Promise<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
+  /**
+   * Translate a target document based on a source.
+   * @param request translation request
+   */
   translate<DocumentShape extends Record<string, Any>>(
-    request: TranslateDocumentSync,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
+    request: TranslateDocument<DocumentShape>,
+  ): Promise<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
 }
 
 /**
@@ -1589,24 +1610,45 @@ export declare type MutationSelectionQueryParams = {
 declare class ObservableAgentsActionClient {
   #private
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  generate(request: GenerateAsyncInstruction): Observable<{
-    _id: string
-  }>
+  /**
+   * Run an instruction to generate content in a target document.
+   * @param request instruction request
+   */
   generate<DocumentShape extends Record<string, Any>>(
-    request: GenerateSyncInstruction<DocumentShape>,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-  transform(request: TransformDocumentAsync): Observable<{
-    _id: string
-  }>
+    request: GenerateInstruction<DocumentShape>,
+  ): Observable<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
+  /**
+   * Transform a target document based on a source.
+   * @param request translation request
+   */
   transform<DocumentShape extends Record<string, Any>>(
-    request: TransformDocumentSync,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-  translate(request: TranslateDocumentAsync): Observable<{
-    _id: string
-  }>
+    request: TransformDocument<DocumentShape>,
+  ): Observable<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
+  /**
+   * Translate a target document based on a source.
+   * @param request translation request
+   */
   translate<DocumentShape extends Record<string, Any>>(
-    request: TranslateDocumentSync,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
+    request: TranslateDocument<DocumentShape>,
+  ): Observable<
+    (typeof request)['async'] extends true
+      ? {
+          _id: string
+        }
+      : IdentifiedSanityDocumentStub & DocumentShape
+  >
 }
 
 /** @internal */
@@ -3526,13 +3568,16 @@ export declare type TransactionMutationOptions =
   | TransactionAllDocumentIdsMutationOptions
 
 /** @beta */
-export declare type TransformDocument = TransformDocumentSync | TransformDocumentAsync
+export declare type TransformDocument<T extends Record<string, Any> = Record<string, Any>> =
+  | TransformDocumentSync<T>
+  | TransformDocumentAsync
 
 /** @beta */
 declare type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
 
 /** @beta */
-declare type TransformDocumentSync = TransformRequestBase & AgentActionSync
+declare type TransformDocumentSync<T extends Record<string, Any> = Record<string, Any>> =
+  TransformRequestBase & AgentActionSync
 
 /**  @beta */
 declare interface TransformRequestBase extends AgentActionRequestBase {
@@ -3608,13 +3653,16 @@ export declare interface TransformTargetInclude extends AgentActionTargetInclude
 }
 
 /** @beta */
-export declare type TranslateDocument = TranslateDocumentSync | TranslateDocumentAsync
+export declare type TranslateDocument<T extends Record<string, Any> = Record<string, Any>> =
+  | TranslateDocumentSync<T>
+  | TranslateDocumentAsync
 
 /** @beta */
 declare type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync
 
 /** @beta */
-declare type TranslateDocumentSync = TranslateRequestBase & AgentActionSync
+declare type TranslateDocumentSync<T extends Record<string, Any> = Record<string, Any>> =
+  TranslateRequestBase & AgentActionSync
 
 /**  @beta */
 declare interface TranslateLanguage {

package/dist/index.js

@@ -1651,7 +1651,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "6.29.0-generate.2";
+var name = "@sanity/client", version = "6.29.0-generate.3";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),