@faasjs/http 0.0.3-beta.86 → 0.0.3-beta.87

package/dist/index.d.mts

@@ -0,0 +1,209 @@
+import { Plugin, DeployData, Next, MountData, InvokeData, UseifyPlugin } from '@faasjs/func';
+import { Logger } from '@faasjs/logger';
+
+type SessionOptions = {
+    key: string;
+    secret: string;
+    salt?: string;
+    signedSalt?: string;
+    keylen?: number;
+    iterations?: number;
+    digest?: string;
+    cipherName?: string;
+};
+type SessionContent = string | number | {
+    [key: string]: any;
+} | null | undefined;
+declare class Session<S extends Record<string, string> = any, C extends Record<string, string> = any> {
+    content: Record<string, string | number>;
+    readonly config: {
+        key: string;
+        secret: string;
+        salt: string;
+        signedSalt: string;
+        keylen: number;
+        iterations: number;
+        digest: string;
+        cipherName: string;
+    };
+    private readonly secret;
+    private readonly signedSecret;
+    private readonly cookie;
+    private changed?;
+    constructor(cookie: Cookie<C, S>, config: SessionOptions);
+    invoke(cookie?: string): void;
+    encode(text: SessionContent): string;
+    decode<TData = any>(text: string): TData | SessionContent;
+    read(key: string): string | number;
+    write(key: string, value?: string | number | null): Session<S, C>;
+    update(): Session<S, C>;
+}
+
+type CookieOptions = {
+    domain?: string;
+    path?: string;
+    expires?: number;
+    secure?: boolean;
+    httpOnly?: boolean;
+    sameSite?: 'Strict' | 'Lax' | 'None';
+    session?: SessionOptions;
+    [key: string]: any;
+};
+declare class Cookie<C extends Record<string, string> = any, S extends Record<string, string> = any> {
+    session: Session<S, C>;
+    content: Record<string, string>;
+    readonly config: {
+        domain?: string;
+        path: string;
+        expires: number;
+        secure: boolean;
+        httpOnly: boolean;
+        sameSite?: 'Strict' | 'Lax' | 'None';
+        session: SessionOptions;
+    };
+    private setCookie;
+    constructor(config: CookieOptions);
+    invoke(cookie: string | undefined): Cookie<C, S>;
+    read(key: string): any;
+    write(key: string, value: string, opts?: {
+        domain?: string;
+        path?: string;
+        expires?: number | string;
+        secure?: boolean;
+        httpOnly?: boolean;
+        sameSite?: 'Strict' | 'Lax' | 'None';
+    }): Cookie<C, S>;
+    headers(): {
+        'Set-Cookie'?: string[];
+    };
+}
+
+type ValidatorRuleOptionsType = 'string' | 'number' | 'boolean' | 'object' | 'array';
+type ValidatorRuleOptions = {
+    type?: ValidatorRuleOptionsType;
+    required?: boolean;
+    in?: any[];
+    default?: any;
+    config?: Partial<ValidatorOptions>;
+    regexp?: RegExp;
+};
+type ValidatorOptions<Content = Record<string, any>> = {
+    whitelist?: 'error' | 'ignore';
+    rules: {
+        [k in keyof Content]?: ValidatorRuleOptions;
+    };
+    onError?: (type: string, key: string | string[], value?: any) => {
+        statusCode?: number;
+        message: any;
+    } | void;
+};
+type Request<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> = {
+    headers: {
+        [key: string]: string;
+    };
+    params?: TParams;
+    cookie?: Cookie<TCookie, TSession>;
+    session?: Session<TSession, TCookie>;
+};
+type BeforeOption<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> = (request: Request<TParams, TCookie, TSession>) => Promise<void | {
+    statusCode?: number;
+    message: string;
+}>;
+type ValidatorConfig<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> = {
+    params?: ValidatorOptions<TParams>;
+    cookie?: ValidatorOptions<TCookie>;
+    session?: ValidatorOptions<TSession>;
+    before?: BeforeOption;
+};
+declare class Validator<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> {
+    before?: BeforeOption<TParams, TCookie, TSession>;
+    paramsConfig?: ValidatorOptions<TParams>;
+    cookieConfig?: ValidatorOptions<TCookie>;
+    sessionConfig?: ValidatorOptions<TSession>;
+    private request;
+    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, logger: Logger): void;
+}
+
+declare const ContentType: {
+    [key: string]: string;
+};
+type HttpConfig<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> = {
+    [key: string]: any;
+    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;
+        cookie?: CookieOptions;
+    };
+    validator?: ValidatorConfig<TParams, TCookie, TSession>;
+};
+type Response = {
+    statusCode?: number;
+    headers?: {
+        [key: string]: string;
+    };
+    body?: string;
+    message?: string;
+};
+declare class HttpError extends Error {
+    readonly statusCode: number;
+    readonly message: string;
+    constructor({ statusCode, message }: {
+        statusCode?: number;
+        message: string;
+    });
+}
+declare class Http<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> implements Plugin {
+    readonly type: string;
+    readonly name: string;
+    headers: {
+        [key: string]: string;
+    };
+    body: any;
+    params: TParams;
+    cookie: Cookie<TCookie, TSession>;
+    session: Session<TSession, TCookie>;
+    config: HttpConfig<TParams, TCookie, TSession>;
+    private readonly validatorOptions?;
+    private response?;
+    private validator?;
+    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>;
+    /**
+     * set header
+     * @param key {string} key
+     * @param value {*} value
+     */
+    setHeader(key: string, value: string): Http<TParams, TCookie, TSession>;
+    /**
+     * 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>;
+    /**
+     * set body
+     * @param body {*} 内容
+     */
+    setBody(body: string): Http<TParams, TCookie, TSession>;
+}
+declare function useHttp<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any>(config?: HttpConfig<TParams, TCookie, TSession>): UseifyPlugin<Http<TParams, TCookie, TSession>>;
+
+export { ContentType, Cookie, CookieOptions, Http, HttpConfig, HttpError, Response, Session, SessionOptions, Validator, ValidatorConfig, ValidatorOptions, ValidatorRuleOptions, useHttp };

package/dist/index.js

@@ -30,35 +30,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 var import_func = require("@faasjs/func");
-
-// ../deep_merge/src/index.ts
-var shouldMerge = function(item) {
-  const type = Object.prototype.toString.call(item);
-  return type === "[object Object]" || type === "[object Array]";
-};
-function deepMerge(...sources) {
-  let acc = /* @__PURE__ */ Object.create(null);
-  for (const source of sources)
-    if (source instanceof Array) {
-      if (!(acc instanceof Array))
-        acc = [];
-      acc = [...new Set(source.concat(...acc))];
-    } else if (shouldMerge(source))
-      for (const [key, value] of Object.entries(source)) {
-        let val;
-        if (shouldMerge(value))
-          val = deepMerge(acc[key], value);
-        else
-          val = value;
-        acc = {
-          ...acc,
-          [key]: val
-        };
-      }
-  return acc;
-}
-
-// src/index.ts
+var import_deep_merge2 = require("@faasjs/deep_merge");
 var import_logger = require("@faasjs/logger");
 
 // src/session.ts
@@ -152,9 +124,10 @@ var Session = class {
 };
 
 // src/cookie.ts
+var import_deep_merge = require("@faasjs/deep_merge");
 var Cookie = class {
   constructor(config) {
-    this.config = deepMerge({
+    this.config = (0, import_deep_merge.deepMerge)({
       path: "/",
       expires: 31536e3,
       secure: true,
@@ -411,14 +384,14 @@ var ContentType = {
   json: "application/json",
   jsonp: "application/javascript"
 };
-var HttpError = class extends Error {
+var HttpError = class _HttpError extends Error {
   constructor({
     statusCode,
     message
   }) {
     super(message);
     if (Error.captureStackTrace)
-      Error.captureStackTrace(this, HttpError);
+      Error.captureStackTrace(this, _HttpError);
     this.statusCode = statusCode || 500;
     this.message = message;
   }
@@ -440,7 +413,7 @@ var Http = class {
     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 };
+    const config = data.config.plugins ? (0, import_deep_merge2.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$/, ""));
       if (config.config.path === "/index")
@@ -476,7 +449,7 @@ var Http = class {
           this.config[key] = value;
       }
     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.config = (0, import_deep_merge2.deepMerge)(this.config, data.config.plugins[this.name || this.type].config);
     data.logger.debug("[onMount] prepare cookie & session");
     this.cookie = new Cookie(this.config.cookie || {});
     this.session = this.cookie.session;
@@ -572,10 +545,20 @@ var Http = class {
       delete data.response.headers["Content-Encoding"];
     }
   }
+  /**
+   * set header
+   * @param key {string} key
+   * @param value {*} value
+   */
   setHeader(key, value) {
     this.response.headers[key] = value;
     return this;
   }
+  /**
+   * set Content-Type
+   * @param type {string} 类型
+   * @param charset {string} 编码
+   */
   setContentType(type, charset = "utf-8") {
     if (ContentType[type])
       this.setHeader("Content-Type", `${ContentType[type]}; charset=${charset}`);
@@ -583,10 +566,18 @@ var Http = class {
       this.setHeader("Content-Type", `${type}; charset=${charset}`);
     return this;
   }
+  /**
+   * set status code
+   * @param code {number} 状态码
+   */
   setStatusCode(code) {
     this.response.statusCode = code;
     return this;
   }
+  /**
+   * set body
+   * @param body {*} 内容
+   */
   setBody(body) {
     this.response.body = body;
     return this;

package/dist/index.mjs

@@ -3,42 +3,14 @@ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require
 }) : x)(function(x) {
   if (typeof require !== "undefined")
     return require.apply(this, arguments);
-  throw new Error('Dynamic require of "' + x + '" is not supported');
+  throw Error('Dynamic require of "' + x + '" is not supported');
 });
 
 // src/index.ts
 import {
   usePlugin
 } from "@faasjs/func";
-
-// ../deep_merge/src/index.ts
-var shouldMerge = function(item) {
-  const type = Object.prototype.toString.call(item);
-  return type === "[object Object]" || type === "[object Array]";
-};
-function deepMerge(...sources) {
-  let acc = /* @__PURE__ */ Object.create(null);
-  for (const source of sources)
-    if (source instanceof Array) {
-      if (!(acc instanceof Array))
-        acc = [];
-      acc = [...new Set(source.concat(...acc))];
-    } else if (shouldMerge(source))
-      for (const [key, value] of Object.entries(source)) {
-        let val;
-        if (shouldMerge(value))
-          val = deepMerge(acc[key], value);
-        else
-          val = value;
-        acc = {
-          ...acc,
-          [key]: val
-        };
-      }
-  return acc;
-}
-
-// src/index.ts
+import { deepMerge as deepMerge2 } from "@faasjs/deep_merge";
 import { Logger } from "@faasjs/logger";
 
 // src/session.ts
@@ -138,6 +110,7 @@ var Session = class {
 };
 
 // src/cookie.ts
+import { deepMerge } from "@faasjs/deep_merge";
 var Cookie = class {
   constructor(config) {
     this.config = deepMerge({
@@ -401,14 +374,14 @@ var ContentType = {
   json: "application/json",
   jsonp: "application/javascript"
 };
-var HttpError = class extends Error {
+var HttpError = class _HttpError extends Error {
   constructor({
     statusCode,
     message
   }) {
     super(message);
     if (Error.captureStackTrace)
-      Error.captureStackTrace(this, HttpError);
+      Error.captureStackTrace(this, _HttpError);
     this.statusCode = statusCode || 500;
     this.message = message;
   }
@@ -430,7 +403,7 @@ var Http = class {
     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 };
+    const config = data.config.plugins ? deepMerge2(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$/, ""));
       if (config.config.path === "/index")
@@ -466,7 +439,7 @@ var Http = class {
           this.config[key] = value;
       }
     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.config = deepMerge2(this.config, data.config.plugins[this.name || this.type].config);
     data.logger.debug("[onMount] prepare cookie & session");
     this.cookie = new Cookie(this.config.cookie || {});
     this.session = this.cookie.session;
@@ -562,10 +535,20 @@ var Http = class {
       delete data.response.headers["Content-Encoding"];
     }
   }
+  /**
+   * set header
+   * @param key {string} key
+   * @param value {*} value
+   */
   setHeader(key, value) {
     this.response.headers[key] = value;
     return this;
   }
+  /**
+   * set Content-Type
+   * @param type {string} 类型
+   * @param charset {string} 编码
+   */
   setContentType(type, charset = "utf-8") {
     if (ContentType[type])
       this.setHeader("Content-Type", `${ContentType[type]}; charset=${charset}`);
@@ -573,10 +556,18 @@ var Http = class {
       this.setHeader("Content-Type", `${type}; charset=${charset}`);
     return this;
   }
+  /**
+   * set status code
+   * @param code {number} 状态码
+   */
   setStatusCode(code) {
     this.response.statusCode = code;
     return this;
   }
+  /**
+   * set body
+   * @param body {*} 内容
+   */
   setBody(body) {
     this.response.body = body;
     return this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/http",
-  "version": "0.0.3-beta.86",
+  "version": "0.0.3-beta.87",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,14 +16,14 @@
   },
   "funding": "https://github.com/sponsors/faasjs",
   "scripts": {
-    "build": "tsup-node src/index.ts --format esm,cjs --dts --clean"
+    "build": "tsup-node src/index.ts --config ../../tsup.config.json"
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@faasjs/func": "^0.0.3-beta.86",
-    "@faasjs/logger": "^0.0.3-beta.86"
+    "@faasjs/func": "^0.0.3-beta.87",
+    "@faasjs/logger": "^0.0.3-beta.87"
   },
   "engines": {
     "npm": ">=8.0.0",