@exodus/available-assets 1.0.0 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 2.0.0 (2023-04-25)
+
+### ⚠ BREAKING CHANGES
+
+- available-assets module to DI definition (#1339)
+
+### Features
+
+- factor out availableAssetModule ([#1924](https://github.com/ExodusMovement/exodus-hydra/issues/1924)) ([e08bd1c](https://github.com/ExodusMovement/exodus-hydra/commit/e08bd1c2319b679e752bc69db1a67790fc6cdbc7))
+
+### Code Refactoring
+
+- available-assets module to DI definition ([#1339](https://github.com/ExodusMovement/exodus-hydra/issues/1339)) ([d98f38b](https://github.com/ExodusMovement/exodus-hydra/commit/d98f38b666f5ab58eb08a38bfd9d0c36899df13e))

package/README.md

@@ -13,9 +13,16 @@ yarn add @exodus/available-assets
 Note: this module does not export a public API aside from its constructor/factory function. It monitors the assetsModule and makes built-in assets/tokens and custom tokens available by writing to the `availableAssetNamesAtom`.
 
 ```js
-import createAvailableAssets from '@exodus/available-assets'
+import availableAssetsDefinition from '@exodus/available-assets/module'
+import { availableAssetNamesAtomDefinition } from '@exodus/available-assets/atoms'
 
-createAvailableAssets({
+const availableAssetNamesAtom = availableAssetNamesAtomDefinition.factory({
+  config: {
+    defaultAvailableAssetNames: ['bitcoin', 'ethereum'],
+  },
+})
+
+availableAssetsDefinition.factory({
   // see #/assets-module in exodus-browser or tests for the API
   assetsModule,
   // atom that this module will write available assets to as they change

package/atoms/available-asset-names.js

@@ -0,0 +1,13 @@
+import { createInMemoryAtom } from '@exodus/atoms'
+
+const createAvailableAssetNamesAtom = ({ config: { defaultAvailableAssetNames } }) =>
+  createInMemoryAtom({ defaultValue: defaultAvailableAssetNames })
+
+const availableAssetNamesAtomDefinition = {
+  id: 'availableAssetNamesAtom',
+  type: 'atom',
+  factory: createAvailableAssetNamesAtom,
+  dependencies: ['config'],
+}
+
+export default availableAssetNamesAtomDefinition

package/atoms/index.js

@@ -0,0 +1 @@
+export availableAssetNamesAtomDefinition from './available-asset-names'

package/{index.js → module/index.js}

@@ -1,13 +1,15 @@
 import ExodusModule from '@exodus/module'
-import { difference } from 'lodash'
+import { difference } from '@exodus/basic-utils'
 import restrictConcurrency from 'make-concurrent'
 
+const MODULE_ID = 'availableAssets'
+
 class AvailableAssets extends ExodusModule {
   #assetsModule
   #availableAssetNamesAtom
   #availableAssetNamesSet
   constructor({ assetsModule, availableAssetNamesAtom, logger }) {
-    super({ name: 'AvailableAssets', logger })
+    super({ name: MODULE_ID, logger })
 
     this.#assetsModule = assetsModule
     this.#availableAssetNamesAtom = availableAssetNamesAtom
@@ -38,4 +40,8 @@ class AvailableAssets extends ExodusModule {
 
 const createAvailableAssetsModule = (opts) => new AvailableAssets(opts)
 
-export default createAvailableAssetsModule
+export default {
+  id: MODULE_ID,
+  factory: createAvailableAssetsModule,
+  dependencies: ['assetsModule', 'availableAssetNamesAtom', 'logger'],
+}

package/package.json

@@ -1,16 +1,19 @@
 {
   "name": "@exodus/available-assets",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "license": "UNLICENSED",
-  "main": "index.js",
   "author": "Exodus Movement Inc.",
   "scripts": {
     "test": "jest",
-    "lint": "eslint .",
+    "lint": "eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix"
   },
   "files": [
-    "index.js"
+    "module",
+    "atoms",
+    "README.md",
+    "CHANGELOG.md",
+    "!**/__tests__"
   ],
   "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/available-assets",
   "bugs": {
@@ -21,11 +24,15 @@
     "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
   },
   "dependencies": {
-    "@exodus/module": "^1.0.0",
+    "@exodus/atoms": "^3.5.0",
+    "@exodus/basic-utils": "^2.0.0",
+    "@exodus/module": "^1.1.0",
     "lodash": "^4.17.21",
     "make-concurrent": "^5.3.0"
   },
   "devDependencies": {
-    "@exodus/atoms": "*"
-  }
+    "eslint": "^8.33.0",
+    "jest": "^29.1.2"
+  },
+  "gitHead": "d83833d02b40e19cb8b0608194226e3f2d270051"
 }