@faasjs/http 0.0.2-beta.399 → 0.0.2-beta.401

package/dist/index.d.ts

@@ -121,17 +121,11 @@ declare class Validator<TParams extends Record<string, any> = any, TCookie exten
     cookieConfig?: ValidatorOptions<TCookie>;
     sessionConfig?: ValidatorOptions<TSession>;
     private request;
-    private readonly logger;
-    constructor(config: {
-        params?: ValidatorOptions<TParams>;
-        cookie?: ValidatorOptions<TCookie>;
-        session?: ValidatorOptions<TSession>;
-        before?: BeforeOption<TParams, TCookie, TSession>;
-    }, logger: Logger);
-    valid(request: Request<TParams, TCookie, TSession>): Promise<void>;
+    constructor(config: ValidatorConfig<TParams, TCookie, TSession>);
+    valid(request: Request<TParams, TCookie, TSession>, logger: Logger): Promise<void>;
     validContent(type: string, params: {
         [key: string]: any;
-    }, baseKey: string, config: ValidatorOptions): void;
+    }, baseKey: string, config: ValidatorOptions, logger: Logger): void;
 }
 
 declare const ContentType: {
@@ -142,8 +136,10 @@ declare type HttpConfig<TParams extends Record<string, any> = any, TCookie exten
     name?: string;
     config?: {
         [key: string]: any;
+        /** POST as default */
         method?: 'BEGIN' | 'GET' | 'POST' | 'DELETE' | 'HEAD' | 'PUT' | 'OPTIONS' | 'TRACE' | 'PATCH' | 'ANY';
         timeout?: number;
+        /** file relative path as default */
         path?: string;
         ignorePathPrefix?: string;
         functionName?: string;
@@ -181,54 +177,29 @@ declare class Http<TParams extends Record<string, any> = any, TCookie extends Re
     private readonly validatorOptions?;
     private response?;
     private validator?;
-    private readonly logger;
-    /**
-     * 创建 Http 插件实例
-     * @param config {object} 配置项
-     * @param config.name {string} 配置名
-     * @param config.config {object} 网关配置
-     * @param config.config.method {string} 请求方法，默认为 POST
-     * @param config.config.path {string} 请求路径，默认为云函数文件路径
-     * @param config.config.ignorePathPrefix {string} 排除的路径前缀，当设置 path 时无效
-     * @param config.config.cookie {object} Cookie 配置
-     * @param config.validator {object} 入参校验配置
-     * @param config.validator.params {object} params 校验配置
-     * @param config.validator.params.whitelist {string} 白名单配置
-     * @param config.validator.params.onError {function} 自定义报错
-     * @param config.validator.params.rules {object} 参数校验规则
-     * @param config.validator.cookie {object} cookie 校验配置
-     * @param config.validator.cookie.whitelist {string} 白名单配置
-     * @param config.validator.cookie.onError {function} 自定义报错
-     * @param config.validator.cookie.rules {object} 参数校验规则
-     * @param config.validator.session {object} session 校验配置
-     * @param config.validator.session.whitelist {string} 白名单配置
-     * @param config.validator.session.onError {function} 自定义报错
-     * @param config.validator.session.rules {object} 参数校验规则
-     * @param config.validator.before {function} 参数校验前自定义函数
-     */
     constructor(config?: HttpConfig<TParams, TCookie, TSession>);
     onDeploy(data: DeployData, next: Next): Promise<void>;
     onMount(data: MountData, next: Next): Promise<void>;
     onInvoke(data: InvokeData, next: Next): Promise<void>;
     /**
-     * 设置 header
+     * set header
      * @param key {string} key
      * @param value {*} value
      */
     setHeader(key: string, value: string): Http<TParams, TCookie, TSession>;
     /**
-     * 设置 Content-Type
+     * set Content-Type
      * @param type {string} 类型
      * @param charset {string} 编码
      */
     setContentType(type: string, charset?: string): Http<TParams, TCookie, TSession>;
     /**
-     * 设置状态码
+     * set status code
      * @param code {number} 状态码
      */
     setStatusCode(code: number): Http<TParams, TCookie, TSession>;
     /**
-     * 设置 body
+     * set body
      * @param body {*} 内容
      */
     setBody(body: string): Http<TParams, TCookie, TSession>;

package/dist/index.js

@@ -216,14 +216,13 @@ var Cookie = class {
 
 // src/validator.ts
 var Validator = class {
-  constructor(config, logger) {
+  constructor(config) {
     this.paramsConfig = config.params;
     this.cookieConfig = config.cookie;
     this.sessionConfig = config.session;
     this.before = config.before;
-    this.logger = logger;
   }
-  async valid(request) {
+  async valid(request, logger) {
     if (this.before) {
       const result = await this.before(request);
       if (result)
@@ -231,33 +230,35 @@ var Validator = class {
     }
     this.request = request;
     if (this.paramsConfig && request.params) {
-      this.logger.debug("Valid Params");
-      this.validContent("params", request.params, "", this.paramsConfig);
+      logger.debug("Valid Params");
+      this.validContent("params", request.params, "", this.paramsConfig, logger);
     }
     if (this.cookieConfig && request.cookie) {
-      this.logger.debug("Valid Cookie");
+      logger.debug("Valid Cookie");
       if (request.cookie == null)
         throw Error("Not found Cookie");
       this.validContent(
         "cookie",
         request.cookie.content,
         "",
-        this.cookieConfig
+        this.cookieConfig,
+        logger
       );
     }
     if (this.sessionConfig && request.session) {
-      this.logger.debug("Valid Session");
+      logger.debug("Valid Session");
       if (request.session == null)
         throw Error("Not found Session");
       this.validContent(
         "session",
         request.session.content,
         "",
-        this.sessionConfig
+        this.sessionConfig,
+        logger
       );
     }
   }
-  validContent(type, params, baseKey, config) {
+  validContent(type, params, baseKey, config, logger) {
     if (config.whitelist) {
       const paramsKeys = Object.keys(params);
       const rulesKeys = Object.keys(config.rules);
@@ -286,7 +287,7 @@ var Validator = class {
       let value = params[key];
       if (rule.default) {
         if (type === "cookie" || type === "session")
-          this.logger.warn("Cookie and Session not support default rule.");
+          logger.warn("Cookie and Session not support default rule.");
         else if (typeof value === "undefined" && rule.default) {
           value = typeof rule.default === "function" ? rule.default(this.request) : rule.default;
           params[key] = value;
@@ -310,7 +311,7 @@ var Validator = class {
       if (typeof value !== "undefined" && value !== null) {
         if (rule.type)
           if (type === "cookie")
-            this.logger.warn("Cookie not support type rule");
+            logger.warn("Cookie not support type rule");
           else {
             let typed = true;
             switch (rule.type) {
@@ -372,21 +373,23 @@ var Validator = class {
         }
         if (rule.config) {
           if (type === "cookie")
-            this.logger.warn("Cookie not support nest rule.");
+            logger.warn("Cookie not support nest rule.");
           else if (Array.isArray(value))
             for (const val of value)
               this.validContent(
                 type,
                 val,
                 baseKey ? `${baseKey}.${key}.` : `${key}.`,
-                rule.config
+                rule.config,
+                logger
               );
           else if (typeof value === "object")
             this.validContent(
               type,
               value,
               baseKey ? `${baseKey}.${key}.` : `${key}.`,
-              rule.config
+              rule.config,
+              logger
             );
         }
       }
@@ -427,7 +430,6 @@ var Http = class {
     this.config = (config == null ? void 0 : config.config) || /* @__PURE__ */ Object.create(null);
     if (config == null ? void 0 : config.validator)
       this.validatorOptions = config.validator;
-    this.logger = new import_logger.Logger(this.name);
     this.headers = /* @__PURE__ */ Object.create(null);
     this.cookie = new Cookie(this.config.cookie || {});
     this.session = this.cookie.session;
@@ -436,8 +438,9 @@ var Http = class {
     var _a;
     data.dependencies["@faasjs/http"] = "*";
     await next();
-    this.logger.debug("\u7EC4\u88C5\u7F51\u5173\u914D\u7F6E");
-    this.logger.debug("%j", data);
+    const logger = new import_logger.Logger(this.name);
+    logger.debug("Generate api gateway's config");
+    logger.debug("%j", data);
     const config = data.config.plugins ? deepMerge(data.config.plugins[this.name || this.type], { config: this.config }) : { config: this.config };
     if (!config.config.path) {
       config.config.path = "/" + ((_a = data.name) == null ? void 0 : _a.replace(/_/g, "/").replace(/\/index$/, ""));
@@ -449,21 +452,21 @@ var Http = class {
           config.config.path = "/";
       }
     }
-    this.logger.debug("\u7EC4\u88C5\u5B8C\u6210 %j", config);
+    logger.debug("Api gateway's config: %j", config);
     const Provider = require(config.provider.type).Provider;
     const provider = new Provider(config.provider.config);
     await provider.deploy(this.type, data, config);
   }
   async onMount(data, next) {
-    this.logger.debug("[onMount] merge config");
+    data.logger.debug("[onMount] merge config");
     if (data.config.plugins && data.config.plugins[this.name || this.type])
       this.config = deepMerge(this.config, data.config.plugins[this.name || this.type].config);
-    this.logger.debug("[onMount] prepare cookie & session");
+    data.logger.debug("[onMount] prepare cookie & session");
     this.cookie = new Cookie(this.config.cookie || {});
     this.session = this.cookie.session;
     if (this.validatorOptions) {
-      this.logger.debug("[onMount] prepare validator");
-      this.validator = new Validator(this.validatorOptions, this.logger);
+      data.logger.debug("[onMount] prepare validator");
+      this.validator = new Validator(this.validatorOptions);
     }
     await next();
   }
@@ -475,32 +478,32 @@ var Http = class {
     this.response = { headers: /* @__PURE__ */ Object.create(null) };
     if (data.event.body) {
       if (data.event.headers && data.event.headers["content-type"] && data.event.headers["content-type"].includes("application/json")) {
-        this.logger.debug("[onInvoke] Parse params from json body");
+        data.logger.debug("[onInvoke] Parse params from json body");
         this.params = JSON.parse(data.event.body);
       } else {
-        this.logger.debug("[onInvoke] Parse params from raw body");
+        data.logger.debug("[onInvoke] Parse params from raw body");
         this.params = data.event.body;
       }
-      this.logger.debug("[onInvoke] Params: %j", this.params);
+      data.logger.debug("[onInvoke] Params: %j", this.params);
     } else if (data.event.queryString) {
-      this.logger.debug("[onInvoke] Parse params from queryString");
+      data.logger.debug("[onInvoke] Parse params from queryString");
       this.params = data.event.queryString;
-      this.logger.debug("[onInvoke] Params: %j", this.params);
+      data.logger.debug("[onInvoke] Params: %j", this.params);
     }
     this.cookie.invoke(this.headers.cookie);
     if (this.headers.cookie) {
-      this.logger.debug("[onInvoke] Cookie: %j", this.cookie.content);
-      this.logger.debug("[onInvoke] Session: %j", this.session.content);
+      data.logger.debug("[onInvoke] Cookie: %j", this.cookie.content);
+      data.logger.debug("[onInvoke] Session: %j", this.session.content);
     }
     try {
       if (this.validator) {
-        this.logger.debug("[onInvoke] Valid request");
+        data.logger.debug("[onInvoke] Valid request");
         await this.validator.valid({
           headers: this.headers,
           params: this.params,
           cookie: this.cookie,
           session: this.session
-        });
+        }, data.logger);
       }
       await next();
     } catch (error) {
@@ -509,7 +512,7 @@ var Http = class {
     this.session.update();
     if (data.response)
       if (data.response instanceof Error || ((_a = data.response.constructor) == null ? void 0 : _a.name) === "Error") {
-        this.logger.error(data.response);
+        data.logger.error(data.response);
         this.response.body = JSON.stringify({ error: { message: data.response.message } });
         try {
           this.response.statusCode = data.response.statusCode || 500;
@@ -530,7 +533,7 @@ var Http = class {
     const originBody = data.response.body;
     data.response.originBody = originBody;
     if (process.env.FaasMode === "local") {
-      this.logger.debug("[onInvoke] Response: %j", data.response);
+      data.logger.debug("[onInvoke] Response: %j", data.response);
       return;
     }
     if (data.response.isBase64Encoded || typeof data.response.body !== "string" || !((_b = data.response.headers["Content-Type"]) == null ? void 0 : _b.includes("json")) || data.response.body.length < 100)

package/dist/index.mjs

@@ -202,14 +202,13 @@ var Cookie = class {
 
 // src/validator.ts
 var Validator = class {
-  constructor(config, logger) {
+  constructor(config) {
     this.paramsConfig = config.params;
     this.cookieConfig = config.cookie;
     this.sessionConfig = config.session;
     this.before = config.before;
-    this.logger = logger;
   }
-  async valid(request) {
+  async valid(request, logger) {
     if (this.before) {
       const result = await this.before(request);
       if (result)
@@ -217,33 +216,35 @@ var Validator = class {
     }
     this.request = request;
     if (this.paramsConfig && request.params) {
-      this.logger.debug("Valid Params");
-      this.validContent("params", request.params, "", this.paramsConfig);
+      logger.debug("Valid Params");
+      this.validContent("params", request.params, "", this.paramsConfig, logger);
     }
     if (this.cookieConfig && request.cookie) {
-      this.logger.debug("Valid Cookie");
+      logger.debug("Valid Cookie");
       if (request.cookie == null)
         throw Error("Not found Cookie");
       this.validContent(
         "cookie",
         request.cookie.content,
         "",
-        this.cookieConfig
+        this.cookieConfig,
+        logger
       );
     }
     if (this.sessionConfig && request.session) {
-      this.logger.debug("Valid Session");
+      logger.debug("Valid Session");
       if (request.session == null)
         throw Error("Not found Session");
       this.validContent(
         "session",
         request.session.content,
         "",
-        this.sessionConfig
+        this.sessionConfig,
+        logger
       );
     }
   }
-  validContent(type, params, baseKey, config) {
+  validContent(type, params, baseKey, config, logger) {
     if (config.whitelist) {
       const paramsKeys = Object.keys(params);
       const rulesKeys = Object.keys(config.rules);
@@ -272,7 +273,7 @@ var Validator = class {
       let value = params[key];
       if (rule.default) {
         if (type === "cookie" || type === "session")
-          this.logger.warn("Cookie and Session not support default rule.");
+          logger.warn("Cookie and Session not support default rule.");
         else if (typeof value === "undefined" && rule.default) {
           value = typeof rule.default === "function" ? rule.default(this.request) : rule.default;
           params[key] = value;
@@ -296,7 +297,7 @@ var Validator = class {
       if (typeof value !== "undefined" && value !== null) {
         if (rule.type)
           if (type === "cookie")
-            this.logger.warn("Cookie not support type rule");
+            logger.warn("Cookie not support type rule");
           else {
             let typed = true;
             switch (rule.type) {
@@ -358,21 +359,23 @@ var Validator = class {
         }
         if (rule.config) {
           if (type === "cookie")
-            this.logger.warn("Cookie not support nest rule.");
+            logger.warn("Cookie not support nest rule.");
           else if (Array.isArray(value))
             for (const val of value)
               this.validContent(
                 type,
                 val,
                 baseKey ? `${baseKey}.${key}.` : `${key}.`,
-                rule.config
+                rule.config,
+                logger
               );
           else if (typeof value === "object")
             this.validContent(
               type,
               value,
               baseKey ? `${baseKey}.${key}.` : `${key}.`,
-              rule.config
+              rule.config,
+              logger
             );
         }
       }
@@ -417,7 +420,6 @@ var Http = class {
     this.config = (config == null ? void 0 : config.config) || /* @__PURE__ */ Object.create(null);
     if (config == null ? void 0 : config.validator)
       this.validatorOptions = config.validator;
-    this.logger = new Logger(this.name);
     this.headers = /* @__PURE__ */ Object.create(null);
     this.cookie = new Cookie(this.config.cookie || {});
     this.session = this.cookie.session;
@@ -426,8 +428,9 @@ var Http = class {
     var _a;
     data.dependencies["@faasjs/http"] = "*";
     await next();
-    this.logger.debug("\u7EC4\u88C5\u7F51\u5173\u914D\u7F6E");
-    this.logger.debug("%j", data);
+    const logger = new Logger(this.name);
+    logger.debug("Generate api gateway's config");
+    logger.debug("%j", data);
     const config = data.config.plugins ? deepMerge(data.config.plugins[this.name || this.type], { config: this.config }) : { config: this.config };
     if (!config.config.path) {
       config.config.path = "/" + ((_a = data.name) == null ? void 0 : _a.replace(/_/g, "/").replace(/\/index$/, ""));
@@ -439,21 +442,21 @@ var Http = class {
           config.config.path = "/";
       }
     }
-    this.logger.debug("\u7EC4\u88C5\u5B8C\u6210 %j", config);
+    logger.debug("Api gateway's config: %j", config);
     const Provider = __require(config.provider.type).Provider;
     const provider = new Provider(config.provider.config);
     await provider.deploy(this.type, data, config);
   }
   async onMount(data, next) {
-    this.logger.debug("[onMount] merge config");
+    data.logger.debug("[onMount] merge config");
     if (data.config.plugins && data.config.plugins[this.name || this.type])
       this.config = deepMerge(this.config, data.config.plugins[this.name || this.type].config);
-    this.logger.debug("[onMount] prepare cookie & session");
+    data.logger.debug("[onMount] prepare cookie & session");
     this.cookie = new Cookie(this.config.cookie || {});
     this.session = this.cookie.session;
     if (this.validatorOptions) {
-      this.logger.debug("[onMount] prepare validator");
-      this.validator = new Validator(this.validatorOptions, this.logger);
+      data.logger.debug("[onMount] prepare validator");
+      this.validator = new Validator(this.validatorOptions);
     }
     await next();
   }
@@ -465,32 +468,32 @@ var Http = class {
     this.response = { headers: /* @__PURE__ */ Object.create(null) };
     if (data.event.body) {
       if (data.event.headers && data.event.headers["content-type"] && data.event.headers["content-type"].includes("application/json")) {
-        this.logger.debug("[onInvoke] Parse params from json body");
+        data.logger.debug("[onInvoke] Parse params from json body");
         this.params = JSON.parse(data.event.body);
       } else {
-        this.logger.debug("[onInvoke] Parse params from raw body");
+        data.logger.debug("[onInvoke] Parse params from raw body");
         this.params = data.event.body;
       }
-      this.logger.debug("[onInvoke] Params: %j", this.params);
+      data.logger.debug("[onInvoke] Params: %j", this.params);
     } else if (data.event.queryString) {
-      this.logger.debug("[onInvoke] Parse params from queryString");
+      data.logger.debug("[onInvoke] Parse params from queryString");
       this.params = data.event.queryString;
-      this.logger.debug("[onInvoke] Params: %j", this.params);
+      data.logger.debug("[onInvoke] Params: %j", this.params);
     }
     this.cookie.invoke(this.headers.cookie);
     if (this.headers.cookie) {
-      this.logger.debug("[onInvoke] Cookie: %j", this.cookie.content);
-      this.logger.debug("[onInvoke] Session: %j", this.session.content);
+      data.logger.debug("[onInvoke] Cookie: %j", this.cookie.content);
+      data.logger.debug("[onInvoke] Session: %j", this.session.content);
     }
     try {
       if (this.validator) {
-        this.logger.debug("[onInvoke] Valid request");
+        data.logger.debug("[onInvoke] Valid request");
         await this.validator.valid({
           headers: this.headers,
           params: this.params,
           cookie: this.cookie,
           session: this.session
-        });
+        }, data.logger);
       }
       await next();
     } catch (error) {
@@ -499,7 +502,7 @@ var Http = class {
     this.session.update();
     if (data.response)
       if (data.response instanceof Error || ((_a = data.response.constructor) == null ? void 0 : _a.name) === "Error") {
-        this.logger.error(data.response);
+        data.logger.error(data.response);
         this.response.body = JSON.stringify({ error: { message: data.response.message } });
         try {
           this.response.statusCode = data.response.statusCode || 500;
@@ -520,7 +523,7 @@ var Http = class {
     const originBody = data.response.body;
     data.response.originBody = originBody;
     if (process.env.FaasMode === "local") {
-      this.logger.debug("[onInvoke] Response: %j", data.response);
+      data.logger.debug("[onInvoke] Response: %j", data.response);
       return;
     }
     if (data.response.isBase64Encoded || typeof data.response.body !== "string" || !((_b = data.response.headers["Content-Type"]) == null ? void 0 : _b.includes("json")) || data.response.body.length < 100)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/http",
-  "version": "0.0.2-beta.399",
+  "version": "0.0.2-beta.401",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,14 +22,15 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/func": "^0.0.2-beta.399",
-    "@faasjs/logger": "^0.0.2-beta.399"
+    "@faasjs/func": "^0.0.2-beta.401",
+    "@faasjs/logger": "^0.0.2-beta.401"
   },
   "devDependencies": {
     "tsup": "*",
     "typescript": "*"
   },
   "engines": {
-    "npm": ">=8.0.0"
+    "npm": ">=8.0.0",
+    "node": ">=16.0.0"
   }
 }