@sanity/sdk 2.12.0 → 2.14.0

package/dist/index.d.ts

@@ -1,2 +1,1856 @@
-import { $ as parseQueryKey, $n as editDocument, $r as agentGenerate, $t as resolveOrganization, A as CORE_SDK_VERSION, Ai as isMediaLibrarySource, An as Action, Ar as FrameMessage, At as RollCallEvent, B as getUsersState, Bn as PublishDocumentAction, Br as observeOrganizationVerificationState, Bt as SanityUserResponse, C as SanityProject, Ci as StudioConfig, Cn as resolvePermissions, Cr as getOrCreateNode, Ct as PreviewValue, D as jsonMatch, Di as isDatasetResource, Dn as JsonMatch, Dr as getOrCreateChannel, Dt as getPresence, E as joinPaths, Ei as isCanvasSource, En as PermissionDeniedReason, Er as destroyController, Et as ValidProjection, F as defineIntent, Fn as DeleteReleaseAction, Fr as ClientStoreState, Ft as GetUsersOptions, G as parseUsersKey, Gn as UnpublishDocumentAction, Gr as AgentPatchOptions, Gt as OrganizationsOptions, H as resolveUser, Hn as ReleaseAction, Hr as AuthStateType, Ht as UsersGroupState, I as createGroqSearchFilter, In as DiscardDocumentAction, Ir as getClient, It as Membership, J as getActiveReleasesState, Jn as createDocument, Jr as AgentPromptResult, Jt as Organization, K as getPerspectiveState, Kn as UnscheduleReleaseAction, Kr as AgentPatchResult, Kt as getOrganizationsState, L as FetcherStore, Ln as DocumentAction, Lr as getClientState, Lt as ResolveUserOptions, M as getCorsErrorProjectId, Mi as AuthProvider, Mn as CreateDocumentAction, Mr as RequestNewTokenMessage, Mt as TransportEvent, N as Intent, Nn as CreateReleaseAction, Nr as WindowMessage, Nt as UserPresence, O as slicePath, Oi as isDatasetSource, On as Selector, Or as getOrCreateController, Ot as DisconnectEvent, P as IntentFilter, Pn as DeleteDocumentAction, Pr as ClientOptions, Pt as GetUserOptions, Q as getQueryState, Qn as discardDocument, Qr as AgentTranslateResult, Qt as getOrganizationState, R as FetcherStoreState, Rn as EditDocumentAction, Rr as logout, Rt as ResolveUsersOptions, S as SanityDocument, Si as SanityConfig, Sn as resolveDocument, Sr as ComlinkNodeState, St as PreviewStoreState, T as getPathDepth, Ti as isCanvasResource, Tn as DocumentPermissionsResult, Tr as ComlinkControllerState, Tt as ProjectionValuePending, U as resolveUsers, Un as ScheduleReleaseAction, Ur as AgentGenerateOptions, Ut as UsersStoreState, V as loadMoreUsers, Vn as PublishReleaseAction, Vr as OrgVerificationResult, Vt as UserProfile, W as getUsersKey, Wn as UnarchiveReleaseAction, Wr as AgentGenerateResult, Wt as Organizations, X as QueryOptions, Xn as deleteDocument, Xr as AgentTransformResult, Xt as OrganizationMember, Y as getAllReleasesState, Yn as createRelease, Yr as AgentTransformOptions, Yt as OrganizationBase, Z as getQueryKey, Zn as deleteRelease, Zr as AgentTranslateOptions, Zt as OrganizationOptions, _ as getTokenState, _i as MediaLibrarySource, _n as TransactionRevertedEvent, _r as createDocumentHandle, _t as PREVIEW_PROJECTION, a as isProjectUserNotFoundClientError, ai as createSanityInstance, an as ApplyDocumentActionsOptions, ar as unpublishDocument, at as getProjectionState, b as ReleaseDocument, bi as ReleaseHandle, bn as getDocumentSyncStatus, br as NodeState, bt as PreviewMedia, c as ErrorAuthState, ci as CanvasSource, cn as DocumentCreatedEvent, cr as resolveDatasets, ct as ProjectMember, d as LoggingInAuthState, di as DatasetSource, dn as DocumentEditedEvent, dr as LogContext, dt as ProjectOptions, ei as agentPatch, en as FavoriteStatusResponse, er as editRelease, et as resolveQuery, f as getAuthState, fi as DocumentHandle, fn as DocumentEvent, fr as LogLevel, ft as getProjectState, g as getLoginUrlState, gi as MediaLibraryResource, gn as TransactionAcceptedEvent, gr as createDatasetHandle, gt as transformProjectionToPreview, h as getIsInDashboardState, hi as DocumentTypeHandle, hn as DocumentUnpublishedEvent, hr as LoggerConfig, ht as resolvePreview, i as getClientErrorApiType, ii as SanityInstance, in as ActionsResult, ir as unarchiveRelease, it as resolveProjection, j as isImportError, ji as AuthConfig, jn as ArchiveReleaseAction, jr as NewTokenResponseMessage, jt as StateEvent, k as stringifyPath, ki as isMediaLibraryResource, kn as StateSource, kr as releaseChannel, kt as PresenceLocation, l as LoggedInAuthState, li as DatasetHandle, ln as DocumentDeletedEvent, lr as configureLogging, lt as ProjectMemberRole, m as getDashboardOrganizationId, mi as DocumentSource, mn as DocumentTransactionSubmissionResult, mr as Logger, mt as ResolvePreviewOptions, n as getClientErrorApiBody, ni as agentTransform, nn as resolveFavoritesState, nr as publishRelease, nt as getProjectsState, o as AuthState, oi as isStudioConfig, on as applyDocumentActions, or as unscheduleRelease, ot as Project, p as getCurrentUserState, pi as DocumentResource, pn as DocumentPublishedEvent, pr as LogNamespace, pt as resolveProject, q as ReleaseState, qn as archiveRelease, qr as AgentPromptOptions, qt as resolveOrganizations, r as getClientErrorApiDescription, ri as agentTranslate, rn as getReleaseDocumentId, rr as scheduleRelease, rt as resolveProjects, s as AuthStoreState, si as CanvasResource, sn as ActionErrorEvent, sr as getDatasetsState, st as ProjectBase, t as ApiErrorBody, ti as agentPrompt, tn as getFavoritesState, tr as publishDocument, tt as ProjectsOptions, u as LoggedOutAuthState, ui as DatasetResource, un as DocumentDiscardedEvent, ur as InstanceContext, ut as ProjectMetadata, v as setAuthToken, vi as PerspectiveHandle, vn as DocumentOptions, vr as createDocumentTypeHandle, vt as GetPreviewStateOptions, w as getIndexForKey, wi as TokenSource, wn as subscribeDocumentEvents, wr as releaseNode, wt as ValuePending, x as Role, xi as ReleasePerspective, xn as getPermissionsState, xr as getNodeState, xt as PreviewQueryResult, y as CurrentUser, yi as ProjectHandle, yn as getDocumentState, yr as createProjectHandle, yt as getPreviewState, z as getUserState, zn as EditReleaseAction, zr as handleAuthCallback, zt as SanityUser } from "./_chunks-dts/utils.js";
-export { Action, ActionErrorEvent, ActionsResult, AgentGenerateOptions, AgentGenerateResult, AgentPatchOptions, AgentPatchResult, AgentPromptOptions, AgentPromptResult, AgentTransformOptions, AgentTransformResult, AgentTranslateOptions, AgentTranslateResult, ApiErrorBody, ApplyDocumentActionsOptions, ArchiveReleaseAction, AuthConfig, AuthProvider, AuthState, AuthStateType, AuthStoreState, CORE_SDK_VERSION, CanvasResource, CanvasSource, ClientOptions, ClientStoreState as ClientState, ComlinkControllerState, ComlinkNodeState, CreateDocumentAction, CreateReleaseAction, CurrentUser, DatasetHandle, DatasetResource, DatasetSource, DeleteDocumentAction, DeleteReleaseAction, DiscardDocumentAction, DisconnectEvent, DocumentAction, DocumentCreatedEvent, DocumentDeletedEvent, DocumentDiscardedEvent, DocumentEditedEvent, DocumentEvent, DocumentHandle, DocumentOptions, DocumentPermissionsResult, DocumentPublishedEvent, DocumentResource, DocumentSource, DocumentTransactionSubmissionResult, DocumentTypeHandle, DocumentUnpublishedEvent, EditDocumentAction, EditReleaseAction, ErrorAuthState, FavoriteStatusResponse, FetcherStore, FetcherStoreState, FrameMessage, GetPreviewStateOptions, GetUserOptions, GetUsersOptions, InstanceContext, Intent, IntentFilter, JsonMatch, LogContext, LogLevel, LogNamespace, LoggedInAuthState, LoggedOutAuthState, Logger, LoggerConfig, LoggingInAuthState, MediaLibraryResource, MediaLibrarySource, Membership, NewTokenResponseMessage, NodeState, OrgVerificationResult, Organization, OrganizationBase, OrganizationMember, OrganizationOptions, Organizations, OrganizationsOptions, PREVIEW_PROJECTION, PermissionDeniedReason, PerspectiveHandle, PresenceLocation, PreviewMedia, PreviewQueryResult, PreviewStoreState, PreviewValue, Project, ProjectBase, ProjectHandle, ProjectMember, ProjectMemberRole, ProjectMetadata, ProjectOptions, ProjectionValuePending, ProjectsOptions, PublishDocumentAction, PublishReleaseAction, QueryOptions, ReleaseAction, ReleaseDocument, ReleaseHandle, ReleasePerspective, ReleaseState, RequestNewTokenMessage, ResolvePreviewOptions, ResolveUserOptions, ResolveUsersOptions, Role, RollCallEvent, SanityConfig, SanityDocument, SanityInstance, SanityProject, SanityUser, SanityUserResponse, ScheduleReleaseAction, Selector, StateEvent, StateSource, StudioConfig, TokenSource, TransactionAcceptedEvent, TransactionRevertedEvent, TransportEvent, UnarchiveReleaseAction, UnpublishDocumentAction, UnscheduleReleaseAction, UserPresence, UserProfile, UsersGroupState, UsersStoreState, ValidProjection, ValuePending, WindowMessage, agentGenerate, agentPatch, agentPrompt, agentTransform, agentTranslate, applyDocumentActions, archiveRelease, configureLogging, createDatasetHandle, createDocument, createDocumentHandle, createDocumentTypeHandle, createGroqSearchFilter, createProjectHandle, createRelease, createSanityInstance, defineIntent, deleteDocument, deleteRelease, destroyController, discardDocument, editDocument, editRelease, getActiveReleasesState, getAllReleasesState, getAuthState, getClient, getClientErrorApiBody, getClientErrorApiDescription, getClientErrorApiType, getClientState, getCorsErrorProjectId, getCurrentUserState, getDashboardOrganizationId, getDatasetsState, getDocumentState, getDocumentSyncStatus, getFavoritesState, getIndexForKey, getIsInDashboardState, getLoginUrlState, getNodeState, getOrCreateChannel, getOrCreateController, getOrCreateNode, getOrganizationState, getOrganizationsState, getPathDepth, getPermissionsState, getPerspectiveState, getPresence, getPreviewState, getProjectState, getProjectionState, getProjectsState, getQueryKey, getQueryState, getReleaseDocumentId, getTokenState, getUserState, getUsersKey, getUsersState, handleAuthCallback, isCanvasResource, isCanvasSource, isDatasetResource, isDatasetSource, isImportError, isMediaLibraryResource, isMediaLibrarySource, isProjectUserNotFoundClientError, isStudioConfig, joinPaths, jsonMatch, loadMoreUsers, logout, observeOrganizationVerificationState, parseQueryKey, parseUsersKey, publishDocument, publishRelease, releaseChannel, releaseNode, resolveDatasets, resolveDocument, resolveFavoritesState, resolveOrganization, resolveOrganizations, resolvePermissions, resolvePreview, resolveProject, resolveProjection, resolveProjects, resolveQuery, resolveUser, resolveUsers, scheduleRelease, setAuthToken, slicePath, stringifyPath, subscribeDocumentEvents, transformProjectionToPreview, unarchiveRelease, unpublishDocument, unscheduleRelease };
+import { $ as isStudioConfig, A as ApiErrorBody, B as LoggingInAuthState, C as PreviewQueryResult, Ct as isMediaLibrarySource, D as ProjectionValuePending, E as ValuePending, F as AuthState, G as getLoginUrlState, H as getCurrentUserState, I as AuthStoreState, J as AuthStateType, K as getTokenState, L as ErrorAuthState, M as getClientErrorApiDescription, N as getClientErrorApiType, O as ValidProjection, P as isProjectUserNotFoundClientError, Q as createSanityInstance, R as LoggedInAuthState, S as PreviewMedia, St as isMediaLibraryResource, T as PreviewValue, Tt as AuthProvider, U as getDashboardOrganizationId, V as getAuthState, W as getIsInDashboardState, X as StoreAction, Y as BoundStoreAction, Z as SanityInstance, _ as parseQueryKey, _t as TokenSource, a as GetUsersOptions, at as DocumentHandle, b as StateSource, bt as isDatasetResource, c as ResolveUsersOptions, ct as DocumentTypeHandle, d as UserProfile, dt as PerspectiveHandle, et as CanvasResource, f as UsersGroupState, ft as ProjectHandle, g as getQueryState, gt as StudioConfig, h as getQueryKey, ht as SanityConfig, i as GetUserOptions, it as DatasetSource, j as getClientErrorApiBody, k as PREVIEW_PROJECTION, l as SanityUser, lt as MediaLibraryResource, m as QueryOptions, mt as ReleasePerspective, n as getUsersKey, nt as DatasetHandle, o as Membership, ot as DocumentResource, p as UsersStoreState, pt as ReleaseHandle, q as setAuthToken, r as parseUsersKey, rt as DatasetResource, s as ResolveUserOptions, st as DocumentSource, t as createGroqSearchFilter, tt as CanvasSource, u as SanityUserResponse, ut as MediaLibrarySource, v as resolveQuery, vt as isCanvasResource, w as PreviewStoreState, wt as AuthConfig, x as transformProjectionToPreview, xt as isDatasetSource, y as Selector, yt as isCanvasSource, z as LoggedOutAuthState } from "./_chunks-dts/createGroqSearchFilter.js";
+import { ClientConfig, ListenEvent, MultipleMutationResult, ReleaseDocument, ReleaseDocument as ReleaseDocument$1, SanityClient, SanityDocument as SanityDocument$1, SanityProject as SanityProject$1 } from "@sanity/client";
+import { CurrentUser, Mutation, PatchOperations, Role, SanityDocument, SanityDocument as SanityDocument$2, SanityDocumentLike } from "@sanity/types";
+import { Observable, Subject } from "rxjs";
+import { SanityDocument as SanityDocument$3, SanityProjectionResult } from "groq";
+import { ChannelInput, ChannelInstance, Controller, Message, Node, NodeInput, Status } from "@sanity/comlink";
+import { PatchMutation } from "/home/runner/work/sdk/sdk/node_modules/.pnpm/@sanity+mutate@0.18.0_xstate@5.31.1/node_modules/@sanity/mutate/dist/_unstable_store.js";
+import { ExprNode } from "groq-js";
+import { CanvasResource as CanvasResource$1, MediaResource, StudioResource } from "@sanity/message-protocol";
+import { getIndexForKey, getPathDepth, joinPaths, jsonMatch, slicePath, stringifyPath } from "@sanity/json-match";
+/** @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, resource?: DocumentResource): AgentGenerateResult;
+/**
+ * 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
+ */
+declare function agentTransform(instance: SanityInstance, options: AgentTransformOptions, resource?: DocumentResource): AgentTransformResult;
+/**
+ * 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, resource?: DocumentResource): 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, resource?: DocumentResource): 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, resource?: DocumentResource): Observable<AgentPatchResult>;
+/**
+ * Error message returned by the organization verification
+ * @public
+ */
+interface OrgVerificationResult {
+  error: string | null;
+}
+/**
+ * Creates an observable that emits the organization verification state for a given instance.
+ * It combines the dashboard organization ID (from auth context) with the
+ * project's actual organization ID (fetched via getProjectState) and compares them.
+ * @public
+ */
+declare function observeOrganizationVerificationState(instance: SanityInstance, projectIds: string[]): Observable<OrgVerificationResult>;
+/**
+ * @public
+ */
+declare const handleAuthCallback: BoundStoreAction<AuthStoreState, [locationHref?: string | undefined], Promise<string | false>>;
+/**
+ * @public
+ */
+declare const logout: BoundStoreAction<AuthStoreState, [], Promise<void>>;
+type AllowedClientConfigKey = 'useCdn' | 'token' | 'perspective' | 'apiHost' | 'proxy' | 'withCredentials' | 'timeout' | 'maxRetries' | 'dataset' | 'projectId' | 'requestTagPrefix' | 'useProjectHostname';
+/**
+ * States tracked by the client store
+ * @public
+ */
+interface ClientStoreState {
+  token: string | null;
+  clients: { [TKey in string]?: SanityClient };
+  authMethod?: 'localstorage' | 'cookie';
+}
+/**
+ * Options used when retrieving a client instance from the client store.
+ *
+ * This interface extends the base {@link ClientConfig} and adds:
+ *
+ * - **apiVersion:** A required string indicating the API version for the client.
+ * - **scope:** An optional flag to choose between the project-specific client
+ *   ('project') and the global client ('global'). When set to `'global'`, the
+ *   global client is used.
+ *
+ * These options are utilized by `getClient` and `getClientState` to configure and
+ * return appropriate client instances that automatically handle authentication
+ * updates and configuration changes.
+ *
+ * @public
+ */
+interface ClientOptions extends Pick<ClientConfig, AllowedClientConfigKey> {
+  /**
+   * An optional flag to choose between the default client (typically project-level)
+   * and the global client ('global'). When set to `'global'`, the global client
+   * is used.
+   */
+  scope?: 'default' | 'global';
+  /**
+   * A required string indicating the API version for the client.
+   */
+  apiVersion: string;
+  /**
+   * @internal
+   * The SDK resource to use for the client -- this will get transformed into a ClientConfig resource.
+   */
+  resource?: DocumentResource;
+}
+/**
+ * Retrieves a Sanity client instance configured with the provided options.
+ *
+ * This function returns a client instance configured for the project or as a
+ * global client based on the options provided. It ensures efficient reuse of
+ * client instances by returning the same instance for the same options.
+ * For automatic handling of authentication token updates, consider using
+ * `getClientState`.
+ *
+ * @public
+ */
+declare const getClient: BoundStoreAction<ClientStoreState, [options: ClientOptions], SanityClient>;
+/**
+ * Returns a state source for the Sanity client instance.
+ *
+ * This function provides a subscribable state source that emits updated client
+ * instances whenever relevant configurations change (such as authentication tokens).
+ * Use this when you need to react to client configuration changes in your application.
+ *
+ * @public
+ */
+declare const getClientState: BoundStoreAction<ClientStoreState, [options: ClientOptions], import("../_exports").StateSource<SanityClient>>;
+/**
+ * Message sent from a containing app to an iframe
+ * @public
+ */
+type FrameMessage = Message;
+/**
+ * Message sent from an iframe to a containing app
+ * @public
+ */
+type WindowMessage = Message;
+/**
+ * Message from SDK (iframe) to Parent (dashboard) to request a new token
+ * @internal
+ */
+type RequestNewTokenMessage = {
+  type: 'dashboard/v1/auth/tokens/create';
+  payload?: undefined;
+};
+/**
+ * Message from Parent (dashboard) to SDK (iframe) with the new token
+ * @internal
+ */
+type NewTokenResponseMessage = {
+  type: 'dashboard/v1/auth/tokens/create';
+  payload: {
+    token: string | null;
+    error?: string;
+  };
+};
+/**
+ * Individual channel with its relevant options
+ * @public
+ */
+interface ChannelEntry {
+  channel: ChannelInstance<FrameMessage, WindowMessage>;
+  options: ChannelInput;
+  refCount: number;
+}
+/**
+ * Internal state tracking comlink connections
+ * @public
+ */
+interface ComlinkControllerState {
+  controller: Controller | null;
+  controllerOrigin: string | null;
+  channels: Map<string, ChannelEntry>;
+}
+/**
+ * Calls the destroy method on the controller and resets the controller state.
+ * @public
+ */
+declare const destroyController: BoundStoreAction<ComlinkControllerState, [], void>;
+/**
+ * Retrieve or create a channel to be used for communication between
+ * an application and the controller.
+ * @public
+ */
+declare const getOrCreateChannel: BoundStoreAction<ComlinkControllerState, [options: ChannelInput], ChannelInstance<import("@sanity/comlink").Message, import("@sanity/comlink").Message>>;
+/**
+ * Initializes or fetches a controller to handle communication
+ * between an application and iframes.
+ * @public
+ */
+declare const getOrCreateController: BoundStoreAction<ComlinkControllerState, [targetOrigin: string], Controller>;
+/**
+ * Signals to the store that the consumer has stopped using the channel
+ * @public
+ */
+declare const releaseChannel: BoundStoreAction<ComlinkControllerState, [name: string], void>;
+/**
+ * Individual node with its relevant options
+ * @public
+ */
+interface NodeEntry {
+  node: Node<WindowMessage, FrameMessage>;
+  options: NodeInput;
+  status: Status;
+  statusUnsub?: () => void;
+}
+/**
+ * Internal state tracking comlink connections
+ * @public
+ */
+interface ComlinkNodeState {
+  nodes: Map<string, NodeEntry>;
+  subscriptions: Map<string, Set<symbol>>;
+}
+/**
+ * Signals to the store that the consumer has stopped using the node
+ * @public
+ */
+declare const releaseNode: BoundStoreAction<ComlinkNodeState, [name: string], void>;
+/**
+ * Retrieve or create a node to be used for communication between
+ * an application and the controller -- specifically, a node should
+ * be created within a frame / window to communicate with the controller.
+ * @public
+ */
+declare const getOrCreateNode: BoundStoreAction<ComlinkNodeState, [options: NodeInput], Node<import("@sanity/comlink").Message, import("@sanity/comlink").Message>>;
+/**
+ * @public
+ */
+interface NodeState {
+  node: Node<WindowMessage, FrameMessage>;
+  status: Status | undefined;
+}
+/**
+ * Provides a subscribable state source for a node by name
+ * @param instance - The Sanity instance to get the node state for
+ * @param nodeInput - The configuration for the node to get the state for
+
+ * @returns A subscribable state source for the node
+ * @public
+ */
+declare const getNodeState: BoundStoreAction<ComlinkNodeState, [NodeInput], import("../../_exports").StateSource<NodeState | undefined>>;
+/**
+ * Creates or validates a `DocumentHandle` object.
+ * Ensures the provided object conforms to the `DocumentHandle` interface.
+ * @param handle - The object containing document identification properties.
+ * @returns The validated `DocumentHandle` object.
+ * @public
+ */
+declare function createDocumentHandle<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(handle: DocumentHandle<TDocumentType, TDataset, TProjectId>): DocumentHandle<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates or validates a `DocumentTypeHandle` object.
+ * Ensures the provided object conforms to the `DocumentTypeHandle` interface.
+ * @param handle - The object containing document type identification properties.
+ * @returns The validated `DocumentTypeHandle` object.
+ * @public
+ */
+declare function createDocumentTypeHandle<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(handle: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>): DocumentTypeHandle<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates or validates a `ProjectHandle` object.
+ * Ensures the provided object conforms to the `ProjectHandle` interface.
+ * @param handle - The object containing project identification properties.
+ * @returns The validated `ProjectHandle` object.
+ * @public
+ */
+declare function createProjectHandle<TProjectId extends string = string>(handle: ProjectHandle<TProjectId>): ProjectHandle<TProjectId>;
+/**
+ * Creates or validates a `DatasetHandle` object.
+ * Ensures the provided object conforms to the `DatasetHandle` interface.
+ * @param handle - The object containing dataset identification properties.
+ * @returns The validated `DatasetHandle` object.
+ * @public
+ */
+declare function createDatasetHandle<TDataset extends string = string, TProjectId extends string = string>(handle: DatasetHandle<TDataset, TProjectId>): DatasetHandle<TDataset, TProjectId>;
+/**
+ * Logging infrastructure for the Sanity SDK
+ *
+ * Provides multi-level, namespace-based logging for both SDK users and maintainers.
+ * In production builds, all logging can be stripped via tree-shaking.
+ *
+ * @example SDK User
+ * ```ts
+ * import {configureLogging} from '@sanity/sdk'
+ *
+ * configureLogging({
+ *   level: 'info',
+ *   namespaces: ['auth', 'document']
+ * })
+ * ```
+ *
+ * @example SDK Maintainer
+ * ```ts
+ * configureLogging({
+ *   level: 'trace',
+ *   namespaces: ['*'],
+ *   internal: true
+ * })
+ * ```
+ */
+/**
+ * Log levels in order of verbosity (least to most)
+ * - error: Critical failures that prevent operation
+ * - warn: Issues that may cause problems but don't stop execution
+ * - info: High-level informational messages (SDK user level)
+ * - debug: Detailed debugging information (maintainer level)
+ * - trace: Very detailed tracing (maintainer level, includes RxJS streams)
+ * @public
+ */
+type LogLevel = 'error' | 'warn' | 'info' | 'debug' | 'trace';
+/**
+ * Log namespaces organize logs by functional domain
+ *
+ * @remarks
+ * This is an extensible string type. As logging is added to more modules,
+ * additional namespaces will be recognized. Currently implemented namespaces
+ * will be documented as they are added.
+ * @internal
+ */
+type LogNamespace = string;
+/**
+ * Configuration for the logging system
+ * @public
+ */
+interface LoggerConfig {
+  /**
+   * Minimum log level to output
+   * @defaultValue 'warn'
+   */
+  level?: LogLevel;
+  /**
+   * Namespaces to enable. Use ['*'] for all namespaces
+   * @defaultValue []
+   * @remarks
+   * Available namespaces depend on which modules have logging integrated.
+   * Check the SDK documentation for the current list of instrumented modules.
+   * @example ['auth', 'document']
+   */
+  namespaces?: string[];
+  /**
+   * Enable internal/maintainer-level logging
+   * Shows RxJS streams, store internals, etc.
+   * @defaultValue false
+   */
+  internal?: boolean;
+  /**
+   * Custom log handler (for testing or custom output)
+   * @defaultValue console methods
+   */
+  handler?: LogHandler;
+  /**
+   * Enable timestamps in log output
+   * @defaultValue true
+   */
+  timestamps?: boolean;
+  /**
+   * Enable in production builds
+   * @defaultValue false
+   */
+  enableInProduction?: boolean;
+}
+/**
+ * Custom log handler interface
+ *
+ * @internal
+ */
+interface LogHandler {
+  error: (message: string, context?: LogContext) => void;
+  warn: (message: string, context?: LogContext) => void;
+  info: (message: string, context?: LogContext) => void;
+  debug: (message: string, context?: LogContext) => void;
+  trace: (message: string, context?: LogContext) => void;
+}
+/**
+ * Context object attached to log messages
+ *
+ * This interface allows you to attach arbitrary contextual data to log messages.
+ * The index signature `[key: string]: unknown` enables you to add any custom
+ * properties relevant to your log entry (e.g., `userId`, `documentId`, `action`, etc.).
+ *
+ * **Sensitive data sanitization:**
+ * Top-level keys containing sensitive names (`token`, `password`, `secret`, `apiKey`,
+ * `authorization`) are automatically redacted to `[REDACTED]` in log output.
+ *
+ * @example
+ * ```ts
+ * logger.info('User logged in', {
+ *   userId: '123',          // Custom context
+ *   action: 'login',        // Custom context
+ *   token: 'secret'         // Will be redacted to [REDACTED]
+ * })
+ * ```
+ *
+ * @internal
+ */
+interface LogContext {
+  /**
+   * Custom context properties that provide additional information about the log entry.
+   * Any key-value pairs can be added here (e.g., userId, documentId, requestId, etc.).
+   * Keys with sensitive names (token, password, secret, apiKey, authorization) are
+   * automatically sanitized.
+   */
+  [key: string]: unknown;
+  /** Error object if logging an error */
+  error?: Error | unknown;
+  /** Duration in milliseconds for timed operations */
+  duration?: number;
+  /** Stack trace for debugging */
+  stack?: string;
+  /** Instance context (automatically added when available) */
+  instanceContext?: InstanceContext;
+}
+/**
+ * Instance context information automatically added to logs
+ * @internal
+ */
+interface InstanceContext {
+  /** Unique instance ID */
+  instanceId?: string;
+  /** Project ID */
+  projectId?: string;
+  /** Dataset name */
+  dataset?: string;
+}
+/**
+ * Logger instance for a specific namespace
+ * @internal
+ */
+interface Logger {
+  readonly namespace: string;
+  error: (message: string, context?: LogContext) => void;
+  warn: (message: string, context?: LogContext) => void;
+  info: (message: string, context?: LogContext) => void;
+  debug: (message: string, context?: LogContext) => void;
+  trace: (message: string, context?: LogContext) => void;
+  /** Check if a log level is enabled (for performance-sensitive code) */
+  isLevelEnabled: (level: LogLevel) => boolean;
+  /** Create a child logger with extended context */
+  child: (context: LogContext) => Logger;
+  /** Get the instance context if available */
+  getInstanceContext: () => InstanceContext | undefined;
+}
+/**
+ * Configure logging for the Sanity SDK
+ *
+ * This function allows you to control what logs are output by the SDK,
+ * making it easier to debug issues in development or production.
+ *
+ * @remarks
+ * **Zero-Config via Environment Variable (Recommended):**
+ *
+ * The SDK automatically reads the `DEBUG` environment variable, making it
+ * easy to enable logging without code changes:
+ *
+ * ```bash
+ * # Enable all SDK logging at debug level
+ * DEBUG=sanity:* npm start
+ *
+ * # Enable specific namespaces
+ * DEBUG=sanity:auth,sanity:document npm start
+ *
+ * # Enable trace level for all namespaces
+ * DEBUG=sanity:trace:* npm start
+ *
+ * # Enable internal/maintainer logs
+ * DEBUG=sanity:*:internal npm start
+ * ```
+ *
+ * This matches the pattern used by Sanity CLI and Studio, making it familiar
+ * and easy for support teams to help troubleshoot issues.
+ *
+ * **Programmatic Configuration (Advanced):**
+ *
+ * For more control (custom handlers, dynamic configuration), call this function
+ * explicitly. Programmatic configuration overrides environment variables.
+ *
+ * **For Application Developers:**
+ * Use `info`, `warn`, or `error` levels to see high-level SDK activity
+ * without being overwhelmed by internal details.
+ *
+ * **For SDK Maintainers:**
+ * Use `debug` or `trace` levels with `internal: true` to see detailed
+ * information about store operations, RxJS streams, and state transitions.
+ *
+ * **Instance Context:**
+ * Logs automatically include instance information (projectId, dataset, instanceId)
+ * when available, making it easier to debug multi-instance scenarios:
+ * ```
+ * [INFO] [auth] [project:abc] [dataset:production] User logged in
+ * ```
+ *
+ * **Available Namespaces:**
+ * - `sdk` - SDK initialization, configuration, and lifecycle
+ * - `auth` - Authentication and authorization (when instrumented in the future)
+ * - And more as logging is added to modules
+ *
+ * @example Zero-config via environment variable (recommended for debugging)
+ * ```bash
+ * # Just set DEBUG and run your app - no code changes needed!
+ * DEBUG=sanity:* npm start
+ * ```
+ *
+ * @example Programmatic configuration (application developer)
+ * ```ts
+ * import {configureLogging} from '@sanity/sdk'
+ *
+ * // Log warnings and errors for auth and document operations
+ * configureLogging({
+ *   level: 'warn',
+ *   namespaces: ['auth', 'document']
+ * })
+ * ```
+ *
+ * @example Programmatic configuration (SDK maintainer)
+ * ```ts
+ * import {configureLogging} from '@sanity/sdk'
+ *
+ * // Enable all logs including internal traces
+ * configureLogging({
+ *   level: 'trace',
+ *   namespaces: ['*'],
+ *   internal: true
+ * })
+ * ```
+ *
+ * @example Custom handler (for testing)
+ * ```ts
+ * import {configureLogging} from '@sanity/sdk'
+ *
+ * const logs: string[] = []
+ * configureLogging({
+ *   level: 'info',
+ *   namespaces: ['*'],
+ *   handler: {
+ *     error: (msg) => logs.push(msg),
+ *     warn: (msg) => logs.push(msg),
+ *     info: (msg) => logs.push(msg),
+ *     debug: (msg) => logs.push(msg),
+ *     trace: (msg) => logs.push(msg),
+ *   }
+ * })
+ * ```
+ *
+ * @public
+ */
+declare function configureLogging(config: LoggerConfig): void;
+/** @public */
+declare const getDatasetsState: BoundStoreAction<import("../_exports").FetcherStoreState<[options?: ProjectHandle<string> | undefined], import("@sanity/client").DatasetsResponse>, [options?: ProjectHandle<string> | undefined], import("../_exports").StateSource<import("@sanity/client").DatasetsResponse | undefined>>;
+/** @public */
+declare const resolveDatasets: BoundStoreAction<import("../_exports").FetcherStoreState<[options?: ProjectHandle<string> | undefined], import("@sanity/client").DatasetsResponse>, [options?: ProjectHandle<string> | undefined], Promise<import("@sanity/client").DatasetsResponse>>;
+/**
+ * Represents an action to create a new document.
+ * Specifies the document type and optionally a document ID (which will be treated as the published ID).
+ * @beta
+ */
+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.
+ * Requires the full document handle including the document ID.
+ * @beta
+ */
+interface DeleteDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.delete';
+}
+/**
+ * Represents an action to edit an existing document using patches.
+ * Requires the full document handle and an array of patch operations.
+ * @beta
+ */
+interface EditDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.edit';
+  patches?: PatchOperations[];
+}
+/**
+ * Represents an action to publish the draft version of a document.
+ * Requires the full document handle.
+ * @beta
+ */
+interface PublishDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.publish';
+}
+/**
+ * Represents an action to unpublish a document, moving its published content to a draft.
+ * Requires the full document handle.
+ * @beta
+ */
+interface UnpublishDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.unpublish';
+}
+/**
+ * Represents an action to discard the draft changes of a document.
+ * Requires the full document handle.
+ * @beta
+ */
+interface DiscardDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.discard';
+}
+/**
+ * Union type representing all possible document actions within the SDK.
+ * @beta
+ */
+type DocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> = CreateDocumentAction<TDocumentType, TDataset, TProjectId> | DeleteDocumentAction<TDocumentType, TDataset, TProjectId> | EditDocumentAction<TDocumentType, TDataset, TProjectId> | PublishDocumentAction<TDocumentType, TDataset, TProjectId> | UnpublishDocumentAction<TDocumentType, TDataset, TProjectId> | DiscardDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Union of every action accepted by `applyDocumentActions` — both document-
+ * level actions and release-lifecycle actions.
+ * @beta
+ */
+type Action<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> = DocumentAction<TDocumentType, TDataset, TProjectId> | ReleaseAction;
+/**
+ * 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>, 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.
+ * @returns A `DeleteDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function deleteDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>): DeleteDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates an `EditDocumentAction` object with patches for modifying a document.
+ * Accepts patches in either the standard `PatchOperations` format or as a `SanityMutatePatchMutation` from `@sanity/mutate`.
+ *
+ * @param doc - A handle uniquely identifying the document to be edited.
+ * @param sanityMutatePatch - A patch mutation object from `@sanity/mutate`.
+ * @returns An `EditDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function editDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>, sanityMutatePatch: PatchMutation): EditDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates an `EditDocumentAction` object with patches for modifying a document.
+ *
+ * @param doc - A handle uniquely identifying the document to be edited.
+ * @param patches - A single patch operation or an array of patch operations.
+ * @returns An `EditDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function editDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>, patches?: PatchOperations | PatchOperations[]): EditDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates a `PublishDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document to be published.
+ * @returns A `PublishDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function publishDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>): PublishDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates an `UnpublishDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document to be unpublished.
+ * @returns An `UnpublishDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function unpublishDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>): UnpublishDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates a `DiscardDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document whose draft changes are to be discarded.
+ * @returns A `DiscardDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function discardDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>): DiscardDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates a new release. The `releaseId` must be unique within the current
+ * retention period.
+ * @beta
+ */
+interface CreateReleaseAction extends ReleaseHandle {
+  type: 'release.create';
+  metadata: ReleaseDocument$1['metadata'];
+}
+/**
+ * Patches the metadata of an existing release.
+ * @beta
+ */
+interface EditReleaseAction extends ReleaseHandle {
+  type: 'release.edit';
+  patch: PatchOperations;
+}
+/**
+ * Publishes all version documents in a release.
+ * @beta
+ */
+interface PublishReleaseAction extends ReleaseHandle {
+  type: 'release.publish';
+}
+/**
+ * Schedules a release to be published at the given UTC time. Locks the
+ * version documents server-side until the release is unscheduled or published.
+ * @beta
+ */
+interface ScheduleReleaseAction extends ReleaseHandle {
+  type: 'release.schedule';
+  publishAt: string;
+}
+/**
+ * Unschedules a release that was previously scheduled, returning it to the
+ * active editable state.
+ * @beta
+ */
+interface UnscheduleReleaseAction extends ReleaseHandle {
+  type: 'release.unschedule';
+}
+/**
+ * Archives an active release. Version documents within the release are
+ * removed and no longer queryable, though still recoverable through history
+ * during the retention period.
+ * @beta
+ */
+interface ArchiveReleaseAction extends ReleaseHandle {
+  type: 'release.archive';
+}
+/**
+ * Restores an archived release. Only possible during the retention period.
+ * @beta
+ */
+interface UnarchiveReleaseAction extends ReleaseHandle {
+  type: 'release.unarchive';
+}
+/**
+ * Permanently deletes an archived or published release. To remove an active
+ * release, use the archive action first.
+ * @beta
+ */
+interface DeleteReleaseAction extends ReleaseHandle {
+  type: 'release.delete';
+}
+/**
+ * Union of all release actions that can be dispatched alongside document
+ * actions through `applyDocumentActions`.
+ * @beta
+ */
+type ReleaseAction = CreateReleaseAction | EditReleaseAction | PublishReleaseAction | ScheduleReleaseAction | UnscheduleReleaseAction | ArchiveReleaseAction | UnarchiveReleaseAction | DeleteReleaseAction;
+/** @beta */
+declare function createRelease(handle: ReleaseHandle, metadata?: ReleaseDocument$1['metadata']): CreateReleaseAction;
+/** @beta */
+declare function editRelease(handle: ReleaseHandle, patch: PatchOperations): EditReleaseAction;
+/** @beta */
+declare function publishRelease(handle: ReleaseHandle): PublishReleaseAction;
+/** @beta */
+declare function scheduleRelease(handle: ReleaseHandle, publishAt: string): ScheduleReleaseAction;
+/** @beta */
+declare function unscheduleRelease(handle: ReleaseHandle): UnscheduleReleaseAction;
+/** @beta */
+declare function archiveRelease(handle: ReleaseHandle): ArchiveReleaseAction;
+/** @beta */
+declare function unarchiveRelease(handle: ReleaseHandle): UnarchiveReleaseAction;
+/** @beta */
+declare function deleteRelease(handle: ReleaseHandle): DeleteReleaseAction;
+/**
+ * Split the entire path string on dots "outside" of any brackets.
+ *
+ * For example:
+ * ```
+ * "friends[0].name"
+ * ```
+ *
+ * becomes:
+ *
+ * ```
+ * [...ParseSegment<"friends[0]">, ...ParseSegment<"name">]
+ * ```
+ *
+ * (We use a simple recursion that splits on the first dot.)
+ */
+type PathParts<TPath extends string> = TPath extends `${infer Head}.${infer Tail}` ? [Head, ...PathParts<Tail>] : TPath extends '' ? [] : [TPath];
+/**
+ * Given a type T and an array of "access keys" Parts, recursively index into T.
+ *
+ * If a part is a key, it looks up that property.
+ * If T is an array and the part is a number, it "indexes" into the element type.
+ */
+type DeepGet<TValue, TPath extends readonly (string | number)[]> = TPath extends [] ? TValue : TPath extends readonly [infer THead, ...infer TTail] ? DeepGet<TValue extends undefined | null ? undefined : THead extends keyof TValue ? TValue[THead] : THead extends number ? TValue extends readonly (infer TElement)[] ? TElement | undefined : undefined : undefined, // Key/index doesn't exist
+TTail extends readonly (string | number)[] ? TTail : []> : never;
+/**
+ * Given a document type TDocument and a JSON Match path string TPath,
+ * compute the type found at that path.
+ * @beta
+ */
+type JsonMatch<TDocument, TPath extends string> = DeepGet<TDocument, PathParts<TPath>>;
+/**
+ * Represents a set of document that will go into `applyMutations`. Before
+ * applying a mutation, it's expected that all relevant documents that the
+ * mutations affect are included, including those that do not exist yet.
+ * Documents that don't exist have a `null` value.
+ */
+type DocumentSet<TDocument extends SanityDocument$2 = SanityDocument$2> = { [TDocumentId in string]?: TDocument | null };
+type Grant = 'read' | 'update' | 'create' | 'history';
+/** @beta */
+interface PermissionDeniedReason {
+  type: 'precondition' | 'access';
+  message: string;
+  documentId?: string;
+}
+/** @beta */
+type DocumentPermissionsResult = {
+  allowed: false;
+  message: string;
+  reasons: PermissionDeniedReason[];
+} | {
+  allowed: true;
+  message?: undefined;
+  reasons?: undefined;
+};
+interface SharedListener {
+  events: Observable<ListenEvent<SanityDocument$1>>;
+  dispose: () => void;
+}
+interface DocumentStoreState {
+  documentStates: { [TDocumentId in string]?: DocumentState };
+  queued: QueuedTransaction[];
+  applied: AppliedTransaction[];
+  outgoing?: OutgoingTransaction;
+  grants?: Record<Grant, ExprNode>;
+  /**
+   * The current user's identity (their user ID).
+   */
+  identity?: string;
+  error?: unknown;
+  sharedListener: SharedListener;
+  fetchDocument: (documentId: string) => Observable<SanityDocument$3 | null>;
+  events: Subject<DocumentEvent>;
+}
+interface DocumentState {
+  id: string;
+  /**
+   * the "remote" local copy that matches the server. represents the last known
+   * server state. this gets updated every time we confirm remote patches
+   */
+  remote?: SanityDocument$3 | null;
+  /**
+   * the current ephemeral working copy that includes local optimistic changes
+   * that have not yet been confirmed by the server
+   */
+  local?: SanityDocument$3 | null;
+  /**
+   * the revision that our remote document is at
+   */
+  remoteRev?: string | null;
+  /**
+   * Array of subscription IDs. This document state will be deleted if there are
+   * no subscribers.
+   */
+  subscriptions: string[];
+  /**
+   * An object keyed by transaction ID of revisions sent out but that have not
+   * yet been verified yet. When an applied transaction is transitioned to an
+   * outgoing transaction, it also adds unverified revisions for each document
+   * that is part of that outgoing transaction. Transactions are submitted to
+   * the server with a locally generated transaction ID. This way we can observe
+   * when our transaction comes back through the shared listener. Each listener
+   * event that comes back contains a `previousRev`. If we see our own
+   * transaction with a different `previousRev` than expected, we can rebase our
+   * local transactions on top of this new remote.
+   */
+  unverifiedRevisions?: { [TTransactionId in string]?: UnverifiedDocumentRevision };
+}
+/**
+ * @beta
+ * Options for specifying a document and optionally a path within it.
+ */
+interface DocumentOptions<TPath extends string | undefined = undefined, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  path?: TPath;
+}
+/** @beta */
+declare function getDocumentState<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>): StateSource<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`> | undefined | null>;
+/** @beta */
+declare function getDocumentState<TPath extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>): StateSource<JsonMatch<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined>;
+/** @beta */
+declare function getDocumentState<TData>(instance: SanityInstance, options: DocumentOptions<string | undefined>): StateSource<TData | undefined | null>;
+/** @beta */
+declare function resolveDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, docHandle: DocumentHandle<TDocumentType, TDataset, TProjectId>): Promise<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`> | null>;
+/** @beta */
+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 = {
+  resource?: DocumentResource;
+  actions: DocumentAction[];
+};
+/** @beta */
+declare const getPermissionsState: BoundStoreAction<DocumentStoreState, [PermissionsStateOptions], StateSource<DocumentPermissionsResult>>;
+/** @beta */
+declare const resolvePermissions: BoundStoreAction<DocumentStoreState, [options: PermissionsStateOptions], Promise<DocumentPermissionsResult>>;
+/** @beta */
+declare const subscribeDocumentEvents: BoundStoreAction<DocumentStoreState, [options: {
+  resource?: DocumentResource;
+  eventHandler: (e: DocumentEvent) => void;
+}], () => void>;
+type ActionMap = {
+  create: 'sanity.action.document.version.create';
+  discard: 'sanity.action.document.version.discard';
+  unpublish: 'sanity.action.document.unpublish';
+  delete: 'sanity.action.document.delete';
+  edit: 'sanity.action.document.edit';
+  publish: 'sanity.action.document.publish';
+  releaseCreate: 'sanity.action.release.create';
+  releaseEdit: 'sanity.action.release.edit';
+  releasePublish: 'sanity.action.release.publish';
+  releaseSchedule: 'sanity.action.release.schedule';
+  releaseUnschedule: 'sanity.action.release.unschedule';
+  releaseArchive: 'sanity.action.release.archive';
+  releaseUnarchive: 'sanity.action.release.unarchive';
+  releaseDelete: 'sanity.action.release.delete';
+};
+type OptimisticLock = {
+  ifDraftRevisionId?: string;
+  ifPublishedRevisionId?: string;
+};
+interface ReleaseMetadataPayload {
+  title?: string;
+  description?: string;
+  intendedPublishAt?: string;
+  releaseType?: 'asap' | 'scheduled' | 'undecided';
+  cardinality?: 'one' | 'many';
+}
+type HttpAction = {
+  actionType: ActionMap['create'];
+  publishedId: string;
+  attributes: SanityDocumentLike;
+} | {
+  actionType: ActionMap['discard'];
+  versionId: string;
+  purge?: boolean;
+} | {
+  actionType: ActionMap['unpublish'];
+  draftId: string;
+  publishedId: string;
+} | {
+  actionType: ActionMap['delete'];
+  publishedId: string;
+  includeDrafts?: string[];
+} | {
+  actionType: ActionMap['edit'];
+  draftId: string;
+  publishedId: string;
+  patch: PatchOperations;
+} | ({
+  actionType: ActionMap['publish'];
+  draftId: string;
+  publishedId: string;
+} & OptimisticLock) | {
+  actionType: ActionMap['releaseCreate'];
+  releaseId: string;
+  metadata?: ReleaseMetadataPayload;
+} | {
+  actionType: ActionMap['releaseEdit'];
+  releaseId: string;
+  patch: PatchOperations;
+} | {
+  actionType: ActionMap['releasePublish'];
+  releaseId: string;
+} | {
+  actionType: ActionMap['releaseSchedule'];
+  releaseId: string;
+  publishAt: string;
+} | {
+  actionType: ActionMap['releaseUnschedule'];
+  releaseId: string;
+} | {
+  actionType: ActionMap['releaseArchive'];
+  releaseId: string;
+} | {
+  actionType: ActionMap['releaseUnarchive'];
+  releaseId: string;
+} | {
+  actionType: ActionMap['releaseDelete'];
+  releaseId: string;
+};
+/**
+ * Represents a transaction that is queued to be applied but has not yet been
+ * applied. A transaction will remain in a queued state until all required
+ * documents for the transactions are available locally.
+ */
+interface QueuedTransaction {
+  /**
+   * the ID of this transaction. this is generated client-side.
+   */
+  transactionId: string;
+  /**
+   * the high-level actions associated with this transaction. note that these
+   * actions don't mention draft IDs and is meant to abstract away the draft
+   * model from users.
+   */
+  actions: Action[];
+  /**
+   * An optional flag set to disable this transaction from being batched with
+   * other transactions.
+   */
+  disableBatching?: boolean;
+}
+/**
+ * Represents a transaction that has been applied locally but has not been
+ * committed/transitioned-to-outgoing. These transactions are visible to the
+ * user but may be rebased upon a new working document set. Applied transactions
+ * also contain the resulting `outgoingActions` that will be submitted to
+ * Content Lake. These `outgoingActions` depend on the state of the working
+ * documents so they are recomputed on rebase and are only relevant to applied
+ * actions (we cannot compute `outgoingActions` for queued transactions because
+ * we haven't resolved the set of documents the actions are dependent on yet).
+ *
+ * In order to support better conflict resolution, the original `previous` set
+ * is saved as the `base` set.
+ */
+interface AppliedTransaction extends QueuedTransaction {
+  /**
+   * the resulting set of documents after the actions have been applied
+   */
+  working: DocumentSet;
+  /**
+   * the previous set of documents before the action was applied
+   */
+  previous: DocumentSet;
+  /**
+   * the original `previous` document set captured when this action was
+   * originally applied. this is used as a reference point to do a 3-way merge
+   * if this applied transaction ever needs to be reapplied on a different
+   * set of documents.
+   */
+  base: DocumentSet;
+  /**
+   * the `_rev`s from `previous` document set
+   */
+  previousRevs: { [TDocumentId in string]?: string };
+  /**
+   * a timestamp for when this transaction was applied locally
+   */
+  timestamp: string;
+  /**
+   * the resulting HTTP actions derived from the state of the `working` document
+   * set. these are sent to Content Lake as-is when this transaction is batched
+   * and transitioned into an outgoing transaction.
+   */
+  outgoingActions: HttpAction[];
+  /**
+   * similar to `outgoingActions` but comprised of mutations instead of actions.
+   * Useful for debugging, and is also used by liveEdit documents to send mutations,
+   * since they can't use the Actions API which is pretty dependent on the draft model.
+   */
+  outgoingMutations: Mutation[];
+}
+/**
+ * Represents a set of applied transactions batched into a single outgoing
+ * transaction. An outgoing transaction is the result of batching many applied
+ * actions. An outgoing transaction may be reverted locally if the server
+ * does not accept it.
+ */
+interface OutgoingTransaction extends AppliedTransaction {
+  disableBatching: boolean;
+  batchedTransactionIds: string[];
+}
+interface UnverifiedDocumentRevision {
+  transactionId: string;
+  documentId: string;
+  previousRev: string | undefined;
+  timestamp: string;
+}
+/** @beta Response body from submitting an outgoing transaction (actions or mutations API). */
+type DocumentTransactionSubmissionResult = Awaited<ReturnType<SanityClient['action']>> | MultipleMutationResult;
+/** @beta */
+type DocumentEvent = ActionErrorEvent | TransactionRevertedEvent | TransactionAcceptedEvent | DocumentRebaseErrorEvent | DocumentEditedEvent | DocumentCreatedEvent | DocumentDeletedEvent | DocumentPublishedEvent | DocumentUnpublishedEvent | DocumentDiscardedEvent;
+/**
+ * @beta
+ * Event emitted when a precondition to applying an action fails.
+ * (For example: when trying to edit a document that no longer exists.)
+ */
+interface ActionErrorEvent {
+  type: 'error';
+  documentId: string;
+  transactionId: string;
+  message: string;
+  error: unknown;
+}
+/**
+ * @beta
+ * Event emitted when a transaction is accepted.
+ */
+interface TransactionAcceptedEvent {
+  type: 'accepted';
+  outgoing: OutgoingTransaction;
+  result: DocumentTransactionSubmissionResult;
+}
+/**
+ * @beta
+ * Event emitted when a transaction is reverted.
+ */
+interface TransactionRevertedEvent {
+  type: 'reverted';
+  message: string;
+  error: unknown;
+  outgoing: OutgoingTransaction;
+}
+/**
+ * @beta
+ * Event emitted when an attempt to apply local changes to a modified remote document fails.
+ */
+interface DocumentRebaseErrorEvent {
+  type: 'rebase-error';
+  documentId: string;
+  transactionId: string;
+  message: string;
+  error: unknown;
+}
+/**
+ * @beta
+ * Event emitted when a document is edited.
+ */
+interface DocumentEditedEvent {
+  type: 'edited';
+  documentId: string;
+  outgoing: OutgoingTransaction;
+}
+/**
+ * @beta
+ * Event emitted when a document is created.
+ */
+interface DocumentCreatedEvent {
+  type: 'created';
+  documentId: string;
+  outgoing: OutgoingTransaction;
+}
+/**
+ * @beta
+ * Event emitted when a document is deleted.
+ */
+interface DocumentDeletedEvent {
+  type: 'deleted';
+  documentId: string;
+  outgoing: OutgoingTransaction;
+}
+/**
+ * @beta
+ * Event emitted when a document is published.
+ */
+interface DocumentPublishedEvent {
+  type: 'published';
+  documentId: string;
+  outgoing: OutgoingTransaction;
+}
+/**
+ * @beta
+ * Event emitted when a document is unpublished.
+ */
+interface DocumentUnpublishedEvent {
+  type: 'unpublished';
+  documentId: string;
+  outgoing: OutgoingTransaction;
+}
+/**
+ * @beta
+ * Event emitted when a document version is discarded.
+ */
+interface DocumentDiscardedEvent {
+  type: 'discarded';
+  documentId: string;
+  outgoing: OutgoingTransaction;
+}
+/** @beta */
+interface ActionsResult<TDocument extends SanityDocument$3 = SanityDocument$3> {
+  transactionId: string;
+  documents: DocumentSet<TDocument>;
+  previous: DocumentSet<TDocument>;
+  previousRevs: {
+    [documentId: string]: string | undefined;
+  };
+  appeared: string[];
+  updated: string[];
+  disappeared: string[];
+  submitted: () => Promise<DocumentTransactionSubmissionResult>;
+}
+/** @beta */
+interface ApplyDocumentActionsOptions {
+  /**
+   * List of actions to apply. Accepts both document actions and release
+   * lifecycle actions because they share the same transaction pipeline.
+   */
+  actions: Action[];
+  /**
+   * The resource to which the documents being acted on belong.
+   */
+  resource?: DocumentResource;
+  /**
+   * Optionally provide an ID to be used as this transaction ID
+   */
+  transactionId?: string;
+  /**
+   * Set this to true to prevent this action from being batched with others.
+   */
+  disableBatching?: boolean;
+}
+/** @beta */
+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, options: ApplyDocumentActionsOptions): Promise<ActionsResult>;
+/**
+ * Returns the full release document ID for the given release name.
+ * e.g. `getReleaseDocumentId('my-release') === '_.releases.my-release'`
+ * @beta
+ */
+declare function getReleaseDocumentId(releaseId: string): string;
+/**
+ * @public
+ */
+interface FavoriteStatusResponse {
+  isFavorited: boolean;
+}
+/**
+ * @public
+ */
+interface FavoriteDocumentContext extends DocumentHandle {
+  resourceId: string;
+  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource$1['type'];
+  schemaName?: string;
+}
+/**
+ * Gets a StateSource for the favorite status of a document.
+ * @param instance - The Sanity instance.
+ * @param context - The document context including ID, type, and resource information.
+ * @returns A StateSource emitting `{ isFavorited: boolean }`.
+ * @public
+ */
+declare const getFavoritesState: BoundStoreAction<import("../_exports").FetcherStoreState<[FavoriteDocumentContext], FavoriteStatusResponse>, [FavoriteDocumentContext], import("../_exports").StateSource<FavoriteStatusResponse | undefined>>;
+/**
+ * Resolves the favorite status for a document.
+ * @param instance - The Sanity instance.
+ * @param context - The document context including ID, type, and resource information.
+ * @returns A Promise resolving to `{ isFavorited: boolean }`.
+ * @public
+ */
+declare const resolveFavoritesState: BoundStoreAction<import("../_exports").FetcherStoreState<[FavoriteDocumentContext], FavoriteStatusResponse>, [FavoriteDocumentContext], Promise<FavoriteStatusResponse>>;
+/** @public */
+interface OrganizationMember {
+  sanityUserId: string;
+  isCurrentUser: boolean;
+  user: {
+    id: string;
+    displayName: string;
+    familyName: string;
+    givenName: string;
+    middleName: string | null;
+    imageUrl: string | null;
+    email: string;
+    loginProvider: string;
+  };
+  roles: Array<{
+    name: string;
+    title: string;
+    description?: string;
+  }>;
+}
+/**
+ * The base fields returned from `/organizations/<id>` for every organization.
+ * @public
+ */
+interface OrganizationBase {
+  id: string;
+  name: string;
+  slug: string | null;
+  createdAt: string;
+  createdByUserId: string;
+  updatedAt: string;
+  deletedAt: string | null;
+  dashboardStatus: 'enabled' | 'disabled';
+  aiFeaturesStatus: 'enabled' | 'disabled';
+  mediaLibraryStatus: 'enabled' | 'disabled';
+  requestAccessStatus: 'allowed' | 'disabled';
+  telemetryConsentStatus: 'allowed' | 'msa_denied' | 'customer_denied';
+  oauthAppsStatus: 'allowed' | 'blocked';
+  defaultRoleName: string;
+  domains: string[] | null;
+}
+/** @public */
+interface OrganizationOptions<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false> {
+  includeMembers?: IncludeMembers;
+  includeFeatures?: IncludeFeatures;
+  organizationId: string;
+}
+/**
+ * An `Organization` with `members` and/or `features` conditionally included
+ * based on the query options used to fetch it.
+ * @public
+ */
+type Organization<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false> = OrganizationBase & (boolean extends IncludeMembers ? {
+  members?: OrganizationMember[];
+} : IncludeMembers extends true ? {
+  members: OrganizationMember[];
+} : unknown) & (boolean extends IncludeFeatures ? {
+  features?: string[];
+} : IncludeFeatures extends true ? {
+  features: string[];
+} : unknown);
+/**
+ * Public signature for the organization state source. The conditional generics
+ * cannot flow through `BoundStoreAction`, so we declare the signature here
+ * and assign the (already-correct) runtime function to it.
+ */
+type GetOrganizationState = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(instance: SanityInstance, options: OrganizationOptions<IncludeMembers, IncludeFeatures>) => StateSource<Organization<IncludeMembers, IncludeFeatures> | undefined>;
+type ResolveOrganization = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(instance: SanityInstance, options: OrganizationOptions<IncludeMembers, IncludeFeatures>) => Promise<Organization<IncludeMembers, IncludeFeatures>>;
+/** @public */
+declare const getOrganizationState: GetOrganizationState;
+/** @public */
+declare const resolveOrganization: ResolveOrganization;
+/**
+ * The list shape returned from `/organizations`, with `members` and/or
+ * `features` conditionally included based on the query options used.
+ * @public
+ */
+type Organizations<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false> = (Pick<OrganizationBase, 'id' | 'name' | 'slug' | 'createdAt' | 'updatedAt' | 'defaultRoleName' | 'dashboardStatus' | 'aiFeaturesStatus'> & (boolean extends IncludeMembers ? {
+  members?: OrganizationMember[];
+} : IncludeMembers extends true ? {
+  members: OrganizationMember[];
+} : unknown) & (boolean extends IncludeFeatures ? {
+  features?: string[];
+} : IncludeFeatures extends true ? {
+  features: string[];
+} : unknown))[];
+/** @public */
+interface OrganizationsOptions<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false> extends Omit<OrganizationOptions<IncludeMembers, IncludeFeatures>, 'organizationId'> {
+  /**
+   * When `true`, includes organisations the user has access to via
+   * project-level grants, not just direct organisation memberships.
+   */
+  includeImplicitMemberships?: boolean;
+}
+/**
+ * Public signature for the organization state source. The conditional generics
+ * cannot flow through `BoundStoreAction`, so we declare the signature here
+ * and assign the (already-correct) runtime function to it.
+ */
+type GetOrganizationsState = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(instance: SanityInstance, options?: OrganizationsOptions<IncludeMembers, IncludeFeatures>) => StateSource<Organizations<IncludeMembers, IncludeFeatures> | undefined>;
+type ResolveOrganizations = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(instance: SanityInstance, options?: OrganizationsOptions<IncludeMembers, IncludeFeatures>) => Promise<Organizations<IncludeMembers, IncludeFeatures>>;
+/** @public */
+declare const getOrganizationsState: GetOrganizationsState;
+/** @public */
+declare const resolveOrganizations: ResolveOrganizations;
+/** @public */
+interface PresenceLocation {
+  type: 'document';
+  documentId: string;
+  path: string[];
+  lastActiveAt: string;
+}
+/** @public */
+interface UserPresence {
+  user: SanityUser;
+  locations: PresenceLocation[];
+  sessionId: string;
+}
+/** @public */
+type TransportEvent = RollCallEvent | StateEvent | DisconnectEvent;
+/** @public */
+interface RollCallEvent {
+  type: 'rollCall';
+  userId: string;
+  sessionId: string;
+}
+/** @public */
+interface StateEvent {
+  type: 'state';
+  userId: string;
+  sessionId: string;
+  timestamp: string;
+  locations: PresenceLocation[];
+}
+/** @public */
+interface DisconnectEvent {
+  type: 'disconnect';
+  userId: string;
+  sessionId: string;
+  timestamp: string;
+}
+/** @beta */
+declare function getPresence(instance: SanityInstance, params?: {
+  resource?: DocumentResource;
+}): StateSource<UserPresence[]>;
+/**
+ * @beta
+ * @deprecated This type is deprecated and will be removed in a future release.
+ */
+type GetPreviewStateOptions = DocumentHandle;
+/**
+ * @beta
+ * @deprecated This function is deprecated and will be removed in a future release.
+ */
+declare function getPreviewState<TResult extends object>(instance: SanityInstance, options: GetPreviewStateOptions): StateSource<ValuePending<TResult>>;
+/**
+ * @beta
+ * @deprecated This function is deprecated and will be removed in a future release.
+ */
+declare function getPreviewState(instance: SanityInstance, options: GetPreviewStateOptions): StateSource<ValuePending<PreviewValue>>;
+/**
+ * @beta
+ * @deprecated This type is deprecated and will be removed in a future release.
+ */
+type ResolvePreviewOptions = DocumentHandle;
+/**
+ * @beta
+ * @deprecated This function is deprecated and will be removed in a future release.
+ */
+declare function resolvePreview(instance: SanityInstance, options: ResolvePreviewOptions): Promise<ValuePending<PreviewValue>>;
+/** @public */
+interface ProjectMemberRole {
+  name: string;
+  title: string;
+  description: string;
+}
+/** @public */
+interface ProjectMember {
+  id: string;
+  createdAt: string;
+  updatedAt: string;
+  isCurrentUser: boolean;
+  isRobot: boolean;
+  roles: ProjectMemberRole[];
+}
+/** @public */
+interface ProjectMetadata {
+  color?: string;
+  externalStudioHost?: string;
+  initialTemplate?: string;
+  cliInitializedAt?: string;
+  integration: 'manage' | 'cli';
+}
+/**
+ * The base fields returned from `/projects` for every project.
+ * @public
+ */
+interface ProjectBase {
+  id: string;
+  displayName: string;
+  studioHost: string | null;
+  organizationId: string;
+  metadata: ProjectMetadata;
+  isBlocked: boolean;
+  isDisabled: boolean;
+  isDisabledByUser: boolean;
+  activityFeedEnabled: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+/**
+ * A `Project` with `members` and/or `features` conditionally included
+ * based on the query options used to fetch it.
+ * @public
+ */
+type Project<IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true> = ProjectBase & (boolean extends IncludeMembers ? {
+  members?: ProjectMember[];
+} : IncludeMembers extends true ? {
+  members: ProjectMember[];
+} : unknown) & (boolean extends IncludeFeatures ? {
+  features?: string[];
+} : IncludeFeatures extends true ? {
+  features: string[];
+} : unknown);
+/** @public */
+interface ProjectOptions<IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true> extends ProjectHandle {
+  includeMembers?: IncludeMembers;
+  includeFeatures?: IncludeFeatures;
+}
+/**
+ * Public signature for the project state source. The conditional generics
+ * cannot flow through `BoundStoreAction`, so we declare the signature here
+ * and assign the (already-correct) runtime function to it.
+ */
+type GetProjectState = <IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true>(instance: SanityInstance, options?: ProjectOptions<IncludeMembers, IncludeFeatures>) => StateSource<Project<IncludeMembers, IncludeFeatures> | undefined>;
+type ResolveProject = <IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true>(instance: SanityInstance, options?: ProjectOptions<IncludeMembers, IncludeFeatures>) => Promise<Project<IncludeMembers, IncludeFeatures>>;
+/** @public */
+declare const getProjectState: GetProjectState;
+/** @public */
+declare const resolveProject: ResolveProject;
+interface ProjectionOptions<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  projection: TProjection;
+}
+/**
+ * @beta
+ */
+declare function getProjectionState<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): StateSource<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>> | undefined>;
+/**
+ * @beta
+ */
+declare function getProjectionState<TData extends object>(instance: SanityInstance, options: ProjectionOptions): StateSource<ProjectionValuePending<TData> | undefined>;
+/**
+ * @beta
+ */
+declare function getProjectionState(instance: SanityInstance, options: ProjectionOptions): StateSource<ProjectionValuePending<Record<string, unknown>> | undefined>;
+/** @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 */
+declare function resolveProjection<TData extends object>(instance: SanityInstance, options: ProjectionOptions): Promise<ProjectionValuePending<TData>>;
+/** @public */
+interface ProjectsOptions<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = true> {
+  organizationId?: string;
+  includeMembers?: IncludeMembers;
+  includeFeatures?: IncludeFeatures;
+  onlyExplicitMembership?: boolean;
+}
+/**
+ * Public signature for the projects state source. The conditional generics
+ * cannot flow through `BoundStoreAction`, so we declare the signature here
+ * and assign the (already-correct) runtime function to it.
+ */
+type GetProjectsState = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = true>(instance: SanityInstance, options?: ProjectsOptions<IncludeMembers, IncludeFeatures>) => StateSource<Project<IncludeMembers, IncludeFeatures>[] | undefined>;
+type ResolveProjects = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = true>(instance: SanityInstance, options?: ProjectsOptions<IncludeMembers, IncludeFeatures>) => Promise<Project<IncludeMembers, IncludeFeatures>[]>;
+/** @public */
+declare const getProjectsState: GetProjectsState;
+/** @public */
+declare const resolveProjects: ResolveProjects;
+/**
+ * Lifecycle states a release document can be in. Mirrors the server's
+ * `ReleaseState`.
+ * @beta
+ */
+type ReleaseState = 'active' | 'archiving' | 'unarchiving' | 'archived' | 'published' | 'publishing' | 'scheduled' | 'scheduling';
+interface ReleasesStoreState {
+  activeReleases?: ReleaseDocument$1[];
+  allReleases?: ReleaseDocument$1[];
+  error?: unknown;
+}
+/**
+ * Get the active releases from the store.
+ * @internal
+ */
+declare const getActiveReleasesState: (instance: SanityInstance, options?: {
+  resource?: DocumentResource;
+}) => StateSource<ReleaseDocument$1[] | undefined>;
+/**
+ * Get every release in the store, including archived and published.
+ * @internal
+ */
+declare const getAllReleasesState: (instance: SanityInstance, options?: {
+  resource?: DocumentResource;
+}) => StateSource<ReleaseDocument$1[] | undefined>;
+declare const _getPerspectiveStateSelector: StoreAction<ReleasesStoreState, [_?: (PerspectiveHandle & {
+  projectId?: string;
+  dataset?: string;
+  resource?: DocumentResource;
+}) | undefined], import("../_exports").StateSource<string[] | "previewDrafts" | "published" | "drafts" | "raw" | undefined>, unknown>;
+type OmitFirst<T extends unknown[]> = T extends [unknown, ...infer R] ? R : never;
+type SelectorParams = OmitFirst<Parameters<typeof _getPerspectiveStateSelector>>;
+type BoundGetPerspectiveState = BoundStoreAction<ReleasesStoreState, SelectorParams, ReturnType<typeof _getPerspectiveStateSelector>>;
+/**
+ * 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.
+ *
+ * @param instance - The Sanity instance to get the perspective for
+ * @param options - The options for the perspective -- usually a release name
+ *
+ * @returns A subscribable perspective value, usually a list of applicable release names,
+ * or a single release name / default perspective (such as 'drafts').
+ *
+ * @public
+ */
+declare const getPerspectiveState: BoundGetPerspectiveState;
+/**
+ * Returns the state source for users associated with a specific resource.
+ *
+ * This function returns a state source that represents the current list of users for a given
+ * resource. Subscribing to the state source will instruct the SDK to fetch the users (if not
+ * already fetched) and will load more from this state source as well. When the last subscriber is
+ * removed, the users state is automatically cleaned up from the store after a delay.
+ *
+ * Note: This functionality is for advanced users who want to build their own framework
+ * integrations. Our SDK also provides a React integration for convenient usage.
+ *
+ * @beta
+ */
+declare const getUsersState: BoundStoreAction<UsersStoreState, [options?: GetUsersOptions | undefined], import("../_exports").StateSource<{
+  data: SanityUser[];
+  totalCount: number;
+  hasMore: boolean;
+} | undefined>>;
+/**
+ * Resolves the users for a specific resource without registering a lasting subscriber.
+ *
+ * This function fetches the users for a given resource and returns a promise that resolves with
+ * the users result. Unlike `getUsersState`, which registers subscribers to keep the data live and
+ * performs automatic cleanup, `resolveUsers` does not track subscribers. This makes it ideal for
+ * use with React Suspense, where the returned promise is thrown to delay rendering until the users
+ * result becomes available. Once the promise resolves, it is expected that a real subscriber will
+ * be added via `getUsersState` to manage ongoing updates.
+ *
+ * Additionally, an optional AbortSignal can be provided to cancel the request and immediately
+ * clear the associated state if there are no active subscribers.
+ *
+ * @beta
+ */
+declare const resolveUsers: BoundStoreAction<UsersStoreState, [ResolveUsersOptions], Promise<{
+  data: SanityUser[];
+  totalCount: number;
+  hasMore: boolean;
+}>>;
+/**
+ * Loads more users for a specific resource.
+ *
+ * This function triggers a request to fetch the next page of users for a given resource. It
+ * requires that users have already been loaded for the resource (via `resolveUsers` or
+ * `getUsersState`), and that there are more users available to load (as indicated by the `hasMore`
+ * property).
+ *
+ * The function returns a promise that resolves when the next page of users has been loaded.
+ *
+ * @beta
+ */
+declare const loadMoreUsers: BoundStoreAction<UsersStoreState, [options?: GetUsersOptions | undefined], Promise<{
+  data: SanityUser[];
+  totalCount: number;
+  hasMore: boolean;
+}>>;
+/**
+ * @beta
+ */
+declare const getUserState: BoundStoreAction<UsersStoreState, [GetUserOptions], Observable<SanityUser | undefined>>;
+/**
+ * @beta
+ */
+declare const resolveUser: BoundStoreAction<UsersStoreState, [ResolveUserOptions], Promise<SanityUser>>;
+interface StoreEntry<TParams extends unknown[], TData> {
+  params: TParams;
+  instance: SanityInstance;
+  key: string;
+  data?: TData;
+  error?: unknown;
+  subscriptions: string[];
+  lastFetchInitiatedAt?: string;
+}
+/**
+ * Internal helper type
+ * @public
+ */
+interface FetcherStoreState<TParams extends unknown[], TData> {
+  stateByParams: { [TSerializedKey in string]?: StoreEntry<TParams, TData> };
+  error?: unknown;
+}
+/**
+ * Internal helper type
+ * @public
+ */
+interface FetcherStore<TParams extends unknown[], TData> {
+  getState: BoundStoreAction<FetcherStoreState<TParams, TData>, TParams, StateSource<TData | undefined>>;
+  resolveState: BoundStoreAction<FetcherStoreState<TParams, TData>, TParams, Promise<TData>>;
+}
+/**
+ * Filter criteria for intent matching. Can be combined to create more specific intents.
+ *
+ * @example
+ * ```typescript
+ * // matches only geopoints in the travel-project project, production dataset
+ * const filter: IntentFilter = {
+ *   projectId: 'travel-project',
+ *   dataset: 'production',
+ *   types: ['geopoint']
+ * }
+ *
+ * // matches all documents in the travel-project project
+ * const filter: IntentFilter = {
+ *   projectId: 'travel-project',
+ *   types: ['*']
+ * }
+ *
+ * // matches geopoints in the travel-project production dataset and map pins in all projects in the org
+ * const filters: IntentFilter[] = [
+ *  {
+ *    projectId: 'travel-project',
+ *    dataset: 'production',
+ *    types: ['geopoint']
+ *  },
+ *  {
+ *    types: ['map-pin']
+ *  }
+ * ]
+ * ```
+ * @public
+ */
+interface IntentFilter {
+  /**
+   * Project ID to match against
+   * @remarks When specified, the intent will only match for the specified project.
+   */
+  projectId?: string;
+  /**
+   * Dataset to match against
+   * @remarks When specified, the intent will only match for the specified dataset. Requires projectId to be specified.
+   */
+  dataset?: string;
+  /**
+   * Document types that this intent can handle
+   * @remarks This is required for all filters. Use ['*'] to match all document types.
+   */
+  types: string[];
+}
+/**
+ * Intent definition structure for registering user intents
+ * @public
+ */
+interface Intent {
+  /**
+   * Unique identifier for this intent
+   * @remarks Should be unique across all registered intents in an org for proper matching
+   */
+  id: string;
+  /**
+   * The action that this intent performs
+   * @remarks Examples: "view", "edit", "create", "delete"
+   */
+  action: 'view' | 'edit' | 'create' | 'delete';
+  /**
+   * Human-readable title for this intent
+   * @remarks Used for display purposes in UI or logs
+   */
+  title: string;
+  /**
+   * Detailed description of what this intent does
+   * @remarks Helps users understand the purpose and behavior of the intent
+   */
+  description?: string;
+  /**
+   * Array of filter criteria for intent matching
+   * @remarks At least one filter is required. Use `{types: ['*']}` to match everything
+   */
+  filters: IntentFilter[];
+}
+/**
+ * Creates a properly typed intent definition for registration with the backend.
+ *
+ * This utility function provides TypeScript support and validation for intent declarations.
+ * It is also used in the CLI if intents are declared as bare objects in an intents file.
+ *
+ * @param intent - The intent definition object
+ * @returns The same intent object with proper typing
+ *
+ * @example
+ * ```typescript
+ * // Specific filter for a document type
+ * const viewGeopointInMapApp = defineIntent({
+ *   id: 'viewGeopointInMapApp',
+ *   action: 'view',
+ *   title: 'View a geopoint in the map app',
+ *   description: 'This lets you view a geopoint in the map app',
+ *   filters: [
+ *     {
+ *       projectId: 'travel-project',
+ *       dataset: 'production',
+ *       types: ['geopoint']
+ *     }
+ *   ]
+ * })
+ *
+ * export default viewGeopointInMapApp
+ * ```
+ *
+ * If your intent is asynchronous, resolve the promise before defining / returning the intent
+ * ```typescript
+ * async function createAsyncIntent() {
+ *   const currentProject = await asyncProjectFunction()
+ *   const currentDataset = await asyncDatasetFunction()
+ *
+ *   return defineIntent({
+ *     id: 'dynamicIntent',
+ *     action: 'view',
+ *     title: 'Dynamic Intent',
+ *     description: 'Intent with dynamically resolved values',
+ *     filters: [
+ *       {
+ *         projectId: currentProject,  // Resolved value
+ *         dataset: currentDataset,    // Resolved value
+ *         types: ['document']
+ *       }
+ *     ]
+ *   })
+ * }
+ *
+ * const intent = await createAsyncIntent()
+ * export default intent
+ * ```
+ *
+ * @public
+ */
+declare function defineIntent(intent: Intent): Intent;
+/**
+ * @public
+ * Extracts the project ID from a CorsOriginError message.
+ * @param error - The error to extract the project ID from.
+ * @returns The project ID or null if the error is not a CorsOriginError.
+ */
+declare function getCorsErrorProjectId(error: Error): string | null;
+/**
+ * Returns true when the given error looks like a dynamic-import or
+ * code-split chunk-loading failure.
+ *
+ * These errors typically surface when a user has a tab open against a
+ * previously-deployed version of an app and the JavaScript or CSS chunk
+ * filenames have since changed: a fresh deployment removes the hashed assets
+ * the open tab still references. Detecting them lets the SDK trigger an
+ * automatic reload so the user gets the new build without manual intervention.
+ *
+ * Recognized shapes (webpack ChunkLoadError, Vite "Failed to fetch
+ * dynamically imported module", Firefox "error loading dynamically imported
+ * module", Safari "Importing a module script failed", and Vite "Unable to
+ * preload CSS").
+ *
+ * @param error - The value to inspect. Anything that is not an Error
+ *   instance returns false.
+ * @returns True if the error matches a known import/chunk-load failure.
+ *
+ * @public
+ */
+declare function isImportError(error: unknown): boolean;
+/**
+ * This version is provided by pkg-utils at build time
+ * @internal
+ */
+declare const CORE_SDK_VERSION: {};
+/**
+ * @public
+ */
+type SanityProject = SanityProject$1;
+export { type Action, 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 ArchiveReleaseAction, type AuthConfig, type AuthProvider, type AuthState, AuthStateType, type AuthStoreState, CORE_SDK_VERSION, type CanvasResource, type CanvasSource, type ClientOptions, type ClientStoreState as ClientState, type ComlinkControllerState, type ComlinkNodeState, type CreateDocumentAction, type CreateReleaseAction, type CurrentUser, type DatasetHandle, type DatasetResource, type DatasetSource, type DeleteDocumentAction, type DeleteReleaseAction, 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 DocumentResource, type DocumentSource, type DocumentTransactionSubmissionResult, type DocumentTypeHandle, type DocumentUnpublishedEvent, type EditDocumentAction, type EditReleaseAction, type ErrorAuthState, type FavoriteStatusResponse, type FetcherStore, type FetcherStoreState, type FrameMessage, type GetPreviewStateOptions, type GetUserOptions, type GetUsersOptions, type InstanceContext, type Intent, type IntentFilter, type JsonMatch, type LogContext, type LogLevel, type LogNamespace, type LoggedInAuthState, type LoggedOutAuthState, type Logger, type LoggerConfig, type LoggingInAuthState, type MediaLibraryResource, type MediaLibrarySource, type Membership, type NewTokenResponseMessage, type NodeState, type OrgVerificationResult, type Organization, type OrganizationBase, type OrganizationMember, type OrganizationOptions, type Organizations, type OrganizationsOptions, PREVIEW_PROJECTION, type PermissionDeniedReason, type PerspectiveHandle, type PresenceLocation, type PreviewMedia, type PreviewQueryResult, type PreviewStoreState, type PreviewValue, type Project, type ProjectBase, type ProjectHandle, type ProjectMember, type ProjectMemberRole, type ProjectMetadata, type ProjectOptions, type ProjectionValuePending, type ProjectsOptions, type PublishDocumentAction, type PublishReleaseAction, type QueryOptions, type ReleaseAction, type ReleaseDocument, type ReleaseHandle, type ReleasePerspective, type ReleaseState, type RequestNewTokenMessage, type ResolvePreviewOptions, type ResolveUserOptions, type ResolveUsersOptions, type Role, type RollCallEvent, type SanityConfig, type SanityDocument, type SanityInstance, SanityProject, type SanityUser, type SanityUserResponse, type ScheduleReleaseAction, type Selector, type StateEvent, type StateSource, type StudioConfig, type TokenSource, type TransactionAcceptedEvent, type TransactionRevertedEvent, type TransportEvent, type UnarchiveReleaseAction, type UnpublishDocumentAction, type UnscheduleReleaseAction, type UserPresence, type UserProfile, type UsersGroupState, type UsersStoreState, type ValidProjection, type ValuePending, type WindowMessage, agentGenerate, agentPatch, agentPrompt, agentTransform, agentTranslate, applyDocumentActions, archiveRelease, configureLogging, createDatasetHandle, createDocument, createDocumentHandle, createDocumentTypeHandle, createGroqSearchFilter, createProjectHandle, createRelease, createSanityInstance, defineIntent, deleteDocument, deleteRelease, destroyController, discardDocument, editDocument, editRelease, getActiveReleasesState, getAllReleasesState, getAuthState, getClient, getClientErrorApiBody, getClientErrorApiDescription, getClientErrorApiType, getClientState, getCorsErrorProjectId, getCurrentUserState, getDashboardOrganizationId, getDatasetsState, getDocumentState, getDocumentSyncStatus, getFavoritesState, getIndexForKey, getIsInDashboardState, getLoginUrlState, getNodeState, getOrCreateChannel, getOrCreateController, getOrCreateNode, getOrganizationState, getOrganizationsState, getPathDepth, getPermissionsState, getPerspectiveState, getPresence, getPreviewState, getProjectState, getProjectionState, getProjectsState, getQueryKey, getQueryState, getReleaseDocumentId, getTokenState, getUserState, getUsersKey, getUsersState, handleAuthCallback, isCanvasResource, isCanvasSource, isDatasetResource, isDatasetSource, isImportError, isMediaLibraryResource, isMediaLibrarySource, isProjectUserNotFoundClientError, isStudioConfig, joinPaths, jsonMatch, loadMoreUsers, logout, observeOrganizationVerificationState, parseQueryKey, parseUsersKey, publishDocument, publishRelease, releaseChannel, releaseNode, resolveDatasets, resolveDocument, resolveFavoritesState, resolveOrganization, resolveOrganizations, resolvePermissions, resolvePreview, resolveProject, resolveProjection, resolveProjects, resolveQuery, resolveUser, resolveUsers, scheduleRelease, setAuthToken, slicePath, stringifyPath, subscribeDocumentEvents, transformProjectionToPreview, unarchiveRelease, unpublishDocument, unscheduleRelease };
+//# sourceMappingURL=index.d.ts.map