@tsed/platform-koa 6.95.6 → 6.95.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/platform-koa",
-  "version": "6.95.6",
+  "version": "6.95.10",
   "description": "Koa package for Ts.ED framework",
   "private": false,
   "source": "./src/index.ts",
@@ -49,10 +49,10 @@
   "repository": "https://github.com/tsedio/tsed",
   "devDependencies": {
     "@koa/cors": "3.1.0",
-    "@tsed/common": "6.95.6",
-    "@tsed/core": "6.95.6",
-    "@tsed/di": "6.95.6",
-    "@tsed/platform-test-utils": "6.95.6",
+    "@tsed/common": "6.95.10",
+    "@tsed/core": "6.95.10",
+    "@tsed/di": "6.95.10",
+    "@tsed/platform-test-utils": "6.95.10",
     "@types/koa": "2.11.3",
     "@types/koa-bodyparser": "4.3.0",
     "@types/koa-compose": "3.2.5",
@@ -77,13 +77,13 @@
     "tslib": "2.2.0"
   },
   "peerDependencies": {
-    "@tsed/common": "^6.95.6",
-    "@tsed/core": "^6.95.6",
-    "@tsed/di": "^6.95.6",
-    "@tsed/json-mapper": "^6.95.6",
+    "@tsed/common": "^6.95.10",
+    "@tsed/core": "^6.95.10",
+    "@tsed/di": "^6.95.10",
+    "@tsed/json-mapper": "^6.95.10",
     "@tsed/logger": ">=6.0.0",
-    "@tsed/openspec": "^6.95.6",
-    "@tsed/schema": "^6.95.6",
+    "@tsed/openspec": "^6.95.10",
+    "@tsed/schema": "^6.95.10",
     "koa": ">=2.13.0",
     "koa-bodyparser": ">=4.3.0",
     "koa-compress": ">=5.0.1",

package/lib/cjs/components/PlatformKoa.d.ts

@@ -1,45 +0,0 @@
-/// <reference types="koa__router" />
-import KoaRouter from "@koa/router";
-import { PlatformAdapter, PlatformApplication, PlatformBuilder, PlatformHandler, PlatformRequest, PlatformResponse, PlatformRouter } from "@tsed/common";
-import { Type } from "@tsed/core";
-import Koa from "koa";
-import { PlatformKoaApplication, PlatformKoaHandler, PlatformKoaRequest, PlatformKoaResponse, PlatformKoaRouter } from "../services";
-/**
- * @platform
- * @koa
- */
-export declare class PlatformKoa implements PlatformAdapter<Koa, KoaRouter> {
-    private platform;
-    readonly providers: ({
-        provide: typeof PlatformResponse;
-        useClass: typeof PlatformKoaResponse;
-    } | {
-        provide: typeof PlatformRequest;
-        useClass: typeof PlatformKoaRequest;
-    } | {
-        provide: typeof PlatformHandler;
-        useClass: typeof PlatformKoaHandler;
-    } | {
-        provide: typeof PlatformRouter;
-        useClass: typeof PlatformKoaRouter;
-    } | {
-        provide: typeof PlatformApplication;
-        useClass: typeof PlatformKoaApplication;
-    })[];
-    constructor(platform: PlatformBuilder<Koa, KoaRouter>);
-    /**
-     * Create new serverless application. In this mode, the component scan are disabled.
-     * @param module
-     * @param settings
-     */
-    static create(module: Type<any>, settings?: Partial<TsED.Configuration>): PlatformBuilder<Koa<Koa.DefaultState, Koa.DefaultContext>, KoaRouter<any, {}>>;
-    /**
-     * Bootstrap a server application
-     * @param module
-     * @param settings
-     */
-    static bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<PlatformBuilder<Koa<Koa.DefaultState, Koa.DefaultContext>, KoaRouter<any, {}>>>;
-    onInit(): void;
-    useRouter(): this;
-    useContext(): this;
-}

package/lib/cjs/decorators/caseSensitive.d.ts

@@ -1,22 +0,0 @@
-/**
- * Specify the behavior of the router controller.
- *
- * ```typescript
- * @Controller("/")
- * @CaseSensitive(true)
- * class MyCtrl {
- *
- * }
- * ```
- *
- * Property | Description | Default
- * ---|---|---
- * CaseSensitive | Enable case sensitivity. | Disabled by default, treating “/Foo” and “/foo” as the same.
- * Strict | Enable strict routing. | Disabled by default, “/foo” and “/foo/” are treated the same by the router.
- *
- * @returns {Function}
- * @decorator
- * @koa
- * @param sensitive
- */
-export declare function CaseSensitive(sensitive: boolean): Function;

package/lib/cjs/decorators/ctx.d.ts

@@ -1,19 +0,0 @@
-import type { Context } from "koa";
-/**
- * Return the original Koa context.
- * @decorator
- * @operation
- * @input
- * @koa
- */
-export declare function KoaCtx(): ParameterDecorator;
-/**
- * Return the original Koa context.
- * @decorator
- * @operation
- * @input
- * @koa
- */
-export declare function Ctx(): ParameterDecorator;
-export declare type Ctx = Context;
-export declare type KoaCtx = Context;

package/lib/cjs/decorators/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./routerSettings";
-export * from "./caseSensitive";
-export * from "./strict";
-export * from "./state";
-export * from "./ctx";

package/lib/cjs/decorators/routerSettings.d.ts

@@ -1,24 +0,0 @@
-/// <reference types="koa__router" />
-import { RouterOptions } from "@koa/router";
-/**
- * Specify the behavior of the router controller.
- *
- * ```typescript
- * @Controller("/")
- * @RouterSettings({sensitive: true})
- * class MyCtrl {
- *
- * }
- * ```
- *
- * Property | Description | Default
- * ---|---|---
- * sensitive | Enable case sensitivity. | Disabled by default, treating “/Foo” and “/foo” as the same.
- * strict | Enable strict routing. | Disabled by default, “/foo” and “/foo/” are treated the same by the router.
- *
- * @returns {(target:any)=>void}
- * @decorator
- * @param routerOptions
- * @koa
- */
-export declare function RouterSettings(routerOptions: RouterOptions): Function;

package/lib/cjs/decorators/state.d.ts

@@ -1,38 +0,0 @@
-/**
- * State return the value from koa.ctx.state object.
- *
- * #### Example
- *
- * ```typescript
- *  * @Middleware()
- * class StateMiddleware {
- *   use(@State() state: any) {
- *      // set some on locals
- *      state.user = "user"
- *   }
- * }
- *
- * @Controller('/')
- * @UseBefore(StateMiddleware)
- * class MyCtrl {
- *    @Get('/')
- *    @View('home.ejs') // will use locals and returned data to render the page
- *    get(@State('user') user: any) {
- *       console.log('user', user);
- *
- *       return {
- *         description: 'Hello world'
- *       }
- *    }
- * }
- * ```
- *
- * @param expression The path of the property to get.
- * @decorator
- * @operation
- * @input
- * @response
- * @koa
- */
-export declare function State(expression: string): ParameterDecorator;
-export declare function State(): ParameterDecorator;

package/lib/cjs/decorators/strict.d.ts

@@ -1,23 +0,0 @@
-/**
- * Specify the behavior of the router controller.
- *
- * ```typescript
- * @Controller("/")
- * @Strict(true)
- * class MyCtrl {
- *
- * }
- * ```
- *
- * Property | Description |    Default
- * ---|---|---
- * CaseSensitive | Enable case sensitivity. | Disabled by default, treating “/Foo” and “/foo” as the same.
- * MergeParams | Preserve the req.params values from the parent router. If the parent and the child have conflicting param names, the child’s value take precedence. | false
- * Strict | Enable strict routing. | Disabled by default, “/foo” and “/foo/” are treated the same by the router.
- *
- * @param strict
- * @returns {Function}
- * @decorator
- * @koa
- */
-export declare function Strict(strict: boolean): Function;

package/lib/cjs/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./interfaces";
-export * from "./decorators";
-export * from "./services";
-export * from "./components/PlatformKoa";

package/lib/cjs/interfaces/PlatformKoaSettings.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="koa__router" />
-import { RouterOptions } from "@koa/router";
-export interface PlatformKoaSettings {
-    /**
-     * Global configuration for the Express.Router. See express [documentation](http://expressjs.com/en/api.html#express.router).
-     */
-    router: RouterOptions;
-}

package/lib/cjs/interfaces/index.d.ts

@@ -1,15 +0,0 @@
-import Koa from "koa";
-import { PlatformKoaSettings } from "./PlatformKoaSettings";
-export * from "./PlatformKoaSettings";
-declare global {
-    namespace TsED {
-        interface Configuration {
-            /**
-             * Configuration related to Koa platform application.
-             */
-            koa: PlatformKoaSettings;
-        }
-        interface NextFunction extends Koa.Next {
-        }
-    }
-}

package/lib/cjs/middlewares/resourceNotFoundMiddleware.d.ts

@@ -1,6 +0,0 @@
-/**
- * @ignore
- * @param ctx
- * @param next
- */
-export declare function resourceNotFoundMiddleware(ctx: any, next: any): Promise<void>;

package/lib/cjs/middlewares/staticsMiddleware.d.ts

@@ -1,6 +0,0 @@
-import { PlatformStaticsOptions } from "@tsed/common";
-/**
- * @ignore
- * @param options
- */
-export declare function staticsMiddleware(options: PlatformStaticsOptions): any;

package/lib/cjs/services/PlatformKoaApplication.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="koa__router" />
-import KoaRouter from "@koa/router";
-import { Configuration, PlatformApplication, PlatformHandler } from "@tsed/common";
-import Koa from "koa";
-import { PlatformKoaRouter } from "./PlatformKoaRouter";
-declare global {
-    namespace TsED {
-        interface Application extends Koa {
-        }
-    }
-}
-/**
- * @platform
- * @express
- */
-export declare class PlatformKoaApplication extends PlatformKoaRouter implements PlatformApplication<Koa, KoaRouter> {
-    app: Koa;
-    rawApp: Koa;
-    constructor(platformHandler: PlatformHandler, configuration: Configuration);
-    getApp(): Koa;
-    callback(): any;
-}

package/lib/cjs/services/PlatformKoaHandler.d.ts

@@ -1,10 +0,0 @@
-import { HandlerMetadata, OnRequestOptions, PlatformContext, PlatformHandler } from "@tsed/common";
-import "./PlatformKoaRequest";
-export declare class PlatformKoaHandler extends PlatformHandler {
-    flush(data: any, ctx: PlatformContext): Promise<void>;
-    protected createRawHandler(metadata: HandlerMetadata): any;
-    protected onRequest(requestOptions: OnRequestOptions): Promise<any>;
-    protected onError(error: unknown, requestOptions: OnRequestOptions): any;
-    protected onCtxRequest(requestOptions: OnRequestOptions): Promise<any>;
-    protected throwError(error: any, $ctx: PlatformContext): void;
-}

package/lib/cjs/services/PlatformKoaRequest.d.ts

@@ -1,34 +0,0 @@
-/// <reference types="node" />
-import "@koa/router";
-import { IncomingEvent, PlatformContext, PlatformRequest } from "@tsed/common";
-import { IncomingMessage } from "http";
-import Koa from "koa";
-declare module "koa" {
-    interface Request {
-        id: string;
-        $ctx: PlatformContext;
-    }
-}
-declare global {
-    namespace TsED {
-        interface Request extends Koa.Request {
-        }
-    }
-}
-/**
- * @platform
- * @koa
- */
-export declare class PlatformKoaRequest extends PlatformRequest<Koa.Request> {
-    #private;
-    constructor(event: IncomingEvent, $ctx: PlatformContext);
-    get protocol(): string;
-    get host(): string;
-    get secure(): boolean;
-    get cookies(): {
-        [p: string]: any;
-    };
-    get session(): any;
-    getReq(): IncomingMessage;
-    destroy(): void;
-}

package/lib/cjs/services/PlatformKoaResponse.d.ts

@@ -1,57 +0,0 @@
-/// <reference types="node" />
-import { IncomingEvent, PlatformContext, PlatformResponse } from "@tsed/common";
-import { ServerResponse } from "http";
-import Koa from "koa";
-declare global {
-    namespace TsED {
-        interface Response extends Koa.Response {
-        }
-    }
-}
-/**
- * @platform
- * @koa
- */
-export declare class PlatformKoaResponse extends PlatformResponse<Koa.Response> {
-    #private;
-    constructor(event: IncomingEvent, $ctx: PlatformContext);
-    get statusCode(): number;
-    get locals(): Koa.DefaultState;
-    /**
-     * Return the Node.js response object
-     */
-    getRes(): ServerResponse;
-    hasStatus(): boolean;
-    /**
-     * Sets the HTTP status for the response.
-     *
-     * @param status
-     */
-    status(status: number): this;
-    /**
-     * Set `Content-Type` response header with `type` through `mime.lookup()`
-     * when it does not contain "/", or set the Content-Type to `type` otherwise.
-     *
-     * Examples:
-     *
-     *     res.type('.html');
-     *     res.type('html');
-     *     res.type('json');
-     *     res.type('application/json');
-     *     res.type('png');
-     */
-    contentType(contentType: string): this;
-    getHeaders(): any;
-    /**
-     * Send any data to your consumer.
-     *
-     * This method accept a ReadableStream, a plain object, boolean, string, number, null and undefined data.
-     * It choose the better way to send the data.
-     *
-     * @param data
-     */
-    body(data: any): this;
-    getBody(): any;
-    redirect(status: number, url: string): this;
-    location(location: string): this;
-}

package/lib/cjs/services/PlatformKoaRouter.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="koa__router" />
-import KoaRouter from "@koa/router";
-import { RouterOptions as KoaRouterOptions } from "@koa/router";
-import { PlatformHandler, PlatformMulter, PlatformMulterSettings, PlatformRouter, PlatformStaticsOptions } from "@tsed/common";
-import { Configuration } from "@tsed/di";
-import send from "koa-send";
-declare global {
-    namespace TsED {
-        interface Router extends KoaRouter {
-        }
-        interface RouterOptions extends KoaRouterOptions {
-        }
-        interface StaticsOptions extends send.SendOptions {
-        }
-    }
-}
-export declare class PlatformKoaRouter extends PlatformRouter<KoaRouter> {
-    constructor(platform: PlatformHandler, configuration: Configuration, routerOptions: any);
-    callback(): KoaRouter.Middleware<any, {}>[];
-    multer(options: PlatformMulterSettings): PlatformMulter;
-    statics(path: string, options: PlatformStaticsOptions): this;
-}

package/lib/cjs/services/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./PlatformKoaApplication";
-export * from "./PlatformKoaHandler";
-export * from "./PlatformKoaRouter";
-export * from "./PlatformKoaRequest";
-export * from "./PlatformKoaResponse";

package/lib/cjs/utils/multer.d.ts

@@ -1,4 +0,0 @@
-/**
- * @ignore
- */
-export declare function getMulter(options: any): any;