initial pixel schema WIP

Author: Lucas Adamski

PixelDefinitions/.prettierignore

@@ -0,0 +1 @@
+*.md

PixelDefinitions/README.md

@@ -0,0 +1 @@
+For information about documenting pixels and validating them, see https://github.com/duckduckgo/pixel-schema/blob/main/README.md

PixelDefinitions/asana_notify.json

@@ -0,0 +1,5 @@
+{
+    "assignee": "ladamski",
+    "followers": ["jeannamatthews", "nshuba", "sammacbeth"],
+    "tagPixelOwners": false
+}

PixelDefinitions/ignore_params.json

@@ -0,0 +1 @@
+{}

PixelDefinitions/native_experiments.json5

@@ -0,0 +1,6 @@
+{
+    // This file will define pixels sent by the native experiments framework
+    defaultSuffixes: [],
+    activeExperiments: {},
+}
+

PixelDefinitions/package-lock.json

@@ -0,0 +1,28 @@
+{
+    "name": "@duckduckgo/windows-browser",
+    "version": "1.0.0",
+    "dependencies": {
+        "@duckduckgo/pixel-schema": "github:duckduckgo/pixel-schema#v1.0.8",
+        "prettier": "^3.5.1"
+    },
+    "scripts": {
+        "validate-defs-without-formatting": "validate-ddg-pixel-defs .",
+        "validate-defs": "validate-ddg-pixel-defs .  && prettier . --check",
+        "lint": "prettier . --check",
+        "lint.fix": "prettier . --write"
+    },
+    "prettier": {
+        "singleQuote": true,
+        "printWidth": 140,
+        "tabWidth": 4,
+        "overrides": [
+            {
+                "files": "*.json5",
+                "options": {
+                    "parser": "json",
+                    "tabWidth": 4
+                }
+            }
+        ]
+    }
+}

PixelDefinitions/package.json

@@ -0,0 +1,29 @@
+// This file defines commonly used params - this does NOT mean they are added by default
+// In your pixel definitions, you can reference these params by their key
+// See TEMPLATE.json for an example
+{
+    "appVersion": {
+        "key": "appVersion",
+        "type": "string",
+        "description": "",
+        "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(\\.[0-9]+)?$",
+        "examples": ["0.89.3"]
+    },
+    "atb": {
+        "key": "atb",
+        "type": "string",
+        "pattern": "v[0-9]{1,3}-[0-7]([a-z]{2})?",
+        "description": "Add to browser value, corresponding to the users install week and day"
+    },
+    "channel": {
+        "key": "channel",
+        "type": "string",
+        "description": "The channel the user is on",
+        "enum": ["dev", "canary", "beta", "preview", "stable", "unknown", "unpackaged"]
+    },
+    "remoteConfigEtag": {
+        "key": "remoteConfigEtag",
+        "description": "",
+        "pattern": "\"[-0-9a-f]{32}\""
+    }
+}

PixelDefinitions/params_dictionary.json

@@ -0,0 +1,30 @@
+// See https://app.asana.com/0/72649045549333/1208001118995887/f.
+{
+    "pixel_name": {
+        "description": "Describe when the pixel fires and its purpose",
+        // Github usernames of the people responsible for the pixel (https://github.com/duckduckgo/internal-github-asana-utils/blob/main/user_map.yml)
+        "owners": ["nshuba"],
+        "triggers": ["other"],
+        "suffixes": [
+            // A suffix is a dynamic part of the pixel name, e.g. "some.pixel.[count|daily]"
+            "first_daily_count", // shortcut to a commonly used suffix, defined in common_suffixes.json.
+            {
+                // Custom suffix.
+                "description": "Describe the custom suffix and its purpose",
+                "enum": ["suffix1", "suffix2"]
+            }
+        ],
+        "parameters": [
+            // Commonly used param, defined in params_dictionary.json.
+            "appVersion",
+            // Commonly used param, defined in params_dictionary.json.
+            "channel",
+            {
+                "key": "paramKey",
+                "description": "Describe the parameter and its purpose"
+            }
+        ],
+        // If pixel is temporary, remove if pixel is permanent.
+        "expires": "2025-01-30"
+    }
+}

PixelDefinitions/pixels/TEMPLATE.json5

@@ -0,0 +1,22 @@
+// See https://app.asana.com/1/137249556945/project/392891325557410/task/1210882421460693
+{
+    m_autocomplete_displayed_bookmark_android_phone: {
+        description: 'TBD',
+        owners: [],
+        suffixes: ['platform', 'form_factor'],
+        parameters: ['appVersion'],
+    },
+    m_autocomplete_displayed_bookmark_android_tablet: {
+        description: 'TBD',
+        owners: [],
+        suffixes: ['platform', 'form_factor'],
+        parameters: ['appVersion'],
+    },
+    m_autocomplete_displayed_favorite_android_phone: {
+        description: 'TBD',
+        owners: [],
+        suffixes: ['platform', 'form_factor'],
+        parameters: ['appVersion'],
+    }
+}
+