@exodus/atoms 8.0.0 → 8.1.1

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.1.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@8.1.0...@exodus/atoms@8.1.1) (2024-09-09)
+
+### Bug Fixes
+
+- **atoms:** actively clear cache upon reset ([#8709](https://github.com/ExodusMovement/exodus-hydra/issues/8709)) ([d159c00](https://github.com/ExodusMovement/exodus-hydra/commit/d159c0020519379a4b477a52b82494b6f93c704e))
+
+## [8.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@8.0.0...@exodus/atoms@8.1.0) (2024-08-10)
+
+### Features
+
+- **atoms:** warn when using cache enhancer on atom with no setter ([#8147](https://github.com/ExodusMovement/exodus-hydra/issues/8147)) ([1511a55](https://github.com/ExodusMovement/exodus-hydra/commit/1511a5528cce33d82795b4eb06385de370e7a847))
+
+### Bug Fixes
+
+- **atoms:** invalidate cache on failed writes, adjust user id analytics atom API ([#8303](https://github.com/ExodusMovement/exodus-hydra/issues/8303)) ([17537a8](https://github.com/ExodusMovement/exodus-hydra/commit/17537a8b18aff90d5e7e1b12dd7964032af7b44b))
+
 ## [8.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@7.6.1...@exodus/atoms@8.0.0) (2024-07-17)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -13,6 +13,7 @@ An atom is a data source wrapper that exposes a single piece of data through 3 d
 - **get()**: read data
 - **set(newValue)**: write data
 - **observe(async (data) => {})**: observes data changes. Will be called initially with current data value. Observers are awaited in series.
+- **reset()**: clear the stored value. The next `get()` call will return the default value\* and observers will be called with the default value.
 
 ## Data sources
 

package/lib/enhancers/difference.d.ts

@@ -1,9 +1,9 @@
-import { Atom, Listener } from '../utils/types.js';
+import { Atom } from '../utils/types.js';
 type Diff<T> = {
     previous?: T;
     current: T;
 };
 declare const difference: <T>(atom: Atom<T>) => Omit<Atom<T>, "observe"> & {
-    observe: (listener: Listener<Diff<T>>) => import("../utils/types.js").Unsubscribe;
+    observe: Atom<Diff<T>>["observe"];
 };
 export default difference;

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

@@ -6,6 +6,9 @@ const getCacheAtom = ({ storage, key }) => {
 const enhanceAtom = (params) => {
     const { atom, logger } = params;
     const cacheAtom = getCacheAtom(params);
+    if (!atom.hasOwnProperty('set')) {
+        logger.warn('Atom does not have a "set" method, cache will last only until the app is restarted');
+    }
     let hasCache = false;
     const setCache = async (fresh) => {
         try {
@@ -31,15 +34,30 @@ const enhanceAtom = (params) => {
         return fresh;
     };
     const set = async (value) => {
-        await atom.set(value);
-        hasCache = false;
+        try {
+            await atom.set(value);
+        }
+        catch (error) {
+            logger.warn('Failed to write to atom, is it a readonly atom? Clearing cache...', error);
+        }
+        finally {
+            hasCache = false;
+        }
     };
     const get = async () => {
         return hasCache ? readCache() : readFresh();
     };
     const reset = async () => {
-        await atom.reset();
-        hasCache = false;
+        try {
+            await atom.reset();
+            await cacheAtom.reset();
+        }
+        catch (error) {
+            logger.warn('Failed to write to atom, is it a readonly atom? Clearing cache...', error);
+        }
+        finally {
+            hasCache = false;
+        }
     };
     return { ...atom, get, set, reset };
 };

package/lib/factories/storage.d.ts

@@ -9,7 +9,7 @@ type Params<D> = {
     isSoleWriter?: boolean;
 };
 declare const createStorageAtomFactory: <T>({ storage }: FactoryParams<T>) => {
-    (opts: Omit<Params<unknown>, 'defaultValue'>): Atom<T | undefined>;
+    (opts: Omit<Params<unknown>, "defaultValue">): Atom<T | undefined>;
     <D extends T>(opts: Params<D>): Atom<T | D>;
 };
 export default createStorageAtomFactory;

package/lib/index.d.ts

@@ -22,4 +22,4 @@ 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';
-export { Atom, ReadonlyAtom, Listener, Unsubscribe } from './utils/types.js';
+export type { Atom, ReadonlyAtom, Listener, Unsubscribe } from './utils/types.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/atoms",
-  "version": "8.0.0",
+  "version": "8.1.1",
   "description": "Abstraction for encapsulating a piece of data behind a simple unified interface: get, set, observe",
   "type": "module",
   "main": "lib/index.js",
@@ -9,8 +9,8 @@
   "scripts": {
     "build": "run -T tsc --build tsconfig.build.json",
     "clean": "run -T tsc --build --clean",
-    "test": "run -T jest",
-    "lint": "run -T eslint . --ignore-path ../../.gitignore",
+    "test": "run -T exodus-test --jest --esbuild",
+    "lint": "run -T eslint .",
     "lint:fix": "yarn lint --fix",
     "prepublishOnly": "yarn run -T build --scope @exodus/atoms"
   },
@@ -28,7 +28,6 @@
     "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Aatoms"
   },
   "dependencies": {
-    "@exodus/basic-utils": "^2.5.2",
     "@exodus/storage-interface": "^1.0.0",
     "delay": "^5.0.0",
     "eventemitter3": "^4.0.7",
@@ -41,12 +40,12 @@
   },
   "devDependencies": {
     "@exodus/atom-tests": "^1.0.0",
-    "@exodus/storage-memory": "^2.1.1",
+    "@exodus/storage-memory": "^2.2.0",
     "@types/jest": "^29.5.11",
     "@types/json-stringify-safe": "^5.0.3",
     "@types/lodash": "^4.14.200",
     "@types/minimalistic-assert": "^1.0.2",
     "events": "^3.3.0"
   },
-  "gitHead": "9c572ff7b092c5806e9de99a462775086689742c"
+  "gitHead": "d64de7579b06afe91fbded3d1f7eb29950f82e5a"
 }