refactor(core): changed mutation hook name and improved destroyed stores

core/src/constants.ts

@@ -11,6 +11,7 @@ export const EVENTS = {
     mutation: {
         before: 'mutation:before',
         after: 'mutation:after',
+        success: 'mutation:success',
         error: 'mutation:error',
     },
     devtools: {

core/src/index.ts

@@ -140,6 +140,7 @@ export function createStore<TState extends BaseState, TExtensions extends Extens
 
     const onBeforeMutation = getMutationHook(EVENTS.mutation.before);
     const onAfterMutation = getMutationHook(EVENTS.mutation.after);
+    const onMutationSuccess = getMutationHook(EVENTS.mutation.success);
     const onMutationError = getMutationHook(EVENTS.mutation.error);
 
     const extendedStore = getExtendedStore<TState, TExtensions>(store, extensions);
@@ -151,6 +152,7 @@ export function createStore<TState extends BaseState, TExtensions extends Extens
         destroy,
         onBeforeMutation,
         onAfterMutation,
+        onMutationSuccess,
         onMutationError,
         state: store.state,
         getter: store.getter.bind(store),

core/src/store.ts

@@ -35,6 +35,8 @@ import type {
     StoreProviders,
     StoreRegistrations,
     RegistrationValueProducer,
+    RegistrationType,
+    StoreRegistration,
 } from './types';
 
 function localiseHandler(name: string, handler: EventHandler): EventHandler {
@@ -99,6 +101,10 @@ export default class Store<TState extends BaseState = any> implements InternalSt
     }
 
     public emit(event: string, sender: string, data: any): void {
+        if (!this.scope.active) {
+            return;
+        }
+
         const payload: EventPayload = {
             data,
             sender,
@@ -124,24 +130,27 @@ export default class Store<TState extends BaseState = any> implements InternalSt
         return this.scope.run(callback)!;
     }
 
-    public hasRegistration(type: string, name: string): boolean {
-        return !!this.registrations[type]?.has(name);
+    public hasRegistration(group: string, name: string): boolean {
+        return !!this.registrations[group]?.has(name);
     }
 
-    public getRegistration(type: string, name: string): RegistrationValueProducer | undefined {
-        return this.registrations[type]?.get(name);
+    public getRegistration(group: string, name: string): StoreRegistration | undefined {
+        return this.registrations[group]?.get(name);
     }
 
-    public register(type: string, name: string, valueProducer: RegistrationValueProducer): void {
-        if (!(type in this.registrations)) {
-            this.registrations[type] = new Map();
+    public register(group: string, name: string, producer: RegistrationValueProducer, type: RegistrationType = 'other'): void {
+        if (!(group in this.registrations)) {
+            this.registrations[group] = new Map();
         }
 
-        this.registrations[type].set(name, valueProducer);
+        this.registrations[group].set(name, {
+            type,
+            producer,
+        });
     }
 
-    public unregister(type: string, name: string): void {
-        this.registrations[type]?.delete(name);
+    public unregister(group: string, name: string): void {
+        this.registrations[group]?.delete(name);
     }
 
     public getter<TResult>(name: string, getter: Getter<TState, TResult>): ComputedRef<TResult> {
@@ -151,22 +160,31 @@ export default class Store<TState extends BaseState = any> implements InternalSt
 
         const output = this.track(() => computed(() => getter(this.state)));
 
-        this.register('getters', name, () => output.value);
+        this.register('getters', name, () => output.value, 'computed');
 
         return output;
     }
 
     private mutate<TPayload, TResult = void>(name: string, sender: string, mutator: Mutator<TState, TPayload, TResult>, payload: TPayload): TResult {
+        if (!this.scope.active) {
+            throw new Error('The current store has been destroyed. Mutations can no longer take place.');
+        }
+
         if (this.stack.has(name)) {
             throw new Error('Circular mutation reference detected. Avoid calling mutations inside other mutations to prevent circular references.');
         }
 
+        let result: TResult;
+
         const eventData: MutationEventData<TPayload, TResult> = {
             payload,
             mutation: name,
         };
 
-        let result: TResult;
+        const emitComplete = (event: string) => this.emit(event, sender, {
+            ...eventData,
+            result,
+        });
 
         this.stack.add(name);
         this.emit(EVENTS.mutation.before, sender, eventData);
@@ -181,12 +199,10 @@ export default class Store<TState extends BaseState = any> implements InternalSt
             throw error;
         } finally {
             this.stack.delete(name);
+            emitComplete(EVENTS.mutation.after);
         }
 
-        this.emit(EVENTS.mutation.after, sender, {
-            ...eventData,
-            result,
-        });
+        emitComplete(EVENTS.mutation.success);
 
         return result;
     }
@@ -205,16 +221,6 @@ export default class Store<TState extends BaseState = any> implements InternalSt
         return mutation;
     }
 
-    public exec<TResult = void>(name: string, payload?: any): TResult {
-        const mutation = this.getRegistration('mutations', name) as Mutation<any, TResult>;
-
-        if (!mutation) {
-            throw new Error(`No mutation found for ${name}`);
-        }
-
-        return mutation(payload);
-    }
-
     public write<TResult = void>(name: string, sender: string, mutator: Mutator<TState, undefined, TResult>): TResult {
         return this.mutate(name, sender, mutator, undefined);
     }

core/src/types.ts

@@ -10,6 +10,8 @@ export type BaseState = object;
 export type StoreProvider<TState extends BaseState> = keyof StoreProviders<TState>;
 export type ReadState<TState extends BaseState> = DeepReadonly<TState>;
 export type WriteState<TState extends BaseState> = TState;
+export type RegistrationType = 'ref' | 'reactive' | 'computed' | 'other';
+export type RegistrationValueProducer = () => unknown;
 export type Getter<TState extends BaseState, TResult> = (state: ReadState<TState>) => TResult;
 export type Mutator<TState extends BaseState, TPayload, TResult = void> = (state: WriteState<TState>, payload: TPayload) => TResult;
 export type Mutation<TPayload, TResult = void> = undefined extends TPayload ? (payload?: TPayload) => TResult : (payload: TPayload) => TResult;
@@ -59,14 +61,13 @@ export interface InternalStore<TState extends BaseState = any> extends StoreBase
     readonly state: ReadState<TState>;
     name: string;
     registrations: StoreRegistrations;
-    hasRegistration(type: string, name: string): boolean;
-    getRegistration(type: string, name: string): RegistrationValueProducer | undefined;
-    register(type: string, name: string, valueProducer: RegistrationValueProducer): void;
-    unregister(type: string, name: string): void;
+    hasRegistration(group: string, name: string): boolean;
+    getRegistration(group: string, name: string): StoreRegistration | undefined;
+    register(group: string, name: string, valueProducer: RegistrationValueProducer, type?: RegistrationType): void;
+    unregister(group: string, name: string): void;
     emit(event: string, sender: string, data: any): void;
     on(event: string, handler: EventHandler): EventListener;
     once(event: string, handler: EventHandler): EventListener
-    exec<TResult = void>(name: string, payload?: any): TResult;
     track<TResult>(callback: () => TResult): TResult;
     provider<TKey extends StoreProvider<TState>>(key: TKey, value: StoreProviders<TState>[TKey]): void;
     write<TResult = void>(name: string, sender: string, mutator: Mutator<TState, undefined, TResult>): TResult;
@@ -89,6 +90,7 @@ export interface Store<TState extends BaseState> extends StoreBase<TState> {
     destroy(): void;
     onBeforeMutation<TPayload = any, TResult = any>(mutationName: string | string[], handler: MutationHookHandler<TPayload, TResult>): EventListener;
     onAfterMutation<TPayload = any, TResult = any>(mutationName: string | string[], handler: MutationHookHandler<TPayload, TResult>): EventListener;
+    onMutationSuccess<TPayload = any, TResult = any>(mutationName: string | string[], handler: MutationHookHandler<TPayload, TResult>): EventListener;
     onMutationError<TPayload = any, TResult = any>(mutationName: string | string[], handler: MutationHookHandler<TPayload, TResult>): EventListener;
 }
 
@@ -101,10 +103,13 @@ export interface PluginOptions {
     plugins?: HarlemPlugin[];
 }
 
-export type RegistrationValueProducer = () => unknown;
+export interface StoreRegistration {
+    type: RegistrationType;
+    producer: RegistrationValueProducer;
+}
 
 export interface StoreRegistrations {
-    [key: string]: Map<string, RegistrationValueProducer>;
-    getters: Map<string, RegistrationValueProducer>;
-    mutations: Map<string, RegistrationValueProducer>;
+    [key: string]: Map<string, StoreRegistration>;
+    getters: Map<string, StoreRegistration>;
+    mutations: Map<string, StoreRegistration>;
 }