@exodus/atoms 7.3.2 → 7.4.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.4.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@7.3.3...@exodus/atoms@7.4.0) (2024-05-24)
+
+### Features
+
+- add storage cache atom enhancer ([#7083](https://github.com/ExodusMovement/exodus-hydra/issues/7083)) ([3983ac6](https://github.com/ExodusMovement/exodus-hydra/commit/3983ac610808a0d70b106829998362dd3b52c263))
+
+## [7.3.3](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@7.3.2...@exodus/atoms@7.3.3) (2024-05-17)
+
+### Bug Fixes
+
+- relax type for atom supplied to compute ([#6995](https://github.com/ExodusMovement/exodus-hydra/issues/6995)) ([929c5aa](https://github.com/ExodusMovement/exodus-hydra/commit/929c5aad1a2a3b05369068bdeeac7f5e84184696))
+
 ## [7.3.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@7.3.1...@exodus/atoms@7.3.2) (2024-05-09)
 
 ### Bug Fixes

package/lib/enhancers/compute.d.ts

@@ -1,6 +1,6 @@
 import { Atom, ReadonlyAtom } from '../utils/types.js';
 type Params<T, V> = {
-    atom: Atom<T>;
+    atom: Atom<T> | ReadonlyAtom<T>;
     selector: (value: T) => V;
 };
 declare const compute: <T, V>({ atom, selector }: Params<T, V>) => ReadonlyAtom<V>;

package/lib/enhancers/compute.js

@@ -18,11 +18,12 @@ const compute = ({ atom, selector }) => {
             return callback(selected);
         });
     };
-    return {
+    const computed = {
         ...atom,
         get,
         set,
         observe,
     };
+    return computed;
 };
 export default compute;

package/lib/enhancers/with-storage-cache.d.ts

@@ -0,0 +1,10 @@
+import { Atom } from '../utils/types.js';
+import { Storage } from '@exodus/storage-interface';
+type Params<T> = {
+    atom: Atom<T>;
+    storage: Storage<T>;
+    key: string;
+    logger: Pick<Console, 'warn'>;
+};
+declare const withStorageCache: <T>(params: Params<T>) => Atom<T>;
+export default withStorageCache;

package/lib/enhancers/with-storage-cache.js

@@ -0,0 +1,49 @@
+import createStorageAtomFactory from '../factories/storage.js';
+const getCacheAtom = ({ storage, key }) => {
+    const createStorageAtom = createStorageAtomFactory({ storage });
+    return createStorageAtom({ key });
+};
+const enhanceAtom = (params) => {
+    const { atom, logger } = params;
+    const cacheAtom = getCacheAtom(params);
+    let hasCache = false;
+    const setCache = async (fresh) => {
+        try {
+            await cacheAtom.set(fresh);
+            hasCache = true;
+        }
+        catch (error) {
+            logger.warn('Failed to write to cache atom', error);
+        }
+    };
+    const readCache = async () => {
+        try {
+            return (await cacheAtom.get());
+        }
+        catch (error) {
+            logger.warn('Failed to read from cache atom, returning fresh', error);
+            return readFresh();
+        }
+    };
+    const readFresh = async () => {
+        const fresh = await atom.get();
+        await setCache(fresh);
+        return fresh;
+    };
+    const set = async (value) => {
+        await atom.set(value);
+        hasCache = false;
+    };
+    const get = async () => {
+        return hasCache ? readCache() : readFresh();
+    };
+    const reset = async () => {
+        await atom.reset();
+        hasCache = false;
+    };
+    return { ...atom, get, set, reset };
+};
+const withStorageCache = (params) => {
+    return enhanceAtom(params);
+};
+export default withStorageCache;

package/lib/factories/observer.d.ts

@@ -1,6 +1,6 @@
-import { Atom, Port } from '../utils/types.js';
+import { ReadonlyAtom, Port } from '../utils/types.js';
 type Params<T> = {
-    atom: Atom<T>;
+    atom: ReadonlyAtom<T>;
     port: Port<T>;
     event: string;
     immediateRegister?: boolean;

package/lib/index.d.ts

@@ -17,6 +17,7 @@ export { default as swallowObserverErrors } from './enhancers/swallow-observer-e
 export { default as timeoutObservers } from './enhancers/timeout-observers.js';
 export { default as optimisticNotifier } from './enhancers/optimistic-notifier.js';
 export { default as mergeWithValue } from './enhancers/merge-with-value.js';
+export { default as withStorageCache } from './enhancers/with-storage-cache.js';
 export { default as waitUntil } from './effects/wait-until.js';
 export { default as enforceObservableRules } from './enforce-rules.js';
 export { default as fromEventEmitter } from './event-emitter.js';

package/lib/index.js

@@ -17,6 +17,7 @@ export { default as swallowObserverErrors } from './enhancers/swallow-observer-e
 export { default as timeoutObservers } from './enhancers/timeout-observers.js';
 export { default as optimisticNotifier } from './enhancers/optimistic-notifier.js';
 export { default as mergeWithValue } from './enhancers/merge-with-value.js';
+export { default as withStorageCache } from './enhancers/with-storage-cache.js';
 export { default as waitUntil } from './effects/wait-until.js';
 export { default as enforceObservableRules } from './enforce-rules.js';
 export { default as fromEventEmitter } from './event-emitter.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/atoms",
-  "version": "7.3.2",
+  "version": "7.4.0",
   "description": "Abstraction for encapsulating a piece of data behind a simple unified interface: get, set, observe",
   "type": "module",
   "main": "lib/index.js",
@@ -45,5 +45,5 @@
     "@types/lodash": "^4.14.200",
     "@types/minimalistic-assert": "^1.0.2"
   },
-  "gitHead": "d826264da11cdb907877d8796d882f8e488abcea"
+  "gitHead": "240b0901d2a97ec1fe86be7c450cc289e28c98bf"
 }