@view-models/core 2.1.0 → 2.1.1

package/README.md

@@ -118,7 +118,7 @@ class TodoViewModel extends ViewModelWithDerivedState<
   toggleTodo(id: string) {
     this.update(({ items }) => ({
       items: items.map((item) =>
-        item.id === id ? { ...item, done: !item.done } : item
+        item.id === id ? { ...item, done: !item.done } : item,
       ),
     }));
   }
@@ -160,107 +160,7 @@ function Counter({ model }) {
 
 ## API Reference
 
-### `ViewModel<T>`
-
-Abstract base class for creating view models.
-
-#### Constructor
-
-```typescript
-constructor(initialState: T)
-```
-
-Initialize the view model with an initial state.
-
-#### Methods
-
-##### `subscribe(listener: ViewModelListener): () => void`
-
-Subscribe to state changes. The listener will be called whenever `update()` is called. Returns a function to unsubscribe.
-
-```typescript
-const unsubscribe = viewModel.subscribe(() => {
-  console.log("State changed:", viewModel.state);
-});
-
-// Later, to unsubscribe:
-unsubscribe();
-```
-
-##### `update(updater: Updater<T>): void` (protected)
-
-Update the state and notify all subscribers. This method is protected and should only be called from within your view model subclass.
-
-```typescript
-protected update(updater: (currentState: T) => T): void
-```
-
-The updater function receives the current state and should return the new state.
-
-##### `state: T` (getter)
-
-Access the current state.
-
-```typescript
-const currentState = viewModel.state;
-```
-
-### `ViewModelWithDerivedState<S, D>`
-
-Abstract base class for creating view models with derived state. Use this when you need computed properties that are automatically recalculated when the internal state changes.
-
-#### Constructor
-
-```typescript
-constructor(initialState: S)
-```
-
-Initialize the view model with an initial internal state. The derived state is automatically computed during construction.
-
-#### Methods
-
-##### `subscribe(listener: ViewModelListener): () => void`
-
-Subscribe to state changes. The listener will be called whenever the derived state changes. Returns a function to unsubscribe.
-
-```typescript
-const unsubscribe = viewModel.subscribe(() => {
-  console.log("State changed:", viewModel.state);
-});
-
-// Later, to unsubscribe:
-unsubscribe();
-```
-
-##### `update(updater: Updater<S>): void` (protected)
-
-Update the internal state, automatically recompute derived state, and notify all subscribers. This method is protected and should only be called from within your view model subclass.
-
-```typescript
-protected update(updater: (currentState: S) => S): void
-```
-
-##### `computeDerivedState(state: S): D` (abstract)
-
-Abstract method that must be implemented to compute the derived state from the internal state. This is called automatically after each update and during initialization.
-
-```typescript
-computeDerivedState({ items }: InternalState): DerivedState {
-  return {
-    items,
-    count: items.length,
-    hasItems: items.length > 0,
-  };
-}
-```
-
-##### `state: D` (getter)
-
-Access the current derived state.
-
-```typescript
-const currentState = viewModel.state;
-```
+For detailed API documentation, see [docs](./docs).
 
 ## Patterns and Best Practices
 

package/dist/ViewModel.d.ts

@@ -1,4 +1,4 @@
-import { ViewModelWithDerivedState } from "./ViewModelWithDerivedState";
+import { ViewModelWithDerivedState } from "./ViewModelWithDerivedState.js";
 /**
  * Abstract base class for creating reactive view models.
  *

package/dist/ViewModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewModel.d.ts","sourceRoot":"","sources":["../src/ViewModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,8BAAsB,SAAS,CAAC,CAAC,CAAE,SAAQ,yBAAyB,CAAC,CAAC,EAAE,CAAC,CAAC;IACxE;;;;OAIG;gBACS,YAAY,EAAE,CAAC;IAI3B,mBAAmB,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC;CAGjC"}
+{"version":3,"file":"ViewModel.d.ts","sourceRoot":"","sources":["../src/ViewModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,8BAAsB,SAAS,CAAC,CAAC,CAAE,SAAQ,yBAAyB,CAAC,CAAC,EAAE,CAAC,CAAC;IACxE;;;;OAIG;gBACS,YAAY,EAAE,CAAC;IAI3B,mBAAmB,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC;CAGjC"}

package/dist/ViewModel.js

@@ -1,4 +1,4 @@
-import { ViewModelWithDerivedState } from "./ViewModelWithDerivedState";
+import { ViewModelWithDerivedState } from "./ViewModelWithDerivedState.js";
 /**
  * Abstract base class for creating reactive view models.
  *

package/dist/ViewModelWithDerivedState.d.ts

@@ -11,7 +11,6 @@ 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 = () => void;
 /**
@@ -27,22 +26,22 @@ export type ViewModelListener = () => void;
  *
  * @example
  * ```typescript
- * type TodoInternalState = {
+ * type TodoState = {
  *   items: Array<{ id: string; text: string; done: boolean }>;
  * };
  *
- * type TodoDerivedState = TodoInternalState & {
+ * type TodoDerivedState = TodoState & {
  *   totalCount: number;
  *   completedCount: number;
  *   remainingCount: number;
  * };
  *
- * class TodoViewModel extends ViewModelWithDerivedState<TodoInternalState, TodoDerivedState> {
+ * class TodoViewModel extends ViewModelWithDerivedState<TodoState, TodoDerivedState> {
  *   constructor() {
  *     super({ items: [] });
  *   }
  *
- *   computeDerivedState({ items }: TodoInternalState): TodoDerivedState {
+ *   computeDerivedState({ items }: TodoState): TodoDerivedState {
  *     return {
  *       items,
  *       totalCount: items.length,

package/dist/ViewModelWithDerivedState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewModelWithDerivedState.d.ts","sourceRoot":"","sources":["../src/ViewModelWithDerivedState.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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,8BAAsB,yBAAyB,CAAC,CAAC,EAAE,CAAC;IAClD,OAAO,CAAC,UAAU,CAAqC;IACvD,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,MAAM,CAAI;IAElB;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM,IAAI;IAOlD;;;;;;;OAOG;gBACS,YAAY,EAAE,CAAC;IAK3B;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IASpC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC;IAEzC;;;;;;;OAOG;IACH,IAAI,KAAK,IAAI,CAAC,CAEb;CACF"}
+{"version":3,"file":"ViewModelWithDerivedState.d.ts","sourceRoot":"","sources":["../src/ViewModelWithDerivedState.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC;AAEhD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,8BAAsB,yBAAyB,CAAC,CAAC,EAAE,CAAC;IAClD,OAAO,CAAC,UAAU,CAAqC;IACvD,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,MAAM,CAAI;IAElB;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM,IAAI;IAOlD;;;;;;;OAOG;gBACS,YAAY,EAAE,CAAC;IAK3B;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IASpC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC;IAEzC;;;;;;;OAOG;IACH,IAAI,KAAK,IAAI,CAAC,CAEb;CACF"}

package/dist/ViewModelWithDerivedState.js

@@ -11,22 +11,22 @@
  *
  * @example
  * ```typescript
- * type TodoInternalState = {
+ * type TodoState = {
  *   items: Array<{ id: string; text: string; done: boolean }>;
  * };
  *
- * type TodoDerivedState = TodoInternalState & {
+ * type TodoDerivedState = TodoState & {
  *   totalCount: number;
  *   completedCount: number;
  *   remainingCount: number;
  * };
  *
- * class TodoViewModel extends ViewModelWithDerivedState<TodoInternalState, TodoDerivedState> {
+ * class TodoViewModel extends ViewModelWithDerivedState<TodoState, TodoDerivedState> {
  *   constructor() {
  *     super({ items: [] });
  *   }
  *
- *   computeDerivedState({ items }: TodoInternalState): TodoDerivedState {
+ *   computeDerivedState({ items }: TodoState): TodoDerivedState {
  *     return {
  *       items,
  *       totalCount: items.length,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@view-models/core",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "A lightweight, framework-agnostic library for building reactive view models with TypeScript",
   "keywords": [
     "view",
@@ -43,11 +43,14 @@
     "test:coverage": "vitest run --coverage",
     "format": "prettier --write \"**/*.{ts,js,json,md}\"",
     "format:check": "prettier --check \"**/*.{ts,js,json,md}\"",
+    "docs": "typedoc && npm run format",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^4.0.16",
     "prettier": "^3.7.4",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.7.3",
     "vitest": "^4.0.16"
   },

package/src/ViewModel.ts

@@ -1,4 +1,4 @@
-import { ViewModelWithDerivedState } from "./ViewModelWithDerivedState";
+import { ViewModelWithDerivedState } from "./ViewModelWithDerivedState.js";
 
 /**
  * Abstract base class for creating reactive view models.

package/src/ViewModelWithDerivedState.ts

@@ -12,7 +12,6 @@ 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 = () => void;
 
@@ -29,22 +28,22 @@ export type ViewModelListener = () => void;
  *
  * @example
  * ```typescript
- * type TodoInternalState = {
+ * type TodoState = {
  *   items: Array<{ id: string; text: string; done: boolean }>;
  * };
  *
- * type TodoDerivedState = TodoInternalState & {
+ * type TodoDerivedState = TodoState & {
  *   totalCount: number;
  *   completedCount: number;
  *   remainingCount: number;
  * };
  *
- * class TodoViewModel extends ViewModelWithDerivedState<TodoInternalState, TodoDerivedState> {
+ * class TodoViewModel extends ViewModelWithDerivedState<TodoState, TodoDerivedState> {
  *   constructor() {
  *     super({ items: [] });
  *   }
  *
- *   computeDerivedState({ items }: TodoInternalState): TodoDerivedState {
+ *   computeDerivedState({ items }: TodoState): TodoDerivedState {
  *     return {
  *       items,
  *       totalCount: items.length,