Release build 6.0.0 [ci release]

.github/workflows/build-pr.yml

@@ -25,16 +25,48 @@ jobs:
         run: npm run build
 
       - name: Create and push release branch
+        id: create_branch
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           git config --global user.name "github-actions[bot]"
           git config --global user.email "github-actions[bot]@users.noreply.github.com"
           git checkout -b pr-releases/pr-${PR_NUMBER}
-          git add -f build
-          git commit -m "Add build folder for PR #${PR_NUMBER}"
+          git add -f build Sources
+          git commit -m "Add build folder for PR ${PR_NUMBER}"
           git push -u origin pr-releases/pr-${PR_NUMBER} --force
+          echo "BRANCH_NAME=pr-releases/pr-${PR_NUMBER}" >> $GITHUB_ENV
+          echo "COMMIT_HASH=$(git rev-parse HEAD)" >> $GITHUB_ENV
+
+      - name: Post comment on PR
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const branchName = process.env.BRANCH_NAME;
+            const commitHash = process.env.COMMIT_HASH;
+            const prNumber = context.issue.number;
+            const repoUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}`;
+            const branchUrl = `${repoUrl}/tree/${branchName}`;
+            const commitUrl = `${repoUrl}/commit/${commitHash}`;
+            const commentBody = `
+            ### Temporary Branch Update
+            
+            The temporary branch has been updated with the latest changes. Below are the details:
+            
+              - **Branch Name**: [${branchName}](${branchUrl})
+              - **Commit Hash**: [${commitHash}](${commitUrl})
+              - **Install Command**: \`npm i github:duckduckgo/content-scope-scripts#${commitHash}\`
+              
+              Please use the above install command to update to the latest version.
+            `;
+
+            await github.rest.issues.createComment({
+                ...context.repo,
+                issue_number: prNumber,
+                body: commentBody
+            });
 
   clean_up:
     if: github.event.action == 'closed'

Sources/ContentScopeScripts/dist/contentScopeIsolated.js

@@ -3307,6 +3307,7 @@
         }
     }
 
+    const MSG_NAME_INITIAL_SETUP = 'initialSetup';
     const MSG_NAME_SET_VALUES = 'setUserValues';
     const MSG_NAME_READ_VALUES = 'getUserValues';
     const MSG_NAME_READ_VALUES_SERP = 'readUserValues';
@@ -3338,6 +3339,13 @@
             this.messaging = messaging;
         }
 
+        /**
+         * @returns {Promise<import("../duck-player.js").OverlaysInitialSettings>}
+         */
+        initialSetup () {
+            return this.messaging.request(MSG_NAME_INITIAL_SETUP)
+        }
+
         /**
          * Inform the native layer that an interaction occurred
          * @param {import("../duck-player.js").UserValues} userValues
@@ -4863,20 +4871,22 @@
         // bind early to attach all listeners
         const domState = new DomState();
 
-        /** @type {import("../duck-player.js").UserValues} */
-        let userValues;
+        /** @type {import("../duck-player.js").OverlaysInitialSettings} */
+        let initialSetup;
         try {
-            userValues = await messages.getUserValues();
+            initialSetup = await messages.initialSetup();
         } catch (e) {
             console.error(e);
             return
         }
 
-        if (!userValues) {
+        if (!initialSetup) {
             console.error('cannot continue without user settings');
             return
         }
 
+        let { userValues } = initialSetup;
+
         /**
          * Create the instance - this might fail if settings or user preferences prevent it
          * @type {Thumbnails|undefined}
@@ -5050,7 +5060,7 @@
      * #### Messages:
      *
      * On Page Load
-     *   - {@link DuckPlayerOverlayMessages.getUserValues} is initially called to get the current settings
+     *   - {@link DuckPlayerOverlayMessages.initialSetup} is initially called to get the current settings
      *   - {@link DuckPlayerOverlayMessages.onUserValuesChanged} subscription begins immediately - it will continue to listen for updates
      *
      * Then the following message can be sent at any time
@@ -5078,6 +5088,11 @@
      * @property {boolean} overlayInteracted - always a boolean
      */
 
+    /**
+     * @typedef OverlaysInitialSettings - The initial payload used to communicate render-blocking information
+     * @property {UserValues} userValues
+     */
+
     /**
      * @internal
      */

build/contentScope.js

@@ -11755,6 +11755,7 @@
         }
     }
 
+    const MSG_NAME_INITIAL_SETUP = 'initialSetup';
     const MSG_NAME_SET_VALUES = 'setUserValues';
     const MSG_NAME_READ_VALUES = 'getUserValues';
     const MSG_NAME_READ_VALUES_SERP = 'readUserValues';
@@ -11786,6 +11787,13 @@
             this.messaging = messaging;
         }
 
+        /**
+         * @returns {Promise<import("../duck-player.js").OverlaysInitialSettings>}
+         */
+        initialSetup () {
+            return this.messaging.request(MSG_NAME_INITIAL_SETUP)
+        }
+
         /**
          * Inform the native layer that an interaction occurred
          * @param {import("../duck-player.js").UserValues} userValues
@@ -13242,20 +13250,22 @@
         // bind early to attach all listeners
         const domState = new DomState();
 
-        /** @type {import("../duck-player.js").UserValues} */
-        let userValues;
+        /** @type {import("../duck-player.js").OverlaysInitialSettings} */
+        let initialSetup;
         try {
-            userValues = await messages.getUserValues();
+            initialSetup = await messages.initialSetup();
         } catch (e) {
             console.error(e);
             return
         }
 
-        if (!userValues) {
+        if (!initialSetup) {
             console.error('cannot continue without user settings');
             return
         }
 
+        let { userValues } = initialSetup;
+
         /**
          * Create the instance - this might fail if settings or user preferences prevent it
          * @type {Thumbnails|undefined}
@@ -13429,7 +13439,7 @@
      * #### Messages:
      *
      * On Page Load
-     *   - {@link DuckPlayerOverlayMessages.getUserValues} is initially called to get the current settings
+     *   - {@link DuckPlayerOverlayMessages.initialSetup} is initially called to get the current settings
      *   - {@link DuckPlayerOverlayMessages.onUserValuesChanged} subscription begins immediately - it will continue to listen for updates
      *
      * Then the following message can be sent at any time
@@ -13457,6 +13467,11 @@
      * @property {boolean} overlayInteracted - always a boolean
      */
 
+    /**
+     * @typedef OverlaysInitialSettings - The initial payload used to communicate render-blocking information
+     * @property {UserValues} userValues
+     */
+
     /**
      * @internal
      */

build/integration/contentScope.js

@@ -11755,6 +11755,7 @@
         }
     }
 
+    const MSG_NAME_INITIAL_SETUP = 'initialSetup';
     const MSG_NAME_SET_VALUES = 'setUserValues';
     const MSG_NAME_READ_VALUES = 'getUserValues';
     const MSG_NAME_READ_VALUES_SERP = 'readUserValues';
@@ -11786,6 +11787,13 @@
             this.messaging = messaging;
         }
 
+        /**
+         * @returns {Promise<import("../duck-player.js").OverlaysInitialSettings>}
+         */
+        initialSetup () {
+            return this.messaging.request(MSG_NAME_INITIAL_SETUP)
+        }
+
         /**
          * Inform the native layer that an interaction occurred
          * @param {import("../duck-player.js").UserValues} userValues
@@ -13242,20 +13250,22 @@
         // bind early to attach all listeners
         const domState = new DomState();
 
-        /** @type {import("../duck-player.js").UserValues} */
-        let userValues;
+        /** @type {import("../duck-player.js").OverlaysInitialSettings} */
+        let initialSetup;
         try {
-            userValues = await messages.getUserValues();
+            initialSetup = await messages.initialSetup();
         } catch (e) {
             console.error(e);
             return
         }
 
-        if (!userValues) {
+        if (!initialSetup) {
             console.error('cannot continue without user settings');
             return
         }
 
+        let { userValues } = initialSetup;
+
         /**
          * Create the instance - this might fail if settings or user preferences prevent it
          * @type {Thumbnails|undefined}
@@ -13429,7 +13439,7 @@
      * #### Messages:
      *
      * On Page Load
-     *   - {@link DuckPlayerOverlayMessages.getUserValues} is initially called to get the current settings
+     *   - {@link DuckPlayerOverlayMessages.initialSetup} is initially called to get the current settings
      *   - {@link DuckPlayerOverlayMessages.onUserValuesChanged} subscription begins immediately - it will continue to listen for updates
      *
      * Then the following message can be sent at any time
@@ -13457,6 +13467,11 @@
      * @property {boolean} overlayInteracted - always a boolean
      */
 
+    /**
+     * @typedef OverlaysInitialSettings - The initial payload used to communicate render-blocking information
+     * @property {UserValues} userValues
+     */
+
     /**
      * @internal
      */

build/windows/contentScope.js

@@ -8550,6 +8550,7 @@
         }
     }
 
+    const MSG_NAME_INITIAL_SETUP = 'initialSetup';
     const MSG_NAME_SET_VALUES = 'setUserValues';
     const MSG_NAME_READ_VALUES = 'getUserValues';
     const MSG_NAME_READ_VALUES_SERP = 'readUserValues';
@@ -8581,6 +8582,13 @@
             this.messaging = messaging;
         }
 
+        /**
+         * @returns {Promise<import("../duck-player.js").OverlaysInitialSettings>}
+         */
+        initialSetup () {
+            return this.messaging.request(MSG_NAME_INITIAL_SETUP)
+        }
+
         /**
          * Inform the native layer that an interaction occurred
          * @param {import("../duck-player.js").UserValues} userValues
@@ -10106,20 +10114,22 @@
         // bind early to attach all listeners
         const domState = new DomState();
 
-        /** @type {import("../duck-player.js").UserValues} */
-        let userValues;
+        /** @type {import("../duck-player.js").OverlaysInitialSettings} */
+        let initialSetup;
         try {
-            userValues = await messages.getUserValues();
+            initialSetup = await messages.initialSetup();
         } catch (e) {
             console.error(e);
             return
         }
 
-        if (!userValues) {
+        if (!initialSetup) {
             console.error('cannot continue without user settings');
             return
         }
 
+        let { userValues } = initialSetup;
+
         /**
          * Create the instance - this might fail if settings or user preferences prevent it
          * @type {Thumbnails|undefined}
@@ -10293,7 +10303,7 @@
      * #### Messages:
      *
      * On Page Load
-     *   - {@link DuckPlayerOverlayMessages.getUserValues} is initially called to get the current settings
+     *   - {@link DuckPlayerOverlayMessages.initialSetup} is initially called to get the current settings
      *   - {@link DuckPlayerOverlayMessages.onUserValuesChanged} subscription begins immediately - it will continue to listen for updates
      *
      * Then the following message can be sent at any time
@@ -10321,6 +10331,11 @@
      * @property {boolean} overlayInteracted - always a boolean
      */
 
+    /**
+     * @typedef OverlaysInitialSettings - The initial payload used to communicate render-blocking information
+     * @property {UserValues} userValues
+     */
+
     /**
      * @internal
      */

integration-test/playwright/page-objects/duckplayer-overlays.js

@@ -247,7 +247,9 @@ export class DuckplayerOverlays {
     async userSettingIs (setting) {
         await this.page.addInitScript(mockResponses, {
             responses: {
-                getUserValues: userValues[setting]
+                initialSetup: {
+                    userValues: userValues[setting]
+                }
             }
         })
     }
@@ -445,6 +447,12 @@ export class DuckplayerOverlays {
                 featureName: 'duckPlayer'
             },
             responses: {
+                initialSetup: {
+                    userValues: {
+                        privatePlayerMode: { alwaysAsk: {} },
+                        overlayInteracted: false
+                    }
+                },
                 getUserValues: {
                     privatePlayerMode: { alwaysAsk: {} },
                     overlayInteracted: false

src/features/duck-player.js

@@ -12,7 +12,7 @@
  * #### Messages:
  *
  * On Page Load
- *   - {@link DuckPlayerOverlayMessages.getUserValues} is initially called to get the current settings
+ *   - {@link DuckPlayerOverlayMessages.initialSetup} is initially called to get the current settings
  *   - {@link DuckPlayerOverlayMessages.onUserValuesChanged} subscription begins immediately - it will continue to listen for updates
  *
  * Then the following message can be sent at any time
@@ -45,6 +45,11 @@ import { Environment, initOverlays } from './duckplayer/overlays.js'
  * @property {boolean} overlayInteracted - always a boolean
  */
 
+/**
+ * @typedef OverlaysInitialSettings - The initial payload used to communicate render-blocking information
+ * @property {UserValues} userValues
+ */
+
 /**
  * @internal
  */

src/features/duckplayer/constants.js

@@ -1,3 +1,4 @@
+export const MSG_NAME_INITIAL_SETUP = 'initialSetup'
 export const MSG_NAME_SET_VALUES = 'setUserValues'
 export const MSG_NAME_READ_VALUES = 'getUserValues'
 export const MSG_NAME_READ_VALUES_SERP = 'readUserValues'

src/features/duckplayer/overlay-messages.js

@@ -21,6 +21,13 @@ export class DuckPlayerOverlayMessages {
         this.messaging = messaging
     }
 
+    /**
+     * @returns {Promise<import("../duck-player.js").OverlaysInitialSettings>}
+     */
+    initialSetup () {
+        return this.messaging.request(constants.MSG_NAME_INITIAL_SETUP)
+    }
+
     /**
      * Inform the native layer that an interaction occurred
      * @param {import("../duck-player.js").UserValues} userValues