@sanity/sdk 2.3.1 → 2.5.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _sanity_client12 from "@sanity/client";
-import { ClientConfig, ClientPerspective, ListenEvent, ResponseQueryOptions, SanityClient, SanityDocument as SanityDocument$1, SanityProject as SanityProject$1, StackablePerspective } from "@sanity/client";
+import { ClientConfig, ClientError, ClientPerspective, ListenEvent, ResponseQueryOptions, SanityClient, SanityDocument as SanityDocument$1, SanityProject as SanityProject$1, StackablePerspective } from "@sanity/client";
 import { Observable, Subject } from "rxjs";
 import { CurrentUser, CurrentUser as CurrentUser$1, Mutation, PatchOperations, Role, SanityDocument, SanityDocument as SanityDocument$2, SanityDocumentLike } from "@sanity/types";
 import * as _sanity_comlink3 from "@sanity/comlink";
@@ -9,17 +9,6 @@ import { SanityDocument as SanityDocument$3, SanityProjectionResult, SanityQuery
 import { ExprNode } from "groq-js";
 import { CanvasResource, MediaResource, StudioResource } from "@sanity/message-protocol";
 import { getIndexForKey, getPathDepth, joinPaths, jsonMatch, slicePath, stringifyPath } from "@sanity/json-match";
-/**
- * Represents the various states the authentication type can be in.
- *
- * @public
- */
-declare enum AuthStateType {
-  LOGGED_IN = "logged-in",
-  LOGGING_IN = "logging-in",
-  ERROR = "error",
-  LOGGED_OUT = "logged-out",
-}
 /**
  * Configuration for an authentication provider
  * @public
@@ -116,12 +105,18 @@ interface DatasetHandle<TDataset extends string = string, TProjectId extends str
 /**
  * Identifies a specific document type within a Sanity dataset and project.
  * Includes `projectId`, `dataset`, and `documentType`.
- * Optionally includes a `documentId`, useful for referencing a specific document type context, potentially without a specific document ID.
+ * Optionally includes a `documentId` and `liveEdit` flag.
  * @public
  */
 interface DocumentTypeHandle<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DatasetHandle<TDataset, TProjectId> {
   documentId?: string;
   documentType: TDocumentType;
+  /**
+   * Indicates whether this document uses liveEdit mode.
+   * When `true`, the document does not use the draft/published model and edits are applied directly to the document.
+   * @see https://www.sanity.io/docs/content-lake/drafts#ca0663a8f002
+   */
+  liveEdit?: boolean;
 }
 /**
  * Uniquely identifies a specific document within a Sanity dataset and project.
@@ -150,6 +145,39 @@ interface SanityConfig extends DatasetHandle, PerspectiveHandle {
     enabled: boolean;
   };
 }
+declare const SOURCE_ID = "__sanity_internal_sourceId";
+/**
+ * A document source can be used for querying.
+ *
+ * @beta
+ * @see datasetSource Construct a document source for a given projectId and dataset.
+ * @see mediaLibrarySource Construct a document source for a mediaLibraryId.
+ * @see canvasSource Construct a document source for a canvasId.
+ */
+type DocumentSource = {
+  [SOURCE_ID]: ['media-library', string] | ['canvas', string] | {
+    projectId: string;
+    dataset: string;
+  };
+};
+/**
+ * Returns a document source for a projectId and dataset.
+ *
+ * @beta
+ */
+declare function datasetSource(projectId: string, dataset: string): DocumentSource;
+/**
+ * Returns a document source for a Media Library.
+ *
+ * @beta
+ */
+declare function mediaLibrarySource(id: string): DocumentSource;
+/**
+ * Returns a document source for a Canvas.
+ *
+ * @beta
+ */
+declare function canvasSource(id: string): DocumentSource;
 /**
  * Represents a Sanity.io resource instance with its own configuration and lifecycle
  * @remarks Instances form a hierarchy through parent/child relationships
@@ -211,33 +239,81 @@ interface SanityInstance {
  * @public
  */
 declare function createSanityInstance(config?: SanityConfig): SanityInstance;
+/** @alpha */
+type AgentGenerateOptions = Parameters<SanityClient['observable']['agent']['action']['generate']>[0];
+/** @alpha */
+type AgentTransformOptions = Parameters<SanityClient['observable']['agent']['action']['transform']>[0];
+/** @alpha */
+type AgentTranslateOptions = Parameters<SanityClient['observable']['agent']['action']['translate']>[0];
+/** @alpha */
+type AgentPromptOptions = Parameters<SanityClient['agent']['action']['prompt']>[0];
+/** @alpha */
+type AgentPatchOptions = Parameters<SanityClient['agent']['action']['patch']>[0];
+/** @alpha */
+type AgentGenerateResult = Awaited<ReturnType<SanityClient['observable']['agent']['action']['generate']>>;
+/** @alpha */
+type AgentTransformResult = Awaited<ReturnType<SanityClient['observable']['agent']['action']['transform']>>;
+/** @alpha */
+type AgentTranslateResult = Awaited<ReturnType<SanityClient['observable']['agent']['action']['translate']>>;
+/** @alpha */
+type AgentPromptResult = Awaited<ReturnType<SanityClient['agent']['action']['prompt']>>;
+/** @alpha */
+type AgentPatchResult = Awaited<ReturnType<SanityClient['agent']['action']['patch']>>;
+/**
+ * Generates a new document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent generate action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent generate action.
+ * @alpha
+ */
+declare function agentGenerate(instance: SanityInstance, options: AgentGenerateOptions): AgentGenerateResult;
 /**
- * Represents a store action that has been bound to a specific store instance
+ * Transforms a document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent transform action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent transform action.
+ * @alpha
  */
-type BoundStoreAction<_TState, TParams extends unknown[], TReturn> = (instance: SanityInstance, ...params: TParams) => TReturn;
+declare function agentTransform(instance: SanityInstance, options: AgentTransformOptions): AgentTransformResult;
 /**
- * Creates an action binder function that uses the provided key function
- * to determine how store instances are shared between Sanity instances
- *
- * @param keyFn - Function that generates a key from a Sanity config
- * @returns A function that binds store actions to Sanity instances
- *
- * @remarks
- * Action binders determine how store instances are shared across multiple
- * Sanity instances. The key function determines which instances share state.
- *
- * @example
- * ```ts
- * // Create a custom binder that uses a tenant ID for isolation
- * const bindActionByTenant = createActionBinder(config => config.tenantId || 'default')
+ * Translates a document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent translate action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent translate action.
+ * @alpha
+ */
+declare function agentTranslate(instance: SanityInstance, options: AgentTranslateOptions): AgentTranslateResult;
+/**
+ * Prompts the agent using the same instruction template format as the other actions, but returns text or json instead of acting on a document.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent prompt action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent prompt action.
+ * @alpha
+ */
+declare function agentPrompt(instance: SanityInstance, options: AgentPromptOptions): Observable<AgentPromptResult>;
+/**
+ * Patches a document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent patch action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent patch action.
+ * @alpha
+ */
+declare function agentPatch(instance: SanityInstance, options: AgentPatchOptions): Observable<AgentPatchResult>;
+/**
+ * Represents the various states the authentication type can be in.
  *
- * // Use the custom binder with a store definition
- * const getTenantUsers = bindActionByTenant(
- *   userStore,
- *   ({state}) => state.get().users
- * )
- * ```
+ * @public
+ */
+declare enum AuthStateType {
+  LOGGED_IN = "logged-in",
+  LOGGING_IN = "logging-in",
+  ERROR = "error",
+  LOGGED_OUT = "logged-out",
+}
+/**
+ * Represents a store action that has been bound to a specific store instance
  */
+type BoundStoreAction<_TState, TParams extends unknown[], TReturn> = (instance: SanityInstance, ...params: TParams) => TReturn;
 /**
  * Represents the various states the authentication can be in.
  *
@@ -321,10 +397,6 @@ declare const getCurrentUserState: BoundStoreAction<AuthStoreState, [], StateSou
  * @public
  */
 declare const getTokenState: BoundStoreAction<AuthStoreState, [], StateSource<string | null>>;
-/**
- * @internal
- */
-
 /**
  * @public
  */
@@ -355,10 +427,6 @@ declare const setAuthToken: BoundStoreAction<AuthStoreState, [token: string | nu
 interface OrgVerificationResult {
   error: string | null;
 }
-/**
- * Compares a project's actual organization ID with the expected organization ID.
- * @public
- */
 /**
  * Creates an observable that emits the organization verification state for a given instance.
  * It combines the dashboard organization ID (from auth context) with the
@@ -374,6 +442,24 @@ declare const handleAuthCallback: BoundStoreAction<AuthStoreState, [locationHref
  * @public
  */
 declare const logout: BoundStoreAction<AuthStoreState, [], Promise<void>>;
+/** @internal */
+type ApiErrorBody = {
+  error?: {
+    type?: string;
+    description?: string;
+  };
+  type?: string;
+  description?: string;
+  message?: string;
+};
+/** @internal Extracts the structured API error body from a ClientError, if present. */
+declare function getClientErrorApiBody(error: ClientError): ApiErrorBody | undefined;
+/** @internal Returns the error type string from an API error body, if available. */
+declare function getClientErrorApiType(error: ClientError): string | undefined;
+/** @internal Returns the error description string from an API error body, if available. */
+declare function getClientErrorApiDescription(error: ClientError): string | undefined;
+/** @internal True if the error represents a projectUserNotFoundError. */
+declare function isProjectUserNotFoundClientError(error: ClientError): boolean;
 type AllowedClientConfigKey = 'useCdn' | 'token' | 'perspective' | 'apiHost' | 'proxy' | 'withCredentials' | 'timeout' | 'maxRetries' | 'dataset' | 'projectId' | 'requestTagPrefix' | 'useProjectHostname';
 /**
  * States tracked by the client store
@@ -415,6 +501,10 @@ interface ClientOptions extends Pick<ClientConfig, AllowedClientConfigKey> {
    * @internal
    */
   '~experimental_resource'?: ClientConfig['~experimental_resource'];
+  /**
+   * @internal
+   */
+  'source'?: DocumentSource;
 }
 /**
  * Retrieves a Sanity client instance configured with the provided options.
@@ -596,6 +686,12 @@ declare const resolveDatasets: BoundStoreAction<FetcherStoreState<[options?: Pro
  */
 interface CreateDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentTypeHandle<TDocumentType, TDataset, TProjectId> {
   type: 'document.create';
+  /**
+   * Optional initial field values for the document.
+   * These values will be set when the document is created.
+   * System fields (_id, _type, _rev, _createdAt, _updatedAt) are omitted as they are set automatically.
+   */
+  initialValue?: Partial<Omit<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>, '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'>>;
 }
 /**
  * Represents an action to delete an existing document.
@@ -646,10 +742,11 @@ type DocumentAction<TDocumentType extends string = string, TDataset extends stri
 /**
  * Creates a `CreateDocumentAction` object.
  * @param doc - A handle identifying the document type, dataset, and project. An optional `documentId` can be provided.
+ * @param initialValue - Optional initial field values for the document. (System fields are omitted as they are set automatically.)
  * @returns A `CreateDocumentAction` object ready for dispatch.
  * @beta
  */
-declare function createDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>): CreateDocumentAction<TDocumentType, TDataset, TProjectId>;
+declare function createDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>, initialValue?: Partial<Omit<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>, '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'>>): CreateDocumentAction<TDocumentType, TDataset, TProjectId>;
 /**
  * Creates a `DeleteDocumentAction` object.
  * @param doc - A handle uniquely identifying the document to be deleted.
@@ -704,21 +801,6 @@ declare function discardDocument<TDocumentType extends string = string, TDataset
  * Documents that don't exist have a `null` value.
  */
 type DocumentSet<TDocument extends SanityDocument$2 = SanityDocument$2> = { [TDocumentId in string]?: TDocument | null };
-/**
- * Implements ID generation:
- *
- * A create mutation creates a new document. It takes the literal document
- * content as its argument. The rules for the new document's identifier are as
- * follows:
- *
- * - If the `_id` attribute is missing, then a new, random, unique ID is
- *   generated.
- * - If the `_id` attribute is present but ends with `.`, then it is used as a
- *   prefix for a new, random, unique ID.
- * - If the _id attribute is present, it is used as-is.
- *
- * [- source](https://www.sanity.io/docs/http-mutations#c732f27330a4)
- */
 /** @beta */
 interface ActionsResult<TDocument extends SanityDocument$3 = SanityDocument$3> {
   transactionId: string;
@@ -734,6 +816,10 @@ interface ActionsResult<TDocument extends SanityDocument$3 = SanityDocument$3> {
 }
 /** @beta */
 interface ApplyDocumentActionsOptions {
+  /**
+   * List of actions to apply.
+   */
+  actions: DocumentAction[];
   /**
    * Optionally provide an ID to be used as this transaction ID
    */
@@ -744,9 +830,9 @@ interface ApplyDocumentActionsOptions {
   disableBatching?: boolean;
 }
 /** @beta */
-declare function applyDocumentActions<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, action: DocumentAction<TDocumentType, TDataset, TProjectId> | DocumentAction<TDocumentType, TDataset, TProjectId>[], options?: ApplyDocumentActionsOptions): Promise<ActionsResult<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>>>;
+declare function applyDocumentActions<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ApplyDocumentActionsOptions): Promise<ActionsResult<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>>>;
 /** @beta */
-declare function applyDocumentActions(instance: SanityInstance, action: DocumentAction | DocumentAction[], options?: ApplyDocumentActionsOptions): Promise<ActionsResult>;
+declare function applyDocumentActions(instance: SanityInstance, options: ApplyDocumentActionsOptions): Promise<ActionsResult>;
 /**
  * Represents a reactive state source that provides synchronized access to store data
  *
@@ -820,11 +906,9 @@ interface SelectorContext<TState> {
  * @public
  */
 type Selector<TState, TParams extends unknown[], TReturn> = (context: SelectorContext<TState>, ...params: TParams) => TReturn;
-/**
- * Configuration options for creating a state source action
- */
 type ActionMap = {
   create: 'sanity.action.document.version.create';
+  createLiveEdit: 'sanity.action.document.create';
   discard: 'sanity.action.document.version.discard';
   unpublish: 'sanity.action.document.unpublish';
   delete: 'sanity.action.document.delete';
@@ -839,6 +923,10 @@ type HttpAction = {
   actionType: ActionMap['create'];
   publishedId: string;
   attributes: SanityDocumentLike;
+} | {
+  actionType: ActionMap['createLiveEdit'];
+  publishedId: string;
+  attributes: SanityDocumentLike;
 } | {
   actionType: ActionMap['discard'];
   versionId: string;
@@ -1096,11 +1184,6 @@ TTail extends readonly (string | number)[] ? TTail : []> : never;
  * @beta
  */
 type JsonMatch<TDocument, TPath extends string> = DeepGet<TDocument, PathParts<TPath>>;
-/**
- * Recursively traverse a value. When an array is encountered, ensure that
- * each object item has a _key property. Memoized such that sub-objects that
- * have not changed aren't re-computed.
- */
 interface SharedListener {
   events: Observable<ListenEvent<SanityDocument$1>>;
   dispose: () => void;
@@ -1169,10 +1252,13 @@ declare function resolveDocument<TDocumentType extends string = string, TDataset
 declare function resolveDocument<TData extends SanityDocument$3>(instance: SanityInstance, docHandle: DocumentHandle<string, string, string>): Promise<TData | null>;
 /** @beta */
 declare const getDocumentSyncStatus: BoundStoreAction<DocumentStoreState, [doc: DocumentHandle<string, string, string>], StateSource<boolean | undefined>>;
+type PermissionsStateOptions = {
+  actions: DocumentAction[];
+};
 /** @beta */
-declare const getPermissionsState: BoundStoreAction<DocumentStoreState, [DocumentAction | DocumentAction[]], StateSource<DocumentPermissionsResult | undefined>>;
+declare const getPermissionsState: BoundStoreAction<DocumentStoreState, [PermissionsStateOptions], StateSource<DocumentPermissionsResult | undefined>>;
 /** @beta */
-declare const resolvePermissions: BoundStoreAction<DocumentStoreState, [actions: DocumentAction | DocumentAction[]], Promise<DocumentPermissionsResult>>;
+declare const resolvePermissions: BoundStoreAction<DocumentStoreState, [options: PermissionsStateOptions], Promise<DocumentPermissionsResult>>;
 /** @beta */
 declare const subscribeDocumentEvents: BoundStoreAction<DocumentStoreState, [eventHandler: (e: DocumentEvent) => void], () => void>;
 /**
@@ -1309,8 +1395,6 @@ interface UserPresence {
   locations: PresenceLocation[];
   sessionId: string;
 }
-/** @public */
-
 /** @public */
 type TransportEvent = RollCallEvent | StateEvent | DisconnectEvent;
 /** @public */
@@ -1334,7 +1418,6 @@ interface DisconnectEvent {
   sessionId: string;
   timestamp: string;
 }
-/** @public */
 type PresenceStoreState = {
   locations: Map<string, {
     userId: string;
@@ -1345,7 +1428,10 @@ type PresenceStoreState = {
 /** @public */
 
 /** @public */
-declare const getPresence: BoundStoreAction<PresenceStoreState, [], StateSource<UserPresence[]>>;
+declare const getPresence: BoundStoreAction<PresenceStoreState, [((object & {
+  projectId?: string;
+  dataset?: string;
+}) | undefined)?, ...unknown[]], StateSource<UserPresence[]>>;
 /**
  * Represents a media asset in a preview.
  *
@@ -1420,9 +1506,6 @@ declare function getPreviewState<TResult extends object>(instance: SanityInstanc
  * @beta
  */
 declare function getPreviewState(instance: SanityInstance, options: GetPreviewStateOptions): StateSource<ValuePending<PreviewValue>>;
-/**
- * @beta
- */
 /**
  * @beta
  */
@@ -1465,9 +1548,6 @@ declare function getProjectionState<TData extends object>(instance: SanityInstan
  * @beta
  */
 declare function getProjectionState(instance: SanityInstance, options: ProjectionOptions): StateSource<ProjectionValuePending<Record<string, unknown>> | undefined>;
-/**
- * @beta
- */
 /** @beta */
 declare function resolveProjection<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): Promise<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>>>;
 /** @beta */
@@ -1494,6 +1574,7 @@ declare const resolveProjects: BoundStoreAction<FetcherStoreState<[options?: {
 interface QueryOptions<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string> extends Pick<ResponseQueryOptions, 'useCdn' | 'cache' | 'next' | 'cacheMode' | 'tag'>, DatasetHandle<TDataset, TProjectId> {
   query: TQuery;
   params?: Record<string, unknown>;
+  source?: DocumentSource;
 }
 /**
  * @beta
@@ -1566,7 +1647,10 @@ interface ReleasesStoreState {
  * Get the active releases from the store.
  * @internal
  */
-declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [], StateSource<ReleaseDocument[] | undefined>>;
+declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [((object & {
+  projectId?: string;
+  dataset?: string;
+}) | undefined)?, ...unknown[]], StateSource<ReleaseDocument[] | undefined>>;
 /**
  * Provides a subscribable state source for a "perspective" for the Sanity client,
  * which is used to fetch documents as though certain Content Releases are active.
@@ -1579,7 +1663,10 @@ declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [], S
  *
  * @public
  */
-declare const getPerspectiveState: BoundStoreAction<ReleasesStoreState, [options?: PerspectiveHandle | undefined], StateSource<string[] | "previewDrafts" | "published" | "drafts" | "raw" | undefined>>;
+declare const getPerspectiveState: BoundStoreAction<ReleasesStoreState, [_?: (PerspectiveHandle & {
+  projectId?: string;
+  dataset?: string;
+}) | undefined], StateSource<string[] | "raw" | "previewDrafts" | "published" | "drafts" | undefined>>;
 /** @internal */
 declare const getUsersKey: (instance: SanityInstance, {
   resourceType,
@@ -1609,7 +1696,7 @@ declare const parseUsersKey: (key: string) => {
  *
  * @beta
  */
-declare const getUsersState: BoundStoreAction<UsersStoreState, [options?: GetUsersOptions], StateSource<{
+declare const getUsersState: BoundStoreAction<UsersStoreState, [options?: GetUsersOptions | undefined], StateSource<{
   data: SanityUser[];
   totalCount: number;
   hasMore: boolean;
@@ -1658,7 +1745,7 @@ declare const getUserState: BoundStoreAction<UsersStoreState, [GetUserOptions],
 /**
  * @beta
  */
-declare const resolveUser: BoundStoreAction<UsersStoreState, [ResolveUserOptions], Promise<SanityUser | undefined>>;
+declare const resolveUser: BoundStoreAction<UsersStoreState, [ResolveUserOptions], Promise<SanityUser>>;
 interface StoreEntry<TParams extends unknown[], TData> {
   params: TParams;
   instance: SanityInstance;
@@ -1684,25 +1771,6 @@ interface FetcherStore<TParams extends unknown[], TData> {
   getState: BoundStoreAction<FetcherStoreState<TParams, TData>, TParams, StateSource<TData | undefined>>;
   resolveState: BoundStoreAction<FetcherStoreState<TParams, TData>, TParams, Promise<TData>>;
 }
-/**
- * Creates a store from a function that returns an observable that fetches data
- * that supports parameterized state caching.
- *
- * This function creates a resource store keyed by parameter values (using the
- * provided `getKey` function) and returns a state source (via `getState`)
- * that components can subscribe to. When a new subscription is added, and if
- * enough time has passed since the last fetch (controlled by
- * `fetchThrottleInternal`), it invokes the observable factory (via
- * `getObservable`) to fetch fresh data. The data is stored in state and can be
- * accessed reactively.
- *
- * Additionally, the store provides a `resolveState` function that returns a
- * Promise resolving with the next non-undefined value from the state source.
- *
- * State expiration is implemented: after the last subscription for a key is
- * removed, its state is cleared after `stateExpirationDelay` ms, causing
- * components to suspend until fresh data is fetched.
- */
 /**
  * Creates a GROQ search filter string (`[@] match text::query("...")`)
  * from a raw search query string.
@@ -1870,4 +1938,4 @@ declare const CORE_SDK_VERSION: {};
  * @public
  */
 type SanityProject = SanityProject$1;
-export { type ActionErrorEvent, type ActionsResult, type ApplyDocumentActionsOptions, type AuthConfig, type AuthProvider, type AuthState, AuthStateType, type AuthStoreState, CORE_SDK_VERSION, type ClientOptions, type ClientStoreState as ClientState, type ComlinkControllerState, type ComlinkNodeState, type CreateDocumentAction, type CurrentUser, type DatasetHandle, type DeleteDocumentAction, type DiscardDocumentAction, type DisconnectEvent, type DocumentAction, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentDiscardedEvent, type DocumentEditedEvent, type DocumentEvent, type DocumentHandle, type DocumentOptions, type DocumentPermissionsResult, type DocumentPublishedEvent, type DocumentTypeHandle, type DocumentUnpublishedEvent, type EditDocumentAction, type ErrorAuthState, type FavoriteStatusResponse, type FetcherStore, type FetcherStoreState, type FrameMessage, type GetPreviewStateOptions, type GetUserOptions, type GetUsersOptions, type Intent, type IntentFilter, type JsonMatch, type LoggedInAuthState, type LoggedOutAuthState, type LoggingInAuthState, type Membership, type NewTokenResponseMessage, type NodeState, type OrgVerificationResult, type PermissionDeniedReason, type PerspectiveHandle, type PresenceLocation, type PreviewStoreState, type PreviewValue, type ProjectHandle, type ProjectionValuePending, type PublishDocumentAction, type QueryOptions, type ReleaseDocument, type ReleasePerspective, type RequestNewTokenMessage, type ResolvePreviewOptions, type ResolveUserOptions, type ResolveUsersOptions, type Role, type RollCallEvent, type SanityConfig, type SanityDocument, type SanityInstance, SanityProject, type SanityUser, type SanityUserResponse, type Selector, type StateEvent, type StateSource, type TransactionAcceptedEvent, type TransactionRevertedEvent, type TransportEvent, type UnpublishDocumentAction, type UserPresence, type UserProfile, type UsersGroupState, type UsersStoreState, type ValidProjection, type ValuePending, type WindowMessage, applyDocumentActions, createDatasetHandle, createDocument, createDocumentHandle, createDocumentTypeHandle, createGroqSearchFilter, createProjectHandle, createSanityInstance, defineIntent, deleteDocument, destroyController, discardDocument, editDocument, getActiveReleasesState, getAuthState, getClient, getClientState, getCorsErrorProjectId, getCurrentUserState, getDashboardOrganizationId, getDatasetsState, getDocumentState, getDocumentSyncStatus, getFavoritesState, getIndexForKey, getIsInDashboardState, getLoginUrlState, getNodeState, getOrCreateChannel, getOrCreateController, getOrCreateNode, getPathDepth, getPermissionsState, getPerspectiveState, getPresence, getPreviewState, getProjectState, getProjectionState, getProjectsState, getQueryKey, getQueryState, getTokenState, getUserState, getUsersKey, getUsersState, handleAuthCallback, joinPaths, jsonMatch, loadMoreUsers, logout, observeOrganizationVerificationState, parseQueryKey, parseUsersKey, publishDocument, releaseChannel, releaseNode, resolveDatasets, resolveDocument, resolveFavoritesState, resolvePermissions, resolvePreview, resolveProject, resolveProjection, resolveProjects, resolveQuery, resolveUser, resolveUsers, setAuthToken, slicePath, stringifyPath, subscribeDocumentEvents, unpublishDocument };
+export { type ActionErrorEvent, type ActionsResult, type AgentGenerateOptions, type AgentGenerateResult, type AgentPatchOptions, type AgentPatchResult, type AgentPromptOptions, type AgentPromptResult, type AgentTransformOptions, type AgentTransformResult, type AgentTranslateOptions, type AgentTranslateResult, type ApiErrorBody, type ApplyDocumentActionsOptions, type AuthConfig, type AuthProvider, type AuthState, AuthStateType, type AuthStoreState, CORE_SDK_VERSION, type ClientOptions, type ClientStoreState as ClientState, type ComlinkControllerState, type ComlinkNodeState, type CreateDocumentAction, type CurrentUser, type DatasetHandle, type DeleteDocumentAction, type DiscardDocumentAction, type DisconnectEvent, type DocumentAction, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentDiscardedEvent, type DocumentEditedEvent, type DocumentEvent, type DocumentHandle, type DocumentOptions, type DocumentPermissionsResult, type DocumentPublishedEvent, type DocumentSource, type DocumentTypeHandle, type DocumentUnpublishedEvent, type EditDocumentAction, type ErrorAuthState, type FavoriteStatusResponse, type FetcherStore, type FetcherStoreState, type FrameMessage, type GetPreviewStateOptions, type GetUserOptions, type GetUsersOptions, type Intent, type IntentFilter, type JsonMatch, type LoggedInAuthState, type LoggedOutAuthState, type LoggingInAuthState, type Membership, type NewTokenResponseMessage, type NodeState, type OrgVerificationResult, type PermissionDeniedReason, type PerspectiveHandle, type PresenceLocation, type PreviewStoreState, type PreviewValue, type ProjectHandle, type ProjectionValuePending, type PublishDocumentAction, type QueryOptions, type ReleaseDocument, type ReleasePerspective, type RequestNewTokenMessage, type ResolvePreviewOptions, type ResolveUserOptions, type ResolveUsersOptions, type Role, type RollCallEvent, type SanityConfig, type SanityDocument, type SanityInstance, SanityProject, type SanityUser, type SanityUserResponse, type Selector, type StateEvent, type StateSource, type TransactionAcceptedEvent, type TransactionRevertedEvent, type TransportEvent, type UnpublishDocumentAction, type UserPresence, type UserProfile, type UsersGroupState, type UsersStoreState, type ValidProjection, type ValuePending, type WindowMessage, agentGenerate, agentPatch, agentPrompt, agentTransform, agentTranslate, applyDocumentActions, canvasSource, createDatasetHandle, createDocument, createDocumentHandle, createDocumentTypeHandle, createGroqSearchFilter, createProjectHandle, createSanityInstance, datasetSource, defineIntent, deleteDocument, destroyController, discardDocument, editDocument, getActiveReleasesState, getAuthState, getClient, getClientErrorApiBody, getClientErrorApiDescription, getClientErrorApiType, getClientState, getCorsErrorProjectId, getCurrentUserState, getDashboardOrganizationId, getDatasetsState, getDocumentState, getDocumentSyncStatus, getFavoritesState, getIndexForKey, getIsInDashboardState, getLoginUrlState, getNodeState, getOrCreateChannel, getOrCreateController, getOrCreateNode, getPathDepth, getPermissionsState, getPerspectiveState, getPresence, getPreviewState, getProjectState, getProjectionState, getProjectsState, getQueryKey, getQueryState, getTokenState, getUserState, getUsersKey, getUsersState, handleAuthCallback, isProjectUserNotFoundClientError, joinPaths, jsonMatch, loadMoreUsers, logout, mediaLibrarySource, observeOrganizationVerificationState, parseQueryKey, parseUsersKey, publishDocument, releaseChannel, releaseNode, resolveDatasets, resolveDocument, resolveFavoritesState, resolvePermissions, resolvePreview, resolveProject, resolveProjection, resolveProjects, resolveQuery, resolveUser, resolveUsers, setAuthToken, slicePath, stringifyPath, subscribeDocumentEvents, unpublishDocument };