feat: add hooks property for viewModelsConfig

Author: js2me

.changeset/silly-badgers-begin.md

@@ -0,0 +1,5 @@
+---
+"mobx-view-model": minor
+---
+
+added `hooks` parameter for `viewModelsConfig`

package.json

@@ -51,7 +51,7 @@
   },
   "dependencies": {
     "react-simple-loadable": "^2.3.9",
-    "yummies": "^6.0.0"
+    "yummies": "^6.1.1"
   },
   "peerDependencies": {
     "mobx": "^6.12.4",

pnpm-lock.yaml

@@ -1,35 +1,42 @@
-import { createGlobalConfig } from 'yummies/complex';
+import { createGlobalConfig, createPubSub } from 'yummies/complex';
 import { generateVmId } from '../utils/generate-vm-id.js';
+import type { ViewModelStore } from '../view-model/view-model.store.js';
 import type { ViewModelsConfig } from './types.js';
 import { mergeVMConfigs } from './utils/merge-vm-configs.js';
 
 /**
  * Global configuration options for view models
  */
-export const viewModelsConfig = createGlobalConfig<ViewModelsConfig>({
-  comparePayload: false,
-  payloadComputed: 'struct',
-  payloadObservable: 'ref',
-  wrapViewsInObserver: true,
-  startViewTransitions: {
-    mount: false,
-    payloadChange: false,
-    unmount: false,
-  },
-  observable: {
-    viewModels: {
-      useDecorators: true,
+export const viewModelsConfig = createGlobalConfig<ViewModelsConfig>(
+  {
+    comparePayload: false,
+    payloadComputed: 'struct',
+    payloadObservable: 'ref',
+    wrapViewsInObserver: true,
+    startViewTransitions: {
+      mount: false,
+      payloadChange: false,
+      unmount: false,
     },
-    viewModelStores: {
-      useDecorators: true,
+    observable: {
+      viewModels: {
+        useDecorators: true,
+      },
+      viewModelStores: {
+        useDecorators: true,
+      },
+    },
+    generateId: generateVmId,
+    factory: (config) => {
+      const VM = config.VM;
+      return new VM({
+        ...config,
+        vmConfig: mergeVMConfigs(config.vmConfig),
+      });
+    },
+    hooks: {
+      storeCreate: createPubSub<[ViewModelStore]>(),
     },
   },
-  generateId: generateVmId,
-  factory: (config) => {
-    const VM = config.VM;
-    return new VM({
-      ...config,
-      vmConfig: mergeVMConfigs(config.vmConfig),
-    });
-  },
-});
+  Symbol.for('VIEW_MODELS_CONFIG'),
+);

src/config/global-config.ts

@@ -1,12 +1,12 @@
+import type { PubSub } from 'yummies/complex';
 import type { AnyObject, Class, DeepPartial, Maybe } from 'yummies/types';
-
 import type { ViewModelHocConfig } from '../hoc/with-view-model.js';
 import type {
   AnyViewModel,
   PayloadCompareFn,
   ViewModelCreateConfig,
+  ViewModelStore,
 } from '../view-model/index.js';
-
 import type { ObservableAnnotationsArray } from './utils/apply-observable.js';
 
 export interface ViewModelObservableConfig {
@@ -37,7 +37,9 @@ export type CreateViewModelFactoryFn<
  * Configuration options for view models.
  * [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config)
  */
-export interface ViewModelsConfig<VM extends AnyViewModel = AnyViewModel> {
+export interface ViewModelsConfig<
+  TViewModel extends AnyViewModel = AnyViewModel,
+> {
   /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config#startviewtransitions) */
   startViewTransitions: {
     mount: boolean;
@@ -53,17 +55,22 @@ export interface ViewModelsConfig<VM extends AnyViewModel = AnyViewModel> {
   /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config#generateid) */
   generateId: GenerateViewModelIdFn;
   /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config#factory) */
-  factory: CreateViewModelFactoryFn<VM>;
+  factory: CreateViewModelFactoryFn<TViewModel>;
   /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config#fallbackcomponent) */
   fallbackComponent?: React.ComponentType;
   /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config#onmount) */
-  onMount?: (viewModel: VM) => void;
+  onMount?: (viewModel: TViewModel) => void;
   /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config#onunmount) */
-  onUnmount?: (viewModel: VM) => void;
+  onUnmount?: (viewModel: TViewModel) => void;
   /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config#processviewcomponent) */
+  readonly hooks: {
+    readonly storeCreate: PubSub<
+      [viewModelStore: ViewModelStore<AnyViewModel>]
+    >;
+  };
   processViewComponent?: (
     component: React.ComponentType<any> | undefined,
-    VM: Class<VM>,
+    VM: Class<TViewModel>,
     config: ViewModelHocConfig<any>,
   ) => Maybe<React.ComponentType<any>>;
   /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config#wrapviewsinobserver) */
@@ -78,9 +85,11 @@ export interface ViewModelsConfig<VM extends AnyViewModel = AnyViewModel> {
 /**
  * [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/view-models-config)
  */
-export type ViewModelsRawConfig = Omit<
-  ViewModelsConfig,
-  'startViewTransitions' | 'observable' | 'factory' | 'generateId'
+export type ViewModelsRawConfig<
+  TViewModel extends AnyViewModel = AnyViewModel,
+> = Omit<
+  ViewModelsConfig<TViewModel>,
+  'startViewTransitions' | 'observable' | 'factory' | 'generateId' | 'hooks'
 > & {
   startViewTransitions?:
     | DeepPartial<ViewModelsConfig['startViewTransitions']>

src/config/types.ts

@@ -76,6 +76,8 @@ export class ViewModelStoreBase<VMBase extends AnyViewModel = AnyViewModel>
       ],
       this.vmConfig.observable.viewModelStores,
     );
+
+    this.vmConfig.hooks.storeCreate(this as ViewModelStore);
   }
 
   get mountedViewsCount() {