Extracted CustomErrorSettings

Author: mgurgel

special-pages/pages/duckplayer/app/features/error-detection.js

@@ -3,7 +3,7 @@ import { YOUTUBE_ERROR_EVENT, YOUTUBE_ERRORS } from '../providers/YouTubeErrorPr
 /**
  * @typedef {import("./iframe").IframeFeature} IframeFeature
  * @typedef {import('../../types/duckplayer').YouTubeError} YouTubeError
- * @typedef {import('../../types/duckplayer').DuckPlayerPageSettings['customError']} CustomErrorOptions
+ * @typedef {import('../../types/duckplayer').CustomErrorSettings} CustomErrorSettings
  */
 
 /**
@@ -15,11 +15,11 @@ export class ErrorDetection {
     /** @type {HTMLIFrameElement} */
     iframe;
 
-    /** @type {CustomErrorOptions} */
+    /** @type {CustomErrorSettings} */
     options;
 
     /**
-     * @param {CustomErrorOptions} options
+     * @param {CustomErrorSettings} options
      */
     constructor(options) {
         this.options = options;
@@ -115,7 +115,8 @@ export class ErrorDetection {
 
             // 2. Check for sign-in support link
             try {
-                if (this.options?.signInRequiredSelector && !!iframeWindow.document.querySelector(this.options.signInRequiredSelector)) {
+                const { settings } = this.options;
+                if (settings?.signInRequiredSelector && !!iframeWindow.document.querySelector(settings.signInRequiredSelector)) {
                     return YOUTUBE_ERRORS.signInRequired;
                 }
             } catch (e) {

special-pages/pages/duckplayer/app/settings.js

@@ -1,12 +1,5 @@
 const DEFAULT_SIGN_IN_REQURED_HREF = '[href*="//support.google.com/youtube/answer/3037019"]';
 
-/**
- * @typedef {object} CustomErrorSettings
- * @property {'enabled'|'disabled'} state
- * @property {object} [settings]
- * @property {string} [settings.signInRequiredSelector]
- */
-
 export class Settings {
     /**
      * @param {object} params
@@ -47,15 +40,15 @@ export class Settings {
      *   }
      * }
      *
-     * @param {import("../types/duckplayer.js").DuckPlayerPageSettings['customError']} customErrorSettings
-     * @return {CustomErrorSettings}
+     * @param {import("../types/duckplayer.js").DuckPlayerPageSettings['customError']} initialSettings
+     * @return {import("../types/duckplayer.js").CustomErrorSettings}
      */
-    parseLegacyCustomError(customErrorSettings) {
-        if (customErrorSettings?.state !== 'enabled') {
+    parseLegacyCustomError(initialSettings) {
+        if (initialSettings?.state !== 'enabled') {
             return { state: 'disabled' };
         }
 
-        const { settings, signInRequiredSelector } = customErrorSettings;
+        const { settings, signInRequiredSelector } = initialSettings;
 
         return {
             state: 'enabled',

special-pages/pages/duckplayer/messages/customErrorSettings.shared.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "CustomErrorSettings",
+  "type": "object",
+  "description": "Configures a custom error message for YouTube errors",
+  "required": ["state"],
+  "properties": {
+    "state": {
+      "type": "string",
+      "enum": ["enabled", "disabled"]
+    },
+    "settings": {
+      "type": "object",
+      "description": "Custom error settings",
+      "properties": {
+        "signInRequiredSelector": {
+          "description": "A selector that, when not empty, indicates a sign-in required error",
+          "type": "string"
+        }
+      }
+    }
+  }
+}

special-pages/pages/duckplayer/messages/initialSetup.response.json

@@ -40,28 +40,18 @@
           }
         },
         "customError": {
-          "type": "object",
-          "description": "Configures a custom error message for YouTube errors",
-          "required": ["state"],
-          "properties": {
-            "state": {
-              "type": "string",
-              "enum": ["enabled", "disabled"]
-            },
-            "settings": {
-              "type": "object",
-              "description": "Custom error settings",
+          "allOf": [
+            { "$ref": "customErrorSettings.shared.json" },
+            {
               "properties": {
                 "signInRequiredSelector": {
-                  "$ref": "#/definitions/signInRequiredSelector"
+                  "type": "string",
+                  "description": "A selector that, when not empty, indicates a sign-in required error",
+                  "$comment": "This setting is duplicated at the top level until Apple and Windows are migrated to the settings object above"
                 }
               }
-            },
-            "signInRequiredSelector": {
-              "$ref": "#/definitions/signInRequiredSelector",
-              "$comment": "This setting is duplicated at the top level until Apple and Windows are migrated to the settings object above"
             }
-          }
+          ]
         }
       }
     },
@@ -86,11 +76,5 @@
       "type": "string",
       "description": "Optional locale-specific strings"
     }
-  },
-  "definitions": {
-    "signInRequiredSelector": {
-      "description": "A selector that, when not empty, indicates a sign-in required error",
-      "type": "string"
-    }
   }
 }

special-pages/pages/duckplayer/types/duckplayer.ts

@@ -129,20 +129,22 @@ export interface DuckPlayerPageSettings {
   focusMode?: {
     state: "enabled" | "disabled";
   };
-  /**
-   * Configures a custom error message for YouTube errors
-   */
-  customError?: {
-    state: "enabled" | "disabled";
+  customError?: CustomErrorSettings & {
     /**
-     * Custom error settings
+     * A selector that, when not empty, indicates a sign-in required error
      */
-    settings?: {
-      /**
-       * A selector that, when not empty, indicates a sign-in required error
-       */
-      signInRequiredSelector?: string;
-    };
+    signInRequiredSelector?: string;
+  };
+}
+/**
+ * Configures a custom error message for YouTube errors
+ */
+export interface CustomErrorSettings {
+  state: "enabled" | "disabled";
+  /**
+   * Custom error settings
+   */
+  settings?: {
     /**
      * A selector that, when not empty, indicates a sign-in required error
      */