@exodus/analytics-validation 1.0.1-alpha.1 → 1.0.1-alpha.2

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.1-alpha.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.0.1-alpha.1...@exodus/analytics-validation@1.0.1-alpha.2) (2023-04-14)
+
+**Note:** Version bump only for package @exodus/analytics-validation
+
 ## [1.0.1-alpha.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.0.1-alpha.0...@exodus/analytics-validation@1.0.1-alpha.1) (2023-04-14)
 
 ### ⚠ BREAKING CHANGES

package/index.js

@@ -0,0 +1 @@
+export { validateEvent } from './src/main.schemasafe.json'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/analytics-validation",
-  "version": "1.0.1-alpha.1",
+  "version": "1.0.1-alpha.2",
   "description": "The analytics-validation library",
   "author": "Exodus Movement Inc",
   "repository": {
@@ -14,7 +14,10 @@
   },
   "main": "./lib/index.js",
   "files": [
-    "lib",
+    "src",
+    "!**/__tests__",
+    "schemasafe.config.js",
+    "index.js",
     "README.md",
     "CHANGELOG.md"
   ],
@@ -29,5 +32,5 @@
     "eslint": "^8.33.0",
     "jest": "^29.1.2"
   },
-  "gitHead": "f03e530bddd1c6cc51d648b0cd8681d2b2691438"
+  "gitHead": "40f7aed15122ee8a6b4bb6d05da665635ca04b30"
 }

package/schemasafe.config.js

@@ -0,0 +1,37 @@
+const fs = require('fs')
+const path = require('path')
+
+const schemasDirPath = path.join(__dirname, './src')
+const schemaNames = fs.readdirSync(schemasDirPath)
+
+const schemas = {}
+for (const schemaName of schemaNames) {
+  if (schemaName === 'main.schemasafe.json') continue
+  const schemaPath = path.join(schemasDirPath, schemaName)
+
+  if (fs.statSync(schemaPath).isDirectory()) {
+    if (schemaName === '__tests__') continue
+    throw new Error('unexpected directory in schemas folder')
+  }
+
+  // primitive-type.schemafe.json -> primitive-type
+  const name = schemaName.slice(0, schemaName.indexOf('.'))
+  const schemaString = fs.readFileSync(schemaPath, 'utf8')
+  schemas[name] = JSON.parse(schemaString)
+}
+
+// Source: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+const semVerRegEx =
+  /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][\dA-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][\dA-Za-z-]*))*))?(?:\+([\dA-Za-z-]+(?:\.[\dA-Za-z-]+)*))?$/
+const localeRegEx = /^[A-Za-z]{2,4}([_-][A-Za-z]{2,4})?$/
+
+// NOTE: this is exported so consumers can use the same settings at runtime
+// as were used to compile schemas at build time
+module.exports = {
+  formats: {
+    'any-string': (str) => typeof str === 'string',
+    'semver-string': semVerRegEx,
+    locale: localeRegEx,
+  },
+  schemas,
+}

package/src/app-session.schemasafe.json

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

package/src/asset-network-manual-refresh.schemasafe.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "AssetNetworkManualRefresh"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        },
+        {
+          "type": "object",
+          "required": [],
+          "properties": {
+            "balance_changed": {
+              "type": "boolean"
+            },
+            "category": {
+              "type": "string",
+              "enum": ["BITCOIN_LIKE", "ETHEREUM_LIKE", "OTHER"]
+            }
+          }
+        }
+      ]
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/src/backup-prompt-view.schemasafe.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "BackupPromptView"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        },
+        {
+          "type": "object",
+          "required": [],
+          "properties": {
+            "origin": {
+              "type": "string",
+              "enum": ["enabling-passcode", "newly-funded-wallet"]
+            }
+          }
+        }
+      ]
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/src/balance-fetch-network-error-notice.schemasafe.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "BalanceFetchNetworkErrorNotice"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        },
+        {
+          "type": "object",
+          "required": [],
+          "properties": {
+            "network": {
+              "type": "string",
+              "enum": [
+                "avalanchec",
+                "bsc",
+                "ethereum",
+                "ethereumarbone",
+                "fantommainnet",
+                "matic",
+                "rootstock",
+                "solana"
+              ]
+            }
+          }
+        }
+      ]
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

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

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "ClientMigrationRun"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        },
+        {
+          "type": "object",
+          "required": [],
+          "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"
+              ]
+            },
+            "success": {
+              "type": "boolean"
+            }
+          }
+        }
+      ]
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/src/common-properties.schemasafe.json

@@ -0,0 +1,181 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Common properties used by most of the events.",
+  "type": "object",
+  "required": [],
+  "unevaluatedProperties": false,
+  "additionalProperties": {
+    "anyOf": [
+      {
+        "type": "string",
+        "format": "any-string",
+        "maxLength": 100
+      },
+      {
+        "type": "number"
+      },
+      {
+        "type": "boolean"
+      },
+      {
+        "type": "null"
+      }
+    ]
+  },
+  "propertyNames": {
+    "pattern": "^\\w*$"
+  },
+  "properties": {
+    "time": {
+      "type": "number"
+    },
+    "distinct_id": {
+      "type": "string",
+      "format": "base64",
+      "maxLength": 100,
+      "$comment": "Max length is arbitrary"
+    },
+    "app_build": {
+      "anyOf": [
+        { "const": "dev" },
+        { "const": "prod" },
+        { "const": "mobile" },
+        { "const": "nile" },
+        { "const": "production" },
+        { "const": "stage" }
+      ]
+    },
+    "app_platform": {
+      "anyOf": [{ "const": "browser" }, { "const": "mobile" }, { "const": "desktop" }]
+    },
+    "app_version": {
+      "type": "string",
+      "format": "semver-string",
+      "maxLength": 10,
+      "$comment": "Max length is arbitrary"
+    },
+    "asset_exchanged_last_90": {
+      "type": "boolean"
+    },
+    "asset_purchased_last_90": {
+      "type": "boolean"
+    },
+    "asset_received_last_90": {
+      "type": "boolean"
+    },
+    "asset_sent_last_90": {
+      "type": "boolean"
+    },
+    "asset_staked_last_90": {
+      "type": "boolean"
+    },
+    "device_manufacturer": {
+      "anyOf": [{ "const": "Apple" }]
+    },
+    "device_model": {
+      "type": "string",
+      "format": "any-string"
+    },
+    "device_arch": {
+      "type": "string",
+      "format": "any-string"
+    },
+    "experiments": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "lightning-app:enabled",
+          "lightning-app:disabled",
+          "nft-app:enabled",
+          "ftx-21.7.29:A",
+          "exchange-2022-06-20:aero2",
+          "exchange-2022-06-20:default",
+          "exchange-metrics:enabled",
+          "exchange-v2-21.8.12:v2",
+          "ramp-onboarding:enabled",
+          "ramp-app:on",
+          "ramp-tab-button:off",
+          "ramp-tab-button:on",
+          "on-ramp-experiment-1:v1",
+          "wallet-connect:enabled",
+          "wallet-connect-dapps:enabled",
+          "seedless:disabled",
+          "seedless:enabled",
+          "support-chat:on"
+        ]
+      }
+    },
+    "has_balance": {
+      "type": "boolean"
+    },
+    "has_nft": {
+      "type": "boolean"
+    },
+    "locale": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "locale",
+        "maxLength": 10,
+        "$comment": "Max length is arbitrary"
+      }
+    },
+    "mp_lib": {
+      "const": "Segment: unknown"
+    },
+    "mp_processing_time_ms": {
+      "type": "number"
+    },
+    "os_name": {
+      "anyOf": [
+        {
+          "const": "A"
+        },
+        {
+          "const": "android"
+        },
+        {
+          "const": "darwin"
+        },
+        {
+          "const": "I"
+        },
+        {
+          "const": "ios"
+        },
+        {
+          "const": "L"
+        },
+        {
+          "const": "linux"
+        },
+        {
+          "const": "M"
+        },
+        {
+          "const": "W"
+        },
+        {
+          "const": "win32"
+        }
+      ]
+    },
+    "os_version": {
+      "type": "string",
+      "format": "semver-string",
+      "maxLength": 10,
+      "$comment": "Max length is arbitrary"
+    },
+    "screen_height": {
+      "type": "number"
+    },
+    "screen_width": {
+      "type": "number"
+    },
+    "selected_language": {
+      "type": "string",
+      "format": "any-string"
+    }
+  }
+}

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

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

package/src/contact-support-email-send.schemasafe.json

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

package/src/contact-support-view.schemasafe.json

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

package/src/d-app-auto-approve-set.schemasafe.json

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

package/src/d-app-auto-approve-unset.schemasafe.json

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

package/src/d-app-connection-delete.schemasafe.json

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

package/src/d-app-connection-request.schemasafe.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "DAppConnectionRequest"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        },
+        {
+          "type": "object",
+          "required": [],
+          "properties": {
+            "approved": {
+              "type": "boolean"
+            },
+            "connection_origin": {
+              "type": "string",
+              "enum": ["banner", "default", "lucky-cat___en"]
+            },
+            "connection_protocol": {
+              "type": "string",
+              "enum": [
+                "wallet-connect",
+                "solana-adapter",
+                "Solana Mobile Wallet Adapter",
+                "dApp Browser",
+                "Wallet Connect",
+                "WalletConnect"
+              ]
+            }
+          }
+        }
+      ]
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/src/d-app-favorite-set.schemasafe.json

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

package/src/d-app-launch.schemasafe.json

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

package/src/d-app-network-switch-request.schemasafe.json

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

package/src/d-app-sign-message-request.schemasafe.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "DAppSignMessageRequest"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        },
+        {
+          "type": "object",
+          "required": [],
+          "properties": {
+            "approved": {
+              "type": "boolean"
+            },
+            "connection_protocol": {
+              "type": "string",
+              "enum": [
+                "wallet-connect",
+                "solana-adapter",
+                "Solana Mobile Wallet Adapter",
+                "dApp Browser",
+                "Wallet Connect",
+                "WalletConnect"
+              ]
+            }
+          }
+        }
+      ]
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}