@exodus/analytics-validation 1.0.1-alpha.8 → 1.1.0-alpha.1

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.1.0-alpha.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.1.0-alpha.0...@exodus/analytics-validation@1.1.0-alpha.1) (2023-05-16)
+
+### Features
+
+- **analytics-validation:** add HomeSuggestionsVideoTap event ([#1646](https://github.com/ExodusMovement/exodus-hydra/issues/1646)) ([2098d11](https://github.com/ExodusMovement/exodus-hydra/commit/2098d112f2c28c419dd83da22186e04fc502e28e))
+- **analytics-validation:** autogen main.schemasafe.json ([#1274](https://github.com/ExodusMovement/exodus-hydra/issues/1274)) ([1395908](https://github.com/ExodusMovement/exodus-hydra/commit/1395908e43d89ebd667ab7b01a58cb9f2efc5d5c))
+
+### Bug Fixes
+
+- **dx:** analytics validation generator ([#1624](https://github.com/ExodusMovement/exodus-hydra/issues/1624)) ([be074bc](https://github.com/ExodusMovement/exodus-hydra/commit/be074bcc785e765468a3c954a286026906245693))
+
+## [1.1.0-alpha.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.0.1-alpha.8...@exodus/analytics-validation@1.1.0-alpha.0) (2023-05-10)
+
+### Features
+
+- support `unknown_unknown` locale ([#1606](https://github.com/ExodusMovement/exodus-hydra/issues/1606)) ([ccb95fd](https://github.com/ExodusMovement/exodus-hydra/commit/ccb95fdbf28484f1f920e4f630b328266b722de2))
+
+### Bug Fixes
+
+- **analytics:** client migration ([#1551](https://github.com/ExodusMovement/exodus-hydra/issues/1551)) ([a02b101](https://github.com/ExodusMovement/exodus-hydra/commit/a02b101f8d7177eb8e43634282bfedcb516cb539))
+
 ## [1.0.1-alpha.8](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.0.1-alpha.7...@exodus/analytics-validation@1.0.1-alpha.8) (2023-04-27)
 
 ### Features

package/README.md

@@ -1,3 +1,17 @@
 # @exodus/analytics-validation
 
-## Usage
+## Development
+
+Before adding a new schema, double check if a subdirectory (essentially an event domain, e.g. `dapps`) already exists in `./src`.
+If not, you will have to come up with a subdirectory name during the next steps.
+
+To add a new schema run
+
+> yarn generate:analytics-validation
+
+in the project root. The CLI tool will ask you for all details needed.
+Once the schema is created, make sure to
+
+1. Fill the schema with the expected properties and their types. The property names should be in the snake case (e.g. `expected_property`);
+2. Fix the generated unit test as it will be intentionally failing;
+3. Add your own test cases to ensure the schema works properly before merging the PR and publishing a new version.

package/index.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-unresolved
 import validateEvent from './src/main.schemasafe.json'
 
 // eslint-disable-next-line unicorn/prefer-export-from

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/analytics-validation",
-  "version": "1.0.1-alpha.8",
+  "version": "1.1.0-alpha.1",
   "description": "The analytics-validation library",
   "author": "Exodus Movement Inc",
   "repository": {
@@ -22,9 +22,10 @@
     "CHANGELOG.md"
   ],
   "scripts": {
+    "build": "node scripts/build-schemasafe.js",
     "lint": "eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix",
-    "test": "jest"
+    "test": "yarn build && jest"
   },
   "devDependencies": {
     "@exodus/schemasafe": "^1.0.0",
@@ -32,5 +33,5 @@
     "eslint": "^8.33.0",
     "jest": "^29.1.2"
   },
-  "gitHead": "9eede399c5cf2331e084728b4d49d7c03a13c47b"
+  "gitHead": "9672b3da7d01fdcb6bc1e13285fdffd9cb36c449"
 }

package/src/common-properties.schemasafe.json

@@ -123,6 +123,9 @@
           "format": "locale",
           "maxLength": 10,
           "$comment": "Max length is arbitrary"
+        },
+        {
+          "enum": ["unknown_unknown", "unknown-unknown"]
         }
       ]
     },

package/src/{web3/web3-view.schemasafe.json → generic-event.schemsafe.json}

@@ -3,15 +3,15 @@
   "type": "object",
   "properties": {
     "event": {
-      "const": "Web3View"
+      "type": "string",
+      "pattern": "^.*$"
     },
     "properties": {
       "allOf": [
         {
           "$ref": "common-properties#"
         }
-      ],
-      "unevaluatedProperties": false
+      ]
     }
   },
   "unevaluatedProperties": false,

package/src/{app-session/app-session.schemasafe.json → home/home-suggestions-video-tap.schemasafe.json}

@@ -3,7 +3,7 @@
   "type": "object",
   "properties": {
     "event": {
-      "const": "AppSession"
+      "const": "HomeSuggestionsVideoTap"
     },
     "properties": {
       "allOf": [
@@ -11,6 +11,17 @@
           "$ref": "common-properties#"
         }
       ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "position": {
+          "type": "number"
+        },
+        "link": {
+          "type": "string",
+          "format": "uri-template"
+        }
+      },
       "unevaluatedProperties": false
     }
   },

package/src/main.schemasafe.json

@@ -2,7 +2,9 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "description": "This schema will be used by the analytics module before tracking events.",
   "type": "object",
-  "required": ["event"],
+  "required": [
+    "event"
+  ],
   "properties": {
     "event": {
       "type": "string",
@@ -13,35 +15,20 @@
     "propertyName": "event"
   },
   "oneOf": [
-    {
-      "$ref": "app-session#"
-    },
     {
       "$ref": "asset-network-manual-refresh#"
     },
     {
       "$ref": "backup-prompt-view#"
     },
-    {
-      "$ref": "check-backup-quiz-completed#"
-    },
-    {
-      "$ref": "write-phrase-screen-exit#"
-    },
     {
       "$ref": "balance-fetch-network-error-notice#"
     },
     {
-      "$ref": "client-migration-run#"
-    },
-    {
-      "$ref": "compound-finance-view#"
-    },
-    {
-      "$ref": "contact-support-email-send#"
+      "$ref": "check-backup-quiz-completed#"
     },
     {
-      "$ref": "contact-support-view#"
+      "$ref": "client-migration-run#"
     },
     {
       "$ref": "d-app-auto-approve-set#"
@@ -55,6 +42,9 @@
     {
       "$ref": "d-app-connection-request#"
     },
+    {
+      "$ref": "d-app-evm-chain-set#"
+    },
     {
       "$ref": "d-app-favorite-set#"
     },
@@ -70,9 +60,6 @@
     {
       "$ref": "d-app-sign-transaction-request#"
     },
-    {
-      "$ref": "d-app-evm-chain-set#"
-    },
     {
       "$ref": "d-app-wallet-watch-asset#"
     },
@@ -91,24 +78,15 @@
     {
       "$ref": "exchange-order-status-change#"
     },
-    {
-      "$ref": "exchange-prompt-be-click#"
-    },
-    {
-      "$ref": "exchange-prompt-be-show#"
-    },
     {
       "$ref": "exchange-view#"
     },
     {
-      "$ref": "exodus-shares-view#"
+      "$ref": "exodus-transaction-broadcast-error#"
     },
     {
       "$ref": "exodus-transaction-broadcast#"
     },
-    {
-      "$ref": "exodus-transaction-broadcast-error#"
-    },
     {
       "$ref": "fiat-view#"
     },
@@ -121,18 +99,9 @@
     {
       "$ref": "fusion-profile-update#"
     },
-    {
-      "$ref": "history-view#"
-    },
     {
       "$ref": "home-news-tap#"
     },
-    {
-      "$ref": "home-portfolio-select#"
-    },
-    {
-      "$ref": "home-portfolio-swipe#"
-    },
     {
       "$ref": "home-portfolio-time-frame-select#"
     },
@@ -143,10 +112,10 @@
       "$ref": "home-suggestion-view#"
     },
     {
-      "$ref": "home-top-mover-tap#"
+      "$ref": "home-suggestions-video-tap#"
     },
     {
-      "$ref": "home-view#"
+      "$ref": "home-top-mover-tap#"
     },
     {
       "$ref": "home-widget-rerank#"
@@ -163,18 +132,9 @@
     {
       "$ref": "lightning-deposit#"
     },
-    {
-      "$ref": "lightning-deposit-view#"
-    },
-    {
-      "$ref": "lightning-history-view#"
-    },
     {
       "$ref": "lightning-invoice-generated#"
     },
-    {
-      "$ref": "lightning-lnur-view#"
-    },
     {
       "$ref": "lightning-onboarding-view#"
     },
@@ -185,10 +145,10 @@
       "$ref": "lightning-receive-view#"
     },
     {
-      "$ref": "lightning-send#"
+      "$ref": "lightning-send-view#"
     },
     {
-      "$ref": "lightning-send-view#"
+      "$ref": "lightning-send#"
     },
     {
       "$ref": "lightning-terms-and-conditions#"
@@ -199,48 +159,18 @@
     {
       "$ref": "lightning-withdraw#"
     },
-    {
-      "$ref": "lightning-withdraw-view#"
-    },
-    {
-      "$ref": "menu-view#"
-    },
     {
       "$ref": "network-easter-egg-activate#"
     },
     {
       "$ref": "news-article-tap#"
     },
-    {
-      "$ref": "news-view#"
-    },
-    {
-      "$ref": "nft-gallery-asset-receive-address-copy#"
-    },
-    {
-      "$ref": "nft-gallery-asset-receive-view#"
-    },
-    {
-      "$ref": "nft-gallery-asset-send#"
-    },
-    {
-      "$ref": "nft-gallery-asset-send-view#"
-    },
-    {
-      "$ref": "nft-gallery-asset-view#"
-    },
-    {
-      "$ref": "nft-gallery-view#"
-    },
     {
       "$ref": "nfts-proxy-server-get-image#"
     },
     {
       "$ref": "notifications-system-permission-modal-enable-tap#"
     },
-    {
-      "$ref": "notifications-system-permission-modal-view#"
-    },
     {
       "$ref": "off-ramp-configure-asset-sale#"
     },
@@ -254,10 +184,10 @@
       "$ref": "off-ramp-provider-status-change#"
     },
     {
-      "$ref": "off-ramp-sale-confirm#"
+      "$ref": "off-ramp-sale-confirm-view#"
     },
     {
-      "$ref": "off-ramp-sale-confirm-view#"
+      "$ref": "off-ramp-sale-confirm#"
     },
     {
       "$ref": "off-ramp-send-to-browser#"
@@ -307,30 +237,6 @@
     {
       "$ref": "onboarding-page-view#"
     },
-    {
-      "$ref": "onboarding-password-creation-confirm#"
-    },
-    {
-      "$ref": "onboarding-password-creation-initiate#"
-    },
-    {
-      "$ref": "onboarding-seed-create#"
-    },
-    {
-      "$ref": "onboarding-seed-input#"
-    },
-    {
-      "$ref": "portfolio-view#"
-    },
-    {
-      "$ref": "profile-edit-change-avatar#"
-    },
-    {
-      "$ref": "profile-edit-change-name#"
-    },
-    {
-      "$ref": "profile-edit-view#"
-    },
     {
       "$ref": "receive-select-asset-view#"
     },
@@ -367,36 +273,18 @@
     {
       "$ref": "restore-wallet-seed-input#"
     },
-    {
-      "$ref": "rewards-view#"
-    },
-    {
-      "$ref": "securitize-account-link#"
-    },
     {
       "$ref": "security-auto-lock-time-set#"
     },
-    {
-      "$ref": "security-backup-created#"
-    },
-    {
-      "$ref": "security-backup-creation-initiated#"
-    },
     {
       "$ref": "security-backup-vault-view#"
     },
     {
       "$ref": "security-backups-screen-view#"
     },
-    {
-      "$ref": "security-private-key-view#"
-    },
     {
       "$ref": "security-secret-phrase-screen-view#"
     },
-    {
-      "$ref": "send-select-asset-view#"
-    },
     {
       "$ref": "settings-advanced-mode-toggle#"
     },
@@ -418,18 +306,12 @@
     {
       "$ref": "settings-notifications-special-offers-toggle#"
     },
-    {
-      "$ref": "settings-notifications-view#"
-    },
     {
       "$ref": "settings-preferred-currency-set#"
     },
     {
       "$ref": "settings-restore-from-backup-view#"
     },
-    {
-      "$ref": "settings-restore-wallet-screen-view#"
-    },
     {
       "$ref": "solana-mobile-adapter-enable#"
     },
@@ -442,30 +324,12 @@
     {
       "$ref": "solana-pay-transaction-confirmation-view#"
     },
-    {
-      "$ref": "support-knowledge-base-send-to-browser#"
-    },
-    {
-      "$ref": "support-status-send-to-browser#"
-    },
-    {
-      "$ref": "support-view#"
-    },
     {
       "$ref": "telemetry-collection-decision#"
     },
-    {
-      "$ref": "unknown-event#"
-    },
-    {
-      "$ref": "wallet-asset-copy-receive-address#"
-    },
     {
       "$ref": "wallet-asset-manager-toggle#"
     },
-    {
-      "$ref": "wallet-asset-manager-view#"
-    },
     {
       "$ref": "wallet-asset-network-manual-refresh#"
     },
@@ -475,18 +339,6 @@
     {
       "$ref": "wallet-asset-send#"
     },
-    {
-      "$ref": "wallet-asset-send-view#"
-    },
-    {
-      "$ref": "wallet-asset-view#"
-    },
-    {
-      "$ref": "wallet-connect-activity-detail-view#"
-    },
-    {
-      "$ref": "wallet-connect-activity-view#"
-    },
     {
       "$ref": "wallet-connect-connection-added#"
     },
@@ -508,21 +360,6 @@
     {
       "$ref": "wallet-connect-initiate-connection#"
     },
-    {
-      "$ref": "wallet-connect-view#"
-    },
-    {
-      "$ref": "wallet-custom-token-add#"
-    },
-    {
-      "$ref": "wallet-exchange-detail-view#"
-    },
-    {
-      "$ref": "wallet-portfolio-create#"
-    },
-    {
-      "$ref": "wallet-portfolio-select#"
-    },
     {
       "$ref": "wallet-receive-assets-view#"
     },
@@ -538,29 +375,11 @@
     {
       "$ref": "wallet-staking-view#"
     },
-    {
-      "$ref": "wallet-transaction-detail-view#"
-    },
-    {
-      "$ref": "wallet-view#"
-    },
-    {
-      "$ref": "web3-browser-home-tap#"
-    },
     {
       "$ref": "web3-browser-launch-dapp#"
     },
     {
-      "$ref": "web3-browser-view#"
-    },
-    {
-      "$ref": "web3-explore-view#"
-    },
-    {
-      "$ref": "web3-favorites-view#"
-    },
-    {
-      "$ref": "web3-view#"
+      "$ref": "write-phrase-screen-exit#"
     }
   ]
-}
+}

package/src/onboarding/client-migration-run.schemasafe.json

@@ -16,14 +16,7 @@
       "properties": {
         "migration_id": {
           "type": "string",
-          "enum": [
-            "encrypt-fusion-storage",
-            "encrypt-orders-storage",
-            "encrypt-synced-balances-storage",
-            "encrypt-wallet-accounts-storage",
-            "nfts-hidden-config",
-            "revoke-connections"
-          ]
+          "format": "any-string"
         },
         "success": {
           "type": "boolean"

package/src/compound/compound-finance-view.schemasafe.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "event": {
-      "const": "CompoundFinanceView"
-    },
-    "properties": {
-      "allOf": [
-        {
-          "$ref": "common-properties#"
-        }
-      ],
-      "unevaluatedProperties": false
-    }
-  },
-  "unevaluatedProperties": false,
-  "required": ["event", "properties"]
-}

package/src/exchange/exchange-prompt-be-click.schemasafe.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "event": {
-      "const": "ExchangePromptBeClick"
-    },
-    "properties": {
-      "allOf": [
-        {
-          "$ref": "common-properties#"
-        }
-      ],
-      "unevaluatedProperties": false
-    }
-  },
-  "unevaluatedProperties": false,
-  "required": ["event", "properties"]
-}

package/src/exchange/exchange-prompt-be-show.schemasafe.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "event": {
-      "const": "ExchangePromptBeShow"
-    },
-    "properties": {
-      "allOf": [
-        {
-          "$ref": "common-properties#"
-        }
-      ],
-      "unevaluatedProperties": false
-    }
-  },
-  "unevaluatedProperties": false,
-  "required": ["event", "properties"]
-}

package/src/exodus/exodus-shares-view.schemasafe.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "event": {
-      "const": "ExodusSharesView"
-    },
-    "properties": {
-      "allOf": [
-        {
-          "$ref": "common-properties#"
-        }
-      ],
-      "unevaluatedProperties": false
-    }
-  },
-  "unevaluatedProperties": false,
-  "required": ["event", "properties"]
-}

package/src/history/history-view.schemasafe.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "event": {
-      "const": "HistoryView"
-    },
-    "properties": {
-      "allOf": [
-        {
-          "$ref": "common-properties#"
-        }
-      ],
-      "unevaluatedProperties": false
-    }
-  },
-  "unevaluatedProperties": false,
-  "required": ["event", "properties"]
-}

package/src/home/home-portfolio-select.schemasafe.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "event": {
-      "const": "HomePortfolioSelect"
-    },
-    "properties": {
-      "allOf": [
-        {
-          "$ref": "common-properties#"
-        }
-      ],
-      "unevaluatedProperties": false
-    }
-  },
-  "unevaluatedProperties": false,
-  "required": ["event", "properties"]
-}