@faasjs/http 8.0.0-beta.5 → 8.0.0-beta.7

package/dist/index.d.ts

@@ -1,164 +1,176 @@
-import { Plugin, MountData, Next, InvokeData, UseifyPlugin } from '@faasjs/func';
-import { Logger } from '@faasjs/logger';
+import { InvokeData, MountData, Next, Plugin, UseifyPlugin } from "@faasjs/func";
+import { Logger } from "@faasjs/logger";
 
+//#region src/session.d.ts
 type SessionOptions = {
-    key: string;
-    secret: string;
-    salt?: string;
-    signedSalt?: string;
-    keylen?: number;
-    iterations?: number;
-    digest?: string;
-    cipherName?: string;
+  key: string;
+  secret: string;
+  salt?: string;
+  signedSalt?: string;
+  keylen?: number;
+  iterations?: number;
+  digest?: string;
+  cipherName?: string;
 };
 type SessionContent = string | number | {
-    [key: string]: any;
+  [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, logger?: Logger): 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>;
+  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, logger?: Logger): 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>;
 }
-
+//#endregion
+//#region src/cookie.d.ts
 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;
+  };
+  logger: Logger | undefined;
+  private setCookie;
+  constructor(config: CookieOptions, logger?: Logger);
+  invoke(cookie: string | undefined, logger: Logger): Cookie<C, S>;
+  read(key: string): any;
+  write(key: string, value: string | null | undefined, opts?: {
     domain?: string;
     path?: string;
-    expires?: number;
+    expires?: number | string;
     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;
-    };
-    logger: Logger;
-    private setCookie;
-    constructor(config: CookieOptions, logger?: Logger);
-    invoke(cookie: string | undefined, logger: Logger): 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[];
-    };
+  }): Cookie<C, S>;
+  headers(): {
+    'Set-Cookie'?: string[];
+  };
 }
-
+//#endregion
+//#region src/index.d.ts
 declare const ContentType: {
-    [key: string]: string;
+  [key: string]: string;
 };
 type HttpConfig = {
-    [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;
-    };
+  [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;
+  };
 };
 type Response = {
-    statusCode?: number;
-    headers?: {
-        [key: string]: string;
-    };
-    body?: string | ReadableStream;
-    message?: string;
+  statusCode?: number;
+  headers?: {
+    [key: string]: string;
+  };
+  body?: string | ReadableStream;
+  message?: string;
 };
 declare class HttpError extends Error {
-    readonly statusCode: number;
-    readonly message: string;
-    constructor({ statusCode, message, }: {
-        statusCode?: number;
-        message: string;
-    });
+  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 = "http";
-    readonly name: string;
-    headers: {
-        [key: string]: string;
-    };
-    body: any;
-    params: TParams;
-    cookie: Cookie<TCookie, TSession>;
-    session: Session<TSession, TCookie>;
-    config: HttpConfig;
-    private response;
-    constructor(config?: HttpConfig);
-    onMount(data: MountData, next: Next): Promise<void>;
-    onInvoke(data: InvokeData, next: Next): Promise<void>;
-    /**
-     * set header
-     * @param key {string} key
-     * @param value {string} 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>;
+  readonly type = "http";
+  readonly name: string;
+  headers: {
+    [key: string]: string;
+  };
+  body: any;
+  params: TParams;
+  cookie: Cookie<TCookie, TSession>;
+  session: Session<TSession, TCookie>;
+  config: HttpConfig;
+  private response;
+  constructor(config?: HttpConfig);
+  onMount(data: MountData, next: Next): Promise<void>;
+  onInvoke(data: InvokeData, next: Next): Promise<void>;
+  /**
+   * set header
+   * @param key {string} key
+   * @param value {string} 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): UseifyPlugin<Http<TParams, TCookie, TSession>>;
-type HttpFuncHandler<TParams extends Record<string, any> = Record<string, any>, TCookie extends Record<string, string> = Record<string, string>, TSession extends Record<string, any> = Record<string, any>, TResult = any> = (data: InvokeData<{
-    [key: string]: any;
-    params?: TParams;
-}> & {
-    params?: TParams;
-    cookie?: Cookie<TCookie, TSession>;
-    session?: Session<TSession, TCookie>;
-}) => Promise<TResult>;
-
-export { ContentType, Cookie, type CookieOptions, Http, type HttpConfig, HttpError, type HttpFuncHandler, type Response, Session, type SessionOptions, useHttp };
+declare module '@faasjs/func' {
+  interface FaasPluginEventMap {
+    http: {
+      headers?: Record<string, any>;
+      body?: any;
+      params?: Record<string, any>;
+      queryString?: Record<string, any>;
+      httpMethod?: string;
+      path?: string;
+      raw?: {
+        request?: unknown;
+        response?: unknown;
+      };
+    };
+  }
+}
+//#endregion
+export { ContentType, Cookie, type CookieOptions, Http, HttpConfig, HttpError, Response, Session, type SessionContent, type SessionOptions, useHttp };