dharma-core 0.9.1 → 0.10.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2025 Frans Ekman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./lib/createEffect";
 export * from "./lib/createStore";
 export * from "./lib/derive";
 export * from "./lib/merge";

package/dist/cjs/index.js

@@ -1,11 +1,13 @@
 'use strict';
 
+var createEffect = require('./lib/createEffect.js');
 var createStore = require('./lib/createStore.js');
 var derive = require('./lib/derive.js');
 var merge = require('./lib/merge.js');
 
 
 
+exports.createEffect = createEffect.createEffect;
 exports.createStore = createStore.createStore;
 exports.derive = derive.derive;
 exports.merge = merge.merge;

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}

package/dist/cjs/lib/createEffect.d.ts

@@ -0,0 +1,13 @@
+import { Effect, Store } from "../types/types";
+/**
+ * Creates an effect that runs when the store's state changes.
+ *
+ * @param store - The store instance to subscribe to
+ * @param effectFn - The function to run when dependencies change. Receives the current state as argument.
+ * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the effect will only run when these dependencies change.
+ *
+ * @returns An Effect object with mount and unmount methods
+ *
+ * @see {@link https://dharma.fransek.dev/core/createeffect/}
+ */
+export declare const createEffect: <TState, TActions, TDerived>(store: Store<TState, TActions>, effectFn: (state: TState) => TDerived, dependencyFn?: (state: TState) => unknown[]) => Effect;

package/dist/cjs/lib/createEffect.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var deeplyEquals = require('./deeplyEquals.js');
+
+/**
+ * Creates an effect that runs when the store's state changes.
+ *
+ * @param store - The store instance to subscribe to
+ * @param effectFn - The function to run when dependencies change. Receives the current state as argument.
+ * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the effect will only run when these dependencies change.
+ *
+ * @returns An Effect object with mount and unmount methods
+ *
+ * @see {@link https://dharma.fransek.dev/core/createeffect/}
+ */
+const createEffect = (store, effectFn, dependencyFn) => {
+    let prev;
+    let unsubscribe;
+    const execute = () => effectFn(store.get());
+    const effect = () => {
+        const next = dependencyFn?.(store.get());
+        if (!prev || !deeplyEquals.deeplyEquals(prev, next)) {
+            prev = next;
+            execute();
+        }
+    };
+    const mount = () => {
+        if (!unsubscribe) {
+            unsubscribe = store.subscribe(effect);
+        }
+        return unmount;
+    };
+    const unmount = () => {
+        unsubscribe?.();
+        unsubscribe = undefined;
+    };
+    return {
+        mount,
+        unmount,
+    };
+};
+
+exports.createEffect = createEffect;
+//# sourceMappingURL=createEffect.js.map

package/dist/cjs/lib/createEffect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createEffect.js","sources":["../../../src/lib/createEffect.ts"],"sourcesContent":["import { Effect, Store } from \"../types/types\";\nimport { deeplyEquals } from \"./deeplyEquals\";\n\n/**\n * Creates an effect that runs when the store's state changes.\n *\n * @param store - The store instance to subscribe to\n * @param effectFn - The function to run when dependencies change. Receives the current state as argument.\n * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the effect will only run when these dependencies change.\n *\n * @returns An Effect object with mount and unmount methods\n *\n * @see {@link https://dharma.fransek.dev/core/createeffect/}\n */\nexport const createEffect = <TState, TActions, TDerived>(\n  store: Store<TState, TActions>,\n  effectFn: (state: TState) => TDerived,\n  dependencyFn?: (state: TState) => unknown[],\n): Effect => {\n  let prev: unknown[] | undefined;\n  let unsubscribe: (() => void) | undefined;\n\n  const execute = () => effectFn(store.get());\n\n  const effect = () => {\n    const next = dependencyFn?.(store.get());\n\n    if (!prev || !deeplyEquals(prev, next)) {\n      prev = next;\n      execute();\n    }\n  };\n\n  const mount = () => {\n    if (!unsubscribe) {\n      unsubscribe = store.subscribe(effect);\n    }\n    return unmount;\n  };\n\n  const unmount = () => {\n    unsubscribe?.();\n    unsubscribe = undefined;\n  };\n\n  return {\n    mount,\n    unmount,\n  };\n};\n"],"names":["deeplyEquals"],"mappings":";;;;AAGA;;;;;;;;;;AAUG;AACI,MAAM,YAAY,GAAG,CAC1B,KAA8B,EAC9B,QAAqC,EACrC,YAA2C,KACjC;AACV,IAAA,IAAI,IAA2B;AAC/B,IAAA,IAAI,WAAqC;AAEzC,IAAA,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IAE3C,MAAM,MAAM,GAAG,MAAK;QAClB,MAAM,IAAI,GAAG,YAAY,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QAExC,IAAI,CAAC,IAAI,IAAI,CAACA,yBAAY,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;YACtC,IAAI,GAAG,IAAI;AACX,YAAA,OAAO,EAAE;QACX;AACF,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,MAAK;QACjB,IAAI,CAAC,WAAW,EAAE;AAChB,YAAA,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC;QACvC;AACA,QAAA,OAAO,OAAO;AAChB,IAAA,CAAC;IAED,MAAM,OAAO,GAAG,MAAK;QACnB,WAAW,IAAI;QACf,WAAW,GAAG,SAAS;AACzB,IAAA,CAAC;IAED,OAAO;QACL,KAAK;QACL,OAAO;KACR;AACH;;;;"}

package/dist/cjs/lib/derive.js

@@ -28,13 +28,7 @@ const derive = (store, deriveFn, dependencyFn) => {
         return memo;
     };
     const get = () => {
-        if (!dependencyFn) {
-            if (isStale) {
-                return compute();
-            }
-            return memo;
-        }
-        const next = dependencyFn(store.get());
+        const next = dependencyFn?.(store.get());
         isStale &&= !prev || !deeplyEquals.deeplyEquals(prev, next);
         if (isStale) {
             prev = next;
@@ -55,13 +49,15 @@ const derive = (store, deriveFn, dependencyFn) => {
             }
         };
     };
+    const listener = () => {
+        isStale = true;
+        listeners.forEach((listener) => listener(get()));
+    };
     const mount = () => {
         if (!unsubscribe) {
-            unsubscribe = store.subscribe(() => {
-                isStale = true;
-                listeners.forEach((listener) => listener(get()));
-            });
+            unsubscribe = store.subscribe(listener);
         }
+        return unmount;
     };
     const unmount = () => {
         unsubscribe?.();

package/dist/cjs/lib/derive.js.map

@@ -1 +1 @@
-{"version":3,"file":"derive.js","sources":["../../../src/lib/derive.ts"],"sourcesContent":["import { DerivedStore, Listener, Store } from \"../types/types\";\nimport { deeplyEquals } from \"./deeplyEquals\";\n\n/**\n * Creates a derived store from an existing store.\n *\n * A derived store computes its state based on the original store's state using a derive function.\n * The derived store's value is memoized and only recomputed when requested.\n *\n * @param store - The original store to derive from\n * @param deriveFn - A function that computes the derived state from the original state\n * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the derived state will only be recomputed when these dependencies change\n *\n * @returns A new store containing the derived state\n *\n * @see {@link https://dharma.fransek.dev/core/derive/}\n */\nexport const derive = <TState, TActions, TDerived>(\n  store: Store<TState, TActions>,\n  deriveFn: (state: TState) => TDerived,\n  dependencyFn?: (state: TState) => unknown[],\n): DerivedStore<TDerived> => {\n  let memo: TDerived | undefined;\n  let prev: unknown[] | undefined;\n  let isStale = true;\n  let unsubscribe: (() => void) | undefined;\n  const listeners = new Set<Listener<TDerived>>();\n\n  const compute = () => {\n    memo = deriveFn(store.get());\n    isStale = false;\n    return memo;\n  };\n\n  const get = () => {\n    if (!dependencyFn) {\n      if (isStale) {\n        return compute();\n      }\n\n      return memo as TDerived;\n    }\n\n    const next = dependencyFn(store.get());\n    isStale &&= !prev || !deeplyEquals(prev, next);\n\n    if (isStale) {\n      prev = next;\n      return compute();\n    }\n\n    return memo as TDerived;\n  };\n\n  const subscribe = (listener: Listener<TDerived>) => {\n    if (listeners.size === 0) {\n      mount();\n    }\n\n    listener(get());\n    listeners.add(listener);\n\n    return () => {\n      listeners.delete(listener);\n\n      if (listeners.size === 0) {\n        unmount();\n      }\n    };\n  };\n\n  const mount = () => {\n    if (!unsubscribe) {\n      unsubscribe = store.subscribe(() => {\n        isStale = true;\n        listeners.forEach((listener) => listener(get()));\n      });\n    }\n  };\n\n  const unmount = () => {\n    unsubscribe?.();\n    unsubscribe = undefined;\n  };\n\n  return {\n    get,\n    subscribe,\n    actions: {\n      mount,\n      unmount,\n    },\n  };\n};\n"],"names":["deeplyEquals"],"mappings":";;;;AAGA;;;;;;;;;;;;;AAaG;AACI,MAAM,MAAM,GAAG,CACpB,KAA8B,EAC9B,QAAqC,EACrC,YAA2C,KACjB;AAC1B,IAAA,IAAI,IAA0B;AAC9B,IAAA,IAAI,IAA2B;IAC/B,IAAI,OAAO,GAAG,IAAI;AAClB,IAAA,IAAI,WAAqC;AACzC,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAsB;IAE/C,MAAM,OAAO,GAAG,MAAK;QACnB,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,GAAG,KAAK;AACf,QAAA,OAAO,IAAI;AACb,IAAA,CAAC;IAED,MAAM,GAAG,GAAG,MAAK;QACf,IAAI,CAAC,YAAY,EAAE;YACjB,IAAI,OAAO,EAAE;gBACX,OAAO,OAAO,EAAE;YAClB;AAEA,YAAA,OAAO,IAAgB;QACzB;QAEA,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC,IAAI,IAAI,CAACA,yBAAY,CAAC,IAAI,EAAE,IAAI,CAAC;QAE9C,IAAI,OAAO,EAAE;YACX,IAAI,GAAG,IAAI;YACX,OAAO,OAAO,EAAE;QAClB;AAEA,QAAA,OAAO,IAAgB;AACzB,IAAA,CAAC;AAED,IAAA,MAAM,SAAS,GAAG,CAAC,QAA4B,KAAI;AACjD,QAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,YAAA,KAAK,EAAE;QACT;AAEA,QAAA,QAAQ,CAAC,GAAG,EAAE,CAAC;AACf,QAAA,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC;AAEvB,QAAA,OAAO,MAAK;AACV,YAAA,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC;AAE1B,YAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,gBAAA,OAAO,EAAE;YACX;AACF,QAAA,CAAC;AACH,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,MAAK;QACjB,IAAI,CAAC,WAAW,EAAE;AAChB,YAAA,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,MAAK;gBACjC,OAAO,GAAG,IAAI;AACd,gBAAA,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;AAClD,YAAA,CAAC,CAAC;QACJ;AACF,IAAA,CAAC;IAED,MAAM,OAAO,GAAG,MAAK;QACnB,WAAW,IAAI;QACf,WAAW,GAAG,SAAS;AACzB,IAAA,CAAC;IAED,OAAO;QACL,GAAG;QACH,SAAS;AACT,QAAA,OAAO,EAAE;YACP,KAAK;YACL,OAAO;AACR,SAAA;KACF;AACH;;;;"}
+{"version":3,"file":"derive.js","sources":["../../../src/lib/derive.ts"],"sourcesContent":["import { DerivedStore, Listener, Store } from \"../types/types\";\nimport { deeplyEquals } from \"./deeplyEquals\";\n\n/**\n * Creates a derived store from an existing store.\n *\n * A derived store computes its state based on the original store's state using a derive function.\n * The derived store's value is memoized and only recomputed when requested.\n *\n * @param store - The original store to derive from\n * @param deriveFn - A function that computes the derived state from the original state\n * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the derived state will only be recomputed when these dependencies change\n *\n * @returns A new store containing the derived state\n *\n * @see {@link https://dharma.fransek.dev/core/derive/}\n */\nexport const derive = <TState, TActions, TDerived>(\n  store: Store<TState, TActions>,\n  deriveFn: (state: TState) => TDerived,\n  dependencyFn?: (state: TState) => unknown[],\n): DerivedStore<TDerived> => {\n  let memo: TDerived | undefined;\n  let prev: unknown[] | undefined;\n  let isStale = true;\n  let unsubscribe: (() => void) | undefined;\n  const listeners = new Set<Listener<TDerived>>();\n\n  const compute = () => {\n    memo = deriveFn(store.get());\n    isStale = false;\n    return memo;\n  };\n\n  const get = () => {\n    const next = dependencyFn?.(store.get());\n    isStale &&= !prev || !deeplyEquals(prev, next);\n\n    if (isStale) {\n      prev = next;\n      return compute();\n    }\n\n    return memo as TDerived;\n  };\n\n  const subscribe = (listener: Listener<TDerived>) => {\n    if (listeners.size === 0) {\n      mount();\n    }\n\n    listener(get());\n    listeners.add(listener);\n\n    return () => {\n      listeners.delete(listener);\n\n      if (listeners.size === 0) {\n        unmount();\n      }\n    };\n  };\n\n  const listener = () => {\n    isStale = true;\n    listeners.forEach((listener) => listener(get()));\n  };\n\n  const mount = () => {\n    if (!unsubscribe) {\n      unsubscribe = store.subscribe(listener);\n    }\n    return unmount;\n  };\n\n  const unmount = () => {\n    unsubscribe?.();\n    unsubscribe = undefined;\n  };\n\n  return {\n    get,\n    subscribe,\n    actions: {\n      mount,\n      unmount,\n    },\n  };\n};\n"],"names":["deeplyEquals"],"mappings":";;;;AAGA;;;;;;;;;;;;;AAaG;AACI,MAAM,MAAM,GAAG,CACpB,KAA8B,EAC9B,QAAqC,EACrC,YAA2C,KACjB;AAC1B,IAAA,IAAI,IAA0B;AAC9B,IAAA,IAAI,IAA2B;IAC/B,IAAI,OAAO,GAAG,IAAI;AAClB,IAAA,IAAI,WAAqC;AACzC,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAsB;IAE/C,MAAM,OAAO,GAAG,MAAK;QACnB,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,GAAG,KAAK;AACf,QAAA,OAAO,IAAI;AACb,IAAA,CAAC;IAED,MAAM,GAAG,GAAG,MAAK;QACf,MAAM,IAAI,GAAG,YAAY,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC,IAAI,IAAI,CAACA,yBAAY,CAAC,IAAI,EAAE,IAAI,CAAC;QAE9C,IAAI,OAAO,EAAE;YACX,IAAI,GAAG,IAAI;YACX,OAAO,OAAO,EAAE;QAClB;AAEA,QAAA,OAAO,IAAgB;AACzB,IAAA,CAAC;AAED,IAAA,MAAM,SAAS,GAAG,CAAC,QAA4B,KAAI;AACjD,QAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,YAAA,KAAK,EAAE;QACT;AAEA,QAAA,QAAQ,CAAC,GAAG,EAAE,CAAC;AACf,QAAA,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC;AAEvB,QAAA,OAAO,MAAK;AACV,YAAA,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC;AAE1B,YAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,gBAAA,OAAO,EAAE;YACX;AACF,QAAA,CAAC;AACH,IAAA,CAAC;IAED,MAAM,QAAQ,GAAG,MAAK;QACpB,OAAO,GAAG,IAAI;AACd,QAAA,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;AAClD,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,MAAK;QACjB,IAAI,CAAC,WAAW,EAAE;AAChB,YAAA,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC;QACzC;AACA,QAAA,OAAO,OAAO;AAChB,IAAA,CAAC;IAED,MAAM,OAAO,GAAG,MAAK;QACnB,WAAW,IAAI;QACf,WAAW,GAAG,SAAS;AACzB,IAAA,CAAC;IAED,OAAO;QACL,GAAG;QACH,SAAS;AACT,QAAA,OAAO,EAAE;YACP,KAAK;YACL,OAAO;AACR,SAAA;KACF;AACH;;;;"}

package/dist/cjs/types/types.d.ts

@@ -10,11 +10,17 @@ export type Store<TState, TActions> = {
 };
 export type DerivedStoreActions = {
     /** Start listening to changes in the original store. Called automatically on the first subscription. */
-    mount: () => void;
+    mount: () => () => void;
     /** Stop listening to changes in the original store. Called automatically when there are no more subscribers. */
     unmount: () => void;
 };
 export type DerivedStore<TState> = Store<TState, DerivedStoreActions>;
+export type Effect = {
+    /** Start listening to changes in the original store. */
+    mount: () => () => void;
+    /** Stop listening to changes in the original store. */
+    unmount: () => void;
+};
 export type StoreEventContext<TState> = {
     /** The current state of the store. */
     state: TState;

package/dist/esm/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./lib/createEffect";
 export * from "./lib/createStore";
 export * from "./lib/derive";
 export * from "./lib/merge";

package/dist/esm/index.js

@@ -1,3 +1,4 @@
+export { createEffect } from './lib/createEffect.js';
 export { createStore } from './lib/createStore.js';
 export { derive } from './lib/derive.js';
 export { merge } from './lib/merge.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/dist/esm/lib/createEffect.d.ts

@@ -0,0 +1,13 @@
+import { Effect, Store } from "../types/types";
+/**
+ * Creates an effect that runs when the store's state changes.
+ *
+ * @param store - The store instance to subscribe to
+ * @param effectFn - The function to run when dependencies change. Receives the current state as argument.
+ * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the effect will only run when these dependencies change.
+ *
+ * @returns An Effect object with mount and unmount methods
+ *
+ * @see {@link https://dharma.fransek.dev/core/createeffect/}
+ */
+export declare const createEffect: <TState, TActions, TDerived>(store: Store<TState, TActions>, effectFn: (state: TState) => TDerived, dependencyFn?: (state: TState) => unknown[]) => Effect;

package/dist/esm/lib/createEffect.js

@@ -0,0 +1,42 @@
+import { deeplyEquals } from './deeplyEquals.js';
+
+/**
+ * Creates an effect that runs when the store's state changes.
+ *
+ * @param store - The store instance to subscribe to
+ * @param effectFn - The function to run when dependencies change. Receives the current state as argument.
+ * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the effect will only run when these dependencies change.
+ *
+ * @returns An Effect object with mount and unmount methods
+ *
+ * @see {@link https://dharma.fransek.dev/core/createeffect/}
+ */
+const createEffect = (store, effectFn, dependencyFn) => {
+    let prev;
+    let unsubscribe;
+    const execute = () => effectFn(store.get());
+    const effect = () => {
+        const next = dependencyFn?.(store.get());
+        if (!prev || !deeplyEquals(prev, next)) {
+            prev = next;
+            execute();
+        }
+    };
+    const mount = () => {
+        if (!unsubscribe) {
+            unsubscribe = store.subscribe(effect);
+        }
+        return unmount;
+    };
+    const unmount = () => {
+        unsubscribe?.();
+        unsubscribe = undefined;
+    };
+    return {
+        mount,
+        unmount,
+    };
+};
+
+export { createEffect };
+//# sourceMappingURL=createEffect.js.map

package/dist/esm/lib/createEffect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createEffect.js","sources":["../../../src/lib/createEffect.ts"],"sourcesContent":["import { Effect, Store } from \"../types/types\";\nimport { deeplyEquals } from \"./deeplyEquals\";\n\n/**\n * Creates an effect that runs when the store's state changes.\n *\n * @param store - The store instance to subscribe to\n * @param effectFn - The function to run when dependencies change. Receives the current state as argument.\n * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the effect will only run when these dependencies change.\n *\n * @returns An Effect object with mount and unmount methods\n *\n * @see {@link https://dharma.fransek.dev/core/createeffect/}\n */\nexport const createEffect = <TState, TActions, TDerived>(\n  store: Store<TState, TActions>,\n  effectFn: (state: TState) => TDerived,\n  dependencyFn?: (state: TState) => unknown[],\n): Effect => {\n  let prev: unknown[] | undefined;\n  let unsubscribe: (() => void) | undefined;\n\n  const execute = () => effectFn(store.get());\n\n  const effect = () => {\n    const next = dependencyFn?.(store.get());\n\n    if (!prev || !deeplyEquals(prev, next)) {\n      prev = next;\n      execute();\n    }\n  };\n\n  const mount = () => {\n    if (!unsubscribe) {\n      unsubscribe = store.subscribe(effect);\n    }\n    return unmount;\n  };\n\n  const unmount = () => {\n    unsubscribe?.();\n    unsubscribe = undefined;\n  };\n\n  return {\n    mount,\n    unmount,\n  };\n};\n"],"names":[],"mappings":";;AAGA;;;;;;;;;;AAUG;AACI,MAAM,YAAY,GAAG,CAC1B,KAA8B,EAC9B,QAAqC,EACrC,YAA2C,KACjC;AACV,IAAA,IAAI,IAA2B;AAC/B,IAAA,IAAI,WAAqC;AAEzC,IAAA,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IAE3C,MAAM,MAAM,GAAG,MAAK;QAClB,MAAM,IAAI,GAAG,YAAY,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QAExC,IAAI,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;YACtC,IAAI,GAAG,IAAI;AACX,YAAA,OAAO,EAAE;QACX;AACF,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,MAAK;QACjB,IAAI,CAAC,WAAW,EAAE;AAChB,YAAA,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC;QACvC;AACA,QAAA,OAAO,OAAO;AAChB,IAAA,CAAC;IAED,MAAM,OAAO,GAAG,MAAK;QACnB,WAAW,IAAI;QACf,WAAW,GAAG,SAAS;AACzB,IAAA,CAAC;IAED,OAAO;QACL,KAAK;QACL,OAAO;KACR;AACH;;;;"}

package/dist/esm/lib/derive.js

@@ -26,13 +26,7 @@ const derive = (store, deriveFn, dependencyFn) => {
         return memo;
     };
     const get = () => {
-        if (!dependencyFn) {
-            if (isStale) {
-                return compute();
-            }
-            return memo;
-        }
-        const next = dependencyFn(store.get());
+        const next = dependencyFn?.(store.get());
         isStale &&= !prev || !deeplyEquals(prev, next);
         if (isStale) {
             prev = next;
@@ -53,13 +47,15 @@ const derive = (store, deriveFn, dependencyFn) => {
             }
         };
     };
+    const listener = () => {
+        isStale = true;
+        listeners.forEach((listener) => listener(get()));
+    };
     const mount = () => {
         if (!unsubscribe) {
-            unsubscribe = store.subscribe(() => {
-                isStale = true;
-                listeners.forEach((listener) => listener(get()));
-            });
+            unsubscribe = store.subscribe(listener);
         }
+        return unmount;
     };
     const unmount = () => {
         unsubscribe?.();

package/dist/esm/lib/derive.js.map

@@ -1 +1 @@
-{"version":3,"file":"derive.js","sources":["../../../src/lib/derive.ts"],"sourcesContent":["import { DerivedStore, Listener, Store } from \"../types/types\";\nimport { deeplyEquals } from \"./deeplyEquals\";\n\n/**\n * Creates a derived store from an existing store.\n *\n * A derived store computes its state based on the original store's state using a derive function.\n * The derived store's value is memoized and only recomputed when requested.\n *\n * @param store - The original store to derive from\n * @param deriveFn - A function that computes the derived state from the original state\n * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the derived state will only be recomputed when these dependencies change\n *\n * @returns A new store containing the derived state\n *\n * @see {@link https://dharma.fransek.dev/core/derive/}\n */\nexport const derive = <TState, TActions, TDerived>(\n  store: Store<TState, TActions>,\n  deriveFn: (state: TState) => TDerived,\n  dependencyFn?: (state: TState) => unknown[],\n): DerivedStore<TDerived> => {\n  let memo: TDerived | undefined;\n  let prev: unknown[] | undefined;\n  let isStale = true;\n  let unsubscribe: (() => void) | undefined;\n  const listeners = new Set<Listener<TDerived>>();\n\n  const compute = () => {\n    memo = deriveFn(store.get());\n    isStale = false;\n    return memo;\n  };\n\n  const get = () => {\n    if (!dependencyFn) {\n      if (isStale) {\n        return compute();\n      }\n\n      return memo as TDerived;\n    }\n\n    const next = dependencyFn(store.get());\n    isStale &&= !prev || !deeplyEquals(prev, next);\n\n    if (isStale) {\n      prev = next;\n      return compute();\n    }\n\n    return memo as TDerived;\n  };\n\n  const subscribe = (listener: Listener<TDerived>) => {\n    if (listeners.size === 0) {\n      mount();\n    }\n\n    listener(get());\n    listeners.add(listener);\n\n    return () => {\n      listeners.delete(listener);\n\n      if (listeners.size === 0) {\n        unmount();\n      }\n    };\n  };\n\n  const mount = () => {\n    if (!unsubscribe) {\n      unsubscribe = store.subscribe(() => {\n        isStale = true;\n        listeners.forEach((listener) => listener(get()));\n      });\n    }\n  };\n\n  const unmount = () => {\n    unsubscribe?.();\n    unsubscribe = undefined;\n  };\n\n  return {\n    get,\n    subscribe,\n    actions: {\n      mount,\n      unmount,\n    },\n  };\n};\n"],"names":[],"mappings":";;AAGA;;;;;;;;;;;;;AAaG;AACI,MAAM,MAAM,GAAG,CACpB,KAA8B,EAC9B,QAAqC,EACrC,YAA2C,KACjB;AAC1B,IAAA,IAAI,IAA0B;AAC9B,IAAA,IAAI,IAA2B;IAC/B,IAAI,OAAO,GAAG,IAAI;AAClB,IAAA,IAAI,WAAqC;AACzC,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAsB;IAE/C,MAAM,OAAO,GAAG,MAAK;QACnB,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,GAAG,KAAK;AACf,QAAA,OAAO,IAAI;AACb,IAAA,CAAC;IAED,MAAM,GAAG,GAAG,MAAK;QACf,IAAI,CAAC,YAAY,EAAE;YACjB,IAAI,OAAO,EAAE;gBACX,OAAO,OAAO,EAAE;YAClB;AAEA,YAAA,OAAO,IAAgB;QACzB;QAEA,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC;QAE9C,IAAI,OAAO,EAAE;YACX,IAAI,GAAG,IAAI;YACX,OAAO,OAAO,EAAE;QAClB;AAEA,QAAA,OAAO,IAAgB;AACzB,IAAA,CAAC;AAED,IAAA,MAAM,SAAS,GAAG,CAAC,QAA4B,KAAI;AACjD,QAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,YAAA,KAAK,EAAE;QACT;AAEA,QAAA,QAAQ,CAAC,GAAG,EAAE,CAAC;AACf,QAAA,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC;AAEvB,QAAA,OAAO,MAAK;AACV,YAAA,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC;AAE1B,YAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,gBAAA,OAAO,EAAE;YACX;AACF,QAAA,CAAC;AACH,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,MAAK;QACjB,IAAI,CAAC,WAAW,EAAE;AAChB,YAAA,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,MAAK;gBACjC,OAAO,GAAG,IAAI;AACd,gBAAA,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;AAClD,YAAA,CAAC,CAAC;QACJ;AACF,IAAA,CAAC;IAED,MAAM,OAAO,GAAG,MAAK;QACnB,WAAW,IAAI;QACf,WAAW,GAAG,SAAS;AACzB,IAAA,CAAC;IAED,OAAO;QACL,GAAG;QACH,SAAS;AACT,QAAA,OAAO,EAAE;YACP,KAAK;YACL,OAAO;AACR,SAAA;KACF;AACH;;;;"}
+{"version":3,"file":"derive.js","sources":["../../../src/lib/derive.ts"],"sourcesContent":["import { DerivedStore, Listener, Store } from \"../types/types\";\nimport { deeplyEquals } from \"./deeplyEquals\";\n\n/**\n * Creates a derived store from an existing store.\n *\n * A derived store computes its state based on the original store's state using a derive function.\n * The derived store's value is memoized and only recomputed when requested.\n *\n * @param store - The original store to derive from\n * @param deriveFn - A function that computes the derived state from the original state\n * @param dependencyFn - Optional function that returns an array of dependencies. If provided, the derived state will only be recomputed when these dependencies change\n *\n * @returns A new store containing the derived state\n *\n * @see {@link https://dharma.fransek.dev/core/derive/}\n */\nexport const derive = <TState, TActions, TDerived>(\n  store: Store<TState, TActions>,\n  deriveFn: (state: TState) => TDerived,\n  dependencyFn?: (state: TState) => unknown[],\n): DerivedStore<TDerived> => {\n  let memo: TDerived | undefined;\n  let prev: unknown[] | undefined;\n  let isStale = true;\n  let unsubscribe: (() => void) | undefined;\n  const listeners = new Set<Listener<TDerived>>();\n\n  const compute = () => {\n    memo = deriveFn(store.get());\n    isStale = false;\n    return memo;\n  };\n\n  const get = () => {\n    const next = dependencyFn?.(store.get());\n    isStale &&= !prev || !deeplyEquals(prev, next);\n\n    if (isStale) {\n      prev = next;\n      return compute();\n    }\n\n    return memo as TDerived;\n  };\n\n  const subscribe = (listener: Listener<TDerived>) => {\n    if (listeners.size === 0) {\n      mount();\n    }\n\n    listener(get());\n    listeners.add(listener);\n\n    return () => {\n      listeners.delete(listener);\n\n      if (listeners.size === 0) {\n        unmount();\n      }\n    };\n  };\n\n  const listener = () => {\n    isStale = true;\n    listeners.forEach((listener) => listener(get()));\n  };\n\n  const mount = () => {\n    if (!unsubscribe) {\n      unsubscribe = store.subscribe(listener);\n    }\n    return unmount;\n  };\n\n  const unmount = () => {\n    unsubscribe?.();\n    unsubscribe = undefined;\n  };\n\n  return {\n    get,\n    subscribe,\n    actions: {\n      mount,\n      unmount,\n    },\n  };\n};\n"],"names":[],"mappings":";;AAGA;;;;;;;;;;;;;AAaG;AACI,MAAM,MAAM,GAAG,CACpB,KAA8B,EAC9B,QAAqC,EACrC,YAA2C,KACjB;AAC1B,IAAA,IAAI,IAA0B;AAC9B,IAAA,IAAI,IAA2B;IAC/B,IAAI,OAAO,GAAG,IAAI;AAClB,IAAA,IAAI,WAAqC;AACzC,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAsB;IAE/C,MAAM,OAAO,GAAG,MAAK;QACnB,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,GAAG,KAAK;AACf,QAAA,OAAO,IAAI;AACb,IAAA,CAAC;IAED,MAAM,GAAG,GAAG,MAAK;QACf,MAAM,IAAI,GAAG,YAAY,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC;QAE9C,IAAI,OAAO,EAAE;YACX,IAAI,GAAG,IAAI;YACX,OAAO,OAAO,EAAE;QAClB;AAEA,QAAA,OAAO,IAAgB;AACzB,IAAA,CAAC;AAED,IAAA,MAAM,SAAS,GAAG,CAAC,QAA4B,KAAI;AACjD,QAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,YAAA,KAAK,EAAE;QACT;AAEA,QAAA,QAAQ,CAAC,GAAG,EAAE,CAAC;AACf,QAAA,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC;AAEvB,QAAA,OAAO,MAAK;AACV,YAAA,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC;AAE1B,YAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,gBAAA,OAAO,EAAE;YACX;AACF,QAAA,CAAC;AACH,IAAA,CAAC;IAED,MAAM,QAAQ,GAAG,MAAK;QACpB,OAAO,GAAG,IAAI;AACd,QAAA,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;AAClD,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,MAAK;QACjB,IAAI,CAAC,WAAW,EAAE;AAChB,YAAA,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC;QACzC;AACA,QAAA,OAAO,OAAO;AAChB,IAAA,CAAC;IAED,MAAM,OAAO,GAAG,MAAK;QACnB,WAAW,IAAI;QACf,WAAW,GAAG,SAAS;AACzB,IAAA,CAAC;IAED,OAAO;QACL,GAAG;QACH,SAAS;AACT,QAAA,OAAO,EAAE;YACP,KAAK;YACL,OAAO;AACR,SAAA;KACF;AACH;;;;"}

package/dist/esm/types/types.d.ts

@@ -10,11 +10,17 @@ export type Store<TState, TActions> = {
 };
 export type DerivedStoreActions = {
     /** Start listening to changes in the original store. Called automatically on the first subscription. */
-    mount: () => void;
+    mount: () => () => void;
     /** Stop listening to changes in the original store. Called automatically when there are no more subscribers. */
     unmount: () => void;
 };
 export type DerivedStore<TState> = Store<TState, DerivedStoreActions>;
+export type Effect = {
+    /** Start listening to changes in the original store. */
+    mount: () => () => void;
+    /** Stop listening to changes in the original store. */
+    unmount: () => void;
+};
 export type StoreEventContext<TState> = {
     /** The current state of the store. */
     state: TState;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "dharma-core",
-  "version": "0.9.1",
+  "version": "0.10.1",
   "author": "Frans Ekman <fransedvinekman@gmail.com>",
   "license": "MIT",
-  "description": "My package description",
+  "description": "A simple and lightweight state management solution for JavaScript and TypeScript applications.",
   "keywords": [],
   "homepage": "https://github.com/fransek/dharma/tree/main/packages/dharma-core#readme",
   "repository": {