@exodus/headless 2.2.2 → 2.3.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.
 
+## [2.3.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.2.2...@exodus/headless@2.3.0) (2024-01-15)
+
+### Features
+
+- **headless:** add analytics plugin ([#5402](https://github.com/ExodusMovement/exodus-hydra/issues/5402)) ([2ffd24b](https://github.com/ExodusMovement/exodus-hydra/commit/2ffd24b937cda8f5ba233d7796de7b5b5367b704))
+
 ## [2.2.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.2.1...@exodus/headless@2.2.2) (2024-01-12)
 
 ### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "The platform-agnostic Exodus wallet SDK",
   "author": "Exodus Movement Inc.",
   "main": "src/index.js",
@@ -66,6 +66,7 @@
     "@exodus/ab-testing": "^7.3.0",
     "@exodus/algorand-lib": "^2.0.1",
     "@exodus/algorand-meta": "^1.1.4",
+    "@exodus/analytics": "^11.0.0",
     "@exodus/apy-rates": "^3.3.1",
     "@exodus/assets-feature": "workspace:^",
     "@exodus/bitcoin-plugin": "^1.0.14",
@@ -82,7 +83,7 @@
     "@exodus/models": "^10.1.0",
     "@exodus/nfts": "^7.11.0",
     "@exodus/personal-notes": "^3.6.0",
-    "@exodus/referrals": "^8.1.1",
+    "@exodus/referrals": "^8.1.2",
     "@exodus/solana-lib": "^1.3.11",
     "@exodus/solana-meta": "^1.0.2",
     "@exodus/storage-encrypted": "^1.1.2",
@@ -100,5 +101,5 @@
     "msw": "^2.0.0",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "13cfd066b8ccfc5d1ff5b4f852fb3fb02c38c72e"
+  "gitHead": "035a21e35481a7819a24348a5eb97f4c71b37d0b"
 }

package/src/dependencies/plugins.js

@@ -1,7 +1,12 @@
-import plugins from '../plugins'
-import { withType } from './utils'
+import headlessAnalyticsPluginDefinition from '../plugins/analytics'
+import logLifecyclePluginDefinition from '../plugins/log-lifecycle'
 
-const createPluginDependencies = () =>
-  plugins.map((definition) => ({ definition })).map(withType('plugin'))
+const createPluginDependencies = () => [
+  { definition: logLifecyclePluginDefinition },
+  {
+    if: { registered: ['analytics'] },
+    definition: headlessAnalyticsPluginDefinition,
+  },
+]
 
 export default createPluginDependencies

package/src/plugins/analytics.js

@@ -0,0 +1,51 @@
+const setBuildMetadataProperties = async ({ analytics, getBuildMetadata }) => {
+  analytics.requireDefaultProperties(['appId', 'osName'])
+
+  const { appId, osName, deviceModel } = await getBuildMetadata()
+
+  analytics.setDefaultProperties({ appId, osName, deviceModel })
+  analytics.setDefaultPropertiesForSanitizationErrors({ osName })
+}
+
+const setSystemPreferencesProperties = async ({ analytics, systemPreferences }) => {
+  if (!systemPreferences) return
+  analytics.requireDefaultProperties(['locale'])
+  const languages = await systemPreferences.getPreferredLanguages()
+  analytics.setDefaultProperties({ locale: languages })
+}
+
+const setEnvProperties = async ({ analytics, env }) => {
+  analytics.setDefaultProperties({
+    appPlatform: env.platform,
+    appVersion: env.version,
+    appBuild: env.build === 'development' ? 'dev' : 'prod',
+  })
+
+  // just need platform and version since segment
+  // makes calls to staging or prod based on API key
+  analytics.setDefaultPropertiesForSanitizationErrors({
+    appPlatform: env.platform,
+    appVersion: env.version,
+  })
+}
+
+const createHeadlessAnalyticsPlugin = ({ analytics, env, getBuildMetadata, systemPreferences }) => {
+  const onStart = async () => {
+    Promise.all([
+      setEnvProperties({ analytics, env }),
+      setBuildMetadataProperties({ analytics, getBuildMetadata }),
+      setSystemPreferencesProperties({ analytics, systemPreferences }),
+    ])
+  }
+
+  return { onStart }
+}
+
+const analyticsPluginDefinition = {
+  id: 'headlessAnalyticsPlugin',
+  type: 'plugin',
+  factory: createHeadlessAnalyticsPlugin,
+  dependencies: ['analytics', 'env', 'getBuildMetadata', 'systemPreferences?'],
+}
+
+export default analyticsPluginDefinition

package/src/plugins/log-lifecycle.js

@@ -1,4 +1,4 @@
-const logLifecycle = {
+const logLifecyclePluginDefinition = {
   id: 'logLifecyclePlugin',
   type: 'plugin',
   factory: ({ logger }) => {
@@ -23,4 +23,4 @@ const logLifecycle = {
   dependencies: ['logger'],
 }
 
-export default logLifecycle
+export default logLifecyclePluginDefinition

package/src/plugins/index.js

@@ -1,3 +0,0 @@
-import logLifecyclePlugin from './log-lifecycle'
-
-export default [logLifecyclePlugin]