-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #163 from znsio/inline-express-list-endpoints
Inlining express-list-endpoints dependency
- Loading branch information
Showing
5 changed files
with
145 additions
and
23 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| export = expressListEndpoints; | ||
| declare function expressListEndpoints(app: import('express').Express | import('express').Router | any): Endpoint[]; | ||
| declare namespace expressListEndpoints { | ||
| export { Route, Endpoint }; | ||
| } | ||
| type Endpoint = { | ||
| path: string; | ||
| methods: string[]; | ||
| middlewares: string[]; | ||
| }; | ||
| type Route = { | ||
| methods: Object; | ||
| path: string | string[]; | ||
| stack: any[]; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| const regExpToParseExpressPathRegExp = /^\/\^\\?\/?(?:(:?[\w\\.-]*(?:\\\/:?[\w\\.-]*)*)|(\(\?:\\?\/?\([^)]+\)\)))\\\/.*/; | ||
| const regExpToReplaceExpressPathRegExpParams = /\(\?:\\?\/?\([^)]+\)\)/; | ||
| const regexpExpressParamRegexp = /\(\?:\\?\\?\/?\([^)]+\)\)/g; | ||
| const regexpExpressPathParamRegexp = /(:[^)]+)\([^)]+\)/g; | ||
| const EXPRESS_ROOT_PATH_REGEXP_VALUE = '/^\\/?(?=\\/|$)/i'; | ||
| const STACK_ITEM_VALID_NAMES = [ | ||
| 'router', | ||
| 'bound dispatch', | ||
| 'mounted_app' | ||
| ]; | ||
| const getRouteMethods = function (route) { | ||
| let methods = Object.keys(route.methods); | ||
| methods = methods.filter((method) => method !== '_all'); | ||
| methods = methods.map((method) => method.toUpperCase()); | ||
| return methods; | ||
| }; | ||
| const getRouteMiddlewares = function (route) { | ||
| return route.stack.map((item) => { | ||
| return item.handle.name || 'anonymous'; | ||
| }); | ||
| }; | ||
| const hasParams = function (expressPathRegExp) { | ||
| return regexpExpressParamRegexp.test(expressPathRegExp); | ||
| }; | ||
| function combinePaths(base, path) { | ||
| return (base + path).replace(/\/+/g, "/").replace(/\/$/, "") || "/"; | ||
| } | ||
| const parseExpressRoute = function (route, basePath) { | ||
| const paths = []; | ||
| if (Array.isArray(route.path)) { | ||
| paths.push(...route.path); | ||
| } | ||
| else { | ||
| paths.push(route.path); | ||
| } | ||
| const endpoints = paths.map((path) => { | ||
| const completePath = combinePaths(basePath, path); | ||
| const endpoint = { | ||
| path: completePath.replace(regexpExpressPathParamRegexp, '$1'), | ||
| methods: getRouteMethods(route), | ||
| middlewares: getRouteMiddlewares(route) | ||
| }; | ||
| return endpoint; | ||
| }); | ||
| return endpoints; | ||
| }; | ||
| const parseExpressPath = function (expressPathRegExp, params) { | ||
| let parsedRegExp = expressPathRegExp.toString(); | ||
| let expressPathRegExpExec = regExpToParseExpressPathRegExp.exec(parsedRegExp); | ||
| let paramIndex = 0; | ||
| while (hasParams(parsedRegExp)) { | ||
| const paramName = params[paramIndex].name; | ||
| const paramId = `:${paramName}`; | ||
| parsedRegExp = parsedRegExp | ||
| .replace(regExpToReplaceExpressPathRegExpParams, (str) => { | ||
| if (str.startsWith('(?:\\/')) { | ||
| return `\\/${paramId}`; | ||
| } | ||
| return paramId; | ||
| }); | ||
| paramIndex++; | ||
| } | ||
| if (parsedRegExp !== expressPathRegExp.toString()) { | ||
| expressPathRegExpExec = regExpToParseExpressPathRegExp.exec(parsedRegExp); | ||
| } | ||
| const parsedPath = expressPathRegExpExec[1].replace(/\\\//g, '/'); | ||
| return parsedPath; | ||
| }; | ||
| const parseEndpoints = function (app, basePath, endpoints) { | ||
| const stack = app.stack || (app._router && app._router.stack); | ||
| endpoints = endpoints || []; | ||
| basePath = basePath || ''; | ||
| if (!stack) { | ||
| if (endpoints.length) { | ||
| endpoints = addEndpoints(endpoints, [{ | ||
| path: basePath, | ||
| methods: [], | ||
| middlewares: [] | ||
| }]); | ||
| } | ||
| } | ||
| else { | ||
| endpoints = parseStack(stack, basePath, endpoints); | ||
| } | ||
| return endpoints; | ||
| }; | ||
| const addEndpoints = function (currentEndpoints, endpointsToAdd) { | ||
| endpointsToAdd.forEach((newEndpoint) => { | ||
| const existingEndpoint = currentEndpoints.find((endpoint) => endpoint.path === newEndpoint.path); | ||
| if (existingEndpoint !== undefined) { | ||
| const newMethods = newEndpoint.methods.filter((method) => !existingEndpoint.methods.includes(method)); | ||
| existingEndpoint.methods = existingEndpoint.methods.concat(newMethods); | ||
| } | ||
| else { | ||
| currentEndpoints.push(newEndpoint); | ||
| } | ||
| }); | ||
| return currentEndpoints; | ||
| }; | ||
| const parseStack = function (stack, basePath, endpoints) { | ||
| stack.forEach((stackItem) => { | ||
| if (stackItem.route) { | ||
| const newEndpoints = parseExpressRoute(stackItem.route, basePath); | ||
| endpoints = addEndpoints(endpoints, newEndpoints); | ||
| } | ||
| else if (STACK_ITEM_VALID_NAMES.includes(stackItem.name)) { | ||
| const isExpressPathRegexp = regExpToParseExpressPathRegExp.test(stackItem.regexp); | ||
| let newBasePath = basePath; | ||
| if (isExpressPathRegexp) { | ||
| const parsedPath = parseExpressPath(stackItem.regexp, stackItem.keys); | ||
| newBasePath += `/${parsedPath}`; | ||
| } | ||
| else if (!stackItem.path && stackItem.regexp && stackItem.regexp.toString() !== EXPRESS_ROOT_PATH_REGEXP_VALUE) { | ||
| const regExpPath = ` RegExp(${stackItem.regexp}) `; | ||
| newBasePath += `/${regExpPath}`; | ||
| } | ||
| endpoints = parseEndpoints(stackItem.handle, newBasePath, endpoints); | ||
| } | ||
| }); | ||
| return endpoints; | ||
| }; | ||
| const expressListEndpoints = function (app) { | ||
| const endpoints = parseEndpoints(app); | ||
| return endpoints; | ||
| }; | ||
| module.exports = expressListEndpoints; |