BREAKING: use mobx-view-model package; BREAKING: rename PageViewModel…

…Impl -> PageViewModelBase (deprecation)
js2me · Feb 8, 2025 · 7cb3256 · 7cb3256
1 parent 913b2a7
commit 7cb3256
Show file tree

Hide file tree

Showing 13 changed files with 58 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -20,16 +20,16 @@ _**MobX** integration with **Wouter**_
 
 ## What package has   
 
-### [`PageViewModelImpl`](src/page-view-model/page-view-model.impl.ts), [`PageViewModel`](src/page-view-model/page-view-model.ts)   
+### [`PageViewModelBase`](src/page-view-model/page-view-model.base.ts), [`PageViewModel`](src/page-view-model/page-view-model.ts)   
 
-Simple [`ViewModel`](https://github.com/js2me/mobx-vm-entities?tab=readme-ov-file#mobx-view-model) wrapper for pages  
+Simple [`ViewModel`](https://github.com/js2me/mobx-view-model?tab=readme-ov-file#mobx-view-model) wrapper for pages  
 
 #### Usage:  
 
 ```ts
-import { PageViewModelImpl } from 'mobx-wouter';
+import { PageViewModelBase } from 'mobx-wouter';
 
-class HomePageVM extends PageViewModelImpl<{ pathParam: string }> {
+class HomePageVM extends PageViewModelBase<{ pathParam: string }> {
   @observable
   accessor value = 'value';
 
@@ -49,7 +49,7 @@ HOC for integration `PageViewModel` with view component of **React**
 #### Usage:  
 
 ```tsx
-import { ViewModelProps } from 'mobx-vm-entities';  
+import { ViewModelProps } from 'mobx-view-model';  
 import { withPageViewModel } from 'mobx-wouter';
 
 const HomePageView = observer(({ model }: ViewModelProps<HomePageVM>) => {

diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
   "peerDependencies": {
     "mobx": "^6.12.4",
     "mobx-react-lite": "^4.0.7",
-    "mobx-vm-entities": "^5.1.4",
+    "mobx-view-model": "^5.2.5",
     "react": "^18.3.1",
     "wouter": "^3.3.5"
   },

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/hoc/with-lazy-page-view-model.test.tsx b/src/hoc/with-lazy-page-view-model.test.tsx
@@ -1,8 +1,8 @@
 import { act, render, screen } from '@testing-library/react';
-import { createCounter } from 'mobx-vm-entities/utils/counter';
+import { createCounter } from 'mobx-view-model/utils/counter';
 import { describe, expect, test } from 'vitest';
 
-import { PageViewModelMock } from '../page-view-model/page-view-model.impl.test';
+import { PageViewModelBaseMock } from '../page-view-model/page-view-model.base.test';
 
 import { withLazyPageViewModel } from './with-lazy-page-view-model';
 import { PageViewModelProps } from './with-page-view-model';
@@ -14,7 +14,7 @@ const createIdGenerator = (prefix?: string) => {
 
 describe('withLazyPageViewModel', () => {
   test('renders (required path param)', async () => {
-    class VM extends PageViewModelMock<{ foo: string }> {
+    class VM extends PageViewModelBaseMock<{ foo: string }> {
       mount() {
         super.mount();
       }
@@ -38,7 +38,7 @@ describe('withLazyPageViewModel', () => {
     expect(screen.getByText('hello VM_0')).toBeDefined();
   });
   test('renders (optional path param)', async () => {
-    class VM extends PageViewModelMock<{ foo?: string }> {
+    class VM extends PageViewModelBaseMock<{ foo?: string }> {
       mount() {
         super.mount();
       }
@@ -62,7 +62,7 @@ describe('withLazyPageViewModel', () => {
     expect(screen.getByText('hello VM_0')).toBeDefined();
   });
   test('renders (no path params)', async () => {
-    class VM extends PageViewModelMock {
+    class VM extends PageViewModelBaseMock {
       mount() {
         super.mount();
       }

diff --git a/src/hoc/with-lazy-page-view-model.tsx b/src/hoc/with-lazy-page-view-model.tsx
@@ -2,8 +2,8 @@ import {
   LazyViewAndModel,
   ViewModelHocConfig,
   withLazyViewModel,
-} from 'mobx-vm-entities';
-import { LoadableMixin } from 'mobx-vm-entities/lib/react-simple-loadable';
+} from 'mobx-view-model';
+import { LoadableMixin } from 'mobx-view-model/lib/react-simple-loadable';
 import { ComponentProps, ComponentType } from 'react';
 
 import { AnyPageViewModel, PageViewModel } from '../page-view-model';

diff --git a/src/hoc/with-page-view-model.test.tsx b/src/hoc/with-page-view-model.test.tsx
@@ -1,8 +1,8 @@
 import { act, render, screen } from '@testing-library/react';
-import { createCounter } from 'mobx-vm-entities/utils/counter';
+import { createCounter } from 'mobx-view-model/utils/counter';
 import { describe, expect, test } from 'vitest';
 
-import { PageViewModelMock } from '../page-view-model/page-view-model.impl.test';
+import { PageViewModelBaseMock } from '../page-view-model/page-view-model.base.test';
 
 import { PageViewModelProps, withPageViewModel } from './with-page-view-model';
 
@@ -13,7 +13,7 @@ const createIdGenerator = (prefix?: string) => {
 
 describe('withPageViewModel', () => {
   test('renders (required path param)', async () => {
-    class VM extends PageViewModelMock<{ foo: string }> {
+    class VM extends PageViewModelBaseMock<{ foo: string }> {
       mount() {
         super.mount();
       }
@@ -29,7 +29,7 @@ describe('withPageViewModel', () => {
     expect(screen.getByText('hello VM_0')).toBeDefined();
   });
   test('renders (optional path param)', async () => {
-    class VM extends PageViewModelMock<{ foo?: string }> {
+    class VM extends PageViewModelBaseMock<{ foo?: string }> {
       mount() {
         super.mount();
       }
@@ -45,7 +45,7 @@ describe('withPageViewModel', () => {
     expect(screen.getByText('hello VM_0')).toBeDefined();
   });
   test('renders (no path params)', async () => {
-    class VM extends PageViewModelMock {
+    class VM extends PageViewModelBaseMock {
       mount() {
         super.mount();
       }

diff --git a/src/hoc/with-page-view-model.tsx b/src/hoc/with-page-view-model.tsx
@@ -4,8 +4,8 @@ import {
   ViewModelInputProps,
   ViewModelProps,
   withViewModel,
-} from 'mobx-vm-entities';
-import { AnyObject, Class, RenameKey } from 'mobx-vm-entities/utils/types';
+} from 'mobx-view-model';
+import { AnyObject, Class, RenameKey } from 'mobx-view-model/utils/types';
 import { ComponentType, ReactNode } from 'react';
 
 import type { AnyPageViewModel } from '../page-view-model';

diff --git a/src/page-view-model/index.ts b/src/page-view-model/index.ts
@@ -1,3 +1,10 @@
+import { PageViewModelBase } from './page-view-model.base';
+
 export * from './page-view-model';
-export * from './page-view-model.impl';
+export * from './page-view-model.base';
 export * from './page-view-model.types';
+
+/**
+ * @deprecated Will be removed in 2.0.0 releases. Please use {@link PageViewModelBase} instead
+ */
+export const PageViewModelImpl = PageViewModelBase;
diff --git a/src/page-view-model/page-view-model.base.test.ts b/src/page-view-model/page-view-model.base.test.ts
@@ -0,0 +1,17 @@
+import { AnyViewModel } from 'mobx-view-model';
+import { EmptyObject } from 'mobx-view-model/utils/types';
+import { describe, expect, test } from 'vitest';
+
+import { PageViewModelBase } from './page-view-model.base';
+import { AnyPathParams } from './page-view-model.types';
+
+export class PageViewModelBaseMock<
+  Params extends AnyPathParams = EmptyObject,
+  ParentViewModel extends AnyViewModel | null = null,
+> extends PageViewModelBase<Params, ParentViewModel> {}
+
+describe.skip('PageViewModelBase', () => {
+  test.skip('renders', () => {
+    expect(true).toBe(true);
+  });
+});
diff --git a/src/page-view-model/page-view-model.impl.ts → src/page-view-model/page-view-model.base.ts b/src/page-view-model/page-view-model.impl.ts → src/page-view-model/page-view-model.base.ts
@@ -1,14 +1,14 @@
-import { AnyViewModel, ViewModelImpl } from 'mobx-vm-entities';
-import { EmptyObject } from 'mobx-vm-entities/utils/types';
+import { AnyViewModel, ViewModelBase } from 'mobx-view-model';
+import { EmptyObject } from 'mobx-view-model/utils/types';
 
 import { PageViewModel } from './page-view-model';
 import { AnyPathParams } from './page-view-model.types';
 
-export class PageViewModelImpl<
+export class PageViewModelBase<
     Params extends AnyPathParams = EmptyObject,
     ParentViewModel extends AnyViewModel | null = null,
   >
-  extends ViewModelImpl<Params, ParentViewModel>
+  extends ViewModelBase<Params, ParentViewModel>
   implements PageViewModel<Params, ParentViewModel>
 {
   get pathParams() {

diff --git a/src/page-view-model/page-view-model.impl.test.ts b/src/page-view-model/page-view-model.impl.test.ts
diff --git a/src/page-view-model/page-view-model.ts b/src/page-view-model/page-view-model.ts
@@ -1,5 +1,5 @@
-import { AnyViewModel, ViewModel } from 'mobx-vm-entities';
-import { EmptyObject } from 'mobx-vm-entities/utils/types';
+import { AnyViewModel, ViewModel } from 'mobx-view-model';
+import { EmptyObject } from 'mobx-view-model/utils/types';
 
 import { AnyPathParams } from './page-view-model.types';
 

diff --git a/src/router/router.types.ts b/src/router/router.types.ts
@@ -3,7 +3,7 @@ import {
   IMobxLocation,
   IQueryParams,
 } from 'mobx-location-history';
-import { AnyObject } from 'mobx-vm-entities/utils/types';
+import { AnyObject } from 'mobx-view-model/utils/types';
 
 export interface IMobxRouter {
   history: IMobxHistory;