@exodus/ui-config 3.1.1 → 3.3.0

package/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [3.3.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@3.2.0...@exodus/ui-config@3.3.0) (2023-11-13)
+
+### Features
+
+- support default value in ui config ([#4751](https://github.com/ExodusMovement/exodus-hydra/issues/4751)) ([74bc7c7](https://github.com/ExodusMovement/exodus-hydra/commit/74bc7c7f7a707e5e209d5c880feaa3f6a41e7c5a))
+
+## [3.2.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@3.1.1...@exodus/ui-config@3.2.0) (2023-10-04)
+
+### Features
+
+- **ui-config:** do not emit using atom id ([#4342](https://github.com/ExodusMovement/exodus-hydra/issues/4342)) ([df9d7b6](https://github.com/ExodusMovement/exodus-hydra/commit/df9d7b67bbca1c351128afd2e7a76a718dd71a79))
+- **ui-config:** support unecrypted ui-configs ([#4286](https://github.com/ExodusMovement/exodus-hydra/issues/4286)) ([b4f7923](https://github.com/ExodusMovement/exodus-hydra/commit/b4f792369c145a7d84b30bf2e2237f9be053caf9))
+
+## [3.1.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@3.1.0...@exodus/ui-config@3.1.1) (2023-09-19)
+
+### Bug Fixes
+
+- **ui-config:** watch on app restart ([#4086](https://github.com/ExodusMovement/exodus-hydra/issues/4086)) ([cc7ef5b](https://github.com/ExodusMovement/exodus-hydra/commit/cc7ef5b3b8df9d3a28fd6277a695e3778948a745))
+
+## [3.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@3.0.0...@exodus/ui-config@3.1.0) (2023-09-05)
+
+### Features
+
+- ui-config redux ([#3842](https://github.com/ExodusMovement/exodus-hydra/issues/3842)) ([d9e9f33](https://github.com/ExodusMovement/exodus-hydra/commit/d9e9f33cd6d2d0b96f48a821d2eb3f331ebb570c))
+
+## [3.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@2.0.0...@exodus/ui-config@3.0.0) (2023-09-01)
+
+### ⚠ BREAKING CHANGES
+
+- **ui-config:** expose utils to compute events (#3819)
+
+### Features
+
+- **ui-config:** expose utils to compute events ([#3819](https://github.com/ExodusMovement/exodus-hydra/issues/3819)) ([32d8bfd](https://github.com/ExodusMovement/exodus-hydra/commit/32d8bfd0a992ee25c9771dfe875683a4b8c8ae3d))
+
+## [2.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/ui-config@1.0.0...@exodus/ui-config@2.0.0) (2023-08-11)
+
+### ⚠ BREAKING CHANGES
+
+- change ui config data structure (#3294)
+
+### Features
+
+- change ui config data structure ([#3294](https://github.com/ExodusMovement/exodus-hydra/issues/3294)) ([eaceb99](https://github.com/ExodusMovement/exodus-hydra/commit/eaceb99ad4310255ff70769435f16f2daa43ce5a))

package/api/index.js

@@ -1,26 +1,17 @@
-import { mapValues } from '@exodus/basic-utils'
-import { merge } from 'lodash'
+const createUiConfigApiDefinition = ({ configValues }) => {
+  const atomIds = configValues.map((v) => v.atomId)
 
-const createUiConfigApiDefinition = ({ atomIds, atomConfigMap }) => {
   return {
     definition: {
       type: 'api',
       id: 'uiConfig',
       factory: ({ ...atoms }) => {
-        const uiConfig = merge(
-          ...Object.values(
-            mapValues(atoms, (atom, atomId) => ({
-              // assetsShowPriceMapAtom -> getAssetsShowPriceMap, setAssetsShowPriceMap
-              [atomConfigMap[atomId]]: {
-                set: atom.set,
-                get: atom.get,
-              },
-            }))
-          )
-        )
-        return {
-          uiConfig,
-        }
+        const uiConfig = configValues.reduce((acc, { id, atomId }) => {
+          acc[id] = { get: atoms[atomId].get, set: atoms[atomId].set }
+          return acc
+        }, {})
+
+        return { uiConfig }
       },
       dependencies: atomIds,
     },

package/atoms/index.js

@@ -0,0 +1,19 @@
+import { createStorageAtomFactory } from '@exodus/atoms'
+
+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'],
+    },
+    aliases: [
+      { implementationId: encrypted ? 'storage' : 'unsafeStorage', interfaceId: 'storage' },
+    ],
+    storage: { namespace: 'uiConfig' },
+  }))
+}
+
+export default createUiConfigAtomDefinitions

package/index.js

@@ -1,39 +1,19 @@
-import { createStorageAtomFactory } from '@exodus/atoms'
-
 import createUiConfigApiDefinition from './api'
+import createUiConfigAtomDefinitions from './atoms'
 import createUiConfigPluginDefinition from './plugin'
 import { getAtomId } from './utils'
 
 export { getConfigReduxEvents, getEventReduxMap } from './utils'
 
 const createUiConfigFeatureDefinition = ({ config }) => {
-  const configValues = Object.values(config)
-  const configAtomMap = Object.fromEntries(configValues.map(({ id }) => [id, getAtomId(id)]))
-  const atomConfigMap = Object.fromEntries(
-    Object.keys(configAtomMap).map((configId) => [configAtomMap[configId], configId])
-  )
-  const atoms = configValues.map(({ id }) => ({
-    definition: {
-      id: configAtomMap[id],
-      type: 'atom',
-      factory: ({ storage, config }) =>
-        createStorageAtomFactory({ storage })({
-          key: id,
-          isSoleWriter: true,
-        }),
-      dependencies: ['storage'],
-    },
-    storage: { namespace: 'uiConfig' },
-  }))
-
-  const atomIds = Object.keys(atomConfigMap)
+  const configValues = Object.values(config).map((v) => ({ ...v, atomId: getAtomId(v.id) }))
 
   return {
     id: 'uiConfigFeatureDefinition',
     definitions: [
-      ...atoms,
-      createUiConfigApiDefinition({ atomIds, atomConfigMap }),
-      createUiConfigPluginDefinition({ atomIds, atomConfigMap }),
+      ...createUiConfigAtomDefinitions({ configValues }),
+      createUiConfigApiDefinition({ configValues }),
+      createUiConfigPluginDefinition({ configValues }),
     ],
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ui-config",
-  "version": "3.1.1",
+  "version": "3.3.0",
   "description": "Helper for storing various UI-specific settings/config.",
   "author": "Exodus Movement Inc.",
   "license": "UNLICENSED",
@@ -14,12 +14,14 @@
   },
   "main": "index.js",
   "files": [
-    "README.md",
-    "utils.js",
-    "plugin",
     "api",
-    "utils",
+    "atoms",
+    "plugin",
     "redux",
+    "utils",
+    "CHANGELOG.md",
+    "utils.js",
+    "README.md",
     "!**/__tests__/**"
   ],
   "scripts": {
@@ -28,9 +30,9 @@
     "test": "jest"
   },
   "dependencies": {
-    "@exodus/atoms": "^5.7.0",
+    "@exodus/atoms": "^6.0.1",
     "@exodus/basic-utils": "^2.1.0",
-    "@exodus/formatting": "^1.2.0",
+    "@exodus/formatting": "^1.2.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
@@ -39,5 +41,5 @@
     "jest": "^29.1.2",
     "redux": "^4.2.1"
   },
-  "gitHead": "09e3da68a572818d13afe37482019e1a91c5df73"
+  "gitHead": "de55f8221ff7aaad1386858dbccd93951f7e7004"
 }

package/plugin/index.js

@@ -1,27 +1,29 @@
 import { createAtomObserver } from '@exodus/atoms'
 
-const factory = ({ port, ...atoms }) => {
-  const atomObservers = Object.entries(atoms).map(([atomId, atom]) =>
-    createAtomObserver({ port, atom, event: atomId })
-  )
+const createUiConfigPluginDefinition = ({ configValues }) => {
+  const atomIds = configValues.map((v) => v.atomId)
 
-  atomObservers.forEach((observer) => observer.register())
+  const factory = ({ port, ...atoms }) => {
+    const atomObservers = configValues.map(({ id, atomId }) =>
+      createAtomObserver({ port, atom: atoms[atomId], event: id })
+    )
+
+    return {
+      onLoad: () => atomObservers.forEach((observer) => observer.start()),
+      onClear: () => Promise.all(Object.values(atoms).map((atom) => atom.set(undefined))),
+      onStop: () => atomObservers.forEach((observer) => observer.unregister()),
+    }
+  }
 
   return {
-    onLoad: () => atomObservers.forEach((observer) => observer.start()),
-    onClear: () => Promise.all(Object.values(atoms).map((atom) => atom.set(undefined))),
-    onStop: () => atomObservers.forEach((observer) => observer.unregister()),
+    definition: {
+      type: 'plugin',
+      id: 'uiConfigPlugin',
+      factory,
+      dependencies: ['port', ...atomIds],
+    },
+    writesAtoms: atomIds,
   }
 }
 
-const createUiConfigPluginDefinition = ({ atomIds }) => ({
-  definition: {
-    type: 'plugin',
-    id: 'uiConfigPlugin',
-    factory,
-    dependencies: ['port', ...atomIds],
-  },
-  writesAtoms: atomIds,
-})
-
 export default createUiConfigPluginDefinition

package/redux/index.js

@@ -1,17 +1,12 @@
 import id from './id'
-import { getAtomId } from '../utils'
 
 const createUiConfigReduxDefinition = (config) => {
   const configValues = Object.values(config)
-  const configAtomMap = configValues.map(({ id }) => [id, getAtomId(id)])
+
   const initialState = Object.fromEntries(configValues.map(({ id }) => [id, undefined]))
+
   const eventReducers = Object.fromEntries(
-    configAtomMap.map(([configId, atomId]) => [
-      atomId,
-      (state, payload) => {
-        return { ...state, [configId]: payload }
-      },
-    ])
+    configValues.map(({ id }) => [id, (state, payload) => ({ ...state, [id]: payload })])
   )
 
   return {