@view-models/core 1.1.0 → 2.0.0

package/README.md

@@ -87,8 +87,8 @@ describe("CounterViewModel", () => {
 
 The view models are designed to work with framework-specific adapters. Upcoming adapters include:
 
-- **@view-models/react** - React hooks integration
-- **@view-models/preact** - Preact hooks integration
+- [@view-models/react](https://github.com/sunesimonsen/view-models-react) - React hooks integration
+- [@view-models/preact](https://github.com/sunesimonsen/view-models-preact) - Preact hooks integration
 
 These adapters will allow you to use the same view model with different frameworks:
 

package/dist/ViewModel.d.ts

@@ -1,7 +1,3 @@
-/**
- * The base type of view model state.
- */
-export type State = Readonly<object>;
 /**
  * Function that receives the current state and returns the new state.
  * The updater function should be pure and return a new state object.
@@ -10,21 +6,21 @@ export type State = Readonly<object>;
  * @param currentState - The current state
  * @returns The new state
  */
-export type Updater<T extends State> = (currentState: T) => T;
+export type Updater<T> = (currentState: T) => T;
 /**
  * Function that gets called when the state changes.
  *
  * @template T - The state type
  * @param state - The new state
  */
-export type ViewModelListener<T> = (state: T) => void;
+export type ViewModelListener = () => void;
 /**
  * Abstract base class for creating reactive view models.
  *
  * A ViewModel manages state and notifies subscribers when the state changes.
  * Extend this class to create your own view models with custom business logic.
  *
- * @template T - The state type (must be a readonly object)
+ * @template S - The state type
  *
  * @example
  * ```typescript
@@ -47,7 +43,7 @@ export type ViewModelListener<T> = (state: T) => void;
  * counter.increment(); // Logs: Count: 1
  * ```
  */
-export declare abstract class ViewModel<T extends State> {
+export declare abstract class ViewModel<S> {
     private _listeners;
     /**
      * Subscribe to state changes.
@@ -67,14 +63,14 @@ export declare abstract class ViewModel<T extends State> {
      * unsubscribe();
      * ```
      */
-    subscribe(listener: ViewModelListener<T>): () => void;
+    subscribe(listener: ViewModelListener): () => void;
     private _state;
     /**
      * Create a new ViewModel with the given initial state.
      *
      * @param initialState - The initial state of the view model
      */
-    constructor(initialState: T);
+    constructor(initialState: S);
     /**
      * Update the state and notify all subscribers.
      *
@@ -92,12 +88,12 @@ export declare abstract class ViewModel<T extends State> {
      * }));
      * ```
      */
-    protected update(updater: Updater<T>): void;
+    protected update(updater: Updater<S>): void;
     /**
      * Get the current state.
      *
      * @returns The current state
      */
-    get state(): T;
+    get state(): S;
 }
 //# sourceMappingURL=ViewModel.d.ts.map

package/dist/ViewModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewModel.d.ts","sourceRoot":"","sources":["../src/ViewModel.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAErC;;;;;;;GAOG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,8BAAsB,SAAS,CAAC,CAAC,SAAS,KAAK;IAC7C,OAAO,CAAC,UAAU,CAAwC;IAE1D;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IAOrD,OAAO,CAAC,MAAM,CAAI;IAElB;;;;OAIG;gBACS,YAAY,EAAE,CAAC;IAI3B;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAQpC;;;;OAIG;IACH,IAAI,KAAK,IAAI,CAAC,CAEb;CACF"}
+{"version":3,"file":"ViewModel.d.ts","sourceRoot":"","sources":["../src/ViewModel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,8BAAsB,SAAS,CAAC,CAAC;IAC/B,OAAO,CAAC,UAAU,CAAqC;IAEvD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM,IAAI;IAOlD,OAAO,CAAC,MAAM,CAAI;IAElB;;;;OAIG;gBACS,YAAY,EAAE,CAAC;IAI3B;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAQpC;;;;OAIG;IACH,IAAI,KAAK,IAAI,CAAC,CAEb;CACF"}

package/dist/ViewModel.js

@@ -4,7 +4,7 @@
  * A ViewModel manages state and notifies subscribers when the state changes.
  * Extend this class to create your own view models with custom business logic.
  *
- * @template T - The state type (must be a readonly object)
+ * @template S - The state type
  *
  * @example
  * ```typescript
@@ -81,7 +81,7 @@ export class ViewModel {
     update(updater) {
         this._state = updater(this._state);
         for (const listener of this._listeners) {
-            listener(this._state);
+            listener();
         }
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@view-models/core",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "A lightweight, framework-agnostic library for building reactive view models with TypeScript",
   "keywords": [
     "view",

package/src/ViewModel.ts

@@ -1,8 +1,3 @@
-/**
- * The base type of view model state.
- */
-export type State = Readonly<object>;
-
 /**
  * Function that receives the current state and returns the new state.
  * The updater function should be pure and return a new state object.
@@ -11,7 +6,7 @@ export type State = Readonly<object>;
  * @param currentState - The current state
  * @returns The new state
  */
-export type Updater<T extends State> = (currentState: T) => T;
+export type Updater<T> = (currentState: T) => T;
 
 /**
  * Function that gets called when the state changes.
@@ -19,7 +14,7 @@ export type Updater<T extends State> = (currentState: T) => T;
  * @template T - The state type
  * @param state - The new state
  */
-export type ViewModelListener<T> = (state: T) => void;
+export type ViewModelListener = () => void;
 
 /**
  * Abstract base class for creating reactive view models.
@@ -27,7 +22,7 @@ export type ViewModelListener<T> = (state: T) => void;
  * A ViewModel manages state and notifies subscribers when the state changes.
  * Extend this class to create your own view models with custom business logic.
  *
- * @template T - The state type (must be a readonly object)
+ * @template S - The state type
  *
  * @example
  * ```typescript
@@ -50,8 +45,8 @@ export type ViewModelListener<T> = (state: T) => void;
  * counter.increment(); // Logs: Count: 1
  * ```
  */
-export abstract class ViewModel<T extends State> {
-  private _listeners: Set<ViewModelListener<T>> = new Set();
+export abstract class ViewModel<S> {
+  private _listeners: Set<ViewModelListener> = new Set();
 
   /**
    * Subscribe to state changes.
@@ -71,21 +66,21 @@ export abstract class ViewModel<T extends State> {
    * unsubscribe();
    * ```
    */
-  subscribe(listener: ViewModelListener<T>): () => void {
+  subscribe(listener: ViewModelListener): () => void {
     this._listeners.add(listener);
     return () => {
       this._listeners.delete(listener);
     };
   }
 
-  private _state: T;
+  private _state: S;
 
   /**
    * Create a new ViewModel with the given initial state.
    *
    * @param initialState - The initial state of the view model
    */
-  constructor(initialState: T) {
+  constructor(initialState: S) {
     this._state = initialState;
   }
 
@@ -106,11 +101,11 @@ export abstract class ViewModel<T extends State> {
    * }));
    * ```
    */
-  protected update(updater: Updater<T>) {
+  protected update(updater: Updater<S>) {
     this._state = updater(this._state);
 
     for (const listener of this._listeners) {
-      listener(this._state);
+      listener();
     }
   }
 
@@ -119,7 +114,7 @@ export abstract class ViewModel<T extends State> {
    *
    * @returns The current state
    */
-  get state(): T {
+  get state(): S {
     return this._state;
   }
 }