@sanity/client 6.28.3-instruct.1 → 6.28.3-instruct.2

package/dist/stega.browser.d.cts

@@ -33,18 +33,6 @@ export declare interface ActionErrorItem {
   index: number
 }
 
-/** @public */
-declare class AiClient {
-  #private
-  constructor(client: SanityClient, httpRequest: HttpRequest)
-  instruct(request: InstructAsyncInstruction): Promise<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: InstructSyncInstruction<DocumentShape>,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
@@ -1626,18 +1614,6 @@ export declare type MutationSelectionQueryParams = {
   [key: string]: Any
 }
 
-/** @public */
-declare class ObservableAiClient {
-  #private
-  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  instruct(request: InstructAsyncInstruction): Observable<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: InstructSyncInstruction<DocumentShape>,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare class ObservableAssetsClient {
   #private
@@ -1815,7 +1791,6 @@ export declare class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  ai: ObservableAiClient
   /**
    * Instance properties
    */
@@ -2310,6 +2285,12 @@ export declare class ObservableSanityClient {
    * @param path - Path to append after the operation
    */
   getDataUrl(operation: string, path?: string): string
+  instruct(request: InstructAsyncInstruction): Observable<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
 }
 
 /**
@@ -2747,7 +2728,6 @@ export declare class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
-  ai: AiClient
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -3262,6 +3242,12 @@ export declare class SanityClient {
    * @param path - Path to append after the operation
    */
   getDataUrl(operation: string, path?: string): string
+  instruct(request: InstructAsyncInstruction): Promise<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
 }
 
 /** @internal */

package/dist/stega.browser.d.ts

@@ -33,18 +33,6 @@ export declare interface ActionErrorItem {
   index: number
 }
 
-/** @public */
-declare class AiClient {
-  #private
-  constructor(client: SanityClient, httpRequest: HttpRequest)
-  instruct(request: InstructAsyncInstruction): Promise<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: InstructSyncInstruction<DocumentShape>,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
@@ -1626,18 +1614,6 @@ export declare type MutationSelectionQueryParams = {
   [key: string]: Any
 }
 
-/** @public */
-declare class ObservableAiClient {
-  #private
-  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  instruct(request: InstructAsyncInstruction): Observable<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: InstructSyncInstruction<DocumentShape>,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare class ObservableAssetsClient {
   #private
@@ -1815,7 +1791,6 @@ export declare class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  ai: ObservableAiClient
   /**
    * Instance properties
    */
@@ -2310,6 +2285,12 @@ export declare class ObservableSanityClient {
    * @param path - Path to append after the operation
    */
   getDataUrl(operation: string, path?: string): string
+  instruct(request: InstructAsyncInstruction): Observable<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
 }
 
 /**
@@ -2747,7 +2728,6 @@ export declare class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
-  ai: AiClient
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -3262,6 +3242,12 @@ export declare class SanityClient {
    * @param path - Path to append after the operation
    */
   getDataUrl(operation: string, path?: string): string
+  instruct(request: InstructAsyncInstruction): Promise<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
 }
 
 /** @internal */

package/dist/stega.d.cts

@@ -33,18 +33,6 @@ export declare interface ActionErrorItem {
   index: number
 }
 
-/** @public */
-declare class AiClient {
-  #private
-  constructor(client: SanityClient, httpRequest: HttpRequest)
-  instruct(request: InstructAsyncInstruction): Promise<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: InstructSyncInstruction<DocumentShape>,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
@@ -1626,18 +1614,6 @@ export declare type MutationSelectionQueryParams = {
   [key: string]: Any
 }
 
-/** @public */
-declare class ObservableAiClient {
-  #private
-  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  instruct(request: InstructAsyncInstruction): Observable<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: InstructSyncInstruction<DocumentShape>,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare class ObservableAssetsClient {
   #private
@@ -1815,7 +1791,6 @@ export declare class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  ai: ObservableAiClient
   /**
    * Instance properties
    */
@@ -2310,6 +2285,12 @@ export declare class ObservableSanityClient {
    * @param path - Path to append after the operation
    */
   getDataUrl(operation: string, path?: string): string
+  instruct(request: InstructAsyncInstruction): Observable<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
 }
 
 /**
@@ -2747,7 +2728,6 @@ export declare class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
-  ai: AiClient
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -3262,6 +3242,12 @@ export declare class SanityClient {
    * @param path - Path to append after the operation
    */
   getDataUrl(operation: string, path?: string): string
+  instruct(request: InstructAsyncInstruction): Promise<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
 }
 
 /** @internal */

package/dist/stega.d.ts

@@ -33,18 +33,6 @@ export declare interface ActionErrorItem {
   index: number
 }
 
-/** @public */
-declare class AiClient {
-  #private
-  constructor(client: SanityClient, httpRequest: HttpRequest)
-  instruct(request: InstructAsyncInstruction): Promise<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: InstructSyncInstruction<DocumentShape>,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
@@ -1626,18 +1614,6 @@ export declare type MutationSelectionQueryParams = {
   [key: string]: Any
 }
 
-/** @public */
-declare class ObservableAiClient {
-  #private
-  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  instruct(request: InstructAsyncInstruction): Observable<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: InstructSyncInstruction<DocumentShape>,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare class ObservableAssetsClient {
   #private
@@ -1815,7 +1791,6 @@ export declare class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  ai: ObservableAiClient
   /**
    * Instance properties
    */
@@ -2310,6 +2285,12 @@ export declare class ObservableSanityClient {
    * @param path - Path to append after the operation
    */
   getDataUrl(operation: string, path?: string): string
+  instruct(request: InstructAsyncInstruction): Observable<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
 }
 
 /**
@@ -2747,7 +2728,6 @@ export declare class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
-  ai: AiClient
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -3262,6 +3242,12 @@ export declare class SanityClient {
    * @param path - Path to append after the operation
    */
   getDataUrl(operation: string, path?: string): string
+  instruct(request: InstructAsyncInstruction): Promise<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
 }
 
 /** @internal */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.28.3-instruct.1",
+  "version": "6.28.3-instruct.2",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/SanityClient.ts

@@ -1,6 +1,5 @@
 import {lastValueFrom, Observable} from 'rxjs'
 
-import {AiClient, ObservableAiClient} from './ai/AiClient'
 import {AssetsClient, ObservableAssetsClient} from './assets/AssetsClient'
 import {defaultConfig, initConfig} from './config'
 import * as dataMethods from './data/dataMethods'
@@ -9,6 +8,7 @@ import {LiveClient} from './data/live'
 import {ObservablePatch, Patch} from './data/patch'
 import {ObservableTransaction, Transaction} from './data/transaction'
 import {DatasetsClient, ObservableDatasetsClient} from './datasets/DatasetsClient'
+import {_instruct} from './instruct/instruct'
 import {ObservableProjectsClient, ProjectsClient} from './projects/ProjectsClient'
 import type {
   Action,
@@ -25,6 +25,9 @@ import type {
   HttpRequest,
   IdentifiedSanityDocumentStub,
   InitializedClientConfig,
+  InstructAsyncInstruction,
+  InstructInstruction,
+  InstructSyncInstruction,
   MultipleActionResult,
   MultipleMutationResult,
   Mutation,
@@ -66,7 +69,6 @@ export class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  ai: ObservableAiClient
   /**
    * Private properties
    */
@@ -88,7 +90,6 @@ export class ObservableSanityClient {
     this.live = new LiveClient(this)
     this.projects = new ObservableProjectsClient(this, this.#httpRequest)
     this.users = new ObservableUsersClient(this, this.#httpRequest)
-    this.ai = new ObservableAiClient(this, this.#httpRequest)
   }
 
   /**
@@ -726,6 +727,27 @@ export class ObservableSanityClient {
   getDataUrl(operation: string, path?: string): string {
     return dataMethods._getDataUrl(this, operation, path)
   }
+
+  instruct(request: InstructAsyncInstruction): Observable<{_id: string}>
+
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<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 InstructInstruction<DocumentShape>,
+  >(
+    request: Req,
+  ): Observable<
+    Req['async'] extends true ? {_id: string} : IdentifiedSanityDocumentStub & DocumentShape
+  > {
+    return _instruct(this, this.#httpRequest, request)
+  }
 }
 
 /** @public */
@@ -735,7 +757,6 @@ export class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
-  ai: AiClient
 
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
@@ -763,7 +784,6 @@ export class SanityClient {
     this.live = new LiveClient(this)
     this.projects = new ProjectsClient(this, this.#httpRequest)
     this.users = new UsersClient(this, this.#httpRequest)
-    this.ai = new AiClient(this, this.#httpRequest)
 
     this.observable = new ObservableSanityClient(httpRequest, config)
   }
@@ -1432,4 +1452,25 @@ export class SanityClient {
   getDataUrl(operation: string, path?: string): string {
     return dataMethods._getDataUrl(this, operation, path)
   }
+
+  instruct(request: InstructAsyncInstruction): Promise<{_id: string}>
+
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<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 InstructInstruction<DocumentShape>,
+  >(
+    request: Req,
+  ): Promise<
+    Req['async'] extends true ? {_id: string} : IdentifiedSanityDocumentStub & DocumentShape
+  > {
+    return lastValueFrom(_instruct(this, this.#httpRequest, request))
+  }
 }

package/src/instruct/instruct.ts

@@ -0,0 +1,24 @@
+import {type Observable} from 'rxjs'
+
+import {_request} from '../data/dataMethods'
+import type {ObservableSanityClient, SanityClient} from '../SanityClient'
+import type {Any, HttpRequest, IdentifiedSanityDocumentStub, InstructInstruction} from '../types'
+import {hasDataset} from '../validators'
+
+export function _instruct<
+  DocumentShape extends Record<string, Any>,
+  Req extends InstructInstruction<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,
+  })
+}

package/src/types.ts

@@ -1345,7 +1345,7 @@ export type {
   InstructInstructionParam,
   InstructInstructionParams,
   InstructSyncInstruction,
-} from './ai/types'
+} from './instruct/types'
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/umd/sanityClient.js

@@ -2823,42 +2823,6 @@ ${selectionOpts}`);
     const error = new Error(signal?.reason ?? "The operation was aborted.");
     return error.name = "AbortError", error;
   }
-  function _instruct(client, httpRequest, request) {
-    const dataset2 = hasDataset(client.config());
-    return _request(client, httpRequest, {
-      method: "POST",
-      uri: `/assist/tasks/instruct/${dataset2}`,
-      body: request
-    });
-  }
-  class ObservableAiClient {
-    #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 AiClient {
-    #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));
-    }
-  }
   class ObservableAssetsClient {
     #client;
     #httpRequest;
@@ -3169,6 +3133,14 @@ ${selectionOpts}`);
       tag: null
     });
   }
+  function _instruct(client, httpRequest, request) {
+    const dataset2 = hasDataset(client.config());
+    return _request(client, httpRequest, {
+      method: "POST",
+      uri: `/assist/tasks/instruct/${dataset2}`,
+      body: request
+    });
+  }
   class ObservableProjectsClient {
     #client;
     #httpRequest;
@@ -3253,7 +3225,6 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    ai;
     /**
      * Private properties
      */
@@ -3264,7 +3235,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.ai = new ObservableAiClient(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);
     }
     /**
      * Clone the client - returns a new instance
@@ -3396,6 +3367,13 @@ ${selectionOpts}`);
     getDataUrl(operation, path) {
       return _getDataUrl(this, operation, path);
     }
+    /**
+     * Run an ad-hoc instruction for a target document.
+     * @param request instruction request
+     */
+    instruct(request) {
+      return _instruct(this, this.#httpRequest, request);
+    }
   }
   class SanityClient {
     assets;
@@ -3403,7 +3381,6 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    ai;
     /**
      * Observable version of the Sanity client, with the same configuration as the promise-based one
      */
@@ -3418,7 +3395,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.ai = new AiClient(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.observable = new ObservableSanityClient(httpRequest, config);
     }
     /**
      * Clone the client - returns a new instance
@@ -3574,6 +3551,13 @@ ${selectionOpts}`);
     getDataUrl(operation, path) {
       return _getDataUrl(this, operation, path);
     }
+    /**
+     * Run an ad-hoc instruction for a target document.
+     * @param request instruction request
+     */
+    instruct(request) {
+      return lastValueFrom(_instruct(this, this.#httpRequest, request));
+    }
   }
   function defineCreateClientExports(envMiddleware2, ClassConstructor) {
     return { requester: defineHttpRequest(envMiddleware2), createClient: (config) => {