@sanity/sdk 2.19.0 → 2.20.1

package/dist/utils-BMwA8Kg9.d.ts

@@ -0,0 +1,3334 @@
+import { ClientConfig, ClientError, ClientPerspective, ListenEvent, MultipleMutationResult, ReleaseDocument, ReleaseDocument as ReleaseDocument$1, ResponseQueryOptions, SanityClient, SanityDocument, SanityProject, StackablePerspective } from "@sanity/client";
+import { Observable, Subject } from "rxjs";
+import { CurrentUser, CurrentUser as CurrentUser$1, Mutation, PatchOperations, Path, PortableTextBlock, Role, SanityDocument as SanityDocument$1, SanityDocument as SanityDocument$3, SanityDocumentLike } from "@sanity/types";
+import "zustand/middleware";
+import { ChannelInput, ChannelInstance, Controller, Message, Node, NodeInput, Status } from "@sanity/comlink";
+import { getIndexForKey as getIndexForKey$1, getPathDepth, joinPaths, jsonMatch as jsonMatch$1, slicePath as slicePath$1, stringifyPath as stringifyPath$1 } from "@sanity/json-match";
+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";
+/**
+ * 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;
+}
+/**
+ * Identifies a release within a Sanity dataset and project. `releaseId` is the
+ * `name` parameter on the release document (e.g. `{name: 'r41035a4'}`).
+ * The underlying release document ID is `_.releases.<releaseId>`.
+ * It's also the `id` parameter sent to the Actions API.
+ * (This type doesn't need to have ProjectId / Dataset generics since it's always the same shape)
+ * @beta
+ */
+interface ReleaseHandle extends DatasetHandle {
+  releaseId: string;
+}
+/**
+ * Represents the complete configuration for a Sanity SDK instance
+ * @public
+ */
+interface SanityConfig extends DatasetHandle, PerspectiveHandle {
+  /**
+   * Authentication configuration for the instance
+   */
+  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
+ *
+ * @public
+ */
+interface SanityInstance {
+  /**
+   * Unique identifier for this instance
+   * @remarks Generated using crypto.randomUUID()
+   */
+  readonly instanceId: string;
+  /**
+   * Resolved configuration for this instance
+   */
+  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
+   * @deprecated The parent/child instance hierarchy is deprecated. Use a single SanityInstance instead.
+   */
+  getParent(): SanityInstance | undefined;
+  /**
+   * Creates a child instance with merged configuration
+   * @param config - Configuration to merge with parent values
+   * @deprecated The parent/child instance hierarchy is deprecated. Use a single SanityInstance instead.
+   */
+  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.
+   * @deprecated The parent/child instance hierarchy is deprecated. Use a single SanityInstance instead.
+   */
+  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, resource?: DocumentResource): AgentGenerateResult;
+/**
+ * Transforms a document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent transform action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent transform action.
+ * @alpha
+ */
+declare function agentTransform(instance: SanityInstance, options: AgentTransformOptions, resource?: DocumentResource): AgentTransformResult;
+/**
+ * Translates a document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent translate action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent translate action.
+ * @alpha
+ */
+declare function agentTranslate(instance: SanityInstance, options: AgentTranslateOptions, resource?: DocumentResource): AgentTranslateResult;
+/**
+ * Prompts the agent using the same instruction template format as the other actions, but returns text or json instead of acting on a document.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent prompt action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent prompt action.
+ * @alpha
+ */
+declare function agentPrompt(instance: SanityInstance, options: AgentPromptOptions, resource?: DocumentResource): Observable<AgentPromptResult>;
+/**
+ * Patches a document using the agent.
+ * @param instance - The Sanity instance.
+ * @param options - The options for the agent patch action. See the [Agent Actions API](https://www.sanity.io/docs/agent-actions/introduction) for more details.
+ * @returns An Observable emitting the result of the agent patch action.
+ * @alpha
+ */
+declare function agentPatch(instance: SanityInstance, options: AgentPatchOptions, resource?: DocumentResource): Observable<AgentPatchResult>;
+/**
+ * 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<import("@sanity/comlink").Message, import("@sanity/comlink").Message>>;
+/**
+ * Initializes or fetches a controller to handle communication
+ * between an application and iframes.
+ * @public
+ */
+declare const getOrCreateController: BoundStoreAction<ComlinkControllerState, [targetOrigin: string], Controller>;
+/**
+ * Signals to the store that the consumer has stopped using the channel
+ * @public
+ */
+declare const releaseChannel: BoundStoreAction<ComlinkControllerState, [name: string], void>;
+/**
+ * Individual node with its relevant options
+ * @public
+ */
+interface NodeEntry {
+  node: Node<WindowMessage, FrameMessage>;
+  options: NodeInput;
+  status: Status;
+  statusUnsub?: () => void;
+}
+/**
+ * Internal state tracking comlink connections
+ * @public
+ */
+interface ComlinkNodeState {
+  nodes: Map<string, NodeEntry>;
+  subscriptions: Map<string, Set<symbol>>;
+}
+/**
+ * Signals to the store that the consumer has stopped using the node
+ * @public
+ */
+declare const releaseNode: BoundStoreAction<ComlinkNodeState, [name: string], void>;
+/**
+ * Retrieve or create a node to be used for communication between
+ * an application and the controller -- specifically, a node should
+ * be created within a frame / window to communicate with the controller.
+ * @public
+ */
+declare const getOrCreateNode: BoundStoreAction<ComlinkNodeState, [options: NodeInput], Node<import("@sanity/comlink").Message, import("@sanity/comlink").Message>>;
+/**
+ * @public
+ */
+interface NodeState {
+  node: Node<WindowMessage, FrameMessage>;
+  status: Status | undefined;
+}
+/**
+ * Provides a subscribable state source for a node by name
+ * @param instance - The Sanity instance to get the node state for
+ * @param nodeInput - The configuration for the node to get the state for
+ * @returns A subscribable state source for the node
+ * @public
+ */
+declare const getNodeState: BoundStoreAction<ComlinkNodeState, [NodeInput], StateSource<NodeState | undefined>>;
+/**
+ * Whether a thread is still being discussed or has been closed out.
+ * @beta
+ */
+type CommentStatus = 'open' | 'resolved';
+/**
+ * The body of a comment, as Portable Text.
+ *
+ * Mentions appear here as inline objects of type `mention` carrying a `userId`.
+ * The SDK stores and returns them untouched, so a mention written in the Studio
+ * survives a round trip, but there is no API for composing one yet.
+ * @beta
+ */
+type CommentMessage = PortableTextBlock[] | null;
+/**
+ * One block touched by a text selection, and that block's text with the
+ * selection boundaries marked.
+ *
+ * `text` is the block's *entire* plain text with two private-use sentinel
+ * characters (U+F000 and U+F001) inserted where the selection starts and ends.
+ * Storing marked-up text rather than character offsets is what lets a highlight
+ * survive edits elsewhere in the same block.
+ * @beta
+ */
+interface CommentTextSelectionItem {
+  _key: string;
+  text: string;
+}
+/**
+ * A comment anchored to a run of text inside a Portable Text field.
+ *
+ * The SDK passes this through untouched. Resolving it back to a position in a
+ * live editor needs the editor's current value, so that lives in
+ * `@portabletext/plugin-sdk-value` rather than here.
+ * @beta
+ */
+interface CommentTextSelection {
+  type: 'text';
+  value: CommentTextSelectionItem[];
+}
+/**
+ * An emoji reaction on a comment.
+ *
+ * Read only for now: a reaction added in the Studio shows up here, but there is
+ * no action for adding or removing one.
+ * @beta
+ */
+interface CommentReaction {
+  shortName: string;
+  userId: string;
+  addedAt: string;
+}
+/**
+ * Why a comment is not yet on the server.
+ *
+ * Local only, never written. Present on a comment whose create request failed,
+ * so an app can offer a retry.
+ * @beta
+ */
+type CommentLocalState = {
+  type: 'createError';
+  error: Error;
+} | {
+  type: 'createRetrying';
+};
+/**
+ * A single comment.
+ *
+ * Deliberately not the stored document. Comments are moving from per-dataset
+ * addon datasets to an organization-level store, and the two disagree on the
+ * document type, on how the commented document is referenced, and on where the
+ * author is recorded. Everything here reads the same on both sides, so an app
+ * written against this survives the move.
+ *
+ * Threads are flat: every comment in a thread shares a `threadId`, the thread's
+ * first comment has no `parentCommentId`, and replies carry that first comment's
+ * `id`. Use {@link CommentThread} to work with them grouped.
+ *
+ * @beta
+ */
+interface Comment {
+  id: string;
+  createdAt: string;
+  /**
+   * Who wrote it.
+   *
+   * Absent when the server carries the author instead of the document. The
+   * Studio's comments dataset stores it on the document, so it is present on
+   * everything written today, but an agent-authored comment records
+   * attribution elsewhere. Render a fallback rather than assuming a user id.
+   */
+  authorId?: string;
+  message: CommentMessage;
+  threadId: string;
+  /** Absent on the comment that starts a thread. */
+  parentCommentId?: string;
+  status: CommentStatus;
+  /** Set once the message has been rewritten. */
+  lastEditedAt?: string;
+  /** The document the thread hangs on, always the published id. */
+  documentId: string;
+  documentType: string;
+  /** The field the thread hangs off, for example `title`. */
+  fieldPath: string;
+  /** Set when the comment is anchored to a run of text in a Portable Text field. */
+  selection?: CommentTextSelection;
+  /** A copy of the content the comment was written about. */
+  contentSnapshot?: unknown;
+  reactions: CommentReaction[];
+  /** Local only. Present while a create is failing or being retried. */
+  state?: CommentLocalState;
+}
+/**
+ * A thread: one comment plus its replies.
+ *
+ * Unlike the Studio, the SDK returns every thread it finds. The Studio hides
+ * threads whose field is gone from the schema or hidden by a conditional, which
+ * it can do because it has the schema. Check `fieldPath` yourself if your app
+ * needs the same behaviour.
+ * @beta
+ */
+interface CommentThread {
+  threadId: string;
+  /** The field the thread hangs off, taken from its first comment. */
+  fieldPath: string;
+  parentComment: Comment;
+  /** Oldest first. */
+  replies: Comment[];
+  /** The parent plus its replies. */
+  commentsCount: number;
+  /** Taken from the parent comment; replies follow it. */
+  status: CommentStatus;
+  /** `createdAt` of the most recent comment in the thread. */
+  lastActivityAt: string;
+}
+/** @beta */
+interface CreateCommentOptions extends DocumentHandle {
+  message: CommentMessage;
+  /**
+   * Which field the thread hangs off, for example `title` or
+   * `body[_key=="intro"].content`.
+   *
+   * Required, and it has to resolve to a real path. There is no such thing as a
+   * comment on a document as a whole: the Studio only ever creates field
+   * comments, and its comment inspector throws on an empty path rather than
+   * ignoring it, so a pathless comment takes the inspector down for everyone
+   * looking at that document.
+   */
+  fieldPath: string | Path;
+  /**
+   * Anchors the comment to a run of text inside a Portable Text field. Building
+   * one needs a live editor, so this comes from
+   * `@portabletext/plugin-sdk-value` rather than being constructed by hand.
+   */
+  selection?: CommentTextSelection;
+  /** Reuse the id of a failed comment to retry it. Defaults to a new id. */
+  commentId?: string;
+  /** Defaults to a new id, which starts a new thread. */
+  threadId?: string;
+  /** @defaultValue `'open'` */
+  status?: CommentStatus;
+  /**
+   * The `_rev` of the document when the comment was written.
+   *
+   * Not filled in automatically: the SDK's local document revision is replaced
+   * by a transaction id while an edit is in flight, so it can name a revision
+   * that never reached the server. Nothing in the Studio reads this today.
+   */
+  documentRevisionId?: string;
+  /**
+   * Ambient information stored alongside the comment, merged over the defaults.
+   *
+   * The Studio writes `tool`, `payload`, `intent`, and `notification` here for
+   * its notification backend. The SDK has no source for any of them, so
+   * mentions in comments created this way do not send email unless you supply
+   * `notification` yourself. Deliberately loose: the organization-level store
+   * treats this as free-form, so no shape is worth promising.
+   */
+  context?: Record<string, unknown>;
+  /** A copy of the content being discussed. References in it are weakened. */
+  contentSnapshot?: unknown;
+}
+/** @beta */
+interface ReplyToCommentOptions extends DocumentHandle {
+  /** The comment being replied to. Replies to a reply join the same thread. */
+  parentCommentId: string;
+  message: CommentMessage;
+  commentId?: string;
+  /** Only needed when the parent is not loaded, such as following a deep link. */
+  threadId?: string;
+  /** Only needed when the parent is not loaded. */
+  fieldPath?: string | Path;
+  /** Required when the parent is not loaded. */
+  status?: CommentStatus;
+}
+/** @beta */
+interface UpdateCommentOptions extends DatasetHandle {
+  commentId: string;
+  message: CommentMessage;
+}
+/** @beta */
+interface SetCommentStatusOptions extends DatasetHandle {
+  /** The thread's first comment. Replies follow their parent. */
+  commentId: string;
+  status: CommentStatus;
+}
+/** @beta */
+interface RemoveCommentOptions extends DatasetHandle {
+  commentId: string;
+}
+/**
+ * Starts a thread on a document, or on one of its fields.
+ *
+ * Creates the project's comments dataset if this is the first comment anywhere
+ * in it. The comment appears locally before the server confirms it; if the
+ * write fails it stays, carrying `_state.createError`, and retrying with the
+ * same `commentId` replaces it.
+ *
+ * @beta
+ */
+declare const createComment: (instance: SanityInstance, options: CreateCommentOptions) => Promise<Comment>;
+/**
+ * Adds a reply to an existing thread.
+ *
+ * The thread and field are taken from the parent comment, so a reply always
+ * matches the same list as the comment it answers. Supply them only when the
+ * parent is not loaded.
+ *
+ * @beta
+ */
+declare const replyToComment: (instance: SanityInstance, options: ReplyToCommentOptions) => Promise<Comment>;
+/**
+ * Rewrites a comment's message and stamps `lastEditedAt`.
+ * @beta
+ */
+declare const updateComment: (instance: SanityInstance, options: UpdateCommentOptions) => Promise<void>;
+/**
+ * Resolves or reopens a thread.
+ *
+ * Pass the thread's first comment: replies follow it, patched server-side in
+ * one query so a reply created by someone else at the same moment is caught
+ * too.
+ *
+ * @beta
+ */
+declare const setCommentStatus: (instance: SanityInstance, options: SetCommentStatusOptions) => Promise<void>;
+/**
+ * Deletes a comment, and its replies when it starts a thread.
+ * @beta
+ */
+declare const removeComment: (instance: SanityInstance, options: RemoveCommentOptions) => Promise<void>;
+/**
+ * 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;
+/**
+ * Which comments to read.
+ * @beta
+ */
+interface CommentsOptions extends DocumentHandle {
+  /**
+   * Narrow to one field. Omit to get every comment on the document.
+   */
+  fieldPath?: string | Path;
+  /** Narrow to open or resolved threads. Omit for both. */
+  status?: CommentStatus;
+}
+/** @beta */
+interface ResolveCommentsOptions extends CommentsOptions {
+  signal?: AbortSignal;
+}
+/**
+ * A stable string standing for one set of read options.
+ *
+ * Only React needs this: it holds one state source steady across renders and
+ * defers swapping to a new one while the previous list is still on screen.
+ * `fieldPath` is normalised on the way in, so a path array and the equivalent
+ * string address the same list.
+ *
+ * @internal
+ */
+declare function getCommentsOptionsKey(options: CommentsOptions): string;
+/** @internal */
+declare function parseCommentsOptionsKey(key: string): CommentsOptions;
+/**
+ * Every comment on a document, newest first.
+ *
+ * `undefined` until the first snapshot arrives. Replies are included; use
+ * {@link getCommentThreadsState} to read them grouped.
+ *
+ * @beta
+ */
+declare const getCommentsState: (instance: SanityInstance, options: CommentsOptions) => StateSource<Comment[] | undefined>;
+/**
+ * Threads on a document, newest thread first, each with its replies oldest first.
+ *
+ * A thread's `status` and `fieldPath` come from its first comment, so filtering
+ * by either selects whole threads rather than individual replies.
+ *
+ * @beta
+ */
+declare const getCommentThreadsState: (instance: SanityInstance, options: CommentsOptions) => StateSource<CommentThread[] | undefined>;
+/**
+ * Waits for a document's comments to load.
+ *
+ * Holds a subscriber only while resolving, so a component that suspends on this
+ * and then errors before mounting does not strand the list. Throw the promise
+ * for Suspense, then read through {@link getCommentsState}.
+ *
+ * @beta
+ */
+declare const resolveComments: (instance: SanityInstance, options: ResolveCommentsOptions) => Promise<Comment[]>;
+/**
+ * Waits for a document's comments to load, grouped into threads.
+ * @beta
+ */
+declare const resolveCommentThreads: (instance: SanityInstance, options: ResolveCommentsOptions) => Promise<CommentThread[]>;
+/**
+ * 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], import("@sanity/client").DatasetsResponse>, [options?: ProjectHandle<string> | undefined], StateSource<import("@sanity/client").DatasetsResponse | undefined>>;
+/** @public */
+declare const resolveDatasets: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], import("@sanity/client").DatasetsResponse>, [options?: ProjectHandle<string> | undefined], Promise<import("@sanity/client").DatasetsResponse>>;
+/**
+ * Represents an action to create a new document.
+ * Specifies the document type and optionally a document ID (which will be treated as the published ID).
+ * @beta
+ */
+interface CreateDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentTypeHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.create';
+  /**
+   * Optional initial field values for the document.
+   * These values will be set when the document is created.
+   * System fields (_id, _type, _rev, _createdAt, _updatedAt) are omitted as they are set automatically.
+   */
+  initialValue?: Partial<Omit<SanityDocument$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[];
+  /**
+   * When `true`, the given `patches` are forwarded verbatim to the server and
+   * applied as-is locally, instead of being re-derived by diffing document
+   * snapshots. This preserves the operational intent of the patches (e.g.
+   * keyed array inserts/unsets), which lets concurrent edits from other
+   * clients interleave coherently instead of being overwritten by
+   * position-based patches computed from a stale snapshot.
+   *
+   * Use this when the patches were produced by an editor that tracks its own
+   * operations (e.g. a collaborative text editor). During a rebase onto a
+   * changed remote document, preserved patches are re-applied operationally;
+   * if a patch can no longer apply, the transaction is skipped and reported
+   * as a `rebase-error` document event.
+   */
+  preserveOperations?: boolean;
+}
+/**
+ * Represents an action to publish the draft version of a document.
+ * Requires the full document handle.
+ * @beta
+ */
+interface PublishDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.publish';
+}
+/**
+ * Represents an action to unpublish a document, moving its published content to a draft.
+ * Requires the full document handle.
+ * @beta
+ */
+interface UnpublishDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.unpublish';
+}
+/**
+ * Represents an action to discard the draft changes of a document.
+ * Requires the full document handle.
+ * @beta
+ */
+interface DiscardDocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  type: 'document.discard';
+}
+/**
+ * Union type representing all possible document actions within the SDK.
+ * @beta
+ */
+type DocumentAction<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> = CreateDocumentAction<TDocumentType, TDataset, TProjectId> | DeleteDocumentAction<TDocumentType, TDataset, TProjectId> | EditDocumentAction<TDocumentType, TDataset, TProjectId> | PublishDocumentAction<TDocumentType, TDataset, TProjectId> | UnpublishDocumentAction<TDocumentType, TDataset, TProjectId> | DiscardDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Union of every action accepted by `applyDocumentActions` — both document-
+ * level actions and release-lifecycle actions.
+ * @beta
+ */
+type Action<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> = DocumentAction<TDocumentType, TDataset, TProjectId> | ReleaseAction;
+/**
+ * Creates a `CreateDocumentAction` object.
+ * @param doc - A handle identifying the document type, dataset, and project. An optional `documentId` can be provided.
+ * @param initialValue - Optional initial field values for the document. (System fields are omitted as they are set automatically.)
+ * @returns A `CreateDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function createDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>, initialValue?: Partial<Omit<SanityDocument$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>;
+/**
+ * Options for creating an `EditDocumentAction`.
+ * @beta
+ */
+interface EditDocumentOptions {
+  /**
+   * Forward the given patches verbatim instead of re-deriving them by
+   * diffing document snapshots. See {@link EditDocumentAction.preserveOperations}.
+   */
+  preserveOperations?: boolean;
+}
+/**
+ * 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`.
+ * @param options - Options controlling how the patches are processed.
+ * @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, options?: EditDocumentOptions): 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.
+ * @param options - Options controlling how the patches are processed.
+ * @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[], options?: EditDocumentOptions): EditDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates a `PublishDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document to be published.
+ * @returns A `PublishDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function publishDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>): PublishDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates an `UnpublishDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document to be unpublished.
+ * @returns An `UnpublishDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function unpublishDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>): UnpublishDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates a `DiscardDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document whose draft changes are to be discarded.
+ * @returns A `DiscardDocumentAction` object ready for dispatch.
+ * @beta
+ */
+declare function discardDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentHandle<TDocumentType, TDataset, TProjectId>): DiscardDocumentAction<TDocumentType, TDataset, TProjectId>;
+/**
+ * Creates a new release. The `releaseId` must be unique within the current
+ * retention period.
+ * @beta
+ */
+interface CreateReleaseAction extends ReleaseHandle {
+  type: 'release.create';
+  metadata: ReleaseDocument['metadata'];
+}
+/**
+ * Patches the metadata of an existing release.
+ * @beta
+ */
+interface EditReleaseAction extends ReleaseHandle {
+  type: 'release.edit';
+  patch: PatchOperations;
+}
+/**
+ * Publishes all version documents in a release.
+ * @beta
+ */
+interface PublishReleaseAction extends ReleaseHandle {
+  type: 'release.publish';
+}
+/**
+ * Schedules a release to be published at the given UTC time. Locks the
+ * version documents server-side until the release is unscheduled or published.
+ * @beta
+ */
+interface ScheduleReleaseAction extends ReleaseHandle {
+  type: 'release.schedule';
+  publishAt: string;
+}
+/**
+ * Unschedules a release that was previously scheduled, returning it to the
+ * active editable state.
+ * @beta
+ */
+interface UnscheduleReleaseAction extends ReleaseHandle {
+  type: 'release.unschedule';
+}
+/**
+ * Archives an active release. Version documents within the release are
+ * removed and no longer queryable, though still recoverable through history
+ * during the retention period.
+ * @beta
+ */
+interface ArchiveReleaseAction extends ReleaseHandle {
+  type: 'release.archive';
+}
+/**
+ * Restores an archived release. Only possible during the retention period.
+ * @beta
+ */
+interface UnarchiveReleaseAction extends ReleaseHandle {
+  type: 'release.unarchive';
+}
+/**
+ * Permanently deletes an archived or published release. To remove an active
+ * release, use the archive action first.
+ * @beta
+ */
+interface DeleteReleaseAction extends ReleaseHandle {
+  type: 'release.delete';
+}
+/**
+ * Union of all release actions that can be dispatched alongside document
+ * actions through `applyDocumentActions`.
+ * @beta
+ */
+type ReleaseAction = CreateReleaseAction | EditReleaseAction | PublishReleaseAction | ScheduleReleaseAction | UnscheduleReleaseAction | ArchiveReleaseAction | UnarchiveReleaseAction | DeleteReleaseAction;
+/** @beta */
+declare function createRelease(handle: ReleaseHandle, metadata?: ReleaseDocument['metadata']): CreateReleaseAction;
+/** @beta */
+declare function editRelease(handle: ReleaseHandle, patch: PatchOperations): EditReleaseAction;
+/** @beta */
+declare function publishRelease(handle: ReleaseHandle): PublishReleaseAction;
+/** @beta */
+declare function scheduleRelease(handle: ReleaseHandle, publishAt: string): ScheduleReleaseAction;
+/** @beta */
+declare function unscheduleRelease(handle: ReleaseHandle): UnscheduleReleaseAction;
+/** @beta */
+declare function archiveRelease(handle: ReleaseHandle): ArchiveReleaseAction;
+/** @beta */
+declare function unarchiveRelease(handle: ReleaseHandle): UnarchiveReleaseAction;
+/** @beta */
+declare function deleteRelease(handle: ReleaseHandle): DeleteReleaseAction;
+/**
+ * Split the entire path string on dots "outside" of any brackets.
+ *
+ * For example:
+ * ```
+ * "friends[0].name"
+ * ```
+ *
+ * becomes:
+ *
+ * ```
+ * [...ParseSegment<"friends[0]">, ...ParseSegment<"name">]
+ * ```
+ *
+ * (We use a simple recursion that splits on the first dot.)
+ */
+type PathParts<TPath extends string> = TPath extends `${infer Head}.${infer Tail}` ? [Head, ...PathParts<Tail>] : TPath extends '' ? [] : [TPath];
+/**
+ * Given a type T and an array of "access keys" Parts, recursively index into T.
+ *
+ * If a part is a key, it looks up that property.
+ * If T is an array and the part is a number, it "indexes" into the element type.
+ */
+type DeepGet<TValue, TPath extends readonly (string | number)[]> = TPath extends [] ? TValue : TPath extends readonly [infer THead, ...infer TTail] ? DeepGet<TValue extends undefined | null ? undefined : THead extends keyof TValue ? TValue[THead] : THead extends number ? TValue extends readonly (infer TElement)[] ? TElement | undefined : undefined : undefined // Key/index doesn't exist
+, TTail extends readonly (string | number)[] ? TTail : []> : never;
+/**
+ * Given a document type TDocument and a JSON Match path string TPath,
+ * compute the type found at that path.
+ * @beta
+ */
+type JsonMatch<TDocument, TPath extends string> = DeepGet<TDocument, PathParts<TPath>>;
+/**
+ * Represents a set of document that will go into `applyMutations`. Before
+ * applying a mutation, it's expected that all relevant documents that the
+ * mutations affect are included, including those that do not exist yet.
+ * Documents that don't exist have a `null` value.
+ */
+type DocumentSet<TDocument extends SanityDocument$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>;
+  /**
+   * The current user's identity (their user ID).
+   */
+  identity?: string;
+  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; };
+  /**
+   * transaction IDs recently submitted by this client for this document,
+   * newest last. used to label `remote-patches` events with the correct
+   * `origin` even after the corresponding `unverifiedRevisions` entry has
+   * been pruned (e.g. by a sync event that raced the listener echo). capped
+   * to the most recent entries.
+   */
+  recentOwnTransactionIds?: string[];
+}
+/**
+ * @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';
+  releaseCreate: 'sanity.action.release.create';
+  releaseEdit: 'sanity.action.release.edit';
+  releasePublish: 'sanity.action.release.publish';
+  releaseSchedule: 'sanity.action.release.schedule';
+  releaseUnschedule: 'sanity.action.release.unschedule';
+  releaseArchive: 'sanity.action.release.archive';
+  releaseUnarchive: 'sanity.action.release.unarchive';
+  releaseDelete: 'sanity.action.release.delete';
+};
+type OptimisticLock = {
+  ifDraftRevisionId?: string;
+  ifPublishedRevisionId?: string;
+};
+interface ReleaseMetadataPayload {
+  title?: string;
+  description?: string;
+  intendedPublishAt?: string;
+  releaseType?: 'asap' | 'scheduled' | 'undecided';
+  cardinality?: 'one' | 'many';
+}
+type HttpAction = {
+  actionType: ActionMap['create'];
+  publishedId: string;
+  attributes: SanityDocumentLike;
+} | {
+  actionType: ActionMap['discard'];
+  versionId: string;
+  purge?: boolean;
+} | {
+  actionType: ActionMap['unpublish'];
+  draftId: string;
+  publishedId: string;
+} | {
+  actionType: ActionMap['delete'];
+  publishedId: string;
+  includeDrafts?: string[];
+} | {
+  actionType: ActionMap['edit'];
+  draftId: string;
+  publishedId: string;
+  patch: PatchOperations;
+} | ({
+  actionType: ActionMap['publish'];
+  draftId: string;
+  publishedId: string;
+} & OptimisticLock) | {
+  actionType: ActionMap['releaseCreate'];
+  releaseId: string;
+  metadata?: ReleaseMetadataPayload;
+} | {
+  actionType: ActionMap['releaseEdit'];
+  releaseId: string;
+  patch: PatchOperations;
+} | {
+  actionType: ActionMap['releasePublish'];
+  releaseId: string;
+} | {
+  actionType: ActionMap['releaseSchedule'];
+  releaseId: string;
+  publishAt: string;
+} | {
+  actionType: ActionMap['releaseUnschedule'];
+  releaseId: string;
+} | {
+  actionType: ActionMap['releaseArchive'];
+  releaseId: string;
+} | {
+  actionType: ActionMap['releaseUnarchive'];
+  releaseId: string;
+} | {
+  actionType: ActionMap['releaseDelete'];
+  releaseId: string;
+};
+/**
+ * Represents a transaction that is queued to be applied but has not yet been
+ * applied. A transaction will remain in a queued state until all required
+ * documents for the transactions are available locally.
+ */
+interface QueuedTransaction {
+  /**
+   * the ID of this transaction. this is generated client-side.
+   */
+  transactionId: string;
+  /**
+   * the high-level actions associated with this transaction. note that these
+   * actions don't mention draft IDs and is meant to abstract away the draft
+   * model from users.
+   */
+  actions: Action[];
+  /**
+   * An optional flag set to disable this transaction from being batched with
+   * other transactions.
+   */
+  disableBatching?: boolean;
+}
+/**
+ * Represents a transaction that has been applied locally but has not been
+ * committed/transitioned-to-outgoing. These transactions are visible to the
+ * user but may be rebased upon a new working document set. Applied transactions
+ * also contain the resulting `outgoingActions` that will be submitted to
+ * Content Lake. These `outgoingActions` depend on the state of the working
+ * documents so they are recomputed on rebase and are only relevant to applied
+ * actions (we cannot compute `outgoingActions` for queued transactions because
+ * we haven't resolved the set of documents the actions are dependent on yet).
+ *
+ * In order to support better conflict resolution, the original `previous` set
+ * is saved as the `base` set.
+ */
+interface AppliedTransaction extends QueuedTransaction {
+  /**
+   * the resulting set of documents after the actions have been applied
+   */
+  working: DocumentSet;
+  /**
+   * the previous set of documents before the action was applied
+   */
+  previous: DocumentSet;
+  /**
+   * the original `previous` document set captured when this action was
+   * originally applied. this is used as a reference point to do a 3-way merge
+   * if this applied transaction ever needs to be reapplied on a different
+   * set of documents.
+   */
+  base: DocumentSet;
+  /**
+   * the `_rev`s from `previous` document set
+   */
+  previousRevs: { [TDocumentId in string]?: string; };
+  /**
+   * a timestamp for when this transaction was applied locally
+   */
+  timestamp: string;
+  /**
+   * the resulting HTTP actions derived from the state of the `working` document
+   * set. these are sent to Content Lake as-is when this transaction is batched
+   * and transitioned into an outgoing transaction.
+   */
+  outgoingActions: HttpAction[];
+  /**
+   * similar to `outgoingActions` but comprised of mutations instead of actions.
+   * Useful for debugging, and is also used by liveEdit documents to send mutations,
+   * since they can't use the Actions API which is pretty dependent on the draft model.
+   */
+  outgoingMutations: Mutation[];
+}
+/**
+ * Represents a set of applied transactions batched into a single outgoing
+ * transaction. An outgoing transaction is the result of batching many applied
+ * actions. An outgoing transaction may be reverted locally if the server
+ * does not accept it.
+ */
+interface OutgoingTransaction extends AppliedTransaction {
+  disableBatching: boolean;
+  batchedTransactionIds: string[];
+}
+interface UnverifiedDocumentRevision {
+  transactionId: string;
+  documentId: string;
+  previousRev: string | undefined;
+  timestamp: string;
+}
+/** @beta Response body from submitting an outgoing transaction (actions or mutations API). */
+type DocumentTransactionSubmissionResult = Awaited<ReturnType<SanityClient['action']>> | MultipleMutationResult;
+/** @beta */
+type DocumentEvent = ActionErrorEvent | TransactionRevertedEvent | TransactionAcceptedEvent | DocumentRebaseErrorEvent | DocumentEditedEvent | DocumentCreatedEvent | DocumentDeletedEvent | DocumentPublishedEvent | DocumentUnpublishedEvent | DocumentDiscardedEvent | DocumentRemotePatchesEvent;
+/**
+ * @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
+ * Event emitted when patches for a document are observed through the listener.
+ *
+ * Unlike the whole-document snapshots the store keeps, these are the raw patch
+ * operations from the transaction that produced the change, preserving the
+ * operational intent of the edit (e.g. keyed array inserts/unsets). Consumers
+ * that maintain their own local state, like collaborative text editors, can
+ * apply these directly instead of diffing document snapshots.
+ *
+ * `origin` is `'local'` when the transaction was submitted by this document
+ * store instance (an own edit observed back through the listener) and
+ * `'remote'` when it came from another client.
+ */
+interface DocumentRemotePatchesEvent {
+  type: 'remote-patches';
+  /** The ID of the document version the patches apply to (e.g. a draft ID). */
+  documentId: string;
+  /** The transaction ID that carried these patches. */
+  transactionId: string;
+  /** The revision the document was at before this transaction. */
+  previousRev?: string;
+  /** The timestamp of the transaction. */
+  timestamp: string;
+  /** The patch operations, rooted at the document. */
+  patches: PatchOperations[];
+  /** Whether the transaction originated from this client or another one. */
+  origin: 'local' | 'remote';
+}
+/** @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. Accepts both document actions and release
+   * lifecycle actions because they share the same transaction pipeline.
+   */
+  actions: Action[];
+  /**
+   * The resource to which the documents being acted on belong.
+   */
+  resource?: DocumentResource;
+  /**
+   * Optionally provide an ID to be used as this transaction ID
+   */
+  transactionId?: string;
+  /**
+   * Set this to true to prevent this action from being batched with others.
+   */
+  disableBatching?: boolean;
+}
+/** @beta */
+declare function applyDocumentActions<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ApplyDocumentActionsOptions): Promise<ActionsResult<SanityDocument$2<TDocumentType, `${TProjectId}.${TDataset}`>>>;
+/** @beta */
+declare function applyDocumentActions(instance: SanityInstance, options: ApplyDocumentActionsOptions): Promise<ActionsResult>;
+/**
+ * Returns the full release document ID for the given release name.
+ * e.g. `getReleaseDocumentId('my-release') === '_.releases.my-release'`
+ * @beta
+ */
+declare function getReleaseDocumentId(releaseId: string): string;
+/**
+ * @public
+ */
+interface FavoriteStatusResponse {
+  isFavorited: boolean;
+}
+/**
+ * @public
+ */
+interface FavoriteDocumentContext extends DocumentHandle {
+  resourceId: string;
+  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['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 OrganizationMember {
+  sanityUserId: string;
+  isCurrentUser: boolean;
+  user: {
+    id: string;
+    displayName: string;
+    familyName: string;
+    givenName: string;
+    middleName: string | null;
+    imageUrl: string | null;
+    email: string;
+    loginProvider: string;
+  };
+  roles: Array<{
+    name: string;
+    title: string;
+    description?: string;
+  }>;
+}
+/**
+ * The base fields returned from `/organizations/<id>` for every organization.
+ * @public
+ */
+interface OrganizationBase {
+  id: string;
+  name: string;
+  slug: string | null;
+  createdAt: string;
+  createdByUserId: string;
+  updatedAt: string;
+  deletedAt: string | null;
+  dashboardStatus: 'enabled' | 'disabled';
+  aiFeaturesStatus: 'enabled' | 'disabled';
+  mediaLibraryStatus: 'enabled' | 'disabled';
+  requestAccessStatus: 'allowed' | 'disabled';
+  telemetryConsentStatus: 'allowed' | 'msa_denied' | 'customer_denied';
+  oauthAppsStatus: 'allowed' | 'blocked';
+  defaultRoleName: string;
+  domains: string[] | null;
+}
+/** @public */
+interface OrganizationOptions<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false> {
+  includeMembers?: IncludeMembers;
+  includeFeatures?: IncludeFeatures;
+  organizationId: string;
+}
+/**
+ * An `Organization` with `members` and/or `features` conditionally included
+ * based on the query options used to fetch it.
+ * @public
+ */
+type Organization<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false> = OrganizationBase & (boolean extends IncludeMembers ? {
+  members?: OrganizationMember[];
+} : IncludeMembers extends true ? {
+  members: OrganizationMember[];
+} : unknown) & (boolean extends IncludeFeatures ? {
+  features?: string[];
+} : IncludeFeatures extends true ? {
+  features: string[];
+} : unknown);
+/**
+ * Public signature for the organization state source. The conditional generics
+ * cannot flow through `BoundStoreAction`, so we declare the signature here
+ * and assign the (already-correct) runtime function to it.
+ */
+type GetOrganizationState = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(instance: SanityInstance, options: OrganizationOptions<IncludeMembers, IncludeFeatures>) => StateSource<Organization<IncludeMembers, IncludeFeatures> | undefined>;
+type ResolveOrganization = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(instance: SanityInstance, options: OrganizationOptions<IncludeMembers, IncludeFeatures>) => Promise<Organization<IncludeMembers, IncludeFeatures>>;
+/** @public */
+declare const getOrganizationState: GetOrganizationState;
+/** @public */
+declare const resolveOrganization: ResolveOrganization;
+/**
+ * The list shape returned from `/organizations`, with `members` and/or
+ * `features` conditionally included based on the query options used.
+ * @public
+ */
+type Organizations<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false> = (Pick<OrganizationBase, 'id' | 'name' | 'slug' | 'createdAt' | 'updatedAt' | 'defaultRoleName' | 'dashboardStatus' | 'aiFeaturesStatus'> & (boolean extends IncludeMembers ? {
+  members?: OrganizationMember[];
+} : IncludeMembers extends true ? {
+  members: OrganizationMember[];
+} : unknown) & (boolean extends IncludeFeatures ? {
+  features?: string[];
+} : IncludeFeatures extends true ? {
+  features: string[];
+} : unknown))[];
+/** @public */
+interface OrganizationsOptions<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false> extends Omit<OrganizationOptions<IncludeMembers, IncludeFeatures>, 'organizationId'> {
+  /**
+   * When `true`, includes organisations the user has access to via
+   * project-level grants, not just direct organisation memberships.
+   */
+  includeImplicitMemberships?: boolean;
+}
+/**
+ * Public signature for the organization state source. The conditional generics
+ * cannot flow through `BoundStoreAction`, so we declare the signature here
+ * and assign the (already-correct) runtime function to it.
+ */
+type GetOrganizationsState = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(instance: SanityInstance, options?: OrganizationsOptions<IncludeMembers, IncludeFeatures>) => StateSource<Organizations<IncludeMembers, IncludeFeatures> | undefined>;
+type ResolveOrganizations = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(instance: SanityInstance, options?: OrganizationsOptions<IncludeMembers, IncludeFeatures>) => Promise<Organizations<IncludeMembers, IncludeFeatures>>;
+/** @public */
+declare const getOrganizationsState: GetOrganizationsState;
+/** @public */
+declare const resolveOrganizations: ResolveOrganizations;
+/**
+ * @public
+ */
+interface 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;
+}
+/**
+ * One end of a text selection: a Portable Text path plus a character offset
+ * within the span it addresses.
+ * @public
+ */
+interface PresenceSelectionPoint {
+  path: Path;
+  offset: number;
+}
+/**
+ * A Portable Text caret or selected range, as exchanged with the Studio.
+ *
+ * Structurally identical to `EditorSelection` from `@portabletext/editor`, and
+ * declared separately so that `@sanity/sdk` stays free of React dependencies. A
+ * value from the editor can be passed straight through, and vice versa.
+ *
+ * `offset` is a character offset within the span that `path` addresses.
+ * @public
+ */
+type PresenceSelection = {
+  anchor: PresenceSelectionPoint;
+  focus: PresenceSelectionPoint;
+  backward?: boolean;
+} | null;
+/**
+ * Somewhere a participant is, as it arrives over the wire.
+ *
+ * Prefer {@link DocumentPresence} from `getDocumentPresence`, which is scoped to one
+ * document, flattened for rendering, and types `path` accurately.
+ * @public
+ */
+interface PresenceLocation {
+  type: 'document';
+  /**
+   * The specific document the participant is in, so a draft, published, or version
+   * id rather than a bare document id.
+   */
+  documentId: string;
+  /**
+   * The focused field path, empty when they are in the document but not a field.
+   *
+   * Declared as `string[]`, but segments can also be numbers or `{_key: string}`
+   * objects when the focus is inside an array or a Portable Text field, because
+   * that is what other clients send. Guard for those rather than assuming strings.
+   * Widening the declared type is a breaking change, so it waits for the next major;
+   * {@link DocumentPresence.path} is typed correctly today.
+   */
+  path: string[];
+  /**
+   * When the participant said they were last active, on *their* clock.
+   *
+   * Fine for display, unreliable for deciding whether someone is still here: it is
+   * subject to clock skew between machines. Presence already drops participants that
+   * stop announcing, so a session appearing here is one the SDK still considers
+   * live.
+   */
+  lastActiveAt: string;
+  /** A Portable Text caret, when the focused field is a Portable Text field. */
+  selection?: PresenceSelection;
+}
+/**
+ * Which specific document a presence id resolves to.
+ *
+ * Presence compares exact document ids, so a client in a draft and a client in the
+ * published document are in different places even for the same `documentId`. Pass
+ * the perspective you are editing under and the SDK resolves it; the React hooks
+ * take it from `ResourceProvider` when you do not pass one.
+ * @public
+ */
+interface PresencePerspectiveOptions extends PerspectiveHandle {
+  /** Live-edit documents have no draft, so presence resolves to the published id. */
+  liveEdit?: boolean;
+}
+/**
+ * What an app reports about where the current user is.
+ *
+ * Omit `path` for document-level presence, or pass one for field-level presence.
+ * @public
+ */
+interface ReportPresenceOptions extends PresencePerspectiveOptions {
+  /**
+   * The document the user is in.
+   *
+   * Pass the plain document id; the perspective decides which specific document that
+   * resolves to. An already-specific id is accepted and re-resolved, so passing
+   * `drafts.abc` while the perspective is `published` reports the published document.
+   */
+  documentId: string;
+  /**
+   * The focused field path. Supports keyed and numeric segments, so array items
+   * and Portable Text spans can be addressed.
+   */
+  path?: Path;
+  /** A Portable Text caret, when the focused field is a Portable Text field. */
+  selection?: PresenceSelection;
+}
+/**
+ * One participant's session and everywhere it currently is.
+ *
+ * Keyed by session, not by user: the same person in two tabs is two entries with
+ * the same `user`.
+ * @public
+ */
+interface UserPresence {
+  user: SanityUser;
+  locations: PresenceLocation[];
+  /** Identifies one tab. Stable while that tab is open, and not reused. */
+  sessionId: string;
+}
+/**
+ * One participant at one location within a single document, flattened so it can
+ * be rendered directly against a field.
+ *
+ * Unlike {@link PresenceLocation.path}, `path` here is typed as a full `Path`, so
+ * keyed and numeric segments are described rather than cast away.
+ * @beta
+ */
+interface DocumentPresence {
+  user: SanityUser;
+  /** Identifies one tab, so the same person in two tabs appears twice. */
+  sessionId: string;
+  /**
+   * The specific document id this participant is in: a draft, published, or
+   * version id, depending on which perspective they are editing.
+   */
+  documentId: string;
+  /** The focused field path. Empty when they are in the document but no field. */
+  path: Path;
+  /**
+   * When they said they were last active, on *their* clock. Fine for display,
+   * unreliable for liveness. See {@link PresenceLocation.lastActiveAt}.
+   */
+  lastActiveAt: string;
+  /** The Portable Text caret, when they are focused in a Portable Text field. */
+  selection?: PresenceSelection;
+}
+/** @beta */
+interface DocumentPresenceOptions extends PresencePerspectiveOptions {
+  /**
+   * The document to look at. Resolved through the perspective exactly as
+   * {@link ReportPresenceOptions.documentId} is, so reads match writes.
+   */
+  documentId: string;
+  /**
+   * Narrows to participants at or below this field path. Omit it for everyone in
+   * the document.
+   */
+  path?: Path;
+  /**
+   * By default a draft, its published version, and any release versions are
+   * treated as the same document, which is what document lists want. Set this to
+   * compare ids exactly, which is what field-level indicators want so that a
+   * draft and a release version do not bleed into each other.
+   */
+  excludeVersions?: boolean;
+}
+/** @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[]>;
+/**
+ * Presence within a single document, flattened to one entry per participant per
+ * location so it can be rendered directly against a field.
+ *
+ * Reading presence never announces anything. Use `reportPresence` to make the
+ * current user visible to others.
+ *
+ * @param instance - the Sanity instance
+ * @param params - the document to look at, its perspective, an optional `path` to
+ *   narrow to a field subtree, and `excludeVersions` to compare document ids exactly
+ *
+ * @beta
+ */
+declare function getDocumentPresence(instance: SanityInstance, params: {
+  resource?: DocumentResource;
+} & DocumentPresenceOptions): StateSource<DocumentPresence[]>;
+/**
+ * Announces where the current user is, so other clients in the same project and
+ * dataset can show them. Reading presence never announces anything, so this is
+ * the only way an app becomes visible to others.
+ *
+ * Call it again whenever the user moves. Announcements are collapsed over a short
+ * window and then repeated every 30 seconds while idle, which is what tells peers
+ * the session is still alive.
+ *
+ * Which specific document each location resolves to depends on its perspective, and
+ * that matters for interoperability: other clients, the Studio included, compare
+ * exact document ids for field-level presence. Pass the perspective you are editing
+ * under rather than building a draft or version id yourself.
+ *
+ * @param instance - the Sanity instance
+ * @param params - the resource to announce on, plus the locations to report.
+ *   Pass one location with a `documentId` for document-level presence, add a
+ *   `path` for field-level presence, and pass an empty array to appear present
+ *   without being in any document.
+ *
+ * @beta
+ */
+declare function reportPresence(instance: SanityInstance, params: {
+  resource?: DocumentResource;
+  locations: ReportPresenceOptions[];
+}): void;
+/**
+ * @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 */
+interface ProjectMemberRole {
+  name: string;
+  title: string;
+  description: string;
+}
+/** @public */
+interface ProjectMember {
+  id: string;
+  createdAt: string;
+  updatedAt: string;
+  isCurrentUser: boolean;
+  isRobot: boolean;
+  roles: ProjectMemberRole[];
+}
+/** @public */
+interface ProjectMetadata {
+  color?: string;
+  externalStudioHost?: string;
+  initialTemplate?: string;
+  cliInitializedAt?: string;
+  integration: 'manage' | 'cli';
+}
+/**
+ * The base fields returned from `/projects` for every project.
+ * @public
+ */
+interface ProjectBase {
+  id: string;
+  displayName: string;
+  studioHost: string | null;
+  organizationId: string;
+  metadata: ProjectMetadata;
+  isBlocked: boolean;
+  isDisabled: boolean;
+  isDisabledByUser: boolean;
+  activityFeedEnabled: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+/**
+ * A `Project` with `members` and/or `features` conditionally included
+ * based on the query options used to fetch it.
+ * @public
+ */
+type Project<IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true> = ProjectBase & (boolean extends IncludeMembers ? {
+  members?: ProjectMember[];
+} : IncludeMembers extends true ? {
+  members: ProjectMember[];
+} : unknown) & (boolean extends IncludeFeatures ? {
+  features?: string[];
+} : IncludeFeatures extends true ? {
+  features: string[];
+} : unknown);
+/** @public */
+interface ProjectOptions<IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true> extends ProjectHandle {
+  includeMembers?: IncludeMembers;
+  includeFeatures?: IncludeFeatures;
+}
+/**
+ * Public signature for the project state source. The conditional generics
+ * cannot flow through `BoundStoreAction`, so we declare the signature here
+ * and assign the (already-correct) runtime function to it.
+ */
+type GetProjectState = <IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true>(instance: SanityInstance, options?: ProjectOptions<IncludeMembers, IncludeFeatures>) => StateSource<Project<IncludeMembers, IncludeFeatures> | undefined>;
+type ResolveProject = <IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true>(instance: SanityInstance, options?: ProjectOptions<IncludeMembers, IncludeFeatures>) => Promise<Project<IncludeMembers, IncludeFeatures>>;
+/** @public */
+declare const getProjectState: GetProjectState;
+/** @public */
+declare const resolveProject: ResolveProject;
+interface ProjectionOptions<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  projection: TProjection;
+}
+/**
+ * @beta
+ */
+declare function getProjectionState<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): StateSource<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>> | undefined>;
+/**
+ * @beta
+ */
+declare function getProjectionState<TData extends object>(instance: SanityInstance, options: ProjectionOptions): StateSource<ProjectionValuePending<TData> | undefined>;
+/**
+ * @beta
+ */
+declare function getProjectionState(instance: SanityInstance, options: ProjectionOptions): StateSource<ProjectionValuePending<Record<string, unknown>> | undefined>;
+/** @beta */
+declare function resolveProjection<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): Promise<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>>>;
+/** @beta */
+declare function resolveProjection<TData extends object>(instance: SanityInstance, options: ProjectionOptions): Promise<ProjectionValuePending<TData>>;
+/** @public */
+interface ProjectsOptions<IncludeMembers extends boolean = false, IncludeFeatures extends boolean = true> {
+  organizationId?: string;
+  includeMembers?: IncludeMembers;
+  includeFeatures?: IncludeFeatures;
+  onlyExplicitMembership?: boolean;
+}
+/**
+ * Public signature for the projects state source. The conditional generics
+ * cannot flow through `BoundStoreAction`, so we declare the signature here
+ * and assign the (already-correct) runtime function to it.
+ */
+type GetProjectsState = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = true>(instance: SanityInstance, options?: ProjectsOptions<IncludeMembers, IncludeFeatures>) => StateSource<Project<IncludeMembers, IncludeFeatures>[] | undefined>;
+type ResolveProjects = <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = true>(instance: SanityInstance, options?: ProjectsOptions<IncludeMembers, IncludeFeatures>) => Promise<Project<IncludeMembers, IncludeFeatures>[]>;
+/** @public */
+declare const getProjectsState: GetProjectsState;
+/** @public */
+declare const resolveProjects: ResolveProjects;
+/**
+ * @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.
+ * It registers a temporary subscriber for the lifetime of the resolution (released shortly after the promise
+ * settles), so the query state participates in normal cleanup even when no lasting subscriber ever attaches —
+ * e.g. when a suspended component errors before committing. 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 other 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>;
+/**
+ * Lifecycle states a release document can be in. Mirrors the server's
+ * `ReleaseState`.
+ * @beta
+ */
+type ReleaseState = 'active' | 'archiving' | 'unarchiving' | 'archived' | 'published' | 'publishing' | 'scheduled' | 'scheduling';
+interface ReleasesStoreState {
+  activeReleases?: ReleaseDocument[];
+  allReleases?: ReleaseDocument[];
+  error?: unknown;
+}
+/**
+ * Get the active releases from the store.
+ * @internal
+ */
+declare const getActiveReleasesState: (instance: SanityInstance, options?: {
+  resource?: DocumentResource;
+}) => StateSource<ReleaseDocument[] | undefined>;
+/**
+ * Get every release in the store, including archived and published.
+ * @internal
+ */
+declare const getAllReleasesState: (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 { parseQueryKey as $, MediaLibrarySource as $i, UnpublishDocumentAction as $n, CommentTextSelection as $r, OrganizationsOptions as $t, CORE_SDK_VERSION as A, AgentPromptResult as Ai, getPermissionsState as An, getCommentThreadsState as Ar, DisconnectEvent as At, getUsersState as B, SanityInstance as Bi, CreateReleaseAction as Bn, ReplyToCommentOptions as Br, TransportEvent as Bt, SanityProject$1 as C, OrgVerificationResult as Ci, DocumentTransactionSubmissionResult as Cn, LoggerConfig as Cr, PreviewValue as Ct, jsonMatch$1 as D, AgentPatchOptions as Di, DocumentOptions as Dn, createProjectHandle as Dr, getDocumentPresence as Dt, joinPaths as E, AgentGenerateResult as Ei, TransactionRevertedEvent as En, createDocumentTypeHandle as Er, ValidProjection as Et, defineIntent as F, agentGenerate as Fi, PermissionDeniedReason as Fn, resolveComments as Fr, PresenceSelection as Ft, parseUsersKey as G, DatasetHandle as Gi, EditDocumentAction as Gn, replyToComment as Gr, ResolveUserOptions as Gt, resolveUser as H, isStudioConfig as Hi, DeleteReleaseAction as Hn, UpdateCommentOptions as Hr, GetUserOptions as Ht, createGroqSearchFilter as I, agentPatch as Ii, JsonMatch as In, Selector as Ir, PresenceSelectionPoint as It, getActiveReleasesState as J, DocumentHandle as Ji, PublishDocumentAction as Jn, Comment as Jr, SanityUserResponse as Jt, getPerspectiveState as K, DatasetResource as Ki, EditDocumentOptions as Kn, setCommentStatus as Kr, ResolveUsersOptions as Kt, FetcherStore as L, agentPrompt as Li, Action as Ln, StateSource as Lr, ReportPresenceOptions as Lt, getCorsErrorProjectId as M, AgentTransformResult as Mi, resolvePermissions as Mn, getCommentsState as Mr, DocumentPresenceOptions as Mt, Intent as N, AgentTranslateOptions as Ni, subscribeDocumentEvents as Nn, parseCommentsOptionsKey as Nr, PresenceLocation as Nt, slicePath$1 as O, AgentPatchResult as Oi, getDocumentState as On, CommentsOptions as Or, getPresence as Ot, IntentFilter as P, AgentTranslateResult as Pi, DocumentPermissionsResult as Pn, resolveCommentThreads as Pr, PresencePerspectiveOptions as Pt, getQueryState as Q, MediaLibraryResource as Qi, UnarchiveReleaseAction as Qn, CommentStatus as Qr, Organizations as Qt, FetcherStoreState as R, agentTransform as Ri, ArchiveReleaseAction as Rn, CreateCommentOptions as Rr, RollCallEvent as Rt, SanityDocument$3 as S, observeOrganizationVerificationState as Si, DocumentRemotePatchesEvent as Sn, Logger as Sr, PreviewStoreState as St, getPathDepth as T, AgentGenerateOptions as Ti, TransactionAcceptedEvent as Tn, createDocumentHandle as Tr, ProjectionValuePending as Tt, resolveUsers as U, CanvasResource$1 as Ui, DiscardDocumentAction as Un, createComment as Ur, GetUsersOptions as Ut, loadMoreUsers as V, createSanityInstance as Vi, DeleteDocumentAction as Vn, SetCommentStatusOptions as Vr, UserPresence as Vt, getUsersKey as W, CanvasSource as Wi, DocumentAction as Wn, removeComment as Wr, Membership as Wt, QueryOptions as X, DocumentSource as Xi, ReleaseAction as Xn, CommentMessage as Xr, UsersGroupState as Xt, getAllReleasesState as Y, DocumentResource as Yi, PublishReleaseAction as Yn, CommentLocalState as Yr, UserProfile as Yt, getQueryKey as Z, DocumentTypeHandle as Zi, ScheduleReleaseAction as Zn, CommentReaction as Zr, UsersStoreState as Zt, getTokenState as _, ClientStoreState as _i, DocumentDeletedEvent as _n, configureLogging as _r, PREVIEW_PROJECTION as _t, isProjectUserNotFoundClientError as a, StudioConfig as aa, getOrCreateNode as ai, OrganizationOptions as an, deleteRelease as ar, getProjectionState as at, ReleaseDocument$1 as b, logout as bi, DocumentEvent as bn, LogLevel as br, PreviewMedia as bt, ErrorAuthState as c, isCanvasSource as ca, destroyController as ci, FavoriteStatusResponse as cn, editRelease as cr, ProjectMember as ct, LoggingInAuthState as d, isMediaLibraryResource as da, releaseChannel as di, getReleaseDocumentId as dn, scheduleRelease as dr, ProjectOptions as dt, PerspectiveHandle as ea, CommentTextSelectionItem as ei, getOrganizationsState as en, UnscheduleReleaseAction as er, resolveQuery as et, getAuthState as f, isMediaLibrarySource as fa, FrameMessage as fi, ActionsResult as fn, unarchiveRelease as fr, getProjectState as ft, getLoginUrlState as g, ClientOptions as gi, DocumentCreatedEvent as gn, resolveDatasets as gr, transformProjectionToPreview as gt, getIsInDashboardState as h, WindowMessage as hi, ActionErrorEvent as hn, getDatasetsState as hr, resolvePreview as ht, getClientErrorApiType as i, SanityConfig as ia, ComlinkNodeState as ii, OrganizationMember as in, deleteDocument as ir, resolveProjection as it, isImportError as j, AgentTransformOptions as ji, resolveDocument as jn, getCommentsOptionsKey as jr, DocumentPresence as jt, stringifyPath$1 as k, AgentPromptOptions as ki, getDocumentSyncStatus as kn, ResolveCommentsOptions as kr, reportPresence as kt, LoggedInAuthState as l, isDatasetResource as la, getOrCreateChannel as li, getFavoritesState as ln, publishDocument as lr, ProjectMemberRole as lt, getDashboardOrganizationId as m, AuthProvider as ma, RequestNewTokenMessage as mi, applyDocumentActions as mn, unscheduleRelease as mr, ResolvePreviewOptions as mt, getClientErrorApiBody as n, ReleaseHandle as na, NodeState as ni, Organization as nn, createDocument as nr, getProjectsState as nt, AuthState as o, TokenSource as oa, releaseNode as oi, getOrganizationState as on, discardDocument as or, Project as ot, getCurrentUserState as p, AuthConfig as pa, NewTokenResponseMessage as pi, ApplyDocumentActionsOptions as pn, unpublishDocument as pr, resolveProject as pt, ReleaseState as q, DatasetSource as qi, EditReleaseAction as qn, updateComment as qr, SanityUser as qt, getClientErrorApiDescription as r, ReleasePerspective as ra, getNodeState as ri, OrganizationBase as rn, createRelease as rr, resolveProjects as rt, AuthStoreState as s, isCanvasResource as sa, ComlinkControllerState as si, resolveOrganization as sn, editDocument as sr, ProjectBase as st, ApiErrorBody as t, ProjectHandle as ta, CommentThread as ti, resolveOrganizations as tn, archiveRelease as tr, ProjectsOptions as tt, LoggedOutAuthState as u, isDatasetSource as ua, getOrCreateController as ui, resolveFavoritesState as un, publishRelease as ur, ProjectMetadata as ut, setAuthToken as v, getClient as vi, DocumentDiscardedEvent as vn, InstanceContext as vr, GetPreviewStateOptions as vt, getIndexForKey$1 as w, AuthStateType as wi, DocumentUnpublishedEvent as wn, createDatasetHandle as wr, ValuePending as wt, Role as x, handleAuthCallback as xi, DocumentPublishedEvent as xn, LogNamespace as xr, PreviewQueryResult as xt, CurrentUser$1 as y, getClientState as yi, DocumentEditedEvent as yn, LogContext as yr, getPreviewState as yt, getUserState as z, agentTranslate as zi, CreateDocumentAction as zn, RemoveCommentOptions as zr, StateEvent as zt };
+//# sourceMappingURL=utils-BMwA8Kg9.d.ts.map