@faasjs/http 0.0.2-beta.39 → 0.0.2-beta.390

package/README.md

@@ -1,9 +1,221 @@
 # @faasjs/http
 
-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)
 
-https://faasjs.com/doc/http.html
+FaasJS's http plugin.
+
+## Install
+
+    npm install @faasjs/http
+
+## Modules
+
+### Classes
+
+- [Cookie](classes/Cookie.md)
+- [Http](classes/Http.md)
+- [HttpError](classes/HttpError.md)
+- [Session](classes/Session.md)
+- [Validator](classes/Validator.md)
+
+### Type aliases
+
+- [CookieOptions](#cookieoptions)
+- [HttpConfig](#httpconfig)
+- [Response](#response)
+- [SessionOptions](#sessionoptions)
+- [ValidatorConfig](#validatorconfig)
+- [ValidatorOptions](#validatoroptions)
+- [ValidatorRuleOptions](#validatorruleoptions)
+
+### Variables
+
+- [ContentType](#contenttype)
+
+### Functions
+
+- [useHttp](#usehttp)
+
+## Type aliases
+
+### CookieOptions
+
+Ƭ **CookieOptions**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `domain?` | `string` |
+| `expires?` | `number` |
+| `httpOnly?` | `boolean` |
+| `path?` | `string` |
+| `sameSite?` | ``"Strict"`` \| ``"Lax"`` \| ``"None"`` |
+| `secure?` | `boolean` |
+| `session?` | [`SessionOptions`](#sessionoptions) |
+
+___
+
+### HttpConfig
+
+Ƭ **HttpConfig**<`TParams`, `TCookie`, `TSession`\>: `Object`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TParams` | extends `Record`<`string`, `any`\> = `any` |
+| `TCookie` | extends `Record`<`string`, `string`\> = `any` |
+| `TSession` | extends `Record`<`string`, `string`\> = `any` |
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `config?` | { `[key: string]`: `any`; `cookie?`: [`CookieOptions`](#cookieoptions) ; `functionName?`: `string` ; `ignorePathPrefix?`: `string` ; `method?`: ``"BEGIN"`` \| ``"GET"`` \| ``"POST"`` \| ``"DELETE"`` \| ``"HEAD"`` \| ``"PUT"`` \| ``"OPTIONS"`` \| ``"TRACE"`` \| ``"PATCH"`` \| ``"ANY"`` ; `path?`: `string` ; `timeout?`: `number`  } |
+| `config.cookie?` | [`CookieOptions`](#cookieoptions) |
+| `config.functionName?` | `string` |
+| `config.ignorePathPrefix?` | `string` |
+| `config.method?` | ``"BEGIN"`` \| ``"GET"`` \| ``"POST"`` \| ``"DELETE"`` \| ``"HEAD"`` \| ``"PUT"`` \| ``"OPTIONS"`` \| ``"TRACE"`` \| ``"PATCH"`` \| ``"ANY"`` |
+| `config.path?` | `string` |
+| `config.timeout?` | `number` |
+| `name?` | `string` |
+| `validator?` | [`ValidatorConfig`](#validatorconfig)<`TParams`, `TCookie`, `TSession`\> |
+
+___
+
+### Response
+
+Ƭ **Response**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `body?` | `string` |
+| `headers?` | { `[key: string]`: `string`;  } |
+| `message?` | `string` |
+| `statusCode?` | `number` |
+
+___
+
+### SessionOptions
+
+Ƭ **SessionOptions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `cipherName?` | `string` |
+| `digest?` | `string` |
+| `iterations?` | `number` |
+| `key` | `string` |
+| `keylen?` | `number` |
+| `salt?` | `string` |
+| `secret` | `string` |
+| `signedSalt?` | `string` |
+
+___
+
+### ValidatorConfig
+
+Ƭ **ValidatorConfig**<`TParams`, `TCookie`, `TSession`\>: `Object`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TParams` | extends `Record`<`string`, `any`\> = `any` |
+| `TCookie` | extends `Record`<`string`, `string`\> = `any` |
+| `TSession` | extends `Record`<`string`, `string`\> = `any` |
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `before?` | `BeforeOption` |
+| `cookie?` | [`ValidatorOptions`](#validatoroptions)<`TCookie`\> |
+| `params?` | [`ValidatorOptions`](#validatoroptions)<`TParams`\> |
+| `session?` | [`ValidatorOptions`](#validatoroptions)<`TSession`\> |
+
+___
+
+### ValidatorOptions
+
+Ƭ **ValidatorOptions**<`Content`\>: `Object`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Content` | `Record`<`string`, `any`\> |
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `rules` | { [k in keyof Content]?: ValidatorRuleOptions } |
+| `whitelist?` | ``"error"`` \| ``"ignore"`` |
+| `onError?` | (`type`: `string`, `key`: `string` \| `string`[], `value?`: `any`) => `void` \| { `message`: `any` ; `statusCode?`: `number`  } |
+
+___
+
+### ValidatorRuleOptions
+
+Ƭ **ValidatorRuleOptions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `config?` | `Partial`<[`ValidatorOptions`](#validatoroptions)\> |
+| `default?` | `any` |
+| `in?` | `any`[] |
+| `regexp?` | `RegExp` |
+| `required?` | `boolean` |
+| `type?` | `ValidatorRuleOptionsType` |
+
+## Variables
+
+### ContentType
+
+• `Const` **ContentType**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+## Functions
+
+### useHttp
+
+▸ **useHttp**<`TParams`, `TCookie`, `TSession`\>(`config?`): [`Http`](classes/Http.md)<`TParams`, `TCookie`, `TSession`\> & `UseifyPlugin`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TParams` | extends `Record`<`string`, `any`\> = `any` |
+| `TCookie` | extends `Record`<`string`, `string`\> = `any` |
+| `TSession` | extends `Record`<`string`, `string`\> = `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `config?` | [`HttpConfig`](#httpconfig)<`TParams`, `TCookie`, `TSession`\> |
+
+#### Returns
+
+[`Http`](classes/Http.md)<`TParams`, `TCookie`, `TSession`\> & `UseifyPlugin`

package/dist/index.d.ts

@@ -0,0 +1,238 @@
+import { Plugin, DeployData, Next, MountData, InvokeData, UseifyPlugin } from '@faasjs/func';
+import { Logger } from '@faasjs/logger';
+
+declare type SessionOptions = {
+    key: string;
+    secret: string;
+    salt?: string;
+    signedSalt?: string;
+    keylen?: number;
+    iterations?: number;
+    digest?: string;
+    cipherName?: string;
+};
+declare 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>;
+}
+
+declare 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[];
+    };
+}
+
+declare type ValidatorRuleOptionsType = 'string' | 'number' | 'boolean' | 'object' | 'array';
+declare type ValidatorRuleOptions = {
+    type?: ValidatorRuleOptionsType;
+    required?: boolean;
+    in?: any[];
+    default?: any;
+    config?: Partial<ValidatorOptions>;
+    regexp?: RegExp;
+};
+declare 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;
+};
+declare 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>;
+};
+declare 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;
+}>;
+declare 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;
+    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>;
+    validContent(type: string, params: {
+        [key: string]: any;
+    }, baseKey: string, config: ValidatorOptions): void;
+}
+
+declare const ContentType: {
+    [key: string]: string;
+};
+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?: {
+        [key: string]: any;
+        method?: 'BEGIN' | 'GET' | 'POST' | 'DELETE' | 'HEAD' | 'PUT' | 'OPTIONS' | 'TRACE' | 'PATCH' | 'ANY';
+        timeout?: number;
+        path?: string;
+        ignorePathPrefix?: string;
+        functionName?: string;
+        cookie?: CookieOptions;
+    };
+    validator?: ValidatorConfig<TParams, TCookie, TSession>;
+};
+declare 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?;
+    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
+     * @param key {string} key
+     * @param value {*} value
+     */
+    setHeader(key: string, value: string): Http<TParams, TCookie, TSession>;
+    /**
+     * 设置 Content-Type
+     * @param type {string} 类型
+     * @param charset {string} 编码
+     */
+    setContentType(type: string, charset?: string): Http<TParams, TCookie, TSession>;
+    /**
+     * 设置状态码
+     * @param code {number} 状态码
+     */
+    setStatusCode(code: number): Http<TParams, TCookie, TSession>;
+    /**
+     * 设置 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>): Http<TParams, TCookie, TSession> & UseifyPlugin;
+
+export { ContentType, Cookie, CookieOptions, Http, HttpConfig, HttpError, Response, Session, SessionOptions, Validator, ValidatorConfig, ValidatorOptions, ValidatorRuleOptions, useHttp };