@sanity/sdk 0.0.0-alpha.21 → 0.0.0-alpha.23

package/src/document/listen.ts

@@ -16,7 +16,7 @@ import {
 } from 'rxjs'
 import {mergeMap, scan} from 'rxjs/operators'
 
-import {type ActionContext, createInternalAction} from '../resources/createAction'
+import {type StoreContext} from '../store/defineStore'
 import {type DocumentStoreState} from './documentStore'
 import {processMutations} from './processMutations'
 
@@ -193,65 +193,66 @@ export function sortListenerEvents(options?: SortListenerEventsOptions) {
   }
 }
 
-export const listen = createInternalAction(({state}: ActionContext<DocumentStoreState>) => {
+export const listen = (
+  {state}: StoreContext<DocumentStoreState>,
+  documentId: string,
+): Observable<RemoteDocument> => {
   const {sharedListener, fetchDocument} = state.get()
 
-  return function (documentId: string) {
-    return sharedListener.pipe(
-      concatMap((e) => {
-        if (e.type === 'welcome') {
-          return fetchDocument(documentId).pipe(
-            map((document): SyncEvent => ({type: 'sync', document})),
-          )
-        }
-        if (e.type === 'mutation' && e.documentId === documentId) return of(e)
-        return EMPTY
-      }),
-      sortListenerEvents(),
-      withLatestFrom(
-        state.observable.pipe(
-          map((s) => s.documentStates[documentId]),
-          filter(Boolean),
-          distinctUntilChanged(),
-        ),
+  return sharedListener.events.pipe(
+    concatMap((e) => {
+      if (e.type === 'welcome') {
+        return fetchDocument(documentId).pipe(
+          map((document): SyncEvent => ({type: 'sync', document})),
+        )
+      }
+      if (e.type === 'mutation' && e.documentId === documentId) return of(e)
+      return EMPTY
+    }),
+    sortListenerEvents(),
+    withLatestFrom(
+      state.observable.pipe(
+        map((s) => s.documentStates[documentId]),
+        filter(Boolean),
+        distinctUntilChanged(),
       ),
-      map(([next, documentState]): RemoteDocument => {
-        if (next.type === 'sync') {
-          return {
-            type: 'sync',
-            documentId,
-            document: next.document,
-            revision: next.document?._rev,
-            timestamp: next.document?._updatedAt ?? new Date().toISOString(),
-          }
+    ),
+    map(([next, documentState]): RemoteDocument => {
+      if (next.type === 'sync') {
+        return {
+          type: 'sync',
+          documentId,
+          document: next.document,
+          revision: next.document?._rev,
+          timestamp: next.document?._updatedAt ?? new Date().toISOString(),
         }
+      }
 
-        // TODO: from manual testing, mendoza patches seem to be applying
-        // let document
-        // if (next.effects?.apply) {
-        //   document = applyPatch(omit(documentState.remote, '_rev'), next.effects?.apply)
-        // }
+      // TODO: from manual testing, mendoza patches seem to be applying
+      // let document
+      // if (next.effects?.apply) {
+      //   document = applyPatch(omit(documentState.remote, '_rev'), next.effects?.apply)
+      // }
 
-        const [document] = Object.values(
-          processMutations({
-            documents: {[documentId]: documentState.remote},
-            mutations: next.mutations as Mutation[],
-            transactionId: next.transactionId,
-            timestamp: next.timestamp,
-          }),
-        )
+      const [document] = Object.values(
+        processMutations({
+          documents: {[documentId]: documentState.remote},
+          mutations: next.mutations as Mutation[],
+          transactionId: next.transactionId,
+          timestamp: next.timestamp,
+        }),
+      )
 
-        const {previousRev, transactionId, timestamp} = next
+      const {previousRev, transactionId, timestamp} = next
 
-        return {
-          type: 'mutation',
-          documentId,
-          document: document ?? null,
-          revision: transactionId,
-          timestamp,
-          ...(previousRev && {previousRev}),
-        }
-      }),
-    )
-  }
-})
+      return {
+        type: 'mutation',
+        documentId,
+        document: document ?? null,
+        revision: transactionId,
+        timestamp,
+        ...(previousRev && {previousRev}),
+      }
+    }),
+  )
+}

package/src/document/patchOperations.ts

@@ -12,49 +12,6 @@ import {
 
 type SingleValuePath = Exclude<PathSegment, IndexTuple>[]
 
-/**
- * @beta
- * 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 interface DocumentHandle<TDocument extends SanityDocumentLike = SanityDocumentLike> {
-  _id: string
-  _type: TDocument['_type']
-  resourceId?: DocumentResourceId
-}
-
-/**
- * @beta
- * A resource identifier for a document, in the format of `document:${projectId}.${dataset}:${documentId}`
- */
-export type DocumentResourceId = `document:${string}.${string}:${string}`
-
-/**
- * @public
- * A resource identifier for a document, in the format of `projectId.dataset`
- */
-export type ResourceId = `${string}.${string}`
-
-/**
- * @beta
- * Get the resource ID from a document resource ID
- */
-export function getResourceId(
-  documentResourceId: DocumentResourceId | undefined,
-): ResourceId | undefined {
-  if (!documentResourceId) return undefined
-  return documentResourceId.split(':')[1] as ResourceId
-}
-
-/** @beta */
-export interface DocumentTypeHandle<TDocument extends SanityDocumentLike = SanityDocumentLike> {
-  _id?: string
-  _type: TDocument['_type']
-  resourceId?: DocumentResourceId
-}
-
 type ToNumber<TInput extends string> = TInput extends `${infer TNumber extends number}`
   ? TNumber
   : TInput

package/src/document/permissions.test.ts

@@ -2,12 +2,19 @@ import {type SanityDocument} from '@sanity/types'
 import {type ExprNode} from 'groq-js'
 import {describe, expect, it} from 'vitest'
 
+import {createSanityInstance} from '../store/createSanityInstance'
 import {getDraftId, getPublishedId} from '../utils/ids'
 import {evaluateSync, parse} from './_synchronous-groq-js.mjs'
 import {type DocumentAction} from './actions'
 import {calculatePermissions, createGrantsLookup, type DatasetAcl, type Grant} from './permissions'
 import {type SyncTransactionState} from './reducers'
 
+const instance = createSanityInstance({projectId: 'p', dataset: 'd'})
+
+afterAll(() => {
+  instance.dispose()
+})
+
 // Helper: Create a sample document that conforms to SanityDocument.
 const createDoc = (id: string, title: string, rev: string = 'initial'): SanityDocument => ({
   _id: id,
@@ -69,7 +76,7 @@ describe('calculatePermissions', () => {
     const actions: DocumentAction[] = [
       {documentId: 'doc1', type: 'document.create', documentType: 'article'},
     ]
-    const result = calculatePermissions(state, actions)
+    const result = calculatePermissions({instance, state}, actions)
     expect(result).toEqual({allowed: true})
   })
 
@@ -85,7 +92,7 @@ describe('calculatePermissions', () => {
     const actions: DocumentAction[] = [
       {documentId: 'doc1', type: 'document.create', documentType: 'article'},
     ]
-    expect(calculatePermissions(state, actions)).toBeUndefined()
+    expect(calculatePermissions({instance, state}, actions)).toBeUndefined()
   })
 
   it('should catch PermissionActionError from processActions and return allowed false with a reason', () => {
@@ -101,7 +108,7 @@ describe('calculatePermissions', () => {
     const actions: DocumentAction[] = [
       {documentId: 'doc1', type: 'document.create', documentType: 'article'},
     ]
-    const result = calculatePermissions(state, actions)
+    const result = calculatePermissions({instance, state}, actions)
     expect(result).toBeDefined()
     expect(result?.allowed).toBe(false)
     expect(result?.reasons).toEqual(
@@ -126,8 +133,10 @@ describe('calculatePermissions', () => {
       },
       defaultGrants,
     )
-    const actions: DocumentAction[] = [{documentId: 'doc1', type: 'document.edit'}]
-    const result = calculatePermissions(state, actions)
+    const actions: DocumentAction[] = [
+      {documentId: 'doc1', documentType: 'book', type: 'document.edit'},
+    ]
+    const result = calculatePermissions({instance, state}, actions)
     expect(result).toBeDefined()
     expect(result?.allowed).toBe(false)
     expect(result?.reasons).toEqual(
@@ -150,8 +159,10 @@ describe('calculatePermissions', () => {
       },
       deniedGrants,
     )
-    const actions: DocumentAction[] = [{documentId: 'doc1', type: 'document.edit'}]
-    const result = calculatePermissions(state, actions)
+    const actions: DocumentAction[] = [
+      {documentId: 'doc1', documentType: 'book', type: 'document.edit'},
+    ]
+    const result = calculatePermissions({instance, state}, actions)
     expect(result).toBeDefined()
     expect(result?.allowed).toBe(false)
     expect(result?.reasons).toEqual(
@@ -175,7 +186,7 @@ describe('calculatePermissions', () => {
     const actions: DocumentAction[] = [
       {documentId: 'doc1', type: 'document.create', documentType: 'article'},
     ]
-    expect(calculatePermissions(state, actions)).toBeUndefined()
+    expect(calculatePermissions({instance, state}, actions)).toBeUndefined()
   })
 
   it('should catch ActionError from processActions and return a precondition error reason', () => {
@@ -187,8 +198,10 @@ describe('calculatePermissions', () => {
       },
       defaultGrants,
     )
-    const actions: DocumentAction[] = [{documentId: 'doc1', type: 'document.delete'}]
-    const result = calculatePermissions(state, actions)
+    const actions: DocumentAction[] = [
+      {documentId: 'doc1', documentType: 'book', type: 'document.delete'},
+    ]
+    const result = calculatePermissions({instance, state}, actions)
     expect(result).toBeDefined()
     expect(result?.allowed).toBe(false)
     expect(result?.reasons).toEqual(
@@ -216,8 +229,8 @@ describe('calculatePermissions', () => {
       documentType: 'article',
     }
     // notice how the action is a copy
-    const result1 = calculatePermissions(state, [{...action}])
-    const result2 = calculatePermissions(state, [{...action}])
+    const result1 = calculatePermissions({instance, state}, [{...action}])
+    const result2 = calculatePermissions({instance, state}, [{...action}])
     expect(result1).toBe(result2)
   })
 })

package/src/document/permissions.ts

@@ -2,6 +2,7 @@ import {type SanityDocument} from '@sanity/types'
 import {type ExprNode} from 'groq-js'
 import {createSelector} from 'reselect'
 
+import {type SelectorContext} from '../store/createStateSourceAction'
 import {getDraftId, getPublishedId} from '../utils/ids'
 import {MultiKeyWeakMap} from '../utils/MultiKeyWeakMap'
 import {evaluateSync, parse} from './_synchronous-groq-js.mjs'
@@ -57,8 +58,9 @@ const nullReplacer: object = {}
 // (If the same documents are computed, the MultiKeyWeakMap will return the same instance.)
 const documentsSelector = createSelector(
   [
-    ({documentStates}: SyncTransactionState) => documentStates,
-    (_state: SyncTransactionState, actions: DocumentAction | DocumentAction[]) => actions,
+    ({state: {documentStates}}: SelectorContext<SyncTransactionState>) => documentStates,
+    (_context: SelectorContext<SyncTransactionState>, actions: DocumentAction | DocumentAction[]) =>
+      actions,
   ],
   (documentStates, actions) => {
     const documentIds = new Set(
@@ -98,7 +100,8 @@ const documentsSelector = createSelector(
 const memoizedActionsSelector = createSelector(
   [
     documentsSelector,
-    (_state: SyncTransactionState, actions: DocumentAction | DocumentAction[]) => actions,
+    (_state: SelectorContext<SyncTransactionState>, actions: DocumentAction | DocumentAction[]) =>
+      actions,
   ],
   (documents, actions) => {
     if (!documents) return undefined
@@ -146,7 +149,11 @@ export type DocumentPermissionsResult =
 const enNarrowConjunction = new Intl.ListFormat('en', {style: 'narrow', type: 'conjunction'})
 
 export const calculatePermissions = createSelector(
-  [({grants}: SyncTransactionState) => grants, documentsSelector, memoizedActionsSelector],
+  [
+    ({state: {grants}}: SelectorContext<SyncTransactionState>) => grants,
+    documentsSelector,
+    memoizedActionsSelector,
+  ],
   (
     grants: Record<Grant, ExprNode> | undefined,
     documents: DocumentSet | undefined,

package/src/document/processActions.test.ts

@@ -149,6 +149,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.delete',
         },
       ]
@@ -184,6 +185,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.delete',
         },
       ]
@@ -215,6 +217,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.delete',
         },
       ]
@@ -233,6 +236,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.discard',
         },
       ]
@@ -261,6 +265,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.discard',
         },
       ]
@@ -279,6 +284,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.edit',
           patches: [{set: {title: 'Edited Title'}}],
         },
@@ -310,6 +316,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.edit',
           patches: [{set: {title: 'New Draft Title'}}],
         },
@@ -337,6 +344,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.edit',
           patches: [{set: {title: 'Original Cool Title'}}],
         },
@@ -365,6 +373,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.edit',
           patches: [{set: {title: 'Should Fail'}}],
         },
@@ -381,6 +390,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.edit',
           patches: [{set: {title: 'Edited Title'}}],
         },
@@ -398,6 +408,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.edit',
           patches: [{set: {title: 'New Title'}}],
         },
@@ -417,6 +428,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.publish',
         },
       ]
@@ -451,6 +463,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.publish',
         },
       ]
@@ -468,6 +481,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.publish',
         },
       ]
@@ -480,7 +494,9 @@ describe('processActions', () => {
       const draft = createDoc('drafts.doc1', 'Draft Title', '1')
       const base: DocumentSet = {'drafts.doc1': draft}
       const working: DocumentSet = {'drafts.doc1': draft}
-      const actions: DocumentAction[] = [{documentId: 'doc1', type: 'document.publish'}]
+      const actions: DocumentAction[] = [
+        {documentId: 'doc1', documentType: 'article', type: 'document.publish'},
+      ]
       const grants = {...defaultGrants, update: alwaysDeny}
       expect(() =>
         processActions({actions, transactionId, base, working, timestamp, grants}),
@@ -492,7 +508,9 @@ describe('processActions', () => {
       const published = createDoc('doc1', 'Published Title', '1')
       const base: DocumentSet = {'drafts.doc1': draft, 'doc1': published}
       const working: DocumentSet = {'drafts.doc1': draft, 'doc1': published}
-      const actions: DocumentAction[] = [{documentId: 'doc1', type: 'document.publish'}]
+      const actions: DocumentAction[] = [
+        {documentId: 'doc1', documentType: 'article', type: 'document.publish'},
+      ]
       const grants = {
         ...defaultGrants,
         update: parse(`$document {"_": _id in path("drafts.**")}._`),
@@ -509,7 +527,9 @@ describe('processActions', () => {
       // simulate case where there is no published version
       const base: DocumentSet = {'drafts.doc1': draft}
       const working: DocumentSet = {'drafts.doc1': draft}
-      const actions: DocumentAction[] = [{documentId: 'doc1', type: 'document.publish'}]
+      const actions: DocumentAction[] = [
+        {documentId: 'doc1', documentType: 'article', type: 'document.publish'},
+      ]
       const grants = {...defaultGrants, create: alwaysDeny}
       expect(() =>
         processActions({actions, transactionId, base, working, timestamp, grants}),
@@ -542,6 +562,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.publish',
         },
       ]
@@ -573,6 +594,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.unpublish',
         },
       ]
@@ -606,6 +628,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.unpublish',
         },
       ]
@@ -623,6 +646,7 @@ describe('processActions', () => {
       const actions: DocumentAction[] = [
         {
           documentId: 'doc1',
+          documentType: 'article',
           type: 'document.unpublish',
         },
       ]
@@ -654,7 +678,9 @@ describe('processActions', () => {
       const published = createDoc('doc1', 'Published Title')
       const base: DocumentSet = {doc1: published}
       const working: DocumentSet = {doc1: published}
-      const actions: DocumentAction[] = [{documentId: 'doc1', type: 'document.unpublish'}]
+      const actions: DocumentAction[] = [
+        {documentId: 'doc1', documentType: 'article', type: 'document.unpublish'},
+      ]
       const grants = {...defaultGrants, update: alwaysDeny}
       expect(() =>
         processActions({actions, transactionId, base, working, timestamp, grants}),
@@ -665,7 +691,9 @@ describe('processActions', () => {
       const published = createDoc('doc1', 'Published Title')
       const base: DocumentSet = {doc1: published}
       const working: DocumentSet = {doc1: published}
-      const actions: DocumentAction[] = [{documentId: 'doc1', type: 'document.unpublish'}]
+      const actions: DocumentAction[] = [
+        {documentId: 'doc1', documentType: 'article', type: 'document.unpublish'},
+      ]
       const grants = {...defaultGrants, create: alwaysDeny}
       expect(() =>
         processActions({actions, transactionId, base, working, timestamp, grants}),
@@ -679,9 +707,14 @@ describe('processActions', () => {
       const base: DocumentSet = {doc1: published}
       const working: DocumentSet = {doc1: published}
       const actions: DocumentAction[] = [
-        {documentId: 'doc1', type: 'document.create', documentType: 'article'},
-        {documentId: 'doc1', type: 'document.edit', patches: [{set: {title: 'Edited Title'}}]},
-        {documentId: 'doc1', type: 'document.publish'},
+        {documentId: 'doc1', documentType: 'article', type: 'document.create'},
+        {
+          documentId: 'doc1',
+          documentType: 'article',
+          type: 'document.edit',
+          patches: [{set: {title: 'Edited Title'}}],
+        },
+        {documentId: 'doc1', documentType: 'article', type: 'document.publish'},
       ]
       const result = processActions({
         actions,