@exodus/balances 12.3.0 → 12.4.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [12.4.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@12.3.0...@exodus/balances@12.4.0) (2024-01-08)
+
+### Features
+
+- **balances:** analytics plugin ([#5287](https://github.com/ExodusMovement/exodus-hydra/issues/5287)) ([91de7ba](https://github.com/ExodusMovement/exodus-hydra/commit/91de7ba2fc0563f49b1a5e39dd5546cea4415a6b))
+
 ## [12.3.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@12.2.0...@exodus/balances@12.3.0) (2024-01-05)
 
 ### Features

package/index.js

@@ -5,17 +5,11 @@ import {
   fundedWalletAccountsAtomDefinition,
 } from './atoms'
 import balancesReportDefinition from './report'
-import balancesPluginDefinition from './plugins'
+import { balancesLifecyclePluginDefinition, balancesAnalyticsPluginDefinition } from './plugins'
 import typeforce from '@exodus/typeforce'
 
 const balances = (config) => {
-  typeforce(
-    {
-      balanceFields: typeforce.arrayOf('String'),
-    },
-    config,
-    true
-  )
+  typeforce({ balanceFields: typeforce.arrayOf('String') }, config, true)
 
   return {
     id: 'balances',
@@ -32,7 +26,11 @@ const balances = (config) => {
       },
       { definition: fundedWalletAccountsAtomDefinition },
       { definition: balancesReportDefinition },
-      { definition: balancesPluginDefinition },
+      { definition: balancesLifecyclePluginDefinition },
+      {
+        if: { registered: ['analytics'] },
+        definition: balancesAnalyticsPluginDefinition,
+      },
     ],
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/balances",
-  "version": "12.3.0",
+  "version": "12.4.0",
   "description": "Tracks crypto balances across enabled wallet accounts.",
   "author": "Exodus Movement Inc.",
   "license": "UNLICENSED",
@@ -58,5 +58,5 @@
     "jest": "^29.1.2",
     "redux": "^4.2.1"
   },
-  "gitHead": "cd84b0179161212d65a695d8b61e91f154b2ecaa"
+  "gitHead": "15dba244250d5c1ceec8432a96c781a19a70aaf0"
 }

package/plugins/analytics.js

@@ -0,0 +1,19 @@
+const createBalancesAnalyticsPlugin = ({ analytics, hasBalanceAtom }) => {
+  let unsubscribe
+
+  const onStart = () => {
+    analytics.setDefaultProperties({ hasBalance: false })
+
+    unsubscribe = hasBalanceAtom.observe((hasBalance) => {
+      analytics.setDefaultProperties({ hasBalance })
+    })
+  }
+
+  const onStop = () => {
+    unsubscribe?.()
+  }
+
+  return { onStart, onStop }
+}
+
+export default createBalancesAnalyticsPlugin

package/plugins/index.js

@@ -1,49 +1,16 @@
-import { createAtomObserver } from '@exodus/atoms'
+import createBalancesAnalyticsPlugin from './analytics'
+import createBalancesLifecyclePlugin from './lifecycle'
 
-const createBalancesPlugin = ({ balancesAtom, port, balances, hasBalanceAtom }) => {
-  const balancesAtomObserver = createAtomObserver({
-    port,
-    atom: balancesAtom,
-    event: 'balances',
-  })
-  balancesAtomObserver.register()
-
-  const hasBalanceAtomObserver = createAtomObserver({
-    port,
-    atom: hasBalanceAtom,
-    event: 'hasBalance',
-  })
-  hasBalanceAtomObserver.register()
-
-  const onLoad = () => {
-    hasBalanceAtomObserver.start()
-    balancesAtomObserver.start()
-
-    balances.load()
-  }
-
-  const onStop = () => {
-    balancesAtomObserver.unregister()
-    hasBalanceAtomObserver.unregister()
-    balances.stop()
-  }
-
-  const onClear = async () => {
-    await hasBalanceAtom.set(undefined)
-  }
-
-  return {
-    onLoad,
-    onStop,
-    onClear,
-  }
-}
-
-const balancesPluginDefinition = {
-  id: 'balancesPlugin',
+export const balancesLifecyclePluginDefinition = {
+  id: 'balancesLifecyclePlugin',
   type: 'plugin',
-  factory: createBalancesPlugin,
+  factory: createBalancesLifecyclePlugin,
   dependencies: ['balancesAtom', 'port', 'balances', 'hasBalanceAtom'],
 }
 
-export default balancesPluginDefinition
+export const balancesAnalyticsPluginDefinition = {
+  id: 'balancesAnalyticsPlugin',
+  type: 'plugin',
+  factory: createBalancesAnalyticsPlugin,
+  dependencies: ['analytics', 'hasBalanceAtom'],
+}

package/plugins/lifecycle.js

@@ -0,0 +1,40 @@
+import { createAtomObserver } from '@exodus/atoms'
+
+const createBalancesLifecyclePlugin = ({ balancesAtom, port, balances, hasBalanceAtom }) => {
+  const balancesAtomObserver = createAtomObserver({
+    port,
+    atom: balancesAtom,
+    event: 'balances',
+  })
+
+  const hasBalanceAtomObserver = createAtomObserver({
+    port,
+    atom: hasBalanceAtom,
+    event: 'hasBalance',
+  })
+
+  const onLoad = () => {
+    hasBalanceAtomObserver.start()
+    balancesAtomObserver.start()
+
+    balances.load()
+  }
+
+  const onStop = () => {
+    balancesAtomObserver.unregister()
+    hasBalanceAtomObserver.unregister()
+    balances.stop()
+  }
+
+  const onClear = async () => {
+    await hasBalanceAtom.set(undefined)
+  }
+
+  return {
+    onLoad,
+    onStop,
+    onClear,
+  }
+}
+
+export default createBalancesLifecyclePlugin