@sanity/sdk-react 2.14.1 → 2.16.0

package/dist/index.d.ts

@@ -1,62 +1,63 @@
-import {ActionsResult} from '@sanity/sdk'
-import {AgentGenerateOptions} from '@sanity/sdk'
-import {AgentPatchOptions} from '@sanity/sdk'
-import {AgentPatchResult} from '@sanity/sdk'
-import {AgentPromptOptions} from '@sanity/sdk'
-import {AgentPromptResult} from '@sanity/sdk'
-import {AgentTransformOptions} from '@sanity/sdk'
-import {AgentTranslateOptions} from '@sanity/sdk'
-import {AuthState} from '@sanity/sdk'
-import {CanvasResource} from '@sanity/message-protocol'
-import {ClientOptions} from '@sanity/sdk'
-import {Context} from 'react'
-import {CurrentUser} from '@sanity/sdk'
-import {DatasetHandle} from '@sanity/sdk'
-import {DatasetsResponse} from '@sanity/client'
-import {DocumentAction} from '@sanity/sdk'
-import {DocumentEvent} from '@sanity/sdk'
-import {DocumentHandle as DocumentHandle_2} from '@sanity/sdk'
-import {DocumentOptions} from '@sanity/sdk'
-import {DocumentPermissionsResult} from '@sanity/sdk'
-import {DocumentResource} from '@sanity/sdk'
-import {DocumentTypeHandle as DocumentTypeHandle_2} from '@sanity/sdk'
-import {FallbackProps} from 'react-error-boundary'
-import {FavoriteStatusResponse} from '@sanity/sdk'
-import {FrameMessage} from '@sanity/sdk'
-import {GetUserOptions} from '@sanity/sdk'
-import {GetUsersOptions} from '@sanity/sdk'
-import {JsonMatch} from '@sanity/sdk'
-import {MediaResource} from '@sanity/message-protocol'
-import {Organization} from '@sanity/sdk'
-import {OrganizationOptions} from '@sanity/sdk'
-import {Organizations} from '@sanity/sdk'
-import {OrganizationsOptions} from '@sanity/sdk'
-import {PathChangeMessage} from '@sanity/message-protocol'
-import {PreviewValue} from '@sanity/sdk'
-import {Project} from '@sanity/sdk'
-import {ProjectOptions} from '@sanity/sdk'
-import {ProjectsOptions} from '@sanity/sdk'
-import {PropsWithChildren} from 'react'
-import {QueryOptions} from '@sanity/sdk'
-import {default as React_2} from 'react'
-import {ReactElement} from 'react'
-import {ReactNode} from 'react'
-import {ReleaseAction} from '@sanity/sdk'
-import {ReleaseDocument} from '@sanity/sdk'
-import {SanityClient} from '@sanity/client'
-import {SanityConfig} from '@sanity/sdk'
-import {SanityDocument} from '@sanity/types'
-import {SanityDocument as SanityDocument_2} from 'groq'
-import {SanityInstance} from '@sanity/sdk'
-import {SanityProjectionResult} from 'groq'
-import {SanityProjectMember} from '@sanity/client'
-import {SanityQueryResult} from 'groq'
-import {SanityUser} from '@sanity/sdk'
-import {SortOrderingItem} from '@sanity/types'
-import {StudioResource} from '@sanity/message-protocol'
-import {TokenSource} from '@sanity/sdk'
-import {UserPresence} from '@sanity/sdk'
-import {WindowMessage} from '@sanity/sdk'
+import { ActionsResult } from "@sanity/sdk";
+import { AgentGenerateOptions } from "@sanity/sdk";
+import { AgentPatchOptions } from "@sanity/sdk";
+import { AgentPatchResult } from "@sanity/sdk";
+import { AgentPromptOptions } from "@sanity/sdk";
+import { AgentPromptResult } from "@sanity/sdk";
+import { AgentTransformOptions } from "@sanity/sdk";
+import { AgentTranslateOptions } from "@sanity/sdk";
+import { AuthState } from "@sanity/sdk";
+import { CanvasResource } from "@sanity/message-protocol";
+import { ClientOptions } from "@sanity/sdk";
+import { Context } from "react";
+import { CurrentUser } from "@sanity/sdk";
+import { DatasetHandle } from "@sanity/sdk";
+import { DatasetsResponse } from "@sanity/client";
+import { DocumentAction } from "@sanity/sdk";
+import { DocumentEvent } from "@sanity/sdk";
+import { DocumentHandle as DocumentHandle_2 } from "@sanity/sdk";
+import { DocumentOptions } from "@sanity/sdk";
+import { DocumentPermissionsResult } from "@sanity/sdk";
+import { DocumentResource } from "@sanity/sdk";
+import { DocumentTypeHandle as DocumentTypeHandle_2 } from "@sanity/sdk";
+import { FallbackProps } from "react-error-boundary";
+import { FavoriteStatusResponse } from "@sanity/sdk";
+import { FrameMessage } from "@sanity/sdk";
+import { GetUserOptions } from "@sanity/sdk";
+import { GetUsersOptions } from "@sanity/sdk";
+import { JsonMatch } from "@sanity/sdk";
+import { MediaResource } from "@sanity/message-protocol";
+import { Organization } from "@sanity/sdk";
+import { OrganizationOptions } from "@sanity/sdk";
+import { Organizations } from "@sanity/sdk";
+import { OrganizationsOptions } from "@sanity/sdk";
+import { PathChangeMessage } from "@sanity/message-protocol";
+import { PreviewValue } from "@sanity/sdk";
+import { Project } from "@sanity/sdk";
+import { ProjectHandle } from "@sanity/sdk";
+import { ProjectOptions } from "@sanity/sdk";
+import { ProjectsOptions } from "@sanity/sdk";
+import { PropsWithChildren } from "react";
+import { QueryOptions } from "@sanity/sdk";
+import { default as React_2 } from "react";
+import { ReactElement } from "react";
+import { ReactNode } from "react";
+import { ReleaseAction } from "@sanity/sdk";
+import { ReleaseDocument } from "@sanity/sdk";
+import { SanityClient } from "@sanity/client";
+import { SanityConfig } from "@sanity/sdk";
+import { SanityDocument } from "@sanity/types";
+import { SanityDocument as SanityDocument_2 } from "groq";
+import { SanityInstance } from "@sanity/sdk";
+import { SanityProjectionResult } from "groq";
+import { SanityProjectMember } from "@sanity/client";
+import { SanityQueryResult } from "groq";
+import { SanityUser } from "@sanity/sdk";
+import { SortOrderingItem } from "@sanity/types";
+import { StudioResource } from "@sanity/message-protocol";
+import { TokenSource } from "@sanity/sdk";
+import { UserPresence } from "@sanity/sdk";
+import { WindowMessage } from "@sanity/sdk";
 
 /**
  * @public
@@ -65,15 +66,15 @@ export declare interface AgentResourceContextOptions {
   /**
    * The project ID of the current context
    */
-  projectId: string
+  projectId: string;
   /**
    * The dataset of the current context
    */
-  dataset: string
+  dataset: string;
   /**
    * Optional document ID if the user is viewing/editing a specific document
    */
-  documentId?: string
+  documentId?: string;
 }
 
 /**
@@ -100,7 +101,7 @@ export declare interface AgentResourceContextOptions {
 export declare function AuthBoundary({
   LoginErrorComponent,
   ...props
-}: AuthBoundaryProps): React.ReactNode
+}: AuthBoundaryProps): React.ReactNode;
 
 /**
  * @internal
@@ -111,33 +112,33 @@ export declare interface AuthBoundaryProps {
    * Receives all props. Defaults to {@link Login}.
    */
   LoginComponent?: React.ComponentType<{
-    header?: React.ReactNode
-    footer?: React.ReactNode
-  }>
+    header?: React.ReactNode;
+    footer?: React.ReactNode;
+  }>;
   /**
    * Custom component to render during OAuth callback processing.
    * Receives all props. Defaults to {@link LoginCallback}.
    */
   CallbackComponent?: React.ComponentType<{
-    header?: React.ReactNode
-    footer?: React.ReactNode
-  }>
+    header?: React.ReactNode;
+    footer?: React.ReactNode;
+  }>;
   /**
    * Custom component to render when authentication errors occur.
    * Receives error boundary props and layout props. Defaults to
    * {@link LoginError}
    */
-  LoginErrorComponent?: React.ComponentType<LoginErrorProps>
+  LoginErrorComponent?: React.ComponentType<LoginErrorProps>;
   /** Header content to display */
-  header?: React.ReactNode
+  header?: React.ReactNode;
   /**
    * The project IDs to use for organization verification.
    */
-  projectIds?: string[]
+  projectIds?: string[];
   /** Footer content to display */
-  footer?: React.ReactNode
+  footer?: React.ReactNode;
   /** Protected content to render when authenticated */
-  children?: React.ReactNode
+  children?: React.ReactNode;
   /**
    * Whether to verify that the project belongs to the organization specified in the dashboard context.
    * By default, organization verification is enabled when running in a dashboard context.
@@ -145,41 +146,57 @@ export declare interface AuthBoundaryProps {
    * WARNING: Disabling organization verification is NOT RECOMMENDED and may cause your application
    * to break in the future. This should never be disabled in production environments.
    */
-  verifyOrganization?: boolean
+  verifyOrganization?: boolean;
 }
 
 /**
  * @public
  */
-export declare type ComlinkStatus = 'idle' | 'handshaking' | 'connected' | 'disconnected'
+export declare type ComlinkStatus =
+  | "idle"
+  | "handshaking"
+  | "connected"
+  | "disconnected";
 
 /**
  * This provider is used to provide the Comlink token refresh feature.
  * It is used to automatically request a new token on 401 error if enabled.
  * @public
  */
-export declare const ComlinkTokenRefreshProvider: React_2.FC<PropsWithChildren>
+export declare const ComlinkTokenRefreshProvider: React_2.FC<PropsWithChildren>;
+
+/**
+ * Optional per-call overrides for {@link useCreateDocument}'s create function.
+ * @public
+ */
+export declare interface CreateDocumentOverrides {
+  /**
+   * Use this document ID instead of generating one. Overrides any `documentId`
+   * supplied on the handle passed to `useCreateDocument`.
+   */
+  documentId?: string;
+}
 
 declare interface DashboardResource {
-  id: string
-  name: string
-  title: string
-  basePath: string
-  projectId: string
-  dataset: string
-  type: string
-  userApplicationId: string
-  url: string
+  id: string;
+  name: string;
+  title: string;
+  basePath: string;
+  projectId: string;
+  dataset: string;
+  type: string;
+  userApplicationId: string;
+  url: string;
 }
 
-export {DatasetsResponse}
+export { DatasetsResponse };
 
 /**
  * Return type for the useDispatchIntent hook
  * @beta
  */
 declare interface DispatchIntent {
-  dispatchIntent: () => void
+  dispatchIntent: () => void;
 }
 
 /**
@@ -195,11 +212,11 @@ export declare interface DocumentHandle<
   TDataset extends string = string,
   TProjectId extends string = string,
 > extends DocumentHandle_2<TDocumentType, TDataset, TProjectId> {
-  resourceName?: string
+  resourceName?: string;
 }
 
 declare interface DocumentInteractionHistory {
-  recordEvent: (eventType: 'viewed' | 'edited' | 'created' | 'deleted') => void
+  recordEvent: (eventType: "viewed" | "edited" | "created" | "deleted") => void;
 }
 
 /**
@@ -213,28 +230,30 @@ export declare interface DocumentsOptions<
   TDataset extends string = string,
   TProjectId extends string = string,
 >
-  extends ResourceHandle<TDataset, TProjectId>, Pick<QueryOptions, 'perspective' | 'params'> {
+  extends
+    ResourceHandle<TDataset, TProjectId>,
+    Pick<QueryOptions, "perspective" | "params"> {
   /**
    * Filter documents by their `_type`. Can be a single type or an array of types.
    */
-  documentType?: TDocumentType | TDocumentType[]
+  documentType?: TDocumentType | TDocumentType[];
   /**
    * GROQ filter expression to apply to the query
    */
-  filter?: string
+  filter?: string;
   /**
    * Number of items to load per batch (defaults to 25)
    */
-  batchSize?: number
+  batchSize?: number;
   /**
    * Sorting configuration for the results
    * @beta
    */
-  orderings?: SortOrderingItem[]
+  orderings?: SortOrderingItem[];
   /**
    * Text search query to filter results
    */
-  search?: string
+  search?: string;
 }
 
 /**
@@ -251,23 +270,23 @@ export declare interface DocumentsResponse<
   /**
    * Array of document handles for the current batch
    */
-  data: DocumentHandle_2<TDocumentType, TDataset, TProjectId>[]
+  data: DocumentHandle_2<TDocumentType, TDataset, TProjectId>[];
   /**
    * Whether there are more items available to load
    */
-  hasMore: boolean
+  hasMore: boolean;
   /**
    * Total count of items matching the query
    */
-  count: number
+  count: number;
   /**
    * Whether a query is currently in progress
    */
-  isPending: boolean
+  isPending: boolean;
   /**
    * Function to load the next batch of results
    */
-  loadMore: () => void
+  loadMore: () => void;
 }
 
 /**
@@ -279,62 +298,69 @@ export declare interface DocumentTypeHandle<
   TDataset extends string = string,
   TProjectId extends string = string,
 > extends DocumentTypeHandle_2<TDocumentType, TDataset, TProjectId> {
-  resourceName?: string
+  resourceName?: string;
 }
 
 /**
  * @internal
  */
 export declare interface FrameConnection<TFrameMessage extends FrameMessage> {
-  connect: (frameWindow: Window) => () => void
-  sendMessage: <T extends TFrameMessage['type']>(
+  connect: (frameWindow: Window) => () => void;
+  sendMessage: <T extends TFrameMessage["type"]>(
     ...params: Extract<
       TFrameMessage,
       {
-        type: T
+        type: T;
       }
-    >['data'] extends undefined
+    >["data"] extends undefined
       ? [type: T]
       : [
           type: T,
           data: Extract<
             TFrameMessage,
             {
-              type: T
+              type: T;
             }
-          >['data'],
+          >["data"],
         ]
-  ) => void
+  ) => void;
 }
 
+declare type IgnoredKey =
+  | "_id"
+  | "_type"
+  | "_rev"
+  | "_createdAt"
+  | "_updatedAt";
+
 /**
  * @alpha
  */
-declare type LoginErrorProps = FallbackProps
+declare type LoginErrorProps = FallbackProps;
 
 declare interface ManageFavorite extends FavoriteStatusResponse {
-  favorite: () => Promise<void>
-  unfavorite: () => Promise<void>
-  isFavorited: boolean
+  favorite: () => Promise<void>;
+  unfavorite: () => Promise<void>;
+  isFavorited: boolean;
 }
 
 /**
  * @public
  */
-declare type MessageData = Record<string, unknown> | undefined
+declare type MessageData = Record<string, unknown> | undefined;
 
 /**
  * @internal
  */
 export declare type MessageHandler<TWindowMessage extends WindowMessage> = (
-  event: TWindowMessage['data'],
-) => TWindowMessage['response'] | Promise<TWindowMessage['response']>
+  event: TWindowMessage["data"],
+) => TWindowMessage["response"] | Promise<TWindowMessage["response"]>;
 
 /** In-flight CLI PR is using named sources since it's aspirational.
  *  We can transform the shape in this function until it's finalized.
  */
 declare interface NamedSources {
-  [key: string]: SanityConfig
+  [key: string]: SanityConfig;
 }
 
 /**
@@ -342,13 +368,13 @@ declare interface NamedSources {
  * @category Types
  */
 export declare interface NavigateToStudioResult {
-  navigateToStudioDocument: () => void
+  navigateToStudioDocument: () => void;
 }
 
 declare interface Observer<T> {
-  next?: (value: T) => void
-  error?: (err: unknown) => void
-  complete?: () => void
+  next?: (value: T) => void;
+  error?: (err: unknown) => void;
+  complete?: () => void;
 }
 
 /**
@@ -362,26 +388,26 @@ export declare interface PaginatedDocumentsOptions<
   TDataset extends string = string,
   TProjectId extends string = string,
 > extends WithResourceNameSupport<
-  Omit<QueryOptions<TDocumentType, TDataset, TProjectId>, 'query'>
+  Omit<QueryOptions<TDocumentType, TDataset, TProjectId>, "query">
 > {
-  documentType?: TDocumentType | TDocumentType[]
+  documentType?: TDocumentType | TDocumentType[];
   /**
    * GROQ filter expression to apply to the query
    */
-  filter?: string
+  filter?: string;
   /**
    * Number of items to display per page (defaults to 25)
    */
-  pageSize?: number
+  pageSize?: number;
   /**
    * Sorting configuration for the results
    * @beta
    */
-  orderings?: SortOrderingItem[]
+  orderings?: SortOrderingItem[];
   /**
    * Text search query to filter results
    */
-  search?: string
+  search?: string;
 }
 
 /**
@@ -398,72 +424,72 @@ export declare interface PaginatedDocumentsResponse<
   /**
    * Array of document handles for the current page
    */
-  data: DocumentHandle_2<TDocumentType, TDataset, TProjectId>[]
+  data: DocumentHandle_2<TDocumentType, TDataset, TProjectId>[];
   /**
    * Whether a query is currently in progress
    */
-  isPending: boolean
+  isPending: boolean;
   /**
    * Number of items displayed per page
    */
-  pageSize: number
+  pageSize: number;
   /**
    * Current page number (1-indexed)
    */
-  currentPage: number
+  currentPage: number;
   /**
    * Total number of pages available
    */
-  totalPages: number
+  totalPages: number;
   /**
    * Starting index of the current page (0-indexed)
    */
-  startIndex: number
+  startIndex: number;
   /**
    * Ending index of the current page (exclusive, 0-indexed)
    */
-  endIndex: number
+  endIndex: number;
   /**
    * Total count of items matching the query
    */
-  count: number
+  count: number;
   /**
    * Navigate to the first page
    */
-  firstPage: () => void
+  firstPage: () => void;
   /**
    * Whether there is a first page available to navigate to
    */
-  hasFirstPage: boolean
+  hasFirstPage: boolean;
   /**
    * Navigate to the previous page
    */
-  previousPage: () => void
+  previousPage: () => void;
   /**
    * Whether there is a previous page available to navigate to
    */
-  hasPreviousPage: boolean
+  hasPreviousPage: boolean;
   /**
    * Navigate to the next page
    */
-  nextPage: () => void
+  nextPage: () => void;
   /**
    * Whether there is a next page available to navigate to
    */
-  hasNextPage: boolean
+  hasNextPage: boolean;
   /**
    * Navigate to the last page
    */
-  lastPage: () => void
+  lastPage: () => void;
   /**
    * Whether there is a last page available to navigate to
    */
-  hasLastPage: boolean
+  hasLastPage: boolean;
   /**
    * Navigate to a specific page number
    * @param pageNumber - The page number to navigate to (1-indexed)
    */
-  goToPage: (pageNumber: number) => void
+  goToPage: (pageNumber: number) => void;
 }
 
 /**
@@ -472,13 +498,13 @@ export declare interface PaginatedDocumentsResponse<
  * @interface
  * @deprecated use the Project type directly.
  */
-export declare type ProjectWithoutMembers = Project
+export declare type ProjectWithoutMembers = Project;
 
 /**
  * This version is provided by pkg-utils at build time
  * @internal
  */
-export declare const REACT_SDK_VERSION: {}
+export declare const REACT_SDK_VERSION: {};
 
 /** @internal */
 export declare function renderSanityApp(
@@ -486,10 +512,10 @@ export declare function renderSanityApp(
   namedSources: NamedSources,
   options: RenderSanitySDKAppOptions,
   children: React.ReactNode,
-): () => void
+): () => void;
 
 declare interface RenderSanitySDKAppOptions {
-  reactStrictMode?: boolean
+  reactStrictMode?: boolean;
 }
 
 /**
@@ -511,7 +537,7 @@ export declare interface ResourceHandle<
    * Name of a resource registered via the `resources` prop on `<SanityApp>`.
    * Resolved to a `DocumentResource` at the React layer.
    */
-  resourceName?: string
+  resourceName?: string;
 }
 
 /**
@@ -534,7 +560,7 @@ export declare function ResourceProvider({
   fallback,
   resource,
   ...config
-}: ResourceProviderProps): React.ReactNode
+}: ResourceProviderProps): React.ReactNode;
 
 /**
  * Props for the ResourceProvider component
@@ -546,13 +572,13 @@ export declare interface ResourceProviderProps extends SanityConfig {
    * for this subtree. Hooks that don't specify an explicit resource will
    * use this value.
    */
-  resource?: DocumentResource
+  resource?: DocumentResource;
   /**
    * React node to show while content is loading.
    * Used as the fallback for the internal Suspense boundary.
    */
-  fallback: React.ReactNode
-  children: React.ReactNode
+  fallback: React.ReactNode;
+  children: React.ReactNode;
 }
 
 /**
@@ -624,7 +650,7 @@ export declare function SanityApp({
   fallback,
   config: configProp,
   ...props
-}: SanityAppProps): ReactElement
+}: SanityAppProps): ReactElement;
 
 /**
  * @public
@@ -637,15 +663,44 @@ export declare interface SanityAppProps {
    * (e.g. inside Sanity Studio) — the config is derived from the workspace
    * automatically.
    */
-  config?: SanityConfig | SanityConfig[]
+  config?: SanityConfig | SanityConfig[];
   /** @deprecated use the `config` prop instead. */
-  sanityConfigs?: SanityConfig[]
-  resources?: Record<string, DocumentResource>
-  children: React.ReactNode
-  fallback: React.ReactNode
+  sanityConfigs?: SanityConfig[];
+  resources?: Record<string, DocumentResource>;
+  children: React.ReactNode;
+  fallback: React.ReactNode;
+  /**
+   * Set this to automatically fetch and register the organization's media library and canvas as named resources.
+   * These resources will be available to hooks as `media-library` and `canvas`.
+   *
+   * The SDK App must be running in the organization's Dashboard to use this feature.
+   *
+   * @example
+   * ```tsx
+   *
+   * const MyApp = () => {
+   *   // should "just work" because of inferMediaLibraryAndCanvas.
+   *   const {data: assets} = useDocuments({
+   *     documentType: 'sanity.asset',
+   *     resourceName: 'media-library',
+   *   })
+   *   return (
+   *     <div>
+   *       {assets.map((asset) => (
+   *         <div key={asset._id}>{asset.originalFilename}</div>
+   *       ))}
+   *     </div>
+   *   )
+   * }
+   * <SanityApp inferMediaLibraryAndCanvas>
+   *   <MyApp />
+   * </SanityApp>
+   * ```
+   */
+  inferMediaLibraryAndCanvas?: boolean;
 }
 
-export {SanityDocument}
+export { SanityDocument };
 
 /**
  * Provides an externally-created Sanity instance to child components through React Context.
@@ -687,7 +742,7 @@ export declare function SanityInstanceProvider({
   instance,
   fallback,
   children,
-}: SanityInstanceProviderProps): React.ReactNode
+}: SanityInstanceProviderProps): React.ReactNode;
 
 /**
  * Props for the SanityInstanceProvider component
@@ -699,16 +754,16 @@ export declare interface SanityInstanceProviderProps {
    * The caller owns the instance lifecycle — SanityInstanceProvider
    * will not dispose it on unmount.
    */
-  instance: SanityInstance
+  instance: SanityInstance;
   /**
    * React node to show while content is loading.
    * Used as the fallback for the internal Suspense boundary.
    */
-  fallback: React.ReactNode
-  children: React.ReactNode
+  fallback: React.ReactNode;
+  children: React.ReactNode;
 }
 
-export {SanityProjectMember}
+export { SanityProjectMember };
 
 /**
  * @internal
@@ -719,17 +774,20 @@ export declare function SDKProvider({
   children,
   config,
   fallback,
+  inferMediaLibraryAndCanvas,
   ...props
-}: SDKProviderProps): ReactElement
+}: SDKProviderProps): ReactElement;
 
 /**
  * @internal
  */
 export declare interface SDKProviderProps extends AuthBoundaryProps {
-  children: ReactNode
-  config: SanityConfig | SanityConfig[]
-  fallback: ReactNode
-  resources?: Record<string, DocumentResource>
+  children: ReactNode;
+  config: SanityConfig | SanityConfig[];
+  fallback: ReactNode;
+  resources?: Record<string, DocumentResource>;
+  /** When set, automatically fetches and registers the organization's media library and canvas as named resources. */
+  inferMediaLibraryAndCanvas?: boolean;
 }
 
 /**
@@ -766,9 +824,9 @@ export declare interface SDKProviderProps extends AuthBoundaryProps {
  *
  * @public
  */
-export declare const SDKStudioContext: Context<StudioWorkspaceHandle | null>
+export declare const SDKStudioContext: Context<StudioWorkspaceHandle | null>;
 
-export {SortOrderingItem}
+export { SortOrderingItem };
 
 /**
  * Minimal duck-typed interface representing a Sanity Studio workspace.
@@ -779,15 +837,15 @@ export {SortOrderingItem}
  */
 export declare interface StudioWorkspaceHandle {
   /** The Sanity project ID for this workspace. */
-  projectId: string
+  projectId: string;
   /** The dataset name for this workspace. */
-  dataset: string
+  dataset: string;
   /**
    * Whether the Studio has determined the user is authenticated.
    * When `true` and the token source emits `null`, the SDK infers
    * cookie-based auth is in use and skips the logged-out state.
    */
-  authenticated?: boolean
+  authenticated?: boolean;
   /** Authentication state for this workspace. */
   auth: {
     /**
@@ -798,29 +856,29 @@ export declare interface StudioWorkspaceHandle {
      * Optional because Studios before Aug 2022 may not expose it. When
      * absent, the SDK falls back to localStorage/cookie discovery.
      */
-    token?: TokenSource
-  }
+    token?: TokenSource;
+  };
 }
 
 declare interface StudioWorkspacesResult {
-  workspacesByProjectIdAndDataset: WorkspacesByProjectIdDataset
-  error: string | null
+  workspacesByProjectIdAndDataset: WorkspacesByProjectIdDataset;
+  error: string | null;
 }
 
 declare interface Subscribable<T> {
-  subscribe(observer: Observer<T>): Subscription
+  subscribe(observer: Observer<T>): Subscription;
   subscribe(
     next: (value: T) => void,
     error?: (err: unknown) => void,
     complete?: () => void,
-  ): Subscription
+  ): Subscription;
 }
 
 declare interface Subscription {
-  unsubscribe(): void
+  unsubscribe(): void;
 }
 
-declare type Updater<TValue> = TValue | ((currentValue: TValue) => TValue)
+declare type Updater<TValue> = TValue | ((currentValue: TValue) => TValue);
 
 /**
  * @public
@@ -840,7 +898,7 @@ declare type Updater<TValue> = TValue | ((currentValue: TValue) => TValue)
  */
 export declare function useActiveReleases(
   options?: WithResourceNameSupport<SanityConfig> | undefined,
-): ReleaseDocument[]
+): ReleaseDocument[];
 
 /**
  * @alpha
@@ -911,7 +969,7 @@ export declare function useActiveReleases(
  */
 export declare function useAgentGenerate(
   resourceHandle?: ResourceHandle,
-): (options: AgentGenerateOptions) => Subscribable<unknown>
+): (options: AgentGenerateOptions) => Subscribable<unknown>;
 
 /**
  * @alpha
@@ -1064,7 +1122,7 @@ export declare function useAgentGenerate(
  */
 export declare function useAgentPatch(
   resourceHandle?: ResourceHandle,
-): (options: AgentPatchOptions) => Promise<AgentPatchResult>
+): (options: AgentPatchOptions) => Promise<AgentPatchResult>;
 
 /**
  * @alpha
@@ -1162,7 +1220,7 @@ export declare function useAgentPatch(
  */
 export declare function useAgentPrompt(
   resourceHandle?: ResourceHandle,
-): (options: AgentPromptOptions) => Promise<AgentPromptResult>
+): (options: AgentPromptOptions) => Promise<AgentPromptResult>;
 
 /**
  * @public
@@ -1194,7 +1252,9 @@ export declare function useAgentPrompt(
  * }
  * ```
  */
-export declare function useAgentResourceContext(options: AgentResourceContextOptions): void
+export declare function useAgentResourceContext(
+  options: AgentResourceContextOptions,
+): void;
 
 /**
  * @alpha
@@ -1269,7 +1329,7 @@ export declare function useAgentResourceContext(options: AgentResourceContextOpt
  */
 export declare function useAgentTransform(
   resourceHandle?: ResourceHandle,
-): (options: AgentTransformOptions) => Subscribable<unknown>
+): (options: AgentTransformOptions) => Subscribable<unknown>;
 
 /**
  * @alpha
@@ -1363,7 +1423,7 @@ export declare function useAgentTransform(
  */
 export declare function useAgentTranslate(
   resourceHandle?: ResourceHandle,
-): (options: AgentTranslateOptions) => Subscribable<unknown>
+): (options: AgentTranslateOptions) => Subscribable<unknown>;
 
 /**
  * @public
@@ -1392,7 +1452,7 @@ export declare function useAgentTranslate(
  */
 export declare function useAllReleases(
   options?: WithResourceNameSupport<SanityConfig> | undefined,
-): ReleaseDocument[]
+): ReleaseDocument[];
 
 /**
  * @public
@@ -1407,7 +1467,9 @@ declare interface UseApplyDocumentActions {
       | DocumentAction<TDocumentType, TDataset, TProjectId>
       | DocumentAction<TDocumentType, TDataset, TProjectId>[],
     options?: ResourceHandle,
-  ) => Promise<ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>>
+  ) => Promise<
+    ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>
+  >;
 }
 
 /**
@@ -1593,13 +1655,16 @@ declare interface UseApplyDocumentActions {
  * }
  * ```
  */
-export declare const useApplyDocumentActions: UseApplyDocumentActions
+export declare const useApplyDocumentActions: UseApplyDocumentActions;
 
 /**
  * @public
  */
 declare interface UseApplyReleaseActions {
-  (): (action: ReleaseAction | ReleaseAction[], options?: ResourceHandle) => Promise<ActionsResult>
+  (): (
+    action: ReleaseAction | ReleaseAction[],
+    options?: ResourceHandle,
+  ) => Promise<ActionsResult>;
 }
 
 /**
@@ -1669,7 +1734,7 @@ declare interface UseApplyReleaseActions {
  * }
  * ```
  */
-export declare const useApplyReleaseActions: UseApplyReleaseActions
+export declare const useApplyReleaseActions: UseApplyReleaseActions;
 
 /**
  * @internal
@@ -1692,14 +1757,14 @@ export declare const useApplyReleaseActions: UseApplyReleaseActions
  * }
  * ```
  */
-export 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
  */
-export declare const useAuthToken: () => string | null
+export declare const useAuthToken: () => string | null;
 
 /**
  * A React hook that provides a client that subscribes to changes in your application,
@@ -1728,7 +1793,48 @@ export declare const useAuthToken: () => string | null
  * @public
  * @function
  */
-export declare const useClient: (options: ClientOptions) => SanityClient
+export declare const useClient: (options: ClientOptions) => SanityClient;
+
+/**
+ * @public
+ * Create a new document, relying on Typegen for the initial-value type.
+ *
+ * @param options - A document-type handle including `documentType`, an optional `documentId`, and optionally `projectId`/`dataset`/`perspective`.
+ * @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).
+ */
+export declare function useCreateDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  options: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>,
+): (
+  initialValue?: Partial<
+    Omit<
+      SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>,
+      IgnoredKey
+    >
+  >,
+  overrides?: CreateDocumentOverrides,
+) => Promise<DocumentHandle<TDocumentType, TDataset, TProjectId>>;
+
+/**
+ * @public
+ * Create a new document with an explicit type `TData`.
+ *
+ * @param options - A document-type handle including `documentType` and optionally `projectId`/`dataset`/`perspective`.
+ * @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.
+ */
+export declare function useCreateDocument<
+  TData extends Record<string, unknown>,
+>(
+  options: DocumentTypeHandle,
+): (
+  initialValue?: Partial<Omit<TData, IgnoredKey>>,
+  overrides?: CreateDocumentOverrides,
+) => Promise<DocumentHandle>;
 
 declare type UseCurrentUser = {
   /**
@@ -1751,15 +1857,15 @@ declare type UseCurrentUser = {
    * )
    * ```
    */
-  (): CurrentUser | null
-}
+  (): CurrentUser | null;
+};
 
 /**
  * @public
  * @function
  * @TODO This should not return null — users of a custom app will always be authenticated via Core
  */
-export declare const useCurrentUser: UseCurrentUser
+export declare const useCurrentUser: UseCurrentUser;
 
 /**
  * @public
@@ -1805,8 +1911,8 @@ export declare const useCurrentUser: UseCurrentUser
  * ```
  */
 export declare function useDashboardNavigate(
-  navigateFn: (options: PathChangeMessage['data']) => void,
-): void
+  navigateFn: (options: PathChangeMessage["data"]) => void,
+): void;
 
 /**
  * @public
@@ -1827,7 +1933,7 @@ export declare function useDashboardNavigate(
  * @category Dashboard
  * @returns The dashboard organization ID (string | undefined)
  */
-export declare function useDashboardOrganizationId(): string | undefined
+export declare function useDashboardOrganizationId(): string | undefined;
 
 declare type UseDatasets = {
   /**
@@ -1835,6 +1941,8 @@ declare type UseDatasets = {
    * Returns metadata for each dataset the current user has access to.
    *
    * @category Datasets
+   * @param options - Optional project/resource to read datasets for. Defaults to
+   *   the resource named in `ResourceProvider`/`SDKProvider`.
    * @returns The metadata for your the datasets
    *
    * @example
@@ -1850,15 +1958,21 @@ declare type UseDatasets = {
    * )
    * ```
    *
+   * @remarks
+   * The `projectId` is resolved in order from:
+   * 1. an explicit `projectId` option
+   * 2. A legacy ProjectContext (e.g. a `<ResourceProvider projectId="…">` with no dataset), then
+   * 3. The active resource (`ResourceProvider`/`SDKProvider`)
+   * 4. `instance.config`.
    */
-  (): DatasetsResponse
-}
+  (options?: ProjectHandle): DatasetsResponse;
+};
 
 /**
  * @public
  * @function
  */
-export declare const useDatasets: UseDatasets
+export declare const useDatasets: UseDatasets;
 
 /**
  * @beta
@@ -1911,26 +2025,32 @@ export declare const useDatasets: UseDatasets
  * }
  * ```
  */
-export declare function useDispatchIntent(params: UseDispatchIntentParams): DispatchIntent
+export declare function useDispatchIntent(
+  params: UseDispatchIntentParams,
+): DispatchIntent;
 
 /**
  * Parameters for the useDispatchIntent hook
  * @beta
  */
 declare interface UseDispatchIntentParams {
-  action?: 'edit'
-  intentId?: string
-  documentHandle: DocumentHandle
-  parameters?: Record<string, unknown>
+  action?: "edit";
+  intentId?: string;
+  documentHandle: DocumentHandle;
+  parameters?: Record<string, unknown>;
 }
 
 declare interface UseDocument {
   /** @internal */
-  <TDocumentType extends string, TDataset extends string, TProjectId extends string = string>(
+  <
+    TDocumentType extends string,
+    TDataset extends string,
+    TProjectId extends string = string,
+  >(
     options: UseDocumentOptions<undefined, TDocumentType, TDataset, TProjectId>,
   ): {
-    data: SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`> | null
-  }
+    data: SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`> | null;
+  };
   /** @internal */
   <
     TPath extends string,
@@ -1940,16 +2060,21 @@ declare interface UseDocument {
   >(
     options: UseDocumentOptions<TPath, TDocumentType>,
   ): {
-    data: JsonMatch<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined
-  }
+    data:
+      | JsonMatch<
+          SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>,
+          TPath
+        >
+      | undefined;
+  };
   /** @internal */
   <TData>(options: DocumentOptions<undefined>): {
-    data: TData | null
-  }
+    data: TData | null;
+  };
   /** @internal */
   <TData>(options: DocumentOptions<string>): {
-    data: TData | undefined
-  }
+    data: TData | undefined;
+  };
   /**
    * ## useDocument via Type Inference (Recommended)
    *
@@ -2022,12 +2147,18 @@ declare interface UseDocument {
   ): TPath extends string
     ? {
         data:
-          | JsonMatch<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>, TPath>
-          | undefined
+          | JsonMatch<
+              SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>,
+              TPath
+            >
+          | undefined;
       }
     : {
-        data: SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`> | null
-      }
+        data: SanityDocument_2<
+          TDocumentType,
+          `${TProjectId}.${TDataset}`
+        > | null;
+      };
   /**
    * @public
    *
@@ -2092,17 +2223,17 @@ declare interface UseDocument {
     options: UseDocumentOptions<TPath>,
   ): TPath extends string
     ? {
-        data: TData | undefined
+        data: TData | undefined;
       }
     : {
-        data: TData | null
-      }
+        data: TData | null;
+      };
   /**
    * @internal
    */
   (options: UseDocumentOptions): {
-    data: unknown
-  }
+    data: unknown;
+  };
 }
 
 /**
@@ -2128,7 +2259,7 @@ declare interface UseDocument {
  *
  * @function
  */
-export declare const useDocument: UseDocument
+export declare const useDocument: UseDocument;
 
 /**
  *
@@ -2188,7 +2319,7 @@ export declare const useDocument: UseDocument
 export declare function useDocumentEvent<
   TDataset extends string = string,
   TProjectId extends string = string,
->(options: UseDocumentEventOptions<TDataset, TProjectId>): void
+>(options: UseDocumentEventOptions<TDataset, TProjectId>): void;
 
 /**
  * @public
@@ -2197,7 +2328,7 @@ declare interface UseDocumentEventOptions<
   TDataset extends string = string,
   TProjectId extends string = string,
 > extends ResourceHandle<TDataset, TProjectId> {
-  onEvent: (documentEvent: DocumentEvent) => void
+  onEvent: (documentEvent: DocumentEvent) => void;
 }
 
 declare type UseDocumentOptions<
@@ -2206,8 +2337,8 @@ declare type UseDocumentOptions<
   TDataset extends string = string,
   TProjectId extends string = string,
 > = DocumentHandle<TDocumentType, TDataset, TProjectId> & {
-  path?: TPath
-}
+  path?: TPath;
+};
 
 /**
  *
@@ -2290,7 +2421,7 @@ export declare function useDocumentPermissions(
   actionOrActions:
     | WithResourceNameSupport<DocumentAction>
     | WithResourceNameSupport<DocumentAction>[],
-): DocumentPermissionsResult
+): DocumentPermissionsResult;
 
 /**
  * @public
@@ -2351,7 +2482,7 @@ export declare function useDocumentPermissions(
 export declare function useDocumentPreview({
   ref,
   ...docHandle
-}: useDocumentPreviewOptions): useDocumentPreviewResults
+}: useDocumentPreviewOptions): useDocumentPreviewResults;
 
 /**
  * @public
@@ -2362,7 +2493,7 @@ export declare interface useDocumentPreviewOptions extends DocumentHandle {
    * Optional ref object to track visibility. When provided, preview resolution
    * only occurs when the referenced element is visible in the viewport.
    */
-  ref?: React.RefObject<unknown>
+  ref?: React.RefObject<unknown>;
 }
 
 /**
@@ -2371,9 +2502,9 @@ export declare interface useDocumentPreviewOptions extends DocumentHandle {
  */
 export declare interface useDocumentPreviewResults {
   /** The results of inferring the document's preview values */
-  data: PreviewValue
+  data: PreviewValue;
   /** True when inferred preview values are being refreshed */
-  isPending: boolean
+  isPending: boolean;
 }
 
 /**
@@ -2455,10 +2586,19 @@ export declare function useDocumentProjection<
   TDataset extends string = string,
   TProjectId extends string = string,
 >(
-  options: useDocumentProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
+  options: useDocumentProjectionOptions<
+    TProjection,
+    TDocumentType,
+    TDataset,
+    TProjectId
+  >,
 ): useDocumentProjectionResults<
-  SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
->
+  SanityProjectionResult<
+    TProjection,
+    TDocumentType,
+    `${TProjectId}.${TDataset}`
+  >
+>;
 
 /**
  * @public
@@ -2507,7 +2647,7 @@ export declare function useDocumentProjection<
  */
 export declare function useDocumentProjection<TData extends object>(
   options: useDocumentProjectionOptions,
-): useDocumentProjectionResults<TData>
+): useDocumentProjectionResults<TData>;
 
 /**
  * @public
@@ -2520,11 +2660,11 @@ export declare interface useDocumentProjectionOptions<
   TProjectId extends string = string,
 > extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   /** The GROQ projection string */
-  projection: TProjection
+  projection: TProjection;
   /** Optional parameters for the projection query */
-  params?: Record<string, unknown>
+  params?: Record<string, unknown>;
   /** Optional ref to track viewport intersection for lazy loading */
-  ref?: React.RefObject<unknown>
+  ref?: React.RefObject<unknown>;
 }
 
 /**
@@ -2533,9 +2673,9 @@ export declare interface useDocumentProjectionOptions<
  */
 export declare interface useDocumentProjectionResults<TData> {
   /** The projected data */
-  data: TData
+  data: TData;
   /** True if the projection is currently being resolved */
-  isPending: boolean
+  isPending: boolean;
 }
 
 /**
@@ -2663,7 +2803,7 @@ export declare function useDocuments<
   TDocumentType,
   TDataset,
   TProjectId
->
+>;
 
 declare type UseDocumentSyncStatus = {
   /**
@@ -2698,14 +2838,14 @@ declare type UseDocumentSyncStatus = {
    * // <SyncIndicator doc={doc} />
    * ```
    */
-  (doc: DocumentHandle_2): boolean
-}
+  (doc: DocumentHandle_2): boolean;
+};
 
 /**
  * @public
  * @function
  */
-export declare const useDocumentSyncStatus: UseDocumentSyncStatus
+export declare const useDocumentSyncStatus: UseDocumentSyncStatus;
 
 /**
  * @public
@@ -2722,8 +2862,12 @@ export declare function useEditDocument<
 >(
   options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>,
 ): (
-  nextValue: Updater<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>,
-) => Promise<ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>>
+  nextValue: Updater<
+    SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>
+  >,
+) => Promise<
+  ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>
+>;
 
 /**
  * @public
@@ -2742,9 +2886,14 @@ export declare function useEditDocument<
   options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>,
 ): (
   nextValue: Updater<
-    JsonMatch<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>, TPath>
+    JsonMatch<
+      SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>,
+      TPath
+    >
   >,
-) => Promise<ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>>
+) => Promise<
+  ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>
+>;
 
 /**
  * @public
@@ -2756,7 +2905,7 @@ export declare function useEditDocument<
  */
 export declare function useEditDocument<TData>(
   options: DocumentOptions<undefined>,
-): (nextValue: Updater<TData>) => Promise<ActionsResult>
+): (nextValue: Updater<TData>) => Promise<ActionsResult>;
 
 /**
  * @public
@@ -2768,7 +2917,7 @@ export declare function useEditDocument<TData>(
  */
 export declare function useEditDocument<TData>(
   options: DocumentOptions<string>,
-): (nextValue: Updater<TData>) => Promise<ActionsResult>
+): (nextValue: Updater<TData>) => Promise<ActionsResult>;
 
 /**
  * @internal
@@ -2776,27 +2925,31 @@ export declare function useEditDocument<TData>(
 export declare function useFrameConnection<
   TFrameMessage extends FrameMessage,
   TWindowMessage extends WindowMessage,
->(options: UseFrameConnectionOptions<TWindowMessage>): FrameConnection<TFrameMessage>
+>(
+  options: UseFrameConnectionOptions<TWindowMessage>,
+): FrameConnection<TFrameMessage>;
 
 /**
  * @internal
  */
-export declare interface UseFrameConnectionOptions<TWindowMessage extends WindowMessage> {
-  name: string
-  connectTo: string
-  targetOrigin: string
+export declare interface UseFrameConnectionOptions<
+  TWindowMessage extends WindowMessage,
+> {
+  name: string;
+  connectTo: string;
+  targetOrigin: string;
   onMessage?: {
-    [K in TWindowMessage['type']]: (
+    [K in TWindowMessage["type"]]: (
       data: Extract<
         TWindowMessage,
         {
-          type: K
+          type: K;
         }
-      >['data'],
-    ) => void
-  }
-  heartbeat?: boolean
-  onStatus?: (status: ComlinkStatus) => void
+      >["data"],
+    ) => void;
+  };
+  heartbeat?: boolean;
+  onStatus?: (status: ComlinkStatus) => void;
 }
 
 /**
@@ -2841,19 +2994,19 @@ export declare interface UseFrameConnectionOptions<TWindowMessage extends Window
  */
 export declare const useHandleAuthCallback: () => (
   locationHref?: string | undefined,
-) => Promise<string | false>
+) => Promise<string | false>;
 
 /**
  * @internal
  */
-export 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
  */
-export declare const useLogOut: () => () => Promise<void>
+export declare const useLogOut: () => () => Promise<void>;
 
 /**
  * @internal
@@ -2908,16 +3061,19 @@ export declare function useManageFavorite({
   resourceId: paramResourceId,
   resourceType,
   schemaName,
-}: UseManageFavoriteProps): ManageFavorite
+}: UseManageFavoriteProps): ManageFavorite;
 
 declare interface UseManageFavoriteProps extends DocumentHandle_2 {
-  resourceId?: string
-  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['type']
+  resourceId?: string;
+  resourceType:
+    | StudioResource["type"]
+    | MediaResource["type"]
+    | CanvasResource["type"];
   /**
    * The name of the schema collection this document belongs to.
    * Typically is the name of the workspace when used in the context of a studio.
    */
-  schemaName?: string
+  schemaName?: string;
 }
 
 /**
@@ -2967,7 +3123,7 @@ declare interface UseManageFavoriteProps extends DocumentHandle_2 {
 export declare function useNavigateToStudioDocument(
   documentHandle: DocumentHandle_2,
   preferredStudioUrl?: string,
-): NavigateToStudioResult
+): NavigateToStudioResult;
 
 /**
  * Returns metadata for a given organisation.
@@ -2997,7 +3153,7 @@ export declare const useOrganization: <
   IncludeFeatures extends boolean = false,
 >(
   options: OrganizationOptions<IncludeMembers, IncludeFeatures>,
-) => Organization<IncludeMembers, IncludeFeatures>
+) => Organization<IncludeMembers, IncludeFeatures>;
 
 /**
  * Returns metadata for each organisation the current user has access to.
@@ -3032,7 +3188,7 @@ export declare const useOrganizations: <
   IncludeFeatures extends boolean = false,
 >(
   options?: OrganizationsOptions<IncludeMembers, IncludeFeatures>,
-) => Organizations<IncludeMembers, IncludeFeatures>
+) => Organizations<IncludeMembers, IncludeFeatures>;
 
 /**
  * Retrieves pages of {@link DocumentHandle}s, narrowed by optional filters, text searches, and custom ordering,
@@ -3141,25 +3297,27 @@ export declare function usePaginatedDocuments<
   orderings,
   search,
   ...rawOptions
-}: PaginatedDocumentsOptions<TDocumentType, TDataset, TProjectId>): PaginatedDocumentsResponse<
+}: PaginatedDocumentsOptions<
   TDocumentType,
   TDataset,
   TProjectId
->
+>): PaginatedDocumentsResponse<TDocumentType, TDataset, TProjectId>;
 
 /**
  * @public
  * @function
  */
-export declare function usePerspective(perspectiveHandle?: ResourceHandle): string | string[]
+export declare function usePerspective(
+  perspectiveHandle?: ResourceHandle,
+): string | string[];
 
 /**
  * A hook for subscribing to presence information for the current project or Canvas.
  * @public
  */
 export declare function usePresence(options?: ResourceHandle): {
-  locations: UserPresence[]
-}
+  locations: UserPresence[];
+};
 
 /**
  * Returns metadata for a given project.
@@ -3187,6 +3345,12 @@ export declare function usePresence(options?: ResourceHandle): {
  * const projectWithoutMembers = useProject({projectId, includeMembers: false})
  * const projectWithoutFeatures = useProject({projectId, includeFeatures: false})
  * ```
+ * @remarks
+ * The `projectId` is resolved in order from:
+ * 1. an explicit `projectId` option
+ * 2. A legacy ProjectContext (e.g. a `<ResourceProvider projectId="…">` with no dataset), then
+ * 3. The active resource (`ResourceProvider`/`SDKProvider`)
+ * 4. `instance.config`.
  * @public
  * @function
  */
@@ -3195,7 +3359,7 @@ export declare const useProject: <
   IncludeFeatures extends boolean = true,
 >(
   options?: ProjectOptions<IncludeMembers, IncludeFeatures>,
-) => Project<IncludeMembers, IncludeFeatures>
+) => Project<IncludeMembers, IncludeFeatures>;
 
 /**
  * Returns metadata for each project you have access to.
@@ -3232,7 +3396,7 @@ export declare const useProjects: <
   IncludeFeatures extends boolean = true,
 >(
   options?: ProjectsOptions<IncludeMembers, IncludeFeatures>,
-) => Project<IncludeMembers, IncludeFeatures>[]
+) => Project<IncludeMembers, IncludeFeatures>[];
 
 /**
  * @public
@@ -3297,10 +3461,10 @@ export declare function useQuery<
   options: UseQueryOptions<TQuery, TDataset, TProjectId>,
 ): {
   /** The query result, typed based on the GROQ query string */
-  data: SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`>
+  data: SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`>;
   /** True if a query transition is in progress */
-  isPending: boolean
-}
+  isPending: boolean;
+};
 
 /**
  * @public
@@ -3330,12 +3494,14 @@ export declare function useQuery<
  * }
  * ```
  */
-export 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
+  data: TData;
   /** True if another query is resolving in the background (suspense handles the initial loading state) */
-  isPending: boolean
-}
+  isPending: boolean;
+};
 
 /**
  * Hook options for useQuery, supporting both direct resource and resourceName.
@@ -3345,7 +3511,7 @@ declare type UseQueryOptions<
   TQuery extends string = string,
   TDataset extends string = string,
   TProjectId extends string = string,
-> = WithResourceNameSupport<QueryOptions<TQuery, TDataset, TProjectId>>
+> = WithResourceNameSupport<QueryOptions<TQuery, TDataset, TProjectId>>;
 
 /**
  * @internal
@@ -3394,19 +3560,22 @@ export declare function useRecordDocumentHistoryEvent({
   resourceType,
   resourceId,
   schemaName,
-}: UseRecordDocumentHistoryEventProps): DocumentInteractionHistory
+}: UseRecordDocumentHistoryEventProps): DocumentInteractionHistory;
 
 /**
  * @internal
  */
 declare interface UseRecordDocumentHistoryEventProps extends DocumentHandle_2 {
-  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['type']
-  resourceId?: string
+  resourceType:
+    | StudioResource["type"]
+    | MediaResource["type"]
+    | CanvasResource["type"];
+  resourceId?: string;
   /**
    * The name of the schema collection this document belongs to.
    * Typically is the name of the workspace when used in the context of a studio.
    */
-  schemaName?: string
+  schemaName?: string;
 }
 
 /**
@@ -3426,7 +3595,7 @@ declare interface UseRecordDocumentHistoryEventProps extends DocumentHandle_2 {
  * console.log(resource?.projectId, resource?.dataset)
  * ```
  */
-export declare function useResource(): DocumentResource | undefined
+export declare function useResource(): DocumentResource | undefined;
 
 /**
  * @public
@@ -3436,11 +3605,11 @@ export declare interface UserResult {
   /**
    * The user data fetched, or undefined if not found.
    */
-  data: SanityUser | undefined
+  data: SanityUser | undefined;
   /**
    * Whether a user request is currently in progress
    */
-  isPending: boolean
+  isPending: boolean;
 }
 
 /**
@@ -3451,19 +3620,19 @@ export declare interface UsersResult {
   /**
    * The users fetched.
    */
-  data: SanityUser[]
+  data: SanityUser[];
   /**
    * Whether there are more users to fetch.
    */
-  hasMore: boolean
+  hasMore: boolean;
   /**
    * Whether a users request is currently in progress
    */
-  isPending: boolean
+  isPending: boolean;
   /**
    * Load more users.
    */
-  loadMore: () => void
+  loadMore: () => void;
 }
 
 /**
@@ -3493,7 +3662,7 @@ export declare const useSanityInstance: (
    * Use `useSanityInstance()` without arguments instead.
    */
   config?: SanityConfig,
-) => SanityInstance
+) => SanityInstance;
 
 /**
  * Hook that fetches studio workspaces and organizes them by projectId:dataset
@@ -3529,7 +3698,7 @@ export declare const useSanityInstance: (
  * }
  * ```
  */
-export declare function useStudioWorkspacesByProjectIdDataset(): StudioWorkspacesResult
+export declare function useStudioWorkspacesByProjectIdDataset(): StudioWorkspacesResult;
 
 /**
  *
@@ -3563,7 +3732,7 @@ export declare function useStudioWorkspacesByProjectIdDataset(): StudioWorkspace
  * )
  * ```
  */
-export declare function useUser(options: GetUserOptions): UserResult
+export declare function useUser(options: GetUserOptions): UserResult;
 
 /**
  *
@@ -3596,8 +3765,14 @@ export declare function useUser(options: GetUserOptions): UserResult
  *   </div>
  * )
  * ```
+ * @remarks
+ * For project-scoped queries the `projectId` is resolved in order from:
+ * 1. an explicit `projectId` option
+ * 2. A legacy ProjectContext (e.g. a `<ResourceProvider projectId="…">` with no dataset), then
+ * 3. The active resource (`ResourceProvider`/`SDKProvider`)
+ * 4. `instance.config`.
  */
-export declare function useUsers(options?: GetUsersOptions): UsersResult
+export declare function useUsers(options?: GetUsersOptions): UsersResult;
 
 /**
  * Hook that verifies the current projects belongs to the organization ID specified in the dashboard context.
@@ -3622,7 +3797,7 @@ export declare function useUsers(options?: GetUsersOptions): UsersResult
 export declare function useVerifyOrgProjects(
   disabled?: boolean,
   projectIds?: string[],
-): string | null
+): string | null;
 
 /**
  * @internal
@@ -3640,15 +3815,17 @@ export declare function useWindowConnection<
   name,
   connectTo,
   onMessage,
-}: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage>
+}: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage>;
 
 /**
  * @internal
  */
-export declare interface UseWindowConnectionOptions<TMessage extends FrameMessage> {
-  name: string
-  connectTo: string
-  onMessage?: Record<TMessage['type'], WindowMessageHandler<TMessage>>
+export declare interface UseWindowConnectionOptions<
+  TMessage extends FrameMessage,
+> {
+  name: string;
+  connectTo: string;
+  onMessage?: Record<TMessage["type"], WindowMessageHandler<TMessage>>;
 }
 
 /**
@@ -3690,38 +3867,38 @@ export declare interface UseWindowConnectionOptions<TMessage extends FrameMessag
  *
  * @public
  */
-export declare function useWindowTitle(viewTitle?: string): void
+export declare function useWindowTitle(viewTitle?: string): void;
 
 /**
  * @internal
  */
 export declare interface WindowConnection<TMessage extends WindowMessage> {
-  sendMessage: <TType extends TMessage['type']>(
+  sendMessage: <TType extends TMessage["type"]>(
     type: TType,
     data?: Extract<
       TMessage,
       {
-        type: TType
+        type: TType;
       }
-    >['data'],
-  ) => void
+    >["data"],
+  ) => void;
   fetch: <TResponse>(
     type: string,
     data?: MessageData,
     options?: {
-      signal?: AbortSignal
-      suppressWarnings?: boolean
-      responseTimeout?: number
+      signal?: AbortSignal;
+      suppressWarnings?: boolean;
+      responseTimeout?: number;
     },
-  ) => Promise<TResponse>
+  ) => Promise<TResponse>;
 }
 
 /**
  * @internal
  */
 export declare type WindowMessageHandler<TFrameMessage extends FrameMessage> = (
-  event: TFrameMessage['data'],
-) => TFrameMessage['response']
+  event: TFrameMessage["data"],
+) => TFrameMessage["response"];
 
 /**
  * Adds React hook support (resourceName resolution) to core types.
@@ -3734,7 +3911,7 @@ export declare type WindowMessageHandler<TFrameMessage extends FrameMessage> = (
  */
 declare type WithResourceNameSupport<
   T extends {
-    resource?: DocumentResource
+    resource?: DocumentResource;
   },
 > = T & {
   /**
@@ -3742,18 +3919,18 @@ declare type WithResourceNameSupport<
    * If provided, will be resolved to a `DocumentResource` via `ResourcesContext`.
    * @beta
    */
-  resourceName?: string
+  resourceName?: string;
   /**
    * @deprecated Use `resourceName` instead.
    * @beta
    */
-  sourceName?: string
-}
+  sourceName?: string;
+};
 
 declare interface WorkspacesByProjectIdDataset {
-  [key: `${string}:${string}`]: DashboardResource[]
+  [key: `${string}:${string}`]: DashboardResource[];
 }
 
-export * from '@sanity/sdk'
+export * from "@sanity/sdk";
 
-export {}
+export {};