@sanity/client 6.28.2 → 6.28.3-instruct.0

package/src/SanityClient.ts

@@ -1,6 +1,7 @@
 import {lastValueFrom, Observable} from 'rxjs'
 
 import {AssetsClient, ObservableAssetsClient} from './assets/AssetsClient'
+import {AssistClient, ObservableAssistClient} from './assist/AssistClient'
 import {defaultConfig, initConfig} from './config'
 import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
@@ -65,7 +66,7 @@ export class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-
+  assist: ObservableAssistClient
   /**
    * Private properties
    */
@@ -87,6 +88,7 @@ export class ObservableSanityClient {
     this.live = new LiveClient(this)
     this.projects = new ObservableProjectsClient(this, this.#httpRequest)
     this.users = new ObservableUsersClient(this, this.#httpRequest)
+    this.assist = new ObservableAssistClient(this, this.#httpRequest)
   }
 
   /**
@@ -733,6 +735,7 @@ export 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
@@ -760,6 +763,7 @@ export class SanityClient {
     this.live = new LiveClient(this)
     this.projects = new ProjectsClient(this, this.#httpRequest)
     this.users = new UsersClient(this, this.#httpRequest)
+    this.assist = new AssistClient(this, this.#httpRequest)
 
     this.observable = new ObservableSanityClient(httpRequest, config)
   }

package/src/assist/AssistClient.ts

@@ -0,0 +1,87 @@
+import {lastValueFrom, type Observable} from 'rxjs'
+
+import {_request} from '../data/dataMethods'
+import type {ObservableSanityClient, SanityClient} from '../SanityClient'
+import type {
+  Any,
+  AssistAsyncInstruction,
+  AssistInstruction,
+  AssistSyncInstruction,
+  HttpRequest,
+  IdentifiedSanityDocumentStub,
+} from '../types'
+import {hasDataset} from '../validators'
+
+function _instruct<
+  DocumentShape extends Record<string, Any>,
+  Req extends AssistInstruction<DocumentShape>,
+>(
+  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: `/assist/tasks/instruct/${dataset}`,
+    body: request,
+  })
+}
+
+/** @public */
+export class ObservableAssistClient {
+  #client: ObservableSanityClient
+  #httpRequest: HttpRequest
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
+  }
+
+  instruct(request: AssistAsyncInstruction): Observable<{_id: string}>
+
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: AssistSyncInstruction<DocumentShape>,
+  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
+
+  /**
+   * Run an ad-hoc instruction for a target document.
+   * @param request instruction request
+   */
+  instruct<DocumentShape extends Record<string, Any>, Req extends AssistInstruction<DocumentShape>>(
+    request: Req,
+  ): Observable<
+    Req['async'] extends true ? {_id: string} : IdentifiedSanityDocumentStub & DocumentShape
+  > {
+    return _instruct(this.#client, this.#httpRequest, request)
+  }
+}
+
+/** @public */
+export class AssistClient {
+  #client: SanityClient
+  #httpRequest: HttpRequest
+  constructor(client: SanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
+  }
+
+  instruct(request: AssistAsyncInstruction): Promise<{_id: string}>
+
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: AssistSyncInstruction<DocumentShape>,
+  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
+
+  /**
+   * Run an ad-hoc instruction for a target document.
+   * @param request instruction request
+   */
+  instruct<DocumentShape extends Record<string, Any>, Req extends AssistInstruction<DocumentShape>>(
+    request: Req,
+  ): Promise<
+    Req['async'] extends true ? {_id: string} : IdentifiedSanityDocumentStub & DocumentShape
+  > {
+    return lastValueFrom(_instruct(this.#client, this.#httpRequest, request))
+  }
+}

package/src/assist/types.ts

@@ -0,0 +1,203 @@
+//Request shape
+
+import type {Any, SanityDocumentStub} from '@sanity/client'
+
+/** @beta */
+export interface ConstantInstructionParam {
+  type: 'constant'
+  value: string
+}
+
+/**
+ *
+ * Includes a LLM-friendly version of the field value in the instruction
+ * @beta
+ * */
+export interface FieldInstructionParam {
+  type: 'field'
+  /**
+   * Examples: 'title', 'array[_key=="key"].field
+   */
+  path: string
+  /**
+   * If omitted, implicitly uses the documentId of the instruction target
+   */
+  documentId?: string
+}
+
+/**
+ *
+ * Includes a LLM-friendly version of the document in the instruction
+ * @beta
+ * */
+export interface DocumentInstructionParam {
+  type: 'document'
+  /**
+   * If omitted, implicitly uses the documentId of the instruction target
+   */
+  documentId?: string
+}
+
+/** @beta */
+export interface GroqInstructionParam {
+  type: 'groq'
+  query: string
+  params?: Record<string, string>
+}
+
+/** @beta */
+export type InstructionParam =
+  | string
+  | ConstantInstructionParam
+  | FieldInstructionParam
+  | DocumentInstructionParam
+  | GroqInstructionParam
+
+/** @beta */
+export type InstructionParams = Record<string, InstructionParam>
+
+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
+    }[]
+  }
+}
+
+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
+}
+
+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
+}
+
+/**
+ * Instruction for an existing document.
+ * @beta
+ */
+interface ExistingDocumentRequest {
+  documentId: string
+}
+
+/**
+ * Instruction to create a new document
+ * @beta
+ */
+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>
+}
+
+/** @beta */
+export type AssistSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+  | ExistingDocumentRequest
+  | CreateDocumentRequest<T>
+) &
+  AssistRequestBase &
+  Sync
+
+/** @beta */
+export type AssistAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+  | ExistingDocumentRequest
+  | CreateDocumentRequest<T>
+) &
+  AssistRequestBase &
+  Async
+
+/** @beta */
+export type AssistInstruction<T extends Record<string, Any> = Record<string, Any>> =
+  | AssistSyncInstruction<T>
+  | AssistAsyncInstruction<T>

package/src/index.ts

@@ -11,7 +11,7 @@ export const requester = exp.requester
 
 /**
  * @remarks
- * As of API version `v2025-02-19`, the default perspective used by the client has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+ * As of API version `v2025-02-19`, the default perspective used by the client has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
  * @public
  */
 export const createClient = exp.createClient

package/src/types.ts

@@ -64,7 +64,7 @@ export interface ClientConfig {
   /**
    * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
    * @remarks
-   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
@@ -72,7 +72,7 @@ export interface ClientConfig {
 
   /**
    @remarks
-   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
    */
   apiVersion?: string
   proxy?: string
@@ -944,7 +944,7 @@ export interface ListenOptions {
 
   /**
    * 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/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
+   * 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`.
    * Note: Keep in mind that additional document variants may be introduced in the future, so it's
    * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -1336,6 +1336,16 @@ export type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
+export type {
+  AssistAsyncInstruction,
+  AssistInstruction,
+  AssistSyncInstruction,
+  ConstantInstructionParam,
+  FieldInstructionParam,
+  GroqInstructionParam,
+  InstructionParam,
+  InstructionParams,
+} from './assist/types'
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/src/util/shareReplayLatest.ts

@@ -62,7 +62,10 @@ function _shareReplayLatest<T>(config: ShareReplayLatestConfig<T>): MonoTypeOper
     )
     const emitLatest = new Observable<T>((subscriber) => {
       if (emitted) {
-        subscriber.next(latest)
+        subscriber.next(
+          // this cast is safe because of the emitted check which asserts that we got T from the source
+          latest as T,
+        )
       }
       subscriber.complete()
     })

package/umd/sanityClient.js

@@ -2887,6 +2887,42 @@ ${selectionOpts}`);
       opts
     );
   }
+  function _instruct(client, httpRequest, request) {
+    const dataset2 = hasDataset(client.config());
+    return _request(client, httpRequest, {
+      method: "POST",
+      uri: `/assist/tasks/instruct/${dataset2}`,
+      body: request
+    });
+  }
+  class ObservableAssistClient {
+    #client;
+    #httpRequest;
+    constructor(client, httpRequest) {
+      this.#client = client, this.#httpRequest = httpRequest;
+    }
+    /**
+     * Run an ad-hoc instruction for a target document.
+     * @param request instruction request
+     */
+    instruct(request) {
+      return _instruct(this.#client, this.#httpRequest, request);
+    }
+  }
+  class AssistClient {
+    #client;
+    #httpRequest;
+    constructor(client, httpRequest) {
+      this.#client = client, this.#httpRequest = httpRequest;
+    }
+    /**
+     * Run an ad-hoc instruction for a target document.
+     * @param request instruction request
+     */
+    instruct(request) {
+      return lastValueFrom(_instruct(this.#client, this.#httpRequest, request));
+    }
+  }
   var defaults = (obj, defaults2) => Object.keys(defaults2).concat(Object.keys(obj)).reduce((target, prop) => (target[prop] = typeof obj[prop] > "u" ? defaults2[prop] : obj[prop], target), {});
   const pick = (obj, props) => props.reduce((selection, prop) => (typeof obj[prop] > "u" || (selection[prop] = obj[prop]), selection), {}), eventSourcePolyfill = defer(() => Promise.resolve().then(function () { return browser$1; })).pipe(
     map(({ default: EventSource2 }) => EventSource2),
@@ -2948,7 +2984,10 @@ ${selectionOpts}`);
         }),
         share(shareConfig)
       ), emitLatest = new Observable((subscriber) => {
-        emitted && subscriber.next(latest), subscriber.complete();
+        emitted && subscriber.next(
+          // this cast is safe because of the emitted check which asserts that we got T from the source
+          latest
+        ), subscriber.complete();
       });
       return merge(wrapped, emitLatest);
     };
@@ -3219,6 +3258,7 @@ ${selectionOpts}`);
     live;
     projects;
     users;
+    assist;
     /**
      * Private properties
      */
@@ -3229,7 +3269,7 @@ ${selectionOpts}`);
      */
     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.assist = new ObservableAssistClient(this, this.#httpRequest);
     }
     /**
      * Clone the client - returns a new instance
@@ -3368,6 +3408,7 @@ ${selectionOpts}`);
     live;
     projects;
     users;
+    assist;
     /**
      * Observable version of the Sanity client, with the same configuration as the promise-based one
      */
@@ -3382,7 +3423,7 @@ ${selectionOpts}`);
      */
     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.assist = new AssistClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
     }
     /**
      * Clone the client - returns a new instance