webext-patterns 1.3.0 → 1.5.0

package/index.d.ts

@@ -1,6 +1,10 @@
 export declare const patternValidationRegex: RegExp;
 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 patternToRegex(...matchPatterns: readonly string[]): RegExp;
 export declare function globToRegex(...globs: readonly string[]): RegExp;
 export declare function excludeDuplicatePatterns(matchPatterns: readonly string[]): string[];

package/index.js

@@ -1,28 +1,54 @@
 import escapeStringRegexp from 'escape-string-regexp';
 // Copied from https://github.com/mozilla/gecko-dev/blob/073cc24f53d0cf31403121d768812146e597cc9d/toolkit/components/extensions/schemas/manifest.json#L487-L491
 export const patternValidationRegex = /^(https?|wss?|file|ftp|\*):\/\/(\*|\*\.[^*/]+|[^*/]+)\/.*$|^file:\/\/\/.*$|^resource:\/\/(\*|\*\.[^*/]+|[^*/]+)\/.*$|^about:/;
-const isFirefox = typeof navigator === 'object' && navigator.userAgent.includes('Firefox/');
+const isFirefox = globalThis.navigator?.userAgent.includes('Firefox/');
 export const allStarsRegex = isFirefox
     ? /^(https?|wss?):[/][/][^/]+([/].*)?$/
     : /^https?:[/][/][^/]+([/].*)?$/;
 export const allUrlsRegex = /^(https?|file|ftp):[/]+/;
-function getRawPatternRegex(matchPattern) {
-    if (!patternValidationRegex.test(matchPattern)) {
-        throw new Error(matchPattern + ' is an invalid pattern, it must match ' + String(patternValidationRegex));
+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 doesUrlMatchPatterns(url, ...patterns) {
+    if (patterns.includes('<all_urls>') && allUrlsRegex.test(url)) {
+        return true;
+    }
+    if (patterns.includes('*://*/*') && allStarsRegex.test(url)) {
+        return true;
     }
-    let [, protocol, host, pathname] = matchPattern.split(/(^[^:]+:[/][/])([^/]+)?/);
+    for (const pattern of patterns) {
+        if (patternToRegex(pattern).test(url)) {
+            return true;
+        }
+    }
+    return false;
+}
+export function findMatchingPatterns(url, ...patterns) {
+    return patterns.filter(pattern => doesUrlMatchPatterns(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
-        .replace(/[/]/g, '[/]'); // Escape slashes
-    host = (host !== null && host !== void 0 ? host : '') // Undefined for file:///
+        .replaceAll(/[/]/g, '[/]'); // Escape slashes
+    if (host === '*') {
+        host = '[^/]+';
+    }
+    host &&= host
         .replace(/^[*][.]/, '([^/]+.)*') // Initial wildcard
-        .replace(/^[*]$/, '[^/]+') // Only wildcard
-        .replace(/[.]/g, '[.]') // Escape dots
-        .replace(/[*]$/g, '[^.]+'); // Last wildcard
+        .replaceAll(/[.]/g, '[.]') // Escape dots
+        .replace(/[*]$/, '[^.]+'); // Last wildcard
     pathname = pathname
-        .replace(/[/]/g, '[/]') // Escape slashes
-        .replace(/[.]/g, '[.]') // Escape dots
-        .replace(/[*]/g, '.*'); // Any wildcard
+        .replaceAll(/[/]/g, '[/]') // Escape slashes
+        .replaceAll(/[.]/g, '[.]') // Escape dots
+        .replaceAll(/[*]/g, '.*'); // Any wildcard
     return '^' + protocol + host + '(' + pathname + ')?$';
 }
 export function patternToRegex(...matchPatterns) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "webext-patterns",
-	"version": "1.3.0",
+	"version": "1.5.0",
 	"description": "Tool to convert the patterns and globs of your WebExtension manifest to regex",
 	"keywords": [
 		"browser",
@@ -21,8 +21,8 @@
 	"license": "MIT",
 	"author": "Federico Brigante <me@fregante.com> (https://fregante.com)",
 	"type": "module",
-	"main": "index.js",
-	"module": "index.js",
+	"exports": "./index.js",
+	"types": "./index.d.ts",
 	"files": [
 		"index.js",
 		"index.d.ts"
@@ -48,13 +48,16 @@
 		"escape-string-regexp": "^5.0.0"
 	},
 	"devDependencies": {
-		"@sindresorhus/tsconfig": "^3.0.1",
-		"@types/chrome": "0.0.210",
-		"ava": "^5.1.1",
-		"sinon": "^15.0.1",
-		"type-fest": "^3.5.3",
-		"typescript": "^4.9.4",
-		"xo": "^0.53.1"
+		"@sindresorhus/tsconfig": "^5.0.0",
+		"@types/chrome": "0.0.268",
+		"ava": "^6.1.3",
+		"sinon": "^18.0.0",
+		"type-fest": "^4.20.0",
+		"typescript": "^5.4.5",
+		"xo": "^0.58.0"
+	},
+	"engines": {
+		"node": ">=18"
 	},
 	"webExt": {
 		"sourceDir": "demo-extension",

package/readme.md

@@ -3,9 +3,7 @@
 [badge-gzip]: https://img.shields.io/bundlephobia/minzip/webext-patterns.svg?label=gzipped
 [link-bundlephobia]: https://bundlephobia.com/result?p=webext-patterns
 
-> Tool to convert the [patterns](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/content_scripts#globs) of your WebExtension manifest to regex
-
-This might be incomplete. Please help me test it by adding more pattern and URLs to the [tests](./test.js).
+> Utilities for [patterns](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/content_scripts#matching_url_patterns) and globs for WebExtensions
 
 ## Install
 
@@ -18,8 +16,14 @@ npm install webext-patterns
 ```
 
 ```js
-// This module is only offered as a ES Module
-import {patternToRegex} from 'webext-patterns';
+import {
+	patternToRegex,
+	globToRegex,
+	excludeDuplicatePatterns
+	doesUrlMatchPatterns,
+	assertValidPattern,
+	isValidPattern,
+} from 'webext-patterns';
 ```
 
 ## Usage
@@ -33,6 +37,12 @@ globToRegex('*.example.com');
 
 excludeDuplicatePatterns(['https://*.google.com/*', 'https://google.com/*']);
 // Returns ['https://*.google.com/*']
+
+assertValidPattern('https://google.*/*');
+// Throws an error because the pattern is invalid
+
+isValidPattern('https://*.google.com/*');
+// Returns true
 ```
 
 > **Note**
@@ -100,21 +110,45 @@ excludeDuplicatePatterns([
 // Returns ["https://*/*"]
 ```
 
-## Related
+#### doesUrlMatchPatterns(url, ...patterns)
+
+Accepts a URL and any number of patterns and returns `true` if the URL matches any of the patterns. This is a convenience method that wraps `patternToRegex` for single use. If you plan on testing multiple URLs to the same pattern, it's better to convert the patterns to a regex once and reuse that.
+
+```js
+doesUrlMatchPatterns('https://google.com/', 'https://*.google.com/*', '*://example.com/*');
+// Returns true
+```
+
+#### findMatchingPatterns(url, ...patterns)
+
+Accepts a URL and any number of patterns and returns an array of the patterns that match the URL. It returns an empty array if none of the patterns match the URL.
 
-### Permissions
+#### assertValidPattern(pattern)
 
-- [webext-additional-permissions](https://github.com/fregante/webext-additional-permissions) - Get any optional permissions that users have granted you.
-- [webext-dynamic-content-scripts](https://github.com/fregante/webext-dynamic-content-scripts) - Automatically registers your content_scripts on domains added via permission.request
+Accepts a pattern and throws an error if it's invalid.
 
-### Others
+```js
+assertValidPattern('https://google.*/*');
+// Throws an error because the pattern is invalid
+```
+
+#### isValidPattern(pattern)
+
+Accepts a pattern and returns `true` if it's valid.
+
+```js
+isValidPattern('https://google.*/*');
+// Returns false
+```
+
+## Related
 
-- [webext-options-sync](https://github.com/fregante/webext-options-sync) - Helps you manage and autosave your extension's options. Chrome and Firefox.
-- [webext-storage-cache](https://github.com/fregante/webext-storage-cache) - Map-like promised cache storage with expiration. Chrome and Firefox
-- [webext-detect-page](https://github.com/fregante/webext-detect-page) - Detects where the current browser extension code is being run. Chrome and Firefox.
-- [webext-content-script-ping](https://github.com/fregante/webext-content-script-ping) - One-file interface to detect whether your content script have loaded.
-- [web-ext-submit](https://github.com/fregante/web-ext-submit) - Wrapper around Mozilla’s web-ext to submit extensions to AMO.
+- [webext-permissions](https://github.com/fregante/webext-permissions) - Get any optional permissions that users have granted you.
+- [webext-options-sync](https://github.com/fregante/webext-options-sync) - Helps you manage and autosave your extension's options.
+- [webext-storage-cache](https://github.com/fregante/webext-storage-cache) - Map-like promised cache storage with expiration.
+- [webext-detect-page](https://github.com/fregante/webext-detect-page) - Detects where the current browser extension code is being run.
 - [Awesome-WebExtensions](https://github.com/fregante/Awesome-WebExtensions) - A curated list of awesome resources for WebExtensions development.
+- [More…](https://github.com/fregante/webext-fun)
 
 ## License