@sanity/sdk 0.0.0-rc.6 → 0.0.0

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 import {AuthStoreState as AuthStoreState_2} from './authStore'
 import {BoundStoreAction} from '../store/createActionBinder'
 import {BoundStoreAction as BoundStoreAction_2} from '../../store/createActionBinder'
+import {CanvasResource} from '@sanity/message-protocol'
 import {ChannelInput} from '@sanity/comlink'
 import {ChannelInstance} from '@sanity/comlink'
 import {ClientConfig} from '@sanity/client'
+import {ClientPerspective} from '@sanity/client'
 import {Controller} from '@sanity/comlink'
 import {CurrentUser} from '@sanity/types'
 import {DatasetsResponse} from '@sanity/client'
@@ -11,6 +13,7 @@ import {DocumentPermissionsResult as DocumentPermissionsResult_2} from './permis
 import {FetcherStoreState as FetcherStoreState_2} from '../_exports'
 import {IndexTuple} from '@sanity/types'
 import {ListenEvent} from '@sanity/client'
+import {MediaResource} from '@sanity/message-protocol'
 import {Message} from '@sanity/comlink'
 import {Mutation} from '@sanity/types'
 import {Node as Node_2} from '@sanity/comlink'
@@ -20,17 +23,20 @@ import {PatchMutation} from '@sanity/mutate/_unstable_store'
 import {PatchOperations} from '@sanity/types'
 import {PathSegment} from '@sanity/types'
 import {PreviewStoreState as PreviewStoreState_2} from './previewStore'
-import {ProjectionStoreState} from './types'
-import {ProjectionValuePending as ProjectionValuePending_2} from './types'
 import {ResponseQueryOptions} from '@sanity/client'
 import {Role} from '@sanity/types'
 import {SanityClient} from '@sanity/client'
 import {SanityDocument} from '@sanity/types'
 import {SanityDocument as SanityDocument_2} from '@sanity/client'
 import {SanityDocumentLike} from '@sanity/types'
+import {SanityDocumentResult} from 'groq'
 import {SanityProject as SanityProject_2} from '@sanity/client'
+import {SanityProjectionResult} from 'groq'
+import {SanityQueryResult} from 'groq'
 import {SanityUser as SanityUser_2} from './types'
+import {StackablePerspective} from '@sanity/client'
 import {StateSource as StateSource_2} from '../_exports'
+import {StudioResource} from '@sanity/message-protocol'
 import {Subject} from 'rxjs'
 import {ValuePending as ValuePending_2} from './previewStore'
 
@@ -69,7 +75,9 @@ declare type ActionMap = {
 }
 
 /** @beta */
-export declare interface ActionsResult<TDocument extends SanityDocument = SanityDocument> {
+export declare interface ActionsResult<
+  TDocument extends SanityDocumentResult = SanityDocumentResult,
+> {
   transactionId: string
   documents: DocumentSet<TDocument>
   previous: DocumentSet<TDocument>
@@ -166,11 +174,17 @@ declare interface AppliedTransaction extends QueuedTransaction {
 }
 
 /** @beta */
-export declare function applyDocumentActions<TDocument extends SanityDocument>(
+export declare function applyDocumentActions<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
   instance: SanityInstance,
-  action: DocumentAction<TDocument> | DocumentAction<TDocument>[],
+  action:
+    | DocumentAction<TDocumentType, TDataset, TProjectId>
+    | DocumentAction<TDocumentType, TDataset, TProjectId>[],
   options?: ApplyDocumentActionsOptions,
-): Promise<ActionsResult<TDocument>>
+): Promise<ActionsResult<SanityDocumentResult<TDocumentType, TDataset, TProjectId>>>
 
 /** @beta */
 export declare function applyDocumentActions(
@@ -370,19 +384,21 @@ declare interface ChannelEntry {
  *
  * @public
  */
-export declare interface ClientOptions
-  extends Pick<ClientConfig, AllowedClientConfigKey>,
-    DatasetHandle {
+export declare interface ClientOptions extends Pick<ClientConfig, AllowedClientConfigKey> {
   /**
    * An optional flag to choose between the default client (typically project-level)
    * and the global client ('global'). When set to `'global'`, the global client
    * is used.
    */
-  scope?: 'default' | 'global'
+  'scope'?: 'default' | 'global'
   /**
    * A required string indicating the API version for the client.
    */
-  apiVersion: string
+  'apiVersion': string
+  /**
+   * @internal
+   */
+  '~experimental_resource'?: ClientConfig['~experimental_resource']
 }
 
 /**
@@ -438,18 +454,75 @@ declare interface ContextNode extends BaseNode {
  */
 export declare const CORE_SDK_VERSION: {}
 
-/** @beta */
-export declare function createDocument<TDocument extends SanityDocumentLike>(
-  doc: DocumentTypeHandle<TDocument>,
-): CreateDocumentAction<TDocument>
+/**
+ * Creates or validates a `DatasetHandle` object.
+ * Ensures the provided object conforms to the `DatasetHandle` interface.
+ * @param handle - The object containing dataset identification properties.
+ * @returns The validated `DatasetHandle` object.
+ * @public
+ */
+export declare function createDatasetHandle<
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(handle: DatasetHandle<TDataset, TProjectId>): DatasetHandle<TDataset, TProjectId>
 
-/** @beta */
+/**
+ * Creates a `CreateDocumentAction` object.
+ * @param doc - A handle identifying the document type, dataset, and project. An optional `documentId` can be provided.
+ * @returns A `CreateDocumentAction` object ready for dispatch.
+ * @beta
+ */
+export declare function createDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>,
+): CreateDocumentAction<TDocumentType, TDataset, TProjectId>
+
+/**
+ * Represents an action to create a new document.
+ * Specifies the document type and optionally a document ID (which will be treated as the published ID).
+ * @beta
+ */
 export declare interface CreateDocumentAction<
-  TDocument extends SanityDocumentLike = SanityDocumentLike,
-> extends DocumentTypeHandle<TDocument> {
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentTypeHandle<TDocumentType, TDataset, TProjectId> {
   type: 'document.create'
 }
 
+/**
+ * Creates or validates a `DocumentHandle` object.
+ * Ensures the provided object conforms to the `DocumentHandle` interface.
+ * @param handle - The object containing document identification properties.
+ * @returns The validated `DocumentHandle` object.
+ * @public
+ */
+export declare function createDocumentHandle<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  handle: DocumentHandle<TDocumentType, TDataset, TProjectId>,
+): DocumentHandle<TDocumentType, TDataset, TProjectId>
+
+/**
+ * Creates or validates a `DocumentTypeHandle` object.
+ * Ensures the provided object conforms to the `DocumentTypeHandle` interface.
+ * @param handle - The object containing document type identification properties.
+ * @returns The validated `DocumentTypeHandle` object.
+ * @public
+ */
+export declare function createDocumentTypeHandle<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  handle: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>,
+): DocumentTypeHandle<TDocumentType, TDataset, TProjectId>
+
 /**
  * Creates a GROQ search filter string (`[@] match text::query("...")`)
  * from a raw search query string.
@@ -465,6 +538,17 @@ export declare interface CreateDocumentAction<
  */
 export declare function createGroqSearchFilter(query: string): string
 
+/**
+ * Creates or validates a `ProjectHandle` object.
+ * Ensures the provided object conforms to the `ProjectHandle` interface.
+ * @param handle - The object containing project identification properties.
+ * @returns The validated `ProjectHandle` object.
+ * @public
+ */
+export declare function createProjectHandle<TProjectId extends string = string>(
+  handle: ProjectHandle<TProjectId>,
+): ProjectHandle<TProjectId>
+
 /**
  * Creates a new Sanity resource instance
  * @param config - Configuration for the instance (optional)
@@ -491,8 +575,12 @@ declare interface DashboardContext {
 /**
  * @public
  */
-export declare interface DatasetHandle extends ProjectHandle {
-  dataset?: string | undefined
+export declare interface DatasetHandle<
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends ProjectHandle<TProjectId>,
+    PerspectiveHandle {
+  dataset?: TDataset
 }
 
 declare class DateTime {
@@ -510,33 +598,52 @@ declare class DateTime {
 declare type DateTimeValue = StaticValue<DateTime, 'datetime'>
 
 /**
- * Given a type T and an array of “access keys” Parts, recursively index into T.
+ * Given a type T and an array of "access keys" Parts, recursively index into T.
  *
  * If a part is a key, it looks up that property.
- * If T is an array and the part is a number, it “indexes” into the element type.
- */
-declare type DeepGet<T, TParts extends readonly unknown[]> = TParts extends [
-  infer Head,
-  ...infer Tail,
-]
-  ? Head extends keyof T
-    ? DeepGet<T[Head], Tail>
-    : T extends Array<infer U>
-      ? Head extends number
-        ? DeepGet<U, Tail>
-        : never
-      : never
-  : T
-
-/** @beta */
-export declare function deleteDocument<TDocument extends SanityDocumentLike>(
-  doc: DocumentHandle<TDocument>,
-): DeleteDocumentAction<TDocument>
+ * If T is an array and the part is a number, it "indexes" into the element type.
+ */
+declare type DeepGet<TValue, TPath extends readonly (string | number)[]> = TPath extends []
+  ? TValue
+  : TPath extends readonly [infer THead, ...infer TTail]
+    ? DeepGet<
+        TValue extends undefined | null
+          ? undefined
+          : THead extends keyof TValue
+            ? TValue[THead]
+            : THead extends number
+              ? TValue extends readonly (infer TElement)[]
+                ? TElement | undefined
+                : undefined
+              : undefined, // Key/index doesn't exist
+        TTail extends readonly (string | number)[] ? TTail : []
+      >
+    : never
+
+/**
+ * Creates a `DeleteDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document to be deleted.
+ * @returns A `DeleteDocumentAction` object ready for dispatch.
+ * @beta
+ */
+export declare function deleteDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
+): DeleteDocumentAction<TDocumentType, TDataset, TProjectId>
 
-/** @beta */
+/**
+ * Represents an action to delete an existing document.
+ * Requires the full document handle including the document ID.
+ * @beta
+ */
 export declare interface DeleteDocumentAction<
-  TDocument extends SanityDocumentLike = SanityDocumentLike,
-> extends DocumentHandle<TDocument> {
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   type: 'document.delete'
 }
 
@@ -560,15 +667,30 @@ declare interface DescNode extends BaseNode {
  */
 export declare const destroyController: BoundStoreAction_2<ComlinkControllerState, [], void>
 
-/** @beta */
-export declare function discardDocument<TDocument extends SanityDocumentLike>(
-  doc: DocumentHandle<TDocument>,
-): DiscardDocumentAction<TDocument>
+/**
+ * Creates a `DiscardDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document whose draft changes are to be discarded.
+ * @returns A `DiscardDocumentAction` object ready for dispatch.
+ * @beta
+ */
+export declare function discardDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
+): DiscardDocumentAction<TDocumentType, TDataset, TProjectId>
 
-/** @beta */
+/**
+ * Represents an action to discard the draft changes of a document.
+ * Requires the full document handle.
+ * @beta
+ */
 export declare interface DiscardDocumentAction<
-  TDocument extends SanityDocumentLike = SanityDocumentLike,
-> extends DocumentHandle<TDocument> {
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   type: 'document.discard'
 }
 
@@ -578,14 +700,21 @@ declare type Document_2 = {
   [T: string]: unknown
 }
 
-/** @beta */
-export declare type DocumentAction<TDocument extends SanityDocumentLike = SanityDocumentLike> =
-  | CreateDocumentAction<TDocument>
-  | DeleteDocumentAction<TDocument>
-  | EditDocumentAction<TDocument>
-  | PublishDocumentAction<TDocument>
-  | UnpublishDocumentAction<TDocument>
-  | DiscardDocumentAction<TDocument>
+/**
+ * Union type representing all possible document actions within the SDK.
+ * @beta
+ */
+export declare type DocumentAction<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> =
+  | CreateDocumentAction<TDocumentType, TDataset, TProjectId>
+  | DeleteDocumentAction<TDocumentType, TDataset, TProjectId>
+  | EditDocumentAction<TDocumentType, TDataset, TProjectId>
+  | PublishDocumentAction<TDocumentType, TDataset, TProjectId>
+  | UnpublishDocumentAction<TDocumentType, TDataset, TProjectId>
+  | DiscardDocumentAction<TDocumentType, TDataset, TProjectId>
 
 /**
  * @beta
@@ -641,17 +770,32 @@ export declare type DocumentEvent =
   | DocumentDiscardedEvent
 
 /**
+ * Uniquely identifies a specific document within a Sanity dataset and project.
+ * Includes `projectId`, `dataset`, `documentType`, and the required `documentId`.
+ * Commonly used by document-related hooks and components to reference a document without fetching its full content initially.
  * @public
- * A minimal set of metadata for a given document, comprising the document's ID and type.
- * Used by most document-related hooks (such as {@link usePreview}, {@link useDocument}, and {@link useEditDocument})
- * to reference a particular document without fetching the entire document upfront.
- * @category Types
  */
-export declare interface DocumentHandle<TDocument extends SanityDocumentLike = SanityDocumentLike>
-  extends DocumentTypeHandle<TDocument> {
+export declare interface DocumentHandle<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentTypeHandle<TDocumentType, TDataset, TProjectId> {
   documentId: string
 }
 
+/**
+ * @beta
+ * Options for specifying a document and optionally a path within it.
+ */
+export declare interface DocumentOptions<
+  TPath extends string | undefined = undefined,
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  path?: TPath
+}
+
 /** @beta */
 export declare type DocumentPermissionsResult =
   | {
@@ -748,12 +892,19 @@ declare interface DocumentStoreState {
   events: Subject<DocumentEvent>
 }
 
-/** @public */
+/**
+ * Identifies a specific document type within a Sanity dataset and project.
+ * Includes `projectId`, `dataset`, and `documentType`.
+ * Optionally includes a `documentId`, useful for referencing a specific document type context, potentially without a specific document ID.
+ * @public
+ */
 export declare interface DocumentTypeHandle<
-  TDocument extends SanityDocumentLike = SanityDocumentLike,
-> extends DatasetHandle {
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DatasetHandle<TDataset, TProjectId> {
   documentId?: string
-  documentType: TDocument['_type']
+  documentType: TDocumentType
 }
 
 /**
@@ -766,22 +917,51 @@ export declare interface DocumentUnpublishedEvent {
   outgoing: OutgoingTransaction
 }
 
-/** @beta */
-export declare function editDocument<TDocument extends SanityDocumentLike>(
-  doc: DocumentHandle<TDocument>,
+/**
+ * Creates an `EditDocumentAction` object with patches for modifying a document.
+ * Accepts patches in either the standard `PatchOperations` format or as a `SanityMutatePatchMutation` from `@sanity/mutate`.
+ *
+ * @param doc - A handle uniquely identifying the document to be edited.
+ * @param sanityMutatePatch - A patch mutation object from `@sanity/mutate`.
+ * @returns An `EditDocumentAction` object ready for dispatch.
+ * @beta
+ */
+export declare function editDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
   sanityMutatePatch: PatchMutation,
-): EditDocumentAction<TDocument>
+): EditDocumentAction<TDocumentType, TDataset, TProjectId>
 
-/** @beta */
-export declare function editDocument<TDocument extends SanityDocumentLike>(
-  doc: DocumentHandle<TDocument>,
+/**
+ * Creates an `EditDocumentAction` object with patches for modifying a document.
+ *
+ * @param doc - A handle uniquely identifying the document to be edited.
+ * @param patches - A single patch operation or an array of patch operations.
+ * @returns An `EditDocumentAction` object ready for dispatch.
+ * @beta
+ */
+export declare function editDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
   patches?: PatchOperations | PatchOperations[],
-): EditDocumentAction<TDocument>
+): EditDocumentAction<TDocumentType, TDataset, TProjectId>
 
-/** @beta */
+/**
+ * Represents an action to edit an existing document using patches.
+ * Requires the full document handle and an array of patch operations.
+ * @beta
+ */
 export declare interface EditDocumentAction<
-  TDocument extends SanityDocumentLike = SanityDocumentLike,
-> extends DocumentHandle<TDocument> {
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   type: 'document.edit'
   patches?: PatchOperations[]
 }
@@ -839,6 +1019,22 @@ declare type ExprNode =
   | TupleNode
   | ValueNode
 
+/**
+ * @public
+ */
+declare interface FavoriteDocumentContext extends DocumentHandle {
+  resourceId: string
+  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['type']
+  schemaName?: string
+}
+
+/**
+ * @public
+ */
+export declare interface FavoriteStatusResponse {
+  isFavorited: boolean
+}
+
 /**
  * Internal helper type
  * @public
@@ -889,6 +1085,16 @@ declare interface FuncCallNode extends BaseNode {
   args: ExprNode[]
 }
 
+/**
+ * Get the active releases from the store.
+ * @internal
+ */
+export declare const getActiveReleasesState: BoundStoreAction<
+  ReleasesStoreState,
+  [],
+  StateSource_2<ReleaseDocument[] | undefined>
+>
+
 /**
  * @public
  */
@@ -946,41 +1152,60 @@ export declare const getDashboardOrganizationId: BoundStoreAction<
 
 /** @public */
 export declare const getDatasetsState: BoundStoreAction<
-  FetcherStoreState_2<[options?: ProjectHandle | undefined], DatasetsResponse>,
-  [options?: ProjectHandle | undefined],
+  FetcherStoreState_2<[options?: ProjectHandle<string> | undefined], DatasetsResponse>,
+  [options?: ProjectHandle<string> | undefined],
   StateSource_2<DatasetsResponse | undefined>
 >
 
 /** @beta */
 export declare function getDocumentState<
-  TDocument extends SanityDocument,
-  TPath extends JsonMatchPath<TDocument>,
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
 >(
   instance: SanityInstance,
-  doc: string | DocumentHandle<TDocument>,
-  path: TPath,
-): StateSource<JsonMatch<TDocument, TPath> | undefined>
+  options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>,
+): StateSource<SanityDocumentResult<TDocumentType, TDataset, TProjectId> | undefined | null>
 
 /** @beta */
-export declare function getDocumentState<TDocument extends SanityDocument>(
+export declare function getDocumentState<
+  TPath extends string = string,
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
   instance: SanityInstance,
-  doc: string | DocumentHandle<TDocument>,
-): StateSource<TDocument | null>
+  options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>,
+): StateSource<
+  JsonMatch<SanityDocumentResult<TDocumentType, TDataset, TProjectId>, TPath> | undefined
+>
 
 /** @beta */
-export declare function getDocumentState(
+export declare function getDocumentState<TData>(
   instance: SanityInstance,
-  doc: string | DocumentHandle,
-  path?: string,
-): StateSource<unknown>
+  options: DocumentOptions<string | undefined>,
+): StateSource<TData | undefined | null>
 
 /** @beta */
 export declare const getDocumentSyncStatus: BoundStoreAction<
   DocumentStoreState,
-  [doc: DocumentHandle<SanityDocumentLike>],
+  [doc: DocumentHandle<string, string, string>],
   StateSource<boolean | undefined>
 >
 
+/**
+ * Gets a StateSource for the favorite status of a document.
+ * @param instance - The Sanity instance.
+ * @param context - The document context including ID, type, and resource information.
+ * @returns A StateSource emitting `{ isFavorited: boolean }`.
+ * @public
+ */
+export declare const getFavoritesState: BoundStoreAction<
+  FetcherStoreState_2<[FavoriteDocumentContext], FavoriteStatusResponse>,
+  [FavoriteDocumentContext],
+  StateSource_2<FavoriteStatusResponse | undefined>
+>
+
 /**
  * @public
  */
@@ -1027,6 +1252,24 @@ export declare const getPermissionsState: BoundStoreAction<
   StateSource<DocumentPermissionsResult_2 | undefined>
 >
 
+/**
+ * Provides a subscribable state source for a "perspective" for the Sanity client,
+ * which is used to fetch documents as though certain Content Releases are active.
+ *
+ * @param instance - The Sanity instance to get the perspective for
+ * @param options - The options for the perspective -- usually a release name
+ *
+ * @returns A subscribable perspective value, usually a list of applicable release names,
+ * or a single release name / default perspective (such as 'drafts').
+ *
+ * @public
+ */
+export declare const getPerspectiveState: BoundStoreAction<
+  ReleasesStoreState,
+  [options?: PerspectiveHandle | undefined],
+  StateSource_2<string[] | 'published' | 'drafts' | 'previewDrafts' | 'raw' | undefined>
+>
+
 /**
  * @beta
  */
@@ -1051,22 +1294,34 @@ export declare type GetPreviewStateOptions = DocumentHandle
 /**
  * @beta
  */
-export declare function getProjectionState<TResult extends object>(
+export declare function getProjectionState<
+  TProjection extends ValidProjection = ValidProjection,
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
   instance: SanityInstance,
-  options: GetProjectionStateOptions,
-): StateSource<ProjectionValuePending<TResult>>
+  options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
+): StateSource<
+  | ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, TDataset, TProjectId>>
+  | undefined
+>
 
 /**
  * @beta
  */
-export declare function getProjectionState(
+export declare function getProjectionState<TData extends object>(
   instance: SanityInstance,
-  options: GetProjectionStateOptions,
-): StateSource<ProjectionValuePending<Record<string, unknown>>>
+  options: ProjectionOptions,
+): StateSource<ProjectionValuePending<TData> | undefined>
 
-declare interface GetProjectionStateOptions extends DocumentHandle {
-  projection: ValidProjection
-}
+/**
+ * @beta
+ */
+export declare function getProjectionState(
+  instance: SanityInstance,
+  options: ProjectionOptions,
+): StateSource<ProjectionValuePending<Record<string, unknown>> | undefined>
 
 /** @public */
 export declare const getProjectsState: BoundStoreAction<
@@ -1077,13 +1332,13 @@ export declare const getProjectsState: BoundStoreAction<
 
 /** @public */
 export declare const getProjectState: BoundStoreAction<
-  FetcherStoreState_2<[options?: ProjectHandle | undefined], SanityProject_2>,
-  [options?: ProjectHandle | undefined],
+  FetcherStoreState_2<[options?: ProjectHandle<string> | undefined], SanityProject_2>,
+  [options?: ProjectHandle<string> | undefined],
   StateSource_2<SanityProject_2 | undefined>
 >
 
 /** @beta */
-export declare const getQueryKey: (query: string, options?: QueryOptions) => string
+export declare const getQueryKey: (options: QueryOptions) => string
 
 /**
  * Returns the state source for a query.
@@ -1101,17 +1356,25 @@ export declare const getQueryKey: (query: string, options?: QueryOptions) => str
  *
  * @beta
  */
-export declare function getQueryState<T>(
+export declare function getQueryState<
+  TQuery extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
   instance: SanityInstance,
-  query: string,
-  options?: QueryOptions,
-): StateSource<T | undefined>
+  queryOptions: QueryOptions<TQuery, TDataset, TProjectId>,
+): StateSource<SanityQueryResult<TQuery, TDataset, TProjectId> | undefined>
+
+/** @beta */
+export declare function getQueryState<TData>(
+  instance: SanityInstance,
+  queryOptions: QueryOptions,
+): StateSource<TData | undefined>
 
 /** @beta */
 export declare function getQueryState(
   instance: SanityInstance,
-  query: string,
-  options?: QueryOptions,
+  queryOptions: QueryOptions,
 ): StateSource<unknown>
 
 /**
@@ -1256,7 +1519,7 @@ declare interface InRangeNode extends BaseNode {
  * compute the type found at that path.
  * @beta
  */
-export declare type JsonMatch<TDocument extends SanityDocumentLike, TPath extends string> = DeepGet<
+export declare type JsonMatch<TDocument, TPath extends string> = DeepGet<
   TDocument,
   PathParts<TPath>
 >
@@ -1274,21 +1537,14 @@ export declare type JsonMatch<TDocument extends SanityDocumentLike, TPath extend
  *
  * @beta
  */
-export declare function jsonMatch<
-  TDocument extends SanityDocumentLike,
-  TPath extends JsonMatchPath<TDocument>,
->(input: TDocument, path: TPath): MatchEntry<JsonMatch<TDocument, TPath>>[]
+export declare function jsonMatch<TDocument, TPath extends string>(
+  input: TDocument,
+  path: TPath,
+): MatchEntry<JsonMatch<TDocument, TPath>>[]
 
 /** @beta */
 export declare function jsonMatch<TValue>(input: unknown, path: string): MatchEntry<TValue>[]
 
-/**
- * Computing the full possible paths may be possible but is hard to compute
- * within the type system for complex document types so we use string.
- * @beta
- */
-export declare type JsonMatchPath<_TDocument extends SanityDocumentLike> = string
-
 /**
  * Loads more users for a specific resource.
  *
@@ -1419,6 +1675,17 @@ declare interface ObjectSplatNode extends BaseNode {
 
 declare type ObjectValue = StaticValue<Record<string, unknown>, 'object'>
 
+/**
+ * Creates an observable that emits the organization verification state for a given instance.
+ * It combines the dashboard organization ID (from auth context) with the
+ * project's actual organization ID (fetched via getProjectState) and compares them.
+ * @public
+ */
+export declare function observeOrganizationVerificationState(
+  instance: SanityInstance,
+  projectIds: string[],
+): Observable<OrgVerificationResult>
+
 declare type OpCall =
   | '=='
   | '!='
@@ -1447,6 +1714,14 @@ declare type OptimisticLock = {
   ifPublishedRevisionId?: string
 }
 
+/**
+ * Error message returned by the organization verification
+ * @public
+ */
+export declare interface OrgVerificationResult {
+  error: string | null
+}
+
 declare interface OrNode extends BaseNode {
   type: 'Or'
   left: ExprNode
@@ -1474,55 +1749,8 @@ declare interface ParentNode_2 extends BaseNode {
   n: number
 }
 
-/**
- * Parse one or more bracketed parts from a segment.
- *
- * It recursively “peels off” a bracketed part and then continues.
- *
- * For example, given the string:
- *
- * ```
- * "[0][foo]"
- * ```
- *
- * it produces:
- *
- * ```
- * [ToNumber<"0">, "foo"]
- * ```
- */
-declare type ParseBracket<TInput extends string> = TInput extends `[${infer TPart}]${infer TRest}`
-  ? [ToNumber<TPart>, ...ParseSegment<TRest>]
-  : []
-
 /** @beta */
-export declare const parseQueryKey: (key: string) => {
-  query: string
-  options: QueryOptions
-}
-
-/**
- * Parse a single “segment” that may include bracket parts.
- *
- * For example, the literal
- *
- * ```
- * "friends[0][1]"
- * ```
- *
- * is parsed as:
- *
- * ```
- * ["friends", 0, 1]
- * ```
- */
-declare type ParseSegment<TInput extends string> = TInput extends `${infer TProp}[${infer TRest}`
-  ? TProp extends ''
-    ? [...ParseBracket<`[${TRest}`>]
-    : [TProp, ...ParseBracket<`[${TRest}`>]
-  : TInput extends ''
-    ? []
-    : [TInput]
+export declare const parseQueryKey: (key: string) => QueryOptions
 
 /** @internal */
 export declare const parseUsersKey: (key: string) => {
@@ -1541,7 +1769,7 @@ declare class Path {
 }
 
 /**
- * Split the entire path string on dots “outside” of any brackets.
+ * Split the entire path string on dots "outside" of any brackets.
  *
  * For example:
  * ```
@@ -1556,9 +1784,11 @@ declare class Path {
  *
  * (We use a simple recursion that splits on the first dot.)
  */
-declare type PathParts<TPath extends string> = TPath extends `${infer TLeft}.${infer TRight}`
-  ? [...ParseSegment<TLeft>, ...PathParts<TRight>]
-  : ParseSegment<TPath>
+declare type PathParts<TPath extends string> = TPath extends `${infer Head}.${infer Tail}`
+  ? [Head, ...PathParts<Tail>]
+  : TPath extends ''
+    ? []
+    : [TPath]
 
 declare type PathValue = StaticValue<Path, 'path'>
 
@@ -1569,6 +1799,13 @@ export declare interface PermissionDeniedReason {
   documentId?: string
 }
 
+/**
+ * @public
+ */
+export declare interface PerspectiveHandle {
+  perspective?: ClientPerspective | ReleasePerspective
+}
+
 declare interface PipeFuncCallNode extends BaseNode {
   type: 'PipeFuncCall'
   func: GroqPipeFunction
@@ -1640,10 +1877,11 @@ export declare interface PreviewValue {
 }
 
 /**
+ * Represents the minimal configuration required to identify a Sanity project.
  * @public
  */
-export declare interface ProjectHandle {
-  projectId?: string | undefined
+export declare interface ProjectHandle<TProjectId extends string = string> {
+  projectId?: TProjectId
 }
 
 declare interface ProjectionNode extends BaseNode {
@@ -1652,6 +1890,15 @@ declare interface ProjectionNode extends BaseNode {
   expr: ExprNode
 }
 
+declare interface ProjectionOptions<
+  TProjection extends ValidProjection = ValidProjection,
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+  projection: TProjection
+}
+
 /**
  * @public
  * The result of a projection query
@@ -1661,27 +1908,43 @@ export declare interface ProjectionValuePending<TValue extends object> {
   isPending: boolean
 }
 
-/** @beta */
-export declare function publishDocument<TDocument extends SanityDocumentLike>(
-  doc: DocumentHandle<TDocument>,
-): PublishDocumentAction<TDocument>
+/**
+ * Creates a `PublishDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document to be published.
+ * @returns A `PublishDocumentAction` object ready for dispatch.
+ * @beta
+ */
+export declare function publishDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
+): PublishDocumentAction<TDocumentType, TDataset, TProjectId>
 
-/** @beta */
+/**
+ * Represents an action to publish the draft version of a document.
+ * Requires the full document handle.
+ * @beta
+ */
 export declare interface PublishDocumentAction<
-  TDocument extends SanityDocumentLike = SanityDocumentLike,
-> extends DocumentHandle<TDocument> {
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   type: 'document.publish'
 }
 
 /**
  * @beta
  */
-export declare interface QueryOptions
-  extends Pick<
-      ResponseQueryOptions,
-      'perspective' | 'useCdn' | 'cache' | 'next' | 'cacheMode' | 'tag'
-    >,
-    DatasetHandle {
+export declare interface QueryOptions<
+  TQuery extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends Pick<ResponseQueryOptions, 'useCdn' | 'cache' | 'next' | 'cacheMode' | 'tag'>,
+    DatasetHandle<TDataset, TProjectId> {
+  query: TQuery
   params?: Record<string, unknown>
 }
 
@@ -1718,30 +1981,74 @@ export declare const releaseChannel: BoundStoreAction_2<
   void
 >
 
+/**
+ * Represents a document in a Sanity dataset that represents release options.
+ * @internal
+ */
+export declare type ReleaseDocument = SanityDocument & {
+  name: string
+  publishAt?: string
+  metadata: {
+    title: string
+    releaseType: 'asap' | 'scheduled' | 'undecided'
+    intendedPublishAt?: string
+  }
+}
+
 /**
  * Signals to the store that the consumer has stopped using the node
  * @public
  */
 export declare const releaseNode: BoundStoreAction_2<ComlinkNodeState, [name: string], void>
 
+/**
+ * @public
+ */
+declare type ReleasePerspective = {
+  releaseName: string
+  excludedPerspectives?: StackablePerspective[]
+}
+
+declare interface ReleasesStoreState {
+  activeReleases?: ReleaseDocument[]
+  error?: unknown
+}
+
 /** @public */
 export declare const resolveDatasets: BoundStoreAction<
-  FetcherStoreState_2<[options?: ProjectHandle | undefined], DatasetsResponse>,
-  [options?: ProjectHandle | undefined],
+  FetcherStoreState_2<[options?: ProjectHandle<string> | undefined], DatasetsResponse>,
+  [options?: ProjectHandle<string> | undefined],
   Promise<DatasetsResponse>
 >
 
 /** @beta */
-export declare function resolveDocument<TDocument extends SanityDocument>(
+export declare function resolveDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
   instance: SanityInstance,
-  doc: string | DocumentHandle<TDocument>,
-): Promise<TDocument | null>
+  docHandle: DocumentHandle<TDocumentType, TDataset, TProjectId>,
+): Promise<SanityDocumentResult<TDocumentType, TDataset, TProjectId> | null>
 
 /** @beta */
-export declare function resolveDocument(
+export declare function resolveDocument<TData extends SanityDocument>(
   instance: SanityInstance,
-  doc: string | DocumentHandle,
-): Promise<SanityDocument | null>
+  docHandle: DocumentHandle<string, string, string>,
+): Promise<TData | null>
+
+/**
+ * Resolves the favorite status for a document.
+ * @param instance - The Sanity instance.
+ * @param context - The document context including ID, type, and resource information.
+ * @returns A Promise resolving to `{ isFavorited: boolean }`.
+ * @public
+ */
+export declare const resolveFavoritesState: BoundStoreAction<
+  FetcherStoreState_2<[FavoriteDocumentContext], FavoriteStatusResponse>,
+  [FavoriteDocumentContext],
+  Promise<FavoriteStatusResponse>
+>
 
 /** @beta */
 export declare const resolvePermissions: BoundStoreAction<
@@ -1766,23 +2073,29 @@ export declare type ResolvePreviewOptions = DocumentHandle
 
 /** @public */
 export declare const resolveProject: BoundStoreAction<
-  FetcherStoreState_2<[options?: ProjectHandle | undefined], SanityProject_2>,
-  [options?: ProjectHandle | undefined],
+  FetcherStoreState_2<[options?: ProjectHandle<string> | undefined], SanityProject_2>,
+  [options?: ProjectHandle<string> | undefined],
   Promise<SanityProject_2>
 >
 
-/**
- * @beta
- */
-export declare const resolveProjection: BoundStoreAction<
-  ProjectionStoreState<object>,
-  [ResolveProjectionOptions],
-  Promise<ProjectionValuePending_2<object>>
+/** @beta */
+export declare function resolveProjection<
+  TProjection extends ValidProjection = ValidProjection,
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  instance: SanityInstance,
+  options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
+): Promise<
+  ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, TDataset, TProjectId>>
 >
 
-declare interface ResolveProjectionOptions extends DocumentHandle {
-  projection: ValidProjection
-}
+/** @beta */
+export declare function resolveProjection<TData extends object>(
+  instance: SanityInstance,
+  options: ProjectionOptions,
+): Promise<ProjectionValuePending<TData>>
 
 /** @public */
 export declare const resolveProjects: BoundStoreAction<
@@ -1805,23 +2118,29 @@ export declare const resolveProjects: BoundStoreAction<
  *
  * @beta
  */
-export declare function resolveQuery<T>(
+export declare function resolveQuery<
+  TQuery extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
   instance: SanityInstance,
-  query: string,
-  options?: ResolveQueryOptions,
-): Promise<T>
+  queryOptions: ResolveQueryOptions<TQuery, TDataset, TProjectId>,
+): Promise<SanityQueryResult<TQuery, TDataset, TProjectId>>
 
 /** @beta */
-export declare function resolveQuery(
+export declare function resolveQuery<TData>(
   instance: SanityInstance,
-  query: string,
-  options?: ResolveQueryOptions,
-): Promise<unknown>
+  queryOptions: ResolveQueryOptions,
+): Promise<TData>
 
 /**
  * @beta
  */
-declare interface ResolveQueryOptions extends QueryOptions {
+declare interface ResolveQueryOptions<
+  TQuery extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends QueryOptions<TQuery, TDataset, TProjectId> {
   signal?: AbortSignal
 }
 
@@ -1863,7 +2182,7 @@ export {Role}
  * Represents the complete configuration for a Sanity SDK instance
  * @public
  */
-export declare interface SanityConfig extends DatasetHandle {
+export declare interface SanityConfig extends DatasetHandle, PerspectiveHandle {
   /**
    * Authentication configuration for the instance
    * @remarks Merged with parent configurations when using createChild
@@ -1880,8 +2199,6 @@ export declare interface SanityConfig extends DatasetHandle {
 
 export {SanityDocument}
 
-export {SanityDocumentLike}
-
 /**
  * Represents a Sanity.io resource instance with its own configuration and lifecycle
  * @remarks Instances form a hierarchy through parent/child relationships
@@ -2122,10 +2439,6 @@ declare interface ThisNode extends BaseNode {
   type: 'This'
 }
 
-declare type ToNumber<TInput extends string> = TInput extends `${infer TNumber extends number}`
-  ? TNumber
-  : TInput
-
 /**
  * @beta
  * Event emitted when a transaction is accepted.
@@ -2152,15 +2465,30 @@ declare interface TupleNode extends BaseNode {
   members: Array<ExprNode>
 }
 
-/** @beta */
-export declare function unpublishDocument<TDocument extends SanityDocumentLike>(
-  doc: DocumentHandle<TDocument>,
-): UnpublishDocumentAction<TDocument>
+/**
+ * Creates an `UnpublishDocumentAction` object.
+ * @param doc - A handle uniquely identifying the document to be unpublished.
+ * @returns An `UnpublishDocumentAction` object ready for dispatch.
+ * @beta
+ */
+export declare function unpublishDocument<
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+>(
+  doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
+): UnpublishDocumentAction<TDocumentType, TDataset, TProjectId>
 
-/** @beta */
+/**
+ * Represents an action to unpublish a document, moving its published content to a draft.
+ * Requires the full document handle.
+ * @beta
+ */
 export declare interface UnpublishDocumentAction<
-  TDocument extends SanityDocumentLike = SanityDocumentLike,
-> extends DocumentHandle<TDocument> {
+  TDocumentType extends string = string,
+  TDataset extends string = string,
+  TProjectId extends string = string,
+> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   type: 'document.unpublish'
 }