@microphi/store 2.11.1 → 2.11.4

package/README.md

@@ -1,252 +1,200 @@
-# @microphi/store
+# @microphi/store [![npm](https://img.shields.io/npm/v/@microphi/store)](https://www.npmjs.com/package/@microphi/store)
 
-@microphi/store is a pure RxJS state manager.
+> Pure RxJS state manager driven by `@Effect` / `@Reduce` decorators
 
 ## Install
-With your favourite package manager install
+
+```sh
+npm i @microphi/store @microphi/di rxjs reflect-metadata
 ```
-@microphi/store
+
+Enable legacy decorators in `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "experimentalDecorators": true
+  }
+}
 ```
 
+## How to use
+
 ### Define the state
+
 ```typescript
-interface ItemsState {
+interface UsersState {
   users: string[];
-  selected?: [number, string];
+  selected?: string;
 }
 ```
 
 ### Define the actions
+
+Every action returns an `Observable`; its arguments are what `dispatch` takes.
+
 ```typescript
-interface ItemsActions {
-  // An action MUST always return an Observable
+interface UsersActions {
   findAll: () => Observable<string[]>;
-  // select: (name: string) => Observable<[number, string]>;
+  findOne: (id: string) => Observable<string>;
 }
 ```
-### Implement effects and reducers in the store
+
+### Implement effects and reducers
+
+For each action the store needs an `@Effect()` method named like the action and an `@Reduce()` method named `on` + `PascalCase(action)`. A missing one throws when the store is constructed.
 
 ```typescript
-import { Store, Effect, Reduce } from '@microphi/store';
+import { Observable, of } from 'rxjs';
+import { Effect, makeStore, Reduce, Store } from '@microphi/store';
 
-// -> Create a class that extends `Store` such as
-class MyStore extends Store<ItemsState, ItemsActions>
-    implements makeStore<ItemsState, ItemsActions> {
-  // -> optionally implement `makeStore` to add extra type checking
+class UsersStore extends Store<UsersState, UsersActions>
+  // optional: type-checks that every effect and reducer is implemented
+  implements makeStore<UsersState, UsersActions> {
 
   constructor() {
-    // -> Set the initial state
-    super({
-      users: ['alice', 'bob'],
-    });
+    // initial state, must be serializable: each instance gets its own deep copy
+    super({ users: ['alice', 'bob'] });
   }
 
   @Effect()
-  // -> Implement `findAll` method
   findAll(): Observable<string[]> {
-    // - Simulate an async call
-    return of(['alice', 'bob', 'carl', 'denise']);
+    return of(['carl', 'denise']);
   }
 
-  @Reduce() // - Decorate with `@Reduce` so the `Store` knows this is a reducer
-  // -> Method name MUST be `on` + capitalized `actionName`
-  //  its first argument is always the current state
-  //  its second argument is the output of its action without the Observable.
-  public onFindAll(state: ItemsState, payload: string[]) {
-    // -> add state transition logic here
-
-    // -> Return the new state
-    return {
-      users: [...state.users, ...payload]
-    };
+  // receives the current state and the value emitted by the effect
+  @Reduce()
+  onFindAll(state: UsersState, users: string[]): UsersState {
+    return { ...state, users: [...state.users, ...users] };
+  }
+
+  @Effect()
+  findOne(id: string): Observable<string> {
+    return fromFetch(`https://my.endpoint/users/${id}`).pipe(switchMap((r) => r.json()));
+  }
+
+  @Reduce()
+  onFindOne(state: UsersState, selected: string): UsersState {
+    return { ...state, selected };
   }
 }
 ```
 
-### Dispatch and select state
+### Dispatch and select
+
 ```typescript
-// given an instance of the store
-const store = new MyStore();
+const store = new UsersStore();
 
-// subscribe to any state change
-store.state$.subscribe((state) => console.log({ state }) );
+// every state change
+store.state$.subscribe((state) => console.log(state));
 
-// or better select a projection of the state
-store.select(({users}) => users).subscribe((users) => console.log({ users }));
+// or a projection, emitted only when it changes
+store.select(({ users }) => users).subscribe((users) => console.log(users));
 
-// finally dispatch an action
 store.dispatch('findAll');
-
+store.dispatch('findOne', 'alice'); // arguments are type-checked against UsersActions
 ```
 
-#### Watch loading state
-We assume every action to be an asyncronious task so every action as a loading state associated to it. Loading state can we subscribed such as:
-```typescript
-store.getLoadingFor('findAll').subscribe((loading) => {
-
-  console.log({loading});
+### Loading and errors
 
-});
+Every action is treated as async, so each has a loading state:
 
+```typescript
+store.getLoadingFor('findOne').subscribe((loading) => console.log({ loading }));
 ```
 
-### Choose the right strategy
-We assume that an action always execute an async effect. Internally such effect is wrapped in a RxJS pipe, as such there are several way this can be done.
-So for example when we dispatch an action such as `findOne` let's say its effect is a call to and endpoint to retrieve an entity by its id.
-Dependending on the scenario we may want to `switchMap`, `mergeMap` or `concatMap`.
+`loading$` carries the full event: `{ code, payload, status, response?, error? }`.
 
-This can be achieved passing the `strategy` argument to the `@Effect` decorator such as:
+If an effect errors, the error is logged and emitted on `loading$` (with `status: false` and `error`), the state is left untouched and the action can be dispatched again.
 
-```typescript
+### Effects that emit more than once
 
-class MyStore extends Store<ItemsState, ItemsActions>
-    implements makeStore<ItemsState, ItemsActions> {
+The reducer runs for every value the effect emits, so a long-lived effect (a connection, a socket) keeps updating the state after the dispatch that started it.
 
-  constructor() {
-    super({
-      users: ['alice', 'bob'],
-      selected: undefined,
+## Strategies
 
-    });
-  }
+When an action is dispatched again while its previous effect is still running, the strategy passed to `@Effect` decides what happens:
 
-  @Effect('mergeMap')
-  findOne(id: string): Observable<string> {
-    return fromFetch(`http://my.super.endpoint/${id}`)
-  }
+| Strategy | Behaviour |
+|---|---|
+| `switchMap` (default) | the pending effect is cancelled, only the latest one reduces |
+| `mergeMap` | effects run in parallel, each reduces as it completes |
+| `concatMap` | effects run one after the other, in dispatch order |
 
-  @Reduce()
-  public onFindOne(state: ItemsState, select: string) {
-    return {
-      ...state,
-      selected,
-    };
-  }
+```typescript
+@Effect('mergeMap')
+findOne(id: string): Observable<string> {
+  return fromFetch(`https://my.endpoint/users/${id}`).pipe(switchMap((r) => r.json()));
 }
 ```
 
-### Operators
-When dispatching actions some RxJS operators can be applied using decorators:
+## Operators
+
+### `@Cache`
 
-#### Cache
-It caches the value returned from the effect (i.e.: its observable) for 300_000 (default) milliseconds (i.e.: 5 mins) or the amount of milliseconds provided in the `ttl` field.
-The effect will be cached according to its arguments. I.e.: like a memoized function `@Cache` will get check arguments and cache their result separately.
+Caches the Observable an effect returns, per store instance and per arguments, so a cached dispatch does not call the effect method again. The Observable itself is resubscribed: a cold one (like `fromFetch`) re-runs its request unless it is shared, e.g. with `shareReplay(1)`.
 
-Optionally a `trackBy` function can be provided in order to customized how arguments are considered for caching.
-If not provided `JSON.stringify` is used to serialize the arguments.
-If provided `trackBy` will have the exact same arguments of the effect being annotated.
 ```typescript
+@Effect('mergeMap')
+@Cache({ ttl: 1_000, trackBy: (id: string) => id.toLowerCase() })
+findOne(id: string): Observable<string> {
+  return fromFetch(`https://my.endpoint/users/${id}`).pipe(
+    switchMap((r) => r.json()),
+    shareReplay(1),
+  );
+}
+```
 
-class MyStore extends Store<ItemsState, ItemsActions>
-    implements makeStore<ItemsState, ItemsActions> {
+- `ttl`: time to live in ms, default 5 minutes
+- `trackBy`: builds the cache key from the effect's arguments, default `JSON.stringify(args)`
 
-  constructor() {
-    super({
-      users: ['alice', 'bob'],
-      selected: undefined,
+`@Cache` lives in `@microphi/di` and works on any class; it is re-exported here.
 
-    });
-  }
+### `@DebounceTime`
 
-  @Effect('mergeMap')
-  @Cache({ttl: 1_000, trackBy: (id: string) => id.toLowerCase()})
-  findOne(id: string): Observable<string> {
-    return fromFetch(`http://my.super.endpoint/${id}`)
-  }
+Debounces dispatches of the action, as `debounceTime` in an RxJS pipe:
 
-  @Reduce()
-  public onFindOne(state: ItemsState, select: string) {
-    return {
-      ...state,
-      selected,
-    };
-  }
+```typescript
+@Effect('switchMap')
+@DebounceTime(300)
+search(query: string): Observable<string[]> {
+  return fromFetch(`https://my.endpoint/search?q=${query}`).pipe(switchMap((r) => r.json()));
 }
 ```
 
+### `@DelayTime`
 
-#### DebounceTime
-It will debouce calling the effect as in a RxJS pipe
+Delays each effect's result, as `delay` in an RxJS pipe:
 
 ```typescript
-
-class MyStore extends Store<ItemsState, ItemsActions>
-    implements makeStore<ItemsState, ItemsActions> {
-
-  constructor() {
-    super({
-      users: ['alice', 'bob'],
-      selected: undefined,
-
-    });
-  }
-
-  @Effect('mergeMap')
-  @DebounceTime(300)
-  findOne(id: string): Observable<string> {
-    return fromFetch(`http://my.super.endpoint/${id}`)
-  }
-
-  @Reduce()
-  public onFindOne(state: ItemsState, select: string) {
-    return {
-      ...state,
-      selected,
-    };
-  }
+/**
+ * with concatMap this rate-limits the effect to one call per 100 ms
+ */
+@Effect('concatMap')
+@DelayTime(100)
+track(id: string) {
+  return fromFetch(`https://my.endpoint/track/${id}`);
 }
 ```
 
-#### DelayTime
-It will deley an effect as in a RxJS pipe.
-```typescript
-  class TestClass extends Store<State, Actions> {
-
-    /**
-     * this effect will be rate limited at one call per 100 ms
-     */
-    @Effect('concatMap')
-    @DelayTime(100)
-    effectWithDelay(id: string) {
-      return fromFetch(`http://my.super.endpoint/${id}`)
-    }
-
-    @Reduce()
-    onEffectWithDelay(state: State, payload: string): State {
-      return {...state, items: [...state.items, payload]};
-    }
-  }
-```
-⚠️ Note the use of `concatMap` strategy. If another strategy is used the effect of `@DelayTime` may be not what really expected.
-Please see [delay.spec.ts](./src/lib/operators/delay.spec.ts) for all possible combination of `strategy` and `@DelayTime`
+⚠️ With strategies other than `concatMap` the result may not be what you expect: see [delay.spec.ts](./src/lib/operators/delay.spec.ts) for every combination.
+
+`@DebounceTime` and `@DelayTime` are read by the store's dispatch pipeline, so they only have an effect on a `Store` subclass.
 
 ## .skills
+
 Automation agents can invoke the following skills when working inside `packages/store`.
 
 ### build-store-lib
 - Goal: emit both ESM and CJS bundles from `src`.
-- Run from repo root (ensures workspace deps resolve):
-  1. `npm install` (first run or when deps change).
-  2. `npm run build -- --scope @microphi/store` to leverage Lerna caching, or `cd packages/store && npm run build` for isolated builds.
-- Checks: confirm `packages/store/lib/esm/index.js` and `packages/store/lib/cjs/index.js` are regenerated.
+- From the repo root: `npm install` (first run or when deps change), then `npm run build -w packages/di -w packages/store` (store needs di's `lib/` output).
+- Checks: `packages/store/lib/esm/index.js` and `packages/store/lib/cjs/index.js` are regenerated.
 
 ### test-store-lib
-- Goal: execute package-specific Jest suite with coverage, mirroring CI.
-- Commands:
-  1. `cd packages/store`.
-  2. `npm run test:ci` (wraps `jest --coverage --ci`).
-- When debugging a single spec use `npx jest src/lib/store/store.spec.ts --runTestsByPath` within this folder.
+- Goal: run the package's vitest suite with coverage, mirroring CI.
+- `cd packages/store && npm run test:ci` (wraps `vitest run --coverage`).
+- Single spec: `npx vitest run src/lib/store/store.spec.ts` within this folder.
 
 ### lint-store-lib
-- Goal: enforce the repo’s TypeScript + ESLint rules before commits.
-- Commands:
-  1. `cd packages/store`.
-  2. `npm run lint:ci` (runs `eslint ./src`).
-- Fix order: apply autofixes via `npx eslint ./src --fix`, rerun lint, then tests.
-
-### release-store-docs
-- Goal: regenerate docs after updating public APIs.
-- Commands:
-  1. From repo root `npm run docs -- --scope @microphi/store` if scoped docs exist, otherwise invoke `npm run docs` to rebuild all packages.
-  2. Run `npm run postdocs` to refresh aggregated docs.
-- Verify README snippets still compile by running the TypeScript samples inside `examples/` or via `ts-node` scratch files as needed.
+- Goal: enforce the repo's TypeScript + ESLint rules before commits.
+- `cd packages/store && npm run lint` (runs `eslint ./src`); autofix with `npx eslint ./src --fix`, then rerun lint and tests.

package/lib/cjs/lib/operators/cache.d.ts

@@ -1,21 +1,5 @@
-import { Store } from '../store/store';
 import { Observable } from 'rxjs';
-import { Fn, Key } from '../store/types';
-import 'reflect-metadata';
-export declare const CacheSymbol: unique symbol;
-export interface CacheOptions {
-    /**
-     * time to live in milliseconds
-     */
-    ttl?: number;
-    /**
-     * This function has the same arguments as the decorated method
-     */
-    trackBy?: (...args: any[]) => string | number;
-}
+export { Cache, CacheSymbol } from '@microphi/di';
+export type { CacheEntry, CacheMap, CacheOptions } from '@microphi/di';
 export type EffectMethod = (...args: any[]) => Observable<any>;
-/**
- * Caches an effect's value
- */
-export declare function Cache(options?: CacheOptions): <S extends Store<any, any>>(_target: S, property: Key, descriptor: TypedPropertyDescriptor<Fn>) => void;
 //# sourceMappingURL=cache.d.ts.map

package/lib/cjs/lib/operators/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../../src/lib/operators/cache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,kBAAkB,CAAC;AAE1B,eAAO,MAAM,WAAW,eAAmB,CAAC;AAE5C,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,GAAC,MAAM,CAAC;CAC7C;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC;AAE/D;;GAEG;AACH,wBAAgB,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,wCAEE,CAAC,YAAY,GAAG,cAAc,wBAAwB,EAAE,CAAC,UA2CtG"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../../src/lib/operators/cache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAIlC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAClD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEvE,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC"}

package/lib/cjs/lib/operators/cache.js

@@ -1,39 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cache = exports.CacheSymbol = void 0;
-require("reflect-metadata");
-exports.CacheSymbol = Symbol('@Cache');
-/**
- * Caches an effect's value
- */
-function Cache(options) {
-    return (_target, property, descriptor) => {
-        const originalFn = descriptor.value;
-        if (originalFn) {
-            descriptor.value = function (...args) {
-                const root = this;
-                const cache = root[exports.CacheSymbol];
-                // this can grow huge
-                // shall we put some sort of cap?
-                const key = options?.trackBy ? options.trackBy(...args) : JSON.stringify(args);
-                const id = `${property}:${key}`;
-                const cached = cache.get(id);
-                if (cached) {
-                    // check ttl given timestamp
-                    const timestamp = cached.timestamp;
-                    const now = Date.now();
-                    const ttl = now - timestamp;
-                    const maxTtl = options?.ttl || 300000; // 5 minutes
-                    if (ttl <= maxTtl) {
-                        const value = cached.value;
-                        return value;
-                    }
-                }
-                const retValue = originalFn.apply(this, args);
-                cache.set(id, { value: retValue, timestamp: Date.now() });
-                return retValue;
-            };
-        }
-    };
-}
-exports.Cache = Cache;
+exports.CacheSymbol = exports.Cache = void 0;
+// `@Cache` lives in `@microphi/di` so that it can be used on any class.
+// It is re-exported here to keep the store's public API unchanged.
+var di_1 = require("@microphi/di");
+Object.defineProperty(exports, "Cache", { enumerable: true, get: function () { return di_1.Cache; } });
+Object.defineProperty(exports, "CacheSymbol", { enumerable: true, get: function () { return di_1.CacheSymbol; } });

package/lib/cjs/lib/reduce/reduce.js

@@ -5,7 +5,7 @@ require("reflect-metadata");
 const scan_instance_1 = require("../utilities/scan-instance");
 exports.ReduceSymbol = Symbol('@Reduce');
 function Reduce() {
-    return (target, propertyKey, descriptor) => {
+    return (target, propertyKey) => {
         // by convention a reducer have name such as onFindAll
         // where findAll is the associated action
         // with the following we extract the action's name

package/lib/cjs/lib/store/store.d.ts

@@ -1,14 +1,11 @@
 import { BehaviorSubject, Observable, SchedulerLike } from 'rxjs';
 import { Effect } from '../effect/effect';
-import { CacheSymbol } from '../operators/cache';
+import { CacheMap, CacheSymbol } from '../operators/cache';
 import { Reducer } from '../reduce/reduce';
 import { getPayloadFromActionType, LoadingState } from './types';
 export declare abstract class Store<State, A> {
     private initialState;
-    protected [CacheSymbol]: Map<string, {
-        timestamp: number;
-        value: Observable<any>;
-    }>;
+    protected [CacheSymbol]: CacheMap;
     private readonly actions;
     readonly effects: Effect[];
     readonly reducers: Reducer[];
@@ -16,7 +13,7 @@ export declare abstract class Store<State, A> {
     get loading$(): Observable<LoadingState<A>>;
     protected readonly _store$: BehaviorSubject<State>;
     get state$(): Observable<State>;
-    constructor(initialState: State, scheduler?: SchedulerLike);
+    constructor(initialState: State, _scheduler?: SchedulerLike);
     select<R>(projection: (s: State) => R): Observable<R>;
     getLoadingFor<C extends keyof A>(action: C): Observable<boolean>;
     dispatch<C extends keyof A>(action: C, ...payload: getPayloadFromActionType<A, C>): void;

package/lib/cjs/lib/store/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/store.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,eAAe,EAAS,UAAU,EAAM,aAAa,EAAW,MAAM,MAAM,CAAC;AAErG,OAAO,EAAE,MAAM,EAA8B,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,OAAO,EAAe,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAM,wBAAwB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGrE,8BAAsB,KAAK,CAAC,KAAK,EAAE,CAAC;IA0BtB,OAAO,CAAC,YAAY;IAxBhC,SAAS,CAAC,CAAC,WAAW,CAAC;mBAA+B,MAAM;eAAS,WAAW,GAAG,CAAC;OAAK;IAEzF,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoE;IAE5F,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAE3B,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAG7B,OAAO,CAAC,SAAS,CAAkC;IAEnD,IAAW,QAAQ,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAEjD;IAED,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAGhD;IAEF,IAAW,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAErC;gBAEmB,YAAY,EAAE,KAAK,EAAE,SAAS,GAAE,aAA6B;IAyFjF,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC;IAOrC,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;IAOhE,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,EACxB,MAAM,EAAE,CAAC,EACT,GAAG,OAAO,EAAE,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC;IAa5C,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG;IAIxC,OAAO,CAAC,MAAM,CAAC,WAAW;IAU1B,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,YAAY;CAarB"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/store.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,eAAe,EAAS,UAAU,EAAM,aAAa,EAAW,MAAM,MAAM,CAAC;AAErG,OAAO,EAAE,MAAM,EAA8B,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAG3D,OAAO,EAAe,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAM,wBAAwB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGrE,8BAAsB,KAAK,CAAC,KAAK,EAAE,CAAC;IA0BtB,OAAO,CAAC,YAAY;IAxBhC,SAAS,CAAC,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAa;IAE9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoE;IAE5F,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAE3B,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAG7B,OAAO,CAAC,SAAS,CAAkC;IAEnD,IAAW,QAAQ,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAEjD;IAED,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAGhD;IAEF,IAAW,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAErC;gBAEmB,YAAY,EAAE,KAAK,EAAE,UAAU,GAAE,aAA6B;IAyFlF,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC;IAOrC,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;IAOhE,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,EACxB,MAAM,EAAE,CAAC,EACT,GAAG,OAAO,EAAE,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC;IAa5C,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG;IAIxC,OAAO,CAAC,MAAM,CAAC,WAAW;IAU1B,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,YAAY;CAarB"}

package/lib/cjs/lib/store/store.js

@@ -17,7 +17,7 @@ class Store {
     get state$() {
         return this._store$.asObservable();
     }
-    constructor(initialState, scheduler = rxjs_1.asapScheduler) {
+    constructor(initialState, _scheduler = rxjs_1.asapScheduler) {
         this.initialState = initialState;
         this[_a] = new Map();
         this.actions = new Map();

package/lib/cjs/lib/store/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,CAAC;AAElC,MAAM,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAEzC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/C,MAAM,MAAM,wBAAwB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IACvD,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,GACpC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,GAAG,GAC9C,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAE7B,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,IAAI,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;AAEnE,MAAM,MAAM,WAAW,CAAC,OAAO,IAAI;KAEhC,CAAC,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,WAAW,CAAC,SAAS,CAAC,GAC3D,KAAK,GACL,OAAO,CAAC,CAAC,CAAC;CACf,CAAA;AAED,MAAM,MAAM,SAAS,CAAC,KAAK,EAAE,OAAO,IAClC;KACG,CAAC,IAAI,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CAC3D,GAID;KAEG,CAAC,IAAI,MAAM,OAAO,IAAI,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,GAC7G,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,KAAK,KAAK,GACnC,OAAO,CAAC,CAAC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GACrC,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,KAAK,GACrC,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,KAAK;CAE7B,CAAC;AAEJ,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;CACjB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,CAAC;AAElC,MAAM,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAEzC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/C,MAAM,MAAM,wBAAwB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IACvD,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,GACpC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,GAAG,GAC9C,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAE7B,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,IAAI,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;AAEnE,MAAM,MAAM,WAAW,CAAC,OAAO,IAAI;KAEhC,CAAC,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,WAAW,CAAC,SAAS,CAAC,GAC3D,KAAK,GACL,OAAO,CAAC,CAAC,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,KAAK,EAAE,OAAO,IAClC;KACG,CAAC,IAAI,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CAC3D,GAID;KAEG,CAAC,IAAI,MAAM,OAAO,IAAI,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,GAC3G,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,KAAK,KAAK,GACnC,OAAO,CAAC,CAAC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GACrC,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,KAAK,GACrC,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,KAAK;CAE/B,CAAC;AAEJ,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;CACjB"}

package/lib/cjs/lib/utilities/scan-instance.js

@@ -14,7 +14,7 @@ function scanInstance(instance, cb) {
         try {
             proto = Object.getPrototypeOf(proto);
         }
-        catch (e) {
+        catch {
             proto = null;
         }
     }

package/lib/esm/lib/operators/cache.d.ts

@@ -1,21 +1,5 @@
-import { Store } from '../store/store';
 import { Observable } from 'rxjs';
-import { Fn, Key } from '../store/types';
-import 'reflect-metadata';
-export declare const CacheSymbol: unique symbol;
-export interface CacheOptions {
-    /**
-     * time to live in milliseconds
-     */
-    ttl?: number;
-    /**
-     * This function has the same arguments as the decorated method
-     */
-    trackBy?: (...args: any[]) => string | number;
-}
+export { Cache, CacheSymbol } from '@microphi/di';
+export type { CacheEntry, CacheMap, CacheOptions } from '@microphi/di';
 export type EffectMethod = (...args: any[]) => Observable<any>;
-/**
- * Caches an effect's value
- */
-export declare function Cache(options?: CacheOptions): <S extends Store<any, any>>(_target: S, property: Key, descriptor: TypedPropertyDescriptor<Fn>) => void;
 //# sourceMappingURL=cache.d.ts.map

package/lib/esm/lib/operators/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../../src/lib/operators/cache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,kBAAkB,CAAC;AAE1B,eAAO,MAAM,WAAW,eAAmB,CAAC;AAE5C,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,GAAC,MAAM,CAAC;CAC7C;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC;AAE/D;;GAEG;AACH,wBAAgB,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,wCAEE,CAAC,YAAY,GAAG,cAAc,wBAAwB,EAAE,CAAC,UA2CtG"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../../src/lib/operators/cache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAIlC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAClD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEvE,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC"}

package/lib/esm/lib/operators/cache.js

@@ -1,35 +1,3 @@
-import 'reflect-metadata';
-export const CacheSymbol = Symbol('@Cache');
-/**
- * Caches an effect's value
- */
-export function Cache(options) {
-    return (_target, property, descriptor) => {
-        const originalFn = descriptor.value;
-        if (originalFn) {
-            descriptor.value = function (...args) {
-                const root = this;
-                const cache = root[CacheSymbol];
-                // this can grow huge
-                // shall we put some sort of cap?
-                const key = options?.trackBy ? options.trackBy(...args) : JSON.stringify(args);
-                const id = `${property}:${key}`;
-                const cached = cache.get(id);
-                if (cached) {
-                    // check ttl given timestamp
-                    const timestamp = cached.timestamp;
-                    const now = Date.now();
-                    const ttl = now - timestamp;
-                    const maxTtl = options?.ttl || 300000; // 5 minutes
-                    if (ttl <= maxTtl) {
-                        const value = cached.value;
-                        return value;
-                    }
-                }
-                const retValue = originalFn.apply(this, args);
-                cache.set(id, { value: retValue, timestamp: Date.now() });
-                return retValue;
-            };
-        }
-    };
-}
+// `@Cache` lives in `@microphi/di` so that it can be used on any class.
+// It is re-exported here to keep the store's public API unchanged.
+export { Cache, CacheSymbol } from '@microphi/di';

package/lib/esm/lib/reduce/reduce.js

@@ -2,7 +2,7 @@ import 'reflect-metadata';
 import { scanInstance } from '../utilities/scan-instance';
 export const ReduceSymbol = Symbol('@Reduce');
 export function Reduce() {
-    return (target, propertyKey, descriptor) => {
+    return (target, propertyKey) => {
         // by convention a reducer have name such as onFindAll
         // where findAll is the associated action
         // with the following we extract the action's name

package/lib/esm/lib/store/store.d.ts

@@ -1,14 +1,11 @@
 import { BehaviorSubject, Observable, SchedulerLike } from 'rxjs';
 import { Effect } from '../effect/effect';
-import { CacheSymbol } from '../operators/cache';
+import { CacheMap, CacheSymbol } from '../operators/cache';
 import { Reducer } from '../reduce/reduce';
 import { getPayloadFromActionType, LoadingState } from './types';
 export declare abstract class Store<State, A> {
     private initialState;
-    protected [CacheSymbol]: Map<string, {
-        timestamp: number;
-        value: Observable<any>;
-    }>;
+    protected [CacheSymbol]: CacheMap;
     private readonly actions;
     readonly effects: Effect[];
     readonly reducers: Reducer[];
@@ -16,7 +13,7 @@ export declare abstract class Store<State, A> {
     get loading$(): Observable<LoadingState<A>>;
     protected readonly _store$: BehaviorSubject<State>;
     get state$(): Observable<State>;
-    constructor(initialState: State, scheduler?: SchedulerLike);
+    constructor(initialState: State, _scheduler?: SchedulerLike);
     select<R>(projection: (s: State) => R): Observable<R>;
     getLoadingFor<C extends keyof A>(action: C): Observable<boolean>;
     dispatch<C extends keyof A>(action: C, ...payload: getPayloadFromActionType<A, C>): void;

package/lib/esm/lib/store/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/store.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,eAAe,EAAS,UAAU,EAAM,aAAa,EAAW,MAAM,MAAM,CAAC;AAErG,OAAO,EAAE,MAAM,EAA8B,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,OAAO,EAAe,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAM,wBAAwB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGrE,8BAAsB,KAAK,CAAC,KAAK,EAAE,CAAC;IA0BtB,OAAO,CAAC,YAAY;IAxBhC,SAAS,CAAC,CAAC,WAAW,CAAC;mBAA+B,MAAM;eAAS,WAAW,GAAG,CAAC;OAAK;IAEzF,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoE;IAE5F,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAE3B,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAG7B,OAAO,CAAC,SAAS,CAAkC;IAEnD,IAAW,QAAQ,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAEjD;IAED,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAGhD;IAEF,IAAW,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAErC;gBAEmB,YAAY,EAAE,KAAK,EAAE,SAAS,GAAE,aAA6B;IAyFjF,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC;IAOrC,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;IAOhE,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,EACxB,MAAM,EAAE,CAAC,EACT,GAAG,OAAO,EAAE,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC;IAa5C,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG;IAIxC,OAAO,CAAC,MAAM,CAAC,WAAW;IAU1B,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,YAAY;CAarB"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/store.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,eAAe,EAAS,UAAU,EAAM,aAAa,EAAW,MAAM,MAAM,CAAC;AAErG,OAAO,EAAE,MAAM,EAA8B,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAG3D,OAAO,EAAe,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAM,wBAAwB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGrE,8BAAsB,KAAK,CAAC,KAAK,EAAE,CAAC;IA0BtB,OAAO,CAAC,YAAY;IAxBhC,SAAS,CAAC,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAa;IAE9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoE;IAE5F,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAE3B,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAG7B,OAAO,CAAC,SAAS,CAAkC;IAEnD,IAAW,QAAQ,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAEjD;IAED,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAGhD;IAEF,IAAW,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAErC;gBAEmB,YAAY,EAAE,KAAK,EAAE,UAAU,GAAE,aAA6B;IAyFlF,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC;IAOrC,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;IAOhE,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,EACxB,MAAM,EAAE,CAAC,EACT,GAAG,OAAO,EAAE,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC;IAa5C,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG;IAIxC,OAAO,CAAC,MAAM,CAAC,WAAW;IAU1B,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,YAAY;CAarB"}