dharma-core 0.3.0 → 0.5.0

package/README.md

@@ -1 +1,32 @@
-# Dharma Core
+# dharma-core
+
+[![Version](https://img.shields.io/npm/v/dharma-core)](https://npmjs.com/package/dharma-core)
+[![Downloads](https://img.shields.io/npm/dm/dharma-core.svg)](https://npmjs.com/package/dharma-core)
+[![Minzipped size](https://img.shields.io/bundlephobia/minzip/dharma-core)](https://bundlephobia.com/package/dharma-core)
+
+A simple and lightweight state management solution for JavaScript and TypeScript applications.
+
+## Basic usage
+
+```ts
+import { createStore } from "dharma-core";
+
+const store = createStore({
+  initialState: { count: 0 },
+  defineActions: ({ set }) => ({
+    increment: () => set((state) => ({ count: state.count + 1 })),
+    decrement: () => set((state) => ({ count: state.count - 1 })),
+  }),
+});
+
+const { increment, decrement } = store.actions;
+
+// Subscribe to state changes
+const unsubscribe = store.subscribe((state) => console.log(state.count));
+// Update the state
+increment();
+// { count: 1 }
+decrement();
+// { count: 0 }
+unsubscribe();
+```

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

@@ -1,4 +1,4 @@
-import { DefineActions, Store, StoreOptions } from "./createStore";
+import { Store, StoreConfiguration } from "./createStore";
 export type StorageAPI = {
     getItem: (key: string) => string | null;
     setItem: (key: string, value: string) => void;
@@ -8,9 +8,10 @@ export type Serializer<T = any> = {
     stringify: (value: T) => string;
     parse: (value: string) => T;
 };
-export type PersistentStoreOptions<TState extends object> = StoreOptions<TState> & {
-    /** The storage to use for persisting the state. Defaults to local storage. */
-    storage?: StorageAPI | "local" | "session";
+export type PersistentStoreConfiguration<TState extends object, TActions extends object> = StoreConfiguration<TState, TActions> & {
+    key: string;
+    /** The storage to use for persisting the state. Defaults to local storage if available. */
+    storage?: StorageAPI;
     /** The serializer to use for storing the state. Defaults to JSON. */
     serializer?: Serializer<TState>;
 };
@@ -21,10 +22,7 @@ export type PersistentStoreOptions<TState extends object> = StoreOptions<TState>
  * **Note:** The state needs to be serializable by whatever serializer you use. (JSON by default)
  * If you need something more versatile I would recommend using a library like [superjson](https://github.com/flightcontrolhq/superjson).
  *
- * @param {string} key - A unique key to identify the store in storage.
- * @param {TState} initialState - The initial state of the store.
- * @param {DefineActions<TState, TActions>} [defineActions] - A function to define actions for the store.
- * @param {PersistentStoreOptions<TState>} [options] - Additional options for the persistent store.
+ * @param {PersistentStoreConfiguration<TState, TActions>} config - The configuration for the persistent store.
  *
  * @returns {Store<TState, TActions>} The created store.
  *
@@ -33,11 +31,15 @@ export type PersistentStoreOptions<TState extends object> = StoreOptions<TState>
  * ```ts
  * import { createPersistentStore } from "dharma-core";
  *
- * const store = createPersistentStore("count", { count: 0 }, (set) => ({
- *   increment: () => set((state) => ({ count: state.count + 1 })),
- *   decrement: () => set((state) => ({ count: state.count - 1 })),
- *   reset: () => set({ count: 0 }),
- * }));
+ * const store = createPersistentStore({
+ *   key: "count",
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
+ *     increment: () => set((state) => ({ count: state.count + 1 })),
+ *     decrement: () => set((state) => ({ count: state.count - 1 })),
+ *     reset: () => set({ count: 0 }),
+ *   }),
+ * });
  * ```
  * @example
  * With superjson serialization and session storage:
@@ -45,20 +47,17 @@ export type PersistentStoreOptions<TState extends object> = StoreOptions<TState>
  * import { createPersistentStore } from "dharma-core";
  * import superjson from "superjson";
  *
- * const store = createPersistentStore(
- *   "count",
- *   { count: 0 },
- *   (set) => ({
+ * const store = createPersistentStore({
+ *   key: "count",
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
  *     increment: () => set((state) => ({ count: state.count + 1 })),
  *     decrement: () => set((state) => ({ count: state.count - 1 })),
  *     reset: () => set({ count: 0 }),
  *   }),
- *   {
- *     serializer: superjson,
- *     storage: "session",
- *   },
- * );
+ *   serializer: superjson,
+ *   storage: sessionStorage,
+ * });
  * ```
- * @group Core
  */
-export declare const createPersistentStore: <TState extends object, TActions extends object = Record<never, never>>(key: string, initialState: TState, defineActions: DefineActions<TState, TActions>, { storage: _storage, serializer, onAttach, onDetach, onChange, ...options }?: PersistentStoreOptions<TState>) => Store<TState, TActions>;
+export declare const createPersistentStore: <TState extends object, TActions extends object = Record<never, never>>(config: PersistentStoreConfiguration<TState, TActions>) => Store<TState, TActions>;

package/dist/cjs/lib/createPersistentStore.js

@@ -9,10 +9,7 @@ var createStore = require('./createStore.js');
  * **Note:** The state needs to be serializable by whatever serializer you use. (JSON by default)
  * If you need something more versatile I would recommend using a library like [superjson](https://github.com/flightcontrolhq/superjson).
  *
- * @param {string} key - A unique key to identify the store in storage.
- * @param {TState} initialState - The initial state of the store.
- * @param {DefineActions<TState, TActions>} [defineActions] - A function to define actions for the store.
- * @param {PersistentStoreOptions<TState>} [options] - Additional options for the persistent store.
+ * @param {PersistentStoreConfiguration<TState, TActions>} config - The configuration for the persistent store.
  *
  * @returns {Store<TState, TActions>} The created store.
  *
@@ -21,11 +18,15 @@ var createStore = require('./createStore.js');
  * ```ts
  * import { createPersistentStore } from "dharma-core";
  *
- * const store = createPersistentStore("count", { count: 0 }, (set) => ({
- *   increment: () => set((state) => ({ count: state.count + 1 })),
- *   decrement: () => set((state) => ({ count: state.count - 1 })),
- *   reset: () => set({ count: 0 }),
- * }));
+ * const store = createPersistentStore({
+ *   key: "count",
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
+ *     increment: () => set((state) => ({ count: state.count + 1 })),
+ *     decrement: () => set((state) => ({ count: state.count - 1 })),
+ *     reset: () => set({ count: 0 }),
+ *   }),
+ * });
  * ```
  * @example
  * With superjson serialization and session storage:
@@ -33,77 +34,70 @@ var createStore = require('./createStore.js');
  * import { createPersistentStore } from "dharma-core";
  * import superjson from "superjson";
  *
- * const store = createPersistentStore(
- *   "count",
- *   { count: 0 },
- *   (set) => ({
+ * const store = createPersistentStore({
+ *   key: "count",
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
  *     increment: () => set((state) => ({ count: state.count + 1 })),
  *     decrement: () => set((state) => ({ count: state.count - 1 })),
  *     reset: () => set({ count: 0 }),
  *   }),
- *   {
- *     serializer: superjson,
- *     storage: "session",
- *   },
- * );
+ *   serializer: superjson,
+ *   storage: sessionStorage,
+ * });
  * ```
- * @group Core
  */
-const createPersistentStore = (key, initialState, defineActions, { storage: _storage = "local", serializer = JSON, onAttach, onDetach, onChange, ...options } = {}) => {
-    if (typeof window === "undefined") {
-        return createStore.createStore(initialState, defineActions, options);
+const createPersistentStore = (config) => {
+    const { key, initialState, storage: customStorage, serializer = JSON, onAttach, onDetach, onChange, ...rest } = config;
+    const IS_BROWSER = typeof window !== "undefined";
+    const storage = customStorage ?? (IS_BROWSER ? localStorage : undefined);
+    if (!storage) {
+        return createStore.createStore(config);
     }
-    const storage = getStorage(_storage);
-    const stateKey = `store_${key}`;
     const initialStateKey = `init_${key}`;
     const initialStateSnapshot = storage.getItem(initialStateKey);
     const initialStateString = serializer.stringify(initialState);
     if (initialStateSnapshot !== initialStateString) {
         storage.setItem(initialStateKey, initialStateString);
-        storage.removeItem(stateKey);
+        storage.removeItem(key);
     }
     const updateSnapshot = (newState) => {
-        const currentSnapshot = storage.getItem(stateKey);
+        const currentSnapshot = storage.getItem(key);
         const newSnapshot = serializer.stringify(newState);
         if (newSnapshot !== currentSnapshot) {
-            storage.setItem(stateKey, newSnapshot);
+            storage.setItem(key, newSnapshot);
         }
     };
     const updateState = () => {
-        const currentSnapshot = storage.getItem(stateKey);
+        const currentSnapshot = storage.getItem(key);
         if (currentSnapshot &&
             currentSnapshot !== serializer.stringify(store.get())) {
             store.set(serializer.parse(currentSnapshot));
         }
     };
-    const store = createStore.createStore(initialState, defineActions, {
-        onAttach: (...args) => {
-            onAttach?.(...args);
+    const store = createStore.createStore({
+        initialState,
+        onAttach: (ctx) => {
+            onAttach?.(ctx);
             updateState();
-            window.addEventListener("focus", updateState);
+            if (IS_BROWSER) {
+                window.addEventListener("focus", updateState);
+            }
         },
-        onDetach: (...args) => {
-            onDetach?.(...args);
-            window.removeEventListener("focus", updateState);
+        onDetach: (ctx) => {
+            onDetach?.(ctx);
+            if (IS_BROWSER) {
+                window.removeEventListener("focus", updateState);
+            }
         },
-        onChange: (state, ...args) => {
-            onChange?.(state, ...args);
+        onChange: ({ state, ...ctx }) => {
+            onChange?.({ state, ...ctx });
             updateSnapshot(state);
         },
-        ...options,
+        ...rest,
     });
     return store;
 };
-const getStorage = (storage) => {
-    switch (storage) {
-        case "local":
-            return localStorage;
-        case "session":
-            return sessionStorage;
-        default:
-            return storage;
-    }
-};
 
 exports.createPersistentStore = createPersistentStore;
 //# sourceMappingURL=createPersistentStore.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"createPersistentStore.js","sources":["../../../src/lib/createPersistentStore.ts"],"sourcesContent":["import { createStore, DefineActions, Store, StoreOptions } from \"./createStore\";\n\nexport type StorageAPI = {\n  getItem: (key: string) => string | null;\n  setItem: (key: string, value: string) => void;\n  removeItem: (key: string) => void;\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type Serializer<T = any> = {\n  stringify: (value: T) => string;\n  parse: (value: string) => T;\n};\n\nexport type PersistentStoreOptions<TState extends object> =\n  StoreOptions<TState> & {\n    /** The storage to use for persisting the state. Defaults to local storage. */\n    storage?: StorageAPI | \"local\" | \"session\";\n    /** The serializer to use for storing the state. Defaults to JSON. */\n    serializer?: Serializer<TState>;\n  };\n\n/**\n * Creates a store that persists its state in local or session storage.\n * Defaults to local storage but this can be changed in the options.\n *\n * **Note:** The state needs to be serializable by whatever serializer you use. (JSON by default)\n * If you need something more versatile I would recommend using a library like [superjson](https://github.com/flightcontrolhq/superjson).\n *\n * @param {string} key - A unique key to identify the store in storage.\n * @param {TState} initialState - The initial state of the store.\n * @param {DefineActions<TState, TActions>} [defineActions] - A function to define actions for the store.\n * @param {PersistentStoreOptions<TState>} [options] - Additional options for the persistent store.\n *\n * @returns {Store<TState, TActions>} The created store.\n *\n * @example\n * Basic usage:\n * ```ts\n * import { createPersistentStore } from \"dharma-core\";\n *\n * const store = createPersistentStore(\"count\", { count: 0 }, (set) => ({\n *   increment: () => set((state) => ({ count: state.count + 1 })),\n *   decrement: () => set((state) => ({ count: state.count - 1 })),\n *   reset: () => set({ count: 0 }),\n * }));\n * ```\n * @example\n * With superjson serialization and session storage:\n * ```ts\n * import { createPersistentStore } from \"dharma-core\";\n * import superjson from \"superjson\";\n *\n * const store = createPersistentStore(\n *   \"count\",\n *   { count: 0 },\n *   (set) => ({\n *     increment: () => set((state) => ({ count: state.count + 1 })),\n *     decrement: () => set((state) => ({ count: state.count - 1 })),\n *     reset: () => set({ count: 0 }),\n *   }),\n *   {\n *     serializer: superjson,\n *     storage: \"session\",\n *   },\n * );\n * ```\n * @group Core\n */\nexport const createPersistentStore = <\n  TState extends object,\n  TActions extends object = Record<never, never>,\n>(\n  key: string,\n  initialState: TState,\n  defineActions: DefineActions<TState, TActions>,\n  {\n    storage: _storage = \"local\",\n    serializer = JSON,\n    onAttach,\n    onDetach,\n    onChange,\n    ...options\n  }: PersistentStoreOptions<TState> = {},\n): Store<TState, TActions> => {\n  if (typeof window === \"undefined\") {\n    return createStore(initialState, defineActions, options);\n  }\n\n  const storage = getStorage(_storage);\n  const stateKey = `store_${key}`;\n  const initialStateKey = `init_${key}`;\n  const initialStateSnapshot = storage.getItem(initialStateKey);\n  const initialStateString = serializer.stringify(initialState);\n\n  if (initialStateSnapshot !== initialStateString) {\n    storage.setItem(initialStateKey, initialStateString);\n    storage.removeItem(stateKey);\n  }\n\n  const updateSnapshot = (newState: TState) => {\n    const currentSnapshot = storage.getItem(stateKey);\n    const newSnapshot = serializer.stringify(newState);\n\n    if (newSnapshot !== currentSnapshot) {\n      storage.setItem(stateKey, newSnapshot);\n    }\n  };\n\n  const updateState = () => {\n    const currentSnapshot = storage.getItem(stateKey);\n\n    if (\n      currentSnapshot &&\n      currentSnapshot !== serializer.stringify(store.get())\n    ) {\n      store.set(serializer.parse(currentSnapshot));\n    }\n  };\n\n  const store = createStore(initialState, defineActions, {\n    onAttach: (...args) => {\n      onAttach?.(...args);\n      updateState();\n      window.addEventListener(\"focus\", updateState);\n    },\n    onDetach: (...args) => {\n      onDetach?.(...args);\n      window.removeEventListener(\"focus\", updateState);\n    },\n    onChange: (state, ...args) => {\n      onChange?.(state, ...args);\n      updateSnapshot(state);\n    },\n    ...options,\n  });\n\n  return store;\n};\n\nconst getStorage = (storage: StorageAPI | \"local\" | \"session\"): StorageAPI => {\n  switch (storage) {\n    case \"local\":\n      return localStorage;\n    case \"session\":\n      return sessionStorage;\n    default:\n      return storage;\n  }\n};\n"],"names":["createStore"],"mappings":";;;;AAsBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CG;AACI,MAAM,qBAAqB,GAAG,CAInC,GAAW,EACX,YAAoB,EACpB,aAA8C,EAC9C,EACE,OAAO,EAAE,QAAQ,GAAG,OAAO,EAC3B,UAAU,GAAG,IAAI,EACjB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,GAAG,OAAO,EAAA,GACwB,EAAE,KACX;AAC3B,IAAA,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,OAAOA,uBAAW,CAAC,YAAY,EAAE,aAAa,EAAE,OAAO,CAAC;IAC1D;AAEA,IAAA,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC;AACpC,IAAA,MAAM,QAAQ,GAAG,CAAA,MAAA,EAAS,GAAG,EAAE;AAC/B,IAAA,MAAM,eAAe,GAAG,CAAA,KAAA,EAAQ,GAAG,EAAE;IACrC,MAAM,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;IAC7D,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;AAE7D,IAAA,IAAI,oBAAoB,KAAK,kBAAkB,EAAE;AAC/C,QAAA,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC;AACpD,QAAA,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;IAC9B;AAEA,IAAA,MAAM,cAAc,GAAG,CAAC,QAAgB,KAAI;QAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;QACjD,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC;AAElD,QAAA,IAAI,WAAW,KAAK,eAAe,EAAE;AACnC,YAAA,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC;QACxC;AACF,IAAA,CAAC;IAED,MAAM,WAAW,GAAG,MAAK;QACvB,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;AAEjD,QAAA,IACE,eAAe;YACf,eAAe,KAAK,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EACrD;YACA,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9C;AACF,IAAA,CAAC;AAED,IAAA,MAAM,KAAK,GAAGA,uBAAW,CAAC,YAAY,EAAE,aAAa,EAAE;AACrD,QAAA,QAAQ,EAAE,CAAC,GAAG,IAAI,KAAI;AACpB,YAAA,QAAQ,GAAG,GAAG,IAAI,CAAC;AACnB,YAAA,WAAW,EAAE;AACb,YAAA,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC;QAC/C,CAAC;AACD,QAAA,QAAQ,EAAE,CAAC,GAAG,IAAI,KAAI;AACpB,YAAA,QAAQ,GAAG,GAAG,IAAI,CAAC;AACnB,YAAA,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC;QAClD,CAAC;AACD,QAAA,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,IAAI,KAAI;AAC3B,YAAA,QAAQ,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC;YAC1B,cAAc,CAAC,KAAK,CAAC;QACvB,CAAC;AACD,QAAA,GAAG,OAAO;AACX,KAAA,CAAC;AAEF,IAAA,OAAO,KAAK;AACd;AAEA,MAAM,UAAU,GAAG,CAAC,OAAyC,KAAgB;IAC3E,QAAQ,OAAO;AACb,QAAA,KAAK,OAAO;AACV,YAAA,OAAO,YAAY;AACrB,QAAA,KAAK,SAAS;AACZ,YAAA,OAAO,cAAc;AACvB,QAAA;AACE,YAAA,OAAO,OAAO;;AAEpB,CAAC;;;;"}
+{"version":3,"file":"createPersistentStore.js","sources":["../../../src/lib/createPersistentStore.ts"],"sourcesContent":["import { createStore, Store, StoreConfiguration } from \"./createStore\";\n\nexport type StorageAPI = {\n  getItem: (key: string) => string | null;\n  setItem: (key: string, value: string) => void;\n  removeItem: (key: string) => void;\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type Serializer<T = any> = {\n  stringify: (value: T) => string;\n  parse: (value: string) => T;\n};\n\nexport type PersistentStoreConfiguration<\n  TState extends object,\n  TActions extends object,\n> = StoreConfiguration<TState, TActions> & {\n  key: string;\n  /** The storage to use for persisting the state. Defaults to local storage if available. */\n  storage?: StorageAPI;\n  /** The serializer to use for storing the state. Defaults to JSON. */\n  serializer?: Serializer<TState>;\n};\n\n/**\n * Creates a store that persists its state in local or session storage.\n * Defaults to local storage but this can be changed in the options.\n *\n * **Note:** The state needs to be serializable by whatever serializer you use. (JSON by default)\n * If you need something more versatile I would recommend using a library like [superjson](https://github.com/flightcontrolhq/superjson).\n *\n * @param {PersistentStoreConfiguration<TState, TActions>} config - The configuration for the persistent store.\n *\n * @returns {Store<TState, TActions>} The created store.\n *\n * @example\n * Basic usage:\n * ```ts\n * import { createPersistentStore } from \"dharma-core\";\n *\n * const store = createPersistentStore({\n *   key: \"count\",\n *   initialState: { count: 0 },\n *   defineActions: ({ set }) => ({\n *     increment: () => set((state) => ({ count: state.count + 1 })),\n *     decrement: () => set((state) => ({ count: state.count - 1 })),\n *     reset: () => set({ count: 0 }),\n *   }),\n * });\n * ```\n * @example\n * With superjson serialization and session storage:\n * ```ts\n * import { createPersistentStore } from \"dharma-core\";\n * import superjson from \"superjson\";\n *\n * const store = createPersistentStore({\n *   key: \"count\",\n *   initialState: { count: 0 },\n *   defineActions: ({ set }) => ({\n *     increment: () => set((state) => ({ count: state.count + 1 })),\n *     decrement: () => set((state) => ({ count: state.count - 1 })),\n *     reset: () => set({ count: 0 }),\n *   }),\n *   serializer: superjson,\n *   storage: sessionStorage,\n * });\n * ```\n */\nexport const createPersistentStore = <\n  TState extends object,\n  TActions extends object = Record<never, never>,\n>(\n  config: PersistentStoreConfiguration<TState, TActions>,\n): Store<TState, TActions> => {\n  const {\n    key,\n    initialState,\n    storage: customStorage,\n    serializer = JSON,\n    onAttach,\n    onDetach,\n    onChange,\n    ...rest\n  } = config;\n\n  const IS_BROWSER = typeof window !== \"undefined\";\n  const storage = customStorage ?? (IS_BROWSER ? localStorage : undefined);\n\n  if (!storage) {\n    return createStore(config);\n  }\n\n  const initialStateKey = `init_${key}`;\n\n  const initialStateSnapshot = storage.getItem(initialStateKey);\n  const initialStateString = serializer.stringify(initialState);\n\n  if (initialStateSnapshot !== initialStateString) {\n    storage.setItem(initialStateKey, initialStateString);\n    storage.removeItem(key);\n  }\n\n  const updateSnapshot = (newState: TState) => {\n    const currentSnapshot = storage.getItem(key);\n    const newSnapshot = serializer.stringify(newState);\n\n    if (newSnapshot !== currentSnapshot) {\n      storage.setItem(key, newSnapshot);\n    }\n  };\n\n  const updateState = () => {\n    const currentSnapshot = storage.getItem(key);\n\n    if (\n      currentSnapshot &&\n      currentSnapshot !== serializer.stringify(store.get())\n    ) {\n      store.set(serializer.parse(currentSnapshot));\n    }\n  };\n\n  const store = createStore({\n    initialState,\n    onAttach: (ctx) => {\n      onAttach?.(ctx);\n      updateState();\n      if (IS_BROWSER) {\n        window.addEventListener(\"focus\", updateState);\n      }\n    },\n    onDetach: (ctx) => {\n      onDetach?.(ctx);\n      if (IS_BROWSER) {\n        window.removeEventListener(\"focus\", updateState);\n      }\n    },\n    onChange: ({ state, ...ctx }) => {\n      onChange?.({ state, ...ctx });\n      updateSnapshot(state);\n    },\n    ...rest,\n  });\n\n  return store;\n};\n"],"names":["createStore"],"mappings":";;;;AAyBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CG;AACI,MAAM,qBAAqB,GAAG,CAInC,MAAsD,KAC3B;IAC3B,MAAM,EACJ,GAAG,EACH,YAAY,EACZ,OAAO,EAAE,aAAa,EACtB,UAAU,GAAG,IAAI,EACjB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,GAAG,IAAI,EACR,GAAG,MAAM;AAEV,IAAA,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,WAAW;AAChD,IAAA,MAAM,OAAO,GAAG,aAAa,KAAK,UAAU,GAAG,YAAY,GAAG,SAAS,CAAC;IAExE,IAAI,CAAC,OAAO,EAAE;AACZ,QAAA,OAAOA,uBAAW,CAAC,MAAM,CAAC;IAC5B;AAEA,IAAA,MAAM,eAAe,GAAG,CAAA,KAAA,EAAQ,GAAG,EAAE;IAErC,MAAM,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;IAC7D,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;AAE7D,IAAA,IAAI,oBAAoB,KAAK,kBAAkB,EAAE;AAC/C,QAAA,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC;AACpD,QAAA,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;IACzB;AAEA,IAAA,MAAM,cAAc,GAAG,CAAC,QAAgB,KAAI;QAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;QAC5C,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC;AAElD,QAAA,IAAI,WAAW,KAAK,eAAe,EAAE;AACnC,YAAA,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC;QACnC;AACF,IAAA,CAAC;IAED,MAAM,WAAW,GAAG,MAAK;QACvB,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;AAE5C,QAAA,IACE,eAAe;YACf,eAAe,KAAK,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EACrD;YACA,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9C;AACF,IAAA,CAAC;IAED,MAAM,KAAK,GAAGA,uBAAW,CAAC;QACxB,YAAY;AACZ,QAAA,QAAQ,EAAE,CAAC,GAAG,KAAI;AAChB,YAAA,QAAQ,GAAG,GAAG,CAAC;AACf,YAAA,WAAW,EAAE;YACb,IAAI,UAAU,EAAE;AACd,gBAAA,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC;YAC/C;QACF,CAAC;AACD,QAAA,QAAQ,EAAE,CAAC,GAAG,KAAI;AAChB,YAAA,QAAQ,GAAG,GAAG,CAAC;YACf,IAAI,UAAU,EAAE;AACd,gBAAA,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC;YAClD;QACF,CAAC;QACD,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,GAAG,EAAE,KAAI;YAC9B,QAAQ,GAAG,EAAE,KAAK,EAAE,GAAG,GAAG,EAAE,CAAC;YAC7B,cAAc,CAAC,KAAK,CAAC;QACvB,CAAC;AACD,QAAA,GAAG,IAAI;AACR,KAAA,CAAC;AAEF,IAAA,OAAO,KAAK;AACd;;;;"}

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

@@ -1,19 +1,41 @@
+type Listener<TState extends object> = (state: TState) => void;
+export type SetState<TState extends object> = (stateModifier: StateModifier<TState>) => TState;
 export type Store<TState extends object, TActions extends object> = {
     /** Returns the current state of the store. */
     get: () => TState;
     /** Sets the state of the store. */
-    set: (stateModifier: StateModifier<TState>) => TState;
+    set: SetState<TState>;
+    /** Resets the state of the store to its initial value. */
+    reset: () => TState;
     /** Actions that can modify the state of the store. */
     actions: TActions;
     /** Subscribes to changes in the state of the store. Returns an unsubscribe function. */
     subscribe: (listener: Listener<TState>) => () => void;
 };
-type Listener<TState extends object> = (state: TState) => void;
-export type StoreEventHandler<TState extends object> = (state: TState, set: SetState<TState>) => void;
-export type SetState<TState extends object> = (stateModifier: StateModifier<TState>) => TState;
+export type EventHandlerContext<TState extends object> = {
+    /** The current state of the store. */
+    state: TState;
+    /** Sets the state of the store. */
+    set: SetState<TState>;
+    /** Resets the state of the store to its initial value. */
+    reset: () => TState;
+};
+export type StoreEventHandler<TState extends object> = (context: EventHandlerContext<TState>) => void;
 export type StateModifier<TState extends object> = Partial<TState> | ((state: TState) => Partial<TState>);
-export type DefineActions<TState extends object, TActions> = (set: (stateModifier: StateModifier<TState>) => TState, get: () => TState) => TActions;
-export type StoreOptions<TState extends object> = {
+export type StateFunctions<TState extends object> = {
+    /** Returns the current state of the store. */
+    get: () => TState;
+    /** Sets the state of the store. */
+    set: SetState<TState>;
+    /** Resets the state of the store to its initial value. */
+    reset: () => TState;
+};
+export type DefineActions<TState extends object, TActions> = (stateFunctions: StateFunctions<TState>) => TActions;
+export type StoreConfiguration<TState extends object, TActions extends object> = {
+    /** The initial state of the store. */
+    initialState: TState;
+    /** A function that defines actions that can modify the state. */
+    defineActions?: DefineActions<TState, TActions>;
     /** Invoked when the store is created. */
     onLoad?: StoreEventHandler<TState>;
     /** Invoked when the store is subscribed to. */
@@ -26,9 +48,7 @@ export type StoreOptions<TState extends object> = {
 /**
  * Creates a store with an initial state and actions that can modify the state.
  *
- * @param {TState} initialState - The initial state of the store.
- * @param {DefineActions<TState, TActions>} [defineActions] - A function that defines actions that can modify the state.
- * @param {StoreOptions<TState>} [options] - Additional options for the store.
+ * @param {StoreConfiguration<TState>} [config] - The configuration for the store.
  *
  * @returns {Store<TState, TActions>} The created store with state management methods.
  *
@@ -36,13 +56,14 @@ export type StoreOptions<TState extends object> = {
  * ```ts
  * import { createStore } from "dharma-core";
  *
- * const store = createStore({ count: 0 }, (set) => ({
- *   increment: () => set((state) => ({ count: state.count + 1 })),
- *   decrement: () => set((state) => ({ count: state.count - 1 })),
- *   reset: () => set({ count: 0 }),
- * }));
+ * const store = createStore({
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
+ *     increment: () => set((state) => ({ count: state.count + 1 })),
+ *     decrement: () => set((state) => ({ count: state.count - 1 })),
+ *   }),
+ * });
  * ```
- * @group Core
  */
-export declare const createStore: <TState extends object, TActions extends object = Record<never, never>>(initialState: TState, defineActions: DefineActions<TState, TActions>, { onLoad, onAttach, onDetach, onChange }?: StoreOptions<TState>) => Store<TState, TActions>;
+export declare const createStore: <TState extends object, TActions extends object = Record<never, never>>(config: StoreConfiguration<TState, TActions>) => Store<TState, TActions>;
 export {};

package/dist/cjs/lib/createStore.js

@@ -5,9 +5,7 @@ var merge = require('./merge.js');
 /**
  * Creates a store with an initial state and actions that can modify the state.
  *
- * @param {TState} initialState - The initial state of the store.
- * @param {DefineActions<TState, TActions>} [defineActions] - A function that defines actions that can modify the state.
- * @param {StoreOptions<TState>} [options] - Additional options for the store.
+ * @param {StoreConfiguration<TState>} [config] - The configuration for the store.
  *
  * @returns {Store<TState, TActions>} The created store with state management methods.
  *
@@ -15,15 +13,17 @@ var merge = require('./merge.js');
  * ```ts
  * import { createStore } from "dharma-core";
  *
- * const store = createStore({ count: 0 }, (set) => ({
- *   increment: () => set((state) => ({ count: state.count + 1 })),
- *   decrement: () => set((state) => ({ count: state.count - 1 })),
- *   reset: () => set({ count: 0 }),
- * }));
+ * const store = createStore({
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
+ *     increment: () => set((state) => ({ count: state.count + 1 })),
+ *     decrement: () => set((state) => ({ count: state.count - 1 })),
+ *   }),
+ * });
  * ```
- * @group Core
  */
-const createStore = (initialState, defineActions, { onLoad, onAttach, onDetach, onChange } = {}) => {
+const createStore = (config) => {
+    const { initialState, defineActions, onLoad, onAttach, onDetach, onChange } = config;
     let state = initialState;
     const listeners = new Set();
     const get = () => state;
@@ -31,8 +31,9 @@ const createStore = (initialState, defineActions, { onLoad, onAttach, onDetach,
         state = merge.merge(state, stateModifier);
         return state;
     };
+    const resetSilently = () => setSilently(initialState);
     const dispatch = () => {
-        onChange?.(state, setSilently);
+        onChange?.({ state, set: setSilently, reset: resetSilently });
         listeners.forEach((listener) => listener(state));
     };
     const set = (stateModifier) => {
@@ -40,24 +41,32 @@ const createStore = (initialState, defineActions, { onLoad, onAttach, onDetach,
         dispatch();
         return state;
     };
+    const reset = () => {
+        resetSilently();
+        dispatch();
+        return state;
+    };
     const subscribe = (listener) => {
-        listener(state);
         if (listeners.size === 0) {
-            onAttach?.(state, set);
+            onAttach?.({ state, set, reset });
         }
+        listener(state);
         listeners.add(listener);
         return () => {
             listeners.delete(listener);
             if (listeners.size === 0) {
-                onDetach?.(state, set);
+                onDetach?.({ state, set, reset });
             }
         };
     };
-    const actions = defineActions ? defineActions(set, get) : {};
-    onLoad?.(state, set);
+    const actions = defineActions
+        ? defineActions({ set, get, reset })
+        : {};
+    onLoad?.({ state, set, reset });
     return {
         get,
         set,
+        reset,
         subscribe,
         actions,
     };

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

@@ -1 +1 @@
-{"version":3,"file":"createStore.js","sources":["../../../src/lib/createStore.ts"],"sourcesContent":["import { merge } from \"./merge\";\n\nexport type Store<TState extends object, TActions extends object> = {\n  /** Returns the current state of the store. */\n  get: () => TState;\n  /** Sets the state of the store. */\n  set: (stateModifier: StateModifier<TState>) => TState;\n  /** Actions that can modify the state of the store. */\n  actions: TActions;\n  /** Subscribes to changes in the state of the store. Returns an unsubscribe function. */\n  subscribe: (listener: Listener<TState>) => () => void;\n};\n\ntype Listener<TState extends object> = (state: TState) => void;\n\nexport type StoreEventHandler<TState extends object> = (\n  state: TState,\n  set: SetState<TState>,\n) => void;\n\nexport type SetState<TState extends object> = (\n  stateModifier: StateModifier<TState>,\n) => TState;\n\nexport type StateModifier<TState extends object> =\n  | Partial<TState>\n  | ((state: TState) => Partial<TState>);\n\nexport type DefineActions<TState extends object, TActions> = (\n  set: (stateModifier: StateModifier<TState>) => TState,\n  get: () => TState,\n) => TActions;\n\nexport type StoreOptions<TState extends object> = {\n  /** Invoked when the store is created. */\n  onLoad?: StoreEventHandler<TState>;\n  /** Invoked when the store is subscribed to. */\n  onAttach?: StoreEventHandler<TState>;\n  /** Invoked when the store is unsubscribed from. */\n  onDetach?: StoreEventHandler<TState>;\n  /** Invoked whenever the state changes. */\n  onChange?: StoreEventHandler<TState>;\n};\n\n/**\n * Creates a store with an initial state and actions that can modify the state.\n *\n * @param {TState} initialState - The initial state of the store.\n * @param {DefineActions<TState, TActions>} [defineActions] - A function that defines actions that can modify the state.\n * @param {StoreOptions<TState>} [options] - Additional options for the store.\n *\n * @returns {Store<TState, TActions>} The created store with state management methods.\n *\n * @example\n * ```ts\n * import { createStore } from \"dharma-core\";\n *\n * const store = createStore({ count: 0 }, (set) => ({\n *   increment: () => set((state) => ({ count: state.count + 1 })),\n *   decrement: () => set((state) => ({ count: state.count - 1 })),\n *   reset: () => set({ count: 0 }),\n * }));\n * ```\n * @group Core\n */\nexport const createStore = <\n  TState extends object,\n  TActions extends object = Record<never, never>,\n>(\n  initialState: TState,\n  defineActions: DefineActions<TState, TActions>,\n  { onLoad, onAttach, onDetach, onChange }: StoreOptions<TState> = {},\n): Store<TState, TActions> => {\n  let state = initialState;\n  const listeners = new Set<Listener<TState>>();\n\n  const get = () => state;\n\n  const setSilently = (stateModifier: StateModifier<TState>) => {\n    state = merge(state, stateModifier);\n    return state;\n  };\n\n  const dispatch = () => {\n    onChange?.(state, setSilently);\n    listeners.forEach((listener) => listener(state));\n  };\n\n  const set = (stateModifier: StateModifier<TState>) => {\n    setSilently(stateModifier);\n    dispatch();\n    return state;\n  };\n\n  const subscribe = (listener: Listener<TState>) => {\n    listener(state);\n    if (listeners.size === 0) {\n      onAttach?.(state, set);\n    }\n\n    listeners.add(listener);\n\n    return () => {\n      listeners.delete(listener);\n\n      if (listeners.size === 0) {\n        onDetach?.(state, set);\n      }\n    };\n  };\n\n  const actions = defineActions ? defineActions(set, get) : ({} as TActions);\n\n  onLoad?.(state, set);\n\n  return {\n    get,\n    set,\n    subscribe,\n    actions,\n  };\n};\n"],"names":["merge"],"mappings":";;;;AA4CA;;;;;;;;;;;;;;;;;;;;AAoBG;MACU,WAAW,GAAG,CAIzB,YAAoB,EACpB,aAA8C,EAC9C,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAA,GAA2B,EAAE,KACxC;IAC3B,IAAI,KAAK,GAAG,YAAY;AACxB,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAoB;AAE7C,IAAA,MAAM,GAAG,GAAG,MAAM,KAAK;AAEvB,IAAA,MAAM,WAAW,GAAG,CAAC,aAAoC,KAAI;AAC3D,QAAA,KAAK,GAAGA,WAAK,CAAC,KAAK,EAAE,aAAa,CAAC;AACnC,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;IAED,MAAM,QAAQ,GAAG,MAAK;AACpB,QAAA,QAAQ,GAAG,KAAK,EAAE,WAAW,CAAC;AAC9B,QAAA,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;AAClD,IAAA,CAAC;AAED,IAAA,MAAM,GAAG,GAAG,CAAC,aAAoC,KAAI;QACnD,WAAW,CAAC,aAAa,CAAC;AAC1B,QAAA,QAAQ,EAAE;AACV,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;AAED,IAAA,MAAM,SAAS,GAAG,CAAC,QAA0B,KAAI;QAC/C,QAAQ,CAAC,KAAK,CAAC;AACf,QAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,YAAA,QAAQ,GAAG,KAAK,EAAE,GAAG,CAAC;QACxB;AAEA,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,QAAQ,GAAG,KAAK,EAAE,GAAG,CAAC;YACxB;AACF,QAAA,CAAC;AACH,IAAA,CAAC;AAED,IAAA,MAAM,OAAO,GAAG,aAAa,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAI,EAAe;AAE1E,IAAA,MAAM,GAAG,KAAK,EAAE,GAAG,CAAC;IAEpB,OAAO;QACL,GAAG;QACH,GAAG;QACH,SAAS;QACT,OAAO;KACR;AACH;;;;"}
+{"version":3,"file":"createStore.js","sources":["../../../src/lib/createStore.ts"],"sourcesContent":["import { merge } from \"./merge\";\n\ntype Listener<TState extends object> = (state: TState) => void;\n\nexport type SetState<TState extends object> = (\n  stateModifier: StateModifier<TState>,\n) => TState;\n\nexport type Store<TState extends object, TActions extends object> = {\n  /** Returns the current state of the store. */\n  get: () => TState;\n  /** Sets the state of the store. */\n  set: SetState<TState>;\n  /** Resets the state of the store to its initial value. */\n  reset: () => TState;\n  /** Actions that can modify the state of the store. */\n  actions: TActions;\n  /** Subscribes to changes in the state of the store. Returns an unsubscribe function. */\n  subscribe: (listener: Listener<TState>) => () => void;\n};\n\nexport type EventHandlerContext<TState extends object> = {\n  /** The current state of the store. */\n  state: TState;\n  /** Sets the state of the store. */\n  set: SetState<TState>;\n  /** Resets the state of the store to its initial value. */\n  reset: () => TState;\n};\n\nexport type StoreEventHandler<TState extends object> = (\n  context: EventHandlerContext<TState>,\n) => void;\n\nexport type StateModifier<TState extends object> =\n  | Partial<TState>\n  | ((state: TState) => Partial<TState>);\n\nexport type StateFunctions<TState extends object> = {\n  /** Returns the current state of the store. */\n  get: () => TState;\n  /** Sets the state of the store. */\n  set: SetState<TState>;\n  /** Resets the state of the store to its initial value. */\n  reset: () => TState;\n};\n\nexport type DefineActions<TState extends object, TActions> = (\n  stateFunctions: StateFunctions<TState>,\n) => TActions;\n\nexport type StoreConfiguration<\n  TState extends object,\n  TActions extends object,\n> = {\n  /** The initial state of the store. */\n  initialState: TState;\n  /** A function that defines actions that can modify the state. */\n  defineActions?: DefineActions<TState, TActions>;\n  /** Invoked when the store is created. */\n  onLoad?: StoreEventHandler<TState>;\n  /** Invoked when the store is subscribed to. */\n  onAttach?: StoreEventHandler<TState>;\n  /** Invoked when the store is unsubscribed from. */\n  onDetach?: StoreEventHandler<TState>;\n  /** Invoked whenever the state changes. */\n  onChange?: StoreEventHandler<TState>;\n};\n\n/**\n * Creates a store with an initial state and actions that can modify the state.\n *\n * @param {StoreConfiguration<TState>} [config] - The configuration for the store.\n *\n * @returns {Store<TState, TActions>} The created store with state management methods.\n *\n * @example\n * ```ts\n * import { createStore } from \"dharma-core\";\n *\n * const store = createStore({\n *   initialState: { count: 0 },\n *   defineActions: ({ set }) => ({\n *     increment: () => set((state) => ({ count: state.count + 1 })),\n *     decrement: () => set((state) => ({ count: state.count - 1 })),\n *   }),\n * });\n * ```\n */\nexport const createStore = <\n  TState extends object,\n  TActions extends object = Record<never, never>,\n>(\n  config: StoreConfiguration<TState, TActions>,\n): Store<TState, TActions> => {\n  const { initialState, defineActions, onLoad, onAttach, onDetach, onChange } =\n    config;\n\n  let state = initialState;\n  const listeners = new Set<Listener<TState>>();\n\n  const get = () => state;\n\n  const setSilently = (stateModifier: StateModifier<TState>) => {\n    state = merge(state, stateModifier);\n    return state;\n  };\n\n  const resetSilently = () => setSilently(initialState);\n\n  const dispatch = () => {\n    onChange?.({ state, set: setSilently, reset: resetSilently });\n    listeners.forEach((listener) => listener(state));\n  };\n\n  const set = (stateModifier: StateModifier<TState>) => {\n    setSilently(stateModifier);\n    dispatch();\n    return state;\n  };\n\n  const reset = () => {\n    resetSilently();\n    dispatch();\n    return state;\n  };\n\n  const subscribe = (listener: Listener<TState>) => {\n    if (listeners.size === 0) {\n      onAttach?.({ state, set, reset });\n    }\n\n    listener(state);\n    listeners.add(listener);\n\n    return () => {\n      listeners.delete(listener);\n\n      if (listeners.size === 0) {\n        onDetach?.({ state, set, reset });\n      }\n    };\n  };\n\n  const actions = defineActions\n    ? defineActions({ set, get, reset })\n    : ({} as TActions);\n\n  onLoad?.({ state, set, reset });\n\n  return {\n    get,\n    set,\n    reset,\n    subscribe,\n    actions,\n  };\n};\n"],"names":["merge"],"mappings":";;;;AAqEA;;;;;;;;;;;;;;;;;;;AAmBG;AACI,MAAM,WAAW,GAAG,CAIzB,MAA4C,KACjB;AAC3B,IAAA,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,GACzE,MAAM;IAER,IAAI,KAAK,GAAG,YAAY;AACxB,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAoB;AAE7C,IAAA,MAAM,GAAG,GAAG,MAAM,KAAK;AAEvB,IAAA,MAAM,WAAW,GAAG,CAAC,aAAoC,KAAI;AAC3D,QAAA,KAAK,GAAGA,WAAK,CAAC,KAAK,EAAE,aAAa,CAAC;AACnC,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC;IAErD,MAAM,QAAQ,GAAG,MAAK;AACpB,QAAA,QAAQ,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;AAC7D,QAAA,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;AAClD,IAAA,CAAC;AAED,IAAA,MAAM,GAAG,GAAG,CAAC,aAAoC,KAAI;QACnD,WAAW,CAAC,aAAa,CAAC;AAC1B,QAAA,QAAQ,EAAE;AACV,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,MAAK;AACjB,QAAA,aAAa,EAAE;AACf,QAAA,QAAQ,EAAE;AACV,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;AAED,IAAA,MAAM,SAAS,GAAG,CAAC,QAA0B,KAAI;AAC/C,QAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;YACxB,QAAQ,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QACnC;QAEA,QAAQ,CAAC,KAAK,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;gBACxB,QAAQ,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;YACnC;AACF,QAAA,CAAC;AACH,IAAA,CAAC;IAED,MAAM,OAAO,GAAG;UACZ,aAAa,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE;UAChC,EAAe;IAEpB,MAAM,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;IAE/B,OAAO;QACL,GAAG;QACH,GAAG;QACH,KAAK;QACL,SAAS;QACT,OAAO;KACR;AACH;;;;"}

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

@@ -3,22 +3,22 @@ import { StateModifier } from "./createStore";
  * Merges the current state with a state modifier.
  * Useful for creating custom set functions.
  *
- * @param {T} stateModifier - A function or object that modifies the state.
- * @param {StateModifier<T>} stateModifier - The current state object.
+ * @param {T} currentState - The current state object.
+ * @param {StateModifier<T>} stateModifier - A function or object that modifies the state.
  * @returns {T} The new state object, which is a combination of the current state and the state modifier.
  *
  * @example
  * ```ts
  * import { createStore, merge, StateModifier } from "dharma-core";
  *
- * const store = createStore(
- *   {
+ * const store = createStore({
+ *   initialState: {
  *     counter: {
  *       count: 0,
  *     },
  *     // ...
  *   },
- *   (set) => {
+ *   defineActions: ({ set }) => {
  *     const setCounter = (counter: StateModifier<{ count: number }>) =>
  *       set((state) => ({
  *         counter: merge(state.counter, counter),
@@ -31,8 +31,7 @@ import { StateModifier } from "./createStore";
  *       // ...
  *     };
  *   },
- * );
+ * });
  * ```
- * @group Utilities
  */
 export declare const merge: <T extends object>(currentState: T, stateModifier: StateModifier<T>) => T;

package/dist/cjs/lib/merge.js

@@ -4,22 +4,22 @@
  * Merges the current state with a state modifier.
  * Useful for creating custom set functions.
  *
- * @param {T} stateModifier - A function or object that modifies the state.
- * @param {StateModifier<T>} stateModifier - The current state object.
+ * @param {T} currentState - The current state object.
+ * @param {StateModifier<T>} stateModifier - A function or object that modifies the state.
  * @returns {T} The new state object, which is a combination of the current state and the state modifier.
  *
  * @example
  * ```ts
  * import { createStore, merge, StateModifier } from "dharma-core";
  *
- * const store = createStore(
- *   {
+ * const store = createStore({
+ *   initialState: {
  *     counter: {
  *       count: 0,
  *     },
  *     // ...
  *   },
- *   (set) => {
+ *   defineActions: ({ set }) => {
  *     const setCounter = (counter: StateModifier<{ count: number }>) =>
  *       set((state) => ({
  *         counter: merge(state.counter, counter),
@@ -32,9 +32,8 @@
  *       // ...
  *     };
  *   },
- * );
+ * });
  * ```
- * @group Utilities
  */
 const merge = (currentState, stateModifier) => {
     const newState = typeof stateModifier === "function"

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

@@ -1 +1 @@
-{"version":3,"file":"merge.js","sources":["../../../src/lib/merge.ts"],"sourcesContent":["import { StateModifier } from \"./createStore\";\n\n/**\n * Merges the current state with a state modifier.\n * Useful for creating custom set functions.\n *\n * @param {T} stateModifier - A function or object that modifies the state.\n * @param {StateModifier<T>} stateModifier - The current state object.\n * @returns {T} The new state object, which is a combination of the current state and the state modifier.\n *\n * @example\n * ```ts\n * import { createStore, merge, StateModifier } from \"dharma-core\";\n *\n * const store = createStore(\n *   {\n *     counter: {\n *       count: 0,\n *     },\n *     // ...\n *   },\n *   (set) => {\n *     const setCounter = (counter: StateModifier<{ count: number }>) =>\n *       set((state) => ({\n *         counter: merge(state.counter, counter),\n *       }));\n *\n *     return {\n *       increment: () => setCounter((state) => ({ count: state.count + 1 })),\n *       decrement: () => setCounter((state) => ({ count: state.count - 1 })),\n *       reset: () => setCounter({ count: 0 }),\n *       // ...\n *     };\n *   },\n * );\n * ```\n * @group Utilities\n */\nexport const merge = <T extends object>(\n  currentState: T,\n  stateModifier: StateModifier<T>,\n): T => {\n  const newState =\n    typeof stateModifier === \"function\"\n      ? stateModifier(currentState)\n      : stateModifier;\n  return { ...currentState, ...newState };\n};\n"],"names":[],"mappings":";;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCG;MACU,KAAK,GAAG,CACnB,YAAe,EACf,aAA+B,KAC1B;AACL,IAAA,MAAM,QAAQ,GACZ,OAAO,aAAa,KAAK;AACvB,UAAE,aAAa,CAAC,YAAY;UAC1B,aAAa;AACnB,IAAA,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,QAAQ,EAAE;AACzC;;;;"}
+{"version":3,"file":"merge.js","sources":["../../../src/lib/merge.ts"],"sourcesContent":["import { StateModifier } from \"./createStore\";\n\n/**\n * Merges the current state with a state modifier.\n * Useful for creating custom set functions.\n *\n * @param {T} currentState - The current state object.\n * @param {StateModifier<T>} stateModifier - A function or object that modifies the state.\n * @returns {T} The new state object, which is a combination of the current state and the state modifier.\n *\n * @example\n * ```ts\n * import { createStore, merge, StateModifier } from \"dharma-core\";\n *\n * const store = createStore({\n *   initialState: {\n *     counter: {\n *       count: 0,\n *     },\n *     // ...\n *   },\n *   defineActions: ({ set }) => {\n *     const setCounter = (counter: StateModifier<{ count: number }>) =>\n *       set((state) => ({\n *         counter: merge(state.counter, counter),\n *       }));\n *\n *     return {\n *       increment: () => setCounter((state) => ({ count: state.count + 1 })),\n *       decrement: () => setCounter((state) => ({ count: state.count - 1 })),\n *       reset: () => setCounter({ count: 0 }),\n *       // ...\n *     };\n *   },\n * });\n * ```\n */\nexport const merge = <T extends object>(\n  currentState: T,\n  stateModifier: StateModifier<T>,\n): T => {\n  const newState =\n    typeof stateModifier === \"function\"\n      ? stateModifier(currentState)\n      : stateModifier;\n  return { ...currentState, ...newState };\n};\n"],"names":[],"mappings":";;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCG;MACU,KAAK,GAAG,CACnB,YAAe,EACf,aAA+B,KAC1B;AACL,IAAA,MAAM,QAAQ,GACZ,OAAO,aAAa,KAAK;AACvB,UAAE,aAAa,CAAC,YAAY;UAC1B,aAAa;AACnB,IAAA,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,QAAQ,EAAE;AACzC;;;;"}

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

@@ -1,4 +1,4 @@
-import { DefineActions, Store, StoreOptions } from "./createStore";
+import { Store, StoreConfiguration } from "./createStore";
 export type StorageAPI = {
     getItem: (key: string) => string | null;
     setItem: (key: string, value: string) => void;
@@ -8,9 +8,10 @@ export type Serializer<T = any> = {
     stringify: (value: T) => string;
     parse: (value: string) => T;
 };
-export type PersistentStoreOptions<TState extends object> = StoreOptions<TState> & {
-    /** The storage to use for persisting the state. Defaults to local storage. */
-    storage?: StorageAPI | "local" | "session";
+export type PersistentStoreConfiguration<TState extends object, TActions extends object> = StoreConfiguration<TState, TActions> & {
+    key: string;
+    /** The storage to use for persisting the state. Defaults to local storage if available. */
+    storage?: StorageAPI;
     /** The serializer to use for storing the state. Defaults to JSON. */
     serializer?: Serializer<TState>;
 };
@@ -21,10 +22,7 @@ export type PersistentStoreOptions<TState extends object> = StoreOptions<TState>
  * **Note:** The state needs to be serializable by whatever serializer you use. (JSON by default)
  * If you need something more versatile I would recommend using a library like [superjson](https://github.com/flightcontrolhq/superjson).
  *
- * @param {string} key - A unique key to identify the store in storage.
- * @param {TState} initialState - The initial state of the store.
- * @param {DefineActions<TState, TActions>} [defineActions] - A function to define actions for the store.
- * @param {PersistentStoreOptions<TState>} [options] - Additional options for the persistent store.
+ * @param {PersistentStoreConfiguration<TState, TActions>} config - The configuration for the persistent store.
  *
  * @returns {Store<TState, TActions>} The created store.
  *
@@ -33,11 +31,15 @@ export type PersistentStoreOptions<TState extends object> = StoreOptions<TState>
  * ```ts
  * import { createPersistentStore } from "dharma-core";
  *
- * const store = createPersistentStore("count", { count: 0 }, (set) => ({
- *   increment: () => set((state) => ({ count: state.count + 1 })),
- *   decrement: () => set((state) => ({ count: state.count - 1 })),
- *   reset: () => set({ count: 0 }),
- * }));
+ * const store = createPersistentStore({
+ *   key: "count",
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
+ *     increment: () => set((state) => ({ count: state.count + 1 })),
+ *     decrement: () => set((state) => ({ count: state.count - 1 })),
+ *     reset: () => set({ count: 0 }),
+ *   }),
+ * });
  * ```
  * @example
  * With superjson serialization and session storage:
@@ -45,20 +47,17 @@ export type PersistentStoreOptions<TState extends object> = StoreOptions<TState>
  * import { createPersistentStore } from "dharma-core";
  * import superjson from "superjson";
  *
- * const store = createPersistentStore(
- *   "count",
- *   { count: 0 },
- *   (set) => ({
+ * const store = createPersistentStore({
+ *   key: "count",
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
  *     increment: () => set((state) => ({ count: state.count + 1 })),
  *     decrement: () => set((state) => ({ count: state.count - 1 })),
  *     reset: () => set({ count: 0 }),
  *   }),
- *   {
- *     serializer: superjson,
- *     storage: "session",
- *   },
- * );
+ *   serializer: superjson,
+ *   storage: sessionStorage,
+ * });
  * ```
- * @group Core
  */
-export declare const createPersistentStore: <TState extends object, TActions extends object = Record<never, never>>(key: string, initialState: TState, defineActions: DefineActions<TState, TActions>, { storage: _storage, serializer, onAttach, onDetach, onChange, ...options }?: PersistentStoreOptions<TState>) => Store<TState, TActions>;
+export declare const createPersistentStore: <TState extends object, TActions extends object = Record<never, never>>(config: PersistentStoreConfiguration<TState, TActions>) => Store<TState, TActions>;

package/dist/esm/lib/createPersistentStore.js

@@ -7,10 +7,7 @@ import { createStore } from './createStore.js';
  * **Note:** The state needs to be serializable by whatever serializer you use. (JSON by default)
  * If you need something more versatile I would recommend using a library like [superjson](https://github.com/flightcontrolhq/superjson).
  *
- * @param {string} key - A unique key to identify the store in storage.
- * @param {TState} initialState - The initial state of the store.
- * @param {DefineActions<TState, TActions>} [defineActions] - A function to define actions for the store.
- * @param {PersistentStoreOptions<TState>} [options] - Additional options for the persistent store.
+ * @param {PersistentStoreConfiguration<TState, TActions>} config - The configuration for the persistent store.
  *
  * @returns {Store<TState, TActions>} The created store.
  *
@@ -19,11 +16,15 @@ import { createStore } from './createStore.js';
  * ```ts
  * import { createPersistentStore } from "dharma-core";
  *
- * const store = createPersistentStore("count", { count: 0 }, (set) => ({
- *   increment: () => set((state) => ({ count: state.count + 1 })),
- *   decrement: () => set((state) => ({ count: state.count - 1 })),
- *   reset: () => set({ count: 0 }),
- * }));
+ * const store = createPersistentStore({
+ *   key: "count",
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
+ *     increment: () => set((state) => ({ count: state.count + 1 })),
+ *     decrement: () => set((state) => ({ count: state.count - 1 })),
+ *     reset: () => set({ count: 0 }),
+ *   }),
+ * });
  * ```
  * @example
  * With superjson serialization and session storage:
@@ -31,77 +32,70 @@ import { createStore } from './createStore.js';
  * import { createPersistentStore } from "dharma-core";
  * import superjson from "superjson";
  *
- * const store = createPersistentStore(
- *   "count",
- *   { count: 0 },
- *   (set) => ({
+ * const store = createPersistentStore({
+ *   key: "count",
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
  *     increment: () => set((state) => ({ count: state.count + 1 })),
  *     decrement: () => set((state) => ({ count: state.count - 1 })),
  *     reset: () => set({ count: 0 }),
  *   }),
- *   {
- *     serializer: superjson,
- *     storage: "session",
- *   },
- * );
+ *   serializer: superjson,
+ *   storage: sessionStorage,
+ * });
  * ```
- * @group Core
  */
-const createPersistentStore = (key, initialState, defineActions, { storage: _storage = "local", serializer = JSON, onAttach, onDetach, onChange, ...options } = {}) => {
-    if (typeof window === "undefined") {
-        return createStore(initialState, defineActions, options);
+const createPersistentStore = (config) => {
+    const { key, initialState, storage: customStorage, serializer = JSON, onAttach, onDetach, onChange, ...rest } = config;
+    const IS_BROWSER = typeof window !== "undefined";
+    const storage = customStorage ?? (IS_BROWSER ? localStorage : undefined);
+    if (!storage) {
+        return createStore(config);
     }
-    const storage = getStorage(_storage);
-    const stateKey = `store_${key}`;
     const initialStateKey = `init_${key}`;
     const initialStateSnapshot = storage.getItem(initialStateKey);
     const initialStateString = serializer.stringify(initialState);
     if (initialStateSnapshot !== initialStateString) {
         storage.setItem(initialStateKey, initialStateString);
-        storage.removeItem(stateKey);
+        storage.removeItem(key);
     }
     const updateSnapshot = (newState) => {
-        const currentSnapshot = storage.getItem(stateKey);
+        const currentSnapshot = storage.getItem(key);
         const newSnapshot = serializer.stringify(newState);
         if (newSnapshot !== currentSnapshot) {
-            storage.setItem(stateKey, newSnapshot);
+            storage.setItem(key, newSnapshot);
         }
     };
     const updateState = () => {
-        const currentSnapshot = storage.getItem(stateKey);
+        const currentSnapshot = storage.getItem(key);
         if (currentSnapshot &&
             currentSnapshot !== serializer.stringify(store.get())) {
             store.set(serializer.parse(currentSnapshot));
         }
     };
-    const store = createStore(initialState, defineActions, {
-        onAttach: (...args) => {
-            onAttach?.(...args);
+    const store = createStore({
+        initialState,
+        onAttach: (ctx) => {
+            onAttach?.(ctx);
             updateState();
-            window.addEventListener("focus", updateState);
+            if (IS_BROWSER) {
+                window.addEventListener("focus", updateState);
+            }
         },
-        onDetach: (...args) => {
-            onDetach?.(...args);
-            window.removeEventListener("focus", updateState);
+        onDetach: (ctx) => {
+            onDetach?.(ctx);
+            if (IS_BROWSER) {
+                window.removeEventListener("focus", updateState);
+            }
         },
-        onChange: (state, ...args) => {
-            onChange?.(state, ...args);
+        onChange: ({ state, ...ctx }) => {
+            onChange?.({ state, ...ctx });
             updateSnapshot(state);
         },
-        ...options,
+        ...rest,
     });
     return store;
 };
-const getStorage = (storage) => {
-    switch (storage) {
-        case "local":
-            return localStorage;
-        case "session":
-            return sessionStorage;
-        default:
-            return storage;
-    }
-};
 
 export { createPersistentStore };
 //# sourceMappingURL=createPersistentStore.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"createPersistentStore.js","sources":["../../../src/lib/createPersistentStore.ts"],"sourcesContent":["import { createStore, DefineActions, Store, StoreOptions } from \"./createStore\";\n\nexport type StorageAPI = {\n  getItem: (key: string) => string | null;\n  setItem: (key: string, value: string) => void;\n  removeItem: (key: string) => void;\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type Serializer<T = any> = {\n  stringify: (value: T) => string;\n  parse: (value: string) => T;\n};\n\nexport type PersistentStoreOptions<TState extends object> =\n  StoreOptions<TState> & {\n    /** The storage to use for persisting the state. Defaults to local storage. */\n    storage?: StorageAPI | \"local\" | \"session\";\n    /** The serializer to use for storing the state. Defaults to JSON. */\n    serializer?: Serializer<TState>;\n  };\n\n/**\n * Creates a store that persists its state in local or session storage.\n * Defaults to local storage but this can be changed in the options.\n *\n * **Note:** The state needs to be serializable by whatever serializer you use. (JSON by default)\n * If you need something more versatile I would recommend using a library like [superjson](https://github.com/flightcontrolhq/superjson).\n *\n * @param {string} key - A unique key to identify the store in storage.\n * @param {TState} initialState - The initial state of the store.\n * @param {DefineActions<TState, TActions>} [defineActions] - A function to define actions for the store.\n * @param {PersistentStoreOptions<TState>} [options] - Additional options for the persistent store.\n *\n * @returns {Store<TState, TActions>} The created store.\n *\n * @example\n * Basic usage:\n * ```ts\n * import { createPersistentStore } from \"dharma-core\";\n *\n * const store = createPersistentStore(\"count\", { count: 0 }, (set) => ({\n *   increment: () => set((state) => ({ count: state.count + 1 })),\n *   decrement: () => set((state) => ({ count: state.count - 1 })),\n *   reset: () => set({ count: 0 }),\n * }));\n * ```\n * @example\n * With superjson serialization and session storage:\n * ```ts\n * import { createPersistentStore } from \"dharma-core\";\n * import superjson from \"superjson\";\n *\n * const store = createPersistentStore(\n *   \"count\",\n *   { count: 0 },\n *   (set) => ({\n *     increment: () => set((state) => ({ count: state.count + 1 })),\n *     decrement: () => set((state) => ({ count: state.count - 1 })),\n *     reset: () => set({ count: 0 }),\n *   }),\n *   {\n *     serializer: superjson,\n *     storage: \"session\",\n *   },\n * );\n * ```\n * @group Core\n */\nexport const createPersistentStore = <\n  TState extends object,\n  TActions extends object = Record<never, never>,\n>(\n  key: string,\n  initialState: TState,\n  defineActions: DefineActions<TState, TActions>,\n  {\n    storage: _storage = \"local\",\n    serializer = JSON,\n    onAttach,\n    onDetach,\n    onChange,\n    ...options\n  }: PersistentStoreOptions<TState> = {},\n): Store<TState, TActions> => {\n  if (typeof window === \"undefined\") {\n    return createStore(initialState, defineActions, options);\n  }\n\n  const storage = getStorage(_storage);\n  const stateKey = `store_${key}`;\n  const initialStateKey = `init_${key}`;\n  const initialStateSnapshot = storage.getItem(initialStateKey);\n  const initialStateString = serializer.stringify(initialState);\n\n  if (initialStateSnapshot !== initialStateString) {\n    storage.setItem(initialStateKey, initialStateString);\n    storage.removeItem(stateKey);\n  }\n\n  const updateSnapshot = (newState: TState) => {\n    const currentSnapshot = storage.getItem(stateKey);\n    const newSnapshot = serializer.stringify(newState);\n\n    if (newSnapshot !== currentSnapshot) {\n      storage.setItem(stateKey, newSnapshot);\n    }\n  };\n\n  const updateState = () => {\n    const currentSnapshot = storage.getItem(stateKey);\n\n    if (\n      currentSnapshot &&\n      currentSnapshot !== serializer.stringify(store.get())\n    ) {\n      store.set(serializer.parse(currentSnapshot));\n    }\n  };\n\n  const store = createStore(initialState, defineActions, {\n    onAttach: (...args) => {\n      onAttach?.(...args);\n      updateState();\n      window.addEventListener(\"focus\", updateState);\n    },\n    onDetach: (...args) => {\n      onDetach?.(...args);\n      window.removeEventListener(\"focus\", updateState);\n    },\n    onChange: (state, ...args) => {\n      onChange?.(state, ...args);\n      updateSnapshot(state);\n    },\n    ...options,\n  });\n\n  return store;\n};\n\nconst getStorage = (storage: StorageAPI | \"local\" | \"session\"): StorageAPI => {\n  switch (storage) {\n    case \"local\":\n      return localStorage;\n    case \"session\":\n      return sessionStorage;\n    default:\n      return storage;\n  }\n};\n"],"names":[],"mappings":";;AAsBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CG;AACI,MAAM,qBAAqB,GAAG,CAInC,GAAW,EACX,YAAoB,EACpB,aAA8C,EAC9C,EACE,OAAO,EAAE,QAAQ,GAAG,OAAO,EAC3B,UAAU,GAAG,IAAI,EACjB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,GAAG,OAAO,EAAA,GACwB,EAAE,KACX;AAC3B,IAAA,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,OAAO,WAAW,CAAC,YAAY,EAAE,aAAa,EAAE,OAAO,CAAC;IAC1D;AAEA,IAAA,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC;AACpC,IAAA,MAAM,QAAQ,GAAG,CAAA,MAAA,EAAS,GAAG,EAAE;AAC/B,IAAA,MAAM,eAAe,GAAG,CAAA,KAAA,EAAQ,GAAG,EAAE;IACrC,MAAM,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;IAC7D,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;AAE7D,IAAA,IAAI,oBAAoB,KAAK,kBAAkB,EAAE;AAC/C,QAAA,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC;AACpD,QAAA,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;IAC9B;AAEA,IAAA,MAAM,cAAc,GAAG,CAAC,QAAgB,KAAI;QAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;QACjD,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC;AAElD,QAAA,IAAI,WAAW,KAAK,eAAe,EAAE;AACnC,YAAA,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC;QACxC;AACF,IAAA,CAAC;IAED,MAAM,WAAW,GAAG,MAAK;QACvB,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;AAEjD,QAAA,IACE,eAAe;YACf,eAAe,KAAK,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EACrD;YACA,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9C;AACF,IAAA,CAAC;AAED,IAAA,MAAM,KAAK,GAAG,WAAW,CAAC,YAAY,EAAE,aAAa,EAAE;AACrD,QAAA,QAAQ,EAAE,CAAC,GAAG,IAAI,KAAI;AACpB,YAAA,QAAQ,GAAG,GAAG,IAAI,CAAC;AACnB,YAAA,WAAW,EAAE;AACb,YAAA,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC;QAC/C,CAAC;AACD,QAAA,QAAQ,EAAE,CAAC,GAAG,IAAI,KAAI;AACpB,YAAA,QAAQ,GAAG,GAAG,IAAI,CAAC;AACnB,YAAA,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC;QAClD,CAAC;AACD,QAAA,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,IAAI,KAAI;AAC3B,YAAA,QAAQ,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC;YAC1B,cAAc,CAAC,KAAK,CAAC;QACvB,CAAC;AACD,QAAA,GAAG,OAAO;AACX,KAAA,CAAC;AAEF,IAAA,OAAO,KAAK;AACd;AAEA,MAAM,UAAU,GAAG,CAAC,OAAyC,KAAgB;IAC3E,QAAQ,OAAO;AACb,QAAA,KAAK,OAAO;AACV,YAAA,OAAO,YAAY;AACrB,QAAA,KAAK,SAAS;AACZ,YAAA,OAAO,cAAc;AACvB,QAAA;AACE,YAAA,OAAO,OAAO;;AAEpB,CAAC;;;;"}
+{"version":3,"file":"createPersistentStore.js","sources":["../../../src/lib/createPersistentStore.ts"],"sourcesContent":["import { createStore, Store, StoreConfiguration } from \"./createStore\";\n\nexport type StorageAPI = {\n  getItem: (key: string) => string | null;\n  setItem: (key: string, value: string) => void;\n  removeItem: (key: string) => void;\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type Serializer<T = any> = {\n  stringify: (value: T) => string;\n  parse: (value: string) => T;\n};\n\nexport type PersistentStoreConfiguration<\n  TState extends object,\n  TActions extends object,\n> = StoreConfiguration<TState, TActions> & {\n  key: string;\n  /** The storage to use for persisting the state. Defaults to local storage if available. */\n  storage?: StorageAPI;\n  /** The serializer to use for storing the state. Defaults to JSON. */\n  serializer?: Serializer<TState>;\n};\n\n/**\n * Creates a store that persists its state in local or session storage.\n * Defaults to local storage but this can be changed in the options.\n *\n * **Note:** The state needs to be serializable by whatever serializer you use. (JSON by default)\n * If you need something more versatile I would recommend using a library like [superjson](https://github.com/flightcontrolhq/superjson).\n *\n * @param {PersistentStoreConfiguration<TState, TActions>} config - The configuration for the persistent store.\n *\n * @returns {Store<TState, TActions>} The created store.\n *\n * @example\n * Basic usage:\n * ```ts\n * import { createPersistentStore } from \"dharma-core\";\n *\n * const store = createPersistentStore({\n *   key: \"count\",\n *   initialState: { count: 0 },\n *   defineActions: ({ set }) => ({\n *     increment: () => set((state) => ({ count: state.count + 1 })),\n *     decrement: () => set((state) => ({ count: state.count - 1 })),\n *     reset: () => set({ count: 0 }),\n *   }),\n * });\n * ```\n * @example\n * With superjson serialization and session storage:\n * ```ts\n * import { createPersistentStore } from \"dharma-core\";\n * import superjson from \"superjson\";\n *\n * const store = createPersistentStore({\n *   key: \"count\",\n *   initialState: { count: 0 },\n *   defineActions: ({ set }) => ({\n *     increment: () => set((state) => ({ count: state.count + 1 })),\n *     decrement: () => set((state) => ({ count: state.count - 1 })),\n *     reset: () => set({ count: 0 }),\n *   }),\n *   serializer: superjson,\n *   storage: sessionStorage,\n * });\n * ```\n */\nexport const createPersistentStore = <\n  TState extends object,\n  TActions extends object = Record<never, never>,\n>(\n  config: PersistentStoreConfiguration<TState, TActions>,\n): Store<TState, TActions> => {\n  const {\n    key,\n    initialState,\n    storage: customStorage,\n    serializer = JSON,\n    onAttach,\n    onDetach,\n    onChange,\n    ...rest\n  } = config;\n\n  const IS_BROWSER = typeof window !== \"undefined\";\n  const storage = customStorage ?? (IS_BROWSER ? localStorage : undefined);\n\n  if (!storage) {\n    return createStore(config);\n  }\n\n  const initialStateKey = `init_${key}`;\n\n  const initialStateSnapshot = storage.getItem(initialStateKey);\n  const initialStateString = serializer.stringify(initialState);\n\n  if (initialStateSnapshot !== initialStateString) {\n    storage.setItem(initialStateKey, initialStateString);\n    storage.removeItem(key);\n  }\n\n  const updateSnapshot = (newState: TState) => {\n    const currentSnapshot = storage.getItem(key);\n    const newSnapshot = serializer.stringify(newState);\n\n    if (newSnapshot !== currentSnapshot) {\n      storage.setItem(key, newSnapshot);\n    }\n  };\n\n  const updateState = () => {\n    const currentSnapshot = storage.getItem(key);\n\n    if (\n      currentSnapshot &&\n      currentSnapshot !== serializer.stringify(store.get())\n    ) {\n      store.set(serializer.parse(currentSnapshot));\n    }\n  };\n\n  const store = createStore({\n    initialState,\n    onAttach: (ctx) => {\n      onAttach?.(ctx);\n      updateState();\n      if (IS_BROWSER) {\n        window.addEventListener(\"focus\", updateState);\n      }\n    },\n    onDetach: (ctx) => {\n      onDetach?.(ctx);\n      if (IS_BROWSER) {\n        window.removeEventListener(\"focus\", updateState);\n      }\n    },\n    onChange: ({ state, ...ctx }) => {\n      onChange?.({ state, ...ctx });\n      updateSnapshot(state);\n    },\n    ...rest,\n  });\n\n  return store;\n};\n"],"names":[],"mappings":";;AAyBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CG;AACI,MAAM,qBAAqB,GAAG,CAInC,MAAsD,KAC3B;IAC3B,MAAM,EACJ,GAAG,EACH,YAAY,EACZ,OAAO,EAAE,aAAa,EACtB,UAAU,GAAG,IAAI,EACjB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,GAAG,IAAI,EACR,GAAG,MAAM;AAEV,IAAA,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,WAAW;AAChD,IAAA,MAAM,OAAO,GAAG,aAAa,KAAK,UAAU,GAAG,YAAY,GAAG,SAAS,CAAC;IAExE,IAAI,CAAC,OAAO,EAAE;AACZ,QAAA,OAAO,WAAW,CAAC,MAAM,CAAC;IAC5B;AAEA,IAAA,MAAM,eAAe,GAAG,CAAA,KAAA,EAAQ,GAAG,EAAE;IAErC,MAAM,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;IAC7D,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;AAE7D,IAAA,IAAI,oBAAoB,KAAK,kBAAkB,EAAE;AAC/C,QAAA,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC;AACpD,QAAA,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;IACzB;AAEA,IAAA,MAAM,cAAc,GAAG,CAAC,QAAgB,KAAI;QAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;QAC5C,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC;AAElD,QAAA,IAAI,WAAW,KAAK,eAAe,EAAE;AACnC,YAAA,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC;QACnC;AACF,IAAA,CAAC;IAED,MAAM,WAAW,GAAG,MAAK;QACvB,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;AAE5C,QAAA,IACE,eAAe;YACf,eAAe,KAAK,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EACrD;YACA,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9C;AACF,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC;QACxB,YAAY;AACZ,QAAA,QAAQ,EAAE,CAAC,GAAG,KAAI;AAChB,YAAA,QAAQ,GAAG,GAAG,CAAC;AACf,YAAA,WAAW,EAAE;YACb,IAAI,UAAU,EAAE;AACd,gBAAA,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC;YAC/C;QACF,CAAC;AACD,QAAA,QAAQ,EAAE,CAAC,GAAG,KAAI;AAChB,YAAA,QAAQ,GAAG,GAAG,CAAC;YACf,IAAI,UAAU,EAAE;AACd,gBAAA,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC;YAClD;QACF,CAAC;QACD,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,GAAG,EAAE,KAAI;YAC9B,QAAQ,GAAG,EAAE,KAAK,EAAE,GAAG,GAAG,EAAE,CAAC;YAC7B,cAAc,CAAC,KAAK,CAAC;QACvB,CAAC;AACD,QAAA,GAAG,IAAI;AACR,KAAA,CAAC;AAEF,IAAA,OAAO,KAAK;AACd;;;;"}

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

@@ -1,19 +1,41 @@
+type Listener<TState extends object> = (state: TState) => void;
+export type SetState<TState extends object> = (stateModifier: StateModifier<TState>) => TState;
 export type Store<TState extends object, TActions extends object> = {
     /** Returns the current state of the store. */
     get: () => TState;
     /** Sets the state of the store. */
-    set: (stateModifier: StateModifier<TState>) => TState;
+    set: SetState<TState>;
+    /** Resets the state of the store to its initial value. */
+    reset: () => TState;
     /** Actions that can modify the state of the store. */
     actions: TActions;
     /** Subscribes to changes in the state of the store. Returns an unsubscribe function. */
     subscribe: (listener: Listener<TState>) => () => void;
 };
-type Listener<TState extends object> = (state: TState) => void;
-export type StoreEventHandler<TState extends object> = (state: TState, set: SetState<TState>) => void;
-export type SetState<TState extends object> = (stateModifier: StateModifier<TState>) => TState;
+export type EventHandlerContext<TState extends object> = {
+    /** The current state of the store. */
+    state: TState;
+    /** Sets the state of the store. */
+    set: SetState<TState>;
+    /** Resets the state of the store to its initial value. */
+    reset: () => TState;
+};
+export type StoreEventHandler<TState extends object> = (context: EventHandlerContext<TState>) => void;
 export type StateModifier<TState extends object> = Partial<TState> | ((state: TState) => Partial<TState>);
-export type DefineActions<TState extends object, TActions> = (set: (stateModifier: StateModifier<TState>) => TState, get: () => TState) => TActions;
-export type StoreOptions<TState extends object> = {
+export type StateFunctions<TState extends object> = {
+    /** Returns the current state of the store. */
+    get: () => TState;
+    /** Sets the state of the store. */
+    set: SetState<TState>;
+    /** Resets the state of the store to its initial value. */
+    reset: () => TState;
+};
+export type DefineActions<TState extends object, TActions> = (stateFunctions: StateFunctions<TState>) => TActions;
+export type StoreConfiguration<TState extends object, TActions extends object> = {
+    /** The initial state of the store. */
+    initialState: TState;
+    /** A function that defines actions that can modify the state. */
+    defineActions?: DefineActions<TState, TActions>;
     /** Invoked when the store is created. */
     onLoad?: StoreEventHandler<TState>;
     /** Invoked when the store is subscribed to. */
@@ -26,9 +48,7 @@ export type StoreOptions<TState extends object> = {
 /**
  * Creates a store with an initial state and actions that can modify the state.
  *
- * @param {TState} initialState - The initial state of the store.
- * @param {DefineActions<TState, TActions>} [defineActions] - A function that defines actions that can modify the state.
- * @param {StoreOptions<TState>} [options] - Additional options for the store.
+ * @param {StoreConfiguration<TState>} [config] - The configuration for the store.
  *
  * @returns {Store<TState, TActions>} The created store with state management methods.
  *
@@ -36,13 +56,14 @@ export type StoreOptions<TState extends object> = {
  * ```ts
  * import { createStore } from "dharma-core";
  *
- * const store = createStore({ count: 0 }, (set) => ({
- *   increment: () => set((state) => ({ count: state.count + 1 })),
- *   decrement: () => set((state) => ({ count: state.count - 1 })),
- *   reset: () => set({ count: 0 }),
- * }));
+ * const store = createStore({
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
+ *     increment: () => set((state) => ({ count: state.count + 1 })),
+ *     decrement: () => set((state) => ({ count: state.count - 1 })),
+ *   }),
+ * });
  * ```
- * @group Core
  */
-export declare const createStore: <TState extends object, TActions extends object = Record<never, never>>(initialState: TState, defineActions: DefineActions<TState, TActions>, { onLoad, onAttach, onDetach, onChange }?: StoreOptions<TState>) => Store<TState, TActions>;
+export declare const createStore: <TState extends object, TActions extends object = Record<never, never>>(config: StoreConfiguration<TState, TActions>) => Store<TState, TActions>;
 export {};

package/dist/esm/lib/createStore.js

@@ -3,9 +3,7 @@ import { merge } from './merge.js';
 /**
  * Creates a store with an initial state and actions that can modify the state.
  *
- * @param {TState} initialState - The initial state of the store.
- * @param {DefineActions<TState, TActions>} [defineActions] - A function that defines actions that can modify the state.
- * @param {StoreOptions<TState>} [options] - Additional options for the store.
+ * @param {StoreConfiguration<TState>} [config] - The configuration for the store.
  *
  * @returns {Store<TState, TActions>} The created store with state management methods.
  *
@@ -13,15 +11,17 @@ import { merge } from './merge.js';
  * ```ts
  * import { createStore } from "dharma-core";
  *
- * const store = createStore({ count: 0 }, (set) => ({
- *   increment: () => set((state) => ({ count: state.count + 1 })),
- *   decrement: () => set((state) => ({ count: state.count - 1 })),
- *   reset: () => set({ count: 0 }),
- * }));
+ * const store = createStore({
+ *   initialState: { count: 0 },
+ *   defineActions: ({ set }) => ({
+ *     increment: () => set((state) => ({ count: state.count + 1 })),
+ *     decrement: () => set((state) => ({ count: state.count - 1 })),
+ *   }),
+ * });
  * ```
- * @group Core
  */
-const createStore = (initialState, defineActions, { onLoad, onAttach, onDetach, onChange } = {}) => {
+const createStore = (config) => {
+    const { initialState, defineActions, onLoad, onAttach, onDetach, onChange } = config;
     let state = initialState;
     const listeners = new Set();
     const get = () => state;
@@ -29,8 +29,9 @@ const createStore = (initialState, defineActions, { onLoad, onAttach, onDetach,
         state = merge(state, stateModifier);
         return state;
     };
+    const resetSilently = () => setSilently(initialState);
     const dispatch = () => {
-        onChange?.(state, setSilently);
+        onChange?.({ state, set: setSilently, reset: resetSilently });
         listeners.forEach((listener) => listener(state));
     };
     const set = (stateModifier) => {
@@ -38,24 +39,32 @@ const createStore = (initialState, defineActions, { onLoad, onAttach, onDetach,
         dispatch();
         return state;
     };
+    const reset = () => {
+        resetSilently();
+        dispatch();
+        return state;
+    };
     const subscribe = (listener) => {
-        listener(state);
         if (listeners.size === 0) {
-            onAttach?.(state, set);
+            onAttach?.({ state, set, reset });
         }
+        listener(state);
         listeners.add(listener);
         return () => {
             listeners.delete(listener);
             if (listeners.size === 0) {
-                onDetach?.(state, set);
+                onDetach?.({ state, set, reset });
             }
         };
     };
-    const actions = defineActions ? defineActions(set, get) : {};
-    onLoad?.(state, set);
+    const actions = defineActions
+        ? defineActions({ set, get, reset })
+        : {};
+    onLoad?.({ state, set, reset });
     return {
         get,
         set,
+        reset,
         subscribe,
         actions,
     };

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

@@ -1 +1 @@
-{"version":3,"file":"createStore.js","sources":["../../../src/lib/createStore.ts"],"sourcesContent":["import { merge } from \"./merge\";\n\nexport type Store<TState extends object, TActions extends object> = {\n  /** Returns the current state of the store. */\n  get: () => TState;\n  /** Sets the state of the store. */\n  set: (stateModifier: StateModifier<TState>) => TState;\n  /** Actions that can modify the state of the store. */\n  actions: TActions;\n  /** Subscribes to changes in the state of the store. Returns an unsubscribe function. */\n  subscribe: (listener: Listener<TState>) => () => void;\n};\n\ntype Listener<TState extends object> = (state: TState) => void;\n\nexport type StoreEventHandler<TState extends object> = (\n  state: TState,\n  set: SetState<TState>,\n) => void;\n\nexport type SetState<TState extends object> = (\n  stateModifier: StateModifier<TState>,\n) => TState;\n\nexport type StateModifier<TState extends object> =\n  | Partial<TState>\n  | ((state: TState) => Partial<TState>);\n\nexport type DefineActions<TState extends object, TActions> = (\n  set: (stateModifier: StateModifier<TState>) => TState,\n  get: () => TState,\n) => TActions;\n\nexport type StoreOptions<TState extends object> = {\n  /** Invoked when the store is created. */\n  onLoad?: StoreEventHandler<TState>;\n  /** Invoked when the store is subscribed to. */\n  onAttach?: StoreEventHandler<TState>;\n  /** Invoked when the store is unsubscribed from. */\n  onDetach?: StoreEventHandler<TState>;\n  /** Invoked whenever the state changes. */\n  onChange?: StoreEventHandler<TState>;\n};\n\n/**\n * Creates a store with an initial state and actions that can modify the state.\n *\n * @param {TState} initialState - The initial state of the store.\n * @param {DefineActions<TState, TActions>} [defineActions] - A function that defines actions that can modify the state.\n * @param {StoreOptions<TState>} [options] - Additional options for the store.\n *\n * @returns {Store<TState, TActions>} The created store with state management methods.\n *\n * @example\n * ```ts\n * import { createStore } from \"dharma-core\";\n *\n * const store = createStore({ count: 0 }, (set) => ({\n *   increment: () => set((state) => ({ count: state.count + 1 })),\n *   decrement: () => set((state) => ({ count: state.count - 1 })),\n *   reset: () => set({ count: 0 }),\n * }));\n * ```\n * @group Core\n */\nexport const createStore = <\n  TState extends object,\n  TActions extends object = Record<never, never>,\n>(\n  initialState: TState,\n  defineActions: DefineActions<TState, TActions>,\n  { onLoad, onAttach, onDetach, onChange }: StoreOptions<TState> = {},\n): Store<TState, TActions> => {\n  let state = initialState;\n  const listeners = new Set<Listener<TState>>();\n\n  const get = () => state;\n\n  const setSilently = (stateModifier: StateModifier<TState>) => {\n    state = merge(state, stateModifier);\n    return state;\n  };\n\n  const dispatch = () => {\n    onChange?.(state, setSilently);\n    listeners.forEach((listener) => listener(state));\n  };\n\n  const set = (stateModifier: StateModifier<TState>) => {\n    setSilently(stateModifier);\n    dispatch();\n    return state;\n  };\n\n  const subscribe = (listener: Listener<TState>) => {\n    listener(state);\n    if (listeners.size === 0) {\n      onAttach?.(state, set);\n    }\n\n    listeners.add(listener);\n\n    return () => {\n      listeners.delete(listener);\n\n      if (listeners.size === 0) {\n        onDetach?.(state, set);\n      }\n    };\n  };\n\n  const actions = defineActions ? defineActions(set, get) : ({} as TActions);\n\n  onLoad?.(state, set);\n\n  return {\n    get,\n    set,\n    subscribe,\n    actions,\n  };\n};\n"],"names":[],"mappings":";;AA4CA;;;;;;;;;;;;;;;;;;;;AAoBG;MACU,WAAW,GAAG,CAIzB,YAAoB,EACpB,aAA8C,EAC9C,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAA,GAA2B,EAAE,KACxC;IAC3B,IAAI,KAAK,GAAG,YAAY;AACxB,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAoB;AAE7C,IAAA,MAAM,GAAG,GAAG,MAAM,KAAK;AAEvB,IAAA,MAAM,WAAW,GAAG,CAAC,aAAoC,KAAI;AAC3D,QAAA,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,aAAa,CAAC;AACnC,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;IAED,MAAM,QAAQ,GAAG,MAAK;AACpB,QAAA,QAAQ,GAAG,KAAK,EAAE,WAAW,CAAC;AAC9B,QAAA,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;AAClD,IAAA,CAAC;AAED,IAAA,MAAM,GAAG,GAAG,CAAC,aAAoC,KAAI;QACnD,WAAW,CAAC,aAAa,CAAC;AAC1B,QAAA,QAAQ,EAAE;AACV,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;AAED,IAAA,MAAM,SAAS,GAAG,CAAC,QAA0B,KAAI;QAC/C,QAAQ,CAAC,KAAK,CAAC;AACf,QAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;AACxB,YAAA,QAAQ,GAAG,KAAK,EAAE,GAAG,CAAC;QACxB;AAEA,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,QAAQ,GAAG,KAAK,EAAE,GAAG,CAAC;YACxB;AACF,QAAA,CAAC;AACH,IAAA,CAAC;AAED,IAAA,MAAM,OAAO,GAAG,aAAa,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAI,EAAe;AAE1E,IAAA,MAAM,GAAG,KAAK,EAAE,GAAG,CAAC;IAEpB,OAAO;QACL,GAAG;QACH,GAAG;QACH,SAAS;QACT,OAAO;KACR;AACH;;;;"}
+{"version":3,"file":"createStore.js","sources":["../../../src/lib/createStore.ts"],"sourcesContent":["import { merge } from \"./merge\";\n\ntype Listener<TState extends object> = (state: TState) => void;\n\nexport type SetState<TState extends object> = (\n  stateModifier: StateModifier<TState>,\n) => TState;\n\nexport type Store<TState extends object, TActions extends object> = {\n  /** Returns the current state of the store. */\n  get: () => TState;\n  /** Sets the state of the store. */\n  set: SetState<TState>;\n  /** Resets the state of the store to its initial value. */\n  reset: () => TState;\n  /** Actions that can modify the state of the store. */\n  actions: TActions;\n  /** Subscribes to changes in the state of the store. Returns an unsubscribe function. */\n  subscribe: (listener: Listener<TState>) => () => void;\n};\n\nexport type EventHandlerContext<TState extends object> = {\n  /** The current state of the store. */\n  state: TState;\n  /** Sets the state of the store. */\n  set: SetState<TState>;\n  /** Resets the state of the store to its initial value. */\n  reset: () => TState;\n};\n\nexport type StoreEventHandler<TState extends object> = (\n  context: EventHandlerContext<TState>,\n) => void;\n\nexport type StateModifier<TState extends object> =\n  | Partial<TState>\n  | ((state: TState) => Partial<TState>);\n\nexport type StateFunctions<TState extends object> = {\n  /** Returns the current state of the store. */\n  get: () => TState;\n  /** Sets the state of the store. */\n  set: SetState<TState>;\n  /** Resets the state of the store to its initial value. */\n  reset: () => TState;\n};\n\nexport type DefineActions<TState extends object, TActions> = (\n  stateFunctions: StateFunctions<TState>,\n) => TActions;\n\nexport type StoreConfiguration<\n  TState extends object,\n  TActions extends object,\n> = {\n  /** The initial state of the store. */\n  initialState: TState;\n  /** A function that defines actions that can modify the state. */\n  defineActions?: DefineActions<TState, TActions>;\n  /** Invoked when the store is created. */\n  onLoad?: StoreEventHandler<TState>;\n  /** Invoked when the store is subscribed to. */\n  onAttach?: StoreEventHandler<TState>;\n  /** Invoked when the store is unsubscribed from. */\n  onDetach?: StoreEventHandler<TState>;\n  /** Invoked whenever the state changes. */\n  onChange?: StoreEventHandler<TState>;\n};\n\n/**\n * Creates a store with an initial state and actions that can modify the state.\n *\n * @param {StoreConfiguration<TState>} [config] - The configuration for the store.\n *\n * @returns {Store<TState, TActions>} The created store with state management methods.\n *\n * @example\n * ```ts\n * import { createStore } from \"dharma-core\";\n *\n * const store = createStore({\n *   initialState: { count: 0 },\n *   defineActions: ({ set }) => ({\n *     increment: () => set((state) => ({ count: state.count + 1 })),\n *     decrement: () => set((state) => ({ count: state.count - 1 })),\n *   }),\n * });\n * ```\n */\nexport const createStore = <\n  TState extends object,\n  TActions extends object = Record<never, never>,\n>(\n  config: StoreConfiguration<TState, TActions>,\n): Store<TState, TActions> => {\n  const { initialState, defineActions, onLoad, onAttach, onDetach, onChange } =\n    config;\n\n  let state = initialState;\n  const listeners = new Set<Listener<TState>>();\n\n  const get = () => state;\n\n  const setSilently = (stateModifier: StateModifier<TState>) => {\n    state = merge(state, stateModifier);\n    return state;\n  };\n\n  const resetSilently = () => setSilently(initialState);\n\n  const dispatch = () => {\n    onChange?.({ state, set: setSilently, reset: resetSilently });\n    listeners.forEach((listener) => listener(state));\n  };\n\n  const set = (stateModifier: StateModifier<TState>) => {\n    setSilently(stateModifier);\n    dispatch();\n    return state;\n  };\n\n  const reset = () => {\n    resetSilently();\n    dispatch();\n    return state;\n  };\n\n  const subscribe = (listener: Listener<TState>) => {\n    if (listeners.size === 0) {\n      onAttach?.({ state, set, reset });\n    }\n\n    listener(state);\n    listeners.add(listener);\n\n    return () => {\n      listeners.delete(listener);\n\n      if (listeners.size === 0) {\n        onDetach?.({ state, set, reset });\n      }\n    };\n  };\n\n  const actions = defineActions\n    ? defineActions({ set, get, reset })\n    : ({} as TActions);\n\n  onLoad?.({ state, set, reset });\n\n  return {\n    get,\n    set,\n    reset,\n    subscribe,\n    actions,\n  };\n};\n"],"names":[],"mappings":";;AAqEA;;;;;;;;;;;;;;;;;;;AAmBG;AACI,MAAM,WAAW,GAAG,CAIzB,MAA4C,KACjB;AAC3B,IAAA,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,GACzE,MAAM;IAER,IAAI,KAAK,GAAG,YAAY;AACxB,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAoB;AAE7C,IAAA,MAAM,GAAG,GAAG,MAAM,KAAK;AAEvB,IAAA,MAAM,WAAW,GAAG,CAAC,aAAoC,KAAI;AAC3D,QAAA,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,aAAa,CAAC;AACnC,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC;IAErD,MAAM,QAAQ,GAAG,MAAK;AACpB,QAAA,QAAQ,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;AAC7D,QAAA,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;AAClD,IAAA,CAAC;AAED,IAAA,MAAM,GAAG,GAAG,CAAC,aAAoC,KAAI;QACnD,WAAW,CAAC,aAAa,CAAC;AAC1B,QAAA,QAAQ,EAAE;AACV,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;IAED,MAAM,KAAK,GAAG,MAAK;AACjB,QAAA,aAAa,EAAE;AACf,QAAA,QAAQ,EAAE;AACV,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;AAED,IAAA,MAAM,SAAS,GAAG,CAAC,QAA0B,KAAI;AAC/C,QAAA,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;YACxB,QAAQ,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QACnC;QAEA,QAAQ,CAAC,KAAK,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;gBACxB,QAAQ,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;YACnC;AACF,QAAA,CAAC;AACH,IAAA,CAAC;IAED,MAAM,OAAO,GAAG;UACZ,aAAa,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE;UAChC,EAAe;IAEpB,MAAM,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;IAE/B,OAAO;QACL,GAAG;QACH,GAAG;QACH,KAAK;QACL,SAAS;QACT,OAAO;KACR;AACH;;;;"}

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

@@ -3,22 +3,22 @@ import { StateModifier } from "./createStore";
  * Merges the current state with a state modifier.
  * Useful for creating custom set functions.
  *
- * @param {T} stateModifier - A function or object that modifies the state.
- * @param {StateModifier<T>} stateModifier - The current state object.
+ * @param {T} currentState - The current state object.
+ * @param {StateModifier<T>} stateModifier - A function or object that modifies the state.
  * @returns {T} The new state object, which is a combination of the current state and the state modifier.
  *
  * @example
  * ```ts
  * import { createStore, merge, StateModifier } from "dharma-core";
  *
- * const store = createStore(
- *   {
+ * const store = createStore({
+ *   initialState: {
  *     counter: {
  *       count: 0,
  *     },
  *     // ...
  *   },
- *   (set) => {
+ *   defineActions: ({ set }) => {
  *     const setCounter = (counter: StateModifier<{ count: number }>) =>
  *       set((state) => ({
  *         counter: merge(state.counter, counter),
@@ -31,8 +31,7 @@ import { StateModifier } from "./createStore";
  *       // ...
  *     };
  *   },
- * );
+ * });
  * ```
- * @group Utilities
  */
 export declare const merge: <T extends object>(currentState: T, stateModifier: StateModifier<T>) => T;

package/dist/esm/lib/merge.js

@@ -2,22 +2,22 @@
  * Merges the current state with a state modifier.
  * Useful for creating custom set functions.
  *
- * @param {T} stateModifier - A function or object that modifies the state.
- * @param {StateModifier<T>} stateModifier - The current state object.
+ * @param {T} currentState - The current state object.
+ * @param {StateModifier<T>} stateModifier - A function or object that modifies the state.
  * @returns {T} The new state object, which is a combination of the current state and the state modifier.
  *
  * @example
  * ```ts
  * import { createStore, merge, StateModifier } from "dharma-core";
  *
- * const store = createStore(
- *   {
+ * const store = createStore({
+ *   initialState: {
  *     counter: {
  *       count: 0,
  *     },
  *     // ...
  *   },
- *   (set) => {
+ *   defineActions: ({ set }) => {
  *     const setCounter = (counter: StateModifier<{ count: number }>) =>
  *       set((state) => ({
  *         counter: merge(state.counter, counter),
@@ -30,9 +30,8 @@
  *       // ...
  *     };
  *   },
- * );
+ * });
  * ```
- * @group Utilities
  */
 const merge = (currentState, stateModifier) => {
     const newState = typeof stateModifier === "function"

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

@@ -1 +1 @@
-{"version":3,"file":"merge.js","sources":["../../../src/lib/merge.ts"],"sourcesContent":["import { StateModifier } from \"./createStore\";\n\n/**\n * Merges the current state with a state modifier.\n * Useful for creating custom set functions.\n *\n * @param {T} stateModifier - A function or object that modifies the state.\n * @param {StateModifier<T>} stateModifier - The current state object.\n * @returns {T} The new state object, which is a combination of the current state and the state modifier.\n *\n * @example\n * ```ts\n * import { createStore, merge, StateModifier } from \"dharma-core\";\n *\n * const store = createStore(\n *   {\n *     counter: {\n *       count: 0,\n *     },\n *     // ...\n *   },\n *   (set) => {\n *     const setCounter = (counter: StateModifier<{ count: number }>) =>\n *       set((state) => ({\n *         counter: merge(state.counter, counter),\n *       }));\n *\n *     return {\n *       increment: () => setCounter((state) => ({ count: state.count + 1 })),\n *       decrement: () => setCounter((state) => ({ count: state.count - 1 })),\n *       reset: () => setCounter({ count: 0 }),\n *       // ...\n *     };\n *   },\n * );\n * ```\n * @group Utilities\n */\nexport const merge = <T extends object>(\n  currentState: T,\n  stateModifier: StateModifier<T>,\n): T => {\n  const newState =\n    typeof stateModifier === \"function\"\n      ? stateModifier(currentState)\n      : stateModifier;\n  return { ...currentState, ...newState };\n};\n"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCG;MACU,KAAK,GAAG,CACnB,YAAe,EACf,aAA+B,KAC1B;AACL,IAAA,MAAM,QAAQ,GACZ,OAAO,aAAa,KAAK;AACvB,UAAE,aAAa,CAAC,YAAY;UAC1B,aAAa;AACnB,IAAA,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,QAAQ,EAAE;AACzC;;;;"}
+{"version":3,"file":"merge.js","sources":["../../../src/lib/merge.ts"],"sourcesContent":["import { StateModifier } from \"./createStore\";\n\n/**\n * Merges the current state with a state modifier.\n * Useful for creating custom set functions.\n *\n * @param {T} currentState - The current state object.\n * @param {StateModifier<T>} stateModifier - A function or object that modifies the state.\n * @returns {T} The new state object, which is a combination of the current state and the state modifier.\n *\n * @example\n * ```ts\n * import { createStore, merge, StateModifier } from \"dharma-core\";\n *\n * const store = createStore({\n *   initialState: {\n *     counter: {\n *       count: 0,\n *     },\n *     // ...\n *   },\n *   defineActions: ({ set }) => {\n *     const setCounter = (counter: StateModifier<{ count: number }>) =>\n *       set((state) => ({\n *         counter: merge(state.counter, counter),\n *       }));\n *\n *     return {\n *       increment: () => setCounter((state) => ({ count: state.count + 1 })),\n *       decrement: () => setCounter((state) => ({ count: state.count - 1 })),\n *       reset: () => setCounter({ count: 0 }),\n *       // ...\n *     };\n *   },\n * });\n * ```\n */\nexport const merge = <T extends object>(\n  currentState: T,\n  stateModifier: StateModifier<T>,\n): T => {\n  const newState =\n    typeof stateModifier === \"function\"\n      ? stateModifier(currentState)\n      : stateModifier;\n  return { ...currentState, ...newState };\n};\n"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCG;MACU,KAAK,GAAG,CACnB,YAAe,EACf,aAA+B,KAC1B;AACL,IAAA,MAAM,QAAQ,GACZ,OAAO,aAAa,KAAK;AACvB,UAAE,aAAa,CAAC,YAAY;UAC1B,aAAa;AACnB,IAAA,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,QAAQ,EAAE;AACzC;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dharma-core",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "author": "Frans Ekman <fransedvinekman@gmail.com>",
   "license": "MIT",
   "description": "My package description",