@sanity/sdk 2.4.0 → 2.5.0

package/dist/index.d.ts

@@ -105,12 +105,18 @@ interface DatasetHandle<TDataset extends string = string, TProjectId extends str
 /**
  * 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.
+ * 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> {
   documentId?: string;
   documentType: TDocumentType;
+  /**
+   * Indicates whether this document uses liveEdit mode.
+   * When `true`, the document does not use the draft/published model and edits are applied directly to the document.
+   * @see https://www.sanity.io/docs/content-lake/drafts#ca0663a8f002
+   */
+  liveEdit?: boolean;
 }
 /**
  * Uniquely identifies a specific document within a Sanity dataset and project.
@@ -308,29 +314,6 @@ declare enum AuthStateType {
  * Represents a store action that has been bound to a specific store instance
  */
 type BoundStoreAction<_TState, TParams extends unknown[], TReturn> = (instance: SanityInstance, ...params: TParams) => TReturn;
-/**
- * Creates an action binder function that uses the provided key function
- * to determine how store instances are shared between Sanity instances
- *
- * @param keyFn - Function that generates a key from a Sanity config
- * @returns A function that binds store actions to Sanity instances
- *
- * @remarks
- * Action binders determine how store instances are shared across multiple
- * Sanity instances. The key function determines which instances share state.
- *
- * @example
- * ```ts
- * // Create a custom binder that uses a tenant ID for isolation
- * const bindActionByTenant = createActionBinder(config => config.tenantId || 'default')
- *
- * // Use the custom binder with a store definition
- * const getTenantUsers = bindActionByTenant(
- *   userStore,
- *   ({state}) => state.get().users
- * )
- * ```
- */
 /**
  * Represents the various states the authentication can be in.
  *
@@ -414,10 +397,6 @@ declare const getCurrentUserState: BoundStoreAction<AuthStoreState, [], StateSou
  * @public
  */
 declare const getTokenState: BoundStoreAction<AuthStoreState, [], StateSource<string | null>>;
-/**
- * @internal
- */
-
 /**
  * @public
  */
@@ -448,10 +427,6 @@ declare const setAuthToken: BoundStoreAction<AuthStoreState, [token: string | nu
 interface OrgVerificationResult {
   error: string | null;
 }
-/**
- * Compares a project's actual organization ID with the expected organization ID.
- * @public
- */
 /**
  * Creates an observable that emits the organization verification state for a given instance.
  * It combines the dashboard organization ID (from auth context) with the
@@ -826,21 +801,6 @@ declare function discardDocument<TDocumentType extends string = string, TDataset
  * Documents that don't exist have a `null` value.
  */
 type DocumentSet<TDocument extends SanityDocument$2 = SanityDocument$2> = { [TDocumentId in string]?: TDocument | null };
-/**
- * Implements ID generation:
- *
- * A create mutation creates a new document. It takes the literal document
- * content as its argument. The rules for the new document's identifier are as
- * follows:
- *
- * - If the `_id` attribute is missing, then a new, random, unique ID is
- *   generated.
- * - If the `_id` attribute is present but ends with `.`, then it is used as a
- *   prefix for a new, random, unique ID.
- * - If the _id attribute is present, it is used as-is.
- *
- * [- source](https://www.sanity.io/docs/http-mutations#c732f27330a4)
- */
 /** @beta */
 interface ActionsResult<TDocument extends SanityDocument$3 = SanityDocument$3> {
   transactionId: string;
@@ -856,6 +816,10 @@ interface ActionsResult<TDocument extends SanityDocument$3 = SanityDocument$3> {
 }
 /** @beta */
 interface ApplyDocumentActionsOptions {
+  /**
+   * List of actions to apply.
+   */
+  actions: DocumentAction[];
   /**
    * Optionally provide an ID to be used as this transaction ID
    */
@@ -866,9 +830,9 @@ interface ApplyDocumentActionsOptions {
   disableBatching?: boolean;
 }
 /** @beta */
-declare function applyDocumentActions<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, action: DocumentAction<TDocumentType, TDataset, TProjectId> | DocumentAction<TDocumentType, TDataset, TProjectId>[], options?: ApplyDocumentActionsOptions): Promise<ActionsResult<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>>>;
+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, action: DocumentAction | DocumentAction[], options?: ApplyDocumentActionsOptions): Promise<ActionsResult>;
+declare function applyDocumentActions(instance: SanityInstance, options: ApplyDocumentActionsOptions): Promise<ActionsResult>;
 /**
  * Represents a reactive state source that provides synchronized access to store data
  *
@@ -942,11 +906,9 @@ interface SelectorContext<TState> {
  * @public
  */
 type Selector<TState, TParams extends unknown[], TReturn> = (context: SelectorContext<TState>, ...params: TParams) => TReturn;
-/**
- * Configuration options for creating a state source action
- */
 type ActionMap = {
   create: 'sanity.action.document.version.create';
+  createLiveEdit: 'sanity.action.document.create';
   discard: 'sanity.action.document.version.discard';
   unpublish: 'sanity.action.document.unpublish';
   delete: 'sanity.action.document.delete';
@@ -961,6 +923,10 @@ type HttpAction = {
   actionType: ActionMap['create'];
   publishedId: string;
   attributes: SanityDocumentLike;
+} | {
+  actionType: ActionMap['createLiveEdit'];
+  publishedId: string;
+  attributes: SanityDocumentLike;
 } | {
   actionType: ActionMap['discard'];
   versionId: string;
@@ -1218,11 +1184,6 @@ TTail extends readonly (string | number)[] ? TTail : []> : never;
  * @beta
  */
 type JsonMatch<TDocument, TPath extends string> = DeepGet<TDocument, PathParts<TPath>>;
-/**
- * Recursively traverse a value. When an array is encountered, ensure that
- * each object item has a _key property. Memoized such that sub-objects that
- * have not changed aren't re-computed.
- */
 interface SharedListener {
   events: Observable<ListenEvent<SanityDocument$1>>;
   dispose: () => void;
@@ -1291,10 +1252,13 @@ declare function resolveDocument<TDocumentType extends string = string, TDataset
 declare function resolveDocument<TData extends SanityDocument$3>(instance: SanityInstance, docHandle: DocumentHandle<string, string, string>): Promise<TData | null>;
 /** @beta */
 declare const getDocumentSyncStatus: BoundStoreAction<DocumentStoreState, [doc: DocumentHandle<string, string, string>], StateSource<boolean | undefined>>;
+type PermissionsStateOptions = {
+  actions: DocumentAction[];
+};
 /** @beta */
-declare const getPermissionsState: BoundStoreAction<DocumentStoreState, [DocumentAction | DocumentAction[]], StateSource<DocumentPermissionsResult | undefined>>;
+declare const getPermissionsState: BoundStoreAction<DocumentStoreState, [PermissionsStateOptions], StateSource<DocumentPermissionsResult | undefined>>;
 /** @beta */
-declare const resolvePermissions: BoundStoreAction<DocumentStoreState, [actions: DocumentAction | DocumentAction[]], Promise<DocumentPermissionsResult>>;
+declare const resolvePermissions: BoundStoreAction<DocumentStoreState, [options: PermissionsStateOptions], Promise<DocumentPermissionsResult>>;
 /** @beta */
 declare const subscribeDocumentEvents: BoundStoreAction<DocumentStoreState, [eventHandler: (e: DocumentEvent) => void], () => void>;
 /**
@@ -1431,8 +1395,6 @@ interface UserPresence {
   locations: PresenceLocation[];
   sessionId: string;
 }
-/** @public */
-
 /** @public */
 type TransportEvent = RollCallEvent | StateEvent | DisconnectEvent;
 /** @public */
@@ -1456,7 +1418,6 @@ interface DisconnectEvent {
   sessionId: string;
   timestamp: string;
 }
-/** @public */
 type PresenceStoreState = {
   locations: Map<string, {
     userId: string;
@@ -1467,7 +1428,10 @@ type PresenceStoreState = {
 /** @public */
 
 /** @public */
-declare const getPresence: BoundStoreAction<PresenceStoreState, [], StateSource<UserPresence[]>>;
+declare const getPresence: BoundStoreAction<PresenceStoreState, [((object & {
+  projectId?: string;
+  dataset?: string;
+}) | undefined)?, ...unknown[]], StateSource<UserPresence[]>>;
 /**
  * Represents a media asset in a preview.
  *
@@ -1542,9 +1506,6 @@ declare function getPreviewState<TResult extends object>(instance: SanityInstanc
  * @beta
  */
 declare function getPreviewState(instance: SanityInstance, options: GetPreviewStateOptions): StateSource<ValuePending<PreviewValue>>;
-/**
- * @beta
- */
 /**
  * @beta
  */
@@ -1587,9 +1548,6 @@ declare function getProjectionState<TData extends object>(instance: SanityInstan
  * @beta
  */
 declare function getProjectionState(instance: SanityInstance, options: ProjectionOptions): StateSource<ProjectionValuePending<Record<string, unknown>> | undefined>;
-/**
- * @beta
- */
 /** @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 */
@@ -1689,7 +1647,10 @@ interface ReleasesStoreState {
  * Get the active releases from the store.
  * @internal
  */
-declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [], StateSource<ReleaseDocument[] | undefined>>;
+declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [((object & {
+  projectId?: string;
+  dataset?: string;
+}) | undefined)?, ...unknown[]], StateSource<ReleaseDocument[] | 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.
@@ -1702,7 +1663,10 @@ declare const getActiveReleasesState: BoundStoreAction<ReleasesStoreState, [], S
  *
  * @public
  */
-declare const getPerspectiveState: BoundStoreAction<ReleasesStoreState, [options?: PerspectiveHandle | undefined], StateSource<string[] | "raw" | "previewDrafts" | "published" | "drafts" | undefined>>;
+declare const getPerspectiveState: BoundStoreAction<ReleasesStoreState, [_?: (PerspectiveHandle & {
+  projectId?: string;
+  dataset?: string;
+}) | undefined], StateSource<string[] | "raw" | "previewDrafts" | "published" | "drafts" | undefined>>;
 /** @internal */
 declare const getUsersKey: (instance: SanityInstance, {
   resourceType,
@@ -1807,25 +1771,6 @@ interface FetcherStore<TParams extends unknown[], TData> {
   getState: BoundStoreAction<FetcherStoreState<TParams, TData>, TParams, StateSource<TData | undefined>>;
   resolveState: BoundStoreAction<FetcherStoreState<TParams, TData>, TParams, Promise<TData>>;
 }
-/**
- * Creates a store from a function that returns an observable that fetches data
- * that supports parameterized state caching.
- *
- * This function creates a resource store keyed by parameter values (using the
- * provided `getKey` function) and returns a state source (via `getState`)
- * that components can subscribe to. When a new subscription is added, and if
- * enough time has passed since the last fetch (controlled by
- * `fetchThrottleInternal`), it invokes the observable factory (via
- * `getObservable`) to fetch fresh data. The data is stored in state and can be
- * accessed reactively.
- *
- * Additionally, the store provides a `resolveState` function that returns a
- * Promise resolving with the next non-undefined value from the state source.
- *
- * State expiration is implemented: after the last subscription for a key is
- * removed, its state is cleared after `stateExpirationDelay` ms, causing
- * components to suspend until fresh data is fetched.
- */
 /**
  * Creates a GROQ search filter string (`[@] match text::query("...")`)
  * from a raw search query string.