feat: mark dispose method for view model store as deprecated for use (new method name is clean)

Author: js2me

src/utils/cleanable.ts

@@ -0,0 +1,3 @@
+export interface Cleanable {
+  clean(): void;
+}

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

@@ -34,6 +34,23 @@ export class TestViewModelStoreImpl extends AbstractViewModelStore {
 }
 
 describe('AbstractViewModelStore', () => {
+  it('has clean method', () => {
+    const vmStore = new TestViewModelStoreImpl();
+    expect(vmStore.clean).toBeDefined();
+  });
+  it('has dispose method', () => {
+    const vmStore = new TestViewModelStoreImpl();
+    expect(vmStore.dispose).toBeDefined();
+  });
+  it('has attach method', () => {
+    const vmStore = new TestViewModelStoreImpl();
+    expect(vmStore.attach).toBeDefined();
+  });
+  it('has createViewModel method', () => {
+    const vmStore = new TestViewModelStoreImpl();
+    expect(vmStore.createViewModel).toBeDefined();
+  });
+
   it('create instance', () => {
     const vmStore = new TestViewModelStoreImpl();
     expect(vmStore).toBeDefined();

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

@@ -177,6 +177,10 @@ export abstract class AbstractViewModelStore<
     return !!id && this.viewModels.has(id) && !this.mountingViews.has(id);
   }
 
+  clean(): void {
+    this.dispose();
+  }
+
   dispose(): void {
     this.viewModels.clear();
     this.viewModelsByClasses.clear();

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

@@ -1,5 +1,4 @@
-import { Disposable } from 'disposer-util';
-
+import { Cleanable } from '../utils/cleanable';
 import { Class, Maybe } from '../utils/types';
 
 import {
@@ -13,7 +12,7 @@ import { AnyViewModel } from './view-model.types';
  * It extends the Disposable interface, allowing for cleanup of resources.
  */
 export interface ViewModelStore<VMBase extends AnyViewModel = AnyViewModel>
-  extends Disposable {
+  extends Cleanable {
   /**
    * Retrieves the ID of a view model based on a given ID or class type.
    * @param idOrClass - The ID or class type of the view model.
@@ -78,4 +77,9 @@ export interface ViewModelStore<VMBase extends AnyViewModel = AnyViewModel>
   generateViewModelId<VM extends VMBase>(
     config: ViewModelGenerateIdConfig<VM>,
   ): string;
+
+  /**
+   * @deprecated Please use {clean()} method
+   */
+  dispose(): void;
 }