@faasjs/http 0.0.2-beta.3 → 0.0.2-beta.302

package/README.md

@@ -2,7 +2,7 @@
 
 http 插件
 
-[![License: MIT](https://img.shields.io/npm/l/@faasjs/http.svg)](https://github.com/faasjs/faasjs/blob/master/packages/faasjs/http/LICENSE)
+[![License: MIT](https://img.shields.io/npm/l/@faasjs/http.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/http/LICENSE)
 [![NPM Stable Version](https://img.shields.io/npm/v/@faasjs/http/stable.svg)](https://www.npmjs.com/package/@faasjs/http)
 [![NPM Beta Version](https://img.shields.io/npm/v/@faasjs/http/beta.svg)](https://www.npmjs.com/package/@faasjs/http)
 

package/lib/cookie.d.ts

@@ -1,5 +1,5 @@
 import { Session, SessionOptions } from './session';
-export interface CookieOptions {
+export declare type CookieOptions = {
     domain?: string;
     path?: string;
     expires?: number;
@@ -8,12 +8,10 @@ export interface CookieOptions {
     sameSite?: 'Strict' | 'Lax' | 'None';
     session?: SessionOptions;
     [key: string]: any;
-}
-export declare class Cookie {
-    session: Session;
-    content: {
-        [key: string]: any;
-    };
+};
+export 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;
@@ -25,19 +23,17 @@ export declare class Cookie {
     };
     private setCookie;
     constructor(config: CookieOptions);
-    invoke(cookie: string | undefined): this;
+    invoke(cookie: string | undefined): Cookie<C, S>;
     read(key: string): any;
-    write(key: string, value: any, opts?: {
+    write(key: string, value: string, opts?: {
         domain?: string;
         path?: string;
         expires?: number | string;
         secure?: boolean;
         httpOnly?: boolean;
         sameSite?: 'Strict' | 'Lax' | 'None';
-    }): this;
+    }): Cookie<C, S>;
     headers(): {
-        'Set-Cookie'?: undefined;
-    } | {
-        'Set-Cookie': string[];
+        'Set-Cookie'?: string[];
     };
 }

package/lib/index.d.ts

@@ -1,59 +1,65 @@
-import { Plugin, InvokeData, MountData, DeployData, Next } from '@faasjs/func';
+import { Plugin, InvokeData, MountData, DeployData, Next, UseifyPlugin } from '@faasjs/func';
 import { Cookie, CookieOptions } from './cookie';
 import { Session, SessionOptions } from './session';
-import { Validator, ValidatorOptions, ValidatorRuleOptions } from './validator';
-export { Cookie, CookieOptions, Session, SessionOptions, Validator, ValidatorOptions, ValidatorRuleOptions };
+import { Validator, ValidatorOptions, ValidatorRuleOptions, ValidatorConfig } from './validator';
+export { Cookie, CookieOptions, Session, SessionOptions, Validator, ValidatorConfig, ValidatorOptions, ValidatorRuleOptions };
 export declare const ContentType: {
     [key: string]: string;
 };
-export interface HttpConfig {
+export declare 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?: {
-        method?: string;
+        [key: string]: any;
+        method?: 'BEGIN' | 'GET' | 'POST' | 'DELETE' | 'HEAD' | 'PUT' | 'OPTIONS' | 'TRACE' | 'PATCH' | 'ANY';
         timeout?: number;
+        path?: string;
+        ignorePathPrefix?: string;
         functionName?: string;
         cookie?: CookieOptions;
-        [key: string]: any;
     };
-    validator?: {
-        params?: ValidatorOptions;
-        cookie?: ValidatorOptions;
-        session?: ValidatorOptions;
-    };
-    [key: string]: any;
-}
-export interface Response {
+    validator?: ValidatorConfig<TParams, TCookie, TSession>;
+};
+export declare type Response = {
     statusCode?: number;
-    headers: {
-        [key: string]: any;
+    headers?: {
+        [key: string]: string;
     };
     body?: string;
+    message?: string;
+};
+export declare class HttpError extends Error {
+    readonly statusCode: number;
+    readonly message: string;
+    constructor({ statusCode, message }: {
+        statusCode?: number;
+        message: string;
+    });
 }
-export declare class Http implements Plugin {
+export 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;
-    name?: string;
+    readonly name: string;
     headers: {
         [key: string]: string;
     };
-    params: any;
-    cookie: Cookie;
-    session: Session;
-    config: {
-        method?: number;
-        timeout?: number;
-        functionName?: string;
-        cookie?: CookieOptions;
-        [key: string]: any;
-    };
-    private validatorOptions?;
+    body: any;
+    params: TParams;
+    cookie: Cookie<TCookie, TSession>;
+    session: Session<TSession, TCookie>;
+    config: HttpConfig<TParams, TCookie, TSession>;
+    private readonly validatorOptions?;
     private response?;
     private validator?;
-    private logger;
+    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} 白名单配置
@@ -67,8 +73,9 @@ export declare class Http implements Plugin {
      * @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);
+    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>;
@@ -77,21 +84,22 @@ export declare class Http implements Plugin {
      * @param key {string} key
      * @param value {*} value
      */
-    setHeader(key: string, value: any): this;
+    setHeader(key: string, value: string): Http<TParams, TCookie, TSession>;
     /**
      * 设置 Content-Type
      * @param type {string} 类型
      * @param charset {string} 编码
      */
-    setContentType(type: string, charset?: string): this;
+    setContentType(type: string, charset?: string): Http<TParams, TCookie, TSession>;
     /**
      * 设置状态码
      * @param code {number} 状态码
      */
-    setStatusCode(code: number): this;
+    setStatusCode(code: number): Http<TParams, TCookie, TSession>;
     /**
      * 设置 body
      * @param body {*} 内容
      */
-    setBody(body: string): this;
+    setBody(body: string): Http<TParams, TCookie, TSession>;
 }
+export 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>): Http<TParams, TCookie, TSession> & UseifyPlugin;