@sanity/sdk 2.7.0 → 3.0.0-rc.0

package/dist/index.d.ts

@@ -2,12 +2,11 @@ import * as _sanity_client12 from "@sanity/client";
 import { ClientConfig, ClientError, ClientPerspective, ListenEvent, ResponseQueryOptions, SanityClient, SanityDocument as SanityDocument$1, SanityProject as SanityProject$1, StackablePerspective } from "@sanity/client";
 import { Observable, Subject } from "rxjs";
 import { CurrentUser, CurrentUser as CurrentUser$1, Mutation, PatchOperations, Role, SanityDocument, SanityDocument as SanityDocument$2, SanityDocumentLike } from "@sanity/types";
-import * as _sanity_comlink3 from "@sanity/comlink";
+import * as _sanity_comlink5 from "@sanity/comlink";
 import { ChannelInput, ChannelInstance, Controller, Message, Node, NodeInput, Status } from "@sanity/comlink";
 import { PatchMutation } from "@sanity/mutate/_unstable_store";
-import { SanityDocument as SanityDocument$3, SanityProjectionResult, SanityQueryResult } from "groq";
 import { ExprNode } from "groq-js";
-import { CanvasResource, MediaResource, StudioResource } from "@sanity/message-protocol";
+import { CanvasResource as CanvasResource$1, MediaResource, StudioResource } from "@sanity/message-protocol";
 import { getIndexForKey, getPathDepth, joinPaths, jsonMatch, slicePath, stringifyPath } from "@sanity/json-match";
 /**
  * Configuration for an authentication provider
@@ -100,6 +99,12 @@ interface TokenSource {
  * @public
  */
 interface StudioConfig {
+  /**
+   * Whether the Studio has already determined the user is authenticated.
+   * When `true` and the token source emits `null`, the SDK infers
+   * cookie-based auth is in use rather than transitioning to logged-out.
+   */
+  authenticated?: boolean;
   /** Reactive auth token source from the Studio's auth store. */
   auth?: {
     /**
@@ -111,13 +116,12 @@ interface StudioConfig {
      */
     token?: TokenSource;
   };
-}
-/**
- * Represents the minimal configuration required to identify a Sanity project.
- * @public
- */
-interface ProjectHandle<TProjectId extends string = string> {
-  projectId?: TProjectId;
+  /**
+   * The project ID for this Studio workspace.
+   * Used to derive the localStorage key for studio auth token discovery
+   * (`__studio_auth_token_<projectId>`) and for project-specific API hostname requests.
+   */
+  projectId?: string;
 }
 /**
  * @public
@@ -130,18 +134,23 @@ type ReleasePerspective = {
  * @public
  */
 interface PerspectiveHandle {
-  perspective?: ClientPerspective | ReleasePerspective;
+  /**
+   * The perspective to use for this operation.
+   * Note that the SDK stacks perspectives for you when querying.
+   * The SDK automatically fetches all of your content releases, and orders them the way the Sanity Studio does: usually by scheduled date, with ASAP releases coming first.
+   * @public
+   */
+  perspective?: Exclude<ClientPerspective, readonly unknown[]> | ReleasePerspective;
 }
 /**
  * @public
  */
-interface DatasetHandle<TDataset extends string = string, TProjectId extends string = string> extends ProjectHandle<TProjectId>, PerspectiveHandle {
-  dataset?: TDataset;
+interface ResourceHandle<TProjectId extends string = string, TDataset extends string = string> extends PerspectiveHandle {
   /**
-   * @beta
-   * Explicit source object to use for this operation.
+   * Explicit resource object to use for this operation.
+   * @public
    */
-  source?: DocumentSource;
+  resource: DocumentResource<TProjectId, TDataset>;
 }
 /**
  * Identifies a specific document type within a Sanity dataset and project.
@@ -149,7 +158,7 @@ interface DatasetHandle<TDataset extends string = string, TProjectId extends str
  * Optionally includes a `documentId` and `liveEdit` flag.
  * @public
  */
-interface DocumentTypeHandle<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DatasetHandle<TDataset, TProjectId> {
+interface DocumentTypeHandle<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends ResourceHandle<TDataset, TProjectId> {
   documentId?: string;
   documentType: TDocumentType;
   /**
@@ -169,13 +178,43 @@ interface DocumentHandle<TDocumentType extends string = string, TDataset extends
   documentId: string;
 }
 /**
- * Represents the complete configuration for a Sanity SDK instance
+ * The key used to identify the default resource in a resources map.
+ * When no `resource` or `resourceName` is specified, the SDK resolves
+ * the resource registered under this name.
+ *
+ * @public
+ */
+declare const DEFAULT_RESOURCE_NAME = "default";
+/**
+ * Represents the complete configuration for a Sanity SDK instance.
+ *
+ * Most apps configure resources via the `resources` prop on `SanityApp`:
+ *
+ * @example Typical React usage
+ * ```tsx
+ * <SanityApp
+ *   resources={{ default: { projectId: 'abc123', dataset: 'production' } }}
+ *   fallback={<Loading />}
+ * >
+ *   <App />
+ * </SanityApp>
+ * ```
+ *
+ * The `defaultResource` field is set automatically by the React layer from
+ * `resources['default']`. It can also be set directly when using the core
+ * SDK without React (e.g. in a Node.js script):
+ *
+ * @example Direct core usage (without React)
+ * ```ts
+ * const instance = createSanityInstance({
+ *   defaultResource: { projectId: 'abc123', dataset: 'production' },
+ * })
+ * ```
  * @public
  */
-interface SanityConfig extends DatasetHandle, PerspectiveHandle {
+interface SanityConfig extends PerspectiveHandle {
   /**
    * Authentication configuration for the instance
-   * @remarks Merged with parent configurations when using createChild
    */
   auth?: AuthConfig;
   /**
@@ -188,61 +227,59 @@ interface SanityConfig extends DatasetHandle, PerspectiveHandle {
    */
   studio?: StudioConfig;
   /**
-   * Studio mode configuration for use of the SDK in a Sanity Studio.
-   * @remarks Controls whether studio mode features are enabled.
-   * @deprecated Use `studio` instead, which provides richer integration
-   * with the Studio's workspace (auth token sync, etc.).
-   */
-  studioMode?: {
-    enabled: boolean;
-  };
-  /**
-   * @beta
-   * A list of named sources to use for this instance.
+   * The default document resource for this instance. Used by bound actions
+   * when no explicit resource is provided.
+   *
+   * @public
    */
-  sources?: Record<string, DocumentSource>;
+  defaultResource?: DocumentResource;
 }
 /**
- * A document source can be used for querying.
- * This will soon be the default way to identify where you are querying from.
+ * A document resource identifies where data is stored and queried from.
+ * Can be a dataset (project + dataset pair), a media library, or a canvas.
  *
- * @beta
+ * @public
  */
-type DocumentSource = DatasetSource | MediaLibrarySource | CanvasSource;
+type DocumentResource<TProjectId extends string = string, TDataset extends string = string> = DatasetResource<TProjectId, TDataset> | MediaLibraryResource | CanvasResource;
 /**
- * @beta
+ * A resource that targets a specific project and dataset.
+ * @public
  */
-type DatasetSource = {
-  projectId: string;
-  dataset: string;
+type DatasetResource<TProjectId extends string = string, TDataset extends string = string> = {
+  projectId: TProjectId;
+  dataset: TDataset;
 };
 /**
- * @beta
+ * A resource that targets a media library.
+ * @public
  */
-type MediaLibrarySource = {
+type MediaLibraryResource = {
   mediaLibraryId: string;
 };
 /**
- * @beta
+ * A resource that targets a canvas.
+ * @public
  */
-type CanvasSource = {
+type CanvasResource = {
   canvasId: string;
 };
 /**
- * @beta
+ * Type guard that checks whether a {@link DocumentResource} is a {@link DatasetResource}.
+ * @public
  */
-declare function isDatasetSource(source: DocumentSource): source is DatasetSource;
+declare function isDatasetResource(resource: DocumentResource): resource is DatasetResource;
 /**
- * @beta
+ * Type guard that checks whether a {@link DocumentResource} is a {@link MediaLibraryResource}.
+ * @public
  */
-declare function isMediaLibrarySource(source: DocumentSource): source is MediaLibrarySource;
+declare function isMediaLibraryResource(resource: DocumentResource): resource is MediaLibraryResource;
 /**
- * @beta
+ * Type guard that checks whether a {@link DocumentResource} is a {@link CanvasResource}.
+ * @public
  */
-declare function isCanvasSource(source: DocumentSource): source is CanvasSource;
+declare function isCanvasResource(resource: DocumentResource): resource is CanvasResource;
 /**
- * Represents a Sanity.io resource instance with its own configuration and lifecycle
- * @remarks Instances form a hierarchy through parent/child relationships
+ * Represents a Sanity.io resource instance with its own configuration and lifecycle.
  *
  * @public
  */
@@ -252,10 +289,7 @@ interface SanityInstance {
    * @remarks Generated using crypto.randomUUID()
    */
   readonly instanceId: string;
-  /**
-   * Resolved configuration for this instance
-   * @remarks Merges values from parent instances where appropriate
-   */
+  /** Resolved configuration for this instance */
   readonly config: SanityConfig;
   /**
    * Checks if the instance has been disposed
@@ -273,34 +307,22 @@ interface SanityInstance {
    * @returns Function to unsubscribe the callback
    */
   onDispose(cb: () => void): () => void;
-  /**
-   * Gets the parent instance in the hierarchy
-   * @returns Parent instance or undefined if this is the root
-   */
-  getParent(): SanityInstance | undefined;
-  /**
-   * Creates a child instance with merged configuration
-   * @param config - Configuration to merge with parent values
-   * @remarks Child instances inherit parent configuration but can override values
-   */
-  createChild(config: SanityConfig): SanityInstance;
-  /**
-   * Traverses the instance hierarchy to find the first instance whose configuration
-   * matches the given target config using a shallow comparison.
-   * @param targetConfig - A partial configuration object containing key-value pairs to match.
-   * @returns The first matching instance or undefined if no match is found.
-   */
-  match(targetConfig: Partial<SanityConfig>): SanityInstance | undefined;
 }
 /**
  * Creates a new Sanity resource instance
  * @param config - Configuration for the instance (optional)
  * @returns A configured SanityInstance
- * @remarks When creating child instances, configurations are merged with parent values
  *
  * @public
  */
 declare function createSanityInstance(config?: SanityConfig): SanityInstance;
+/**
+ * Options that all agent actions accept for targeting a specific resource.
+ * @alpha
+ */
+interface AgentResourceOptions {
+  resource: DocumentResource;
+}
 /** @alpha */
 type AgentGenerateOptions = Parameters<SanityClient['observable']['agent']['action']['generate']>[0];
 /** @alpha */
@@ -328,7 +350,7 @@ type AgentPatchResult = Awaited<ReturnType<SanityClient['agent']['action']['patc
  * @returns An Observable emitting the result of the agent generate action.
  * @alpha
  */
-declare function agentGenerate(instance: SanityInstance, options: AgentGenerateOptions): AgentGenerateResult;
+declare function agentGenerate(instance: SanityInstance, options: AgentGenerateOptions & AgentResourceOptions): AgentGenerateResult;
 /**
  * Transforms a document using the agent.
  * @param instance - The Sanity instance.
@@ -336,7 +358,7 @@ declare function agentGenerate(instance: SanityInstance, options: AgentGenerateO
  * @returns An Observable emitting the result of the agent transform action.
  * @alpha
  */
-declare function agentTransform(instance: SanityInstance, options: AgentTransformOptions): AgentTransformResult;
+declare function agentTransform(instance: SanityInstance, options: AgentTransformOptions & AgentResourceOptions): AgentTransformResult;
 /**
  * Translates a document using the agent.
  * @param instance - The Sanity instance.
@@ -344,7 +366,7 @@ declare function agentTransform(instance: SanityInstance, options: AgentTransfor
  * @returns An Observable emitting the result of the agent translate action.
  * @alpha
  */
-declare function agentTranslate(instance: SanityInstance, options: AgentTranslateOptions): AgentTranslateResult;
+declare function agentTranslate(instance: SanityInstance, options: AgentTranslateOptions & AgentResourceOptions): AgentTranslateResult;
 /**
  * Prompts the agent using the same instruction template format as the other actions, but returns text or json instead of acting on a document.
  * @param instance - The Sanity instance.
@@ -352,7 +374,7 @@ declare function agentTranslate(instance: SanityInstance, options: AgentTranslat
  * @returns An Observable emitting the result of the agent prompt action.
  * @alpha
  */
-declare function agentPrompt(instance: SanityInstance, options: AgentPromptOptions): Observable<AgentPromptResult>;
+declare function agentPrompt(instance: SanityInstance, options: AgentPromptOptions & AgentResourceOptions): Observable<AgentPromptResult>;
 /**
  * Patches a document using the agent.
  * @param instance - The Sanity instance.
@@ -360,11 +382,9 @@ declare function agentPrompt(instance: SanityInstance, options: AgentPromptOptio
  * @returns An Observable emitting the result of the agent patch action.
  * @alpha
  */
-declare function agentPatch(instance: SanityInstance, options: AgentPatchOptions): Observable<AgentPatchResult>;
+declare function agentPatch(instance: SanityInstance, options: AgentPatchOptions & AgentResourceOptions): Observable<AgentPatchResult>;
 /**
  * Returns `true` when the config indicates the SDK is running inside a Studio.
- * Checks the new `studio` field first, then falls back to the deprecated
- * `studioMode.enabled` for backwards compatibility.
  *
  * @internal
  */
@@ -614,7 +634,12 @@ interface ClientStoreState {
  *
  * @public
  */
-interface ClientOptions extends Pick<ClientConfig, AllowedClientConfigKey> {
+interface ClientOptions extends Omit<Pick<ClientConfig, AllowedClientConfigKey>, 'resource'> {
+  /**
+   * Narrows the inherited `perspective` to exclude stackable perspectives,
+   * which are not supported by the SDK.
+   */
+  'perspective'?: Exclude<ClientPerspective, readonly unknown[]>;
   /**
    * An optional flag to choose between the default client (typically project-level)
    * and the global client ('global'). When set to `'global'`, the global client
@@ -632,7 +657,7 @@ interface ClientOptions extends Pick<ClientConfig, AllowedClientConfigKey> {
   /**
    * @internal
    */
-  'source'?: DocumentSource;
+  'resource'?: DocumentResource;
 }
 /**
  * Retrieves a Sanity client instance configured with the provided options.
@@ -713,7 +738,7 @@ declare const destroyController: BoundStoreAction<ComlinkControllerState, [], vo
  * an application and the controller.
  * @public
  */
-declare const getOrCreateChannel: BoundStoreAction<ComlinkControllerState, [options: ChannelInput], ChannelInstance<_sanity_comlink3.Message, _sanity_comlink3.Message>>;
+declare const getOrCreateChannel: BoundStoreAction<ComlinkControllerState, [options: ChannelInput], ChannelInstance<_sanity_comlink5.Message, _sanity_comlink5.Message>>;
 /**
  * Initializes or fetches a controller to handle communication
  * between an application and iframes.
@@ -754,7 +779,7 @@ declare const releaseNode: BoundStoreAction<ComlinkNodeState, [name: string], vo
  * be created within a frame / window to communicate with the controller.
  * @public
  */
-declare const getOrCreateNode: BoundStoreAction<ComlinkNodeState, [options: NodeInput], Node<_sanity_comlink3.Message, _sanity_comlink3.Message>>;
+declare const getOrCreateNode: BoundStoreAction<ComlinkNodeState, [options: NodeInput], Node<_sanity_comlink5.Message, _sanity_comlink5.Message>>;
 /**
  * @public
  */
@@ -788,21 +813,13 @@ declare function createDocumentHandle<TDocumentType extends string = string, TDa
  */
 declare function createDocumentTypeHandle<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(handle: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>): DocumentTypeHandle<TDocumentType, TDataset, TProjectId>;
 /**
- * Creates or validates a `ProjectHandle` object.
- * Ensures the provided object conforms to the `ProjectHandle` interface.
- * @param handle - The object containing project identification properties.
- * @returns The validated `ProjectHandle` object.
- * @public
- */
-declare function createProjectHandle<TProjectId extends string = string>(handle: ProjectHandle<TProjectId>): ProjectHandle<TProjectId>;
-/**
- * Creates or validates a `DatasetHandle` object.
- * Ensures the provided object conforms to the `DatasetHandle` interface.
- * @param handle - The object containing dataset identification properties.
- * @returns The validated `DatasetHandle` object.
+ * Creates or validates a `ResourceHandle` object.
+ * Ensures the provided object conforms to the `ResourceHandle` interface.
+ * @param handle - The object containing resource identification properties.
+ * @returns The validated `ResourceHandle` object.
  * @public
  */
-declare function createDatasetHandle<TDataset extends string = string, TProjectId extends string = string>(handle: DatasetHandle<TDataset, TProjectId>): DatasetHandle<TDataset, TProjectId>;
+declare function createResourceHandle<TDataset extends string = string, TProjectId extends string = string>(handle: ResourceHandle<TProjectId, TDataset>): ResourceHandle<TProjectId, TDataset>;
 /**
  * Logging infrastructure for the Sanity SDK
  *
@@ -947,9 +964,9 @@ interface LogContext {
 interface InstanceContext {
   /** Unique instance ID */
   instanceId?: string;
-  /** Project ID */
+  /** Project ID (derived from default resource) */
   projectId?: string;
-  /** Dataset name */
+  /** Dataset name (derived from default resource) */
   dataset?: string;
 }
 /**
@@ -1075,9 +1092,17 @@ interface Logger {
  */
 declare function configureLogging(config: LoggerConfig): void;
 /** @public */
-declare const getDatasetsState: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client12.DatasetsResponse>, [options?: ProjectHandle<string> | undefined], StateSource<_sanity_client12.DatasetsResponse | undefined>>;
+declare const getDatasetsState: BoundStoreAction<FetcherStoreState<[options: {
+  projectId: string;
+}], _sanity_client12.DatasetsResponse>, [options: {
+  projectId: string;
+}], StateSource<_sanity_client12.DatasetsResponse | undefined>>;
 /** @public */
-declare const resolveDatasets: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client12.DatasetsResponse>, [options?: ProjectHandle<string> | undefined], Promise<_sanity_client12.DatasetsResponse>>;
+declare const resolveDatasets: BoundStoreAction<FetcherStoreState<[options: {
+  projectId: string;
+}], _sanity_client12.DatasetsResponse>, [options: {
+  projectId: string;
+}], Promise<_sanity_client12.DatasetsResponse>>;
 /**
  * Represents an action to create a new document.
  * Specifies the document type and optionally a document ID (which will be treated as the published ID).
@@ -1090,7 +1115,7 @@ interface CreateDocumentAction<TDocumentType extends string = string, TDataset e
    * These values will be set when the document is created.
    * System fields (_id, _type, _rev, _createdAt, _updatedAt) are omitted as they are set automatically.
    */
-  initialValue?: Partial<Omit<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>, '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'>>;
+  initialValue?: Partial<Omit<SanityDocument$2, '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'>>;
 }
 /**
  * Represents an action to delete an existing document.
@@ -1145,7 +1170,7 @@ type DocumentAction<TDocumentType extends string = string, TDataset extends stri
  * @returns A `CreateDocumentAction` object ready for dispatch.
  * @beta
  */
-declare function createDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>, initialValue?: Partial<Omit<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>, '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'>>): CreateDocumentAction<TDocumentType, TDataset, TProjectId>;
+declare function createDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>, initialValue?: Partial<Omit<SanityDocument$2, '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'>>): CreateDocumentAction<TDocumentType, TDataset, TProjectId>;
 /**
  * Creates a `DeleteDocumentAction` object.
  * @param doc - A handle uniquely identifying the document to be deleted.
@@ -1201,7 +1226,7 @@ declare function discardDocument<TDocumentType extends string = string, TDataset
  */
 type DocumentSet<TDocument extends SanityDocument$2 = SanityDocument$2> = { [TDocumentId in string]?: TDocument | null };
 /** @beta */
-interface ActionsResult<TDocument extends SanityDocument$3 = SanityDocument$3> {
+interface ActionsResult<TDocument extends SanityDocument$2 = SanityDocument$2> {
   transactionId: string;
   documents: DocumentSet<TDocument>;
   previous: DocumentSet<TDocument>;
@@ -1219,6 +1244,10 @@ interface ApplyDocumentActionsOptions {
    * List of actions to apply.
    */
   actions: DocumentAction[];
+  /**
+   * The resource to which the documents being acted on belong.
+   */
+  resource: DocumentResource;
   /**
    * Optionally provide an ID to be used as this transaction ID
    */
@@ -1229,8 +1258,6 @@ interface ApplyDocumentActionsOptions {
   disableBatching?: boolean;
 }
 /** @beta */
-declare function applyDocumentActions<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ApplyDocumentActionsOptions): Promise<ActionsResult<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>>>;
-/** @beta */
 declare function applyDocumentActions(instance: SanityInstance, options: ApplyDocumentActionsOptions): Promise<ActionsResult>;
 /**
  * Represents a reactive state source that provides synchronized access to store data
@@ -1282,9 +1309,9 @@ interface StateSource<T> {
  * ```ts
  * // Using both state and instance in a selector (psuedo example)
  * const getUserByProjectId = createStateSourceAction(
- *   ({ state, instance }: SelectorContext<UsersState>, options?: ProjectHandle) => {
+ *   ({ state, instance }: SelectorContext<UsersState>, options?: ResourceHandle) => {
  *     const allUsers = state.users
- *     const projectId = options?.projectId ?? instance.config.projectId
+ *     const projectId = options?.projectId ?? instance.config.defaultResource?.projectId
  *     return allUsers.filter(user => user.projectId === projectId)
  *   }
  * )
@@ -1436,23 +1463,6 @@ interface UnverifiedDocumentRevision {
   previousRev: string | undefined;
   timestamp: string;
 }
-type Grant = 'read' | 'update' | 'create' | 'history';
-/** @beta */
-interface PermissionDeniedReason {
-  type: 'precondition' | 'access';
-  message: string;
-  documentId?: string;
-}
-/** @beta */
-type DocumentPermissionsResult = {
-  allowed: false;
-  message: string;
-  reasons: PermissionDeniedReason[];
-} | {
-  allowed: true;
-  message?: undefined;
-  reasons?: undefined;
-};
 /** @beta */
 type DocumentEvent = ActionErrorEvent | TransactionRevertedEvent | TransactionAcceptedEvent | DocumentRebaseErrorEvent | DocumentEditedEvent | DocumentCreatedEvent | DocumentDeletedEvent | DocumentPublishedEvent | DocumentUnpublishedEvent | DocumentDiscardedEvent;
 /**
@@ -1551,38 +1561,23 @@ interface DocumentDiscardedEvent {
   documentId: string;
   outgoing: OutgoingTransaction;
 }
-/**
- * Split the entire path string on dots "outside" of any brackets.
- *
- * For example:
- * ```
- * "friends[0].name"
- * ```
- *
- * becomes:
- *
- * ```
- * [...ParseSegment<"friends[0]">, ...ParseSegment<"name">]
- * ```
- *
- * (We use a simple recursion that splits on the first dot.)
- */
-type PathParts<TPath extends string> = TPath extends `${infer Head}.${infer Tail}` ? [Head, ...PathParts<Tail>] : TPath extends '' ? [] : [TPath];
-/**
- * Given a type T and an array of "access keys" Parts, recursively index into T.
- *
- * If a part is a key, it looks up that property.
- * If T is an array and the part is a number, it "indexes" into the element type.
- */
-type DeepGet<TValue, TPath extends readonly (string | number)[]> = TPath extends [] ? TValue : TPath extends readonly [infer THead, ...infer TTail] ? DeepGet<TValue extends undefined | null ? undefined : THead extends keyof TValue ? TValue[THead] : THead extends number ? TValue extends readonly (infer TElement)[] ? TElement | undefined : undefined : undefined,
-// Key/index doesn't exist
-TTail extends readonly (string | number)[] ? TTail : []> : never;
-/**
- * Given a document type TDocument and a JSON Match path string TPath,
- * compute the type found at that path.
- * @beta
- */
-type JsonMatch<TDocument, TPath extends string> = DeepGet<TDocument, PathParts<TPath>>;
+type Grant = 'read' | 'update' | 'create' | 'history';
+/** @beta */
+interface PermissionDeniedReason {
+  type: 'precondition' | 'access';
+  message: string;
+  documentId?: string;
+}
+/** @beta */
+type DocumentPermissionsResult = {
+  allowed: false;
+  message: string;
+  reasons: PermissionDeniedReason[];
+} | {
+  allowed: true;
+  message?: undefined;
+  reasons?: undefined;
+};
 interface SharedListener {
   events: Observable<ListenEvent<SanityDocument$1>>;
   dispose: () => void;
@@ -1595,7 +1590,7 @@ interface DocumentStoreState {
   grants?: Record<Grant, ExprNode>;
   error?: unknown;
   sharedListener: SharedListener;
-  fetchDocument: (documentId: string) => Observable<SanityDocument$3 | null>;
+  fetchDocument: (documentId: string) => Observable<SanityDocument$2 | null>;
   events: Subject<DocumentEvent>;
 }
 interface DocumentState {
@@ -1604,12 +1599,12 @@ interface DocumentState {
    * the "remote" local copy that matches the server. represents the last known
    * server state. this gets updated every time we confirm remote patches
    */
-  remote?: SanityDocument$3 | null;
+  remote?: SanityDocument$2 | null;
   /**
    * the current ephemeral working copy that includes local optimistic changes
    * that have not yet been confirmed by the server
    */
-  local?: SanityDocument$3 | null;
+  local?: SanityDocument$2 | null;
   /**
    * the revision that our remote document is at
    */
@@ -1640,26 +1635,26 @@ interface DocumentOptions<TPath extends string | undefined = undefined, TDocumen
   path?: TPath;
 }
 /** @beta */
-declare function getDocumentState<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>): StateSource<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`> | undefined | null>;
-/** @beta */
-declare function getDocumentState<TPath extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>): StateSource<JsonMatch<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined>;
-/** @beta */
 declare function getDocumentState<TData>(instance: SanityInstance, options: DocumentOptions<string | undefined>): StateSource<TData | undefined | null>;
 /** @beta */
-declare function resolveDocument<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, docHandle: DocumentHandle<TDocumentType, TDataset, TProjectId>): Promise<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`> | null>;
+declare function resolveDocument<TData extends SanityDocument$2>(instance: SanityInstance, docHandle: DocumentHandle): Promise<TData | null>;
 /** @beta */
-declare function resolveDocument<TData extends SanityDocument$3>(instance: SanityInstance, docHandle: DocumentHandle<string, string, string>): Promise<TData | null>;
+declare function resolveDocument(instance: SanityInstance, docHandle: DocumentHandle): Promise<SanityDocument$2 | null>;
 /** @beta */
 declare const getDocumentSyncStatus: BoundStoreAction<DocumentStoreState, [doc: DocumentHandle<string, string, string>], StateSource<boolean | undefined>>;
 type PermissionsStateOptions = {
+  resource: DocumentResource;
   actions: DocumentAction[];
 };
 /** @beta */
-declare const getPermissionsState: BoundStoreAction<DocumentStoreState, [PermissionsStateOptions], StateSource<DocumentPermissionsResult | undefined>>;
+declare const getPermissionsState: BoundStoreAction<DocumentStoreState, [PermissionsStateOptions], StateSource<DocumentPermissionsResult>>;
 /** @beta */
 declare const resolvePermissions: BoundStoreAction<DocumentStoreState, [options: PermissionsStateOptions], Promise<DocumentPermissionsResult>>;
 /** @beta */
-declare const subscribeDocumentEvents: BoundStoreAction<DocumentStoreState, [eventHandler: (e: DocumentEvent) => void], () => void>;
+declare const subscribeDocumentEvents: BoundStoreAction<DocumentStoreState, [options: {
+  resource: DocumentResource;
+  eventHandler: (e: DocumentEvent) => void;
+}], () => void>;
 /**
  * @public
  */
@@ -1671,7 +1666,7 @@ interface FavoriteStatusResponse {
  */
 interface FavoriteDocumentContext extends DocumentHandle {
   resourceId: string;
-  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['type'];
+  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource$1['type'];
   schemaName?: string;
 }
 /**
@@ -1729,7 +1724,8 @@ interface UserProfile {
 /**
  * @public
  */
-interface GetUsersOptions extends ProjectHandle {
+interface GetUsersOptions {
+  projectId?: string;
   resourceType?: 'organization' | 'project';
   batchSize?: number;
   organizationId?: string;
@@ -1770,7 +1766,8 @@ interface ResolveUsersOptions extends GetUsersOptions {
 /**
  * @public
  */
-interface GetUserOptions extends ProjectHandle {
+interface GetUserOptions {
+  projectId?: string;
   userId: string;
   resourceType?: 'organization' | 'project';
   organizationId?: string;
@@ -1826,11 +1823,43 @@ type PresenceStoreState = {
 };
 /** @public */
 
-/** @public */
-declare const getPresence: BoundStoreAction<PresenceStoreState, [((object & {
-  projectId?: string;
-  dataset?: string;
-}) | undefined)?, ...unknown[]], StateSource<UserPresence[]>>;
+/** @beta */
+declare const getPresence: BoundStoreAction<PresenceStoreState, [{
+  resource?: DocumentResource;
+}, ...unknown[]], StateSource<UserPresence[]>>;
+/**
+ * Generates a GROQ projection for preview data without requiring a schema.
+ * Uses common field names to make educated guesses about which fields to use.
+ *
+ * @internal
+ */
+declare const PREVIEW_PROJECTION: string;
+/**
+ * @public
+ * The result of a projection query
+ */
+interface ProjectionValuePending<TValue extends object> {
+  data: TValue | null;
+  isPending: boolean;
+}
+interface DocumentStatus {
+  lastEditedDraftAt?: string;
+  lastEditedPublishedAt?: string;
+  lastEditedVersionAt?: string;
+}
+/**
+ *
+ * @internal
+ */
+interface PreviewQueryResult {
+  _id: string;
+  _type: string;
+  _updatedAt: string;
+  titleCandidates: Record<string, unknown>;
+  subtitleCandidates: Record<string, unknown>;
+  media?: PreviewMedia | null;
+  _status?: DocumentStatus;
+}
 /**
  * Represents a media asset in a preview.
  *
@@ -1887,58 +1916,26 @@ type ValuePending<T> = {
   isPending: boolean;
 };
 /**
- * @public
- */
-interface PreviewStoreState {
-  values: { [TDocumentId in string]?: ValuePending<PreviewValue> };
-  subscriptions: { [TDocumentId in string]?: { [TSubscriptionId in string]?: true } };
-}
-/**
- * @beta
- */
-type GetPreviewStateOptions = DocumentHandle;
-/**
- * @beta
- */
-declare function getPreviewState<TResult extends object>(instance: SanityInstance, options: GetPreviewStateOptions): StateSource<ValuePending<TResult>>;
-/**
- * @beta
- */
-declare function getPreviewState(instance: SanityInstance, options: GetPreviewStateOptions): StateSource<ValuePending<PreviewValue>>;
-/**
- * @beta
- */
-type ResolvePreviewOptions = DocumentHandle;
-/**
- * @beta
+ * Transforms a projection result (with titleCandidates, subtitleCandidates, media)
+ * into a PreviewValue (with title, subtitle, media).
+ *
+ * @param projectionResult - The raw projection result from GROQ
+ * @param instance - The Sanity instance to use for client configuration
+ * @param resource - Data resource for the preview
+ * @internal
  */
-declare const resolvePreview: BoundStoreAction<PreviewStoreState, [docHandle: ResolvePreviewOptions], Promise<ValuePending<object>>>;
+declare function transformProjectionToPreview(instance: SanityInstance, resource: DocumentResource, projectionResult: PreviewQueryResult): PreviewValue;
+/** @public */
+type ProjectHandle = {
+  projectId: string;
+};
 /** @public */
-declare const getProjectState: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client12.SanityProject>, [options?: ProjectHandle<string> | undefined], StateSource<_sanity_client12.SanityProject | undefined>>;
+declare const getProjectState: BoundStoreAction<FetcherStoreState<[options: ProjectHandle], _sanity_client12.SanityProject>, [options: ProjectHandle], StateSource<_sanity_client12.SanityProject | undefined>>;
 /** @public */
-declare const resolveProject: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client12.SanityProject>, [options?: ProjectHandle<string> | undefined], Promise<_sanity_client12.SanityProject>>;
-/**
- * @public
- * The result of a projection query
- */
-interface ProjectionValuePending<TValue extends object> {
-  data: TValue | null;
-  isPending: boolean;
-}
-/**
- * @public
- * @deprecated
- * Template literals are a bit too limited, so this type is deprecated.
- * Use `string` instead. Projection strings are validated at runtime.
- */
-type ValidProjection = string;
+declare const resolveProject: BoundStoreAction<FetcherStoreState<[options: ProjectHandle], _sanity_client12.SanityProject>, [options: ProjectHandle], Promise<_sanity_client12.SanityProject>>;
 interface ProjectionOptions<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   projection: TProjection;
 }
-/**
- * @beta
- */
-declare function getProjectionState<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): StateSource<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>> | undefined>;
 /**
  * @beta
  */
@@ -1948,8 +1945,6 @@ declare function getProjectionState<TData extends object>(instance: SanityInstan
  */
 declare function getProjectionState(instance: SanityInstance, options: ProjectionOptions): StateSource<ProjectionValuePending<Record<string, unknown>> | undefined>;
 /** @beta */
-declare function resolveProjection<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): Promise<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>>>;
-/** @beta */
 declare function resolveProjection<TData extends object>(instance: SanityInstance, options: ProjectionOptions): Promise<ProjectionValuePending<TData>>;
 /** @public */
 declare const getProjectsState: BoundStoreAction<FetcherStoreState<[options?: {
@@ -1970,7 +1965,7 @@ declare const resolveProjects: BoundStoreAction<FetcherStoreState<[options?: {
 /**
  * @beta
  */
-interface QueryOptions<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string> extends Pick<ResponseQueryOptions, 'useCdn' | 'cache' | 'next' | 'cacheMode' | 'tag'>, DatasetHandle<TDataset, TProjectId> {
+interface QueryOptions<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string> extends Pick<ResponseQueryOptions, 'useCdn' | 'cache' | 'next' | 'cacheMode' | 'tag'>, ResourceHandle<TDataset, TProjectId> {
   query: TQuery;
   params?: Record<string, unknown>;
 }
@@ -2000,8 +1995,6 @@ declare const parseQueryKey: (key: string) => QueryOptions;
  *
  * @beta
  */
-declare function getQueryState<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, queryOptions: QueryOptions<TQuery, TDataset, TProjectId>): StateSource<SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`> | undefined>;
-/** @beta */
 declare function getQueryState<TData>(instance: SanityInstance, queryOptions: QueryOptions): StateSource<TData | undefined>;
 /** @beta */
 declare function getQueryState(instance: SanityInstance, queryOptions: QueryOptions): StateSource<unknown>;
@@ -2019,8 +2012,6 @@ declare function getQueryState(instance: SanityInstance, queryOptions: QueryOpti
  *
  * @beta
  */
-declare function resolveQuery<TQuery extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, queryOptions: ResolveQueryOptions<TQuery, TDataset, TProjectId>): Promise<SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`>>;
-/** @beta */
 declare function resolveQuery<TData>(instance: SanityInstance, queryOptions: ResolveQueryOptions): Promise<TData>;
 /**
  * Represents a document in a Sanity dataset that represents release options.
@@ -2045,13 +2036,11 @@ interface ReleasesStoreState {
  * Get the active releases from the store.
  * @internal
  */
-declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [((object & {
-  projectId?: string;
-  dataset?: string;
-}) | undefined)?, ...unknown[]], StateSource<ReleaseDocument[] | undefined>>;
+declare const getActiveReleasesState: (instance: SanityInstance, options: {
+  resource: DocumentResource;
+}) => StateSource<ReleaseDocument[] | undefined>;
 declare const _getPerspectiveStateSelector: StoreAction<ReleasesStoreState, [_?: (PerspectiveHandle & {
-  projectId?: string;
-  dataset?: string;
+  resource?: DocumentResource;
 }) | undefined], StateSource<string[] | "previewDrafts" | "published" | "drafts" | "raw" | undefined>, unknown>;
 type OmitFirst<T extends unknown[]> = T extends [unknown, ...infer R] ? R : never;
 type SelectorParams = OmitFirst<Parameters<typeof _getPerspectiveStateSelector>>;
@@ -2070,7 +2059,7 @@ type BoundGetPerspectiveState = BoundStoreAction<ReleasesStoreState, SelectorPar
  */
 declare const getPerspectiveState: BoundGetPerspectiveState;
 /** @internal */
-declare const getUsersKey: (instance: SanityInstance, {
+declare const getUsersKey: (_instance: SanityInstance, {
   resourceType,
   organizationId,
   batchSize,
@@ -2340,4 +2329,4 @@ declare const CORE_SDK_VERSION: {};
  * @public
  */
 type SanityProject = SanityProject$1;
-export { type ActionErrorEvent, type ActionsResult, type AgentGenerateOptions, type AgentGenerateResult, type AgentPatchOptions, type AgentPatchResult, type AgentPromptOptions, type AgentPromptResult, type AgentTransformOptions, type AgentTransformResult, type AgentTranslateOptions, type AgentTranslateResult, type ApiErrorBody, type ApplyDocumentActionsOptions, type AuthConfig, type AuthProvider, type AuthState, AuthStateType, type AuthStoreState, CORE_SDK_VERSION, type CanvasSource, type ClientOptions, type ClientStoreState as ClientState, type ComlinkControllerState, type ComlinkNodeState, type CreateDocumentAction, type CurrentUser, type DatasetHandle, type DatasetSource, type DeleteDocumentAction, type DiscardDocumentAction, type DisconnectEvent, type DocumentAction, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentDiscardedEvent, type DocumentEditedEvent, type DocumentEvent, type DocumentHandle, type DocumentOptions, type DocumentPermissionsResult, type DocumentPublishedEvent, type DocumentSource, type DocumentTypeHandle, type DocumentUnpublishedEvent, type EditDocumentAction, type ErrorAuthState, type FavoriteStatusResponse, type FetcherStore, type FetcherStoreState, type FrameMessage, type GetPreviewStateOptions, type GetUserOptions, type GetUsersOptions, type InstanceContext, type Intent, type IntentFilter, type JsonMatch, type LogContext, type LogLevel, type LogNamespace, type LoggedInAuthState, type LoggedOutAuthState, type Logger, type LoggerConfig, type LoggingInAuthState, type MediaLibrarySource, type Membership, type NewTokenResponseMessage, type NodeState, type OrgVerificationResult, type PermissionDeniedReason, type PerspectiveHandle, type PresenceLocation, type PreviewStoreState, type PreviewValue, type ProjectHandle, type ProjectionValuePending, type PublishDocumentAction, type QueryOptions, type ReleaseDocument, type ReleasePerspective, type RequestNewTokenMessage, type ResolvePreviewOptions, type ResolveUserOptions, type ResolveUsersOptions, type Role, type RollCallEvent, type SanityConfig, type SanityDocument, type SanityInstance, SanityProject, type SanityUser, type SanityUserResponse, type Selector, type StateEvent, type StateSource, type StudioConfig, type TokenSource, type TransactionAcceptedEvent, type TransactionRevertedEvent, type TransportEvent, type UnpublishDocumentAction, type UserPresence, type UserProfile, type UsersGroupState, type UsersStoreState, type ValidProjection, type ValuePending, type WindowMessage, agentGenerate, agentPatch, agentPrompt, agentTransform, agentTranslate, applyDocumentActions, configureLogging, createDatasetHandle, createDocument, createDocumentHandle, createDocumentTypeHandle, createGroqSearchFilter, createProjectHandle, createSanityInstance, defineIntent, deleteDocument, destroyController, discardDocument, editDocument, getActiveReleasesState, getAuthState, getClient, getClientErrorApiBody, getClientErrorApiDescription, getClientErrorApiType, getClientState, getCorsErrorProjectId, getCurrentUserState, getDashboardOrganizationId, getDatasetsState, getDocumentState, getDocumentSyncStatus, getFavoritesState, getIndexForKey, getIsInDashboardState, getLoginUrlState, getNodeState, getOrCreateChannel, getOrCreateController, getOrCreateNode, getPathDepth, getPermissionsState, getPerspectiveState, getPresence, getPreviewState, getProjectState, getProjectionState, getProjectsState, getQueryKey, getQueryState, getTokenState, getUserState, getUsersKey, getUsersState, handleAuthCallback, isCanvasSource, isDatasetSource, isMediaLibrarySource, isProjectUserNotFoundClientError, isStudioConfig, joinPaths, jsonMatch, loadMoreUsers, logout, observeOrganizationVerificationState, parseQueryKey, parseUsersKey, publishDocument, releaseChannel, releaseNode, resolveDatasets, resolveDocument, resolveFavoritesState, resolvePermissions, resolvePreview, resolveProject, resolveProjection, resolveProjects, resolveQuery, resolveUser, resolveUsers, setAuthToken, slicePath, stringifyPath, subscribeDocumentEvents, unpublishDocument };
+export { type ActionErrorEvent, type ActionsResult, type AgentGenerateOptions, type AgentGenerateResult, type AgentPatchOptions, type AgentPatchResult, type AgentPromptOptions, type AgentPromptResult, type AgentResourceOptions, type AgentTransformOptions, type AgentTransformResult, type AgentTranslateOptions, type AgentTranslateResult, type ApiErrorBody, type ApplyDocumentActionsOptions, type AuthConfig, type AuthProvider, type AuthState, AuthStateType, type AuthStoreState, CORE_SDK_VERSION, type CanvasResource, type ClientOptions, type ClientStoreState as ClientState, type ComlinkControllerState, type ComlinkNodeState, type CreateDocumentAction, type CurrentUser, DEFAULT_RESOURCE_NAME, type DatasetResource, type DeleteDocumentAction, type DiscardDocumentAction, type DisconnectEvent, type DocumentAction, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentDiscardedEvent, type DocumentEditedEvent, type DocumentEvent, type DocumentHandle, type DocumentOptions, type DocumentPermissionsResult, type DocumentPublishedEvent, type DocumentResource, type DocumentTypeHandle, type DocumentUnpublishedEvent, type EditDocumentAction, type ErrorAuthState, type FavoriteStatusResponse, type FetcherStore, type FetcherStoreState, type FrameMessage, type GetUserOptions, type GetUsersOptions, type InstanceContext, type Intent, type IntentFilter, type LogContext, type LogLevel, type LogNamespace, type LoggedInAuthState, type LoggedOutAuthState, type Logger, type LoggerConfig, type LoggingInAuthState, type MediaLibraryResource, type Membership, type NewTokenResponseMessage, type NodeState, type OrgVerificationResult, PREVIEW_PROJECTION, type PermissionDeniedReason, type PerspectiveHandle, type PresenceLocation, type PreviewMedia, type PreviewQueryResult, type PreviewValue, type ProjectHandle, type ProjectionValuePending, type PublishDocumentAction, type QueryOptions, type ReleaseDocument, type ReleasePerspective, type RequestNewTokenMessage, type ResolveUserOptions, type ResolveUsersOptions, type ResourceHandle, type Role, type RollCallEvent, type SanityConfig, type SanityDocument, type SanityInstance, SanityProject, type SanityUser, type SanityUserResponse, type Selector, type StateEvent, type StateSource, type StudioConfig, type TokenSource, type TransactionAcceptedEvent, type TransactionRevertedEvent, type TransportEvent, type UnpublishDocumentAction, type UserPresence, type UserProfile, type UsersGroupState, type UsersStoreState, type ValuePending, type WindowMessage, agentGenerate, agentPatch, agentPrompt, agentTransform, agentTranslate, applyDocumentActions, configureLogging, createDocument, createDocumentHandle, createDocumentTypeHandle, createGroqSearchFilter, createResourceHandle, createSanityInstance, defineIntent, deleteDocument, destroyController, discardDocument, editDocument, getActiveReleasesState, getAuthState, getClient, getClientErrorApiBody, getClientErrorApiDescription, getClientErrorApiType, getClientState, getCorsErrorProjectId, getCurrentUserState, getDashboardOrganizationId, getDatasetsState, getDocumentState, getDocumentSyncStatus, getFavoritesState, getIndexForKey, getIsInDashboardState, getLoginUrlState, getNodeState, getOrCreateChannel, getOrCreateController, getOrCreateNode, getPathDepth, getPermissionsState, getPerspectiveState, getPresence, getProjectState, getProjectionState, getProjectsState, getQueryKey, getQueryState, getTokenState, getUserState, getUsersKey, getUsersState, handleAuthCallback, isCanvasResource, isDatasetResource, isMediaLibraryResource, isProjectUserNotFoundClientError, isStudioConfig, joinPaths, jsonMatch, loadMoreUsers, logout, observeOrganizationVerificationState, parseQueryKey, parseUsersKey, publishDocument, releaseChannel, releaseNode, resolveDatasets, resolveDocument, resolveFavoritesState, resolvePermissions, resolveProject, resolveProjection, resolveProjects, resolveQuery, resolveUser, resolveUsers, setAuthToken, slicePath, stringifyPath, subscribeDocumentEvents, transformProjectionToPreview, unpublishDocument };