@view-models/core 1.0.0 → 1.2.0

package/README.md

@@ -2,6 +2,8 @@
 
 A lightweight, framework-agnostic library for building reactive view models with TypeScript. Separate your business logic from your UI framework with a simple, testable pattern.
 
+![View models banner](./view-models.png)
+
 ## Why View Models?
 
 - **Framework Agnostic**: Write your logic once, use it with React, Preact, or any other framework
@@ -85,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:
 
@@ -200,9 +202,10 @@ class AppViewModel {
 }
 ```
 
-### Handle Side Effects
+### Asynchronous actions
 
-Keep your update logic pure, but expose methods for side effects:
+While the update logic is pure, you can use methods to execute asynchronous
+actions:
 
 ```typescript
 class TodosViewModel extends ViewModel<TodosState> {

package/dist/ViewModel.d.ts

@@ -1,4 +1,3 @@
-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.
@@ -7,7 +6,7 @@ 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.
  *
@@ -21,7 +20,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 T - The state type
  *
  * @example
  * ```typescript
@@ -44,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<T> {
     private _listeners;
     /**
      * Subscribe to state changes.
@@ -97,5 +96,4 @@ export declare abstract class ViewModel<T extends State> {
      */
     get state(): T;
 }
-export {};
 //# 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,KAAK,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAE9B;;;;;;;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,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,8BAAsB,SAAS,CAAC,CAAC;IAC/B,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"}

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 T - The state type
  *
  * @example
  * ```typescript

package/package.json

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

package/src/ViewModel.ts

@@ -1,5 +1,3 @@
-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.
@@ -8,7 +6,7 @@ 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.
@@ -24,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 T - The state type
  *
  * @example
  * ```typescript
@@ -47,7 +45,7 @@ export type ViewModelListener<T> = (state: T) => void;
  * counter.increment(); // Logs: Count: 1
  * ```
  */
-export abstract class ViewModel<T extends State> {
+export abstract class ViewModel<T> {
   private _listeners: Set<ViewModelListener<T>> = new Set();
 
   /**