ntp: customizer data/messages (#1328)

special-pages/package.json

@@ -19,6 +19,7 @@
     "test.android": "npm run test-int -- --project android",
     "test.headed": "npm run test-int -- --headed",
     "test.ui": "npm run test-int -- --ui",
+    "preserve": "npm run build.dev",
     "serve": "http-server -c-1 --port 3210 ../build/integration/pages",
     "watch": "node watch.mjs"
   },

special-pages/pages/new-tab/messages/customizer_deleteImage.notify.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string"
+    }
+  }
+}

special-pages/pages/new-tab/messages/customizer_onBackgroundUpdate.subscribe.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "allOf": [
+    {
+      "$ref": "types/background-data.json"
+    }
+  ]
+}

special-pages/pages/new-tab/messages/customizer_onColorUpdate.subscribe.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "allOf": [
+    {
+      "$ref": "types/user-color-data.json"
+    }
+  ]
+}

special-pages/pages/new-tab/messages/customizer_onImagesUpdate.subscribe.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "allOf": [
+    {
+      "$ref": "./types/user-image-data.json"
+    }
+  ]
+}

special-pages/pages/new-tab/messages/customizer_onThemeUpdate.subscribe.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "allOf": [
+    {
+      "$ref": "types/theme-data.json"
+    }
+  ]
+}

special-pages/pages/new-tab/messages/customizer_setBackground.notify.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "background"
+  ],
+  "properties": {
+    "background": {
+      "$ref": "./types/background.json#/definitions/background-variant"
+    }
+  }
+}

special-pages/pages/new-tab/messages/customizer_setTheme.notify.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": ["theme"],
+  "properties": {
+    "theme": {
+      "$ref": "types/browser-theme.json"
+    }
+  }
+}

special-pages/pages/new-tab/messages/customizer_upload.notify.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

special-pages/pages/new-tab/messages/examples/widgets.js

@@ -41,6 +41,7 @@ const initialSetupResponse = {
     locale: 'en',
     platform: { name: 'windows' },
     updateNotification: { content: null },
+    customizer: { theme: 'system', userImages: [], userColor: null, background: { kind: 'default' } },
 };
 
 export {};

special-pages/pages/new-tab/messages/initialSetup.response.json

@@ -29,6 +29,9 @@
         }
       }
     },
+    "customizer": {
+      "$ref": "./types/customizer-data.json"
+    },
     "updateNotification": {
       "oneOf": [
         {

special-pages/pages/new-tab/messages/types/background-data.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Background Data",
+  "type": "object",
+  "required": ["background"],
+  "properties": {
+    "background": {
+      "$ref": "./background.json#/definitions/background-variant"
+    }
+  }
+}

special-pages/pages/new-tab/messages/types/background.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "background-variant": {
+      "title": "Background Variant",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/default"
+        },
+        {
+          "$ref": "#/definitions/solid"
+        },
+        {
+          "$ref": "#/definitions/hex"
+        },
+        {
+          "$ref": "#/definitions/gradient"
+        },
+        {
+          "$ref": "#/definitions/image"
+        }
+      ]
+    },
+    "default": {
+      "type": "object",
+      "required": [
+        "kind"
+      ],
+      "title": "Default Background",
+      "properties": {
+        "kind": {
+          "const": "default"
+        }
+      }
+    },
+    "solid": {
+      "type": "object",
+      "required": [
+        "kind",
+        "value"
+      ],
+      "title": "Solid Color Background",
+      "properties": {
+        "kind": {
+          "const": "color"
+        },
+        "value": {
+          "$ref": "./colors.json#/definitions/colors"
+        }
+      }
+    },
+    "hex": {
+      "type": "object",
+      "required": [
+        "kind",
+        "value"
+      ],
+      "title": "Hex Value Background",
+      "properties": {
+        "kind": {
+          "const": "hex"
+        },
+        "value": {
+          "type": "string"
+        }
+      }
+    },
+    "gradient":     {
+      "type": "object",
+      "required": [
+        "kind",
+        "value"
+      ],
+      "title": "Gradient Background",
+      "properties": {
+        "kind": {
+          "const": "gradient"
+        },
+        "value": {
+          "$ref": "./colors.json#/definitions/gradients"
+        }
+      }
+    },
+    "image":     {
+      "type": "object",
+      "required": [
+        "kind",
+        "value"
+      ],
+      "title": "User Image Background",
+      "properties": {
+        "kind": {
+          "const": "userImage"
+        },
+        "value": {
+          "$ref": "./user-image.json"
+        }
+      }
+    }
+  }
+}

special-pages/pages/new-tab/messages/types/browser-theme.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Browser Theme",
+  "enum": [
+    "light",
+    "dark",
+    "system"
+  ]
+}

special-pages/pages/new-tab/messages/types/colors.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "gradients": {
+      "title": "Predefined Gradient",
+      "enum": [
+        "gradient01",
+        "gradient02",
+        "gradient03",
+        "gradient04",
+        "gradient05",
+        "gradient06",
+        "gradient07",
+        "gradient08"
+      ]
+    },
+    "colors": {
+      "title": "Predefined Color",
+      "enum": [
+        "color01",
+        "color02",
+        "color03",
+        "color04",
+        "color05",
+        "color06",
+        "color07",
+        "color08",
+        "color09",
+        "color10",
+        "color11",
+        "color12",
+        "color13",
+        "color14",
+        "color15",
+        "color16",
+        "color17",
+        "color18",
+        "color19"
+      ]
+    },
+    "colorScheme": {
+      "title": "Background Color Scheme",
+      "description": "Note: this is different to the Browser Theme",
+      "enum": ["light", "dark"]
+    }
+  }
+}

special-pages/pages/new-tab/messages/types/customizer-data.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Customizer Data",
+  "type": "object",
+  "required": [
+    "background",
+    "theme",
+    "userImages",
+    "userColor"
+  ],
+  "properties": {
+    "background": {"$ref": "./background.json#/definitions/background-variant"},
+    "theme": { "$ref": "./browser-theme.json" },
+    "userImages": {
+      "type": "array",
+      "items": {
+        "$ref": "./user-image.json"
+      }
+    },
+    "userColor": {
+      "$ref": "./user-color-data.json#/definitions/userColor"
+    }
+  }
+}

special-pages/pages/new-tab/messages/types/theme-data.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "theme"
+  ],
+  "properties": {
+    "theme": {
+      "$ref": "./browser-theme.json"
+    }
+  }
+}

special-pages/pages/new-tab/messages/types/user-color-data.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "User Color Data",
+  "type": "object",
+  "required": [
+    "userColor"
+  ],
+  "properties": {
+    "userColor": {"$ref": "#/definitions/userColor"}
+  },
+  "definitions": {
+    "userColor": {
+      "oneOf": [
+        {"type": "null"},
+        {"$ref": "./background.json#/definitions/hex"}
+      ]
+    }
+  }
+}

special-pages/pages/new-tab/messages/types/user-image-data.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "User Image Data",
+  "type": "object",
+  "required": [
+    "userImages"
+  ],
+  "properties": {
+    "userImages": {
+      "type": "array",
+      "items": {
+        "$ref": "./user-image.json"
+      }
+    }
+  }
+}

special-pages/pages/new-tab/messages/types/user-image.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "UserImage",
+  "type": "object",
+  "required": ["id", "colorScheme", "src", "thumb"],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "src": {
+      "type": "string"
+    },
+    "thumb": {
+      "type": "string"
+    },
+    "colorScheme": {
+      "$ref": "./colors.json#/definitions/colorScheme"
+    }
+  }
+}