@exodus/headless 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0...@exodus/headless@2.1.0) (2023-12-18)
+
+### Features
+
+- add geolocation debug api ([#5000](https://github.com/ExodusMovement/exodus-hydra/issues/5000)) ([63f7420](https://github.com/ExodusMovement/exodus-hydra/commit/63f7420ac9f2dee98702691d382e6561310f31cc))
+- **debug:** add clear and restart methods ([#5109](https://github.com/ExodusMovement/exodus-hydra/issues/5109)) ([77170cf](https://github.com/ExodusMovement/exodus-hydra/commit/77170cf42c261f18269f0d2de3091f7db752af2e))
+- filesystem feature ([#5058](https://github.com/ExodusMovement/exodus-hydra/issues/5058)) ([1d3d85d](https://github.com/ExodusMovement/exodus-hydra/commit/1d3d85dc2e200954230305a0a6c0e36f35c79db2))
+- **headless:** pass debug flag instead of using env build ([#5087](https://github.com/ExodusMovement/exodus-hydra/issues/5087)) ([f5be292](https://github.com/ExodusMovement/exodus-hydra/commit/f5be292047781c808173df377eaa43e590350a2e))
+- **headless:** use debugger preprocessor ([#5088](https://github.com/ExodusMovement/exodus-hydra/issues/5088)) ([7e15717](https://github.com/ExodusMovement/exodus-hydra/commit/7e15717cb18dfa169e668bcdce6cde9a412c321d))
+
 ## [2.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.149...@exodus/headless@2.0.0) (2023-12-15)
 
 **Note:** Version bump only for package @exodus/headless

package/README.md

@@ -195,6 +195,18 @@ An object with additional configuration options for the Exodus instance.
 
 Currently not used.
 
+## Debugging
+
+Some features expose APIs for easy debugging, troubleshooting, and PR testing. You can access these APIs under exodus.debug. To enable them, simply pass debug: true to the headless factory function:
+
+```js
+import createExodus from '@exodus/headless'
+
+const exodusContainer = createExodus({ port, adapters, config, debug: true })
+
+exodusContainer.debug.geolocation.merge({ countryCode: 'US' })
+```
+
 ## Headless API
 
 ### wallet

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "The platform-agnostic Exodus wallet SDK",
   "author": "Exodus Movement Inc.",
   "main": "src/index.js",
@@ -35,12 +35,13 @@
     "@exodus/basic-utils": "^2.0.0",
     "@exodus/blockchain-metadata": "^15.0.0",
     "@exodus/dependency-injection": "^2.1.0",
-    "@exodus/dependency-preprocessors": "^4.0.0",
+    "@exodus/dependency-preprocessors": "^4.1.0",
     "@exodus/enabled-assets": "^9.0.1",
     "@exodus/feature-flags": "^5.1.0",
     "@exodus/fee-data-monitors": "^3.0.0",
     "@exodus/fetch": "^1.2.1",
-    "@exodus/geolocation": "^3.0.0",
+    "@exodus/filesystem": "^1.1.0",
+    "@exodus/geolocation": "^3.1.0",
     "@exodus/hd-key-slip-10": "^2.0.0",
     "@exodus/key-identifier-provider": "^1.4.0",
     "@exodus/keychain": "^4.3.0",
@@ -80,7 +81,7 @@
     "@exodus/litecoin-meta": "^1.0.0",
     "@exodus/market-history": "^7.2.0",
     "@exodus/models": "^10.1.0",
-    "@exodus/nfts": "^7.1.2",
+    "@exodus/nfts": "^7.1.4",
     "@exodus/personal-notes": "^3.6.0",
     "@exodus/referrals": "^8.0.1",
     "@exodus/solana-lib": "^1.3.11",
@@ -100,5 +101,5 @@
     "msw": "^2.0.0",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "a4af3e13c365318d2105d7d9c8ccfbfa2aa089a0"
+  "gitHead": "19a9d0cdb9f2b1a8dd9b1b4802f95bfafcd46c60"
 }

package/src/api/debug.js

@@ -1,12 +1,20 @@
-const createApi = ({ ioc }) => {
-  const { env } = ioc.getByType('adapter')
-
-  if (!env || env.build !== 'development') return {}
+const createApi = ({ ioc, port, debug }) => {
+  if (!debug) return {}
 
   const apis = ioc.getByType('debug')
 
+  const { unsafeStorage } = ioc.getByType('adapter')
+
+  const clear = async () => {
+    await unsafeStorage.namespace('debug').clear()
+  }
+
+  const restart = async () => {
+    port.emit('restart', { reason: 'debug' })
+  }
+
   return {
-    debug: Object.assign({}, ...Object.values(apis)),
+    debug: Object.assign({}, ...Object.values(apis), { clear, restart }),
   }
 }
 

package/src/api/index.js

@@ -3,12 +3,12 @@ import { validateMnemonic as isMnemonicValid } from 'bip39'
 import createDebug from './debug'
 import createReporting from './reporting'
 
-const createApi = ({ ioc, port, config }) => {
+const createApi = ({ ioc, port, config, debug }) => {
   const apis = ioc.getByType('api')
 
   return {
     ...Object.assign({}, ...Object.values(apis)),
-    ...createDebug({ ioc }),
+    ...createDebug({ ioc, port, debug }),
     ...createReporting({ ioc, config }),
     isMnemonicValid,
     subscribe: port.subscribe.bind(port),

package/src/index.js

@@ -6,6 +6,7 @@ import blockchainMetadata from '@exodus/blockchain-metadata'
 import enabledAssets from '@exodus/enabled-assets'
 import featureFlags from '@exodus/feature-flags'
 import fees from '@exodus/fee-data-monitors'
+import filesystem from '@exodus/filesystem'
 import geolocation from '@exodus/geolocation'
 import keychain from '@exodus/keychain'
 import locale from '@exodus/locale'
@@ -24,8 +25,8 @@ import createIOC from './ioc'
 import attachMigrations from './migrations/attach'
 import attachPlugins from './plugins/attach'
 
-const createExodus = ({ adapters, config, port }) => {
-  const ioc = createIOC({ adapters, config })
+const createExodus = ({ adapters, config, port, debug = false }) => {
+  const ioc = createIOC({ adapters, config, debug })
 
   ioc.use(addressProvider({ config: config.addressProvider }))
   ioc.use(assetsFeature())
@@ -35,6 +36,7 @@ const createExodus = ({ adapters, config, port }) => {
   ioc.use(enabledAssets())
   ioc.use(featureFlags())
   ioc.use(fees())
+  ioc.use(filesystem())
   ioc.use(geolocation())
   ioc.use(keychain(config.keychain))
   ioc.use(locale())
@@ -119,7 +121,7 @@ const createExodus = ({ adapters, config, port }) => {
       logger: ioc.get('createLogger')('attachPlugins'),
     })
 
-    return createApi({ ioc, port, config })
+    return createApi({ ioc, port, config, debug })
   }
 
   return { ...ioc, resolve }

package/src/ioc.js

@@ -2,6 +2,7 @@ import createIocContainer from '@exodus/dependency-injection'
 import preprocess from '@exodus/dependency-preprocessors'
 import alias from '@exodus/dependency-preprocessors/src/preprocessors/alias'
 import configPreprocessor from '@exodus/dependency-preprocessors/src/preprocessors/config'
+import debuggerPreprocessor from '@exodus/dependency-preprocessors/src/preprocessors/debugger'
 import devModeAtoms from '@exodus/dependency-preprocessors/src/preprocessors/dev-mode-atoms'
 import logify from '@exodus/dependency-preprocessors/src/preprocessors/logify'
 import namespaceStorage from '@exodus/dependency-preprocessors/src/preprocessors/namespace-storage'
@@ -12,8 +13,8 @@ import assert from 'minimalistic-assert'
 
 import createDependencies from './dependencies'
 
-const createIOC = ({ adapters, config }) => {
-  const { createLogger, performance = {} } = adapters
+const createIOC = ({ adapters, config, debug }) => {
+  const { createLogger, unsafeStorage, performance = {} } = adapters
   const {
     readOnlyAtoms: readOnlyAtomsConfig,
     devModeAtoms: devModeAtomsConfig,
@@ -48,6 +49,7 @@ const createIOC = ({ adapters, config }) => {
     }),
     optional(),
     devModeAtomsConfig && devModeAtoms(devModeAtomsConfig),
+    debuggerPreprocessor({ debug, unsafeStorage }),
   ].filter(Boolean)
 
   const registerMultiple = (dependencies) => {