@yaasl/core 0.14.0-alpha.0 → 0.14.0-alpha.2

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

@@ -5,11 +5,9 @@ export interface ExpirationOptions {
     expiresIn?: number | (() => number);
 }
 /** Effect to make an atom value expirable and reset to its defaulValue.
- *
- * __Note:__ When using `expiresAt`, a function returning the date should be prefered since using a static date might end in an infinite loop.
  *
  * @param {ExpirationOptions | undefined} options
- * @param options.expiresAt Date at which the value expires
+ * @param options.expiresAt Date at which the value expires. Using a function returning the date should be prefered here, since using a static date might end in an infinite loop.
  * @param options.expiresIn Milliseconds in which the value expires. Will be ignored if expiresAt is set.
  *
  * @returns The effect to be used on atoms.

package/dist/@types/effects/indexed-db.d.ts

@@ -14,4 +14,9 @@ export interface IndexedDbOptions {
  *
  * @returns The effect to be used on atoms.
  **/
-export declare const indexedDb: (...[optionsArg]: [] | [undefined] | [IndexedDbOptions]) => import("./create-effect").EffectAtomCallback<IndexedDbOptions | undefined, unknown>;
+export declare const indexedDb: ((...[optionsArg]: [] | [undefined] | [IndexedDbOptions]) => import("./create-effect").EffectAtomCallback<IndexedDbOptions | undefined, unknown>) & {
+    get: (key: string) => Promise<unknown>;
+    getAllKeys: () => Promise<string[]>;
+    set: (key: string, value: unknown) => Promise<IDBValidKey | undefined>;
+    delete: (key: string) => Promise<undefined>;
+};

package/dist/@types/utils/idb-store.d.ts

@@ -1,8 +1,9 @@
-export declare class IdbStore<T> {
+export declare class IdbStore<T = unknown> {
     private name;
     private database?;
     constructor(name: string);
     private getStore;
+    getAllKeys(): Promise<string[]>;
     get(key: string): Promise<T | undefined>;
     set(key: string, value: T): Promise<IDBValidKey | undefined>;
     delete(key: string): Promise<undefined>;

package/dist/cjs/effects/expiration.js

@@ -23,11 +23,9 @@ const syncOverBrowserTabs = (observingKey, onChange) => {
     });
 };
 /** Effect to make an atom value expirable and reset to its defaulValue.
- *
- * __Note:__ When using `expiresAt`, a function returning the date should be prefered since using a static date might end in an infinite loop.
  *
  * @param {ExpirationOptions | undefined} options
- * @param options.expiresAt Date at which the value expires
+ * @param options.expiresAt Date at which the value expires. Using a function returning the date should be prefered here, since using a static date might end in an infinite loop.
  * @param options.expiresIn Milliseconds in which the value expires. Will be ignored if expiresAt is set.
  *
  * @returns The effect to be used on atoms.

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

@@ -14,6 +14,13 @@ const create_effect_1 = require("./create-effect");
 const base_1 = require("../base");
 const idb_store_1 = require("../utils/idb-store");
 let atomDb = null;
+const getAtomDb = () => {
+    var _a;
+    if (!atomDb) {
+        atomDb = new idb_store_1.IdbStore((_a = base_1.CONFIG.name) !== null && _a !== void 0 ? _a : "yaasl");
+    }
+    return atomDb;
+};
 /** Middleware to save and load atom values to an indexedDb.
  *
  *  Will use one database and store for all atoms with your `CONFIG.name`
@@ -26,16 +33,13 @@ let atomDb = null;
  *
  * @returns The effect to be used on atoms.
  **/
-exports.indexedDb = (0, create_effect_1.createEffect)(({ atom, options }) => {
+exports.indexedDb = Object.assign((0, create_effect_1.createEffect)(({ atom, options }) => {
     var _a;
     const key = (_a = options === null || options === void 0 ? void 0 : options.key) !== null && _a !== void 0 ? _a : atom.name;
     return {
         sort: "pre",
         init: (_a) => __awaiter(void 0, [_a], void 0, function* ({ atom, set }) {
-            var _b;
-            if (!atomDb) {
-                atomDb = new idb_store_1.IdbStore((_b = base_1.CONFIG.name) !== null && _b !== void 0 ? _b : "yaasl");
-            }
+            const atomDb = getAtomDb();
             const existing = yield atomDb.get(key);
             if (existing != null) {
                 set(existing);
@@ -54,4 +58,9 @@ exports.indexedDb = (0, create_effect_1.createEffect)(({ atom, options }) => {
             }
         },
     };
+}), {
+    get: (key) => getAtomDb().get(key),
+    getAllKeys: () => getAtomDb().getAllKeys(),
+    set: (key, value) => getAtomDb().set(key, value),
+    delete: (key) => getAtomDb().delete(key),
 });

package/dist/cjs/utils/idb-store.js

@@ -37,6 +37,11 @@ class IdbStore {
             return database === null || database === void 0 ? void 0 : database.transaction(this.name, mode).objectStore(this.name);
         });
     }
+    getAllKeys() {
+        return this.getStore("readonly").then(store => !store
+            ? []
+            : promisifyRequest(store.getAllKeys()).then(keys => keys.map(String)));
+    }
     get(key) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.getStore("readonly").then(store => !store ? undefined : promisifyRequest(store.get(key)));

package/dist/esm/effects/expiration.js

@@ -16,11 +16,9 @@ const syncOverBrowserTabs = (observingKey, onChange) => getWindow()?.addEventLis
     onChange(newValue);
 });
 /** Effect to make an atom value expirable and reset to its defaulValue.
- *
- * __Note:__ When using `expiresAt`, a function returning the date should be prefered since using a static date might end in an infinite loop.
  *
  * @param {ExpirationOptions | undefined} options
- * @param options.expiresAt Date at which the value expires
+ * @param options.expiresAt Date at which the value expires. Using a function returning the date should be prefered here, since using a static date might end in an infinite loop.
  * @param options.expiresIn Milliseconds in which the value expires. Will be ignored if expiresAt is set.
  *
  * @returns The effect to be used on atoms.

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

@@ -2,6 +2,12 @@ import { createEffect } from "./create-effect";
 import { CONFIG } from "../base";
 import { IdbStore } from "../utils/idb-store";
 let atomDb = null;
+const getAtomDb = () => {
+    if (!atomDb) {
+        atomDb = new IdbStore(CONFIG.name ?? "yaasl");
+    }
+    return atomDb;
+};
 /** Middleware to save and load atom values to an indexedDb.
  *
  *  Will use one database and store for all atoms with your `CONFIG.name`
@@ -14,14 +20,12 @@ let atomDb = null;
  *
  * @returns The effect to be used on atoms.
  **/
-export const indexedDb = createEffect(({ atom, options }) => {
+export const indexedDb = Object.assign(createEffect(({ atom, options }) => {
     const key = options?.key ?? atom.name;
     return {
         sort: "pre",
         init: async ({ atom, set }) => {
-            if (!atomDb) {
-                atomDb = new IdbStore(CONFIG.name ?? "yaasl");
-            }
+            const atomDb = getAtomDb();
             const existing = await atomDb.get(key);
             if (existing != null) {
                 set(existing);
@@ -40,4 +44,9 @@ export const indexedDb = createEffect(({ atom, options }) => {
             }
         },
     };
+}), {
+    get: (key) => getAtomDb().get(key),
+    getAllKeys: () => getAtomDb().getAllKeys(),
+    set: (key, value) => getAtomDb().set(key, value),
+    delete: (key) => getAtomDb().delete(key),
 });

package/dist/esm/utils/idb-store.js

@@ -24,6 +24,11 @@ export class IdbStore {
         const database = await this.database;
         return database?.transaction(this.name, mode).objectStore(this.name);
     }
+    getAllKeys() {
+        return this.getStore("readonly").then(store => !store
+            ? []
+            : promisifyRequest(store.getAllKeys()).then(keys => keys.map(String)));
+    }
     async get(key) {
         return this.getStore("readonly").then(store => !store ? undefined : promisifyRequest(store.get(key)));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaasl/core",
-  "version": "0.14.0-alpha.0",
+  "version": "0.14.0-alpha.2",
   "description": "yet another atomic store library (vanilla-js)",
   "author": "PrettyCoffee",
   "license": "MIT",