webext-patterns 2.0.2 → 3.0.0

package/{index.d.ts → distribution/index.d.ts}

@@ -3,8 +3,8 @@ export declare const allStarsRegex: RegExp;
 export declare const allUrlsRegex: RegExp;
 export declare function assertValidPattern(matchPattern: string): void;
 export declare function isValidPattern(matchPattern: string): boolean;
-export declare function doesUrlMatchPatterns(url: string, ...patterns: string[]): boolean;
-export declare function findMatchingPatterns(url: string, ...patterns: string[]): string[];
+export declare function testPatterns(url: string, patterns: string[]): boolean;
+export declare function getMatchingPatterns(url: string, patterns: string[]): string[];
 export declare function patternToRegex(...matchPatterns: readonly string[]): RegExp;
 export declare function globToRegex(...globs: readonly string[]): RegExp;
-export declare function excludeDuplicatePatterns(matchPatterns: readonly string[]): string[];
+export declare function removeRedundantPatterns(matchPatterns: readonly string[]): string[];

package/distribution/index.js

@@ -0,0 +1,119 @@
+// Copied from https://github.com/mozilla/gecko-dev/blob/5836a062726f715fda621338a17b51aff30d0a8c/toolkit/components/extensions/schemas/manifest.json#L729-L741
+export const patternValidationRegex = /^(https?|wss?|file|ftp|\*):\/\/(\*|\*\.[^*/]+|[^*/]+)\/.*$|^file:\/\/\/.*$|^resource:\/\/(\*|\*\.[^*/]+|[^*/]+)\/.*$|^about:/;
+const isFirefox = globalThis.navigator?.userAgent.includes('Firefox/');
+export const allStarsRegex = isFirefox
+    ? /^(https?|wss?):[/][/][^/]+([/].*)?$/
+    : /^https?:[/][/][^/]+([/].*)?$/;
+export const allUrlsRegex = /^(https?|file|ftp):[/]+/;
+export function assertValidPattern(matchPattern) {
+    if (!isValidPattern(matchPattern)) {
+        throw new Error(matchPattern + ' is an invalid pattern. See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Match_patterns for more info.');
+    }
+}
+export function isValidPattern(matchPattern) {
+    return matchPattern === '<all_urls>' || patternValidationRegex.test(matchPattern);
+}
+export function testPatterns(url, patterns) {
+    if (patterns.includes('<all_urls>') && allUrlsRegex.test(url)) {
+        return true;
+    }
+    if (patterns.includes('*://*/*') && allStarsRegex.test(url)) {
+        return true;
+    }
+    for (const pattern of patterns) {
+        if (patternToRegex(pattern).test(url)) {
+            return true;
+        }
+    }
+    return false;
+}
+export function getMatchingPatterns(url, patterns) {
+    return patterns.filter(pattern => testPatterns(url, [pattern]));
+}
+function getRawPatternRegex(matchPattern) {
+    assertValidPattern(matchPattern);
+    // Host undefined for file:///
+    let [, protocol, host = '', pathname] = matchPattern.split(/(^[^:]+:[/][/])([^/]+)?/);
+    protocol = protocol
+        .replace('*', isFirefox ? '(https?|wss?)' : 'https?') // Protocol wildcard
+        .replaceAll(/[/]/g, '[/]'); // Escape slashes
+    if (host === '*') {
+        host = '[^/]+';
+    }
+    host &&= host
+        .replace(/^[*][.]/, '([^/]+.)*') // Initial wildcard
+        .replaceAll(/[.]/g, '[.]') // Escape dots
+        .replace(/[*]$/, '[^.]+'); // Last wildcard
+    pathname = pathname
+        .replaceAll(/[/]/g, '[/]') // Escape slashes
+        .replaceAll(/[.]/g, '[.]') // Escape dots
+        .replaceAll(/[*]/g, '.*'); // Any wildcard
+    return '^' + protocol + host + '(' + pathname + ')?$';
+}
+export function patternToRegex(...matchPatterns) {
+    // No pattern, match nothing https://stackoverflow.com/q/14115522/288906
+    if (matchPatterns.length === 0) {
+        return /$./;
+    }
+    if (matchPatterns.includes('<all_urls>')) {
+        return allUrlsRegex;
+    }
+    if (matchPatterns.includes('*://*/*')) {
+        return allStarsRegex;
+    }
+    return new RegExp(matchPatterns.map(x => getRawPatternRegex(x)).join('|'));
+}
+// The parens are required by .split() to preserve the symbols
+const globSymbols = /([?*]+)/;
+function splitReplace(part, index) {
+    if (part === '') {
+        // Shortcut for speed
+        return '';
+    }
+    if (index % 2 === 0) {
+        // Raw text, escape it
+        // eslint-disable-next-line no-use-extend-native/no-use-extend-native -- TODO: Drop after https://github.com/dustinspecker/eslint-plugin-no-use-extend-native/issues/157
+        return RegExp.escape(part);
+    }
+    // Else: Symbol
+    if (part.includes('*')) { // Can be more than one and it swallows surrounding question marks
+        return '.*';
+    }
+    return [...part].map(() => isFirefox ? '.' : '.?').join('');
+}
+function getRawGlobRegex(glob) {
+    const regexString = glob
+        .split(globSymbols)
+        // eslint-disable-next-line unicorn/no-array-callback-reference -- tis ok 🤫
+        .map(splitReplace)
+        .join('');
+    // Drop "start with anything" and "end with anything" sequences because they're the default for regex
+    return ('^' + regexString + '$')
+        .replace(/^[.][*]/, '')
+        .replace(/[.][*]$/, '')
+        .replace(/^[$]$/, '.+'); // Catch `*` and `*`
+}
+export function globToRegex(...globs) {
+    // No glob, match anything; `include_globs: []` is the default
+    if (globs.length === 0) {
+        return /.*/;
+    }
+    return new RegExp(globs.map(x => getRawGlobRegex(x)).join('|'));
+}
+export function removeRedundantPatterns(matchPatterns) {
+    if (matchPatterns.includes('<all_urls>')) {
+        return ['<all_urls>'];
+    }
+    if (matchPatterns.includes('*://*/*')) {
+        return ['*://*/*'];
+    }
+    // Cover identical patterns
+    const uniquePatterns = [...new Set(matchPatterns)];
+    return uniquePatterns.filter(possibleSubset => 
+    // Keep if there are no matches
+    !uniquePatterns.some(possibleSuperset => 
+    // Don't compare to self
+    possibleSubset !== possibleSuperset
+        // Drop if it's a subset
+        && patternToRegex(possibleSuperset).test(possibleSubset)));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "webext-patterns",
-	"version": "2.0.2",
+	"version": "3.0.0",
 	"description": "Tool to convert the patterns and globs of your WebExtension manifest to regex",
 	"keywords": [
 		"browser",
@@ -21,11 +21,11 @@
 	"license": "MIT",
 	"author": "Federico Brigante <me@fregante.com> (https://fregante.com)",
 	"type": "module",
-	"exports": "./index.js",
-	"types": "./index.d.ts",
+	"exports": "./distribution/index.js",
+	"types": "./distribution/index.d.ts",
 	"files": [
-		"index.js",
-		"index.d.ts"
+		"distribution/index.js",
+		"distribution/index.d.ts"
 	],
 	"scripts": {
 		"build": "tsc",

package/index.js

@@ -1,150 +0,0 @@
-"use strict";
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-var _a;
-exports.__esModule = true;
-exports.removeRedundantPatterns = exports.globToRegex = exports.patternToRegex = exports.getMatchingPatterns = exports.testPatterns = exports.isValidPattern = exports.assertValidPattern = exports.allUrlsRegex = exports.allStarsRegex = exports.patternValidationRegex = void 0;
-// Copied from https://github.com/mozilla/gecko-dev/blob/5836a062726f715fda621338a17b51aff30d0a8c/toolkit/components/extensions/schemas/manifest.json#L729-L741
-exports.patternValidationRegex = /^(https?|wss?|file|ftp|\*):\/\/(\*|\*\.[^*/:]+|[^*/:]+)\/.*$|^file:\/\/\/.*$|^about:/;
-var isFirefox = (_a = globalThis.navigator) === null || _a === void 0 ? void 0 : _a.userAgent.includes('Firefox/');
-exports.allStarsRegex = isFirefox
-    ? /^(https?|wss?):[/][/][^/]+([/].*)?$/
-    : /^https?:[/][/][^/]+([/].*)?$/;
-exports.allUrlsRegex = /^(https?|file|ftp):[/]+/;
-function assertValidPattern(matchPattern) {
-    if (!isValidPattern(matchPattern)) {
-        throw new Error(matchPattern + ' is an invalid pattern. See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Match_patterns for more info.');
-    }
-}
-exports.assertValidPattern = assertValidPattern;
-function isValidPattern(matchPattern) {
-    return matchPattern === '<all_urls>' || exports.patternValidationRegex.test(matchPattern);
-}
-exports.isValidPattern = isValidPattern;
-function testPatterns(url, patterns) {
-    if (patterns.includes('<all_urls>') && exports.allUrlsRegex.test(url)) {
-        return true;
-    }
-    if (patterns.includes('*://*/*') && exports.allStarsRegex.test(url)) {
-        return true;
-    }
-    for (var _i = 0, patterns_1 = patterns; _i < patterns_1.length; _i++) {
-        var pattern = patterns_1[_i];
-        if (patternToRegex(pattern).test(url)) {
-            return true;
-        }
-    }
-    return false;
-}
-exports.testPatterns = testPatterns;
-function getMatchingPatterns(url, patterns) {
-    return patterns.filter(function (pattern) { return testPatterns(url, [pattern]); });
-}
-exports.getMatchingPatterns = getMatchingPatterns;
-function getRawPatternRegex(matchPattern) {
-    assertValidPattern(matchPattern);
-    // Host undefined for file:///
-    var _a = matchPattern.split(/(^[^:]+:[/][/])([^/]+)?/), protocol = _a[1], _b = _a[2], host = _b === void 0 ? '' : _b, pathname = _a[3];
-    protocol = protocol
-        .replace('*', isFirefox ? '(https?|wss?)' : 'https?') // Protocol wildcard
-        .replaceAll(/[/]/g, '[/]'); // Escape slashes
-    if (host === '*') {
-        host = '[^/]+';
-    }
-    host && (host = host
-        .replace(/^[*][.]/, '([^/]+.)*') // Initial wildcard
-        .replaceAll(/[.]/g, '[.]') // Escape dots
-        .replace(/[*]$/, '[^.]+')); // Last wildcard
-    pathname = pathname
-        .replaceAll(/[/]/g, '[/]') // Escape slashes
-        .replaceAll(/[.]/g, '[.]') // Escape dots
-        .replaceAll(/[*]/g, '.*'); // Any wildcard
-    return '^' + protocol + host + '(' + pathname + ')?$';
-}
-function patternToRegex() {
-    var matchPatterns = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        matchPatterns[_i] = arguments[_i];
-    }
-    // No pattern, match nothing https://stackoverflow.com/q/14115522/288906
-    if (matchPatterns.length === 0) {
-        return /$./;
-    }
-    if (matchPatterns.includes('<all_urls>')) {
-        return exports.allUrlsRegex;
-    }
-    if (matchPatterns.includes('*://*/*')) {
-        return exports.allStarsRegex;
-    }
-    return new RegExp(matchPatterns.map(function (x) { return getRawPatternRegex(x); }).join('|'));
-}
-exports.patternToRegex = patternToRegex;
-// The parens are required by .split() to preserve the symbols
-var globSymbols = /([?*]+)/;
-function splitReplace(part, index) {
-    if (part === '') {
-        // Shortcut for speed
-        return '';
-    }
-    if (index % 2 === 0) {
-        // Raw text, escape it
-        // eslint-disable-next-line no-use-extend-native/no-use-extend-native -- TODO: Drop after https://github.com/dustinspecker/eslint-plugin-no-use-extend-native/issues/157
-        return RegExp.escape(part);
-    }
-    // Else: Symbol
-    if (part.includes('*')) { // Can be more than one and it swallows surrounding question marks
-        return '.*';
-    }
-    return __spreadArray([], part, true).map(function () { return isFirefox ? '.' : '.?'; }).join('');
-}
-function getRawGlobRegex(glob) {
-    var regexString = glob
-        .split(globSymbols)
-        // eslint-disable-next-line unicorn/no-array-callback-reference -- tis ok 🤫
-        .map(splitReplace)
-        .join('');
-    // Drop "start with anything" and "end with anything" sequences because they're the default for regex
-    return ('^' + regexString + '$')
-        .replace(/^[.][*]/, '')
-        .replace(/[.][*]$/, '')
-        .replace(/^[$]$/, '.+'); // Catch `*` and `*`
-}
-function globToRegex() {
-    var globs = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        globs[_i] = arguments[_i];
-    }
-    // No glob, match anything; `include_globs: []` is the default
-    if (globs.length === 0) {
-        return /.*/;
-    }
-    return new RegExp(globs.map(function (x) { return getRawGlobRegex(x); }).join('|'));
-}
-exports.globToRegex = globToRegex;
-function removeRedundantPatterns(matchPatterns) {
-    if (matchPatterns.includes('<all_urls>')) {
-        return ['<all_urls>'];
-    }
-    if (matchPatterns.includes('*://*/*')) {
-        return ['*://*/*'];
-    }
-    // Cover identical patterns
-    var uniquePatterns = __spreadArray([], new Set(matchPatterns), true);
-    return uniquePatterns.filter(function (possibleSubset) {
-        // Keep if there are no matches
-        return !uniquePatterns.some(function (possibleSuperset) {
-            // Don't compare to self
-            return possibleSubset !== possibleSuperset
-                // Drop if it's a subset
-                && patternToRegex(possibleSuperset).test(possibleSubset);
-        });
-    });
-}
-exports.removeRedundantPatterns = removeRedundantPatterns;