@makeflow/gateway - npm Package Compare versions

Comparing version 0.1.11 to 0.1.12

bld/library/gateway.js

@@ -5,6 +5,6 @@ "use strict";
 const tslib_1 = require("tslib");
-const assert_1 = tslib_1.__importDefault(require("assert"));
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
 const events_1 = require("events");
-const koa_1 = tslib_1.__importDefault(require("koa"));
-const koa_session_1 = tslib_1.__importDefault(require("koa-session"));
+const koa_1 = (0, tslib_1.__importDefault)(require("koa"));
+const koa_session_1 = (0, tslib_1.__importDefault)(require("koa-session"));
 const target_1 = require("./target");
@@ -17,38 +17,69 @@ const GATEWAY_OPTIONS_DEFAULT = {
         super();
-        this.options = options;
-        this.koa = new koa_1.default();
-        this.targets = [];
-        this.log = (level, event, data) => {
-            this.emit('log', {
-                level,
-                event,
-                ...data,
-            });
-        };
-        this.middleware = async (context, next) => {
-            let target;
-            let base;
-            for (let candidateTarget of this.targets) {
-                let candidateBase = candidateTarget.match(context);
-                if (typeof candidateBase === 'string') {
-                    assert_1.default(context.url.startsWith(candidateBase));
-                    target = candidateTarget;
-                    base = candidateBase;
-                    break;
-                }
+        Object.defineProperty(this, "options", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: options
+        });
+        Object.defineProperty(this, "koa", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new koa_1.default()
+        });
+        Object.defineProperty(this, "sessionEnabled", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "targets", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        Object.defineProperty(this, "log", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (level, event, data) => {
+                this.emit('log', {
+                    level,
+                    event,
+                    ...data,
+                });
             }
-            if (!target) {
-                context.body = 'No gateway target matched';
-                return;
-            }
-            if (this.sessionEnabled && target.sessionEnabled) {
-                let session = context.session;
-                if (!session._sessCtx.prevHash) {
-                    // If session has never been set.
-                    session.save();
+        });
+        Object.defineProperty(this, "middleware", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: async (context, next) => {
+                let target;
+                let base;
+                for (let candidateTarget of this.targets) {
+                    let candidateBase = candidateTarget.match(context);
+                    if (typeof candidateBase === 'string') {
+                        (0, assert_1.default)(context.url.startsWith(candidateBase));
+                        target = candidateTarget;
+                        base = candidateBase;
+                        break;
+                    }
                 }
-                await context.session.manuallyCommit();
+                if (!target) {
+                    context.body = 'No gateway target matched';
+                    return;
+                }
+                if (this.sessionEnabled && target.sessionEnabled) {
+                    let session = context.session;
+                    if (!session._sessCtx.prevHash) {
+                        // If session has never been set.
+                        session.save();
+                    }
+                    await context.session.manuallyCommit();
+                }
+                await target.handle(context, next, base);
             }
-            await target.handle(context, next, base);
-        };
+        });
         let { keys, session: sessionOptions = GATEWAY_OPTIONS_DEFAULT.session, targets: targetDescriptors, } = options;
@@ -61,3 +92,3 @@ let koa = this.koa;
             this.sessionEnabled = true;
-            koa.use(koa_session_1.default({
+            koa.use((0, koa_session_1.default)({
                 ...(sessionOptions === true ? undefined : sessionOptions),
@@ -64,0 +95,0 @@ // By calling `save()` it marked session force save on commit. However,

bld/library/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./gateway"), exports);
-tslib_1.__exportStar(require("./target"), exports);
-tslib_1.__exportStar(require("./log"), exports);
+(0, tslib_1.__exportStar)(require("./gateway"), exports);
+(0, tslib_1.__exportStar)(require("./target"), exports);
+(0, tslib_1.__exportStar)(require("./log"), exports);
 //# sourceMappingURL=index.js.map

bld/library/target/file-target.d.ts

 import { Context, Next } from 'koa';
-import Compress from 'koa-compress';
+import { CompressOptions } from 'koa-compress';
 import { SendOptions } from 'koa-send';
@@ -9,3 +9,3 @@ import { LogFunction } from '../log';
     target: string;
-    compress?: Compress.CompressOptions | boolean;
+    compress?: CompressOptions | boolean;
     send?: SendOptions;
@@ -12,0 +12,0 @@ }

bld/library/target/file-target.js

@@ -5,6 +5,6 @@ "use strict";
 const tslib_1 = require("tslib");
-const assert_1 = tslib_1.__importDefault(require("assert"));
-const koa_compose_1 = tslib_1.__importDefault(require("koa-compose"));
-const koa_compress_1 = tslib_1.__importDefault(require("koa-compress"));
-const koa_send_1 = tslib_1.__importDefault(require("koa-send"));
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
+const koa_compose_1 = (0, tslib_1.__importDefault)(require("koa-compose"));
+const koa_compress_1 = (0, tslib_1.__importDefault)(require("koa-compress"));
+const koa_send_1 = (0, tslib_1.__importDefault)(require("koa-send"));
 const target_1 = require("./target");
@@ -20,6 +20,12 @@ const FILE_TARGET_DESCRIPTOR_DEFAULT = {
         super(descriptor, log);
+        Object.defineProperty(this, "middleware", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         let { target, compress: compressOptions = FILE_TARGET_DESCRIPTOR_DEFAULT.compress, send: sendOptions, } = descriptor;
         let middlewareArray = [];
         if (compressOptions) {
-            middlewareArray.push(koa_compress_1.default(compressOptions === true
+            middlewareArray.push((0, koa_compress_1.default)(compressOptions === true
                 ? FILE_TARGET_DESCRIPTOR_DEFAULT.compress
@@ -29,5 +35,5 @@ : compressOptions));
         middlewareArray.push(async (context) => {
-            return koa_send_1.default(context, target, sendOptions);
+            return (0, koa_send_1.default)(context, target, sendOptions);
         });
-        this.middleware = koa_compose_1.default(middlewareArray);
+        this.middleware = (0, koa_compose_1.default)(middlewareArray);
     }
@@ -42,4 +48,4 @@ async handle(context, next) {
     if (prefix) {
-        assert_1.default(prefix.startsWith('/'));
-        assert_1.default(!prefix.endsWith('/'));
+        (0, assert_1.default)(prefix.startsWith('/'));
+        (0, assert_1.default)(!prefix.endsWith('/'));
     }
@@ -46,0 +52,0 @@ return new RegExp(`^${prefix}(?=(?:/[^.]*)?(?:\\?|$))`);

bld/library/target/index.js

@@ -13,6 +13,6 @@ "use strict";
 };
-tslib_1.__exportStar(require("./target"), exports);
-tslib_1.__exportStar(require("./proxy-target"), exports);
-tslib_1.__exportStar(require("./static-target"), exports);
-tslib_1.__exportStar(require("./file-target"), exports);
+(0, tslib_1.__exportStar)(require("./target"), exports);
+(0, tslib_1.__exportStar)(require("./proxy-target"), exports);
+(0, tslib_1.__exportStar)(require("./static-target"), exports);
+(0, tslib_1.__exportStar)(require("./file-target"), exports);
 //# sourceMappingURL=index.js.map

bld/library/target/proxy-target.js

@@ -7,9 +7,20 @@ "use strict";
 const target_1 = require("./target");
-const setHeader = http_1.OutgoingMessage.prototype.setHeader;
+const setHeader = http_1.ServerResponse.prototype.setHeader;
 class ProxyTarget extends target_1.AbstractGatewayTarget {
     constructor(descriptor, log) {
         super(descriptor, log);
-        this.websocketUpgradeInitialized = false;
+        Object.defineProperty(this, "proxy", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "websocketUpgradeInitialized", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
         let { options } = descriptor;
-        this.proxy = http_proxy_1.createProxyServer({ ...options, ignorePath: true });
+        this.proxy = (0, http_proxy_1.createProxyServer)({ ...options, ignorePath: true });
         this.proxy.on('error', error => this.log('error', 'proxy-server-error', { error }));
@@ -16,0 +27,0 @@ }

bld/library/target/static-target.js

@@ -5,6 +5,6 @@ "use strict";
 const tslib_1 = require("tslib");
-const koa_1 = tslib_1.__importDefault(require("koa"));
-const koa_compress_1 = tslib_1.__importDefault(require("koa-compress"));
-const koa_mount_1 = tslib_1.__importDefault(require("koa-mount"));
-const koa_static_1 = tslib_1.__importDefault(require("koa-static"));
+const koa_1 = (0, tslib_1.__importDefault)(require("koa"));
+const koa_compress_1 = (0, tslib_1.__importDefault)(require("koa-compress"));
+const koa_mount_1 = (0, tslib_1.__importDefault)(require("koa-mount"));
+const koa_static_1 = (0, tslib_1.__importDefault)(require("koa-static"));
 const target_1 = require("./target");
@@ -21,15 +21,25 @@ const STATIC_TARGET_DESCRIPTOR_DEFAULT = {
         super(descriptor, log);
-        this.koa = new koa_1.default();
-        this.baseToMountMap = new Map();
+        Object.defineProperty(this, "koa", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new koa_1.default()
+        });
+        Object.defineProperty(this, "baseToMountMap", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new Map()
+        });
         let { target, compress: compressOptions = STATIC_TARGET_DESCRIPTOR_DEFAULT.compress, static: staticOptions, } = descriptor;
         let koa = this.koa;
         if (compressOptions) {
-            koa.use(koa_compress_1.default(compressOptions === true
+            koa.use((0, koa_compress_1.default)(compressOptions === true
                 ? STATIC_TARGET_DESCRIPTOR_DEFAULT.compress
                 : compressOptions));
         }
-        koa.use(koa_static_1.default(target, staticOptions));
+        koa.use((0, koa_static_1.default)(target, staticOptions));
     }
     get sessionEnabled() {
-        let { session: sessionEnabled = STATIC_TARGET_DESCRIPTOR_DEFAULT.session, } = this.descriptor;
+        let { session: sessionEnabled = STATIC_TARGET_DESCRIPTOR_DEFAULT.session } = this.descriptor;
         return sessionEnabled;
@@ -44,3 +54,3 @@ }
         if (!middleware) {
-            middleware = koa_mount_1.default(base, this.koa);
+            middleware = (0, koa_mount_1.default)(base, this.koa);
             baseToMountMap.set(base, middleware);
@@ -47,0 +57,0 @@ }

bld/library/target/target.js

@@ -10,7 +10,17 @@ "use strict";
     constructor(descriptor, log) {
-        this.descriptor = descriptor;
-        this.log = log;
+        Object.defineProperty(this, "descriptor", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: descriptor
+        });
+        Object.defineProperty(this, "log", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: log
+        });
     }
     get sessionEnabled() {
-        let { session: sessionEnabled = GATEWAY_TARGET_DESCRIPTOR_DEFAULT.session, } = this.descriptor;
+        let { session: sessionEnabled = GATEWAY_TARGET_DESCRIPTOR_DEFAULT.session } = this.descriptor;
         return sessionEnabled;
@@ -17,0 +27,0 @@ }

package.json

 {
   "name": "@makeflow/gateway",
-  "version": "0.1.11",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/makeflow/gateway.git"
-  },
+  "version": "0.1.12",
+  "license": "MIT",
+  "author": "Chengdu Mufan Technology Co., Ltd.",
+  "repository": "https://github.com/makeflow/gateway.git",
   "publishConfig": {
     "access": "public"
   },
-  "license": "MIT",
-  "author": {
-    "name": "Chengdu Mufan Technology Co., Ltd.",
-    "email": "[e-mail]",
-    "url": "https://www.mufan.com"
-  },
+  "main": "bld/library/index.js",
+  "types": "bld/library/index.d.ts",
   "files": [
@@ -24,44 +19,41 @@ "src/**/*.ts",
   ],
-  "main": "bld/library/index.js",
-  "types": "bld/library/index.d.ts",
   "scripts": {
-    "build": "rimraf bld && tsc --build tsconfig.json",
-    "lint": "run-in-every eslint-project --echo --parallel -- eslint --config {configFileName} .",
-    "lint-prettier": "prettier --list-different '**/*.{ts,tsx,js,jsx,json,md}'",
+    "build": "rimraf ./bld && tsc --build",
+    "lint": "eslint .",
+    "lint-prettier": "prettier --check .",
     "test": "yarn lint-prettier && yarn build && yarn lint && jest"
   },
   "dependencies": {
+    "@types/http-proxy": "^1.17.7",
+    "@types/koa": "^2.13.4",
+    "@types/koa-compose": "^3.2.5",
+    "@types/koa-compress": "^4.0.3",
+    "@types/koa-mount": "^4.0.1",
+    "@types/koa-send": "^4.1.3",
+    "@types/koa-session": "^5.10.4",
+    "@types/koa-static": "^4.0.2",
     "http-proxy": "^1.18.1",
-    "koa": "^2.13.0",
+    "koa": "^2.13.3",
     "koa-compose": "^4.1.0",
-    "koa-compress": "^5.0.1",
+    "koa-compress": "^5.1.0",
     "koa-mount": "^4.0.0",
     "koa-send": "^5.0.1",
-    "koa-session": "^6.0.0",
+    "koa-session": "^6.2.0",
     "koa-static": "^5.0.0",
-    "tslang": "^0.1.22",
-    "tslib": "^2.0.0"
+    "tslang": "^0.1.23",
+    "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@magicspace/configs": "^0.2.5",
-    "@magicspace/eslint-plugin": "^0.1.31",
-    "@types/http-proxy": "^1.17.4",
-    "@types/jest": "^26.0.4",
-    "@types/koa": "^2.11.3",
-    "@types/koa-compose": "^3.2.5",
-    "@types/koa-compress": "^4.0.0",
-    "@types/koa-mount": "^4.0.0",
-    "@types/koa-send": "^4.1.2",
-    "@types/koa-session": "^5.10.2",
-    "@types/koa-static": "^4.0.1",
-    "@types/node": "^14.0.22",
-    "@types/node-fetch": "^2.5.7",
-    "eslint": "^7.4.0",
-    "jest": "^26.1.0",
-    "node-fetch": "^2.6.0",
-    "prettier": "^2.0.5",
+    "@mufan/code": "^0.2.9",
+    "@mufan/eslint-plugin": "^0.1.41",
+    "@types/jest": "^27.0.2",
+    "@types/node": "^16.10.1",
+    "@types/node-fetch": "2",
+    "eslint": "^7.32.0",
+    "jest": "^27.2.2",
+    "node-fetch": "2",
+    "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
-    "run-in-every": "^0.1.3",
-    "typescript": "3.9.6"
+    "typescript": "^4.4.3"
   }
 }

README.md

@@ -97,1 +97,5 @@ # Makeflow Gateway
 ```
+
+## License
+
+MIT License.

src/library/target/file-target.ts

@@ -5,3 +5,3 @@ import assert from 'assert';
 import compose from 'koa-compose';
-import Compress from 'koa-compress';
+import compress, {CompressOptions} from 'koa-compress';
 import send, {SendOptions} from 'koa-send';
@@ -23,3 +23,3 @@
   target: string;
-  compress?: Compress.CompressOptions | boolean;
+  compress?: CompressOptions | boolean;
   send?: SendOptions;
@@ -44,3 +44,3 @@ }
       middlewareArray.push(
-        Compress(
+        compress(
           compressOptions === true
@@ -47,0 +47,0 @@ ? FILE_TARGET_DESCRIPTOR_DEFAULT.compress

src/library/target/index.ts

@@ -13,5 +13,5 @@ import {Dict} from 'tslang';
 
-export const GATEWAY_TARGET_CONSTRUCTOR_DICT: Dict<GatewayTargetConstructor<
-  IGatewayTargetDescriptor
->> = {
+export const GATEWAY_TARGET_CONSTRUCTOR_DICT: Dict<
+  GatewayTargetConstructor<IGatewayTargetDescriptor>
+> = {
   proxy: ProxyTarget,
@@ -18,0 +18,0 @@ static: StaticTarget,

src/library/target/proxy-target.ts

@@ -1,2 +0,2 @@
-import {IncomingMessage, OutgoingMessage, Server as HTTPServer} from 'http';
+import {IncomingMessage, Server as HTTPServer, ServerResponse} from 'http';
 
@@ -10,3 +10,3 @@ import Server, {ServerOptions, createProxyServer} from 'http-proxy';
 
-const setHeader = OutgoingMessage.prototype.setHeader;
+const setHeader = ServerResponse.prototype.setHeader;
 
@@ -135,6 +135,6 @@ export interface ProxyTargetDescriptor extends IGatewayTargetDescriptor {
 function setHeaderOverride(
-  this: OutgoingMessage,
+  this: ServerResponse,
   name: string,
   value: string | number | string[],
-): void {
+): ServerResponse {
   if (name.toLowerCase() === 'set-cookie') {
@@ -141,0 +141,0 @@ let originalValue = this.getHeader('set-cookie');

src/library/target/static-target.ts

@@ -25,5 +25,3 @@ import Koa, {Context, Middleware, Next} from 'koa';
 
-export class StaticTarget extends AbstractGatewayTarget<
-  StaticTargetDescriptor
-> {
+export class StaticTarget extends AbstractGatewayTarget<StaticTargetDescriptor> {
   private koa = new Koa();
@@ -58,5 +56,4 @@
   get sessionEnabled(): boolean {
-    let {
-      session: sessionEnabled = STATIC_TARGET_DESCRIPTOR_DEFAULT.session,
-    } = this.descriptor;
+    let {session: sessionEnabled = STATIC_TARGET_DESCRIPTOR_DEFAULT.session} =
+      this.descriptor;
 
@@ -63,0 +60,0 @@ return sessionEnabled;

src/library/target/target.ts

@@ -45,5 +45,4 @@ import {IncomingHttpHeaders} from 'http';
   get sessionEnabled(): boolean {
-    let {
-      session: sessionEnabled = GATEWAY_TARGET_DESCRIPTOR_DEFAULT.session,
-    } = this.descriptor;
+    let {session: sessionEnabled = GATEWAY_TARGET_DESCRIPTOR_DEFAULT.session} =
+      this.descriptor;
 
@@ -97,11 +96,11 @@ return sessionEnabled;
 
-export type IGatewayTarget<
-  TDescriptor extends IGatewayTargetDescriptor
-> = GatewayTarget<TDescriptor>;
+export type IGatewayTarget<TDescriptor extends IGatewayTargetDescriptor> =
+  GatewayTarget<TDescriptor>;
 
 export type GatewayTargetConstructor<
-  TDescriptor extends IGatewayTargetDescriptor
-> = new (descriptor: TDescriptor, log: LogFunction) => IGatewayTarget<
-  TDescriptor
->;
+  TDescriptor extends IGatewayTargetDescriptor,
+> = new (
+  descriptor: TDescriptor,
+  log: LogFunction,
+) => IGatewayTarget<TDescriptor>;
 
@@ -108,0 +107,0 @@ function matchPath(

src/test/general.test.ts

@@ -33,4 +33,4 @@ import * as Path from 'path';
     session: {
-      prevHash: !!context.session._sessCtx.prevHash,
-      populated: context.session.populated,
+      prevHash: !!context.session!._sessCtx.prevHash,
+      populated: context.session!.populated,
     },
@@ -37,0 +37,0 @@ url: context.url,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

11

decreased by-45%

Number of lines in readme file

101

increased by4.12%

Number of medium supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Total package byte prevSize

80776

decreased by-87.2%

Dependency count

18

increased by80%

Number of package files

39

decreased by-31.58%

Lines of code

1260

decreased by-12.56%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@types/http-proxy@^1.17.7

• + Added@types/koa@^2.13.4

• + Added@types/koa-compose@^3.2.5

• + Added@types/koa-compress@^4.0.3

• + Added@types/koa-mount@^4.0.1

• + Added@types/koa-send@^4.1.3

• + Added@types/koa-session@^5.10.4

• + Added@types/koa-static@^4.0.2

• + Added@types/accepts@1.3.7(transitive)

• + Added@types/body-parser@1.19.5(transitive)

• + Added@types/connect@3.4.38(transitive)

• + Added@types/content-disposition@0.5.8(transitive)

• + Added@types/cookies@0.9.0(transitive)

• + Added@types/express@5.0.0(transitive)

• + Added@types/express-serve-static-core@5.0.1(transitive)

• + Added@types/http-assert@1.5.6(transitive)

• + Added@types/http-errors@2.0.4(transitive)

• + Added@types/http-proxy@1.17.15(transitive)

• + Added@types/keygrip@1.0.6(transitive)

• + Added@types/koa@2.15.0(transitive)

• + Added@types/koa-compose@3.2.8(transitive)

• + Added@types/koa-compress@4.0.6(transitive)

• + Added@types/koa-mount@4.0.5(transitive)

• + Added@types/koa-send@4.1.6(transitive)

• + Added@types/koa-session@5.10.6(transitive)

• + Added@types/koa-static@4.0.4(transitive)

• + Added@types/mime@1.3.5(transitive)

• + Added@types/node@22.9.3(transitive)

• + Added@types/qs@6.9.17(transitive)

• + Added@types/range-parser@1.2.7(transitive)

• + Added@types/send@0.17.4(transitive)

• + Added@types/serve-static@1.15.7(transitive)

• + Addedundici-types@6.19.8(transitive)

• Updatedkoa@^2.13.3

• Updatedkoa-compress@^5.1.0

• Updatedkoa-session@^6.2.0

• Updatedtslang@^0.1.23

• Updatedtslib@^2.3.1