[in progress] scriptlets as an npm module

.gitignore

@@ -16,3 +16,6 @@ test-results
 .netlify
 # VS Code user config
 .vscode
+
+# Auto-generated scriptlets file (built from @adguard/scriptlets)
+injected/src/features/scriptlets-minimal.js

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "injected/src/features/Scriptlets"]
-	path = injected/src/features/Scriptlets
-	url = https://github.com/AdguardTeam/Scriptlets.git

.prettierignore

@@ -3,7 +3,6 @@ docs/**/*
 injected/src/types
 special-pages/pages/**/types
 injected/integration-test/extension/contentScope.js
-injected/src/features/Scriptlets
 **/*.json
 **/*.md
 **/*.html

.stylelintrc.json

@@ -1,7 +1,7 @@
 {
     "extends": ["stylelint-config-standard"],
     "plugins": ["stylelint-csstree-validator"],
-    "ignoreFiles": ["build/**/*.css", "Sources/**/*.css", "docs/**/*.css", "special-pages/pages/**/*/dist/*.css", "injected/src/features/Scriptlets/**/*"],
+    "ignoreFiles": ["build/**/*.css", "Sources/**/*.css", "docs/**/*.css", "special-pages/pages/**/*/dist/*.css"],
     "rules": {
         "csstree/validator": {
             "ignoreProperties": ["text-wrap", "view-transition-name"]

build-output.eslint.config.js

@@ -2,9 +2,6 @@
 // https://github.com/eslint/eslint/discussions/18806#discussioncomment-10848750
 
 export default [
-    {
-        ignores: ['injected/src/features/Scriptlets', 'injected/src/features/scriptlets.js'],
-    },
     {
         languageOptions: {
             ecmaVersion: 'latest',

eslint.config.js

@@ -23,8 +23,7 @@ export default tseslint.config(
             'playwright-report',
             'test-results',
             'injected/src/types',
-            'injected/src/features/Scriptlets',
-            'injected/src/features/scriptlets.js',
+            'injected/src/features/scriptlets-minimal.js',
             '.idea',
         ],
     },

injected/entry-points/integration.js

@@ -48,6 +48,7 @@ function generateConfig() {
                 'apiManipulation',
                 'duckPlayer',
                 'duckPlayerNative',
+                'scriptlets',
             ],
         },
     };

injected/integration-test/pages.spec.js

@@ -97,4 +97,122 @@ test.describe('Test integration pages', () => {
             `./integration-test/test-pages/webcompat/config/modify-cookies.json`,
         );
     });
+
+    // Scriptlet integration page tests
+    test('Set Cookie Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/set-cookie.html',
+            './integration-test/test-pages/scriptlets/config/set-cookie.json',
+        );
+    });
+
+    test('Set Local Storage Item Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/set-local-storage-item.html',
+            './integration-test/test-pages/scriptlets/config/set-local-storage-item.json',
+        );
+    });
+
+    test('Set Constant Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/set-constant.html',
+            './integration-test/test-pages/scriptlets/config/set-constant.json',
+        );
+    });
+
+    test('Trusted Set Cookie Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/trusted-set-cookie.html',
+            './integration-test/test-pages/scriptlets/config/trusted-set-cookie.json',
+        );
+    });
+
+    test('Remove Cookie Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/remove-cookie.html',
+            './integration-test/test-pages/scriptlets/config/remove-cookie.json',
+        );
+    });
+
+    test('Abort on Property Read Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/abort-on-property-read.html',
+            './integration-test/test-pages/scriptlets/config/abort-on-property-read.json',
+        );
+    });
+
+    test('Abort on Property Write Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/abort-on-property-write.html',
+            './integration-test/test-pages/scriptlets/config/abort-on-property-write.json',
+        );
+    });
+
+    test('Prevent Add Event Listener Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/prevent-addEventListener.html',
+            './integration-test/test-pages/scriptlets/config/prevent-addEventListener.json',
+        );
+    });
+
+    test('Prevent Set Timeout Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/prevent-setTimeout.html',
+            './integration-test/test-pages/scriptlets/config/prevent-setTimeout.json',
+        );
+    });
+
+    test('Prevent Window Open Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/prevent-window-open.html',
+            './integration-test/test-pages/scriptlets/config/prevent-window-open.json',
+        );
+    });
+
+    test('Prevent Fetch Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/prevent-fetch.html',
+            './integration-test/test-pages/scriptlets/config/prevent-fetch.json',
+        );
+    });
+
+    test('Remove Node Text Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/remove-node-text.html',
+            './integration-test/test-pages/scriptlets/config/remove-node-text.json',
+        );
+    });
+
+    test('Abort Current Inline Script Scriptlet', async ({ page }, testInfo) => {
+        await testPage(
+            page,
+            testInfo,
+            'scriptlets/pages/abort-current-inline-script.html',
+            './integration-test/test-pages/scriptlets/config/abort-current-inline-script.json',
+        );
+    });
 });

injected/integration-test/test-pages/scriptlets/config/abort-current-inline-script.json

@@ -0,0 +1,39 @@
+{
+  "readme": "This config tests the abortCurrentInlineScript scriptlet",
+  "version": 1,
+  "unprotectedTemporary": [],
+  "features": {
+    "scriptlets": {
+      "exceptions": [],
+      "state": "enabled",
+      "settings": {
+        "scriptlets": [],
+        "conditionalChanges": [
+          {
+            "condition": [
+              {
+                "domain": "localhost"
+              },
+              {
+                "domain": "privacy-test-pages.site"
+              }
+            ],
+            "patchSettings": [
+              {
+                "op": "add",
+                "path": "/scriptlets/-",
+                "value": {
+                  "name": "abortCurrentInlineScript",
+                  "attrs": {
+                    "property": "document.createElement",
+                    "search": "badScript"
+                  }
+                }
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+} 

injected/integration-test/test-pages/scriptlets/config/abort-on-property-read.json

@@ -0,0 +1,38 @@
+{
+  "readme": "This config tests the abortOnPropertyRead scriptlet",
+  "version": 1,
+  "unprotectedTemporary": [],
+  "features": {
+    "scriptlets": {
+      "exceptions": [],
+      "state": "enabled",
+      "settings": {
+        "scriptlets": [],
+        "conditionalChanges": [
+          {
+            "condition": [
+              {
+                "domain": "localhost"
+              },
+              {
+                "domain": "privacy-test-pages.site"
+              }
+            ],
+            "patchSettings": [
+              {
+                "op": "add",
+                "path": "/scriptlets/-",
+                "value": {
+                  "name": "abortOnPropertyRead",
+                  "attrs": {
+                    "property": "testBadProperty"
+                  }
+                }
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+} 

injected/integration-test/test-pages/scriptlets/config/abort-on-property-write.json

@@ -0,0 +1,38 @@
+{
+  "readme": "This config tests the abortOnPropertyWrite scriptlet",
+  "version": 1,
+  "unprotectedTemporary": [],
+  "features": {
+    "scriptlets": {
+      "exceptions": [],
+      "state": "enabled",
+      "settings": {
+        "scriptlets": [],
+        "conditionalChanges": [
+          {
+            "condition": [
+              {
+                "domain": "localhost"
+              },
+              {
+                "domain": "privacy-test-pages.site"
+              }
+            ],
+            "patchSettings": [
+              {
+                "op": "add",
+                "path": "/scriptlets/-",
+                "value": {
+                  "name": "abortOnPropertyWrite",
+                  "attrs": {
+                    "property": "testWriteProperty"
+                  }
+                }
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+} 

injected/integration-test/test-pages/scriptlets/config/prevent-addEventListener.json

@@ -0,0 +1,39 @@
+{
+  "readme": "This config tests the preventAddEventListener scriptlet",
+  "version": 1,
+  "unprotectedTemporary": [],
+  "features": {
+    "scriptlets": {
+      "exceptions": [],
+      "state": "enabled",
+      "settings": {
+        "scriptlets": [],
+        "conditionalChanges": [
+          {
+            "condition": [
+              {
+                "domain": "localhost"
+              },
+              {
+                "domain": "privacy-test-pages.site"
+              }
+            ],
+            "patchSettings": [
+              {
+                "op": "add",
+                "path": "/scriptlets/-",
+                "value": {
+                  "name": "preventAddEventListener",
+                  "attrs": {
+                    "typeSearch": "click",
+                    "listenerSearch": "badListener"
+                  }
+                }
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+} 

injected/integration-test/test-pages/scriptlets/config/prevent-fetch.json

@@ -0,0 +1,38 @@
+{
+  "readme": "This config tests the preventFetch scriptlet",
+  "version": 1,
+  "unprotectedTemporary": [],
+  "features": {
+    "scriptlets": {
+      "exceptions": [],
+      "state": "enabled",
+      "settings": {
+        "scriptlets": [],
+        "conditionalChanges": [
+          {
+            "condition": [
+              {
+                "domain": "localhost"
+              },
+              {
+                "domain": "privacy-test-pages.site"
+              }
+            ],
+            "patchSettings": [
+              {
+                "op": "add",
+                "path": "/scriptlets/-",
+                "value": {
+                  "name": "preventFetch",
+                  "attrs": {
+                    "propsToMatch": "url:/blocked-url"
+                  }
+                }
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+}