koatty 3.5.11 → 3.5.12-0

package/dist/index.d.ts

@@ -1,19 +1,363 @@
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2020-05-18 10:43:05
- */
-export * from "./controller/BaseController";
-export * from "./controller/HttpController";
-export * from "./core/Bootstrap";
-export * from "./core/Component";
-export * from "./service/BaseService";
-export * from "koatty_core";
-export * from "koatty_container";
-export * from "koatty_exception";
-export * from "koatty_router";
-export * from "koatty_serve";
-export * from "koatty_trace";
-export { Helper } from "./util/Helper";
-export { Logger } from "./util/Logger";
+/*!
+* @Author: richen
+* @Date: 2021-12-21 12:22:04
+* @License: BSD (3-Clause)
+* @Copyright (c) - <richenlin(at)gmail.com>
+* @HomePage: https://koatty.org/
+*/
+import { Helper } from 'koatty_lib';
+import Koa from 'koa';
+import { Koatty } from 'koatty_core';
+import { KoattyContext } from 'koatty_core';
+import { Logger as Logger_2 } from 'koatty_logger';
+import { ObjectDefinitionOptions } from 'koatty_container';
+
+/**
+ * Interface for Api input
+ */
+export declare interface ApiInput {
+    code?: number;
+    message?: string;
+    data?: any;
+}
+
+/**
+ * Interface for Api output
+ */
+export declare interface ApiOutput {
+    code: number;
+    message: string;
+    data: any;
+}
+
+export declare type AppReadyHookFunc = (app: Koatty) => Promise<any>;
+
+/**
+ * Base controller
+ *
+ * @export
+ * @class BaseController
+ * @implements {IController}
+ */
+export declare class BaseController implements IController {
+    app: Koatty;
+    readonly ctx: KoattyContext;
+    /**
+     * instance of BaseController.
+     * @param {Koatty} app
+     * @param {KoattyContext} ctx
+     * @memberof BaseController
+     */
+    /**
+     * init
+     *
+     * @protected
+     * @memberof BaseController
+     */
+    /**
+     * Response to normalize json format content for success
+     *
+     * @param {(string | ApiInput)} msg   待处理的message消息
+     * @param {*} [data]    待处理的数据
+     * @param {number} [code=200]    错误码，默认0
+     * @returns {*}
+     * @memberof BaseController
+     */
+    ok(msg: string | ApiInput, data?: any, code?: number): Promise<ApiOutput>;
+    /**
+     * Response to normalize json format content for fail
+     *
+     * @param {(string | ApiInput)} msg
+     * @param {*} [data]
+     * @param {number} [code=1]
+     * @returns {*}
+     * @memberof BaseController
+     */
+    fail(msg: Error | string | ApiInput, data?: any, code?: number): any;
+}
+
+/**
+ * Base class
+ *
+ * @export
+ * @class Base
+ */
+export declare class BaseService implements IService {
+    app: Koatty;
+    /**
+     * instance of Base.
+     * @param {...any[]} arg
+     * @memberof Base
+     */
+    /**
+     * init
+     *
+     * @protected
+     * @param {...any[]} arg
+     * @memberof Base
+     */
+}
+
+/**
+ * bind AppReadyHookFunc
+ * example:
+ * export function TestDecorator(): ClassDecorator {
+ *  return (target: any) => {
+ *   BindAppReadyHook((app: Koatty) => {
+ *      // todo
+ *      return Promise.resolve();
+ *   }, target)
+ *  }
+ * }
+ *
+ * @export
+ * @param {AppReadyHookFunc} func
+ * @param {*} target
+ */
+export declare function BindAppReadyHook(func: AppReadyHookFunc, target: any): void;
+
+/**
+ * Bootstrap application
+ *
+ * @export
+ * @param {Function} [bootFunc]
+ * @returns {ClassDecorator}
+ */
+export declare function Bootstrap(bootFunc?: Function): ClassDecorator;
+
+/**
+ * Indicates that an decorated class is a "component".
+ *
+ * @export
+ * @param {string} [identifier] component name
+ * @returns {ClassDecorator}
+ */
+export declare function Component(identifier?: string): ClassDecorator;
+
+/**
+ * Define project scan path
+ *
+ * @export
+ * @param {(string | string[])} [scanPath]
+ * @returns {ClassDecorator}
+ */
+export declare function ComponentScan(scanPath?: string | string[]): ClassDecorator;
+
+/**
+ * Define project configuration scan path
+ *
+ * @export
+ * @param {(string | string[])} [scanPath]
+ * @returns {ClassDecorator}
+ */
+export declare function ConfigurationScan(scanPath?: string | string[]): ClassDecorator;
+
+/**
+ * Indicates that an decorated class is a "controller".
+ *
+ * @export
+ * @param {string} [path] controller router path
+ * @returns {ClassDecorator}
+ */
+export declare function Controller(path?: string): ClassDecorator;
+
+export { Helper }
+
+/**
+ * HTTP controller
+ *
+ * @export
+ * @class HttpController
+ * @implements {IController}
+ */
+export declare class HttpController extends BaseController {
+    /**
+     * Whether it is a GET request
+     *
+     * @public
+     * @returns {boolean}
+     * @memberof HttpController
+     */
+    isGet(): boolean;
+    /**
+     * Whether it is a POST request
+     *
+     * @public
+     * @returns {boolean}
+     * @memberof HttpController
+     */
+    isPost(): boolean;
+    /**
+     * Determines whether the METHOD request is specified
+     *
+     * @public
+     * @param {string} method
+     * @returns {boolean}
+     * @memberof HttpController
+     */
+    isMethod(method: string): boolean;
+    /**
+     * Get/Set headers.
+     *
+     * @public
+     * @param {string} [name]
+     * @param {*} [value]
+     * @returns {*}
+     * @memberof HttpController
+     */
+    header(name?: string, value?: any): any;
+    /**
+     * Get POST/GET parameters, the POST value is priority.
+     *
+     * @param {string} [name]
+     * @returns
+     * @memberof HttpController
+     */
+    param(name?: string): any;
+    /**
+     * Set response content-type
+     *
+     * @public
+     * @param {string} contentType
+     * @param {(string | boolean)} [encoding]
+     * @returns {string}
+     * @memberof HttpController
+     */
+    type(contentType: string, encoding?: string | boolean): string;
+    /**
+     * set cache-control and expires header
+     *
+     * @public
+     * @param {number} [timeout=30]
+     * @returns {void}
+     * @memberof HttpController
+     */
+    expires(timeout?: number): void;
+    /**
+     * Url redirect
+     *
+     * @param {string} urls
+     * @param {string} [alt]
+     * @returns {void}
+     * @memberof HttpController
+     */
+    redirect(urls: string, alt?: string): void;
+    /**
+     * Block access
+     *
+     * @param {number} [code=403]
+     * @returns {Promise<any>}
+     * @memberof HttpController
+     */
+    deny(code?: number): Promise<any>;
+    /**
+     * Set response Body content
+     *
+     * @param {*} data
+     * @param {string} [contentType]
+     * @param {string} [encoding]
+     * @returns {Promise<any>}
+     * @memberof HttpController
+     */
+    body(data: any, contentType?: string, encoding?: string): Promise<any>;
+    /**
+     * Respond to json formatted content
+     *
+     * @param {*} data
+     * @returns {Promise<any>}
+     * @memberof HttpController
+     */
+    json(data: any): Promise<any>;
+    /**
+     * Response to normalize json format content for success
+     *
+     * @param {(string | ApiInput)} msg   待处理的message消息
+     * @param {*} [data]    待处理的数据
+     * @param {number} [code=200]    错误码，默认0
+     * @returns {*}
+     * @memberof HttpController
+     */
+    ok(msg: string | ApiInput, data?: any, code?: number): Promise<any>;
+    /**
+     * Response to normalize json format content for fail
+     *
+     * @param {(string | ApiInput)} msg
+     * @param {*} [data]
+     * @param {number} [code=1]
+     * @returns {*}
+     * @memberof HttpController
+     */
+    fail(msg: Error | string | ApiInput, data?: any, code?: number): Promise<any>;
+}
+
+/**
+ * Interface for Controller
+ */
+export declare interface IController {
+    app: Koatty;
+    readonly ctx: KoattyContext;
+    __befor?: () => Promise<any>;
+    __after?: () => Promise<any>;
+    readonly fail: (msg?: Error | string | ApiInput, data?: any, ret?: number) => Promise<any>;
+    readonly ok: (msg?: string | ApiInput, data?: any, ret?: number) => Promise<any>;
+}
+
+/**
+ * Interface for Middleware
+ */
+export declare interface IMiddleware {
+    run: (options: any, app: Koatty) => Koa.Middleware;
+}
+
+/**
+ * Interface for Plugin
+ */
+export declare interface IPlugin {
+    run: (options: any, app: Koatty) => Promise<any>;
+}
+
+/**
+ * Interface for Service
+ */
+export declare interface IService {
+    app: Koatty;
+}
+
+export declare const Logger: Logger_2;
+
+/**
+ * Indicates that an decorated class is a "middleware".
+ *
+ * @export
+ * @param {string} [identifier] middleware name
+ * @returns {ClassDecorator}
+ */
+export declare function Middleware(identifier?: string): ClassDecorator;
+
+/**
+ * Indicates that an decorated class is a "plugin".
+ *
+ * @export
+ * @param {string} [identifier]
+ * @returns {ClassDecorator}
+ */
+export declare function Plugin(identifier?: string): ClassDecorator;
+
+/**
+ * Indicates that an decorated class is a "service".
+ *
+ * @export
+ * @param {string} [identifier] middleware name
+ * @returns {ClassDecorator}
+ */
+export declare function Service(identifier?: string): ClassDecorator;
+
+
+export * from "koatty_container";
+export * from "koatty_core";
+export * from "koatty_exception";
+export * from "koatty_router";
+export * from "koatty_serve";
+export * from "koatty_trace";
+
+export { }