@yaasl/core 0.13.0-alpha.4 → 0.13.0

package/dist/@types/effects/auto-sort.d.ts

@@ -0,0 +1,13 @@
+export interface AutoSortOptions<TData> {
+    /** Function to sort the atom value. */
+    sortFn?: (a: TData, b: TData) => number;
+}
+/** Middleware to automatically sort the atom value.
+ *  Only supports arrays and nullish values.
+ *
+ * @param {AutoSortOptions | undefined} options
+ * @param options.sortFn Function to sort the atom value.
+ *
+ * @returns The effect to be used on atoms.
+ **/
+export declare const autoSort: <TData>({ sortFn }: AutoSortOptions<TData>) => import("./create-effect").EffectAtomCallback<AutoSortOptions<TData>, TData[] | null | undefined>;

package/dist/@types/effects/index.d.ts

@@ -1,5 +1,7 @@
 export { createEffect } from "./create-effect";
 export type { Effect, EffectPayload, EffectAtomCallback } from "./create-effect";
+export { autoSort } from "./auto-sort";
+export type { AutoSortOptions } from "./auto-sort";
 export { localStorage } from "./local-storage";
 export type { LocalStorageOptions } from "./local-storage";
 export { sessionStorage } from "./session-storage";

package/dist/cjs/effects/auto-sort.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.autoSort = void 0;
+const utils_1 = require("@yaasl/utils");
+const create_effect_1 = require("./create-effect");
+const forceArray = (value, atom) => {
+    if (value == null)
+        return [];
+    if (Array.isArray(value))
+        return value;
+    const message = (0, utils_1.consoleMessage)(`Value type is not compatile with the autoSort effect. Value must be an array or nullish.`, { scope: atom.name });
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    throw new Error(message + "\nValue: " + String(value));
+};
+/** Middleware to automatically sort the atom value.
+ *  Only supports arrays and nullish values.
+ *
+ * @param {AutoSortOptions | undefined} options
+ * @param options.sortFn Function to sort the atom value.
+ *
+ * @returns The effect to be used on atoms.
+ **/
+const autoSort = ({ sortFn }) => {
+    const sortEffect = (0, create_effect_1.createEffect)({
+        sort: "pre",
+        init: ({ atom, value, options, set }) => {
+            const array = forceArray(value, atom);
+            set(array.toSorted(options.sortFn));
+        },
+        set: ({ atom, value, options, set }) => {
+            const array = forceArray(value, atom);
+            set(array.toSorted(options.sortFn));
+        },
+    });
+    return sortEffect({ sortFn });
+};
+exports.autoSort = autoSort;

package/dist/cjs/effects/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMigrationStep = exports.migration = exports.expiration = exports.indexedDb = exports.sessionStorage = exports.localStorage = exports.createEffect = void 0;
+exports.createMigrationStep = exports.migration = exports.expiration = exports.indexedDb = exports.sessionStorage = exports.localStorage = exports.autoSort = exports.createEffect = void 0;
 var create_effect_1 = require("./create-effect");
 Object.defineProperty(exports, "createEffect", { enumerable: true, get: function () { return create_effect_1.createEffect; } });
+var auto_sort_1 = require("./auto-sort");
+Object.defineProperty(exports, "autoSort", { enumerable: true, get: function () { return auto_sort_1.autoSort; } });
 var local_storage_1 = require("./local-storage");
 Object.defineProperty(exports, "localStorage", { enumerable: true, get: function () { return local_storage_1.localStorage; } });
 var session_storage_1 = require("./session-storage");

package/dist/cjs/effects/indexed-db.js

@@ -18,9 +18,24 @@ let atomDb = null;
 const createSync = (storeKey, onTabSync) => {
     const key = (0, get_scoped_key_1.getScopedKey)(storeKey);
     const channel = new BroadcastChannel(key);
-    channel.onmessage = () => onTabSync();
+    let changeTrigger = null;
+    channel.onmessage = () => {
+        if (changeTrigger === "self") {
+            changeTrigger = null;
+            return;
+        }
+        changeTrigger = "sync";
+        onTabSync();
+    };
     return {
-        pushSync: () => channel.postMessage("sync"),
+        pushSync: () => {
+            if (changeTrigger === "sync") {
+                changeTrigger = null;
+                return;
+            }
+            changeTrigger = "self";
+            channel.postMessage("sync");
+        },
     };
 };
 /** Middleware to save and load atom values to an indexedDb.
@@ -60,9 +75,12 @@ exports.indexedDb = (0, create_effect_1.createEffect)(({ atom, options }) => {
                 yield atomDb.set(key, atom.defaultValue);
             }
         }),
-        set: ({ value }) => {
-            // don't wait to set the atom value,directly pass it into the atom
-            void (atomDb === null || atomDb === void 0 ? void 0 : atomDb.set(key, value).then(pushSync));
+        set: ({ value, atom }) => {
+            const action = value === atom.defaultValue
+                ? atomDb === null || atomDb === void 0 ? void 0 : atomDb.delete(key)
+                : atomDb === null || atomDb === void 0 ? void 0 : atomDb.set(key, value);
+            // don't wait to set the atom value, directly pass it into the atom
+            void (action === null || action === void 0 ? void 0 : action.then(pushSync));
         },
     };
 });

package/dist/esm/effects/auto-sort.js

@@ -0,0 +1,33 @@
+import { consoleMessage } from "@yaasl/utils";
+import { createEffect } from "./create-effect";
+const forceArray = (value, atom) => {
+    if (value == null)
+        return [];
+    if (Array.isArray(value))
+        return value;
+    const message = consoleMessage(`Value type is not compatile with the autoSort effect. Value must be an array or nullish.`, { scope: atom.name });
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    throw new Error(message + "\nValue: " + String(value));
+};
+/** Middleware to automatically sort the atom value.
+ *  Only supports arrays and nullish values.
+ *
+ * @param {AutoSortOptions | undefined} options
+ * @param options.sortFn Function to sort the atom value.
+ *
+ * @returns The effect to be used on atoms.
+ **/
+export const autoSort = ({ sortFn }) => {
+    const sortEffect = createEffect({
+        sort: "pre",
+        init: ({ atom, value, options, set }) => {
+            const array = forceArray(value, atom);
+            set(array.toSorted(options.sortFn));
+        },
+        set: ({ atom, value, options, set }) => {
+            const array = forceArray(value, atom);
+            set(array.toSorted(options.sortFn));
+        },
+    });
+    return sortEffect({ sortFn });
+};

package/dist/esm/effects/index.js

@@ -1,4 +1,5 @@
 export { createEffect } from "./create-effect";
+export { autoSort } from "./auto-sort";
 export { localStorage } from "./local-storage";
 export { sessionStorage } from "./session-storage";
 export { indexedDb } from "./indexed-db";

package/dist/esm/effects/indexed-db.js

@@ -6,9 +6,24 @@ let atomDb = null;
 const createSync = (storeKey, onTabSync) => {
     const key = getScopedKey(storeKey);
     const channel = new BroadcastChannel(key);
-    channel.onmessage = () => onTabSync();
+    let changeTrigger = null;
+    channel.onmessage = () => {
+        if (changeTrigger === "self") {
+            changeTrigger = null;
+            return;
+        }
+        changeTrigger = "sync";
+        onTabSync();
+    };
     return {
-        pushSync: () => channel.postMessage("sync"),
+        pushSync: () => {
+            if (changeTrigger === "sync") {
+                changeTrigger = null;
+                return;
+            }
+            changeTrigger = "self";
+            channel.postMessage("sync");
+        },
     };
 };
 /** Middleware to save and load atom values to an indexedDb.
@@ -46,9 +61,12 @@ export const indexedDb = createEffect(({ atom, options }) => {
                 await atomDb.set(key, atom.defaultValue);
             }
         },
-        set: ({ value }) => {
-            // don't wait to set the atom value,directly pass it into the atom
-            void atomDb?.set(key, value).then(pushSync);
+        set: ({ value, atom }) => {
+            const action = value === atom.defaultValue
+                ? atomDb?.delete(key)
+                : atomDb?.set(key, value);
+            // don't wait to set the atom value, directly pass it into the atom
+            void action?.then(pushSync);
         },
     };
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaasl/core",
-  "version": "0.13.0-alpha.4",
+  "version": "0.13.0",
   "description": "yet another atomic store library (vanilla-js)",
   "author": "PrettyCoffee",
   "license": "MIT",
@@ -40,10 +40,10 @@
     "validate": "run-s lint test build"
   },
   "peerDependencies": {
-    "@yaasl/utils": "^0.12.1"
+    "@yaasl/utils": "^0.13.0"
   },
   "devDependencies": {
-    "@yaasl/utils": "^0.12.1"
+    "@yaasl/utils": "^0.13.0"
   },
   "lint-staged": {
     "*.{ts,tsx}": [