@exodus/ui-config 1.0.0

package/README.md

@@ -0,0 +1,30 @@
+# @exodus/ui-config
+
+Helper for storing various UI-specific settings/config. Use this ONLY for UI-specific settings/config. Most data is NOT UI-specific and should be managed by domain-specific features/modules/atoms in the background.
+
+Valid examples:
+
+- Boolean flag that controls whether to show price maps in the UI
+- Boolean flag that flips to true after onboarding was shown
+- Counter for how many times a modal has been shown, or needs to be shown
+
+## Usage
+
+```js
+import uiConfig from '@exodus/ui-config'
+
+// exodus is created via `@exodus/headless`
+exodus.use(
+  uiConfig({
+    atoms: [
+      // these are emitted to the `port` as events 'delightUserAtom' and 'terrifyUserAtom'
+      { id: 'delightUserAtom' },
+      { id: 'terrifyUserAtom' },
+    ],
+  })
+)
+
+// API usage
+exodus.uiConfig.setDelightUser(true)
+exodus.uiConfig.setTerrifyUser(false)
+```

package/api/index.js

@@ -0,0 +1,31 @@
+import { mapValues } from '@exodus/basic-utils'
+import { merge } from 'lodash'
+import { stripAtom, toFirstUpper } from '../utils'
+
+const getGetterName = (name) => `get${toFirstUpper(stripAtom(name))}`
+
+const getSetterName = (name) => `set${toFirstUpper(stripAtom(name))}`
+
+const createUiConfigApiDefinition = ({ atomIds }) => {
+  return {
+    definition: {
+      type: 'api',
+      id: 'uiConfig',
+      factory: ({ ...atoms }) => ({
+        uiConfig: merge(
+          ...Object.values(
+            mapValues(atoms, (atom, name) => ({
+              // assetsShowPriceMapAtom -> getAssetsShowPriceMap, setAssetsShowPriceMap
+              [getGetterName(name)]: atom.get,
+              [getSetterName(name)]: atom.set,
+            }))
+          )
+        ),
+      }),
+      dependencies: atomIds,
+    },
+    writesAtoms: atomIds,
+  }
+}
+
+export default createUiConfigApiDefinition

package/index.js

@@ -0,0 +1,33 @@
+import { createStorageAtomFactory } from '@exodus/atoms'
+import createUiConfigApiDefinition from './api'
+import createUiConfigPluginDefinition from './plugin'
+import { stripAtom } from './utils'
+
+const createUiConfigFeatureDefinition = ({ atoms: uiConfigAtoms }) => {
+  const atoms = uiConfigAtoms.map(({ id }) => ({
+    definition: {
+      id,
+      type: 'atom',
+      factory: ({ storage, config }) =>
+        createStorageAtomFactory({ storage })({
+          key: stripAtom(id),
+          isSoleWriter: true,
+        }),
+      dependencies: ['storage'],
+    },
+    storage: { namespace: 'uiConfig' },
+  }))
+
+  const atomIds = uiConfigAtoms.map(({ id }) => id)
+
+  return {
+    id: 'uiConfigFeatureDefinition',
+    definitions: [
+      ...atoms,
+      createUiConfigApiDefinition({ atomIds }),
+      createUiConfigPluginDefinition({ atomIds }),
+    ],
+  }
+}
+
+export default createUiConfigFeatureDefinition

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@exodus/ui-config",
+  "version": "1.0.0",
+  "description": "Helper for storing various UI-specific settings/config.",
+  "author": "Exodus Movement Inc.",
+  "license": "UNLICENSED",
+  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/features/ui-config",
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Aui-config"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
+  },
+  "main": "index.js",
+  "files": [
+    "README.md",
+    "utils.js",
+    "plugin",
+    "api"
+  ],
+  "scripts": {
+    "lint": "eslint . --ignore-path ../../.gitignore",
+    "lint:fix": "yarn lint --fix"
+  },
+  "dependencies": {
+    "@exodus/atoms": "^5.4.0",
+    "@exodus/basic-utils": "^2.1.0",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "eslint": "^8.44.0"
+  },
+  "gitHead": "14fc30509aaa011e0e214aa6b7e0d6608ad3f7c2"
+}

package/plugin/index.js

@@ -0,0 +1,24 @@
+const createUiConfigPluginDefinition = ({ atomIds }) => ({
+  definition: {
+    type: 'plugin',
+    id: 'uiConfigPlugin',
+    factory: ({ port, ...atoms }) => {
+      const watch = () =>
+        Object.entries(atoms).forEach(([name, atom]) =>
+          atom.observe((value) => port.emit(name, value))
+        )
+
+      const clear = () =>
+        Promise.all(Object.entries(atoms).map(([name, atom]) => atom.set(undefined)))
+
+      return {
+        onStart: watch,
+        onClear: clear,
+      }
+    },
+    dependencies: ['port', ...atomIds],
+  },
+  writesAtoms: atomIds,
+})
+
+export default createUiConfigPluginDefinition

package/utils.js

@@ -0,0 +1,3 @@
+export const toFirstUpper = (name) => name.slice(0, 1).toUpperCase() + name.slice(1)
+
+export const stripAtom = (name) => name.replace(/Atom$/, '')