@sanity/sdk 2.6.0 → 2.7.0

package/dist/index.d.ts

@@ -76,6 +76,42 @@ interface AuthConfig {
    */
   token?: string;
 }
+/**
+ * A minimal Observable-compatible interface for subscribing to token changes.
+ * Any object with a `subscribe` method that follows this contract will work,
+ * including RxJS Observables. This avoids coupling the SDK to a specific
+ * reactive library.
+ *
+ * @public
+ */
+interface TokenSource {
+  /** Subscribe to token emissions. Emits `null` when logged out. */
+  subscribe(observer: {
+    next: (token: string | null) => void;
+  }): {
+    unsubscribe(): void;
+  };
+}
+/**
+ * Studio-specific configuration for the SDK.
+ * When present, the SDK operates in studio mode and derives auth from the
+ * provided token source instead of discovering tokens independently.
+ *
+ * @public
+ */
+interface StudioConfig {
+  /** Reactive auth token source from the Studio's auth store. */
+  auth?: {
+    /**
+     * A reactive token source. The SDK subscribes and stays in sync — the
+     * Studio is the single authority for auth and handles token refresh.
+     *
+     * Optional because older Studios may not expose it. When absent, the
+     * SDK falls back to localStorage/cookie discovery.
+     */
+    token?: TokenSource;
+  };
+}
 /**
  * Represents the minimal configuration required to identify a Sanity project.
  * @public
@@ -101,11 +137,6 @@ interface PerspectiveHandle {
  */
 interface DatasetHandle<TDataset extends string = string, TProjectId extends string = string> extends ProjectHandle<TProjectId>, PerspectiveHandle {
   dataset?: TDataset;
-  /**
-   * @beta
-   * The name of the source to use for this operation.
-   */
-  sourceName?: string;
   /**
    * @beta
    * Explicit source object to use for this operation.
@@ -148,8 +179,19 @@ interface SanityConfig extends DatasetHandle, PerspectiveHandle {
    */
   auth?: AuthConfig;
   /**
-   * Studio mode configuration for use of the SDK in a Sanity Studio
-   * @remarks Controls whether studio mode features are enabled
+   * Studio configuration provided by a Sanity Studio workspace.
+   * When present, the SDK operates in studio mode and derives auth from the
+   * workspace's reactive token source — no manual configuration needed.
+   *
+   * @remarks Typically set automatically by `SanityApp` when it detects an
+   * `SDKStudioContext` provider. Can also be set explicitly for programmatic use.
+   */
+  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;
@@ -319,6 +361,14 @@ declare function agentPrompt(instance: SanityInstance, options: AgentPromptOptio
  * @alpha
  */
 declare function agentPatch(instance: SanityInstance, options: AgentPatchOptions): 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
+ */
+declare function isStudioConfig(config: SanityConfig): boolean;
 /**
  * Represents the various states the authentication type can be in.
  *
@@ -330,6 +380,64 @@ declare enum AuthStateType {
   ERROR = "error",
   LOGGED_OUT = "logged-out",
 }
+/**
+ * Represents a reactive store state container with multiple access patterns
+ */
+interface StoreState<TState> {
+  /**
+   * Gets the current state value
+   *
+   * @remarks
+   * This is a direct synchronous accessor that doesn't trigger subscriptions
+   */
+  get: () => TState;
+  /**
+   * Updates the store state
+   * @param name - Action name for devtools tracking
+   * @param updatedState - New state value or updater function
+   *
+   * @remarks
+   * When providing a partial object, previous top-level keys not included in
+   * the update will be preserved.
+   */
+  set: (name: string, updatedState: Partial<TState> | ((s: TState) => Partial<TState>)) => void;
+  /**
+   * Observable stream of state changes
+   * @remarks
+   * - Emits immediately with current state on subscription
+   * - Shares underlying subscription between observers
+   * - Only emits when state reference changes
+   * - Completes when store is disposed
+   */
+  observable: Observable<TState>;
+}
+/**
+ * Context object provided to store initialization functions
+ */
+interface StoreContext<TState, TKey = unknown> {
+  /**
+   * Sanity instance associated with this store
+   *
+   * @remarks
+   * Provides access to the Sanity configuration and instance lifecycle methods
+   */
+  instance: SanityInstance;
+  /**
+   * Reactive store state management utilities
+   *
+   * @remarks
+   * Contains methods for getting/setting state and observing changes
+   */
+  state: StoreState<TState>;
+  /**
+   * The key used to instantiate the store.
+   */
+  key: TKey;
+}
+/**
+ * Defines a store action that operates on a specific state type
+ */
+type StoreAction<TState, TParams extends unknown[], TReturn, TKey = unknown> = (context: StoreContext<TState, TKey>, ...params: TParams) => TReturn;
 /**
  * Represents a store action that has been bound to a specific store instance
  */
@@ -1865,7 +1973,6 @@ declare const resolveProjects: BoundStoreAction<FetcherStoreState<[options?: {
 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>;
-  source?: DocumentSource;
 }
 /**
  * @beta
@@ -1942,6 +2049,13 @@ declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [((ob
   projectId?: string;
   dataset?: string;
 }) | undefined)?, ...unknown[]], StateSource<ReleaseDocument[] | undefined>>;
+declare const _getPerspectiveStateSelector: StoreAction<ReleasesStoreState, [_?: (PerspectiveHandle & {
+  projectId?: string;
+  dataset?: string;
+}) | 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>>;
+type BoundGetPerspectiveState = BoundStoreAction<ReleasesStoreState, SelectorParams, ReturnType<typeof _getPerspectiveStateSelector>>;
 /**
  * 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.
@@ -1954,10 +2068,7 @@ declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [((ob
  *
  * @public
  */
-declare const getPerspectiveState: BoundStoreAction<ReleasesStoreState, [_?: (PerspectiveHandle & {
-  projectId?: string;
-  dataset?: string;
-}) | undefined], StateSource<string[] | "raw" | "previewDrafts" | "published" | "drafts" | undefined>>;
+declare const getPerspectiveState: BoundGetPerspectiveState;
 /** @internal */
 declare const getUsersKey: (instance: SanityInstance, {
   resourceType,
@@ -2229,4 +2340,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 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, 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 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 };