@backlib/koa
Advanced tools
Comparing version
@@ -1,17 +0,21 @@ | ||
"use strict"; | ||
var __importDefault = (this && this.__importDefault) || function (mod) { | ||
return (mod && mod.__esModule) ? mod : { "default": mod }; | ||
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) { | ||
if (kind === "m") throw new TypeError("Private method is not writable"); | ||
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); | ||
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); | ||
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value; | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.routeHead = exports.routeDelete = exports.routeOptions = exports.routePatch = exports.routePut = exports.routePost = exports.routeGet = exports.routeUse = exports.BaseRouter = void 0; | ||
const router_1 = __importDefault(require("@koa/router")); | ||
const koa_compose_1 = __importDefault(require("koa-compose")); | ||
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) { | ||
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); | ||
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); | ||
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); | ||
}; | ||
var _BaseRouter_koaRouterWrapper, _BaseRouter_middleware; | ||
import Router from '@koa/router'; | ||
import koaCompose from 'koa-compose'; | ||
const REQUEST_METHODS = Object.freeze(['get', 'post', 'put', 'patch', 'options', 'delete', 'head']); | ||
class BaseRouter { | ||
#koaRouterWrapper; | ||
#middleware; // keep type flexible here | ||
/** Return the composed middleware of all of the route of this router */ | ||
middleware() { return this.#middleware; } | ||
export class BaseRouter { | ||
constructor(prefix) { | ||
this.#koaRouterWrapper = new KoaRouterWrapper(prefix); | ||
_BaseRouter_koaRouterWrapper.set(this, void 0); | ||
_BaseRouter_middleware.set(this, void 0); // keep type flexible here | ||
__classPrivateFieldSet(this, _BaseRouter_koaRouterWrapper, new KoaRouterWrapper(prefix), "f"); | ||
//// wrap the use item | ||
@@ -26,7 +30,9 @@ const wrappedUseMiddelwares = this.__toRegister.useItems.map(useItem => this.wrapUseMiddleware(useItem)); | ||
const wrappedRequestHandler = this.wrapRequestHandler(item.handler); | ||
this.#koaRouterWrapper.registerRoute(item.requestMethod, item.path, wrappedRequestHandler); | ||
__classPrivateFieldGet(this, _BaseRouter_koaRouterWrapper, "f").registerRoute(item.requestMethod, item.path, wrappedRequestHandler); | ||
} | ||
//// create new composed middleware (use items first, then the routes) | ||
this.#middleware = koa_compose_1.default([...wrappedUseMiddelwares, this.#koaRouterWrapper.routes()]); | ||
__classPrivateFieldSet(this, _BaseRouter_middleware, koaCompose([...wrappedUseMiddelwares, __classPrivateFieldGet(this, _BaseRouter_koaRouterWrapper, "f").routes()]), "f"); | ||
} | ||
/** Return the composed middleware of all of the route of this router */ | ||
middleware() { return __classPrivateFieldGet(this, _BaseRouter_middleware, "f"); } | ||
async assertKoaContext(ktx) { | ||
@@ -72,5 +78,5 @@ // by default does not do any check. Sub classes should do the ktx check. | ||
} | ||
exports.BaseRouter = BaseRouter; | ||
_BaseRouter_koaRouterWrapper = new WeakMap(), _BaseRouter_middleware = new WeakMap(); | ||
//#region ---------- Route Decorators ---------- | ||
function routeUse() { | ||
export function routeUse() { | ||
return function (target, propertyKey, descriptor) { | ||
@@ -80,4 +86,3 @@ addUseItem(target, descriptor.value); | ||
} | ||
exports.routeUse = routeUse; | ||
function routeGet(path) { | ||
export function routeGet(path) { | ||
return function (target, propertyKey, descriptor) { | ||
@@ -87,4 +92,3 @@ addRouteItem(target, propertyKey, descriptor, 'get', path); | ||
} | ||
exports.routeGet = routeGet; | ||
function routePost(path) { | ||
export function routePost(path) { | ||
return function (target, propertyKey, descriptor) { | ||
@@ -94,4 +98,3 @@ addRouteItem(target, propertyKey, descriptor, 'post', path); | ||
} | ||
exports.routePost = routePost; | ||
function routePut(path) { | ||
export function routePut(path) { | ||
return function (target, propertyKey, descriptor) { | ||
@@ -101,4 +104,3 @@ addRouteItem(target, propertyKey, descriptor, 'put', path); | ||
} | ||
exports.routePut = routePut; | ||
function routePatch(path) { | ||
export function routePatch(path) { | ||
return function (target, propertyKey, descriptor) { | ||
@@ -108,4 +110,3 @@ addRouteItem(target, propertyKey, descriptor, 'patch', path); | ||
} | ||
exports.routePatch = routePatch; | ||
function routeOptions(path) { | ||
export function routeOptions(path) { | ||
return function (target, propertyKey, descriptor) { | ||
@@ -115,4 +116,3 @@ addRouteItem(target, propertyKey, descriptor, 'options', path); | ||
} | ||
exports.routeOptions = routeOptions; | ||
function routeDelete(path) { | ||
export function routeDelete(path) { | ||
return function (target, propertyKey, descriptor) { | ||
@@ -122,4 +122,3 @@ addRouteItem(target, propertyKey, descriptor, 'delete', path); | ||
} | ||
exports.routeDelete = routeDelete; | ||
function routeHead(path) { | ||
export function routeHead(path) { | ||
return function (target, propertyKey, descriptor) { | ||
@@ -129,3 +128,2 @@ addRouteItem(target, propertyKey, descriptor, 'head', path); | ||
} | ||
exports.routeHead = routeHead; | ||
function addUseItem(target, handler) { | ||
@@ -147,5 +145,4 @@ const toRegister = getToRegister(target); | ||
class KoaRouterWrapper { | ||
koaRouter; | ||
constructor(prefix) { | ||
this.koaRouter = new router_1.default({ prefix }); | ||
this.koaRouter = new Router({ prefix }); | ||
} | ||
@@ -160,1 +157,2 @@ routes() { | ||
} | ||
//# sourceMappingURL=base-router.js.map |
@@ -1,13 +0,2 @@ | ||
"use strict"; | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); | ||
}) : (function(o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
o[k2] = m[k]; | ||
})); | ||
var __exportStar = (this && this.__exportStar) || function(m, exports) { | ||
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p); | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
__exportStar(require("./base-router"), exports); | ||
export * from './base-router.js'; | ||
//# sourceMappingURL=index.js.map |
{ | ||
"name": "@backlib/koa", | ||
"version": "0.3.6", | ||
"type": "module", | ||
"version": "0.4.0-SNAPSHOT.1", | ||
"description": "Minimalist KOA utilities for backend web services", | ||
@@ -20,24 +21,16 @@ "main": "dist/index.js", | ||
"dependencies": { | ||
"@koa/router": "^10.1.0", | ||
"@koa/router": "^10.1.1", | ||
"@types/koa": "^2.13.4", | ||
"@types/koa__router": "^8.0.7", | ||
"fs-extra-plus": "^0.5.22", | ||
"handlebars": "^4.7.7", | ||
"js-yaml": "^4.1.0", | ||
"koa": "^2.13.1", | ||
"koa-compose": "^4.1.0", | ||
"markdown-it": "^12.1.0" | ||
"@types/koa__router": "^8.0.11", | ||
"koa": "^2.13.4", | ||
"koa-compose": "^4.1.0" | ||
}, | ||
"peerDependencies": { | ||
"backlib": "^0.3.3" | ||
"backlib": "0.4.0-SNAPSHOT.1" | ||
}, | ||
"devDependencies": { | ||
"@types/js-yaml": "^4.0.2", | ||
"@types/markdown-it": "^12.0.3", | ||
"@types/mocha": "^9.0.0", | ||
"backlib": "^0.3.3", | ||
"mocha": "^9.0.2", | ||
"@types/mocha": "^9.1.0", | ||
"backlib": "0.4.0-SNAPSHOT.1", | ||
"rimraf": "^3.0.2", | ||
"ts-node-dev": "^1.1.8", | ||
"typescript": "^4.3.5" | ||
"typescript": "^4.5.4" | ||
}, | ||
@@ -44,0 +37,0 @@ "files": [ |
@@ -1,2 +0,2 @@ | ||
export * from './base-router'; | ||
export * from './base-router.js'; | ||
Deprecated
MaintenanceThe maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.
Found 1 instance in 1 package
21136
12.66%6
-40%4
-50%Yes
NaN291
-14.91%1
Infinity%+ Added
+ Added
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
Updated
Updated
Updated