feat!: rename useActions → useDocumentActions and useActions → useDocumentActions (#362)

Author: ryanbonial

apps/kitchensink-react/src/DocumentCollection/DocumentEditorRoute.tsx

@@ -10,7 +10,7 @@ import {
   unpublishDocument,
 } from '@sanity/sdk'
 import {
-  useApplyActions,
+  useApplyDocumentActions,
   useDocument,
   useDocumentEvent,
   useDocumentSyncStatus,
@@ -36,7 +36,7 @@ const doc: DocumentHandle<Author> = {
 function Editor() {
   useDocumentEvent((e) => console.log(e), doc)
   const synced = useDocumentSyncStatus(doc)
-  const apply = useApplyActions()
+  const apply = useApplyDocumentActions()
 
   const canEdit = usePermissions(editDocument(doc))
   const canCreate = usePermissions(createDocument(doc))

packages/core/src/_exports/index.ts

@@ -52,7 +52,11 @@ export {
   unpublishDocument,
   type UnpublishDocumentAction,
 } from '../document/actions'
-export {type ActionsResult, applyActions, type ApplyActionsOptions} from '../document/applyActions'
+export {
+  type ActionsResult,
+  applyDocumentActions,
+  type ApplyDocumentActionsOptions,
+} from '../document/applyDocumentActions'
 export {
   getDocumentState,
   getDocumentSyncStatus,

packages/core/src/document/applyActions.test.ts renamed to packages/core/src/document/applyDocumentActions.test.ts

@@ -1,4 +1,4 @@
-// applyActions.test.ts
+// applyDocumentActions.test.ts
 import {type SanityDocument} from '@sanity/types'
 import {Subject} from 'rxjs'
 import {describe, expect, it} from 'vitest'
@@ -7,7 +7,7 @@ import {createSanityInstance} from '../instance/sanityInstance'
 import {type ActionContext} from '../resources/createAction'
 import {createResourceState} from '../resources/createResource'
 import {type DocumentAction} from './actions'
-import {applyActions} from './applyActions'
+import {applyDocumentActions} from './applyDocumentActions'
 import {type DocumentStoreState} from './documentStore'
 import {type DocumentEvent} from './events'
 import {type AppliedTransaction, type OutgoingTransaction} from './reducers'
@@ -25,7 +25,7 @@ const exampleDoc: SanityDocument = {
   _rev: 'txn0',
 }
 
-describe('applyActions', () => {
+describe('applyDocumentActions', () => {
   it('resolves with a successful applied transaction and accepted event', async () => {
     const eventsSubject = new Subject<DocumentEvent>()
     const initialState: TestState = {
@@ -46,10 +46,14 @@ describe('applyActions', () => {
       patches: [{set: {foo: 'bar'}}],
     }
 
-    // Call applyActions with a fixed transactionId for reproducibility.
-    const applyPromise = applyActions(context as ActionContext<DocumentStoreState>, action, {
-      transactionId: 'txn-success',
-    })
+    // Call applyDocumentActions with a fixed transactionId for reproducibility.
+    const applyPromise = applyDocumentActions(
+      context as ActionContext<DocumentStoreState>,
+      action,
+      {
+        transactionId: 'txn-success',
+      },
+    )
 
     const appliedTx: AppliedTransaction = {
       transactionId: 'txn-success',
@@ -67,7 +71,7 @@ describe('applyActions', () => {
     // Update the state so that its "applied" array contains our applied transaction.
     state.set('simulateApplied', {applied: [appliedTx]})
 
-    // Await the resolution of applyActions. This should pick up the applied transaction.
+    // Await the resolution of applyDocumentActions. This should pick up the applied transaction.
     const result = await applyPromise
 
     // Check that the result fields match the simulated applied transaction.
@@ -114,10 +118,14 @@ describe('applyActions', () => {
       patches: [{set: {foo: 'error'}}],
     }
 
-    // Call applyActions with a fixed transactionId.
-    const applyPromise = applyActions(context as ActionContext<DocumentStoreState>, action, {
-      transactionId: 'txn-error',
-    })
+    // Call applyDocumentActions with a fixed transactionId.
+    const applyPromise = applyDocumentActions(
+      context as ActionContext<DocumentStoreState>,
+      action,
+      {
+        transactionId: 'txn-error',
+      },
+    )
 
     const errorEvent: DocumentEvent = {
       type: 'error',

packages/core/src/document/applyActions.ts renamed to packages/core/src/document/applyDocumentActions.ts

@@ -22,7 +22,7 @@ export interface ActionsResult<TDocument extends SanityDocument = SanityDocument
 }
 
 /** @beta */
-export interface ApplyActionsOptions {
+export interface ApplyDocumentActionsOptions {
   /**
    * Optionally provide an ID to be used as this transaction ID
    */
@@ -34,30 +34,30 @@ export interface ApplyActionsOptions {
 }
 
 /** @beta */
-export function applyActions<TDocument extends SanityDocument>(
+export function applyDocumentActions<TDocument extends SanityDocument>(
   instance: SanityInstance | ActionContext<DocumentStoreState>,
   action: DocumentAction<TDocument> | DocumentAction<TDocument>[],
-  options?: ApplyActionsOptions,
+  options?: ApplyDocumentActionsOptions,
 ): Promise<ActionsResult<TDocument>>
 /** @beta */
-export function applyActions(
+export function applyDocumentActions(
   instance: SanityInstance | ActionContext<DocumentStoreState>,
   action: DocumentAction | DocumentAction[],
-  options?: ApplyActionsOptions,
+  options?: ApplyDocumentActionsOptions,
 ): Promise<ActionsResult>
 /** @beta */
-export function applyActions(
-  ...args: Parameters<typeof _applyActions>
-): ReturnType<typeof _applyActions> {
-  return _applyActions(...args)
+export function applyDocumentActions(
+  ...args: Parameters<typeof _applyDocumentActions>
+): ReturnType<typeof _applyDocumentActions> {
+  return _applyDocumentActions(...args)
 }
 
-const _applyActions = createAction(documentStore, ({state}) => {
+const _applyDocumentActions = createAction(documentStore, ({state}) => {
   const {events} = state.get()
 
   return async function (
     action: DocumentAction | DocumentAction[],
-    {transactionId = crypto.randomUUID(), disableBatching}: ApplyActionsOptions = {},
+    {transactionId = crypto.randomUUID(), disableBatching}: ApplyDocumentActionsOptions = {},
   ): Promise<ActionsResult> {
     const actions = Array.isArray(action) ? action : [action]