@hlw-midway/core 1.0.0

package/dist/exception/filter.js

@@ -0,0 +1,42 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwExceptionFilter = void 0;
+const core_1 = require("@midwayjs/core");
+const global_1 = require("../constant/global");
+const comm_1 = require("../exception/comm");
+/**
+ * 全局异常处理
+ */
+let HlwExceptionFilter = class HlwExceptionFilter {
+    async catch(err) {
+        const { RESCODE } = global_1.GlobalConfig.getInstance();
+        if (err instanceof comm_1.HlwCommException) {
+            // 401/403 只输出简短信息，不输出堆栈
+            this.coreLogger.warn(`[${err.statusCode || err.status}] ${err.message}`);
+        }
+        else {
+            this.coreLogger.error(err);
+        }
+        return {
+            code: err.status || RESCODE.COMMFAIL,
+            message: err.message,
+        };
+    }
+};
+exports.HlwExceptionFilter = HlwExceptionFilter;
+__decorate([
+    (0, core_1.Logger)(),
+    __metadata("design:type", Object)
+], HlwExceptionFilter.prototype, "coreLogger", void 0);
+exports.HlwExceptionFilter = HlwExceptionFilter = __decorate([
+    (0, core_1.Catch)()
+], HlwExceptionFilter);

package/dist/exception/validate.d.ts

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

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, statusCode) {
+        const { RESCODE, RESMESSAGE } = global_1.GlobalConfig.getInstance();
+        super('HlwValidateException', RESCODE.VALIDATEFAIL, message ? message : RESMESSAGE.VALIDATEFAIL, statusCode);
+    }
+}
+exports.HlwValidateException = HlwValidateException;

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+export { HlwConfiguration as Configuration } from './configuration';
+export * from './exception/filter';
+export * from './exception/core';
+export * from './exception/base';
+export * from './exception/comm';
+export * from './exception/validate';
+export * from './cache/store';
+export * from './entity/base';
+export * from './entity/typeorm';
+export * from './entity/mongo';
+export * from './service/base';
+export * from './service/mysql';
+export * from './service/postgres';
+export * from './service/sqlite';
+export * from './controller/base';
+export * from './event/index';
+export * from './decorator/controller';
+export * from './decorator/cache';
+export * from './decorator/event';
+export * from './decorator/transaction';
+export * from './decorator/tag';
+export * from './decorator/index';
+export * from './rest/eps';
+export * from './tag/data';
+export * from './module/config';
+export * from './module/import';
+export * from './module/menu';
+export * from './interface';
+export * from './util/func';
+export * from './constant/global';
+export * from './util/location';

package/dist/index.js

@@ -0,0 +1,60 @@
+"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.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.HlwConfiguration; } });
+// 异常处理
+__exportStar(require("./exception/filter"), exports);
+__exportStar(require("./exception/core"), exports);
+__exportStar(require("./exception/base"), exports);
+__exportStar(require("./exception/comm"), exports);
+__exportStar(require("./exception/validate"), exports);
+// cache
+__exportStar(require("./cache/store"), exports);
+// entity
+__exportStar(require("./entity/base"), exports);
+__exportStar(require("./entity/typeorm"), exports);
+__exportStar(require("./entity/mongo"), exports);
+// service
+__exportStar(require("./service/base"), exports);
+__exportStar(require("./service/mysql"), exports);
+__exportStar(require("./service/postgres"), exports);
+__exportStar(require("./service/sqlite"), exports);
+// controller
+__exportStar(require("./controller/base"), exports);
+// 事件
+__exportStar(require("./event/index"), exports);
+// 装饰器
+__exportStar(require("./decorator/controller"), exports);
+__exportStar(require("./decorator/cache"), exports);
+__exportStar(require("./decorator/event"), exports);
+__exportStar(require("./decorator/transaction"), exports);
+__exportStar(require("./decorator/tag"), exports);
+__exportStar(require("./decorator/index"), exports);
+// rest
+__exportStar(require("./rest/eps"), exports);
+// tag
+__exportStar(require("./tag/data"), exports);
+// 模块
+__exportStar(require("./module/config"), exports);
+__exportStar(require("./module/import"), exports);
+__exportStar(require("./module/menu"), exports);
+// 其他
+__exportStar(require("./interface"), exports);
+__exportStar(require("./util/func"), exports);
+__exportStar(require("./constant/global"), exports);
+__exportStar(require("./util/location"), exports);

package/dist/interface.d.ts

@@ -0,0 +1,432 @@
+import { MiddlewareParamArray } from '@midwayjs/core';
+import { AedesOptions } from 'aedes';
+import { PublishPacket } from 'packet';
+/**
+ * 模块配置
+ */
+export interface ModuleConfig {
+    /** 名称 */
+    name: string;
+    /** 描述 */
+    description: string;
+    /** 模块中间件 */
+    middlewares?: MiddlewareParamArray;
+    /** 全局中间件 */
+    globalMiddlewares?: MiddlewareParamArray;
+    /** 模块加载顺序，默认为0，值越大越优先加载 */
+    order?: number;
+}
+export interface HlwConfig {
+    /** 短信 */
+    sms?: HlwSmsConfig;
+    /** 是否自动导入数据库 */
+    initDB?: boolean;
+    /** Eps */
+    eps?: boolean;
+    /** 开启多租户 */
+    tenant?: {
+        /** 是否开启 */
+        enable: boolean;
+        urls: string[];
+    };
+    /** 开启多语言 */
+    i18n?: {
+        /** 是否开启 */
+        enable: boolean;
+        /** 语言 */
+        languages: Array<'zh-cn' | 'en' | 'az' | 'de' | 'pt' | 'es' | 'da' | 'fr' | 'nb-NO' | 'zh-tw' | 'it' | 'ko' | 'ja' | 'nl' | 'vi' | 'ru' | 'tr' | 'pt-br' | 'fa' | 'th' | 'id' | 'bg' | 'pa' | 'pl' | 'fi' | 'sv' | 'el' | 'sk' | 'ca' | 'cs' | 'uk' | 'tk' | 'ta' | 'lv' | 'af' | 'et' | 'sl' | 'ar' | 'he' | 'lt' | 'mn' | 'kk' | 'hu' | 'ro' | 'ku' | 'ckb' | 'ug-cn' | 'km' | 'sr' | 'eu' | 'ky' | 'hy-am' | 'hr' | 'eo' | 'bn' | 'ms'>;
+        /** 翻译服务 */
+        serviceUrl?: string;
+    };
+    /** 是否自动导入模块菜单 */
+    initMenu?: boolean;
+    /** 判断是否初始化的方式 */
+    initJudge: 'file' | 'db';
+    /** crud配置 */
+    crud?: {
+        /** 软删除 */
+        softDelete: boolean;
+        /** 分页查询每页条数 */
+        pageSize: number;
+        /** 插入方式 */
+        upsert: 'normal' | 'save';
+    };
+    /** elasticsearch配置 */
+    es?: {
+        nodes: string[];
+        options?: any;
+    };
+    /** pay */
+    pay?: {
+        /** 微信支付 */
+        wx?: HlwWxPayConfig;
+        /** 支付宝支付 */
+        ali?: HlwAliPayConfig;
+    };
+    /** rpc */
+    rpc?: HlwRpcConfig;
+    /** redis  */
+    redis?: RedisConfig | RedisConfig[];
+    /** 文件上传 */
+    file?: {
+        /** 上传模式 */
+        mode: MODETYPE;
+        /** 本地上传 文件地址前缀 */
+        domain?: string;
+        /** oss */
+        oss?: OSSConfig;
+        /** cos */
+        cos?: COSConfig;
+        /** qiniu */
+        qiniu?: QINIUConfig;
+        /** aws */
+        aws: AWSConfig;
+    };
+    /** IOT 配置 */
+    iot?: HlwIotConfig;
+}
+export interface HlwRpcConfig {
+    /** 服务名称 */
+    name: string;
+    /** redis */
+    redis: RedisConfig & RedisConfig[] & unknown;
+}
+export interface RedisConfig {
+    /** host */
+    host: string;
+    /** password */
+    password: string;
+    /** port */
+    port: number;
+    /** db */
+    db: number;
+}
+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 HlwFileConfig {
+    /** 上传模式 */
+    mode: MODETYPE;
+    /** 阿里云oss 配置 */
+    oss: OSSConfig;
+    /** 腾讯云 cos配置 */
+    cos: COSConfig;
+    /** 七牛云 配置 */
+    qiniu: QINIUConfig;
+    /** AWS s3 配置 */
+    aws: AWSConfig;
+    /** 文件前缀 */
+    domain: string;
+}
+/**
+ * OSS 配置
+ */
+export interface OSSConfig {
+    /** 阿里云accessKeyId */
+    accessKeyId: string;
+    /** 阿里云accessKeySecret */
+    accessKeySecret: string;
+    /** 阿里云oss的bucket */
+    bucket: string;
+    /** 阿里云oss的endpoint */
+    endpoint: string;
+    /** 阿里云oss的timeout */
+    timeout: string;
+    /** 签名失效时间，毫秒 */
+    expAfter?: number;
+    /** 文件最大的 size */
+    maxSize?: number;
+    host?: string;
+    publicDomain?: string;
+}
+/**
+ * COS 配置
+ */
+export interface COSConfig {
+    /** 腾讯云accessKeyId */
+    accessKeyId: string;
+    /** 腾讯云accessKeySecret */
+    accessKeySecret: string;
+    /** 腾讯云cos的bucket */
+    bucket: string;
+    /** 腾讯云cos的区域 */
+    region: string;
+    /** 腾讯云cos的公网访问地址 */
+    publicDomain: string;
+    /** 上传持续时间 */
+    durationSeconds?: number;
+    /** 允许操作（上传）的对象前缀 */
+    allowPrefix?: string;
+    /** 密钥的权限列表 */
+    allowActions?: string[];
+}
+export interface QINIUConfig {
+    /** 七牛云accessKeyId */
+    accessKeyId: string;
+    /** 七牛云accessKeySecret */
+    accessKeySecret: string;
+    /** 七牛云cos的bucket */
+    bucket: string;
+    /** 七牛云cos的区域 */
+    region: string;
+    /** 七牛云cos的公网访问地址 */
+    publicDomain: string;
+    /** 上传地址 */
+    uploadUrl?: string;
+    /** 上传fileKey */
+    fileKey?: string;
+}
+export interface AWSConfig {
+    /** accessKeyId */
+    accessKeyId: string;
+    /** secretAccessKey */
+    secretAccessKey: string;
+    /** bucket */
+    bucket: string;
+    /** region */
+    region: string;
+    /** fields */
+    fields?: any;
+    /** conditions */
+    conditions?: any[];
+    /** expires */
+    expires?: number;
+    /** publicDomain */
+    publicDomain?: string;
+    /** forcePathStyle */
+    forcePathStyle?: boolean;
+}
+/**
+ * 微信支付配置
+ */
+export interface HlwWxPayConfig {
+    /** 直连商户申请的公众号或移动应用appid。 */
+    appid: string;
+    /** 商户号 */
+    mchid: string;
+    /** 可选参数 证书序列号 */
+    serial_no?: string;
+    /** 回调链接 */
+    notify_url: string;
+    /** 公钥 */
+    publicKey: Buffer;
+    /** 私钥 */
+    privateKey: Buffer;
+    /** 可选参数 认证类型，目前为WECHATPAY2-SHA256-RSA2048 */
+    authType?: string;
+    /** 可选参数 User-Agent */
+    userAgent?: string;
+    /** 可选参数 APIv3密钥 */
+    key?: string;
+}
+/**
+ * 支付宝支付配置
+ */
+export interface HlwAliPayConfig {
+    /** 支付回调地址 */
+    notifyUrl: string;
+    /** 应用ID */
+    appId: string;
+    /**
+     * 应用私钥字符串
+     * RSA签名验签工具：https://docs.open.alipay.com/291/106097）
+     * 密钥格式一栏请选择 “PKCS1(非JAVA适用)”
+     */
+    privateKey: string;
+    /** 签名类型 */
+    signType?: 'RSA2' | 'RSA';
+    /** 支付宝公钥（需要对返回值做验签时候必填） */
+    alipayPublicKey?: string;
+    /** 网关 */
+    gateway?: string;
+    /** 网关超时时间（单位毫秒，默认 5s） */
+    timeout?: number;
+    /** 是否把网关返回的下划线 key 转换为驼峰写法 */
+    camelcase?: boolean;
+    /** 编码（只支持 utf-8） */
+    charset?: 'utf-8';
+    /** api版本 */
+    version?: '1.0';
+    urllib?: any;
+    /** 指定private key类型, 默认： PKCS1, PKCS8: PRIVATE KEY, PKCS1: RSA PRIVATE KEY */
+    keyType?: 'PKCS1' | 'PKCS8';
+    /** 应用公钥证书文件路径 */
+    appCertPath?: string;
+    /** 应用公钥证书文件内容 */
+    appCertContent?: string | Buffer;
+    /** 应用公钥证书sn */
+    appCertSn?: string;
+    /** 支付宝根证书文件路径 */
+    alipayRootCertPath?: string;
+    /** 支付宝根证书文件内容 */
+    alipayRootCertContent?: string | Buffer;
+    /** 支付宝根证书sn */
+    alipayRootCertSn?: string;
+    /** 支付宝公钥证书文件路径 */
+    alipayPublicCertPath?: string;
+    /** 支付宝公钥证书文件内容 */
+    alipayPublicCertContent?: string | Buffer;
+    /** 支付宝公钥证书sn */
+    alipayCertSn?: string;
+    /** AES密钥，调用AES加解密相关接口时需要 */
+    encryptKey?: string;
+    /** 服务器地址 */
+    wsServiceUrl?: string;
+}
+/**
+ * IOT配置
+ */
+export interface HlwIotConfig {
+    /** MQTT服务端口 */
+    port: number;
+    /** MQTT Websocket服务端口 */
+    wsPort: number;
+    /** redis 配置 mqtt cluster下必须要配置 */
+    redis?: {
+        /** host */
+        host: string;
+        /** port */
+        port: number;
+        /** password */
+        password: string;
+        /** db */
+        db: number;
+    };
+    /** 发布消息配置 */
+    publish?: PublishPacket;
+    /** 认证 */
+    auth?: {
+        /** 用户 */
+        username: string;
+        /** 密码 */
+        password: string;
+    };
+    /** 服务配置 */
+    serve?: AedesOptions;
+}
+export interface HlwSmsConfig {
+    /**
+     * 阿里云短信配置
+     */
+    ali: HlwSmsAliConfig;
+    /**
+     * 腾讯云短信配置
+     */
+    tx: HlwSmsTxConfig;
+    /**
+     * 云片短信配置
+     */
+    yp: HlwSmsYpConfig;
+    /**
+     * aws短信配置
+     */
+    aws: HlwSmsAwsConfig;
+}
+export interface HlwSmsAwsConfig {
+    /**
+     * 区域
+     */
+    region: string;
+    /**
+     * accessKeyId
+     */
+    accessKeyId: string;
+    /**
+     * secretAccessKey
+     */
+    secretAccessKey: string;
+    /**
+     * 扩展配置
+     */
+    extend?: any;
+}
+/**
+ * 阿里云配置
+ */
+export interface HlwSmsAliConfig {
+    /**
+     * 阿里云accessKeyId
+     */
+    accessKeyId: string;
+    /**
+     * 阿里云accessKeySecret
+     */
+    accessKeySecret: string;
+    /**
+     * 签名，非必填，调用时可以传入
+     */
+    signName?: string;
+    /**
+     * 模板，非必填，调用时可以传入
+     */
+    template?: string;
+}
+/**
+ * 腾讯云配置
+ */
+export interface HlwSmsTxConfig {
+    /**
+     * 应用ID
+     */
+    appId: string;
+    /**
+     * 腾讯云secretId
+     */
+    secretId: string;
+    /**
+     * 腾讯云secretKey
+     */
+    secretKey: string;
+    /**
+     * 签名，非必填，调用时可以传入
+     */
+    signName?: string;
+    /**
+     * 模板，非必填，调用时可以传入
+     */
+    template?: string;
+}
+/**
+ * 云片短信配置
+ */
+export interface HlwSmsYpConfig {
+    /**
+     * 云片apikey
+     */
+    apikey: string;
+    /**
+     * 签名，非必填，调用时可以传入
+     */
+    signName?: string;
+    /**
+     * 模板，非必填，调用时可以传入
+     */
+    template?: string;
+}

package/dist/interface.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/module/config.d.ts

@@ -0,0 +1,21 @@
+import { IMidwayApplication } from '@midwayjs/core';
+/**
+ * 模块配置
+ */
+export declare class HlwModuleConfig {
+    app: IMidwayApplication;
+    allConfig: any;
+    modules: any;
+    init(): Promise<void>;
+    /**
+     * 模块配置
+     * @param module 模块
+     * @param config 配置
+     */
+    moduleConfig(module: any, config: any): Promise<void>;
+    /**
+     * 全局中间件
+     * @param middleware 中间件
+     */
+    globalMiddlewareArr(middlewares: any[]): Promise<void>;
+}