@sanity/client 6.29.0-generate.0 → 6.29.1

package/dist/stega.browser.d.ts

@@ -33,18 +33,6 @@ export declare interface ActionErrorItem {
   index: number
 }
 
-/** @public */
-declare class AgentActionsClient {
-  #private
-  constructor(client: SanityClient, httpRequest: HttpRequest)
-  generate(request: GenerateAsyncInstruction): Promise<{
-    _id: string
-  }>
-  generate<DocumentShape extends Record<string, Any>>(
-    request: GenerateSyncInstruction<DocumentShape>,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
@@ -122,18 +110,6 @@ export declare class AssetsClient {
   ): Promise<SanityAssetDocument | SanityImageAssetDocument>
 }
 
-declare interface Async {
-  /**
-   * When async: true, requests responds with status 201 and {_id} as response body as soon as the request is validated.
-   * The instruction operation will carry on in the background.
-   *
-   * When async: false (default), requests respond with status 200 and the document value after instruction has been applied.
-   *
-   * async: true is incompatible with noWrite, as async: true does not return the resulting document
-   */
-  async: true
-}
-
 /** @internal */
 export declare type AttributeSet = {
   [key: string]: Any
@@ -717,19 +693,6 @@ export declare type CreateAction = {
  */
 export declare const createClient: (config: ClientConfig_2) => SanityClient
 
-/**
- * Instruction to create a new document
- * @beta
- */
-declare interface CreateDocumentRequest<T extends Record<string, Any> = Record<string, Any>> {
-  createDocument: {
-    /** if no _id is provided, one will be generated. _id is always returned when the requests succeed */
-    _id?: string
-    _type: string
-  } & SanityDocumentStub<T>
-  documentId?: never
-}
-
 /** @public */
 export declare interface CurrentSanityUser {
   id: string
@@ -935,15 +898,6 @@ export declare type EventSourceEvent<Name extends string> = ServerSentEvent<Name
  */
 export declare type EventSourceInstance = InstanceType<typeof globalThis.EventSource>
 
-/**
- * Instruction for an existing document.
- * @beta
- */
-declare interface ExistingDocumentRequest {
-  documentId: string
-  createDocument?: never
-}
-
 /** @public */
 export declare type FilterDefault = (props: {
   /**
@@ -1059,312 +1013,6 @@ export declare type FirstDocumentMutationOptions = BaseMutationOptions & {
   returnDocuments?: true
 }
 
-/** @beta */
-export declare type GenerateAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> =
-  (ExistingDocumentRequest | CreateDocumentRequest<T>) & GenerateRequestBase & Async
-
-/** @beta */
-export declare interface GenerateConstantInstructionParam {
-  type: 'constant'
-  value: string
-}
-
-/**
- *
- * Includes a LLM-friendly version of the document in the instruction
- * @beta
- * */
-declare interface GenerateDocumentInstructionParam {
-  type: 'document'
-  /**
-   * If omitted, implicitly uses the documentId of the instruction target
-   */
-  documentId?: string
-}
-
-/**
- *
- * Includes a LLM-friendly version of the field value in the instruction
- * @beta
- * */
-export declare interface GenerateFieldInstructionParam {
-  type: 'field'
-  /**
-   * Examples: ['title'], ['array', {_key: 'arrayItemKey'}, 'field']
-   */
-  path: GeneratePath
-  /**
-   * If omitted, implicitly uses the documentId of the instruction target
-   */
-  documentId?: string
-}
-
-/**
- * Includes a LLM-friendly version of GROQ query result in the instruction
- * @beta
- * */
-export declare interface GenerateGroqInstructionParam {
-  type: 'groq'
-  query: string
-  params?: Record<string, string>
-}
-
-/** @beta */
-export declare type GenerateInstruction<T extends Record<string, Any> = Record<string, Any>> =
-  | GenerateSyncInstruction<T>
-  | GenerateAsyncInstruction<T>
-
-/** @beta */
-export declare type GenerateInstructionParam =
-  | string
-  | GenerateConstantInstructionParam
-  | GenerateFieldInstructionParam
-  | GenerateDocumentInstructionParam
-  | GenerateGroqInstructionParam
-
-/** @beta */
-export declare type GenerateInstructionParams = Record<string, GenerateInstructionParam>
-
-declare type GenerateOperation = 'set' | 'append' | 'mixed'
-
-declare type GeneratePath = GeneratePathSegment[]
-
-declare type GeneratePathSegment =
-  | string
-  | {
-      _key: string
-    }
-
-declare interface GenerateRequestBase {
-  /** schemaId as reported by sanity deploy / sanity schema store */
-  schemaId: string
-  /** string template using $variable – more on this below under "Dynamic instruction" */
-  instruction: string
-  /** param values for the string template, keys are the variable name, ie if the template has "$variable", one key must be "variable" */
-  instructionParams?: GenerateInstructionParams
-  /**
-   * 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 GenerateRequestBase#conditionalPaths
-   */
-  target?: GenerateTarget | GenerateTarget[]
-  /**
-   * When a type or field in the schema has a function set for `hidden` or `readOnly`, it is conditional.
-   *
-   * By default, Generate will not output to conditional `readOnly` and `hidden` fields,
-   * ie, they are considered to resolve to `readOnly: true` / `hidden: true`.
-   *
-   * `conditionalPaths` param allows setting the default conditional value for
-   * `hidden` and `readOnly` to false,
-   * or individually set `hidden` and `readOnly` state for individual document paths.
-   *
-   *
-   * Note: fields and types with explicit readOnly: true or hidden: true in the schema, are not available to Generate,
-   * and cannot be changed via conditionalPaths
-   *
-   * conditionalPaths state only apply to fields and types that have conditional `hidden` or `readOnly` in their schema definition.
-   *
-   * Consider using `hidden: () => true` in schema config, if a field should be writeable only by Generate and never
-   * visible in the studio – then make the field visible to the Generate using `conditionalPaths`.
-   *
-   * @see GenerateRequestBase#target
-   */
-  conditionalPaths?: {
-    defaultReadOnly?: boolean
-    defaultHidden?: boolean
-    paths?: {
-      /** path here is not a relative path: it must be the full document path, regardless of `path` param used in targets */
-      path: GeneratePath
-      readOnly: boolean
-      hidden: boolean
-    }[]
-  }
-  /**
-   * When localeSettings is provided on the request, instruct can write to date and datetime fields.
-   * Otherwise, such fields will be ignored.
-   */
-  localeSettings?: {
-    /**
-     * A valid Unicode BCP 47 locale identifier used to interpret and format
-     * natural language inputs and date output. Examples include "en-US", "fr-FR", or "ja-JP".
-     *
-     * This affects how phrases like "next Friday" or "in two weeks" are parsed,
-     * and how resulting dates are presented (e.g., 12-hour vs 24-hour format).
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#getcanonicalocales
-     */
-    locale: string
-    /**
-     * A valid IANA time zone identifier used to resolve relative and absolute
-     * date expressions to a specific point in time. Examples include
-     * "America/New_York", "Europe/Paris", or "Asia/Tokyo".
-     *
-     * This ensures phrases like "tomorrow at 9am" are interpreted correctly
-     * based on the user's local time.
-     *
-     * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-     */
-    timeZone: string
-  }
-  /**
-   * Controls how much variance the instructions will run with.
-   *
-   * Value must be in the range [0, 1] (inclusive).
-   *
-   * Default: 0.3
-   */
-  temperature?: number
-}
-
-/** @beta */
-export declare type GenerateSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | ExistingDocumentRequest
-  | CreateDocumentRequest<T>
-) &
-  GenerateRequestBase &
-  Sync
-
-/**
- * @beta
- */
-declare interface GenerateTarget {
-  /**
-   * Root target path.
-   *
-   * Use this to have the instruction only affect a part of the document.
-   *
-   * To further control the behavior of individual paths under the root, use `include`, `exclude`, `types.include`
-   * and `types.exclude`.
-   *
-   * Example:
-   *
-   * `path: ['body', {_key: 'someKey'}, 'nestedObject']`
-   *
-   * Here, the instruction will only write to fields under the nestedObject.
-   *
-   * Default: [] = the document itself
-   *
-   * @see #GeneratePathSegment
-   * @see #GeneratePath
-   * */
-  path?: GeneratePathSegment | GeneratePath
-  /**
-   * Sets the default operation for all paths in the target.
-   * Generate runs in `'mixed'` operation mode by default:
-   * Changes are set in all non-array fields, and append to all array fields.
-   *
-   * ### Operation types
-   * - `'set'` – an *overwriting* operation, and replaces the full field value.
-   * - `'append'`:
-   *    – array fields: appends new items to the end of the array,
-   *    - string fields: '<existing content> <new content>'
-   *    - text fields: '<existing content>\n<new content>'
-   *    - number fields: existing + new
-   *    - other field types not mentioned will set instead (dates, url)
-   * - `'mixed'` – (default) sets non-array fields, and appends to array fields
-   *
-   * The default operation can be overridden on a per-path basis using `include`.
-   *
-   * Nested fields inherit the operation specified by their parent and falls back to the
-   * top level target operation if not otherwise specified.
-   *
-   * Use `include` to change the `operation` of individual fields or items.
-   *
-   * #### Appending in the middle of arrays
-   * `target: {path: ['array'], operation: 'append'}` will append the output of the instruction to the end of the array.
-   *
-   * To insert in the middle of the array, use `target: {path: ['array', {_key: 'appendAfterKey'}], operation: 'append'}`.
-   * Here, the output of the instruction will be appended after the array item with key `'appendAfterKey'`.
-   *
-   * @see #GenerateTargetInclude.operation
-   * @see #include
-   * @see #GenerateTargetInclude.include
-   */
-  operation?: GenerateOperation
-  /**
-   * maxPathDepth controls how deep into the schema from the target root the instruction will affect.
-   *
-   * Depth is based on path segments:
-   * - `title` has depth 1
-   * - `array[_key="no"].title` has depth 3
-   *
-   * Be careful not to set this too high in studios with recursive document schemas, as it could have
-   * negative impact on performance; both for runtime and quality of responses.
-   *
-   * Default: 4
-   */
-  maxPathDepth?: number
-  /**
-   * 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?: (GeneratePathSegment | GenerateTargetInclude)[]
-  /**
-   * By default, all children up to `target.maxPathDepth` are included.
-   * Fields or array items not on the exclude list, are implicitly included.
-   */
-  exclude?: GeneratePathSegment[]
-  /**
-   * Types can be used to exclude array item types or all fields directly under the target path of a certain type.
-   * If you do exclude: ['string'] all string fields under the target will be excluded, for instance.
-   *
-   * `types.include` and `types.exclude` are mutually exclusive.
-   */
-  types?: GenerateTypeConfig
-}
-
-declare interface GenerateTargetInclude {
-  path: GeneratePathSegment | GeneratePath
-  /**
-   * Sets the operation for this path, and all its children.
-   * This overrides any operation set parents or the root target.
-   * @see #GenerateTarget.operation
-   * @see #include
-   */
-  operation?: GenerateOperation
-  /**
-   * 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?: (GeneratePathSegment | GenerateTargetInclude)[]
-  /**
-   * By default, all children up to `target.maxPathDepth` are included.
-   * Fields or array items not on the exclude list, are implicitly included.
-   */
-  exclude?: GeneratePathSegment[]
-  /**
-   * Types can be used to exclude array item types or all fields directly under the target path of a certain type.
-   * If you do exclude: ['string'] all string fields under the target will be excluded, for instance.
-   *
-   * `types.include` and `types.exclude` are mutually exclusive.
-   */
-  types?: GenerateTypeConfig
-}
-
-declare type GenerateTypeConfig =
-  | {
-      include: string[]
-      exclude?: never
-    }
-  | {
-      exclude: string[]
-      include?: never
-    }
-
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1814,18 +1462,6 @@ export declare type MutationSelectionQueryParams = {
   [key: string]: Any
 }
 
-/** @public */
-declare class ObservableAgentsActionClient {
-  #private
-  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  generate(request: GenerateAsyncInstruction): Observable<{
-    _id: string
-  }>
-  generate<DocumentShape extends Record<string, Any>>(
-    request: GenerateSyncInstruction<DocumentShape>,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare class ObservableAssetsClient {
   #private
@@ -2003,9 +1639,6 @@ export declare class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  agent: {
-    action: ObservableAgentsActionClient
-  }
   /**
    * Instance properties
    */
@@ -2937,9 +2570,6 @@ export declare class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
-  agent: {
-    action: AgentActionsClient
-  }
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -3723,29 +3353,6 @@ export declare type StudioBaseUrl =
 /** @alpha */
 export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
 
-declare interface Sync {
-  /**
-   * By default, noWrite: false.
-   * Write enabled operations will mutate the target document, and emit AI presence in the studio.
-   *
-   * When noWrite: true, the api will not mutate any documents nor emit presence.
-   * Ie, when true, no changes will be made to content-lake
-   *
-   * noWrite: true is incompatible with async: true,
-   * as noWrite implies that you will use the return value of the operation
-   */
-  noWrite?: boolean
-  /**
-   * When async: true, requests responds with status 201 and {_id} as response body as soon as the request is validated.
-   * The instruction operation will carry on in the background.
-   *
-   * When async: false (default), requests respond with status 200 and the document value after instruction has been applied.
-   *
-   * async: true is incompatible with noWrite: true, as async: true does not return the resulting document
-   */
-  async?: false
-}
-
 /** @public */
 export declare type SyncTag = `s1:${string}`