@exodus/analytics-validation 1.2.0 → 1.4.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.
 
+## [1.4.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.3.0...@exodus/analytics-validation@1.4.0) (2023-06-09)
+
+### Features
+
+- **analytics-validation:** add events for new onboarding and home tour ([#1879](https://github.com/ExodusMovement/exodus-hydra/issues/1879)) ([4a9ac31](https://github.com/ExodusMovement/exodus-hydra/commit/4a9ac31191124faa5c4a7a51967cbf4fe85bbc69))
+
+## [1.3.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.2.0...@exodus/analytics-validation@1.3.0) (2023-06-05)
+
+### Features
+
+- **analytics-validation:** replace all origin enum validation with any-string ([#1765](https://github.com/ExodusMovement/exodus-hydra/issues/1765)) ([a5fb529](https://github.com/ExodusMovement/exodus-hydra/commit/a5fb529c162943b87be175bf5559e591e4cf688b))
+
 ## [1.2.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.1.0...@exodus/analytics-validation@1.2.0) (2023-06-01)
 
 ### Features

package/README.md

@@ -1,17 +1,70 @@
 # @exodus/analytics-validation
 
+## Why
+
+This helps prevent that we do not accidentally collect any sensitive and/or private information, therefore all events must pass a validation layer.
+
+Examples of what could go wrong:
+
+- [Slope Finance sending 12-word mnemonics to Sentry 💀](https://twitter.com/osec_io/status/1555087560887922688?s=20)
+
 ## 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.
+### Do I need to add a new schema?
+
+```mermaid
+flowchart TD
+    Title(Adding a new telemetry event) --> A
+    A{Does your event\nhave properties?}
+    A -->|Yes| C
+    A -->|No| B
+    B(You're done!)
+    C{Does it only require\n the 'origin' property?}
+    C -->|Yes| B
+    C -->|No| E[Generate a new JSON Schema: \nyarn generate:analytics-validation]
+    E --> D[Adjust the schema and tests]
+    D --> B
+
+```
+
+### JSON Schema Development
 
 To add a new schema run
 
-> yarn generate:analytics-validation
+```bash
+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.
+1. 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;
+2. Fill the schema with the expected properties and their types. The property names must be in the **snake_case** (e.g. `expected_property`);
+3. Fix the generated unit test as it will be intentionally failing;
+4. Add your own test cases to ensure the schema works properly before merging the PR and publishing a new version.
+
+#### List of string formats
+
+Schemasafe ships with a bunch of default formats, [you can find the implementation of these here!](https://github.com/ExodusMovement/schemasafe/blob/master/src/formats.js)
+
+- email
+- hostname
+- uuid
+- date
+- time
+- date-time
+- duration
+- ipv4
+- ipv6
+- uri
+- uri-reference
+- uri-template
+- alpha
+- alphanumeric
+- base64
+- hex-digits
+- hex-digits-prefixed
+- hex-bytes
+- hex-bytes-prefixed
+- json-pointer
+- relative-json-pointer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/analytics-validation",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "The analytics-validation library",
   "author": "Exodus Movement Inc",
   "repository": {
@@ -33,5 +33,5 @@
     "eslint": "^8.33.0",
     "jest": "^29.1.2"
   },
-  "gitHead": "52828af6d22620c3770831020cee683af894a98b"
+  "gitHead": "ab1e457d13ea95f2b4da405f9277eb1bdc9f6b1d"
 }

package/src/bitrefill/bitrefill-pay.schemasafe.json

@@ -14,10 +14,6 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
-          "type": "string",
-          "format": "any-string"
-        },
         "success": {
           "type": "boolean"
         }

package/src/common-properties.schemasafe.json

@@ -184,6 +184,10 @@
     "selected_language": {
       "type": "string",
       "format": "any-string"
+    },
+    "origin": {
+      "type": "string",
+      "format": "any-string"
     }
   }
 }

package/src/exchange/exchange-asset-swap.schemasafe.json

@@ -14,20 +14,6 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
-          "type": "string",
-          "enum": [
-            "dashboard-portfolio",
-            "nav-bar",
-            "nft-gallery",
-            "null",
-            "stake-form-no-funds",
-            "staking-claim",
-            "transactions",
-            "wallet-asset",
-            "wallet-quick-action"
-          ]
-        },
         "success": {
           "type": "boolean"
         }

package/src/fiat/off-ramp-continue-tap.schemasafe.json

@@ -18,20 +18,6 @@
           "type": "string",
           "format": "any-string"
         },
-        "origin": {
-          "type": "string",
-          "enum": [
-            "dashboard",
-            "exodex-insufficient-funds",
-            "exodus-dashboard-asset",
-            "home",
-            "nav-bar",
-            "profile",
-            "promo-banner",
-            "wallet-asset",
-            "wallet-connect"
-          ]
-        },
         "payment_method": {
           "type": "string",
           "enum": ["card"]

package/src/fiat/off-ramp-provider-status-change.schemasafe.json

@@ -35,10 +35,6 @@
           "type": "string",
           "format": "any-string"
         },
-        "origin": {
-          "type": "string",
-          "format": "any-string"
-        },
         "payment_method": {
           "type": "string",
           "format": "any-string"

package/src/fiat/off-ramp-sale-confirm.schemasafe.json

@@ -14,10 +14,6 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
-          "type": "string",
-          "format": "any-string"
-        },
         "success": {
           "type": "boolean"
         }

package/src/fiat/on-ramp-continue-tap.schemasafe.json

@@ -18,10 +18,6 @@
           "type": "string",
           "format": "any-string"
         },
-        "origin": {
-          "type": "string",
-          "format": "any-string"
-        },
         "payment_method": {
           "type": "string",
           "format": "any-string"

package/src/fiat/on-ramp-payment-method-select.schemasafe.json

@@ -14,10 +14,6 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
-          "type": "string",
-          "format": "any-string"
-        },
         "payment_method_to": {
           "type": "string",
           "format": "any-string"

package/src/fiat/on-ramp-provider-select.schemasafe.json

@@ -17,10 +17,6 @@
         "best_price": {
           "type": "boolean"
         },
-        "origin": {
-          "type": "string",
-          "format": "any-string"
-        },
         "provider_from": {
           "type": "string",
           "format": "any-string"

package/src/fiat/on-ramp-provider-status-change.schemasafe.json

@@ -38,10 +38,6 @@
         "network_fee": {
           "type": "number"
         },
-        "origin": {
-          "type": "string",
-          "format": "any-string"
-        },
         "payment_method": {
           "type": "string",
           "format": "any-string"

package/src/fiat/on-ramp-purchase-confirm.schemasafe.json

@@ -14,10 +14,6 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
-          "type": "string",
-          "format": "any-string"
-        },
         "success": {
           "type": "boolean"
         }

package/src/{fiat/off-ramp-sale-confirm-view.schemasafe.json → home/home-banner-page-view.schemasafe.json}

@@ -3,7 +3,7 @@
   "type": "object",
   "properties": {
     "event": {
-      "const": "OffRampSaleConfirmView"
+      "const": "HomeBannerPageView"
     },
     "properties": {
       "allOf": [
@@ -14,7 +14,10 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
+        "page_order": {
+          "type": "number"
+        },
+        "page": {
           "type": "string",
           "format": "any-string"
         }

package/src/main.schemasafe.json

@@ -15,24 +15,12 @@
     {
       "$ref": "asset-network-manual-refresh#"
     },
-    {
-      "$ref": "backup-prompt-view#"
-    },
     {
       "$ref": "balance-fetch-network-error-notice#"
     },
-    {
-      "$ref": "bitrefill-insufficient-funds-view#"
-    },
     {
       "$ref": "bitrefill-pay#"
     },
-    {
-      "$ref": "bitrefill-payment-view#"
-    },
-    {
-      "$ref": "bitrefill-view#"
-    },
     {
       "$ref": "check-backup-quiz-completed#"
     },
@@ -81,9 +69,6 @@
     {
       "$ref": "exchange-asset-swap#"
     },
-    {
-      "$ref": "exchange-configure-asset-swap#"
-    },
     {
       "$ref": "exchange-no-gas#"
     },
@@ -96,18 +81,12 @@
     {
       "$ref": "exchange-order-status-change#"
     },
-    {
-      "$ref": "exchange-view#"
-    },
     {
       "$ref": "exodus-transaction-broadcast-error#"
     },
     {
       "$ref": "exodus-transaction-broadcast#"
     },
-    {
-      "$ref": "fiat-view#"
-    },
     {
       "$ref": "fusion-profile-create#"
     },
@@ -117,6 +96,9 @@
     {
       "$ref": "fusion-profile-update#"
     },
+    {
+      "$ref": "home-banner-page-view#"
+    },
     {
       "$ref": "home-edit-favorites-toggle#"
     },
@@ -156,27 +138,15 @@
     {
       "$ref": "lightning-invoice-generated#"
     },
-    {
-      "$ref": "lightning-onboarding-view#"
-    },
     {
       "$ref": "lightning-receive-funds#"
     },
-    {
-      "$ref": "lightning-receive-view#"
-    },
-    {
-      "$ref": "lightning-send-view#"
-    },
     {
       "$ref": "lightning-send#"
     },
     {
       "$ref": "lightning-terms-and-conditions#"
     },
-    {
-      "$ref": "lightning-view#"
-    },
     {
       "$ref": "lightning-withdraw#"
     },
@@ -192,12 +162,6 @@
     {
       "$ref": "notifications-system-permission-modal-enable-tap#"
     },
-    {
-      "$ref": "off-ramp-configure-asset-sale#"
-    },
-    {
-      "$ref": "off-ramp-configure-asset-sell#"
-    },
     {
       "$ref": "off-ramp-continue-tap#"
     },
@@ -207,53 +171,29 @@
     {
       "$ref": "off-ramp-provider-status-change#"
     },
-    {
-      "$ref": "off-ramp-sale-confirm-view#"
-    },
     {
       "$ref": "off-ramp-sale-confirm#"
     },
-    {
-      "$ref": "off-ramp-send-to-browser#"
-    },
-    {
-      "$ref": "off-ramp-view#"
-    },
-    {
-      "$ref": "on-ramp-configure-asset-purchase#"
-    },
     {
       "$ref": "on-ramp-continue-tap#"
     },
-    {
-      "$ref": "on-ramp-disabled-view#"
-    },
     {
       "$ref": "on-ramp-payment-method-select#"
     },
-    {
-      "$ref": "on-ramp-payment-method-view#"
-    },
     {
       "$ref": "on-ramp-provider-select#"
     },
     {
       "$ref": "on-ramp-provider-status-change#"
     },
-    {
-      "$ref": "on-ramp-provider-view#"
-    },
     {
       "$ref": "on-ramp-purchase-confirm#"
     },
     {
-      "$ref": "on-ramp-receive-from-browser#"
+      "$ref": "onboarding-existing-wallet-tap#"
     },
     {
-      "$ref": "on-ramp-send-to-browser#"
-    },
-    {
-      "$ref": "on-ramp-view#"
+      "$ref": "onboarding-new-wallet-tap#"
     },
     {
       "$ref": "onboarding-page-skipped#"
@@ -261,9 +201,6 @@
     {
       "$ref": "onboarding-page-view#"
     },
-    {
-      "$ref": "receive-select-asset-view#"
-    },
     {
       "$ref": "referral-code-input#"
     },
@@ -303,12 +240,6 @@
     {
       "$ref": "security-backup-vault-view#"
     },
-    {
-      "$ref": "security-backups-screen-view#"
-    },
-    {
-      "$ref": "security-secret-phrase-screen-view#"
-    },
     {
       "$ref": "settings-advanced-mode-toggle#"
     },
@@ -357,18 +288,12 @@
     {
       "$ref": "wallet-asset-network-manual-refresh#"
     },
-    {
-      "$ref": "wallet-asset-receive-view#"
-    },
     {
       "$ref": "wallet-asset-send-no-gas#"
     },
     {
       "$ref": "wallet-asset-send#"
     },
-    {
-      "$ref": "wallet-asset-view#"
-    },
     {
       "$ref": "wallet-connect-connection-added#"
     },
@@ -387,21 +312,6 @@
     {
       "$ref": "wallet-connect-fiat-on-ramp-cta-tap#"
     },
-    {
-      "$ref": "wallet-connect-initiate-connection#"
-    },
-    {
-      "$ref": "wallet-exchange-detail-view#"
-    },
-    {
-      "$ref": "wallet-purchase-detail-view#"
-    },
-    {
-      "$ref": "wallet-receive-assets-view#"
-    },
-    {
-      "$ref": "wallet-sale-detail-view#"
-    },
     {
       "$ref": "wallet-staking-claim#"
     },
@@ -417,9 +327,6 @@
     {
       "$ref": "wallet-staking-view#"
     },
-    {
-      "$ref": "wallet-transaction-detail-view#"
-    },
     {
       "$ref": "web3-browser-launch-dapp#"
     },

package/src/{backup/backup-prompt-view.schemasafe.json → onboarding/onboarding-existing-wallet-tap.schemasafe.json}

@@ -3,7 +3,7 @@
   "type": "object",
   "properties": {
     "event": {
-      "const": "BackupPromptView"
+      "const": "OnboardingExistingWalletTap"
     },
     "properties": {
       "allOf": [
@@ -14,9 +14,11 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
+        "invite_code": {
           "type": "string",
-          "enum": ["enabling-passcode", "newly-funded-wallet"]
+          "format": "any-string",
+          "minLength": 1,
+          "maxLength": 10
         }
       },
       "unevaluatedProperties": false

package/src/{bitrefill/bitrefill-insufficient-funds-view.schemasafe.json → onboarding/onboarding-new-wallet-tap.schemasafe.json}

@@ -3,7 +3,7 @@
   "type": "object",
   "properties": {
     "event": {
-      "const": "BitrefillInsufficientFundsView"
+      "const": "OnboardingNewWalletTap"
     },
     "properties": {
       "allOf": [
@@ -14,9 +14,14 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
+        "has_invite_code": {
+          "type": "boolean"
+        },
+        "invite_code": {
           "type": "string",
-          "format": "any-string"
+          "format": "any-string",
+          "minLength": 1,
+          "maxLength": 10
         }
       },
       "unevaluatedProperties": false

package/src/onboarding/restore-wallet-seed-input.schemasafe.json

@@ -14,10 +14,6 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
-          "type": "string",
-          "enum": ["onboarding", "settings"]
-        },
         "is_onboarding": {
           "type": "boolean"
         },

package/src/security/security-backup-vault-view.schemasafe.json

@@ -14,10 +14,6 @@
       "type": "object",
       "required": [],
       "properties": {
-        "origin": {
-          "type": "string",
-          "enum": ["nav-bar", "security"]
-        },
         "screen_type": {
           "type": "string",
           "enum": [

package/src/wallet/wallet-staking-view.schemasafe.json

@@ -16,10 +16,6 @@
       "properties": {
         "is_active": {
           "type": "boolean"
-        },
-        "origin": {
-          "type": "string",
-          "format": "any-string"
         }
       },
       "unevaluatedProperties": false

package/src/web3/web3-browser-launch-dapp.schemasafe.json

@@ -17,10 +17,6 @@
         "dapp_domain": {
           "type": "string",
           "format": "any-string"
-        },
-        "origin": {
-          "type": "string",
-          "format": "any-string"
         }
       },
       "unevaluatedProperties": false

package/src/bitrefill/bitrefill-payment-view.schemasafe.json

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

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

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