@exodus/ui-config 3.11.0 → 3.12.1

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.
 
+## [3.12.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@3.12.0...@exodus/ui-config@3.12.1) (2024-09-27)
+
+### Bug Fixes
+
+- **ui-config:** store syncable configs in storage ([#9581](https://github.com/ExodusMovement/exodus-hydra/issues/9581)) ([73b97d3](https://github.com/ExodusMovement/exodus-hydra/commit/73b97d392975b250aef35801f6acc658b72404ec))
+
+## [3.12.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@3.11.0...@exodus/ui-config@3.12.0) (2024-09-27)
+
+### Features
+
+- **ui-config:** add syncable configs support ([#9543](https://github.com/ExodusMovement/exodus-hydra/issues/9543)) ([31e5d61](https://github.com/ExodusMovement/exodus-hydra/commit/31e5d61bb64279d3caf4d9045d87afd23234e345))
+
 ## [3.11.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@3.10.2...@exodus/ui-config@3.11.0) (2024-09-20)
 
 ### Features

package/atoms/index.js

@@ -1,20 +1,12 @@
-import { createStorageAtomFactory } from '@exodus/atoms'
+import createSyncableUiConfigAtom from './syncable.js'
+import createLocalUiConfigAtom from './local.js'
 
 const createUiConfigAtomDefinitions = ({ configValues }) => {
-  return configValues.map(({ id, atomId, encrypted, defaultValue }) => ({
-    definition: {
-      id: atomId,
-      type: 'atom',
-      factory: ({ storage }) =>
-        createStorageAtomFactory({ storage })({ key: id, isSoleWriter: true, defaultValue }),
-      dependencies: ['storage'],
-      public: true,
-    },
-    aliases: [
-      { implementationId: encrypted ? 'storage' : 'unsafeStorage', interfaceId: 'storage' },
-    ],
-    storage: { namespace: 'uiConfig' },
-  }))
+  return configValues.map((configValue) =>
+    configValue.syncable
+      ? createSyncableUiConfigAtom(configValue)
+      : createLocalUiConfigAtom(configValue)
+  )
 }
 
 export default createUiConfigAtomDefinitions

package/atoms/local.js

@@ -0,0 +1,16 @@
+import { createStorageAtomFactory } from '@exodus/atoms'
+
+const createLocalUiConfigAtom = ({ id, atomId, encrypted, defaultValue }) => ({
+  definition: {
+    id: atomId,
+    type: 'atom',
+    factory: ({ storage }) =>
+      createStorageAtomFactory({ storage })({ key: id, isSoleWriter: true, defaultValue }),
+    dependencies: ['storage'],
+    public: true,
+  },
+  aliases: [{ implementationId: encrypted ? 'storage' : 'unsafeStorage', interfaceId: 'storage' }],
+  storage: { namespace: 'uiConfig' },
+})
+
+export default createLocalUiConfigAtom

package/atoms/syncable.js

@@ -0,0 +1,45 @@
+/* eslint-disable @exodus/hydra/no-eternal-subscription */
+
+import lodash from 'lodash'
+import { createFusionAtom } from '@exodus/fusion-atoms'
+import { createStorageAtomFactory } from '@exodus/atoms'
+
+const { isEqual } = lodash
+
+const createSyncableUiConfigAtom = ({ id, atomId, encrypted, defaultValue }) => {
+  const factory = ({ fusion, storage }) => {
+    const path = encrypted ? `private.${id}` : id
+
+    const localAtom = createStorageAtomFactory({ storage })({ key: id, isSoleWriter: true })
+    const fusionAtom = createFusionAtom({ fusion, path })
+
+    // Sync value up to fusion
+    localAtom.observe((value) => {
+      if (value === undefined) return // Avoid syncing down missing fusion values
+      fusionAtom.set((prevValue) => (isEqual(value, prevValue) ? prevValue : value))
+    })
+
+    // Sync value down from fusion
+    fusionAtom.observe((value) => {
+      if (value === undefined) return // Avoid syncing down missing fusion values
+      localAtom.set((prevValue) => (isEqual(value, prevValue) ? prevValue : value))
+    })
+
+    return localAtom
+  }
+
+  return {
+    definition: {
+      id: atomId,
+      type: 'atom',
+      factory,
+      dependencies: ['fusion', 'storage'],
+    },
+    storage: { namespace: 'uiConfig' },
+    aliases: [
+      { implementationId: encrypted ? 'storage' : 'unsafeStorage', interfaceId: 'storage' },
+    ],
+  }
+}
+
+export default createSyncableUiConfigAtom

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ui-config",
-  "version": "3.11.0",
+  "version": "3.12.1",
   "description": "Helper for storing various UI-specific settings/config.",
   "author": "Exodus Movement, Inc.",
   "license": "UNLICENSED",
@@ -34,11 +34,12 @@
   "dependencies": {
     "@exodus/atoms": "^8.1.1",
     "@exodus/formatting": "^8.0.0",
+    "@exodus/fusion-atoms": "^1.2.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@exodus/redux-dependency-injection": "^4.0.3",
     "redux": "^4.2.1"
   },
-  "gitHead": "9f46287a2df974301fb838845f271dd2ee9adcb3"
+  "gitHead": "749dabfbfbc35953de731b88bea180e95edc1e06"
 }