@exodus/analytics-validation 1.3.0 → 1.4.1

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.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.4.0...@exodus/analytics-validation@1.4.1) (2023-06-12)
+
+### Bug Fixes
+
+- **AnalyticsValidation:** add isAuth for WalletConnectConnectionAdded schema ([#1892](https://github.com/ExodusMovement/exodus-hydra/issues/1892)) ([19177ba](https://github.com/ExodusMovement/exodus-hydra/commit/19177bab24d07ce7553cc13b197b5b4ec8c6619d))
+
+## [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

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.3.0",
+  "version": "1.4.1",
   "description": "The analytics-validation library",
   "author": "Exodus Movement Inc",
   "repository": {
@@ -33,5 +33,5 @@
     "eslint": "^8.33.0",
     "jest": "^29.1.2"
   },
-  "gitHead": "098c18a96733499ec8378bbb21c3a6e3c1c4cb38"
+  "gitHead": "b37b53c1f4f795017ab77444574df2305b2579eb"
 }

package/src/home/home-banner-page-view.schemasafe.json

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

package/src/main.schemasafe.json

@@ -96,6 +96,9 @@
     {
       "$ref": "fusion-profile-update#"
     },
+    {
+      "$ref": "home-banner-page-view#"
+    },
     {
       "$ref": "home-edit-favorites-toggle#"
     },
@@ -186,6 +189,12 @@
     {
       "$ref": "on-ramp-purchase-confirm#"
     },
+    {
+      "$ref": "onboarding-existing-wallet-tap#"
+    },
+    {
+      "$ref": "onboarding-new-wallet-tap#"
+    },
     {
       "$ref": "onboarding-page-skipped#"
     },

package/src/onboarding/onboarding-existing-wallet-tap.schemasafe.json

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

package/src/onboarding/onboarding-new-wallet-tap.schemasafe.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "OnboardingNewWalletTap"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "has_invite_code": {
+          "type": "boolean"
+        },
+        "invite_code": {
+          "type": "string",
+          "format": "any-string",
+          "minLength": 1,
+          "maxLength": 10
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/src/wallet/wallet-connect-connection-added.schemasafe.json

@@ -17,6 +17,9 @@
         "dapp_domain": {
           "type": "string",
           "format": "any-string"
+        },
+        "is_auth": {
+          "type": "boolean"
         }
       },
       "unevaluatedProperties": false