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

package/src/agent/actions/transform.ts

@@ -0,0 +1,107 @@
+import type {
+  AgentActionAsync,
+  AgentActionPathSegment,
+  AgentActionRequestBase,
+  AgentActionSync,
+  AgentActionTarget,
+  AgentActionTargetInclude,
+} from '@sanity/client/agent/actions/commonTypes'
+import {type Observable} from 'rxjs'
+
+import {_request} from '../../data/dataMethods'
+import type {ObservableSanityClient, SanityClient} from '../../SanityClient'
+import type {AgentActionParams, Any, HttpRequest, IdentifiedSanityDocumentStub} from '../../types'
+import {hasDataset} from '../../validators'
+
+/**  @beta */
+export interface TransformRequestBase extends AgentActionRequestBase {
+  /** schemaId as reported by sanity deploy / sanity schema store */
+  schemaId: string
+
+  documentId: string
+  targetDocument?: TransformTargetDocument
+
+  /** string template using $variable  */
+  transformation: string
+  /** param values for the string template, keys are the variable name, ie if the template has "$variable", one key must be "variable" */
+  transformationParams?: AgentActionParams
+
+  /**
+   * Target defines which parts of the document will be affected by the instruction.
+   * It can be an array, so multiple parts of the document can be separately configured in detail.
+   *
+   * Omitting target implies that the document itself is the root.
+   *
+   * Notes:
+   * - instruction can only affect fields up to `maxPathDepth`
+   * - when multiple targets are provided, they will be coalesced into a single target sharing a common target root.
+   * It is therefor an error to provide conflicting include/exclude across targets (ie, include title in one, and exclude it in another)
+   *
+   * @see AgentActionRequestBase#conditionalPaths
+   */
+  target?: TransformTarget | TransformTarget[]
+}
+
+/**  @beta */
+export type TransformTargetDocument =
+  | {operation: 'get'; _id: string}
+  | {operation: 'create'; _id?: string}
+  | {operation: 'createIfNotExists'; _id: string}
+  | {operation: 'createOrReplace'; _id: string}
+
+/**  @beta */
+export interface TransformTargetInclude extends AgentActionTargetInclude {
+  /** string template using $variable from instructionParams  */
+  transformation?: string
+
+  /**
+   * By default, all children up to `target.maxPathDepth` are included.
+   *
+   * When `include` is specified, only segments explicitly listed will be included.
+   *
+   * Fields or array items not on the include list, are implicitly excluded.
+   */
+  include?: (AgentActionPathSegment | TransformTargetInclude)[]
+}
+
+/**  @beta */
+export interface TransformTarget extends AgentActionTarget {
+  /** string template using $variable from instructionParams  */
+  transformation?: string
+
+  /**
+   * By default, all children up to `target.maxPathDepth` are included.
+   *
+   * When `include` is specified, only segments explicitly listed will be included.
+   *
+   * Fields or array items not on the include list, are implicitly excluded.
+   */
+  include?: (AgentActionPathSegment | TransformTargetInclude)[]
+}
+
+/** @beta */
+export type TransformDocumentSync = TransformRequestBase & AgentActionSync
+
+/** @beta */
+export type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
+
+/** @beta */
+export type TransformDocument = TransformDocumentSync | TransformDocumentAsync
+
+export function _transform<
+  DocumentShape extends Record<string, Any>,
+  Req extends TransformDocument,
+>(
+  client: SanityClient | ObservableSanityClient,
+  httpRequest: HttpRequest,
+  request: Req,
+): Observable<
+  Req['async'] extends true ? {_id: string} : IdentifiedSanityDocumentStub & DocumentShape
+> {
+  const dataset = hasDataset(client.config())
+  return _request(client, httpRequest, {
+    method: 'POST',
+    uri: `/agent/action/transform/${dataset}`,
+    body: request,
+  })
+}

package/src/agent/actions/translate.ts

@@ -0,0 +1,120 @@
+import type {
+  AgentActionAsync,
+  AgentActionPath,
+  AgentActionRequestBase,
+  AgentActionSync,
+  AgentActionTargetInclude,
+} from '@sanity/client/agent/actions/commonTypes'
+import {type Observable} from 'rxjs'
+
+import {_request} from '../../data/dataMethods'
+import type {ObservableSanityClient, SanityClient} from '../../SanityClient'
+import type {
+  AgentActionParams,
+  AgentActionPathSegment,
+  AgentActionTarget,
+  Any,
+  HttpRequest,
+  IdentifiedSanityDocumentStub,
+} from '../../types'
+import {hasDataset} from '../../validators'
+import type {TransformTargetDocument} from './transform'
+
+/**  @beta */
+export interface TranslateRequestBase extends AgentActionRequestBase {
+  /** schemaId as reported by sanity deploy / sanity schema store */
+  schemaId: string
+
+  documentId: string
+  targetDocument?: TransformTargetDocument
+
+  fromLanguage?: TranslateLanguage
+  toLanguage: TranslateLanguage
+
+  /** string template using $variable  */
+  styleGuide?: string
+  /** param values for the string template, keys are the variable name, ie if the template has "$variable", one key must be "variable" */
+  styleGuideParams?: AgentActionParams
+
+  /**
+   * Target defines which parts of the document will be affected by the instruction.
+   * It can be an array, so multiple parts of the document can be separately configured in detail.
+   *
+   * Omitting target implies that the document itself is the root.
+   *
+   * Notes:
+   * - instruction can only affect fields up to `maxPathDepth`
+   * - when multiple targets are provided, they will be coalesced into a single target sharing a common target root.
+   * It is therefor an error to provide conflicting include/exclude across targets (ie, include title in one, and exclude it in another)
+   *
+   * @see AgentActionRequestBase#conditionalPaths
+   */
+  target?: TranslateTarget | TranslateTarget[]
+
+  languageFieldPath?: AgentActionPathSegment | AgentActionPath
+
+  protectedPhrases?: string[]
+}
+
+/**  @beta */
+export interface TranslateLanguage {
+  id: string
+  title?: string
+}
+
+/**  @beta */
+export interface TranslateTargetInclude extends AgentActionTargetInclude {
+  /** string template using $variable from instructionParams  */
+  styleGuide?: string
+
+  /**
+   * By default, all children up to `target.maxPathDepth` are included.
+   *
+   * When `include` is specified, only segments explicitly listed will be included.
+   *
+   * Fields or array items not on the include list, are implicitly excluded.
+   */
+  include?: (AgentActionPathSegment | TranslateTargetInclude)[]
+}
+
+/**  @beta */
+export interface TranslateTarget extends AgentActionTarget {
+  /** string template using $variable from instructionParams  */
+  styleGuide?: string
+
+  /**
+   * By default, all children up to `target.maxPathDepth` are included.
+   *
+   * When `include` is specified, only segments explicitly listed will be included.
+   *
+   * Fields or array items not on the include list, are implicitly excluded.
+   */
+  include?: (AgentActionPathSegment | TranslateTargetInclude)[]
+}
+
+/** @beta */
+export type TranslateDocumentSync = TranslateRequestBase & AgentActionSync
+
+/** @beta */
+export type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync
+
+/** @beta */
+export type TranslateDocument = TranslateDocumentSync | TranslateDocumentAsync
+
+export function _translate<
+  DocumentShape extends Record<string, Any>,
+  Req extends TranslateDocument,
+>(
+  client: SanityClient | ObservableSanityClient,
+  httpRequest: HttpRequest,
+  request: Req,
+): Observable<
+  Req['async'] extends true ? {_id: string} : IdentifiedSanityDocumentStub & DocumentShape
+> {
+  const dataset = hasDataset(client.config())
+  return _request(client, httpRequest, {
+    method: 'POST',
+    uri: `/agent/action/translate/${dataset}`,
+    body: request,
+  })
+}

package/src/types.ts

@@ -1373,15 +1373,33 @@ export type ClientReturn<
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
 export type {
-  GenerateAsyncInstruction,
-  GenerateConstantInstructionParam,
-  GenerateFieldInstructionParam,
-  GenerateGroqInstructionParam,
+  AgentActionParam,
+  AgentActionParams,
+  AgentActionPath,
+  AgentActionPathSegment,
+  AgentActionTarget,
+  ConstantAgentActionParam,
+  DocumentAgentActionParam,
+  FieldAgentActionParam,
+  GroqAgentActionParam,
+} from './agent/actions/commonTypes'
+export type {
   GenerateInstruction,
-  GenerateInstructionParam,
-  GenerateInstructionParams,
-  GenerateSyncInstruction,
-} from './agent/actions/types'
+  GenerateOperation,
+  GenerateTarget,
+  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

@@ -2879,6 +2879,22 @@ ${selectionOpts}`);
       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;
@@ -2892,6 +2908,20 @@ ${selectionOpts}`);
     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;
@@ -2906,6 +2936,20 @@ ${selectionOpts}`);
     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;