chore: rename returning types from withViewModel, withLazyViewModel hocs

Author: js2me

.changeset/hip-lemons-happen.md

@@ -0,0 +1,5 @@
+---
+"mobx-view-model": patch
+---
+
+rename ComponentWithLazyViewModel -> VMLazyComponent

.changeset/tangy-mugs-shake.md

@@ -0,0 +1,5 @@
+---
+"mobx-view-model": patch
+---
+
+rename type ComponentWithViewModel -> VMComponent

docs/react/api/with-lazy-view-model.md

@@ -14,7 +14,7 @@ function withLazyViewModel<TViewModel extends AnyViewModel>(
     Component: TView | Promised<TView>
   }>,
   config?: ViewModelHocConfig<TViewModel>
-): ComponentWithLazyViewModel
+): VMLazyComponent
 ```
 
 

docs/react/api/with-view-model.md

@@ -9,7 +9,7 @@ function withViewModel<VM extends AnyViewModel>(
   config?: ViewModelHocConfig<VM>
 ):
   (Component: ComponentType<ComponentProps & ViewModelProps<VM>>) =>
-    ComponentWithViewModel
+    VMComponent
 
 function withViewModel<
   TViewModel extends AnyViewModel,
@@ -18,7 +18,7 @@ function withViewModel<
   model: Class<TViewModel>,
   component: ComponentType<TCompProps & ViewModelProps<TViewModel>>,
   config?: ViewModelHocConfig<TViewModel>,
-): ComponentWithViewModel<TViewModel, TCompProps>;
+): VMComponent<TViewModel, TCompProps>;
 ```
 
 ##  Usage  

src/hoc/with-lazy-view-model.tsx

@@ -7,7 +7,7 @@ import { Class, Maybe, MaybePromise } from '../utils/types.js';
 import { AnyViewModel } from '../view-model/index.js';
 
 import {
-  ComponentWithViewModel,
+  VMComponent,
   ViewModelHocConfig,
   withViewModel,
 } from './with-view-model.js';
@@ -20,10 +20,18 @@ export interface LazyViewAndModel<
   View?: TView | PackedAsyncModule<TView>;
 }
 
+export type VMLazyComponent<
+  TViewModel extends AnyViewModel,
+  TView extends ComponentType<any>,
+> = VMComponent<TViewModel, ComponentProps<TView>> & LoadableMixin;
+
+/**
+ * @deprecated use `VMLazyComponent` instead. Will be removed in next major release
+ */
 export type ComponentWithLazyViewModel<
   TViewModel extends AnyViewModel,
   TView extends ComponentType<any>,
-> = ComponentWithViewModel<TViewModel, ComponentProps<TView>> & LoadableMixin;
+> = VMLazyComponent<TViewModel, ComponentProps<TView>> & LoadableMixin;
 
 export interface LazyViewModelHocConfig<TViewModel extends AnyViewModel>
   extends ViewModelHocConfig<TViewModel>,
@@ -42,7 +50,7 @@ export function withLazyViewModel<
   configOrFallbackComponent?:
     | LazyViewModelHocConfig<NoInfer<TViewModel>>
     | LoadableConfig['loading'],
-): ComponentWithLazyViewModel<TViewModel, TView> {
+): VMLazyComponent<TViewModel, TView> {
   const config: Maybe<LazyViewModelHocConfig<NoInfer<TViewModel>>> =
     typeof configOrFallbackComponent === 'function'
       ? {
@@ -76,7 +84,7 @@ export function withLazyViewModel<
       preload: patchedConfig?.preload,
       throwOnError: patchedConfig?.throwOnError,
     },
-  ) as ComponentWithLazyViewModel<TViewModel, TView>;
+  ) as VMLazyComponent<TViewModel, TView>;
 
   patchedConfig.ctx!.externalComponent = lazyVM;
 

src/hoc/with-view-model.tsx

@@ -68,12 +68,23 @@ export interface ViewModelHocConfig<VM extends AnyViewModel>
   getPayload?: (allProps: any) => any;
 }
 
+export type VMComponentProps<
+  TViewModel extends AnyViewModel,
+  TComponentOriginProps extends AnyObject,
+> = Omit<TComponentOriginProps, 'model'> & ViewModelInputProps<TViewModel>;
+
+export type VMComponent<
+  TViewModel extends AnyViewModel,
+  TComponentOriginProps extends AnyObject = ViewModelProps<TViewModel>,
+> = (props: VMComponentProps<TViewModel, TComponentOriginProps>) => ReactNode;
+
+/**
+ * @deprecated use `VMComponent` type. Will be removed in next major release.
+ */
 export type ComponentWithViewModel<
   TViewModel extends AnyViewModel,
   TComponentOriginProps extends AnyObject = ViewModelProps<TViewModel>,
-> = (
-  props: Omit<TComponentOriginProps, 'model'> & ViewModelInputProps<TViewModel>,
-) => ReactNode;
+> = VMComponent<TViewModel, TComponentOriginProps>;
 
 /**
  * A Higher-Order Component that connects React components to their ViewModels, providing seamless MobX integration.
@@ -87,7 +98,7 @@ export function withViewModel<
   model: Class<TViewModel>,
   component: ComponentType<TComponentOriginProps & ViewModelProps<TViewModel>>,
   config?: ViewModelHocConfig<TViewModel>,
-): ComponentWithViewModel<TViewModel, TComponentOriginProps>;
+): VMComponent<TViewModel, TComponentOriginProps>;
 
 /**
  * A Higher-Order Component that connects React components to their ViewModels, providing seamless MobX integration.
@@ -99,7 +110,7 @@ export function withViewModel<TViewModel extends AnyViewModel>(
   config?: ViewModelHocConfig<TViewModel>,
 ): <TComponentOriginProps extends AnyObject = ViewModelProps<TViewModel>>(
   Component?: ComponentType<TComponentOriginProps & ViewModelProps<TViewModel>>,
-) => ComponentWithViewModel<TViewModel, TComponentOriginProps>;
+) => VMComponent<TViewModel, TComponentOriginProps>;
 
 /**
  * Creates new instance of ViewModel

src/view-model/view-model.store.base.ts

@@ -5,10 +5,7 @@ import {
   mergeVMConfigs,
   applyObservable,
 } from '../config/index.js';
-import {
-  ComponentWithLazyViewModel,
-  ComponentWithViewModel,
-} from '../hoc/index.js';
+import { VMLazyComponent, VMComponent } from '../hoc/index.js';
 import { generateVmId } from '../utils/index.js';
 import { Class, Maybe } from '../utils/types.js';
 
@@ -31,7 +28,7 @@ export class ViewModelStoreBase<VMBase extends AnyViewModel = AnyViewModel>
 {
   protected viewModels: Map<string, VMBase | AnyViewModelSimple>;
   protected linkedComponentVMClasses: Map<
-    ComponentWithViewModel<VMBase, any>,
+    VMComponent<VMBase, any>,
     Class<VMBase>
   >;
   protected viewModelIdsByClasses: Map<
@@ -133,8 +130,7 @@ export class ViewModelStoreBase<VMBase extends AnyViewModel = AnyViewModel>
   linkComponents(
     VM: Class<VMBase>,
     ...components: Maybe<
-      | ComponentWithViewModel<VMBase, any>
-      | ComponentWithLazyViewModel<VMBase, any>
+      VMComponent<VMBase, any> | VMLazyComponent<VMBase, any>
     >[]
   ): void {
     components.forEach((component) => {
@@ -146,8 +142,7 @@ export class ViewModelStoreBase<VMBase extends AnyViewModel = AnyViewModel>
 
   unlinkComponents(
     ...components: Maybe<
-      | ComponentWithViewModel<VMBase, any>
-      | ComponentWithLazyViewModel<VMBase, any>
+      VMComponent<VMBase, any> | VMLazyComponent<VMBase, any>
     >[]
   ): void {
     components.forEach((component) => {

src/view-model/view-model.store.ts

@@ -1,7 +1,4 @@
-import {
-  ComponentWithLazyViewModel,
-  ComponentWithViewModel,
-} from '../hoc/index.js';
+import { VMLazyComponent, VMComponent } from '../hoc/index.js';
 import { Class, Maybe } from '../utils/types.js';
 
 import { ViewModelSimple } from './view-model-simple.js';
@@ -112,8 +109,7 @@ export interface ViewModelStore<VMBase extends AnyViewModel = AnyViewModel> {
   linkComponents(
     VM: Class<VMBase>,
     ...components: Maybe<
-      | ComponentWithViewModel<VMBase, any>
-      | ComponentWithLazyViewModel<VMBase, any>
+      VMComponent<VMBase, any> | VMLazyComponent<VMBase, any>
     >[]
   ): void;
 
@@ -123,8 +119,7 @@ export interface ViewModelStore<VMBase extends AnyViewModel = AnyViewModel> {
    */
   unlinkComponents(
     ...components: Maybe<
-      | ComponentWithViewModel<VMBase, any>
-      | ComponentWithLazyViewModel<VMBase, any>
+      VMComponent<VMBase, any> | VMLazyComponent<VMBase, any>
     >[]
   ): void;
 

src/view-model/view-model.store.types.ts

@@ -1,10 +1,7 @@
 import { ComponentType } from 'react';
 
 import { ViewModelsRawConfig } from '../config/index.js';
-import {
-  ComponentWithLazyViewModel,
-  ComponentWithViewModel,
-} from '../hoc/index.js';
+import { VMLazyComponent, VMComponent } from '../hoc/index.js';
 import { AnyObject, Class, Maybe } from '../utils/types.js';
 
 import {
@@ -32,7 +29,7 @@ export interface ViewModelCreateConfig<VM extends AnyViewModel>
   extends ViewModelParams<VM['payload'], VM['parentViewModel']> {
   VM: Class<VM>;
   fallback?: ComponentType;
-  component?: ComponentWithViewModel<AnyViewModel, any>;
+  component?: VMComponent<AnyViewModel, any>;
   componentProps?: AnyObject;
 }
 
@@ -43,5 +40,5 @@ export type ViewModelLookup<T extends AnyViewModel | AnyViewModelSimple> =
   | AnyViewModel['id']
   | Class<T>
   | (T extends AnyViewModel
-      ? ComponentWithViewModel<T, any> | ComponentWithLazyViewModel<T, any>
+      ? VMComponent<T, any> | VMLazyComponent<T, any>
       : Class<T>);