@sanity/client 6.27.3-canary.2 → 6.28.0-instruct.0

package/dist/stega.browser.d.cts

@@ -110,6 +110,129 @@ export declare class AssetsClient {
   ): Promise<SanityAssetDocument | SanityImageAssetDocument>
 }
 
+/** @beta */
+export declare type AssistAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+  | ExistingDocumentRequest
+  | CreateDocumentRequest<T>
+) &
+  AssistRequestBase &
+  Async
+
+/** @public */
+declare class AssistClient {
+  #private
+  constructor(client: SanityClient, httpRequest: HttpRequest)
+  instruct(request: AssistAsyncInstruction): Promise<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: AssistSyncInstruction<DocumentShape>,
+  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
+}
+
+/** @beta */
+export declare type AssistInstruction<T extends Record<string, Any> = Record<string, Any>> =
+  | AssistSyncInstruction<T>
+  | AssistAsyncInstruction<T>
+
+declare interface AssistRequestBase {
+  /** 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?: InstructionParams
+  /**
+   *  Optional document path output target for the instruction.
+   *  When provided, the instruction will apply to this path in the document and its children.
+   *
+   *  ## Examples
+   *  - `path: 'title'` will output to the title field in the document
+   * - `path: 'array[_key="xx"]'` will output to the item with `_key: 'xx'` in the array field
+   */
+  path?: string
+  /**
+   * Controls sub-paths in the document that can be output to.
+   *
+   * The string-paths are relative to the `path` param
+   *
+   * Note: these path strings are less strictly validated than the `path` param itself:
+   * if an relative-path does not exist or is invalid, it will be silently ignored.
+   *
+   * @see AssistRequestBase#conditionalPaths
+   * @see AssistRequestBase#outputTypes
+   */
+  relativeOutputPaths?:
+    | {
+        include: string[]
+      }
+    | {
+        exclude: string[]
+      }
+  /**
+   * Controls which types the instruction is allowed to output to.
+   *
+   * @see AssistRequestBase#relativeOutputPaths
+   * @see AssistRequestBase#conditionalPaths
+   */
+  outputTypes?:
+    | {
+        include: string[]
+      }
+    | {
+        exclude: string[]
+      }
+  /**
+   * When a type or field in the schema has a function set for `hidden` or `readOnly`, it is conditional.
+   *
+   * By default, AI Assist 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 AI Assist,
+   * and cannot be changed via conditionalPaths.
+   *
+   * conditionalPaths state only apply to fields and types that have conditional `hidden` or `readOnly` in their schema definition.
+   *
+   * @see AssistRequestBase#relativeOutputPaths
+   * @see AssistRequestBase#outputTypes
+   */
+  conditionalPaths?: {
+    defaultReadOnly?: boolean
+    defaultHidden?: boolean
+    paths?: {
+      /** path here is not a relative path: it must be the full document path, regardless of `path` param on the request itself */
+      path: string
+      readOnly: boolean
+      hidden: boolean
+    }[]
+  }
+}
+
+/** @beta */
+export declare type AssistSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+  | ExistingDocumentRequest
+  | CreateDocumentRequest<T>
+) &
+  AssistRequestBase &
+  Sync
+
+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 skipWrite, as async: true does not return the resulting document
+   */
+  async: true
+}
+
 /** @internal */
 export declare type AttributeSet = {
   [key: string]: Any
@@ -395,7 +518,7 @@ export declare class ClientError extends Error {
 
 /** @public */
 export declare type ClientPerspective =
-  | 'previewDrafts'
+  | DeprecatedPreviewDrafts
   | 'published'
   | 'drafts'
   | 'raw'
@@ -446,6 +569,12 @@ export declare class ConnectionFailedError extends Error {
   readonly name = 'ConnectionFailedError'
 }
 
+/** @beta */
+export declare interface ConstantInstructionParam {
+  type: 'constant'
+  value: string
+}
+
 /** @public */
 export declare interface ContentSourceMap {
   mappings: ContentSourceMapMappings
@@ -664,6 +793,18 @@ 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>
+}
+
 /** @internal */
 export declare interface CurrentSanityUser {
   id: string
@@ -759,6 +900,11 @@ export declare type DeleteAction = {
   purge?: boolean
 }
 
+/**
+ * @deprecated use 'drafts' instead
+ */
+declare type DeprecatedPreviewDrafts = 'previewDrafts'
+
 /**
  * Delete the draft version of a document.
  * It is an error if it does not exist. If the purge flag is set, the document history is also deleted.
@@ -864,6 +1010,20 @@ 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
+}
+
+/** @beta */
+export declare interface FieldInstructionParam {
+  type: 'field'
+  path: string
+}
+
 /** @public */
 export declare type FilterDefault = (props: {
   /**
@@ -979,6 +1139,13 @@ export declare type FirstDocumentMutationOptions = BaseMutationOptions & {
   returnDocuments?: true
 }
 
+/** @beta */
+export declare interface GroqInstructionParam {
+  type: 'groq'
+  query: string
+  params?: Record<string, string>
+}
+
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1049,6 +1216,16 @@ export declare type InsertPatch =
       items: Any[]
     }
 
+/** @beta */
+export declare type InstructionParam =
+  | string
+  | ConstantInstructionParam
+  | FieldInstructionParam
+  | GroqInstructionParam
+
+/** @beta */
+export declare type InstructionParams = Record<string, InstructionParam>
+
 /**
  * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  *
@@ -1465,6 +1642,18 @@ export declare class ObservableAssetsClient {
   >
 }
 
+/** @public */
+declare class ObservableAssistClient {
+  #private
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
+  instruct(request: AssistAsyncInstruction): Observable<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: AssistSyncInstruction<DocumentShape>,
+  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
+}
+
 /** @internal */
 export declare class ObservableDatasetsClient {
   #private
@@ -1588,6 +1777,7 @@ export declare class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
+  assist: ObservableAssistClient
   /**
    * Instance properties
    */
@@ -2519,6 +2709,7 @@ export declare class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
+  assist: AssistClient
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -3302,6 +3493,29 @@ export declare type StudioBaseUrl =
 /** @alpha */
 export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
 
+declare interface Sync {
+  /**
+   * By default, skipWrite: false.
+   * Write enabled operations will mutate the target document, and emit AI presence in the studio.
+   *
+   * When skipWrite: true, the api will not mutate any documents nor emit presence.
+   * Ie, when true, no changes will be made to content-lake
+   *
+   * skipWrite: true is incompatible with async: true,
+   * as skipWrite implies that you will use the return value of the operation
+   */
+  skipWrite?: 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 skipWrite: true, as async: true does not return the resulting document
+   */
+  async?: false
+}
+
 /** @public */
 export declare type SyncTag = `s1:${string}`
 

package/dist/stega.browser.d.ts

@@ -110,6 +110,129 @@ export declare class AssetsClient {
   ): Promise<SanityAssetDocument | SanityImageAssetDocument>
 }
 
+/** @beta */
+export declare type AssistAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+  | ExistingDocumentRequest
+  | CreateDocumentRequest<T>
+) &
+  AssistRequestBase &
+  Async
+
+/** @public */
+declare class AssistClient {
+  #private
+  constructor(client: SanityClient, httpRequest: HttpRequest)
+  instruct(request: AssistAsyncInstruction): Promise<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: AssistSyncInstruction<DocumentShape>,
+  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
+}
+
+/** @beta */
+export declare type AssistInstruction<T extends Record<string, Any> = Record<string, Any>> =
+  | AssistSyncInstruction<T>
+  | AssistAsyncInstruction<T>
+
+declare interface AssistRequestBase {
+  /** 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?: InstructionParams
+  /**
+   *  Optional document path output target for the instruction.
+   *  When provided, the instruction will apply to this path in the document and its children.
+   *
+   *  ## Examples
+   *  - `path: 'title'` will output to the title field in the document
+   * - `path: 'array[_key="xx"]'` will output to the item with `_key: 'xx'` in the array field
+   */
+  path?: string
+  /**
+   * Controls sub-paths in the document that can be output to.
+   *
+   * The string-paths are relative to the `path` param
+   *
+   * Note: these path strings are less strictly validated than the `path` param itself:
+   * if an relative-path does not exist or is invalid, it will be silently ignored.
+   *
+   * @see AssistRequestBase#conditionalPaths
+   * @see AssistRequestBase#outputTypes
+   */
+  relativeOutputPaths?:
+    | {
+        include: string[]
+      }
+    | {
+        exclude: string[]
+      }
+  /**
+   * Controls which types the instruction is allowed to output to.
+   *
+   * @see AssistRequestBase#relativeOutputPaths
+   * @see AssistRequestBase#conditionalPaths
+   */
+  outputTypes?:
+    | {
+        include: string[]
+      }
+    | {
+        exclude: string[]
+      }
+  /**
+   * When a type or field in the schema has a function set for `hidden` or `readOnly`, it is conditional.
+   *
+   * By default, AI Assist 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 AI Assist,
+   * and cannot be changed via conditionalPaths.
+   *
+   * conditionalPaths state only apply to fields and types that have conditional `hidden` or `readOnly` in their schema definition.
+   *
+   * @see AssistRequestBase#relativeOutputPaths
+   * @see AssistRequestBase#outputTypes
+   */
+  conditionalPaths?: {
+    defaultReadOnly?: boolean
+    defaultHidden?: boolean
+    paths?: {
+      /** path here is not a relative path: it must be the full document path, regardless of `path` param on the request itself */
+      path: string
+      readOnly: boolean
+      hidden: boolean
+    }[]
+  }
+}
+
+/** @beta */
+export declare type AssistSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+  | ExistingDocumentRequest
+  | CreateDocumentRequest<T>
+) &
+  AssistRequestBase &
+  Sync
+
+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 skipWrite, as async: true does not return the resulting document
+   */
+  async: true
+}
+
 /** @internal */
 export declare type AttributeSet = {
   [key: string]: Any
@@ -395,7 +518,7 @@ export declare class ClientError extends Error {
 
 /** @public */
 export declare type ClientPerspective =
-  | 'previewDrafts'
+  | DeprecatedPreviewDrafts
   | 'published'
   | 'drafts'
   | 'raw'
@@ -446,6 +569,12 @@ export declare class ConnectionFailedError extends Error {
   readonly name = 'ConnectionFailedError'
 }
 
+/** @beta */
+export declare interface ConstantInstructionParam {
+  type: 'constant'
+  value: string
+}
+
 /** @public */
 export declare interface ContentSourceMap {
   mappings: ContentSourceMapMappings
@@ -664,6 +793,18 @@ 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>
+}
+
 /** @internal */
 export declare interface CurrentSanityUser {
   id: string
@@ -759,6 +900,11 @@ export declare type DeleteAction = {
   purge?: boolean
 }
 
+/**
+ * @deprecated use 'drafts' instead
+ */
+declare type DeprecatedPreviewDrafts = 'previewDrafts'
+
 /**
  * Delete the draft version of a document.
  * It is an error if it does not exist. If the purge flag is set, the document history is also deleted.
@@ -864,6 +1010,20 @@ 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
+}
+
+/** @beta */
+export declare interface FieldInstructionParam {
+  type: 'field'
+  path: string
+}
+
 /** @public */
 export declare type FilterDefault = (props: {
   /**
@@ -979,6 +1139,13 @@ export declare type FirstDocumentMutationOptions = BaseMutationOptions & {
   returnDocuments?: true
 }
 
+/** @beta */
+export declare interface GroqInstructionParam {
+  type: 'groq'
+  query: string
+  params?: Record<string, string>
+}
+
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1049,6 +1216,16 @@ export declare type InsertPatch =
       items: Any[]
     }
 
+/** @beta */
+export declare type InstructionParam =
+  | string
+  | ConstantInstructionParam
+  | FieldInstructionParam
+  | GroqInstructionParam
+
+/** @beta */
+export declare type InstructionParams = Record<string, InstructionParam>
+
 /**
  * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  *
@@ -1465,6 +1642,18 @@ export declare class ObservableAssetsClient {
   >
 }
 
+/** @public */
+declare class ObservableAssistClient {
+  #private
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
+  instruct(request: AssistAsyncInstruction): Observable<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: AssistSyncInstruction<DocumentShape>,
+  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
+}
+
 /** @internal */
 export declare class ObservableDatasetsClient {
   #private
@@ -1588,6 +1777,7 @@ export declare class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
+  assist: ObservableAssistClient
   /**
    * Instance properties
    */
@@ -2519,6 +2709,7 @@ export declare class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
+  assist: AssistClient
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -3302,6 +3493,29 @@ export declare type StudioBaseUrl =
 /** @alpha */
 export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
 
+declare interface Sync {
+  /**
+   * By default, skipWrite: false.
+   * Write enabled operations will mutate the target document, and emit AI presence in the studio.
+   *
+   * When skipWrite: true, the api will not mutate any documents nor emit presence.
+   * Ie, when true, no changes will be made to content-lake
+   *
+   * skipWrite: true is incompatible with async: true,
+   * as skipWrite implies that you will use the return value of the operation
+   */
+  skipWrite?: 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 skipWrite: true, as async: true does not return the resulting document
+   */
+  async?: false
+}
+
 /** @public */
 export declare type SyncTag = `s1:${string}`
 

package/dist/stega.browser.js

@@ -1,4 +1,4 @@
-import { SanityClient, ObservableSanityClient, requester as requester$1, createClient as createClient$1 } from "@sanity/client";
+import { requester as requester$1, createClient as createClient$1, SanityClient, ObservableSanityClient } from "@sanity/client";
 export * from "@sanity/client";
 import { encodeIntoResult, stegaEncodeSourceMap } from "./_chunks-es/stegaEncodeSourceMap.js";
 import { stegaClean, vercelStegaCleanAll } from "./_chunks-es/stegaClean.js";