@exodus/available-assets 8.0.0 → 8.1.0

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.
 
+## [8.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/available-assets@8.0.1...@exodus/available-assets@8.1.0) (2024-04-23)
+
+### Features
+
+- type remaining API methods shipped with headless ([#6619](https://github.com/ExodusMovement/exodus-hydra/issues/6619)) ([d1ec08e](https://github.com/ExodusMovement/exodus-hydra/commit/d1ec08e695f0df2c9e63b01169c746ef872fe541))
+
+## [8.0.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/available-assets@8.0.0...@exodus/available-assets@9.0.0) (2024-03-18)
+
+### Bug Fixes
+
+- **available-assets:** assets add/update event names ([#6159](https://github.com/ExodusMovement/exodus-hydra/issues/6159)) ([e54e8f3](https://github.com/ExodusMovement/exodus-hydra/commit/e54e8f3524a60f0286bf8ace578b0837b74c71dd))
+
 ## [8.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/available-assets@7.0.0...@exodus/available-assets@8.0.0) (2023-11-22)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -10,25 +10,27 @@ yarn add @exodus/available-assets
 
 ## Usage
 
-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 availableAssetsDefinition from '@exodus/available-assets/module'
-import { availableAssetNamesAtomDefinition } from '@exodus/available-assets/atoms'
+// see https://github.com/ExodusMovement/exodus-hydra/blob/c5632b131fd3cd210f658fb45113528c0e227beb/sdks/headless/__tests__/available-assets.test.js#L40
+import createExodus from '@exodus/headless'
+import availableAssets from '@exodus/available-assets'
 
-const availableAssetNamesAtom = availableAssetNamesAtomDefinition.factory({
+const container = createExodus({
+  port,
+  adapters,
   config: {
-    defaultAvailableAssetNames: ['bitcoin', 'ethereum'],
+    // ...,
+    // TODO: support configuring via feature config:
+    // `container.use(availableAssets({ defaultAvailableAssetNames: ['bitcoin', 'ethereum']}))`
+    availableAssetsAtom: {
+      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
-  availableAssetNamesAtom,
-  // @exodus/blockchain-metadata instance
-  // see ../modules/module/src/logger.js for API
-  logger,
-})
+container.use(availableAssets())
+
+const exodus = container.resolve()
+
+const availableAssetNames = await exodus.availableAssets.get() // ['bitcoin', 'ethereum']
 ```

package/api/index.d.ts

@@ -0,0 +1,11 @@
+declare const assetsApiDefinition: {
+  id: 'availableAssetsApi'
+  type: 'api'
+  factory(): {
+    availableAssets: {
+      get(): Promise<string[]>
+    }
+  }
+}
+
+export default assetsApiDefinition

package/index.d.ts

@@ -0,0 +1,8 @@
+import availableAssetsApiDefinition from './api'
+
+declare const availableAssets: () => {
+  id: 'availableAssets'
+  definitions: [{ definition: typeof availableAssetsApiDefinition }]
+}
+
+export default availableAssets

package/index.js

@@ -12,7 +12,6 @@ const availableAssets = () => ({
   definitions: [
     {
       definition: availableAssetsModuleDefinition,
-      writesAtoms: ['availableAssetsAtom'],
     },
     { definition: availableAssetsAtomDefinition },
     { definition: availableAssetNamesAtomDefinition },

package/module/index.js

@@ -1,4 +1,4 @@
-import ExodusModule from '@exodus/module'
+import ExodusModule from '@exodus/module' // eslint-disable-line import/no-deprecated
 import restrictConcurrency from 'make-concurrent'
 
 const MODULE_ID = 'availableAssets'
@@ -36,11 +36,11 @@ class AvailableAssets extends ExodusModule {
     this.#subscriptions.push(
       this.#assetsAtom.observe(({ added, updated }) => {
         if (added.length > 0) {
-          this.#makeAssetsAvailable(added, 'assets-added')
+          this.#makeAssetsAvailable(added, 'assets-add')
         }
 
         if (updated.length > 0) {
-          this.#makeAssetsAvailable(updated, 'assets-updated')
+          this.#makeAssetsAvailable(updated, 'assets-update')
         }
       }),
       // built-in custom tokens that the user added/enabled/disabled explicitly needs to be available forever

package/package.json

@@ -1,23 +1,24 @@
 {
   "name": "@exodus/available-assets",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "Tracks supported/available assets, i.e. assets that the user can potentially enable via the UI",
   "license": "UNLICENSED",
-  "author": "Exodus Movement Inc.",
+  "author": "Exodus Movement, Inc.",
   "scripts": {
-    "test": "jest",
-    "lint": "eslint . --ignore-path ../../.gitignore",
+    "test": "run -T jest",
+    "lint": "run -T eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix"
   },
   "main": "index.js",
   "files": [
-    "module",
-    "atoms",
     "api",
-    "redux",
+    "atoms",
+    "module",
     "plugins",
-    "README.md",
+    "redux",
+    "index.d.ts",
     "CHANGELOG.md",
+    "README.md",
     "!**/__tests__/**"
   ],
   "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/features/available-assets",
@@ -29,7 +30,7 @@
     "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
   },
   "dependencies": {
-    "@exodus/atoms": "^6.0.1",
+    "@exodus/atoms": "^7.0.5",
     "@exodus/basic-utils": "^2.0.0",
     "@exodus/core-selectors": "^1.5.0",
     "@exodus/module": "^1.1.0",
@@ -40,14 +41,12 @@
   "devDependencies": {
     "@exodus/assets": "^8.0.95",
     "@exodus/assets-base": "^8.1.10",
-    "@exodus/assets-feature": "^3.8.0",
+    "@exodus/assets-feature": "^5.1.0",
     "@exodus/combined-assets-meta": "^1.2.6-alpha-1",
     "@exodus/enabled-assets": "^6.0.2",
     "@exodus/redux-dependency-injection": "^3.0.0",
-    "eslint": "^8.44.0",
-    "jest": "^29.1.2",
     "jest-when": "^3.6.0",
     "redux": "^4.2.1"
   },
-  "gitHead": "134218d9d199a266dc274b9906d6a816dafe5b94"
+  "gitHead": "34f1dab70f6c2fc0062d946f5c74ae84e5379539"
 }