@sanity/sdk 2.8.0 → 2.10.0

package/dist/_chunks-dts/utils.d.ts

@@ -0,0 +1,2450 @@
+import * as _sanity_client20 from "@sanity/client";
+import { ClientConfig, ClientError, ClientPerspective, ListenEvent, MultipleMutationResult, ResponseQueryOptions, SanityClient, SanityDocument, SanityProject, StackablePerspective } from "@sanity/client";
+import { CurrentUser, CurrentUser as CurrentUser$1, Mutation, PatchOperations, Role, SanityDocument as SanityDocument$1, SanityDocument as SanityDocument$3, SanityDocumentLike } from "@sanity/types";
+import { Observable, Subject } from "rxjs";
+import * as _sanity_comlink3 from "@sanity/comlink";
+import { ChannelInput, ChannelInstance, Controller, Message, Node, NodeInput, Status } from "@sanity/comlink";
+import { PatchMutation } from "@sanity/mutate/_unstable_store";
+import { SanityDocument as SanityDocument$2, SanityProjectionResult, SanityQueryResult } from "groq";
+import { ExprNode } from "groq-js";
+import { CanvasResource, MediaResource, StudioResource } from "@sanity/message-protocol";
+import { getIndexForKey, getPathDepth, joinPaths, jsonMatch, slicePath, stringifyPath } from "@sanity/json-match";
+/**
+ * Configuration for an authentication provider
+ * @public
+ */
+interface AuthProvider {
+  /**
+   * Unique identifier for the auth provider (e.g., 'google', 'github')
+   */
+  name: string;
+  /**
+   * Display name for the auth provider in the UI
+   */
+  title: string;
+  /**
+   * Complete authentication URL including callback and token parameters
+   */
+  url: string;
+  /**
+   * Optional URL for direct sign-up flow
+   */
+  signUpUrl?: string;
+}
+/**
+ * Configuration options for creating an auth store.
+ *
+ * @public
+ */
+interface AuthConfig {
+  /**
+   * The initial location href to use when handling auth callbacks.
+   * Defaults to the current window location if available.
+   */
+  initialLocationHref?: string;
+  /**
+   * Factory function to create a SanityClient instance.
+   * Defaults to the standard Sanity client factory if not provided.
+   */
+  clientFactory?: (config: ClientConfig) => SanityClient;
+  /**
+   * Custom authentication providers to use instead of or in addition to the default ones.
+   * Can be an array of providers or a function that takes the default providers and returns
+   * a modified array or a Promise resolving to one.
+   */
+  providers?: AuthProvider[] | ((prev: AuthProvider[]) => AuthProvider[] | Promise<AuthProvider[]>);
+  /**
+   * The API hostname for requests. Usually leave this undefined, but it can be set
+   * if using a custom domain or CNAME for the API endpoint.
+   */
+  apiHost?: string;
+  /**
+   * Storage implementation to persist authentication state.
+   * Defaults to `localStorage` if available.
+   */
+  storageArea?: Storage;
+  /**
+   * A callback URL for your application.
+   * If none is provided, the auth API will redirect back to the current location (`location.href`).
+   * When handling callbacks, this URL's pathname is checked to ensure it matches the callback.
+   */
+  callbackUrl?: string;
+  /**
+   * A static authentication token to use instead of handling the OAuth flow.
+   * When provided, the auth store will remain in a logged-in state with this token,
+   * ignoring any storage or callback handling.
+   */
+  token?: string;
+}
+/**
+ * A minimal Observable-compatible interface for subscribing to token changes.
+ * Any object with a `subscribe` method that follows this contract will work,
+ * including RxJS Observables. This avoids coupling the SDK to a specific
+ * reactive library.
+ *
+ * @public
+ */
+interface TokenSource {
+  /** Subscribe to token emissions. Emits `null` when logged out. */
+  subscribe(observer: {
+    next: (token: string | null) => void;
+  }): {
+    unsubscribe(): void;
+  };
+}
+/**
+ * Studio-specific configuration for the SDK.
+ * When present, the SDK operates in studio mode and derives auth from the
+ * provided token source instead of discovering tokens independently.
+ *
+ * @public
+ */
+interface StudioConfig {
+  /**
+   * Whether the Studio has already determined the user is authenticated.
+   * When `true` and the token source emits `null`, the SDK infers
+   * cookie-based auth is in use rather than transitioning to logged-out.
+   */
+  authenticated?: boolean;
+  /** Reactive auth token source from the Studio's auth store. */
+  auth?: {
+    /**
+     * A reactive token source. The SDK subscribes and stays in sync — the
+     * Studio is the single authority for auth and handles token refresh.
+     *
+     * Optional because older Studios may not expose it. When absent, the
+     * SDK falls back to localStorage/cookie discovery.
+     */
+    token?: TokenSource;
+  };
+}
+/**
+ * Represents the minimal configuration required to identify a Sanity project.
+ * @public
+ */
+interface ProjectHandle<TProjectId extends string = string> {
+  projectId?: TProjectId;
+}
+/**
+ * @public
+ */
+type ReleasePerspective = {
+  releaseName: string;
+  excludedPerspectives?: StackablePerspective[];
+};
+/**
+ * @public
+ */
+interface PerspectiveHandle {
+  perspective?: ClientPerspective | ReleasePerspective;
+}
+/**
+ * @public
+ */
+interface DatasetHandle<TDataset extends string = string, TProjectId extends string = string> extends ProjectHandle<TProjectId>, PerspectiveHandle {
+  dataset?: TDataset;
+  /**
+   * @beta
+   * Explicit resource object to use for this operation.
+   */
+  resource?: DocumentResource;
+  /**
+   * @deprecated Use `resource` instead.
+   * @beta
+   */
+  source?: DocumentResource;
+}
+/**
+ * Identifies a specific document type within a Sanity dataset and project.
+ * Includes `projectId`, `dataset`, and `documentType`.
+ * Optionally includes a `documentId` and `liveEdit` flag.
+ * @public
+ */
+interface DocumentTypeHandle<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DatasetHandle<TDataset, TProjectId> {
+  documentId?: string;
+  documentType: TDocumentType;
+  /**
+   * Indicates whether this document uses liveEdit mode.
+   * When `true`, the document does not use the draft/published model and edits are applied directly to the document.
+   * @see https://www.sanity.io/docs/content-lake/drafts#ca0663a8f002
+   */
+  liveEdit?: boolean;
+}
+/**
+ * Uniquely identifies a specific document within a Sanity dataset and project.
+ * Includes `projectId`, `dataset`, `documentType`, and the required `documentId`.
+ * Commonly used by document-related hooks and components to reference a document without fetching its full content initially.
+ * @public
+ */
+interface DocumentHandle<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentTypeHandle<TDocumentType, TDataset, TProjectId> {
+  documentId: string;
+}
+/**
+ * Represents the complete configuration for a Sanity SDK instance
+ * @public
+ */
+interface SanityConfig extends DatasetHandle, PerspectiveHandle {
+  /**
+   * Authentication configuration for the instance
+   * @remarks Merged with parent configurations when using createChild
+   */
+  auth?: AuthConfig;
+  /**
+   * Studio configuration provided by a Sanity Studio workspace.
+   * When present, the SDK operates in studio mode and derives auth from the
+   * workspace's reactive token source — no manual configuration needed.
+   *
+   * @remarks Typically set automatically by `SanityApp` when it detects an
+   * `SDKStudioContext` provider. Can also be set explicitly for programmatic use.
+   */
+  studio?: StudioConfig;
+  /**
+   * Studio mode configuration for use of the SDK in a Sanity Studio.
+   * @remarks Controls whether studio mode features are enabled.
+   * @deprecated Use `studio` instead, which provides richer integration
+   * with the Studio's workspace (auth token sync, etc.).
+   */
+  studioMode?: {
+    enabled: boolean;
+  };
+  /**
+   * @beta
+   * A list of named resources to use for this instance.
+   */
+  resources?: Record<string, DocumentResource>;
+  /**
+   * @deprecated Use `resources` instead.
+   * @beta
+   */
+  sources?: Record<string, DocumentResource>;
+}
+/**
+ * A document resource can be used for querying.
+ * This will soon be the default way to identify where you are querying from.
+ *
+ * @beta
+ */
+type DocumentResource = DatasetResource | MediaLibraryResource | CanvasResource$1;
+/**
+ * @beta
+ */
+type DatasetResource = {
+  projectId: string;
+  dataset: string;
+};
+/**
+ * @beta
+ */
+type MediaLibraryResource = {
+  mediaLibraryId: string;
+};
+/**
+ * @beta
+ */
+type CanvasResource$1 = {
+  canvasId: string;
+};
+/**
+ * @beta
+ */
+declare function isDatasetResource(resource: DocumentResource): resource is DatasetResource;
+/**
+ * @beta
+ */
+declare function isMediaLibraryResource(resource: DocumentResource): resource is MediaLibraryResource;
+/**
+ * @beta
+ */
+declare function isCanvasResource(resource: DocumentResource): resource is CanvasResource$1;
+/**
+ * @deprecated Use `DocumentResource` instead.
+ * @beta
+ */
+type DocumentSource = DocumentResource;
+/**
+ * @deprecated Use `DatasetResource` instead.
+ * @beta
+ */
+type DatasetSource = DatasetResource;
+/**
+ * @deprecated Use `MediaLibraryResource` instead.
+ * @beta
+ */
+type MediaLibrarySource = MediaLibraryResource;
+/**
+ * @deprecated Use `CanvasResource` instead.
+ * @beta
+ */
+type CanvasSource = CanvasResource$1;
+/**
+ * @deprecated Use `isDatasetResource` instead.
+ * @beta
+ */
+declare function isDatasetSource(source: DocumentSource): source is DatasetSource;
+/**
+ * @deprecated Use `isMediaLibraryResource` instead.
+ * @beta
+ */
+declare function isMediaLibrarySource(source: DocumentSource): source is MediaLibrarySource;
+/**
+ * @deprecated Use `isCanvasResource` instead.
+ * @beta
+ */
+declare function isCanvasSource(source: DocumentSource): source is CanvasSource;
+/**
+ * Returns `true` when the config indicates the SDK is running inside a Studio.
+ * Checks the new `studio` field first, then falls back to the deprecated
+ * `studioMode.enabled` for backwards compatibility.
+ *
+ * @internal
+ */
+declare function isStudioConfig(config: SanityConfig): boolean;
+/**
+ * Represents a Sanity.io resource instance with its own configuration and lifecycle
+ * @remarks Instances form a hierarchy through parent/child relationships
+ *
+ * @public
+ */
+interface SanityInstance {
+  /**
+   * Unique identifier for this instance
+   * @remarks Generated using crypto.randomUUID()
+   */
+  readonly instanceId: string;
+  /**
+   * Resolved configuration for this instance
+   * @remarks Merges values from parent instances where appropriate
+   */
+  readonly config: SanityConfig;
+  /**
+   * Checks if the instance has been disposed
+   * @returns true if dispose() has been called
+   */
+  isDisposed(): boolean;
+  /**
+   * Disposes the instance and cleans up associated resources
+   * @remarks Triggers all registered onDispose callbacks
+   */
+  dispose(): void;
+  /**
+   * Registers a callback to be invoked when the instance is disposed
+   * @param cb - Callback to execute on disposal
+   * @returns Function to unsubscribe the callback
+   */
+  onDispose(cb: () => void): () => void;
+  /**
+   * Gets the parent instance in the hierarchy
+   * @returns Parent instance or undefined if this is the root
+   */
+  getParent(): SanityInstance | undefined;
+  /**
+   * Creates a child instance with merged configuration
+   * @param config - Configuration to merge with parent values
+   * @remarks Child instances inherit parent configuration but can override values
+   */
+  createChild(config: SanityConfig): SanityInstance;
+  /**
+   * Traverses the instance hierarchy to find the first instance whose configuration
+   * matches the given target config using a shallow comparison.
+   * @param targetConfig - A partial configuration object containing key-value pairs to match.
+   * @returns The first matching instance or undefined if no match is found.
+   */
+  match(targetConfig: Partial<SanityConfig>): SanityInstance | undefined;
+}
+/**
+ * Creates a new Sanity resource instance
+ * @param config - Configuration for the instance (optional)
+ * @returns A configured SanityInstance
+ * @remarks When creating child instances, configurations are merged with parent values
+ *
+ * @public
+ */
+declare function createSanityInstance(config?: SanityConfig): SanityInstance;
+/**
+ * Represents a reactive store state container with multiple access patterns
+ */
+interface StoreState<TState> {
+  /**
+   * Gets the current state value
+   *
+   * @remarks
+   * This is a direct synchronous accessor that doesn't trigger subscriptions
+   */
+  get: () => TState;
+  /**
+   * Updates the store state
+   * @param name - Action name for devtools tracking
+   * @param updatedState - New state value or updater function
+   *
+   * @remarks
+   * When providing a partial object, previous top-level keys not included in
+   * the update will be preserved.
+   */
+  set: (name: string, updatedState: Partial<TState> | ((s: TState) => Partial<TState>)) => void;
+  /**
+   * Observable stream of state changes
+   * @remarks
+   * - Emits immediately with current state on subscription
+   * - Shares underlying subscription between observers
+   * - Only emits when state reference changes
+   * - Completes when store is disposed
+   */
+  observable: Observable<TState>;
+}
+/**
+ * Context object provided to store initialization functions
+ */
+interface StoreContext<TState, TKey = unknown> {
+  /**
+   * Sanity instance associated with this store
+   *
+   * @remarks
+   * Provides access to the Sanity configuration and instance lifecycle methods
+   */
+  instance: SanityInstance;
+  /**
+   * Reactive store state management utilities
+   *
+   * @remarks
+   * Contains methods for getting/setting state and observing changes
+   */
+  state: StoreState<TState>;
+  /**
+   * The key used to instantiate the store.
+   */
+  key: TKey;
+}
+/** @alpha */
+type AgentGenerateOptions = Parameters<SanityClient['observable']['agent']['action']['generate']>[0];
+/** @alpha */
+type AgentTransformOptions = Parameters<SanityClient['observable']['agent']['action']['transform']>[0];
+/** @alpha */
+type AgentTranslateOptions = Parameters<SanityClient['observable']['agent']['action']['translate']>[0];
+/** @alpha */
+type AgentPromptOptions = Parameters<SanityClient['agent']['action']['prompt']>[0];
+/** @alpha */
+type AgentPatchOptions = Parameters<SanityClient['agent']['action']['patch']>[0];
+/** @alpha */
+type AgentGenerateResult = Awaited<ReturnType<SanityClient['observable']['agent']['action']['generate']>>;
+/** @alpha */
+type AgentTransformResult = Awaited<ReturnType<SanityClient['observable']['agent']['action']['transform']>>;
+/** @alpha */
+type AgentTranslateResult = Awaited<ReturnType<SanityClient['observable']['agent']['action']['translate']>>;
+/** @alpha */
+type AgentPromptResult = Awaited<ReturnType<SanityClient['agent']['action']['prompt']>>;
+/** @alpha */
+type AgentPatchResult = Awaited<ReturnType<SanityClient['agent']['action']['patch']>>;
+/**
+ * Generates a new document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent generate action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent generate action.
+ * @alpha
+ */
+declare function agentGenerate(instance: SanityInstance, options: AgentGenerateOptions): AgentGenerateResult;
+/**
+ * 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): 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): AgentTranslateResult;
+/**
+ * Prompts the agent using the same instruction template format as the other actions, but returns text or json instead of acting on a document.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent prompt action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent prompt action.
+ * @alpha
+ */
+declare function agentPrompt(instance: SanityInstance, options: AgentPromptOptions): Observable<AgentPromptResult>;
+/**
+ * Patches a document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent patch action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent patch action.
+ * @alpha
+ */
+declare function agentPatch(instance: SanityInstance, options: AgentPatchOptions): Observable<AgentPatchResult>;
+/**
+ * Represents the various states the authentication type can be in.
+ *
+ * @public
+ */
+declare enum AuthStateType {
+  LOGGED_IN = "logged-in",
+  LOGGING_IN = "logging-in",
+  ERROR = "error",
+  LOGGED_OUT = "logged-out",
+}
+/**
+ * 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>;
+/**
+ * Defines a store action that operates on a specific state type
+ */
+type StoreAction<TState, TParams extends unknown[], TReturn, TKey = unknown> = (context: StoreContext<TState, TKey>, ...params: TParams) => TReturn;
+/**
+ * Represents a store action that has been bound to a specific store instance
+ */
+type BoundStoreAction<_TState, TParams extends unknown[], TReturn> = (instance: SanityInstance, ...params: TParams) => TReturn;
+/**
+ * @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], 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<_sanity_comlink3.Message, _sanity_comlink3.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<_sanity_comlink3.Message, _sanity_comlink3.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], 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<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client20.DatasetsResponse>, [options?: ProjectHandle<string> | undefined], StateSource<_sanity_client20.DatasetsResponse | undefined>>;
+/** @public */
+declare const resolveDatasets: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client20.DatasetsResponse>, [options?: ProjectHandle<string> | undefined], Promise<_sanity_client20.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$2<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>;
+/**
+ * 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$2<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>;
+/**
+ * Represents a reactive state source that provides synchronized access to store data
+ *
+ * @remarks
+ * Designed to work with React's useSyncExternalStore hook. Provides three ways to access data:
+ * 1. `getCurrent()` for synchronous current value access
+ * 2. `subscribe()` for imperative change notifications
+ * 3. `observable` for reactive stream access
+ *
+ * @public
+ */
+interface StateSource<T> {
+  /**
+   * Subscribes to state changes with optional callback
+   * @param onStoreChanged - Called whenever relevant state changes occur
+   * @returns Unsubscribe function to clean up the subscription
+   */
+  subscribe: (onStoreChanged?: () => void) => () => void;
+  /**
+   * Gets the current derived state value
+   *
+   * @remarks
+   * Safe to call without subscription. Will always return the latest value
+   * based on the current store state and selector parameters.
+   */
+  getCurrent: () => T;
+  /**
+   * Observable stream of state values
+   *
+   * @remarks
+   * Shares a single underlying subscription between all observers. Emits:
+   * - Immediately with current value on subscription
+   * - On every relevant state change
+   * - Errors if selector throws
+   */
+  observable: Observable<T>;
+}
+/**
+ * Context passed to selectors when deriving state
+ *
+ * @remarks
+ * Provides access to both the current state value and the Sanity instance,
+ * allowing selectors to use configuration values when computing derived state.
+ * The context is memoized for each state object and instance combination
+ * to optimize performance and prevent unnecessary recalculations.
+ *
+ * @example
+ * ```ts
+ * // Using both state and instance in a selector (psuedo example)
+ * const getUserByProjectId = createStateSourceAction(
+ *   ({ state, instance }: SelectorContext<UsersState>, options?: ProjectHandle) => {
+ *     const allUsers = state.users
+ *     const projectId = options?.projectId ?? instance.config.projectId
+ *     return allUsers.filter(user => user.projectId === projectId)
+ *   }
+ * )
+ * ```
+ */
+interface SelectorContext<TState> {
+  /**
+   * The current state object from the store
+   */
+  state: TState;
+  /**
+   * The Sanity instance associated with this state
+   */
+  instance: SanityInstance;
+}
+/**
+ * Function type for selecting derived state from store state and parameters
+ * @public
+ */
+type Selector<TState, TParams extends unknown[], TReturn> = (context: SelectorContext<TState>, ...params: TParams) => TReturn;
+/**
+ * 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$1 = SanityDocument$1> = { [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>>;
+  dispose: () => void;
+}
+interface DocumentStoreState {
+  documentStates: { [TDocumentId in string]?: DocumentState };
+  queued: QueuedTransaction[];
+  applied: AppliedTransaction[];
+  outgoing?: OutgoingTransaction;
+  grants?: Record<Grant, ExprNode>;
+  error?: unknown;
+  sharedListener: SharedListener;
+  fetchDocument: (documentId: string) => Observable<SanityDocument$2 | 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$2 | null;
+  /**
+   * the current ephemeral working copy that includes local optimistic changes
+   * that have not yet been confirmed by the server
+   */
+  local?: SanityDocument$2 | 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$2<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$2<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$2<TDocumentType, `${TProjectId}.${TDataset}`> | null>;
+/** @beta */
+declare function resolveDocument<TData extends SanityDocument$2>(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';
+};
+type OptimisticLock = {
+  ifDraftRevisionId?: string;
+  ifPublishedRevisionId?: string;
+};
+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);
+/**
+ * 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: DocumentAction[];
+  /**
+   * 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$2 = SanityDocument$2> {
+  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.
+   */
+  actions: DocumentAction[];
+  /**
+   * 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$2<TDocumentType, `${TProjectId}.${TDataset}`>>>;
+/** @beta */
+declare function applyDocumentActions(instance: SanityInstance, options: ApplyDocumentActionsOptions): Promise<ActionsResult>;
+/**
+ * @public
+ */
+interface FavoriteStatusResponse {
+  isFavorited: boolean;
+}
+/**
+ * @public
+ */
+interface FavoriteDocumentContext extends DocumentHandle {
+  resourceId: string;
+  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['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<FetcherStoreState<[FavoriteDocumentContext], FavoriteStatusResponse>, [FavoriteDocumentContext], 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<FetcherStoreState<[FavoriteDocumentContext], FavoriteStatusResponse>, [FavoriteDocumentContext], Promise<FavoriteStatusResponse>>;
+/**
+ * @public
+ */
+interface SanityUser {
+  sanityUserId: string;
+  profile: UserProfile;
+  memberships: Membership[];
+}
+/**
+ * @public
+ */
+interface Membership {
+  addedAt?: string;
+  resourceType: string;
+  resourceId: string;
+  roleNames: Array<string>;
+  lastSeenAt?: string | null;
+}
+/**
+ * @public
+ */
+interface UserProfile {
+  id: string;
+  displayName: string;
+  email: string;
+  familyName?: string;
+  givenName?: string;
+  middleName?: string | null;
+  imageUrl?: string;
+  provider: string;
+  tosAcceptedAt?: string;
+  createdAt: string;
+  updatedAt?: string;
+  isCurrentUser?: boolean;
+  providerId?: string;
+}
+/**
+ * @public
+ */
+interface GetUsersOptions extends ProjectHandle {
+  resourceType?: 'organization' | 'project';
+  batchSize?: number;
+  organizationId?: string;
+  userId?: string;
+}
+/**
+ * @public
+ */
+interface UsersGroupState {
+  subscriptions: string[];
+  totalCount?: number;
+  nextCursor?: string | null;
+  lastLoadMoreRequest?: string;
+  users?: SanityUser[];
+  error?: unknown;
+}
+/**
+ * @public
+ */
+interface SanityUserResponse {
+  data: SanityUser[];
+  totalCount: number;
+  nextCursor: string | null;
+}
+/**
+ * @public
+ */
+interface UsersStoreState {
+  users: { [TUsersKey in string]?: UsersGroupState };
+  error?: unknown;
+}
+/**
+ * @public
+ */
+interface ResolveUsersOptions extends GetUsersOptions {
+  signal?: AbortSignal;
+}
+/**
+ * @public
+ */
+interface GetUserOptions extends ProjectHandle {
+  userId: string;
+  resourceType?: 'organization' | 'project';
+  organizationId?: string;
+}
+/**
+ * @public
+ */
+interface ResolveUserOptions extends GetUserOptions {
+  signal?: AbortSignal;
+}
+/** @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[]>;
+/**
+ * @public
+ * The result of a projection query
+ */
+interface ProjectionValuePending<TValue extends object> {
+  data: TValue | null;
+  isPending: boolean;
+}
+/**
+ * @public
+ * @deprecated
+ * Template literals are a bit too limited, so this type is deprecated.
+ * Use `string` instead. Projection strings are validated at runtime.
+ */
+type ValidProjection = string;
+interface DocumentStatus {
+  lastEditedDraftAt?: string;
+  lastEditedPublishedAt?: string;
+  lastEditedVersionAt?: string;
+}
+/**
+ *
+ * @internal
+ */
+interface PreviewQueryResult {
+  _id: string;
+  _type: string;
+  _updatedAt: string;
+  titleCandidates: Record<string, unknown>;
+  subtitleCandidates: Record<string, unknown>;
+  media?: PreviewMedia | null;
+  _status?: DocumentStatus;
+}
+/**
+ * Represents a media asset in a preview.
+ *
+ * @public
+ */
+interface PreviewMedia {
+  type: 'image-asset';
+  _ref: string;
+  url: string;
+}
+/**
+ * Represents the set of values displayed as a preview for a given Sanity document.
+ * This includes a primary title, a secondary subtitle, an optional piece of media associated
+ * with the document, and the document's status.
+ *
+ * @public
+ */
+interface PreviewValue {
+  /**
+   * The primary text displayed for the document preview.
+   */
+  title: string;
+  /**
+   * A secondary line of text providing additional context about the document.
+   */
+  subtitle?: string;
+  /**
+   * An optional piece of media representing the document within its preview.
+   * Currently, only image assets are available.
+   */
+  media?: PreviewMedia | null;
+  /**
+   * The status of the document.
+   */
+  _status?: {
+    /** The date of the last published edit */
+    lastEditedPublishedAt?: string;
+    /** The date of the last draft edit */
+    lastEditedDraftAt?: string;
+  };
+}
+/**
+ * Represents the current state of a preview value along with a flag indicating whether
+ * the preview data is still being fetched or is fully resolved.
+ *
+ * The tuple contains a preview value or null, and a boolean indicating if the data is
+ * pending. A `true` value means a fetch is ongoing; `false` indicates that the
+ * currently provided preview value is up-to-date.
+ *
+ * @public
+ */
+type ValuePending<T> = {
+  data: T | null;
+  isPending: boolean;
+};
+/**
+ * @public
+ * @deprecated This interface is kept for backwards compatibility but is no longer used internally.
+ * Preview state is now stored in the projection store.
+ */
+interface PreviewStoreState {
+  values: { [TDocumentId in string]?: ValuePending<PreviewValue> };
+  subscriptions: { [TDocumentId in string]?: { [TSubscriptionId in string]?: true } };
+}
+/**
+ * @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>>;
+/**
+ * Generates a GROQ projection for preview data without requiring a schema.
+ * Uses common field names to make educated guesses about which fields to use.
+ *
+ * @internal
+ */
+declare const PREVIEW_PROJECTION: string;
+/**
+ * Transforms a projection result (with titleCandidates, subtitleCandidates, media)
+ * into a PreviewValue (with title, subtitle, media).
+ *
+ * @param projectionResult - The raw projection result from GROQ
+ * @param instance - The Sanity instance to use for client configuration
+ * @param resource - Data resource for the preview
+ * @internal
+ */
+declare function transformProjectionToPreview(instance: SanityInstance, projectionResult: PreviewQueryResult, resource?: DocumentResource): 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 */
+declare const getProjectState: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client20.SanityProject>, [options?: ProjectHandle<string> | undefined], StateSource<_sanity_client20.SanityProject | undefined>>;
+/** @public */
+declare const resolveProject: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client20.SanityProject>, [options?: ProjectHandle<string> | undefined], Promise<_sanity_client20.SanityProject>>;
+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 */
+declare const getProjectsState: BoundStoreAction<FetcherStoreState<[options?: {
+  organizationId?: string;
+  includeMembers?: boolean;
+} | undefined], Omit<_sanity_client20.SanityProject, never>[]>, [options?: {
+  organizationId?: string;
+  includeMembers?: boolean;
+} | undefined], StateSource<Omit<_sanity_client20.SanityProject, never>[] | undefined>>;
+/** @public */
+declare const resolveProjects: BoundStoreAction<FetcherStoreState<[options?: {
+  organizationId?: string;
+  includeMembers?: boolean;
+} | undefined], Omit<_sanity_client20.SanityProject, never>[]>, [options?: {
+  organizationId?: string;
+  includeMembers?: boolean;
+} | undefined], Promise<Omit<_sanity_client20.SanityProject, never>[]>>;
+/**
+ * @beta
+ */
+interface QueryOptions<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string> extends Pick<ResponseQueryOptions, 'useCdn' | 'cache' | 'next' | 'cacheMode' | 'tag'>, DatasetHandle<TDataset, TProjectId> {
+  query: TQuery;
+  params?: Record<string, unknown>;
+}
+/**
+ * @beta
+ */
+interface ResolveQueryOptions<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string> extends QueryOptions<TQuery, TDataset, TProjectId> {
+  signal?: AbortSignal;
+}
+/** @beta */
+declare const getQueryKey: (options: QueryOptions) => string;
+/** @beta */
+declare const parseQueryKey: (key: string) => QueryOptions;
+/**
+ * Returns the state source for a query.
+ *
+ * This function returns a state source that represents the current result of a GROQ query.
+ * Subscribing to the state source will instruct the SDK to fetch the query (if not already fetched)
+ * and will keep the query live using the Live content API (considering sync tags) to provide up-to-date results.
+ * When the last subscriber is removed, the query state is automatically cleaned up from the store.
+ *
+ * Note: This functionality is for advanced users who want to build their own framework integrations.
+ * Our SDK also provides a React integration (useQuery hook) for convenient usage.
+ *
+ * Note: Automatic cleanup can interfere with React Suspense because if a component suspends while being the only subscriber,
+ * cleanup might occur unexpectedly. In such cases, consider using `resolveQuery` instead.
+ *
+ * @beta
+ */
+declare function getQueryState<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, queryOptions: QueryOptions<TQuery, TDataset, TProjectId>): StateSource<SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`> | undefined>;
+/** @beta */
+declare function getQueryState<TData>(instance: SanityInstance, queryOptions: QueryOptions): StateSource<TData | undefined>;
+/** @beta */
+declare function getQueryState(instance: SanityInstance, queryOptions: QueryOptions): StateSource<unknown>;
+/**
+ * Resolves the result of a query without registering a lasting subscriber.
+ *
+ * This function fetches the result of a GROQ query and returns a promise that resolves with the query result.
+ * Unlike `getQueryState`, which registers subscribers to keep the query live and performs automatic cleanup,
+ * `resolveQuery` does not track subscribers. This makes it ideal for use with React Suspense, where the returned
+ * promise is thrown to delay rendering until the query result becomes available.
+ * Once the promise resolves, it is expected that a real subscriber will be added via `getQueryState` to manage ongoing updates.
+ *
+ * Additionally, an optional AbortSignal can be provided to cancel the query and immediately clear the associated state
+ * if there are no active subscribers.
+ *
+ * @beta
+ */
+declare function resolveQuery<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, queryOptions: ResolveQueryOptions<TQuery, TDataset, TProjectId>): Promise<SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`>>;
+/** @beta */
+declare function resolveQuery<TData>(instance: SanityInstance, queryOptions: ResolveQueryOptions): Promise<TData>;
+/**
+ * Represents a document in a Sanity dataset that represents release options.
+ * @internal
+ */
+type ReleaseDocument = SanityDocument$1 & {
+  name: string;
+  publishAt?: string;
+  state: 'active' | 'scheduled';
+  metadata: {
+    title: string;
+    releaseType: 'asap' | 'scheduled' | 'undecided';
+    intendedPublishAt?: string;
+    description?: string;
+  };
+};
+interface ReleasesStoreState {
+  activeReleases?: ReleaseDocument[];
+  error?: unknown;
+}
+/**
+ * Get the active releases from the store.
+ * @internal
+ */
+declare const getActiveReleasesState: (instance: SanityInstance, options?: {
+  resource?: DocumentResource;
+}) => StateSource<ReleaseDocument[] | undefined>;
+declare const _getPerspectiveStateSelector: StoreAction<ReleasesStoreState, [_?: (PerspectiveHandle & {
+  projectId?: string;
+  dataset?: string;
+  resource?: DocumentResource;
+}) | undefined], 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;
+/** @internal */
+declare const getUsersKey: (instance: SanityInstance, {
+  resourceType,
+  organizationId,
+  batchSize,
+  projectId,
+  userId
+}?: GetUsersOptions) => string;
+/** @internal */
+declare const parseUsersKey: (key: string) => {
+  batchSize: number;
+  resourceType?: "organization" | "project";
+  projectId?: string;
+  organizationId?: string;
+  userId?: string;
+};
+/**
+ * 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], 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>>;
+}
+/**
+ * Creates a GROQ search filter string (`[@] match text::query("...")`)
+ * from a raw search query string.
+ *
+ * It applies wildcard ('*') logic to the last eligible token and escapes
+ * double quotes within the search term.
+ *
+ * If the input query is empty or only whitespace, it returns an empty string.
+ *
+ * @param query - The raw input search string.
+ * @returns The GROQ search filter string, or an empty string.
+ * @internal
+ */
+declare function createGroqSearchFilter(query: string): string;
+/**
+ * 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$1 = SanityProject;
+/**
+ * Represents the various states the authentication can be in.
+ *
+ * @public
+ */
+type AuthState = LoggedInAuthState | LoggedOutAuthState | LoggingInAuthState | ErrorAuthState;
+/**
+ * Logged-in state from the auth state.
+ * @public
+ */
+type LoggedInAuthState = {
+  type: AuthStateType.LOGGED_IN;
+  token: string;
+  currentUser: CurrentUser | null;
+  lastTokenRefresh?: number;
+};
+/**
+ * Logged-out state from the auth state.
+ * @public
+ */
+type LoggedOutAuthState = {
+  type: AuthStateType.LOGGED_OUT;
+  isDestroyingSession: boolean;
+};
+/**
+ * Logging-in state from the auth state.
+ * @public
+ */
+type LoggingInAuthState = {
+  type: AuthStateType.LOGGING_IN;
+  isExchangingToken: boolean;
+};
+/**
+ * Error state from the auth state.
+ * @public
+ */
+type ErrorAuthState = {
+  type: AuthStateType.ERROR;
+  error: unknown;
+};
+/**
+ * Represents the various states the authentication can be in.
+ *
+ * @public
+ */
+interface DashboardContext {
+  mode?: string;
+  env?: string;
+  orgId?: string;
+}
+/**
+ * The method of authentication used.
+ * @internal
+ */
+type AuthMethodOptions = 'localstorage' | 'cookie' | undefined;
+/**
+ * @public
+ */
+interface AuthStoreState {
+  authState: AuthState;
+  providers?: AuthProvider[];
+  options: {
+    initialLocationHref: string;
+    clientFactory: (config: ClientConfig) => SanityClient;
+    customProviders: AuthConfig['providers'];
+    storageKey: string;
+    storageArea: Storage | undefined;
+    apiHost: string | undefined;
+    loginUrl: string;
+    callbackUrl: string | undefined;
+    providedToken: string | undefined;
+    authMethod: AuthMethodOptions;
+  };
+  dashboardContext?: DashboardContext;
+}
+/**
+ * @public
+ */
+declare const getCurrentUserState: BoundStoreAction<AuthStoreState, [], StateSource<CurrentUser | null>>;
+/**
+ * @public
+ */
+declare const getTokenState: BoundStoreAction<AuthStoreState, [], StateSource<string | null>>;
+/**
+ * @public
+ */
+declare const getLoginUrlState: BoundStoreAction<AuthStoreState, [], StateSource<string>>;
+/**
+ * @public
+ */
+declare const getAuthState: BoundStoreAction<AuthStoreState, [], StateSource<AuthState>>;
+/**
+ * @public
+ */
+declare const getDashboardOrganizationId: BoundStoreAction<AuthStoreState, [], StateSource<string | undefined>>;
+/**
+ * Returns a state source indicating if the SDK is running within a dashboard context.
+ * @public
+ */
+declare const getIsInDashboardState: BoundStoreAction<AuthStoreState, [], StateSource<boolean>>;
+/**
+ * Action to explicitly set the authentication token.
+ * Used internally by the Comlink token refresh.
+ * @internal
+ */
+declare const setAuthToken: BoundStoreAction<AuthStoreState, [token: string | null], void>;
+/** @internal */
+type ApiErrorBody = {
+  error?: {
+    type?: string;
+    description?: string;
+  };
+  type?: string;
+  description?: string;
+  message?: string;
+};
+/** @internal Extracts the structured API error body from a ClientError, if present. */
+declare function getClientErrorApiBody(error: ClientError): ApiErrorBody | undefined;
+/** @internal Returns the error type string from an API error body, if available. */
+declare function getClientErrorApiType(error: ClientError): string | undefined;
+/** @internal Returns the error description string from an API error body, if available. */
+declare function getClientErrorApiDescription(error: ClientError): string | undefined;
+/** @internal True if the error represents a projectUserNotFoundError. */
+declare function isProjectUserNotFoundClientError(error: ClientError): boolean;
+export { getProjectsState as $, getClientState as $n, getDocumentState as $t, isImportError as A, Logger as An, DocumentSource as Ar, SanityUser as At, loadMoreUsers as B, releaseNode as Bn, isCanvasResource as Br, applyDocumentActions as Bt, getIndexForKey as C, getDatasetsState as Cn, CanvasResource$1 as Cr, TransportEvent as Ct, slicePath as D, LogContext as Dn, DatasetSource as Dr, Membership as Dt, jsonMatch as E, InstanceContext as En, DatasetResource as Er, GetUsersOptions as Et, createGroqSearchFilter as F, createProjectHandle as Fn, ProjectHandle as Fr, FavoriteStatusResponse as Ft, getPerspectiveState as G, releaseChannel as Gn, isMediaLibrarySource as Gr, DocumentEditedEvent as Gt, resolveUsers as H, destroyController as Hn, isDatasetResource as Hr, DocumentCreatedEvent as Ht, FetcherStore as I, NodeState as In, ReleasePerspective as Ir, getFavoritesState as It, QueryOptions as J, RequestNewTokenMessage as Jn, DocumentTransactionSubmissionResult as Jt, ReleaseDocument as K, FrameMessage as Kn, AuthConfig as Kr, DocumentEvent as Kt, FetcherStoreState as L, getNodeState as Ln, SanityConfig as Lr, resolveFavoritesState as Lt, Intent as M, createDatasetHandle as Mn, MediaLibraryResource as Mr, UserProfile as Mt, IntentFilter as N, createDocumentHandle as Nn, MediaLibrarySource as Nr, UsersGroupState as Nt, stringifyPath as O, LogLevel as On, DocumentHandle as Or, ResolveUserOptions as Ot, defineIntent as P, createDocumentTypeHandle as Pn, PerspectiveHandle as Pr, UsersStoreState as Pt, resolveQuery as Q, getClient as Qn, DocumentOptions as Qt, getUserState as R, ComlinkNodeState as Rn, StudioConfig as Rr, ActionsResult as Rt, SanityProject$1 as S, unpublishDocument as Sn, isStudioConfig as Sr, StateEvent as St, joinPaths as T, configureLogging as Tn, DatasetHandle as Tr, GetUserOptions as Tt, getUsersKey as U, getOrCreateChannel as Un, isDatasetSource as Ur, DocumentDeletedEvent as Ut, resolveUser as V, ComlinkControllerState as Vn, isCanvasSource as Vr, ActionErrorEvent as Vt, parseUsersKey as W, getOrCreateController as Wn, isMediaLibraryResource as Wr, DocumentDiscardedEvent as Wt, getQueryState as X, ClientOptions as Xn, TransactionAcceptedEvent as Xt, getQueryKey as Y, WindowMessage as Yn, DocumentUnpublishedEvent as Yt, parseQueryKey as Z, ClientStoreState as Zn, TransactionRevertedEvent as Zt, getTokenState as _, createDocument as _n, agentPrompt as _r, ValidProjection as _t, isProjectUserNotFoundClientError as a, DocumentPermissionsResult as an, AgentGenerateOptions as ar, ResolvePreviewOptions as at, Role as b, editDocument as bn, SanityInstance as br, PresenceLocation as bt, ErrorAuthState as c, Selector as cn, AgentPatchResult as cr, PREVIEW_PROJECTION as ct, LoggingInAuthState as d, DeleteDocumentAction as dn, AgentTransformOptions as dr, PreviewMedia as dt, getDocumentSyncStatus as en, logout as er, resolveProjects as et, getAuthState as f, DiscardDocumentAction as fn, AgentTransformResult as fr, PreviewQueryResult as ft, getLoginUrlState as g, UnpublishDocumentAction as gn, agentPatch as gr, ProjectionValuePending as gt, getIsInDashboardState as h, PublishDocumentAction as hn, agentGenerate as hr, ValuePending as ht, getClientErrorApiType as i, subscribeDocumentEvents as in, AuthStateType as ir, resolveProject as it, getCorsErrorProjectId as j, LoggerConfig as jn, DocumentTypeHandle as jr, SanityUserResponse as jt, CORE_SDK_VERSION as k, LogNamespace as kn, DocumentResource as kr, ResolveUsersOptions as kt, LoggedInAuthState as l, StateSource as ln, AgentPromptOptions as lr, GetPreviewStateOptions as lt, getDashboardOrganizationId as m, EditDocumentAction as mn, AgentTranslateResult as mr, PreviewValue as mt, getClientErrorApiBody as n, resolveDocument as nn, observeOrganizationVerificationState as nr, getProjectionState as nt, AuthState as o, PermissionDeniedReason as on, AgentGenerateResult as or, resolvePreview as ot, getCurrentUserState as p, DocumentAction as pn, AgentTranslateOptions as pr, PreviewStoreState as pt, getActiveReleasesState as q, NewTokenResponseMessage as qn, AuthProvider as qr, DocumentPublishedEvent as qt, getClientErrorApiDescription as r, resolvePermissions as rn, OrgVerificationResult as rr, getProjectState as rt, AuthStoreState as s, JsonMatch as sn, AgentPatchOptions as sr, transformProjectionToPreview as st, ApiErrorBody as t, getPermissionsState as tn, handleAuthCallback as tr, resolveProjection as tt, LoggedOutAuthState as u, CreateDocumentAction as un, AgentPromptResult as ur, getPreviewState as ut, setAuthToken as v, deleteDocument as vn, agentTransform as vr, getPresence as vt, getPathDepth as w, resolveDatasets as wn, CanvasSource as wr, UserPresence as wt, SanityDocument$3 as x, publishDocument as xn, createSanityInstance as xr, RollCallEvent as xt, CurrentUser$1 as y, discardDocument as yn, agentTranslate as yr, DisconnectEvent as yt, getUsersState as z, getOrCreateNode as zn, TokenSource as zr, ApplyDocumentActionsOptions as zt };