@sanity/sdk 0.0.0-alpha.13 → 0.0.0-alpha.14

package/README.md

@@ -7,20 +7,20 @@
 
 Core utilities for creating Sanity applications.
 
-## Installation
+## 💻 Installation
 
 ```bash
 npm i @sanity/sdk
 ```
 
-## SDK Documentation
+## 📚 SDK Documentation
 
 See the [SDK Documentation](https://sdk-docs.sanity.dev) for more information.
 
-## Implementations
+## 🧑‍💻 Implementations
 
 - [React](https://www.npmjs.com/package/@sanity/sdk-react)
 
-## License
+## 📄 License
 
 MIT © Sanity.io

package/dist/index.d.ts

@@ -240,13 +240,6 @@ export declare interface AuthConfig {
    * ignoring any storage or callback handling.
    */
   token?: string
-  /**
-   * The authentication scope.
-   * If set to 'project', requests are scoped to the project-level.
-   * If set to 'global', requests are scoped to the user access level.
-   * Defaults to 'project'.
-   */
-  authScope?: 'project' | 'global'
 }
 
 /**
@@ -305,7 +298,6 @@ export declare interface AuthStoreState {
     initialLocationHref: string
     clientFactory: (config: ClientConfig) => SanityClient
     customProviders: AuthConfig['providers']
-    authScope: 'project' | 'global'
     storageKey: string
     storageArea: Storage | undefined
     apiHost: string | undefined
@@ -422,6 +414,7 @@ export declare interface CreateDocumentAction<
 > {
   type: 'document.create'
   documentId?: string
+  resourceId?: DocumentResourceId
   documentType: TDocument['_type']
 }
 
@@ -533,7 +526,7 @@ declare type DeepGet<T, TParts extends readonly unknown[]> = TParts extends [
 
 /** @beta */
 export declare function deleteDocument<TDocument extends SanityDocumentLike>(
-  doc: string | DocumentHandle<TDocument>,
+  doc: DocumentHandle<TDocument>,
 ): DeleteDocumentAction<TDocument>
 
 /** @beta */
@@ -542,6 +535,7 @@ export declare interface DeleteDocumentAction<
 > {
   type: 'document.delete'
   documentId: string
+  resourceId?: DocumentResourceId
 }
 
 declare type DereferenceFunction = (obj: {
@@ -568,7 +562,7 @@ export declare const destroyController: (
 
 /** @beta */
 export declare function discardDocument<TDocument extends SanityDocumentLike>(
-  doc: string | DocumentHandle<TDocument>,
+  doc: DocumentHandle<TDocument>,
 ): DiscardDocumentAction<TDocument>
 
 /** @beta */
@@ -577,6 +571,7 @@ export declare interface DiscardDocumentAction<
 > {
   type: 'document.discard'
   documentId: string
+  resourceId?: DocumentResourceId
 }
 
 declare type Document_2 = {
@@ -657,6 +652,7 @@ export declare type DocumentEvent =
 export declare interface DocumentHandle<TDocument extends SanityDocumentLike = SanityDocumentLike> {
   _id: string
   _type: TDocument['_type']
+  resourceId?: DocumentResourceId
 }
 
 /**
@@ -674,11 +670,13 @@ declare interface DocumentHandle_2 {
  * @public
  */
 export declare interface DocumentListOptions {
+  /** The resourceId of the Sanity instance to use for this list. */
+  resourceId?: string
   /** GROQ filter expression to query specific documents */
   filter?: string
   /** Array of sort ordering specifications to determine the order of results */
   sort?: SortOrderingItem[]
-  /** The Content Lake perspective to use for this list. Defaults to `previewDrafts`. */
+  /** The Content Lake perspective to use for this list. Defaults to `drafts`. */
   perspective?: string
 }
 
@@ -717,6 +715,12 @@ declare interface DocumentRebaseErrorEvent {
   error: unknown
 }
 
+/**
+ * @beta
+ * A resource identifier for a document, in the format of `document:${projectId}.${dataset}:${documentId}`
+ */
+export declare type DocumentResourceId = `document:${string}.${string}:${string}`
+
 /**
  * Represents a set of document that will go into `applyMutations`. Before
  * applying a mutation, it's expected that all relevant documents that the
@@ -784,6 +788,7 @@ export declare interface DocumentTypeHandle<
 > {
   _id?: string
   _type: TDocument['_type']
+  resourceId?: DocumentResourceId
 }
 
 /**
@@ -803,7 +808,7 @@ export declare function editDocument<TDocument extends SanityDocumentLike>(
 
 /** @beta */
 export declare function editDocument<TDocument extends SanityDocumentLike>(
-  doc: string | DocumentHandle<TDocument>,
+  doc: DocumentHandle<TDocument>,
   patches?: PatchOperations | PatchOperations[],
 ): EditDocumentAction<TDocument>
 
@@ -813,6 +818,7 @@ export declare interface EditDocumentAction<
 > {
   type: 'document.edit'
   documentId: string
+  resourceId?: DocumentResourceId
   patches?: PatchOperations[]
 }
 
@@ -1010,7 +1016,7 @@ export declare function getDocumentState(
 /** @beta */
 export declare const getDocumentSyncStatus: ResourceAction<
   DocumentStoreState,
-  [doc: string | DocumentHandle<SanityDocumentLike>],
+  [doc: DocumentHandle<SanityDocumentLike>],
   StateSource<boolean | undefined>
 >
 
@@ -1080,6 +1086,27 @@ export declare interface GetPreviewStateOptions {
   document: DocumentHandle_2
 }
 
+/**
+ * @beta
+ */
+export declare function getProjectionState<TResult extends object>(
+  instance: SanityInstance | ActionContext<ProjectionStoreState>,
+  options: GetProjectionStateOptions,
+): StateSource<ProjectionValuePending<TResult>>
+
+/**
+ * @beta
+ */
+export declare function getProjectionState(
+  instance: SanityInstance | ActionContext<ProjectionStoreState>,
+  options: GetProjectionStateOptions,
+): StateSource<ProjectionValuePending<Record<string, unknown>>>
+
+declare interface GetProjectionStateOptions {
+  document: DocumentHandle_2
+  projection: ValidProjection
+}
+
 /** @public */
 export declare const getProjectsState: ResourceAction<
   FetcherStoreState<[], Omit<SanityProject_2, 'members'>[]>,
@@ -1094,6 +1121,14 @@ export declare const getProjectState: ResourceAction<
   StateSource<SanityProject_2 | undefined>
 >
 
+/**
+ * @beta
+ * Get the resource ID from a document resource ID
+ */
+export declare function getResourceId(
+  documentResourceId: DocumentResourceId | undefined,
+): ResourceId | undefined
+
 /**
  * @public
  */
@@ -1224,6 +1259,11 @@ export declare function jsonMatch<TValue>(input: unknown, path: string): MatchEn
  */
 export declare type JsonMatchPath<_TDocument extends SanityDocumentLike> = string
 
+declare interface LiveEventAwareState {
+  lastLiveEventId: string | null
+  syncTags: Record<string, true>
+}
+
 /**
  * Logged-in state from the auth state.
  * @public
@@ -1497,7 +1537,7 @@ declare interface PosNode extends BaseNode {
 /**
  * @public
  */
-export declare interface PreviewStoreState {
+export declare interface PreviewStoreState extends LiveEventAwareState {
   values: {
     [TDocumentId in string]?: ValuePending<PreviewValue>
   }
@@ -1509,8 +1549,6 @@ export declare interface PreviewStoreState {
       [TSubscriptionId in string]?: true
     }
   }
-  syncTags: Record<SyncTag, true>
-  lastLiveEventId: string | null
 }
 
 /**
@@ -1554,9 +1592,31 @@ declare interface ProjectionNode extends BaseNode {
   expr: ExprNode
 }
 
+declare interface ProjectionStoreState<TValue extends object = object> extends LiveEventAwareState {
+  values: {
+    [TDocumentId in string]?: ProjectionValuePending<TValue>
+  }
+  documentProjections: {
+    [TDocumentId in string]?: ValidProjection
+  }
+  subscriptions: {
+    [TDocumentId in string]?: {
+      [TSubscriptionId in string]?: true
+    }
+  }
+}
+
+/**
+ * @beta
+ */
+export declare interface ProjectionValuePending<TValue extends object> {
+  results: TValue | null
+  isPending: boolean
+}
+
 /** @beta */
 export declare function publishDocument<TDocument extends SanityDocumentLike>(
-  doc: string | DocumentHandle<TDocument>,
+  doc: DocumentHandle<TDocument>,
 ): PublishDocumentAction<TDocument>
 
 /** @beta */
@@ -1565,6 +1625,7 @@ export declare interface PublishDocumentAction<
 > {
   type: 'document.publish'
   documentId: string
+  resourceId?: DocumentResourceId
 }
 
 /**
@@ -1651,6 +1712,20 @@ export declare const resolveProject: ResourceAction<
   Promise<SanityProject_2>
 >
 
+/**
+ * @beta
+ */
+export declare const resolveProjection: ResourceAction<
+  ProjectionStoreState<object>,
+  [ResolveProjectionOptions],
+  Promise<ProjectionValuePending<Record<string, unknown>>>
+>
+
+declare interface ResolveProjectionOptions {
+  document: DocumentHandle_2
+  projection: ValidProjection
+}
+
 /** @public */
 export declare const resolveProjects: ResourceAction<
   FetcherStoreState<[], Omit<SanityProject_2, 'members'>[]>,
@@ -1666,6 +1741,12 @@ export declare type ResourceAction<TState, TParams extends unknown[], TReturn> =
   ...params: TParams
 ) => TReturn
 
+/**
+ * @public
+ * A resource identifier for a document, in the format of `projectId.dataset`
+ */
+export declare type ResourceId = `${string}.${string}`
+
 /**
  * @public
  */
@@ -1760,6 +1841,7 @@ export declare interface SdkIdentity {
   readonly id: string
   readonly projectId: string
   readonly dataset: string
+  readonly resourceId: ResourceId
 }
 
 declare interface SelectAlternativeNode extends BaseNode {
@@ -1873,7 +1955,7 @@ declare interface TupleNode extends BaseNode {
 
 /** @beta */
 export declare function unpublishDocument<TDocument extends SanityDocumentLike>(
-  doc: string | DocumentHandle<TDocument>,
+  doc: DocumentHandle<TDocument>,
 ): UnpublishDocumentAction<TDocument>
 
 /** @beta */
@@ -1882,6 +1964,7 @@ export declare interface UnpublishDocumentAction<
 > {
   type: 'document.unpublish'
   documentId: string
+  resourceId?: DocumentResourceId
 }
 
 declare interface UnverifiedDocumentRevision {
@@ -1929,6 +2012,11 @@ export declare interface UsersStoreState {
   }
 }
 
+/**
+ * @beta
+ */
+export declare type ValidProjection = `{${string}}`
+
 /**
  * The result of an expression.
  */