@midwayjs/info 4.0.0-alpha.1 → 4.0.0-beta.1

package/README.md

@@ -29,4 +29,4 @@ Your can curl `/_info` to show it.
 
 ## License
 
-[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))
+[MIT]((https://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/config.default.js

@@ -6,5 +6,6 @@ exports.info = {
     title: 'Midway Info',
     infoPath: '/_info',
     hiddenKey: interface_1.DefaultHiddenKey,
+    ignoreKey: [],
 };
 //# sourceMappingURL=config.default.js.map

package/dist/infoService.d.ts

@@ -1,15 +1,19 @@
 import { MidwayInformationService, IMidwayContainer, MidwayConfigService, MidwayEnvironmentService } from '@midwayjs/core';
-import { InfoValueType, TypeInfo } from './interface';
+import { InfoType, InfoValueType, TypeInfo } from './interface';
 export declare class InfoService {
     midwayInformationService: MidwayInformationService;
     configService: MidwayConfigService;
     environment: MidwayEnvironmentService;
-    titleConfig: any;
+    titleConfig: string;
     defaultHiddenKey: string[];
+    ignoreKey: string[];
     secretMatchList: Array<any>;
     container: IMidwayContainer;
     init(): Promise<void>;
-    info(infoValueType?: InfoValueType): string | TypeInfo[];
+    info(infoValueType?: InfoValueType): string | {
+        type: string;
+        info: {};
+    }[];
     projectInfo(): TypeInfo;
     systemInfo(): TypeInfo;
     resourceOccupationInfo(): TypeInfo;
@@ -19,14 +23,14 @@ export declare class InfoService {
     networkInfo(): TypeInfo;
     dependenciesInfo(): TypeInfo;
     midwayService(): {
-        type: string;
+        type: InfoType;
         info: {};
     };
     midwayConfig(): {
-        type: string;
+        type: InfoType;
         info: {};
     };
-    protected filterSecretContent(key: any, value: any): any;
+    protected filterSecretContent(key: string, value: any): any;
     protected safeJson(value: any): string;
 }
 //# sourceMappingURL=infoService.d.ts.map

package/dist/infoService.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoService = void 0;
 const core_1 = require("@midwayjs/core");
 const core_2 = require("@midwayjs/core");
+const interface_1 = require("./interface");
 const utils_1 = require("./utils");
 const os_1 = require("os");
 const path_1 = require("path");
@@ -23,25 +24,35 @@ let InfoService = class InfoService {
         });
     }
     info(infoValueType) {
-        const info = [];
-        info.push(this.projectInfo());
-        info.push(this.systemInfo());
-        info.push(this.resourceOccupationInfo());
-        info.push(this.softwareInfo());
-        info.push(this.midwayConfig());
-        info.push(this.midwayService());
-        info.push(this.timeInfo());
-        info.push(this.envInfo());
-        info.push(this.dependenciesInfo());
-        info.push(this.networkInfo());
+        const allInfo = [];
+        allInfo.push(this.projectInfo());
+        allInfo.push(this.systemInfo());
+        allInfo.push(this.resourceOccupationInfo());
+        allInfo.push(this.softwareInfo());
+        allInfo.push(this.midwayConfig());
+        allInfo.push(this.midwayService());
+        allInfo.push(this.timeInfo());
+        allInfo.push(this.envInfo());
+        allInfo.push(this.dependenciesInfo());
+        allInfo.push(this.networkInfo());
+        // 过滤自定义隐藏的key
+        const newInfo = allInfo.map(({ type, info }) => {
+            const infoKeys = Object.keys(info);
+            const keys = infoKeys.filter(k => !this.ignoreKey.includes(k));
+            const infoByIgnore = {};
+            for (const key of keys) {
+                infoByIgnore[key] = info[key];
+            }
+            return { type, info: infoByIgnore };
+        });
         if (infoValueType === 'html') {
-            return (0, utils_1.renderToHtml)(info, this.titleConfig);
+            return (0, utils_1.renderToHtml)(newInfo, this.titleConfig);
         }
-        return info;
+        return newInfo;
     }
     projectInfo() {
         return {
-            type: 'Project',
+            type: interface_1.InfoType.PROJECT,
             info: {
                 Project: this.midwayInformationService.getProjectName(),
                 AppDir: this.midwayInformationService.getAppDir(),
@@ -54,7 +65,7 @@ let InfoService = class InfoService {
     systemInfo() {
         const _platform = process.platform;
         return {
-            type: 'System',
+            type: interface_1.InfoType.SYSTEM,
             info: {
                 Platform: _platform === 'win32' ? 'Windows' : _platform,
                 Node: process.versions.node,
@@ -72,7 +83,7 @@ let InfoService = class InfoService {
         const memory = process.memoryUsage();
         const cpu = (0, os_1.cpus)();
         return {
-            type: 'Memory & CPU',
+            type: interface_1.InfoType.MEMORY_CPU,
             info: {
                 'Memory Total Occupy': (0, utils_1.bitToMB)(memory.rss),
                 'Heap Total Occupy': (0, utils_1.bitToMB)(memory.heapTotal),
@@ -110,7 +121,7 @@ let InfoService = class InfoService {
             }
         }
         return {
-            type: 'Software',
+            type: interface_1.InfoType.SOFTWARE,
             info,
         };
     }
@@ -120,14 +131,14 @@ let InfoService = class InfoService {
             env[envName] = this.filterSecretContent(envName, process.env[envName]);
         });
         return {
-            type: 'Environment Variable',
+            type: interface_1.InfoType.ENVIRONMENT_VARIABLE,
             info: env,
         };
     }
     timeInfo() {
         const t = new Date().toString().split(' ');
         return {
-            type: 'Time',
+            type: interface_1.InfoType.TIME,
             info: {
                 Current: Date.now(),
                 Uptime: (0, os_1.uptime)(),
@@ -164,7 +175,7 @@ let InfoService = class InfoService {
                 .join(' / ');
         });
         return {
-            type: 'Network',
+            type: interface_1.InfoType.NETWORK,
             info,
         };
     }
@@ -177,7 +188,7 @@ let InfoService = class InfoService {
             info[modName] = `${modInfo.version || 'Not Found'}(${dependencies[modName]})`;
         });
         return {
-            type: 'Dependencies',
+            type: interface_1.InfoType.DEPENDENCIES,
             info,
         };
     }
@@ -191,7 +202,7 @@ let InfoService = class InfoService {
             }
         }
         return {
-            type: 'Midway Service',
+            type: interface_1.InfoType.MIDWAY_SERVICE,
             info,
         };
     }
@@ -202,7 +213,7 @@ let InfoService = class InfoService {
             info[key] = this.safeJson(this.filterSecretContent(key, config[key]));
         });
         return {
-            type: 'Midway Config',
+            type: interface_1.InfoType.MIDWAY_CONFIG,
             info,
         };
     }
@@ -267,12 +278,16 @@ __decorate([
 ], InfoService.prototype, "environment", void 0);
 __decorate([
     (0, core_1.Config)('info.title'),
-    __metadata("design:type", Object)
+    __metadata("design:type", String)
 ], InfoService.prototype, "titleConfig", void 0);
 __decorate([
     (0, core_1.Config)('info.hiddenKey'),
     __metadata("design:type", Array)
 ], InfoService.prototype, "defaultHiddenKey", void 0);
+__decorate([
+    (0, core_1.Config)('info.ignoreKey'),
+    __metadata("design:type", Array)
+], InfoService.prototype, "ignoreKey", void 0);
 __decorate([
     (0, core_1.ApplicationContext)(),
     __metadata("design:type", Object)

package/dist/interface.d.ts

@@ -10,5 +10,19 @@ export interface InfoConfigOptions {
     title: string;
     infoPath: string;
     hiddenKey: Array<string>;
+    ignoreKey: Array<string>;
+}
+export declare enum InfoType {
+    PROJECT = "Project",
+    SYSTEM = "System",
+    MEMORY_CPU = "Memory & CPU",
+    SOFTWARE = "Software",
+    ENVIRONMENT_VARIABLE = "Environment Variable",
+    TIME = "Time",
+    NETWORK = "Network",
+    RESOURCE = "Resource",
+    DEPENDENCIES = "Dependencies",
+    MIDWAY_SERVICE = "Midway Service",
+    MIDWAY_CONFIG = "Midway Config"
 }
 //# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -1,5 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultHiddenKey = void 0;
+exports.InfoType = exports.DefaultHiddenKey = void 0;
 exports.DefaultHiddenKey = ['keys', '*key', '*token', '*secret*', 'pass*'];
+var InfoType;
+(function (InfoType) {
+    InfoType["PROJECT"] = "Project";
+    InfoType["SYSTEM"] = "System";
+    InfoType["MEMORY_CPU"] = "Memory & CPU";
+    InfoType["SOFTWARE"] = "Software";
+    InfoType["ENVIRONMENT_VARIABLE"] = "Environment Variable";
+    InfoType["TIME"] = "Time";
+    InfoType["NETWORK"] = "Network";
+    InfoType["RESOURCE"] = "Resource";
+    InfoType["DEPENDENCIES"] = "Dependencies";
+    InfoType["MIDWAY_SERVICE"] = "Midway Service";
+    InfoType["MIDWAY_CONFIG"] = "Midway Config";
+})(InfoType || (exports.InfoType = InfoType = {}));
 //# sourceMappingURL=interface.js.map

package/dist/middleware/info.middleware.d.ts

@@ -1,6 +1,6 @@
 import { InfoService } from '../infoService';
 export declare class InfoMiddleware {
-    protected infoPath: any;
+    protected infoPath: string;
     protected infoService: InfoService;
     resolve(app: any): ((req: any, res: any, next: any) => Promise<void>) | ((ctx: any, next: any) => Promise<any>);
     static getName(): string;

package/dist/middleware/info.middleware.js

@@ -43,7 +43,7 @@ let InfoMiddleware = class InfoMiddleware {
 exports.InfoMiddleware = InfoMiddleware;
 __decorate([
     (0, core_1.Config)('info.infoPath'),
-    __metadata("design:type", Object)
+    __metadata("design:type", String)
 ], InfoMiddleware.prototype, "infoPath", void 0);
 __decorate([
     (0, core_1.Inject)(),

package/dist/utils.d.ts

@@ -1,6 +1,6 @@
 import { TypeInfo } from './interface';
 export declare function safeRequire(mod: string, defaultValue?: any): any;
 export declare function bitToMB(bit: number): string;
-export declare function renderToHtml(infoList: TypeInfo[], title: any): string;
+export declare function renderToHtml(infoList: TypeInfo[], title: string): string;
 export declare function safeContent(value?: string): string;
 //# sourceMappingURL=utils.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@midwayjs/info",
   "description": "midway info",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-beta.1",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -13,10 +13,10 @@
     "picomatch": "2.3.1"
   },
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-alpha.1",
-    "@midwayjs/express": "^4.0.0-alpha.1",
-    "@midwayjs/koa": "^4.0.0-alpha.1",
-    "@midwayjs/mock": "^4.0.0-alpha.1"
+    "@midwayjs/core": "^4.0.0-beta.1",
+    "@midwayjs/express": "^4.0.0-beta.1",
+    "@midwayjs/koa": "^4.0.0-beta.1",
+    "@midwayjs/mock": "^4.0.0-beta.1"
   },
   "keywords": [
     "midway"
@@ -37,5 +37,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "14bb4da91805a1cf52f190c0d37a74b395dd6372"
+  "gitHead": "832961ec3aff123c033197d8c00cb2bc9bad7ff8"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2013 - Now midwayjs
-
-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.