@sanity/sdk-react 3.1.0 → 3.2.0

package/dist/index.d.ts

@@ -1,13 +1,11 @@
 import { DatasetsResponse, DatasetsResponse as DatasetsResponse$1, SanityProjectMember } from "@sanity/client";
-import { AccessResourceType, ActionsResult, Application, ApplicationInclude, ApplicationsOptions, ApplicationsResponse, AuthState, ClientOptions, Comment, CommentThread, CommentsOptions, CreateCommentOptions, CurrentUser, DatasetHandle, DocumentAction, DocumentEvent, DocumentHandle as DocumentHandle$1, DocumentOptions, DocumentPermissionsResult, DocumentPresence, DocumentResource, DocumentTypeHandle as DocumentTypeHandle$1, FavoriteStatusResponse, GetUserOptions, GetUsersOptions, Installation, InstallationInclude, InstallationsOptions, InstallationsResponse, JsonMatch, Organization, OrganizationOptions, Organizations, OrganizationsOptions, PresenceSelection, PreviewValue, Project, ProjectHandle, ProjectOptions, ProjectsOptions, QueryOptions, ReleaseAction, ReleaseDocument, RemoveCommentOptions, ReplyToCommentOptions, SanityConfig, SanityInstance, SanityUser, SetCommentStatusOptions, TokenSource, UpdateCommentOptions, UserPresence } from "@sanity/sdk";
+import { AccessResourceType, ActionsResult, Application, ApplicationInclude, ApplicationsOptions, ApplicationsResponse, AuthState, ClientOptions, Comment, CommentThread, CommentsOptions, CreateCommentOptions, CurrentUser, DatasetHandle, DocumentAction, DocumentEvent, DocumentHandle as DocumentHandle$1, DocumentOptions, DocumentPermissionsResult, DocumentPresence, DocumentResource, DocumentTypeHandle as DocumentTypeHandle$1, FavoriteStatusResponse, GetUserOptions, GetUsersOptions, Installation, InstallationInclude, InstallationsOptions, InstallationsResponse, JsonMatch, Organization, OrganizationOptions, Organizations, OrganizationsOptions, PresenceSelection, PreviewValue, Project, ProjectHandle, ProjectOptions, ProjectsOptions, QueryOptions, ReleaseAction, ReleaseDocument, RemoveCommentOptions, ReplyToCommentOptions, ResolveDocument, ResolveProjectionResult, ResolveQueryResult, SanityConfig, SanityInstance, SanityUser, SetCommentStatusOptions, TokenSource, UpdateCommentOptions, UserPresence } from "@sanity/sdk";
 import "@sanity/sdk/_internal";
 import React$1, { PropsWithChildren, ReactElement, ReactNode } from "react";
 import { FallbackProps } from "react-error-boundary";
 import { CanvasResource, MediaResource, StudioResource } from "@sanity/message-protocol";
 import { FrameMessage, WindowMessage } from "@sanity/sdk/comlink";
-import "xstate";
 import { AgentGenerateOptions, AgentPatchOptions, AgentPatchResult, AgentPromptOptions, AgentPromptResult, AgentTransformOptions, AgentTranslateOptions } from "@sanity/sdk/agent";
-import { SanityDocument as SanityDocument$1, SanityProjectionResult, SanityQueryResult } from "groq";
 import { Path, SanityDocument, SortOrderingItem, SortOrderingItem as SortOrderingItem$1 } from "@sanity/types";
 export * from "@sanity/sdk";
 /**
@@ -80,7 +78,7 @@ interface AuthBoundaryProps {
  *
  * @internal
  */
-declare function AuthBoundary({ LoginErrorComponent, ...props }: AuthBoundaryProps): React.ReactNode;
+export declare function AuthBoundary({ LoginErrorComponent, ...props }: AuthBoundaryProps): React.ReactNode;
 /**
  * @public
  * @category Types
@@ -190,7 +188,7 @@ interface SanityAppProps {
  * }
  * ```
  */
-declare function SanityApp({ children, fallback, config: configProp, ...props }: SanityAppProps): ReactElement;
+export declare function SanityApp({ children, fallback, config: configProp, ...props }: SanityAppProps): ReactElement;
 /**
  * @internal
  */
@@ -207,7 +205,7 @@ interface SDKProviderProps extends AuthBoundaryProps {
  *
  * Top-level context provider that provides access to the Sanity SDK.
  */
-declare function SDKProvider({ children, config, fallback, inferMediaLibraryAndCanvas, ...props }: SDKProviderProps): ReactElement;
+export declare function SDKProvider({ children, config, fallback, inferMediaLibraryAndCanvas, ...props }: SDKProviderProps): ReactElement;
 /**
  * React SDK resource handle — extends the core DatasetHandle with `resourceName`
  * for context-based resource resolution.
@@ -249,7 +247,7 @@ interface DocumentHandle<TDocumentType extends string = string, TDataset extends
  * It is used to automatically request a new token on 401 error if enabled.
  * @public
  */
-declare const ComlinkTokenRefreshProvider: React$1.FC<PropsWithChildren>;
+export declare const ComlinkTokenRefreshProvider: React$1.FC<PropsWithChildren>;
 interface RenderSanitySDKAppOptions {
   reactStrictMode?: boolean;
 }
@@ -260,7 +258,7 @@ interface NamedSources {
   [key: string]: SanityConfig;
 }
 /** @internal */
-declare function renderSanityApp(rootElement: HTMLElement | null, namedSources: NamedSources, options: RenderSanitySDKAppOptions, children: React.ReactNode): () => void;
+export declare function renderSanityApp(rootElement: HTMLElement | null, namedSources: NamedSources, options: RenderSanitySDKAppOptions, children: React.ReactNode): () => void;
 /**
  * Props for the ResourceProvider component
  * @internal
@@ -294,7 +292,7 @@ interface ResourceProviderProps extends SanityConfig {
  * </ResourceProvider>
  * ```
  */
-declare function ResourceProvider({ children, fallback, resource, ...config }: ResourceProviderProps): React.ReactNode;
+export declare function ResourceProvider({ children, fallback, resource, ...config }: ResourceProviderProps): React.ReactNode;
 /**
  * Props for the SanityInstanceProvider component
  * @public
@@ -349,7 +347,7 @@ interface SanityInstanceProviderProps {
  *
  * @category Components
  */
-declare function SanityInstanceProvider({ instance, fallback, children }: SanityInstanceProviderProps): React.ReactNode;
+export declare function SanityInstanceProvider({ instance, fallback, children }: SanityInstanceProviderProps): React.ReactNode;
 /**
  * Minimal duck-typed interface representing a Sanity Studio workspace.
  * The Studio's `Workspace` type satisfies this naturally — no import
@@ -415,7 +413,7 @@ interface StudioWorkspaceHandle {
  *
  * @public
  */
-declare const SDKStudioContext: import("react").Context<StudioWorkspaceHandle | null>;
+export declare const SDKStudioContext: import("react").Context<StudioWorkspaceHandle | null>;
 /**
  * The value returned by a fetcher-backed hook. The hook suspends until the
  * first fetch succeeds, so `data` is always present once your component renders.
@@ -445,7 +443,7 @@ interface FetcherHookResult<TData> {
  * @param permissions - The permission names to check.
  * @returns The result envelope `{data, isFetching, error, refetch}`.
  */
-declare const useCheckPermissions: <Permission extends string>(resourceType: AccessResourceType, resourceId: string, permissions: Permission[]) => FetcherHookResult<Record<Permission, boolean>>;
+export declare const useCheckPermissions: <Permission extends string>(resourceType: AccessResourceType, resourceId: string, permissions: Permission[]) => FetcherHookResult<Record<Permission, boolean>>;
 interface Subscription {
   unsubscribe(): void;
 }
@@ -525,7 +523,7 @@ interface Subscribable<T> {
  *
  * @category Agent Actions
  */
-declare function useAgentGenerate(resourceHandle?: ResourceHandle): (options: AgentGenerateOptions) => Subscribable<unknown>;
+export declare function useAgentGenerate(resourceHandle?: ResourceHandle): (options: AgentGenerateOptions) => Subscribable<unknown>;
 /**
  * @alpha
  * Transforms an existing document or selected fields using Sanity Agent Actions.
@@ -597,7 +595,7 @@ declare function useAgentGenerate(resourceHandle?: ResourceHandle): (options: Ag
  *
  * @category Agent Actions
  */
-declare function useAgentTransform(resourceHandle?: ResourceHandle): (options: AgentTransformOptions) => Subscribable<unknown>;
+export declare function useAgentTransform(resourceHandle?: ResourceHandle): (options: AgentTransformOptions) => Subscribable<unknown>;
 /**
  * @alpha
  * Translates documents or fields using Sanity Agent Actions.
@@ -688,7 +686,7 @@ declare function useAgentTransform(resourceHandle?: ResourceHandle): (options: A
  *
  * @category Agent Actions
  */
-declare function useAgentTranslate(resourceHandle?: ResourceHandle): (options: AgentTranslateOptions) => Subscribable<unknown>;
+export declare function useAgentTranslate(resourceHandle?: ResourceHandle): (options: AgentTranslateOptions) => Subscribable<unknown>;
 /**
  * @alpha
  * Prompts the Content Agent using the same instruction template format as other agent actions.
@@ -783,7 +781,7 @@ declare function useAgentTranslate(resourceHandle?: ResourceHandle): (options: A
  *
  * @category Agent Actions
  */
-declare function useAgentPrompt(resourceHandle?: ResourceHandle): (options: AgentPromptOptions) => Promise<AgentPromptResult>;
+export declare function useAgentPrompt(resourceHandle?: ResourceHandle): (options: AgentPromptOptions) => Promise<AgentPromptResult>;
 /**
  * @alpha
  * Schema-aware patching with Sanity Agent Actions.
@@ -933,7 +931,7 @@ declare function useAgentPrompt(resourceHandle?: ResourceHandle): (options: Agen
  *
  * @category Agent Actions
  */
-declare function useAgentPatch(resourceHandle?: ResourceHandle): (options: AgentPatchOptions) => Promise<AgentPatchResult>;
+export declare function useAgentPatch(resourceHandle?: ResourceHandle): (options: AgentPatchOptions) => Promise<AgentPatchResult>;
 /**
  * Returns a single application by id.
  *
@@ -946,7 +944,7 @@ declare function useAgentPatch(resourceHandle?: ResourceHandle): (options: Agent
  * @param options - Optional `include` list to expand related resources.
  * @returns The result envelope `{data, isFetching, error, refetch}`.
  */
-declare const useApplication: <Include extends ApplicationInclude = never>(applicationId: string, options?: {
+export declare const useApplication: <Include extends ApplicationInclude = never>(applicationId: string, options?: {
   include?: Include[];
 }) => FetcherHookResult<Application<Include>>;
 /**
@@ -960,7 +958,7 @@ declare const useApplication: <Include extends ApplicationInclude = never>(appli
  * @param options - Filter and include options for the applications list.
  * @returns The result envelope `{data, isFetching, error, refetch}`.
  */
-declare const useApplications: <Include extends ApplicationInclude = never>(options: ApplicationsOptions<Include>) => FetcherHookResult<ApplicationsResponse<Include>>;
+export declare const useApplications: <Include extends ApplicationInclude = never>(options: ApplicationsOptions<Include>) => FetcherHookResult<ApplicationsResponse<Include>>;
 /**
  * The value returned by a mutation-backed hook. The write-side counterpart to
  * {@link FetcherHookResult}: local `{mutate, isPending, error, data, reset}`
@@ -991,14 +989,14 @@ interface MutationHookResult<TInput, TResult> {
  * @internal
  * @returns The mutation envelope `{mutate, isPending, error, data, reset}`.
  */
-declare const useDeleteApplication: () => MutationHookResult<import("@sanity/sdk").DeleteApplicationInput, import("@sanity/sdk").DeletedResult>;
+export declare const useDeleteApplication: () => MutationHookResult<import("@sanity/sdk").DeleteApplicationInput, import("@sanity/sdk").DeletedResult>;
 /**
  * Updates an application's mutable properties (title, icon, visibility).
  *
  * @internal
  * @returns The mutation envelope `{mutate, isPending, error, data, reset}`.
  */
-declare const useUpdateApplication: () => MutationHookResult<import("@sanity/sdk").UpdateApplicationInput, import("@sanity/sdk").ApplicationBase>;
+export declare const useUpdateApplication: () => MutationHookResult<import("@sanity/sdk").UpdateApplicationInput, import("@sanity/sdk").ApplicationBase>;
 /**
  * @internal
  * A React hook that subscribes to authentication state changes.
@@ -1020,13 +1018,13 @@ declare const useUpdateApplication: () => MutationHookResult<import("@sanity/sdk
  * }
  * ```
  */
-declare const useAuthState: () => AuthState;
+export declare const useAuthState: () => AuthState;
 /**
  * Hook to get the currently logged in user
  * @internal
  * @returns The current user or null if not authenticated
  */
-declare const useAuthToken: () => string | null;
+export declare const useAuthToken: () => string | null;
 type UseCurrentUser = {
   /**
    * @public
@@ -1055,7 +1053,7 @@ type UseCurrentUser = {
  * @function
  * @TODO This should not return null — users of a custom app will always be authenticated via Core
  */
-declare const useCurrentUser: UseCurrentUser;
+export declare const useCurrentUser: UseCurrentUser;
 /**
  * @internal
  * A React hook that returns a function for handling authentication callbacks.
@@ -1096,17 +1094,17 @@ declare const useCurrentUser: UseCurrentUser;
  * @returns A callback handler function that processes OAuth redirects
  * @public
  */
-declare const useHandleAuthCallback: () => (locationHref?: string | undefined) => Promise<string | false>;
+export declare const useHandleAuthCallback: () => (locationHref?: string | undefined) => Promise<string | false>;
 /**
  * @internal
  */
-declare function useLoginUrl(): string;
+export declare function useLoginUrl(): string;
 /**
  * Hook to log out of the current session
  * @internal
  * @returns A function to log out of the current session
  */
-declare const useLogOut: () => () => Promise<void>;
+export declare const useLogOut: () => () => Promise<void>;
 /**
  * Hook that verifies the current projects belongs to the organization ID specified in the dashboard context.
  *
@@ -1127,7 +1125,7 @@ declare const useLogOut: () => () => Promise<void>;
  * }
  * ```
  */
-declare function useVerifyOrgProjects(disabled?: boolean, projectIds?: string[]): string | null;
+export declare function useVerifyOrgProjects(disabled?: boolean, projectIds?: string[]): string | null;
 /**
  * A React hook that provides a client that subscribes to changes in your application,
  *
@@ -1155,7 +1153,12 @@ declare function useVerifyOrgProjects(disabled?: boolean, projectIds?: string[])
  * @public
  * @function
  */
-declare const useClient: (options: ClientOptions) => import("@sanity/client").SanityClient;
+export declare const useClient: (options: ClientOptions) => import("@sanity/client").SanityClient;
+declare global {
+  interface SymbolConstructor {
+    readonly observable: symbol;
+  }
+}
 /**
  * @public
  */
@@ -1195,7 +1198,7 @@ interface FrameConnection<TFrameMessage extends FrameMessage> {
 /**
  * @internal
  */
-declare function useFrameConnection<TFrameMessage extends FrameMessage, TWindowMessage extends WindowMessage>(options: UseFrameConnectionOptions<TWindowMessage>): FrameConnection<TFrameMessage>;
+export declare function useFrameConnection<TFrameMessage extends FrameMessage, TWindowMessage extends WindowMessage>(options: UseFrameConnectionOptions<TWindowMessage>): FrameConnection<TFrameMessage>;
 /**
  * @internal
  */
@@ -1230,7 +1233,7 @@ interface WindowConnection<TMessage extends WindowMessage> {
  * Generally not to be used directly, but to be used as a dependency of
  * Comlink-powered hooks like `useStudioWorkspacesByProjectIdDataset`.
  */
-declare function useWindowConnection<TWindowMessage extends WindowMessage, TFrameMessage extends FrameMessage>({ name, connectTo, onMessage }: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage>;
+export declare function useWindowConnection<TWindowMessage extends WindowMessage, TFrameMessage extends FrameMessage>({ name, connectTo, onMessage }: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage>;
 /**
  * Adds React hook support (resourceName resolution) to core types.
  * Prefer using the React-layer handle types (ResourceHandle, DocumentHandle)
@@ -1302,7 +1305,7 @@ interface CommentActions {
  *
  * @public
  */
-declare function useCommentActions(): CommentActions;
+export declare function useCommentActions(): CommentActions;
 /**
  * @public
  * @category Types
@@ -1346,7 +1349,7 @@ interface UseCommentsResult {
  *
  * @public
  */
-declare function useComments(options: WithResourceNameSupport<CommentsOptions>): UseCommentsResult;
+export declare function useComments(options: WithResourceNameSupport<CommentsOptions>): UseCommentsResult;
 /**
  * @public
  * @category Types
@@ -1397,7 +1400,7 @@ interface UseCommentThreadsResult {
  *
  * @public
  */
-declare function useCommentThreads(options: WithResourceNameSupport<CommentsOptions>): UseCommentThreadsResult;
+export declare function useCommentThreads(options: WithResourceNameSupport<CommentsOptions>): UseCommentThreadsResult;
 /**
  * Returns the currently active `DocumentResource` for the nearest resource context.
  *
@@ -1415,7 +1418,7 @@ declare function useCommentThreads(options: WithResourceNameSupport<CommentsOpti
  * console.log(resource?.projectId, resource?.dataset)
  * ```
  */
-declare function useResource(): DocumentResource | undefined;
+export declare function useResource(): DocumentResource | undefined;
 /**
  * Retrieves the current Sanity instance from context
  *
@@ -1436,7 +1439,7 @@ declare function useResource(): DocumentResource | undefined;
  *
  * @throws Error if no SanityInstance is found in context
  */
-declare const useSanityInstance: () => SanityInstance;
+export declare const useSanityInstance: () => SanityInstance;
 /**
  * Props shared by {@link useFavorite} and {@link useUpdateFavorite}: a document
  * handle plus the resource it lives in.
@@ -1474,7 +1477,7 @@ interface UseFavoriteProps extends DocumentHandle$1 {
  * }
  * ```
  */
-declare function useFavorite(props: UseFavoriteProps): boolean;
+export declare function useFavorite(props: UseFavoriteProps): boolean;
 interface DocumentInteractionHistory {
   recordEvent: (eventType: 'viewed' | 'edited' | 'created' | 'deleted') => void;
 }
@@ -1531,7 +1534,7 @@ interface UseRecordDocumentHistoryEventProps extends DocumentHandle$1 {
  * }
  * ```
  */
-declare function useRecordDocumentHistoryEvent({ documentId, documentType, resourceType, resourceId, schemaName }: UseRecordDocumentHistoryEventProps): DocumentInteractionHistory;
+export declare function useRecordDocumentHistoryEvent({ documentId, documentType, resourceType, resourceId, schemaName }: UseRecordDocumentHistoryEventProps): DocumentInteractionHistory;
 interface DashboardResource {
   id: string;
   name: string;
@@ -1584,7 +1587,7 @@ interface StudioWorkspacesResult {
  * }
  * ```
  */
-declare function useStudioWorkspacesByProjectIdDataset(): StudioWorkspacesResult;
+export declare function useStudioWorkspacesByProjectIdDataset(): StudioWorkspacesResult;
 /**
  * The value returned by {@link useUpdateFavorite}.
  *
@@ -1641,7 +1644,7 @@ interface UpdateFavorite {
  * }
  * ```
  */
-declare function useUpdateFavorite(props: UseFavoriteProps): UpdateFavorite;
+export declare function useUpdateFavorite(props: UseFavoriteProps): UpdateFavorite;
 /**
  * Returns metadata for each dataset the current user has access to.
  *
@@ -1672,12 +1675,12 @@ declare function useUpdateFavorite(props: UseFavoriteProps): UpdateFavorite;
  * 4. `instance.config`.
  * @public
  */
-declare function useDatasets(options?: ProjectHandle): FetcherHookResult<DatasetsResponse$1>;
+export declare function useDatasets(options?: ProjectHandle): FetcherHookResult<DatasetsResponse$1>;
 /**
  * @public
  */
 interface UseApplyDocumentActions {
-  (): <TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(action: DocumentAction<TDocumentType, TDataset, TProjectId> | DocumentAction<TDocumentType, TDataset, TProjectId>[], options?: ResourceHandle) => Promise<ActionsResult<SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`>>>;
+  (): <TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(action: DocumentAction<TDocumentType, TDataset, TProjectId> | DocumentAction<TDocumentType, TDataset, TProjectId>[], options?: ResourceHandle) => Promise<ActionsResult<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>>>;
 }
 /**
  * @public
@@ -1855,14 +1858,14 @@ interface UseApplyDocumentActions {
  *       perspective: {releaseName: 'summer-drop'},
  *     })
  *
- *     apply(editDocument(docHandle, {title: 'Updated for release'}))
+ *     apply(editDocument(docHandle, {set: {title: 'Updated for release'}}))
  *   }
  *
  *   return <button onClick={handleEdit}>Edit in Release</button>
  * }
  * ```
  */
-declare const useApplyDocumentActions: UseApplyDocumentActions;
+export declare const useApplyDocumentActions: UseApplyDocumentActions;
 type IgnoredKey = '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt';
 /**
  * Optional per-call overrides for {@link useCreateDocument}'s create function.
@@ -1883,7 +1886,7 @@ interface CreateDocumentOverrides {
  * @returns A function that creates the document. It accepts optional initial field values and an optional `{documentId}` override,
  *          and resolves to the {@link DocumentHandle} of the created document (carrying the generated or supplied id).
  */
-declare function useCreateDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>): (initialValue?: Partial<Omit<SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`>, IgnoredKey>>, overrides?: CreateDocumentOverrides) => Promise<DocumentHandle<TDocumentType, TDataset, TProjectId>>;
+export declare function useCreateDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>): (initialValue?: Partial<Omit<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>, IgnoredKey>>, overrides?: CreateDocumentOverrides) => Promise<DocumentHandle<TDocumentType, TDataset, TProjectId>>;
 /**
  * @public
  * Create a new document with an explicit type `TData`.
@@ -1892,18 +1895,18 @@ declare function useCreateDocument<TDocumentType extends string = string, TDatas
  * @returns A function that creates the document. It accepts optional initial field values (typed against `TData`) and an
  *          optional `{documentId}` override, and resolves to the {@link DocumentHandle} of the created document.
  */
-declare function useCreateDocument<TData extends Record<string, unknown>>(options: DocumentTypeHandle): (initialValue?: Partial<Omit<TData, IgnoredKey>>, overrides?: CreateDocumentOverrides) => Promise<DocumentHandle>;
+export declare function useCreateDocument<TData extends Record<string, unknown>>(options: DocumentTypeHandle): (initialValue?: Partial<Omit<TData, IgnoredKey>>, overrides?: CreateDocumentOverrides) => Promise<DocumentHandle>;
 type UseDocumentOptions<TPath extends string | undefined = undefined, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> = DocumentHandle<TDocumentType, TDataset, TProjectId> & {
   path?: TPath;
 };
 interface UseDocument {
   /** @internal */
   <TDocumentType extends string, TDataset extends string, TProjectId extends string = string>(options: UseDocumentOptions<undefined, TDocumentType, TDataset, TProjectId>): {
-    data: SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`> | null;
+    data: ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`> | null;
   };
   /** @internal */
   <TPath extends string, TDocumentType extends string, TDataset extends string = string, TProjectId extends string = string>(options: UseDocumentOptions<TPath, TDocumentType>): {
-    data: JsonMatch<SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined;
+    data: JsonMatch<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined;
   };
   /** @internal */
   <TData>(options: DocumentOptions<undefined>): {
@@ -1976,9 +1979,9 @@ interface UseDocument {
    * @inlineType DocumentOptions
    */
   <TPath extends string | undefined = undefined, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: UseDocumentOptions<TPath, TDocumentType>): TPath extends string ? {
-    data: JsonMatch<SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined;
+    data: JsonMatch<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined;
   } : {
-    data: SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`> | null;
+    data: ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`> | null;
   };
   /**
    * @public
@@ -2075,7 +2078,7 @@ interface UseDocument {
  *
  * @function
  */
-declare const useDocument: UseDocument;
+export declare const useDocument: UseDocument;
 /**
  * @public
  */
@@ -2137,7 +2140,7 @@ interface UseDocumentEventOptions<TDataset extends string = string, TProjectId e
  * }
  * ```
  */
-declare function useDocumentEvent<TDataset extends string = string, TProjectId extends string = string>(options: UseDocumentEventOptions<TDataset, TProjectId>): void;
+export declare function useDocumentEvent<TDataset extends string = string, TProjectId extends string = string>(options: UseDocumentEventOptions<TDataset, TProjectId>): void;
 /**
  *
  * @public
@@ -2215,7 +2218,7 @@ declare function useDocumentEvent<TDataset extends string = string, TProjectId e
  * }
  * ```
  */
-declare function useDocumentPermissions(actionOrActions: WithResourceNameSupport<DocumentAction> | WithResourceNameSupport<DocumentAction>[]): DocumentPermissionsResult;
+export declare function useDocumentPermissions(actionOrActions: WithResourceNameSupport<DocumentAction> | WithResourceNameSupport<DocumentAction>[]): DocumentPermissionsResult;
 type UseDocumentSyncStatus = {
   /**
    * Exposes the document's sync status between local and remote document states.
@@ -2255,7 +2258,7 @@ type UseDocumentSyncStatus = {
  * @public
  * @function
  */
-declare const useDocumentSyncStatus: UseDocumentSyncStatus;
+export declare const useDocumentSyncStatus: UseDocumentSyncStatus;
 type Updater<TValue> = TValue | ((currentValue: TValue) => TValue);
 /**
  * @public
@@ -2265,7 +2268,7 @@ type Updater<TValue> = TValue | ((currentValue: TValue) => TValue);
  * @returns A stable function to update the document state. Accepts either the new document state or an updater function `(currentValue) => nextValue`.
  *          Returns a promise resolving to the {@link ActionsResult}.
  */
-declare function useEditDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>): (nextValue: Updater<SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`>>) => Promise<ActionsResult<SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`>>>;
+export declare function useEditDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>): (nextValue: Updater<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>>) => Promise<ActionsResult<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>>>;
 /**
  * @public
  * Edit a specific path within a document, relying on Typegen for the type.
@@ -2274,7 +2277,7 @@ declare function useEditDocument<TDocumentType extends string = string, TDataset
  * @returns A stable function to update the value at the specified path. Accepts either the new value or an updater function `(currentValue) => nextValue`.
  *          Returns a promise resolving to the {@link ActionsResult}.
  */
-declare function useEditDocument<TPath extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>): (nextValue: Updater<JsonMatch<SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`>, TPath>>) => Promise<ActionsResult<SanityDocument$1<TDocumentType, `${TProjectId}.${TDataset}`>>>;
+export declare function useEditDocument<TPath extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>): (nextValue: Updater<JsonMatch<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>, TPath>>) => Promise<ActionsResult<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>>>;
 /**
  * @public
  * Edit an entire document with an explicit type `TData`.
@@ -2283,7 +2286,7 @@ declare function useEditDocument<TPath extends string = string, TDocumentType ex
  * @returns A stable function to update the document state. Accepts either the new document state (`TData`) or an updater function `(currentValue: TData) => nextValue: TData`.
  *          Returns a promise resolving to the {@link ActionsResult}.
  */
-declare function useEditDocument<TData>(options: DocumentOptions<undefined>): (nextValue: Updater<TData>) => Promise<ActionsResult>;
+export declare function useEditDocument<TData>(options: DocumentOptions<undefined>): (nextValue: Updater<TData>) => Promise<ActionsResult>;
 /**
  * @public
  * Edit a specific path within a document with an explicit type `TData`.
@@ -2292,7 +2295,7 @@ declare function useEditDocument<TData>(options: DocumentOptions<undefined>): (n
  * @returns A stable function to update the value at the specified path. Accepts either the new value (`TData`) or an updater function `(currentValue: TData) => nextValue: TData`.
  *          Returns a promise resolving to the {@link ActionsResult}.
  */
-declare function useEditDocument<TData>(options: DocumentOptions<string>): (nextValue: Updater<TData>) => Promise<ActionsResult>;
+export declare function useEditDocument<TData>(options: DocumentOptions<string>): (nextValue: Updater<TData>) => Promise<ActionsResult>;
 /**
  * Configuration options for the useDocuments hook
  *
@@ -2459,7 +2462,7 @@ interface DocumentsResponse<TDocumentType extends string = string, TDataset exte
  * }
  * ```
  */
-declare function useDocuments<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>({ batchSize, params, search, filter, orderings, documentType, ...rawOptions }: DocumentsOptions<TDocumentType, TDataset, TProjectId>): DocumentsResponse<TDocumentType, TDataset, TProjectId>;
+export declare function useDocuments<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>({ batchSize, params, search, filter, orderings, documentType, ...rawOptions }: DocumentsOptions<TDocumentType, TDataset, TProjectId>): DocumentsResponse<TDocumentType, TDataset, TProjectId>;
 /**
  * Returns a single installation by id.
  *
@@ -2472,7 +2475,7 @@ declare function useDocuments<TDocumentType extends string = string, TDataset ex
  * @param options - Optional `include` list to expand related resources.
  * @returns The result envelope `{data, isFetching, error, refetch}`.
  */
-declare const useInstallation: <Include extends InstallationInclude = never>(installationId: string, options?: {
+export declare const useInstallation: <Include extends InstallationInclude = never>(installationId: string, options?: {
   include?: Include[];
 }) => FetcherHookResult<Installation<Include>>;
 /**
@@ -2486,7 +2489,7 @@ declare const useInstallation: <Include extends InstallationInclude = never>(ins
  * @param options - Filter and include options for the installations list.
  * @returns The result envelope `{data, isFetching, error, refetch}`.
  */
-declare const useInstallations: <Include extends InstallationInclude = never>(options: InstallationsOptions<Include>) => FetcherHookResult<InstallationsResponse<Include>>;
+export declare const useInstallations: <Include extends InstallationInclude = never>(options: InstallationsOptions<Include>) => FetcherHookResult<InstallationsResponse<Include>>;
 /**
  * Returns metadata for a given organisation.
  *
@@ -2511,7 +2514,7 @@ declare const useInstallations: <Include extends InstallationInclude = never>(op
  * @public
  * @function
  */
-declare const useOrganization: <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(options: OrganizationOptions<IncludeMembers, IncludeFeatures>) => FetcherHookResult<Organization<IncludeMembers, IncludeFeatures>>;
+export declare const useOrganization: <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(options: OrganizationOptions<IncludeMembers, IncludeFeatures>) => FetcherHookResult<Organization<IncludeMembers, IncludeFeatures>>;
 /**
  * Returns metadata for each organisation the current user has access to.
  *
@@ -2541,7 +2544,7 @@ declare const useOrganization: <IncludeMembers extends boolean = false, IncludeF
  * @public
  * @function
  */
-declare const useOrganizations: <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(options?: OrganizationsOptions<IncludeMembers, IncludeFeatures>) => FetcherHookResult<Organizations<IncludeMembers, IncludeFeatures>>;
+export declare const useOrganizations: <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = false>(options?: OrganizationsOptions<IncludeMembers, IncludeFeatures>) => FetcherHookResult<Organizations<IncludeMembers, IncludeFeatures>>;
 /**
  * Configuration options for the usePaginatedDocuments hook
  *
@@ -2740,7 +2743,7 @@ interface PaginatedDocumentsResponse<TDocumentType extends string = string, TDat
  * // <PaginatedDocumentList dataset={myDatasetHandle} documentType="post" />
  * ```
  */
-declare function usePaginatedDocuments<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>({ documentType, filter, pageSize, params, orderings, search, ...rawOptions }: PaginatedDocumentsOptions<TDocumentType, TDataset, TProjectId>): PaginatedDocumentsResponse<TDocumentType, TDataset, TProjectId>;
+export declare function usePaginatedDocuments<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>({ documentType, filter, pageSize, params, orderings, search, ...rawOptions }: PaginatedDocumentsOptions<TDocumentType, TDataset, TProjectId>): PaginatedDocumentsResponse<TDocumentType, TDataset, TProjectId>;
 /**
  * Every participant in the current project and dataset, or Canvas.
  *
@@ -2758,7 +2761,7 @@ declare function usePaginatedDocuments<TDocumentType extends string = string, TD
  *
  * @public
  */
-declare function usePresence(options?: ResourceHandle): {
+export declare function usePresence(options?: ResourceHandle): {
   locations: UserPresence[];
 };
 /** @beta */
@@ -2808,7 +2811,7 @@ interface UsePresenceForDocumentOptions extends DocumentHandle {
  *
  * @beta
  */
-declare function usePresenceForDocument(options: UsePresenceForDocumentOptions): {
+export declare function usePresenceForDocument(options: UsePresenceForDocumentOptions): {
   presence: DocumentPresence[];
 };
 /** @beta */
@@ -2874,7 +2877,7 @@ interface UseReportPresenceOptions extends DocumentHandle {
  *
  * @beta
  */
-declare function useReportPresence(options: UseReportPresenceOptions): void;
+export declare function useReportPresence(options: UseReportPresenceOptions): void;
 /**
  * @public
  * @category Types
@@ -2952,7 +2955,7 @@ interface useDocumentPreviewResults {
  * )
  * ```
  */
-declare function useDocumentPreview({ ref, ...docHandle }: useDocumentPreviewOptions): useDocumentPreviewResults;
+export declare function useDocumentPreview({ ref, ...docHandle }: useDocumentPreviewOptions): useDocumentPreviewResults;
 /**
  * @public
  * @category Types
@@ -3000,19 +3003,19 @@ interface useDocumentProjectionResults<TData> {
  * @param options - Options including the document handle properties (`documentId`, `documentType`, etc.) and the `projection`.
  * @returns The projected data, typed based on Typegen.
  *
- * @example Using Typegen for a book preview
+ * @example Using an existing experimental Typegen file for a book preview
  * ```tsx
  * // ProjectionComponent.tsx
- * import {useDocumentProjection, type DocumentHandle} from '@sanity/sdk-react'
+ * import {defineProjection, useDocumentProjection, type DocumentHandle} from '@sanity/sdk-react'
  * import {useRef} from 'react'
- * import {defineProjection} from 'groq'
  *
  * // Define props using DocumentHandle with the specific document type
  * type ProjectionComponentProps = {
  *   doc: DocumentHandle<'book'> // Typegen knows 'book'
  * }
  *
- * // This is required for typegen to generate the correct return type
+ * // Keep the projection string identical to its entry in the existing generated file.
+ * // Current Typegen does not scan defineProjection imported from the SDK.
  * const myProjection = defineProjection(`{
  *   title,
  *   'coverImage': cover.asset->url,
@@ -3048,7 +3051,7 @@ interface useDocumentProjectionResults<TData> {
  * // </Suspense>
  * ```
  */
-declare function useDocumentProjection<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: useDocumentProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): useDocumentProjectionResults<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>>;
+export declare function useDocumentProjection<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: useDocumentProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): useDocumentProjectionResults<ResolveProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>>;
 /**
  * @public
  * Fetch a projection with an explicitly defined return type `TData`.
@@ -3094,7 +3097,7 @@ declare function useDocumentProjection<TProjection extends string = string, TDoc
  * // </Suspense>
  * ```
  */
-declare function useDocumentProjection<TData extends object>(options: useDocumentProjectionOptions): useDocumentProjectionResults<TData>;
+export declare function useDocumentProjection<TData extends object>(options: useDocumentProjectionOptions): useDocumentProjectionResults<TData>;
 /**
  * Returns metadata for a given project.
  *
@@ -3131,7 +3134,7 @@ declare function useDocumentProjection<TData extends object>(options: useDocumen
  * @public
  * @function
  */
-declare const useProject: <IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true>(options?: ProjectOptions<IncludeMembers, IncludeFeatures>) => FetcherHookResult<Project<IncludeMembers, IncludeFeatures>>;
+export declare const useProject: <IncludeMembers extends boolean = true, IncludeFeatures extends boolean = true>(options?: ProjectOptions<IncludeMembers, IncludeFeatures>) => FetcherHookResult<Project<IncludeMembers, IncludeFeatures>>;
 /**
  * Returns metadata for each project you have access to.
  *
@@ -3163,7 +3166,7 @@ declare const useProject: <IncludeMembers extends boolean = true, IncludeFeature
  * @public
  * @function
  */
-declare const useProjects: <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = true>(options?: ProjectsOptions<IncludeMembers, IncludeFeatures>) => FetcherHookResult<Project<IncludeMembers, IncludeFeatures>[]>;
+export declare const useProjects: <IncludeMembers extends boolean = false, IncludeFeatures extends boolean = true>(options?: ProjectsOptions<IncludeMembers, IncludeFeatures>) => FetcherHookResult<Project<IncludeMembers, IncludeFeatures>[]>;
 /**
  * Hook options for useQuery, supporting both direct resource and resourceName.
  * @beta
@@ -3224,9 +3227,9 @@ type UseQueryOptions<TQuery extends string = string, TDataset extends string = s
  * }
  * ```
  */
-declare function useQuery<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: UseQueryOptions<TQuery, TDataset, TProjectId>): {
+export declare function useQuery<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string>(options: UseQueryOptions<TQuery, TDataset, TProjectId>): {
   /** The query result, typed based on the GROQ query string */
-  data: SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`>;
+  data: ResolveQueryResult<TQuery, `${TProjectId}.${TDataset}`>;
   /** True if a query transition is in progress */
   isPending: boolean;
 };
@@ -3258,7 +3261,7 @@ declare function useQuery<TQuery extends string = string, TDataset extends strin
  * }
  * ```
  */
-declare function useQuery<TData>(options: WithResourceNameSupport<QueryOptions>): {
+export declare function useQuery<TData>(options: WithResourceNameSupport<QueryOptions>): {
   /** The query result, cast to the provided type TData */
   data: TData;
   /** True if another query is resolving in the background (suspense handles the initial loading state) */
@@ -3280,7 +3283,7 @@ declare function useQuery<TData>(options: WithResourceNameSupport<QueryOptions>)
  * const activeReleases = useActiveReleases()
  * ```
  */
-declare function useActiveReleases(options?: WithResourceNameSupport<DatasetHandle> | undefined): ReleaseDocument[];
+export declare function useActiveReleases(options?: WithResourceNameSupport<DatasetHandle> | undefined): ReleaseDocument[];
 /**
  * @public
  * @function
@@ -3306,7 +3309,7 @@ declare function useActiveReleases(options?: WithResourceNameSupport<DatasetHand
  * const releases = useAllReleases()
  * ```
  */
-declare function useAllReleases(options?: WithResourceNameSupport<DatasetHandle> | undefined): ReleaseDocument[];
+export declare function useAllReleases(options?: WithResourceNameSupport<DatasetHandle> | undefined): ReleaseDocument[];
 /**
  * @public
  */
@@ -3380,12 +3383,12 @@ interface UseApplyReleaseActions {
  * }
  * ```
  */
-declare const useApplyReleaseActions: UseApplyReleaseActions;
+export declare const useApplyReleaseActions: UseApplyReleaseActions;
 /**
  * @public
  * @function
  */
-declare function usePerspective(perspectiveHandle?: ResourceHandle): string | string[];
+export declare function usePerspective(perspectiveHandle?: ResourceHandle): string | string[];
 /**
  * @public
  * @category Types
@@ -3432,7 +3435,7 @@ interface UserResult {
  * )
  * ```
  */
-declare function useUser(options: GetUserOptions): UserResult;
+export declare function useUser(options: GetUserOptions): UserResult;
 /**
  * @public
  * @category Types
@@ -3493,11 +3496,11 @@ interface UsersResult {
  * 3. The active resource (`ResourceProvider`/`SDKProvider`)
  * 4. `instance.config`.
  */
-declare function useUsers(options?: GetUsersOptions): UsersResult;
+export declare function useUsers(options?: GetUsersOptions): UsersResult;
 /**
  * This version is provided by pkg-utils at build time
  * @internal
  */
-declare const REACT_SDK_VERSION: {};
-export { AuthBoundary, type AuthBoundaryProps, type Status as ComlinkStatus, ComlinkTokenRefreshProvider, type CommentActions, type CreateDocumentOverrides, type DatasetsResponse, type DocumentHandle, type DocumentTypeHandle, type DocumentsOptions, type DocumentsResponse, type FetcherHookResult, type FrameConnection, type FrameMessageHandler as MessageHandler, type MutationHookResult, type PaginatedDocumentsOptions, type PaginatedDocumentsResponse, REACT_SDK_VERSION, type ResourceHandle, ResourceProvider, type ResourceProviderProps, SDKProvider, type SDKProviderProps, SDKStudioContext, SanityApp, type SanityAppProps, type SanityDocument, SanityInstanceProvider, type SanityInstanceProviderProps, type SanityProjectMember, type SortOrderingItem, type StudioWorkspaceHandle, type UseCommentThreadsResult, type UseCommentsResult, type UseFrameConnectionOptions, type UsePresenceForDocumentOptions, type UseReportPresenceOptions, type UseWindowConnectionOptions, type UserResult, type UsersResult, type WindowConnection, type WindowMessageHandler, renderSanityApp, useActiveReleases, useAgentGenerate, useAgentPatch, useAgentPrompt, useAgentTransform, useAgentTranslate, useAllReleases, useApplication, useApplications, useApplyDocumentActions, useApplyReleaseActions, useAuthState, useAuthToken, useCheckPermissions, useClient, useCommentActions, useCommentThreads, useComments, useCreateDocument, useCurrentUser, useDatasets, useDeleteApplication, useDocument, useDocumentEvent, useDocumentPermissions, useDocumentPreview, type useDocumentPreviewOptions, type useDocumentPreviewResults, useDocumentProjection, type useDocumentProjectionOptions, type useDocumentProjectionResults, useDocumentSyncStatus, useDocuments, useEditDocument, useFavorite, useFrameConnection, useHandleAuthCallback, useInstallation, useInstallations, useLogOut, useLoginUrl, useOrganization, useOrganizations, usePaginatedDocuments, usePerspective, usePresence, usePresenceForDocument, useProject, useProjects, useQuery, useRecordDocumentHistoryEvent, useReportPresence, useResource, useSanityInstance, useStudioWorkspacesByProjectIdDataset, useUpdateApplication, useUpdateFavorite, useUser, useUsers, useVerifyOrgProjects, useWindowConnection };
+export declare const REACT_SDK_VERSION: {};
+export type { AuthBoundaryProps, Status as ComlinkStatus, CommentActions, CreateDocumentOverrides, DatasetsResponse, DocumentHandle, DocumentTypeHandle, DocumentsOptions, DocumentsResponse, FetcherHookResult, FrameConnection, FrameMessageHandler as MessageHandler, MutationHookResult, PaginatedDocumentsOptions, PaginatedDocumentsResponse, ResourceHandle, ResourceProviderProps, SDKProviderProps, SanityAppProps, SanityDocument, SanityInstanceProviderProps, SanityProjectMember, SortOrderingItem, StudioWorkspaceHandle, UseCommentThreadsResult, UseCommentsResult, UseFrameConnectionOptions, UsePresenceForDocumentOptions, UseReportPresenceOptions, UseWindowConnectionOptions, UserResult, UsersResult, WindowConnection, WindowMessageHandler, useDocumentPreviewOptions, useDocumentPreviewResults, useDocumentProjectionOptions, useDocumentProjectionResults };
 //# sourceMappingURL=index.d.ts.map