@eggjs/path-matching 3.0.0-beta.20

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# egg-path-matching
+
+[![NPM version][npm-image]][npm-url]
+[![CI](https://github.com/eggjs/egg-path-matching/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg-path-matching/actions/workflows/nodejs.yml)
+[![Test coverage](https://img.shields.io/codecov/c/github/eggjs/egg-path-matching.svg?style=flat-square)](https://codecov.io/gh/eggjs/egg-path-matching)
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/egg-path-matching.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/egg-path-matching
+[snyk-image]: https://snyk.io/test/npm/egg-path-matching/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/egg-path-matching
+[download-image]: https://img.shields.io/npm/dm/egg-path-matching.svg?style=flat-square
+[download-url]: https://npmjs.org/package/egg-path-matching
+
+## Installation
+
+```bash
+npm install egg-path-matching
+```
+
+## Usage
+
+```ts
+import { pathMatching } from 'egg-path-matching';
+
+const options = {
+  ignore: '/api', // string will use parsed by path-to-regexp
+  // support regexp
+  ignore: /^\/api/,
+  // support function
+  ignore: ctx => ctx.path.startsWith('/api'),
+  // support Array
+  ignore: [ctx => ctx.path.startsWith('/api'), /^\/foo$/, '/bar'],
+  // support match or ignore
+  match: '/api',
+  // custom path-to-regexp module, default is `path-to-regexp@6`
+  // pathToRegexpModule: customPathToRegexp,
+};
+
+const match = pathMatching(options);
+assert.equal(match({ path: '/api' }), true);
+assert.equal(match({ path: '/api/hello' }), true);
+assert.equal(match({ path: '/api' }), true);
+```
+
+### options
+
+- `match` {String | RegExp | Function | Array} - if request path hit `options.match`, will return `true`, otherwise will return `false`.
+- `ignore` {String | RegExp | Function | Array} - if request path hit `options.ignore`, will return `false`, otherwise will return `true`.
+- `pathToRegexpModule` {Object | Function} - custom path-to-regexp module. Default is `path-to-regexp@6`. Supports both `path-to-regexp@6` and `path-to-regexp@8+` formats.
+
+`ignore` and `match` can not both be presented.
+and if neither `ignore` nor `match` presented, the new function will always return `true`.
+
+### License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg-path-matching)](https://github.com/eggjs/egg-path-matching/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+//#region src/index.d.ts
+type PathMatchingFun = (ctx: any) => boolean;
+type PathMatchingPattern = string | RegExp | PathMatchingFun | (string | RegExp | PathMatchingFun)[];
+interface PathMatchingOptions {
+  ignore?: PathMatchingPattern;
+  match?: PathMatchingPattern;
+  pathToRegexpModule?: any;
+}
+declare function pathMatching(options: PathMatchingOptions): PathMatchingFun;
+//#endregion
+export { PathMatchingFun, PathMatchingOptions, PathMatchingPattern, pathMatching };

package/dist/index.js

@@ -0,0 +1,36 @@
+import { pathToRegexp } from "path-to-regexp";
+
+//#region src/index.ts
+function pathMatching(options) {
+	options = options || {};
+	if (options.match && options.ignore) throw new Error("options.match and options.ignore can not both present");
+	if (!options.match && !options.ignore) return () => true;
+	const pathToRegexpModule = options.pathToRegexpModule || { pathToRegexp };
+	const pathToRegexpFn = pathToRegexpModule.pathToRegexp || pathToRegexpModule;
+	const matchFn = options.match ? toPathMatch(options.match, pathToRegexpFn) : toPathMatch(options.ignore, pathToRegexpFn);
+	return function pathMatch(ctx) {
+		const matched = matchFn(ctx);
+		return options.match ? matched : !matched;
+	};
+}
+function toPathMatch(pattern, pathToRegexpFn) {
+	if (typeof pattern === "string") {
+		let reg = pathToRegexpFn(pattern, [], { end: false });
+		if (reg.regexp) reg = reg.regexp;
+		if (reg.global) reg.lastIndex = 0;
+		return (ctx) => reg.test(ctx.path);
+	}
+	if (pattern instanceof RegExp) return (ctx) => {
+		if (pattern.global) pattern.lastIndex = 0;
+		return pattern.test(ctx.path);
+	};
+	if (typeof pattern === "function") return pattern;
+	if (Array.isArray(pattern)) {
+		const matchFns = pattern.map((item) => toPathMatch(item, pathToRegexpFn));
+		return (ctx) => matchFns.some((matchFn) => matchFn(ctx));
+	}
+	throw new Error(`match/ignore pattern must be RegExp, Array or String, but got ${pattern}`);
+}
+
+//#endregion
+export { pathMatching };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@eggjs/path-matching",
+  "version": "3.0.0-beta.20",
+  "description": "match or ignore url path",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "url",
+    "match",
+    "ignore"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/eggjs/egg/tree/next/packages/path-matching",
+  "bugs": {
+    "url": "https://github.com/eggjs/egg/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eggjs/egg.git",
+    "directory": "packages/path-matching"
+  },
+  "author": {
+    "name": "dead-horse",
+    "email": "dead_horse@qq.com",
+    "url": "http://deadhorse.me"
+  },
+  "engines": {
+    "node": ">= 22.18.0"
+  },
+  "dependencies": {
+    "path-to-regexp": "^6.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.6.2",
+    "oxlint": "^1.19.0",
+    "path-to-regexp-v8": "npm:path-to-regexp@^8.3.0",
+    "rimraf": "^6.0.1",
+    "tsdown": "^0.15.4",
+    "typescript": "^5.9.3",
+    "vitest": "4.0.0-beta.17",
+    "@eggjs/tsconfig": "3.1.0-beta.27"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsdown",
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint --type-aware",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "npm run lint:fix && vitest"
+  }
+}