feat: record module mutations in the mutation history

This will be useful in the future for mutation replay/sync engines

Author: Akryum

packages/core/src/module.ts

@@ -45,10 +45,16 @@ export function createModule<
     $callbacks.push(cb)
   }
 
+  /**
+   * Allow looking up the exposed mutations.
+   */
+  let _exposed: Record<string, any> = {}
+
   return {
     ...module,
     state,
     resolve(exposed: any) {
+      _exposed = exposed
       const resolved: ResolvedModule<any, any> & {
         $callbacks: ResolveCallbacks
       } = {
@@ -66,6 +72,20 @@ export function createModule<
     },
     onResolve,
     defineMutation(mutation) {
+      let key: string | undefined
+      const originalMutation = mutation
+      mutation = ((...args: Parameters<typeof mutation>) => {
+        if (!key) {
+          key = Object.keys(_exposed).find(k => _exposed[k] === mutation)
+        }
+        store.$mutationHistory.push({
+          operation: 'module-mutation',
+          module: module.name,
+          key: key!,
+          payload: args,
+        })
+        return originalMutation(...args)
+      }) as typeof mutation
       mutation = store.$wrapMutation(mutation)
       ;(mutation as any).__brand = 'rstore-module-mutation'
       return mutation as ModuleMutation<typeof mutation>

packages/shared/src/types/module.ts

@@ -1,5 +1,3 @@
-/* eslint-disable ts/no-unsafe-function-type */
-
 import type { MutationSpecialProps } from './mutation'
 import type { Awaitable, Brand } from './utils'
 
@@ -18,10 +16,10 @@ export type ResolvedModule<
   $state: ResolvedModuleState<TModule>
 }
 
-export type ModuleMutation<TMutation extends Function> = Brand<TMutation, 'rstore-module-mutation'> & MutationSpecialProps
+export type ModuleMutation<TMutation extends (...args: any[]) => unknown> = Brand<TMutation, 'rstore-module-mutation'> & MutationSpecialProps
 
 export type CreateModuleApi<TModule extends Module> = TModule & {
   resolve: <const TModuleExposed extends Record<string, any>> (exposed: TModuleExposed) => ResolvedModule<TModule, TModuleExposed>
-  defineMutation: <const TMutation extends Function> (mutation: TMutation) => ModuleMutation<TMutation>
+  defineMutation: <const TMutation extends (...args: any[]) => unknown> (mutation: TMutation) => ModuleMutation<TMutation>
   onResolve: (cb: () => Awaitable<unknown>) => void
 }

packages/shared/src/types/mutation.ts

@@ -6,8 +6,12 @@ export interface MutationOperation<
   TModelDefaults extends ModelDefaults,
   TModelList extends ModelList,
 > {
-  operation: 'create' | 'update' | 'delete'
-  model: ResolvedModel<TModel, TModelDefaults, TModelList>
+  operation: 'create' | 'update' | 'delete' | 'module-mutation'
+  model?: ResolvedModel<TModel, TModelDefaults, TModelList>
+  module?: string
+  /**
+   * Either the key of the item in the model or the key of the exposed mutation in the module.
+   */
   key?: string | number
   payload?: Partial<ResolvedModelItem<TModel, TModelDefaults, TModelList>>
 }