@sanity/sdk-react 2.10.0 → 2.11.0

package/dist/index.d.ts

@@ -6,7 +6,6 @@ import {AgentPromptOptions} from '@sanity/sdk'
 import {AgentPromptResult} from '@sanity/sdk'
 import {AgentTransformOptions} from '@sanity/sdk'
 import {AgentTranslateOptions} from '@sanity/sdk'
-import {ApplyDocumentActionsOptions} from '@sanity/sdk'
 import {AuthState} from '@sanity/sdk'
 import {CanvasResource} from '@sanity/message-protocol'
 import {ClientOptions} from '@sanity/sdk'
@@ -16,10 +15,11 @@ import {DatasetHandle} from '@sanity/sdk'
 import {DatasetsResponse} from '@sanity/client'
 import {DocumentAction} from '@sanity/sdk'
 import {DocumentEvent} from '@sanity/sdk'
-import {DocumentHandle} 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'
@@ -27,9 +27,15 @@ 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 {ProjectHandle} 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'
@@ -41,8 +47,6 @@ import {SanityConfig} from '@sanity/sdk'
 import {SanityDocument} from '@sanity/types'
 import {SanityDocument as SanityDocument_2} from 'groq'
 import {SanityInstance} from '@sanity/sdk'
-import {SanityProject} from '@sanity/sdk'
-import {SanityProject as SanityProject_2} from '@sanity/client'
 import {SanityProjectionResult} from 'groq'
 import {SanityProjectMember} from '@sanity/client'
 import {SanityQueryResult} from 'groq'
@@ -177,6 +181,22 @@ declare interface DispatchIntent {
   dispatchIntent: () => void
 }
 
+/**
+ * React SDK document handle. Adds `resourceName` to the core `DocumentHandle`.
+ *
+ * Import from `@sanity/sdk-react` (not `@sanity/sdk`) when writing option types
+ * for hooks — this version understands `resourceName` resolution.
+ *
+ * @public
+ */
+export declare interface DocumentHandle<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentHandle_2<TDocumentType, TDataset, TProjectId> {
+  resourceName?: string
+}
+
 declare interface DocumentInteractionHistory {
   recordEvent: (eventType: 'viewed' | 'edited' | 'created' | 'deleted') => void
 }
@@ -192,7 +212,7 @@ export declare interface DocumentsOptions<
   TDataset extends string = string,
   TProjectId extends string = string,
 >
-  extends DatasetHandle<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.
    */
@@ -230,7 +250,7 @@ export declare interface DocumentsResponse<
   /**
    * Array of document handles for the current batch
    */
-  data: DocumentHandle<TDocumentType, TDataset, TProjectId>[]
+  data: DocumentHandle_2<TDocumentType, TDataset, TProjectId>[]
   /**
    * Whether there are more items available to load
    */
@@ -249,6 +269,18 @@ export declare interface DocumentsResponse<
   loadMore: () => void
 }
 
+/**
+ * React SDK document-type handle. Adds `resourceName` to the core `DocumentTypeHandle`.
+ * @public
+ */
+export declare interface DocumentTypeHandle<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentTypeHandle_2<TDocumentType, TDataset, TProjectId> {
+  resourceName?: string
+}
+
 /**
  * @internal
  */
@@ -328,7 +360,9 @@ export declare interface PaginatedDocumentsOptions<
   TDocumentType extends string = string,
   TDataset extends string = string,
   TProjectId extends string = string,
-> extends Omit<QueryOptions<TDocumentType, TDataset, TProjectId>, 'query'> {
+> extends WithResourceNameSupport<
+  Omit<QueryOptions<TDocumentType, TDataset, TProjectId>, 'query'>
+> {
   documentType?: TDocumentType | TDocumentType[]
   /**
    * GROQ filter expression to apply to the query
@@ -363,7 +397,7 @@ export declare interface PaginatedDocumentsResponse<
   /**
    * Array of document handles for the current page
    */
-  data: DocumentHandle<TDocumentType, TDataset, TProjectId>[]
+  data: DocumentHandle_2<TDocumentType, TDataset, TProjectId>[]
   /**
    * Whether a query is currently in progress
    */
@@ -435,8 +469,9 @@ export declare interface PaginatedDocumentsResponse<
  * @public
  * @category Types
  * @interface
+ * @deprecated use the Project type directly.
  */
-export declare type ProjectWithoutMembers = Omit<SanityProject_2, 'members'>
+export declare type ProjectWithoutMembers = Project
 
 /**
  * This version is provided by pkg-utils at build time
@@ -457,53 +492,46 @@ declare interface RenderSanitySDKAppOptions {
 }
 
 /**
- * Provides a Sanity instance to child components through React Context
+ * React SDK resource handle — extends the core DatasetHandle with `resourceName`
+ * for context-based resource resolution.
  *
- * @internal
- *
- * @remarks
- * The ResourceProvider creates a hierarchical structure of Sanity instances:
- * - When used as a root provider, it creates a new Sanity instance with the given config
- * - When nested inside another ResourceProvider, it creates a child instance that
- *   inherits and extends the parent's configuration
+ * Use this (or its subtypes) as the options type for custom hooks that need to
+ * accept a resource. It accepts a `resource` object, a `resourceName` registered
+ * via the `resources` prop on `<SanityApp>`, or a bare `projectId`/`dataset` pair
+ * for backward compatibility.
  *
- * Features:
- * - Automatically manages the lifecycle of Sanity instances
- * - Disposes instances when the component unmounts
- * - Includes a Suspense boundary for data loading
- * - Enables hierarchical configuration inheritance
+ * @public
+ */
+export declare interface ResourceHandle<
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DatasetHandle<TDataset, TProjectId> {
+  /**
+   * Name of a resource registered via the `resources` prop on `<SanityApp>`.
+   * Resolved to a `DocumentResource` at the React layer.
+   */
+  resourceName?: string
+}
+
+/**
+ * Provides Sanity configuration to child components through React Context.
  *
- * Use this component to:
- * - Set up project/dataset configuration for an application
- * - Override specific configuration values in a section of your app
- * - Create isolated instance hierarchies for different features
+ * @internal
  *
- * @example Creating a root provider
+ * @example
  * ```tsx
  * <ResourceProvider
- *   projectId="your-project-id"
- *   dataset="production"
+ *   resource={{ projectId: 'your-project-id', dataset: 'production' }}
  *   fallback={<LoadingSpinner />}
  * >
  *   <YourApp />
  * </ResourceProvider>
  * ```
- *
- * @example Creating nested providers with configuration inheritance
- * ```tsx
- * // Root provider with production config with nested provider for preview features with custom dataset
- * <ResourceProvider projectId="abc123" dataset="production" fallback={<Loading />}>
- *   <div>...Main app content</div>
- *   <Dashboard />
- *   <ResourceProvider dataset="preview" fallback={<Loading />}>
- *     <PreviewFeatures />
- *   </ResourceProvider>
- * </ResourceProvider>
- * ```
  */
 export declare function ResourceProvider({
   children,
   fallback,
+  resource,
   ...config
 }: ResourceProviderProps): React.ReactNode
 
@@ -513,8 +541,14 @@ export declare function ResourceProvider({
  */
 export declare interface ResourceProviderProps extends SanityConfig {
   /**
-   * React node to show while content is loading
-   * Used as the fallback for the internal Suspense boundary
+   * The document resource (project/dataset, media library, or canvas)
+   * for this subtree. Hooks that don't specify an explicit resource will
+   * use this value.
+   */
+  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
@@ -679,8 +713,6 @@ export {SanityProjectMember}
  * @internal
  *
  * Top-level context provider that provides access to the Sanity SDK.
- * Creates a hierarchy of ResourceProviders, each providing a SanityInstance that can be
- * accessed by hooks. The first configuration in the array becomes the default instance.
  */
 export declare function SDKProvider({
   children,
@@ -789,30 +821,13 @@ declare interface Subscription {
 
 declare type Updater<TValue> = TValue | ((currentValue: TValue) => TValue)
 
-/**
- * @public
-
- * Returns the active releases for the current project,
- * represented as a list of release documents.
- *
- * @returns The active releases for the current project.
- * @category Projects
- * @example
- * ```tsx
- * import {useActiveReleases} from '@sanity/sdk-react'
- *
- * const activeReleases = useActiveReleases()
- * ```
- */
-declare type UseActiveReleases = {
-  (options?: WithResourceNameSupport<SanityConfig> | undefined): ReleaseDocument[]
-}
-
 /**
  * @public
  * @function
  */
-export declare const useActiveReleases: UseActiveReleases
+export declare function useActiveReleases(
+  options?: WithResourceNameSupport<SanityConfig> | undefined,
+): ReleaseDocument[]
 
 /**
  * @alpha
@@ -881,9 +896,9 @@ export declare const useActiveReleases: UseActiveReleases
  *
  * @category Agent Actions
  */
-export declare const useAgentGenerate: () => (
-  options: AgentGenerateOptions,
-) => Subscribable<unknown>
+export declare function useAgentGenerate(
+  resourceHandle?: ResourceHandle,
+): (options: AgentGenerateOptions) => Subscribable<unknown>
 
 /**
  * @alpha
@@ -1034,7 +1049,9 @@ export declare const useAgentGenerate: () => (
  *
  * @category Agent Actions
  */
-export declare const useAgentPatch: () => (options: AgentPatchOptions) => Promise<AgentPatchResult>
+export declare function useAgentPatch(
+  resourceHandle?: ResourceHandle,
+): (options: AgentPatchOptions) => Promise<AgentPatchResult>
 
 /**
  * @alpha
@@ -1130,9 +1147,9 @@ export declare const useAgentPatch: () => (options: AgentPatchOptions) => Promis
  *
  * @category Agent Actions
  */
-export declare const useAgentPrompt: () => (
-  options: AgentPromptOptions,
-) => Promise<AgentPromptResult>
+export declare function useAgentPrompt(
+  resourceHandle?: ResourceHandle,
+): (options: AgentPromptOptions) => Promise<AgentPromptResult>
 
 /**
  * @public
@@ -1237,9 +1254,9 @@ export declare function useAgentResourceContext(options: AgentResourceContextOpt
  *
  * @category Agent Actions
  */
-export declare const useAgentTransform: () => (
-  options: AgentTransformOptions,
-) => Subscribable<unknown>
+export declare function useAgentTransform(
+  resourceHandle?: ResourceHandle,
+): (options: AgentTransformOptions) => Subscribable<unknown>
 
 /**
  * @alpha
@@ -1331,9 +1348,9 @@ export declare const useAgentTransform: () => (
  *
  * @category Agent Actions
  */
-export declare const useAgentTranslate: () => (
-  options: AgentTranslateOptions,
-) => Subscribable<unknown>
+export declare function useAgentTranslate(
+  resourceHandle?: ResourceHandle,
+): (options: AgentTranslateOptions) => Subscribable<unknown>
 
 /**
  * @public
@@ -1347,7 +1364,7 @@ declare interface UseApplyDocumentActions {
     action:
       | DocumentAction<TDocumentType, TDataset, TProjectId>
       | DocumentAction<TDocumentType, TDataset, TProjectId>[],
-    options?: WithResourceNameSupport<ApplyDocumentActionsOptions>,
+    options?: ResourceHandle,
   ) => Promise<ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>>
 }
 
@@ -1785,7 +1802,7 @@ export declare function useDispatchIntent(params: UseDispatchIntentParams): Disp
 declare interface UseDispatchIntentParams {
   action?: 'edit'
   intentId?: string
-  documentHandle: WithResourceNameSupport<DocumentHandle>
+  documentHandle: DocumentHandle
   parameters?: Record<string, unknown>
 }
 
@@ -2061,7 +2078,7 @@ export declare function useDocumentEvent<
 declare interface UseDocumentEventOptions<
   TDataset extends string = string,
   TProjectId extends string = string,
-> extends DatasetHandle<TDataset, TProjectId> {
+> extends ResourceHandle<TDataset, TProjectId> {
   onEvent: (documentEvent: DocumentEvent) => void
 }
 
@@ -2070,7 +2087,9 @@ declare type UseDocumentOptions<
   TDocumentType extends string = string,
   TDataset extends string = string,
   TProjectId extends string = string,
-> = WithResourceNameSupport<DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>>
+> = DocumentHandle<TDocumentType, TDataset, TProjectId> & {
+  path?: TPath
+}
 
 /**
  *
@@ -2150,7 +2169,9 @@ declare type UseDocumentOptions<
  * ```
  */
 export declare function useDocumentPermissions(
-  actionOrActions: DocumentAction | DocumentAction[],
+  actionOrActions:
+    | WithResourceNameSupport<DocumentAction>
+    | WithResourceNameSupport<DocumentAction>[],
 ): DocumentPermissionsResult
 
 /**
@@ -2218,7 +2239,7 @@ export declare function useDocumentPreview({
  * @public
  * @category Types
  */
-export declare interface useDocumentPreviewOptions extends WithResourceNameSupport<DocumentHandle> {
+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.
@@ -2379,7 +2400,7 @@ export declare interface useDocumentProjectionOptions<
   TDocumentType extends string = string,
   TDataset extends string = string,
   TProjectId extends string = string,
-> extends WithResourceNameSupport<DocumentHandle<TDocumentType, TDataset, TProjectId>> {
+> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   /** The GROQ projection string */
   projection: TProjection
   /** Optional parameters for the projection query */
@@ -2519,7 +2540,7 @@ export declare function useDocuments<
   filter,
   orderings,
   documentType,
-  ...options
+  ...rawOptions
 }: DocumentsOptions<TDocumentType, TDataset, TProjectId>): DocumentsResponse<
   TDocumentType,
   TDataset,
@@ -2559,7 +2580,7 @@ declare type UseDocumentSyncStatus = {
    * // <SyncIndicator doc={doc} />
    * ```
    */
-  (doc: DocumentHandle): boolean
+  (doc: DocumentHandle_2): boolean
 }
 
 /**
@@ -2771,7 +2792,7 @@ export declare function useManageFavorite({
   schemaName,
 }: UseManageFavoriteProps): ManageFavorite
 
-declare interface UseManageFavoriteProps extends DocumentHandle {
+declare interface UseManageFavoriteProps extends DocumentHandle_2 {
   resourceId?: string
   resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['type']
   /**
@@ -2826,10 +2847,75 @@ declare interface UseManageFavoriteProps extends DocumentHandle {
  * ```
  */
 export declare function useNavigateToStudioDocument(
-  documentHandle: DocumentHandle,
+  documentHandle: DocumentHandle_2,
   preferredStudioUrl?: string,
 ): NavigateToStudioResult
 
+/**
+ * Returns metadata for a given organisation.
+ *
+ * @category Organizations
+ * @param options - Configuration options
+ * @returns The metadata for the organisation. `members` is included only when
+ *   `includeMembers: true`; `features` is included only when `includeFeatures: true`.
+ * @example
+ * ```tsx
+ * function OrganizationName({organizationId}: {organizationId: string}) {
+ *   const organization = useOrganization({organizationId})
+ *
+ *   return <h1>{organization.name}</h1>
+ * }
+ * ```
+ * @example
+ * ```tsx
+ * const organizationWithMembers = useOrganization({organizationId, includeMembers: true})
+ * const organizationWithFeatures = useOrganization({organizationId, includeFeatures: true})
+ * ```
+ * @public
+ * @function
+ */
+export declare const useOrganization: <
+  IncludeMembers extends boolean = false,
+  IncludeFeatures extends boolean = false,
+>(
+  options: OrganizationOptions<IncludeMembers, IncludeFeatures>,
+) => Organization<IncludeMembers, IncludeFeatures>
+
+/**
+ * Returns metadata for each organisation the current user has access to.
+ *
+ * @category Organizations
+ * @param options - Configuration options
+ * @returns An array of organisation metadata. `members` is included only when
+ *   `includeMembers: true`; `features` is included only when `includeFeatures: true`.
+ * @example
+ * ```tsx
+ * const organizations = useOrganizations()
+ *
+ * return (
+ *   <select>
+ *     {organizations.map((organization) => (
+ *       <option key={organization.id}>{organization.name}</option>
+ *     ))}
+ *   </select>
+ * )
+ * ```
+ * @example
+ * ```tsx
+ * const organizationsWithMembers = useOrganizations({includeMembers: true})
+ * const organizationsWithFeatures = useOrganizations({includeFeatures: true})
+ * const organizationsIncludingImplicit = useOrganizations({includeImplicitMemberships: true})
+ * ```
+ * @public
+ * @function
+ */
+export declare const useOrganizations: <
+  IncludeMembers extends boolean = false,
+  IncludeFeatures extends boolean = false,
+>(
+  options?: OrganizationsOptions<IncludeMembers, IncludeFeatures>,
+) => Organizations<IncludeMembers, IncludeFeatures>
+
 /**
  * Retrieves pages of {@link DocumentHandle}s, narrowed by optional filters, text searches, and custom ordering,
  * with support for traditional paginated interfaces. The number of document handles returned per page is customizable,
@@ -2936,98 +3022,70 @@ export declare function usePaginatedDocuments<
   params,
   orderings,
   search,
-  ...options
+  ...rawOptions
 }: PaginatedDocumentsOptions<TDocumentType, TDataset, TProjectId>): PaginatedDocumentsResponse<
   TDocumentType,
   TDataset,
   TProjectId
 >
 
-/**
- * @public
- * @function
- *
- * Returns a single or stack of perspectives for the given perspective handle,
- * which can then be used to correctly query the documents
- * via the `perspective` parameter in the client.
- *
- * @param perspectiveHandle - The perspective handle to get the perspective for.
- * @category Documents
- * @example
- * ```tsx
- * import {usePerspective, useQuery} from '@sanity/sdk-react'
-
- * const perspective = usePerspective({perspective: 'rxg1346', projectId: 'abc123', dataset: 'production'})
- * const {data} = useQuery<Movie[]>('*[_type == "movie"]', {
- *   perspective: perspective,
- * })
- * ```
- *
- * @returns The perspective for the given perspective handle.
- */
-declare type UsePerspective = {
-  (perspectiveHandle: DatasetHandle): string | string[]
-}
-
 /**
  * @public
  * @function
  */
-export declare const usePerspective: UsePerspective
+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?: WithResourceNameSupport<DatasetHandle>): {
+export declare function usePresence(options?: ResourceHandle): {
   locations: UserPresence[]
 }
 
-declare type UseProject = {
-  /**
-   *
-   * Returns metadata for a given project
-   *
-   * @category Projects
-   * @param projectId - The ID of the project to retrieve metadata for
-   * @returns The metadata for the project
-   * @example
-   * ```tsx
-   *  function ProjectMetadata({ projectId }: { projectId: string }) {
-   *    const project = useProject(projectId)
-   *
-   *    return (
-   *      <figure style={{ backgroundColor: project.metadata.color || 'lavender'}}>
-   *        <h1>{project.displayName}</h1>
-   *      </figure>
-   *    )
-   *  }
-   * ```
-   */
-  (projectHandle?: ProjectHandle): SanityProject
-}
-
 /**
+ * Returns metadata for a given project.
+ *
+ * @category Projects
+ * @param options - Configuration options
+ * @returns The metadata for the project. `members` is included only when
+ *   `includeMembers: true`; `features` is included unless `includeFeatures: false`.
+ * @example
+ * ```tsx
+ * function ProjectMetadata({projectId}: {projectId: string}) {
+ *   const project = useProject({projectId})
+ *
+ *   return (
+ *     <figure style={{backgroundColor: project.metadata.color || 'lavender'}}>
+ *       <h1>{project.displayName}</h1>
+ *     </figure>
+ *   )
+ * }
+ * ```
+ * @example
+ * ```tsx
+ * const projectWithMembersAndFeatures = useProject({projectId})
+ * const projectWithMembers = useProject({projectId, includeMembers: true})
+ * const projectWithoutMembers = useProject({projectId, includeMembers: false})
+ * const projectWithoutFeatures = useProject({projectId, includeFeatures: false})
+ * ```
  * @public
  * @function
  */
-export declare const useProject: UseProject
-
-/**
- * @public
- * @category Types
- */
-declare type UseProjects = <TIncludeMembers extends boolean = false>(options?: {
-  organizationId?: string
-  includeMembers?: TIncludeMembers
-}) => TIncludeMembers extends true ? SanityProject_2[] : ProjectWithoutMembers[]
+export declare const useProject: <
+  IncludeMembers extends boolean = true,
+  IncludeFeatures extends boolean = true,
+>(
+  options?: ProjectOptions<IncludeMembers, IncludeFeatures>,
+) => Project<IncludeMembers, IncludeFeatures>
 
 /**
  * Returns metadata for each project you have access to.
  *
  * @category Projects
  * @param options - Configuration options
- * @returns An array of project metadata. If includeMembers is true, returns full SanityProject objects. Otherwise, returns ProjectWithoutMembers objects.
+ * @returns An array of project metadata. `members` is included only when
+ *   `includeMembers: true`; `features` is included unless `includeFeatures: false`.
  * @example
  * ```tsx
  * const projects = useProjects()
@@ -3042,13 +3100,21 @@ declare type UseProjects = <TIncludeMembers extends boolean = false>(options?: {
  * ```
  * @example
  * ```tsx
- * const projectsWithMembers = useProjects({ includeMembers: true })
- * const projectsWithoutMembers = useProjects({ includeMembers: false })
+ * const projects = useProjects()
+ * const projectsWithFeatures = useProjects()
+ * const projectsWithMembers = useProjects({includeMembers: true})
+ * const projectsWithoutMembers = useProjects({includeMembers: false})
+ * const projectsWithoutFeatures = useProjects({includeFeatures: false})
  * ```
  * @public
  * @function
  */
-export declare const useProjects: UseProjects
+export declare const useProjects: <
+  IncludeMembers extends boolean = false,
+  IncludeFeatures extends boolean = true,
+>(
+  options?: ProjectsOptions<IncludeMembers, IncludeFeatures>,
+) => Project<IncludeMembers, IncludeFeatures>[]
 
 /**
  * @public
@@ -3215,7 +3281,7 @@ export declare function useRecordDocumentHistoryEvent({
 /**
  * @internal
  */
-declare interface UseRecordDocumentHistoryEventProps extends DocumentHandle {
+declare interface UseRecordDocumentHistoryEventProps extends DocumentHandle_2 {
   resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['type']
   resourceId?: string
   /**
@@ -3225,6 +3291,25 @@ declare interface UseRecordDocumentHistoryEventProps extends DocumentHandle {
   schemaName?: string
 }
 
+/**
+ * Returns the currently active `DocumentResource` for the nearest resource context.
+ *
+ * Resolves in priority order:
+ * 1. A `resource` prop on the nearest `<ResourceProvider>`
+ * 2. The `projectId`/`dataset` from the current `SanityInstance` config
+ * 3. `undefined` when neither is available
+ *
+ * @public
+ * @category Platform
+ *
+ * @example
+ * ```tsx
+ * const resource = useResource()
+ * console.log(resource?.projectId, resource?.dataset)
+ * ```
+ */
+export declare function useResource(): DocumentResource | undefined
+
 /**
  * @public
  * @category Types
@@ -3264,60 +3349,33 @@ export declare interface UsersResult {
 }
 
 /**
- * Retrieves the current Sanity instance or finds a matching instance from the hierarchy
+ * Retrieves the current Sanity instance from context
  *
  * @public
  *
  * @category Platform
- * @param config - Optional configuration to match against when finding an instance
- * @returns The current or matching Sanity instance
+ * @param config - Deprecated. Formerly used to match against the instance hierarchy.
+ * @returns The current Sanity instance
  *
  * @remarks
- * This hook accesses the nearest Sanity instance from the React context. When provided with
- * a configuration object, it traverses up the instance hierarchy to find the closest instance
- * that matches the specified configuration using shallow comparison of properties.
- *
+ * This hook accesses the nearest Sanity instance from the React context.
  * The hook must be used within a component wrapped by a `ResourceProvider` or `SanityApp`.
  *
- * Use this hook when you need to:
- * - Access the current SanityInstance from context
- * - Find a specific instance with matching project/dataset configuration
- * - Access a parent instance with specific configuration values
- *
  * @example Get the current instance
  * ```tsx
- * // Get the current instance from context
  * const instance = useSanityInstance()
  * console.log(instance.config.projectId)
  * ```
  *
- * @example Find an instance with specific configuration
- * ```tsx
- * // Find an instance matching the given project and dataset
- * const instance = useSanityInstance({
- *   projectId: 'abc123',
- *   dataset: 'production'
- * })
- *
- * // Use instance for API calls
- * const fetchDocument = (docId) => {
- *   // Instance is guaranteed to have the matching config
- *   return client.fetch(`*[_id == $id][0]`, { id: docId })
- * }
- * ```
- *
- * @example Match partial configuration
- * ```tsx
- * // Find an instance with specific auth configuration
- * const instance = useSanityInstance({
- *   auth: { requireLogin: true }
- * })
- * ```
- *
  * @throws Error if no SanityInstance is found in context
- * @throws Error if no matching instance is found for the provided config
  */
-export declare const useSanityInstance: (config?: SanityConfig) => SanityInstance
+export declare const useSanityInstance: (
+  /**
+   * @deprecated Passing a config to match against the instance hierarchy is deprecated.
+   * Use `useSanityInstance()` without arguments instead.
+   */
+  config?: SanityConfig,
+) => SanityInstance
 
 /**
  * Hook that fetches studio workspaces and organizes them by projectId:dataset
@@ -3549,10 +3607,9 @@ export declare type WindowMessageHandler<TFrameMessage extends FrameMessage> = (
 
 /**
  * Adds React hook support (resourceName resolution) to core types.
- * This wrapper allows hooks to accept `resourceName` as a convenience,
- * which is then resolved to a `DocumentResource` at the React layer.
- * For now, we are trying to avoid resource name resolution in core --
- * functions having resources explicitly passed will reduce complexity.
+ * Prefer using the React-layer handle types (ResourceHandle, DocumentHandle)
+ * from `@sanity/sdk-react` — this wrapper is kept for cases where overloads
+ * don't fit (e.g. non-handle options objects).
  *
  * @typeParam T - The core type to extend (must have optional `resource` field)
  * @beta