@hlw-midway/plugin-cli 1.0.0 → 1.0.1

package/dist/constant/global.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 返回码
+ */
+export declare enum RESCODE {
+    SUCCESS = 1000,
+    COMMFAIL = 1001,
+    VALIDATEFAIL = 1002,
+    COREFAIL = 1003
+}
+/**
+ * 返回信息
+ */
+export declare enum RESMESSAGE {
+    SUCCESS = "success",
+    COMMFAIL = "comm fail",
+    VALIDATEFAIL = "validate fail",
+    COREFAIL = "core fail"
+}
+/**
+ * 错误提示
+ */
+export declare enum ERRINFO {
+    NOENTITY = "\u672A\u8BBE\u7F6E\u64CD\u4F5C\u5B9E\u4F53",
+    NOID = "\u67E5\u8BE2\u53C2\u6570[id]\u4E0D\u5B58\u5728",
+    SORTFIELD = "\u6392\u5E8F\u53C2\u6570\u4E0D\u6B63\u786E"
+}
+/**
+ * 事件
+ */
+export declare enum EVENT {
+    SOFT_DELETE = "onSoftDelete",
+    SERVER_READY = "onServerReady",
+    READY = "onReady",
+    ES_DATA_CHANGE = "esDataChange"
+}
+export declare class GlobalConfig {
+    private static instance;
+    RESCODE: {
+        SUCCESS: number;
+        COMMFAIL: number;
+        VALIDATEFAIL: number;
+        COREFAIL: number;
+    };
+    RESMESSAGE: {
+        SUCCESS: string;
+        COMMFAIL: string;
+        VALIDATEFAIL: string;
+        COREFAIL: string;
+    };
+    private constructor();
+    static getInstance(): GlobalConfig;
+}

package/dist/constant/global.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GlobalConfig = exports.EVENT = exports.ERRINFO = exports.RESMESSAGE = exports.RESCODE = void 0;
+/**
+ * 返回码
+ */
+var RESCODE;
+(function (RESCODE) {
+    // 成功
+    RESCODE[RESCODE["SUCCESS"] = 1000] = "SUCCESS";
+    // 失败
+    RESCODE[RESCODE["COMMFAIL"] = 1001] = "COMMFAIL";
+    // 参数验证失败
+    RESCODE[RESCODE["VALIDATEFAIL"] = 1002] = "VALIDATEFAIL";
+    // 参数验证失败
+    RESCODE[RESCODE["COREFAIL"] = 1003] = "COREFAIL";
+})(RESCODE || (exports.RESCODE = RESCODE = {}));
+/**
+ * 返回信息
+ */
+var RESMESSAGE;
+(function (RESMESSAGE) {
+    // 成功
+    RESMESSAGE["SUCCESS"] = "success";
+    // 失败
+    RESMESSAGE["COMMFAIL"] = "comm fail";
+    // 参数验证失败
+    RESMESSAGE["VALIDATEFAIL"] = "validate fail";
+    // 核心异常
+    RESMESSAGE["COREFAIL"] = "core fail";
+})(RESMESSAGE || (exports.RESMESSAGE = RESMESSAGE = {}));
+/**
+ * 错误提示
+ */
+var ERRINFO;
+(function (ERRINFO) {
+    ERRINFO["NOENTITY"] = "\u672A\u8BBE\u7F6E\u64CD\u4F5C\u5B9E\u4F53";
+    ERRINFO["NOID"] = "\u67E5\u8BE2\u53C2\u6570[id]\u4E0D\u5B58\u5728";
+    ERRINFO["SORTFIELD"] = "\u6392\u5E8F\u53C2\u6570\u4E0D\u6B63\u786E";
+})(ERRINFO || (exports.ERRINFO = ERRINFO = {}));
+/**
+ * 事件
+ */
+var EVENT;
+(function (EVENT) {
+    // 软删除
+    EVENT["SOFT_DELETE"] = "onSoftDelete";
+    // 服务成功启动
+    EVENT["SERVER_READY"] = "onServerReady";
+    // 服务就绪
+    EVENT["READY"] = "onReady";
+    // ES 数据改变
+    EVENT["ES_DATA_CHANGE"] = "esDataChange";
+})(EVENT || (exports.EVENT = EVENT = {}));
+class GlobalConfig {
+    // ... 其他的配置 ...
+    constructor() {
+        this.RESCODE = {
+            SUCCESS: 1000,
+            COMMFAIL: 1001,
+            VALIDATEFAIL: 1002,
+            COREFAIL: 1003,
+        };
+        this.RESMESSAGE = {
+            SUCCESS: "success",
+            COMMFAIL: "comm fail",
+            VALIDATEFAIL: "validate fail",
+            COREFAIL: "core fail",
+        };
+    }
+    static getInstance() {
+        if (!GlobalConfig.instance) {
+            GlobalConfig.instance = new GlobalConfig();
+        }
+        return GlobalConfig.instance;
+    }
+}
+exports.GlobalConfig = GlobalConfig;

package/dist/exception/base.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 异常基类
+ */
+export declare class BaseException extends Error {
+    status: number;
+    constructor(name: string, code: number, message: string);
+}

package/dist/exception/base.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseException = void 0;
+/**
+ * 异常基类
+ */
+class BaseException extends Error {
+    constructor(name, code, message) {
+        super(message);
+        this.name = name;
+        this.status = code;
+    }
+}
+exports.BaseException = BaseException;

package/dist/exception/comm.d.ts

@@ -0,0 +1,7 @@
+import { BaseException } from './base';
+/**
+ * 通用异常
+ */
+export declare class HlwCommException extends BaseException {
+    constructor(message: string);
+}

package/dist/exception/comm.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwCommException = void 0;
+const global_1 = require("../constant/global");
+const base_1 = require("./base");
+/**
+ * 通用异常
+ */
+class HlwCommException extends base_1.BaseException {
+    constructor(message) {
+        const { RESCODE, RESMESSAGE } = global_1.GlobalConfig.getInstance();
+        super('HlwCommException', RESCODE.COMMFAIL, message ? message : RESMESSAGE.COMMFAIL);
+    }
+}
+exports.HlwCommException = HlwCommException;

package/dist/exception/core.d.ts

@@ -0,0 +1,7 @@
+import { BaseException } from './base';
+/**
+ * 核心异常
+ */
+export declare class HlwCoreException extends BaseException {
+    constructor(message: string);
+}

package/dist/exception/core.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwCoreException = void 0;
+const global_1 = require("../constant/global");
+const base_1 = require("./base");
+/**
+ * 核心异常
+ */
+class HlwCoreException extends base_1.BaseException {
+    constructor(message) {
+        const { RESCODE, RESMESSAGE } = global_1.GlobalConfig.getInstance();
+        super('HlwCoreException', RESCODE.COREFAIL, message ? message : RESMESSAGE.COREFAIL);
+    }
+}
+exports.HlwCoreException = HlwCoreException;

package/dist/exception/validate.d.ts

@@ -0,0 +1,7 @@
+import { BaseException } from "./base";
+/**
+ * 校验异常
+ */
+export declare class HlwValidateException extends BaseException {
+    constructor(message: string);
+}

package/dist/exception/validate.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwValidateException = void 0;
+const global_1 = require("../constant/global");
+const base_1 = require("./base");
+/**
+ * 校验异常
+ */
+class HlwValidateException extends base_1.BaseException {
+    constructor(message) {
+        const { RESCODE, RESMESSAGE } = global_1.GlobalConfig.getInstance();
+        super("HlwValidateException", RESCODE.VALIDATEFAIL, message ? message : RESMESSAGE.VALIDATEFAIL);
+    }
+}
+exports.HlwValidateException = HlwValidateException;

package/dist/hook/upload.d.ts

@@ -0,0 +1,51 @@
+export declare enum MODETYPE {
+    LOCAL = "local",
+    CLOUD = "cloud",
+    OTHER = "other"
+}
+export declare enum CLOUDTYPE {
+    OSS = "oss",
+    COS = "cos",
+    QINIU = "qiniu",
+    /** AWS S3 */
+    AWS = "aws"
+}
+/**
+ * 上传模式
+ */
+export interface Mode {
+    mode: MODETYPE;
+    type: string;
+}
+/**
+ * 文件上传
+ */
+export interface BaseUpload {
+    /**
+     * 获得上传模式
+     */
+    getMode(): Promise<Mode>;
+    /**
+     * 获得原始操作对象
+     * @returns
+     */
+    getMetaFileObj(): any;
+    /**
+     * 下载并上传
+     * @param url
+     * @param fileName 文件名
+     */
+    downAndUpload(url: string, fileName?: string): Promise<string>;
+    /**
+     * 指定Key(路径)上传，本地文件上传到存储服务
+     * @param filePath 文件路径
+     * @param key 路径一致会覆盖源文件
+     */
+    uploadWithKey(filePath: any, key: any): Promise<string>;
+    /**
+     * 上传文件
+     * @param ctx
+     * @param key 文件路径
+     */
+    upload(ctx: any): Promise<any>;
+}

package/dist/hook/upload.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLOUDTYPE = exports.MODETYPE = void 0;
+// 模式
+var MODETYPE;
+(function (MODETYPE) {
+    // 本地
+    MODETYPE["LOCAL"] = "local";
+    // 云存储
+    MODETYPE["CLOUD"] = "cloud";
+    // 其他
+    MODETYPE["OTHER"] = "other";
+})(MODETYPE || (exports.MODETYPE = MODETYPE = {}));
+var CLOUDTYPE;
+(function (CLOUDTYPE) {
+    // 阿里云存储
+    CLOUDTYPE["OSS"] = "oss";
+    // 腾讯云存储
+    CLOUDTYPE["COS"] = "cos";
+    // 七牛云存储
+    CLOUDTYPE["QINIU"] = "qiniu";
+    /** AWS S3 */
+    CLOUDTYPE["AWS"] = "aws";
+})(CLOUDTYPE || (exports.CLOUDTYPE = CLOUDTYPE = {}));

package/dist/index.d.ts

@@ -0,0 +1,104 @@
+import { MidwayCache } from "@midwayjs/cache-manager";
+import { IMidwayContext, IMidwayApplication } from "@midwayjs/core";
+import { HlwCacheStore } from "@hlw-midway/core";
+type FsCacheStore = ReturnType<typeof HlwCacheStore>;
+export * from "./hook/upload";
+export * from "./exception/base";
+export * from "./exception/comm";
+export * from "./exception/core";
+export * from "./exception/validate";
+export * from "./constant/global";
+/**
+ * 插件信息
+ */
+export interface PluginInfo {
+    /** 名称 */
+    name: string;
+    /** 唯一标识 */
+    key: string;
+    /** 钩子 */
+    hook: string;
+    /** 版本 */
+    version: string;
+    /** 描述 */
+    description: string;
+    /** 作者 */
+    author: string;
+    /** logo */
+    logo: string;
+    /** README 使用说明 */
+    readme: string;
+    /** 配置 */
+    config: any;
+}
+/**
+ * 插件基类，不建议修改
+ */
+export declare abstract class BasePlugin {
+    /** 插件信息 */
+    pluginInfo: PluginInfo;
+    /** 请求上下文，用到此项无法本地调试，需安装到hlw-admin中才能调试 */
+    ctx: IMidwayContext;
+    /** 应用实例，用到此项无法本地调试，需安装到hlw-admin中才能调试 */
+    app: IMidwayApplication;
+    /** 缓存 */
+    cache: FsCacheStore | MidwayCache;
+    /** 插件 */
+    pluginService: PluginService;
+    /** 基础目录位置 */
+    baseDir: string;
+    setCtx(ctx: IMidwayContext): void;
+    setApp(app: IMidwayApplication): void;
+    constructor();
+    /**
+     * 获得App级别的实例
+     * @param name
+     * @returns
+     */
+    getAppInstance(name: string): Promise<unknown>;
+    /**
+     * 获得请求级别的实例
+     * @param name
+     * @returns
+     */
+    getCtxInstance(name: string): Promise<unknown>;
+    /**
+     * 初始化插件
+     * @param pluginInfo
+     * @param ctx
+     * @param app
+     */
+    init(pluginInfo: PluginInfo, ctx?: IMidwayContext, app?: IMidwayApplication, other?: any): Promise<void>;
+    /**
+     * 处理配置目录
+     */
+    private configDir;
+    /**
+     * 插件就绪
+     */
+    ready(): Promise<void>;
+}
+/**
+ * 插件服务
+ */
+export declare class PluginService {
+    /**
+     * 调用插件
+     * @param key 插件key
+     * @param method 方法
+     * @param params 参数
+     * @returns
+     */
+    invoke(key: string, method: string, ...params: any[]): Promise<any>;
+    /**
+     * 获得插件实例
+     * @param key
+     * @returns
+     */
+    getInstance(key: string): Promise<any>;
+    /**
+     * 检查状态
+     * @param key
+     */
+    checkStatus(key: string): Promise<void>;
+}

package/dist/index.js

@@ -0,0 +1,95 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 });
+exports.BasePlugin = void 0;
+const core_1 = require("@hlw-midway/core");
+// 文件上传
+__exportStar(require("./hook/upload"), exports);
+// 异常处理
+__exportStar(require("./exception/base"), exports);
+__exportStar(require("./exception/comm"), exports);
+__exportStar(require("./exception/core"), exports);
+__exportStar(require("./exception/validate"), exports);
+// 全局参数
+__exportStar(require("./constant/global"), exports);
+/**
+ * 插件基类，不建议修改
+ */
+class BasePlugin {
+    setCtx(ctx) {
+        this.ctx = ctx;
+    }
+    setApp(app) {
+        this.app = app;
+        this.baseDir = app.getBaseDir();
+        this.configDir();
+    }
+    constructor() { }
+    /**
+     * 获得App级别的实例
+     * @param name
+     * @returns
+     */
+    async getAppInstance(name) {
+        return await this.app.getApplicationContext().getAsync(name);
+    }
+    /**
+     * 获得请求级别的实例
+     * @param name
+     * @returns
+     */
+    async getCtxInstance(name) {
+        return await this.ctx.requestContext.getAsync(name);
+    }
+    /**
+     * 初始化插件
+     * @param pluginInfo
+     * @param ctx
+     * @param app
+     */
+    async init(pluginInfo, ctx, app, other) {
+        var _a;
+        this.pluginInfo = pluginInfo;
+        this.ctx = ctx;
+        this.app = app;
+        this.baseDir = process.cwd();
+        if (this.app) {
+            this.baseDir = (_a = this.app) === null || _a === void 0 ? void 0 : _a.getBaseDir();
+        }
+        this.configDir();
+        this.cache = (0, core_1.HlwCacheStore)({});
+        if (other) {
+            this.cache = other.cache;
+            this.pluginService = other.pluginService;
+        }
+        await this.ready();
+    }
+    /**
+     * 处理配置目录
+     */
+    configDir() {
+        // 替换\为/
+        this.baseDir = this.baseDir.replace(/\\/g, "/");
+        let config = this.pluginInfo.config || {};
+        config = JSON.stringify(config);
+        this.pluginInfo.config = JSON.parse(config.replace(/@baseDir/g, this.baseDir));
+    }
+    /**
+     * 插件就绪
+     */
+    async ready() { }
+}
+exports.BasePlugin = BasePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hlw-midway/plugin-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "hlw-admin midway plugin",
   "main": "dist/index.js",
   "scripts": {