@tsed/platform-router 7.79.4 → 7.80.1

package/lib/types-esm/domain/PlatformHandlerMetadata.d.ts

@@ -0,0 +1,40 @@
+import { DIContext, InjectorService, Provider, ProviderScope, TokenProvider } from "@tsed/di";
+import { JsonParameterStore } from "@tsed/schema";
+import { PlatformHandlerType } from "./PlatformHandlerType.js";
+import { SinglePathType } from "./SinglePathType.js";
+export interface PlatformHandlerMetadataOpts extends Record<string, any> {
+    token?: TokenProvider;
+}
+export interface PlatformHandlerMetadataProps {
+    provider?: Provider;
+    handler?: any;
+    opts?: PlatformHandlerMetadataOpts;
+    propertyKey?: string | symbol;
+    type?: PlatformHandlerType;
+}
+export declare class PlatformHandlerMetadata {
+    #private;
+    path: SinglePathType;
+    readonly provider?: Provider;
+    readonly propertyKey: string | symbol;
+    readonly type: PlatformHandlerType;
+    readonly hasNextFunction: boolean;
+    readonly opts: PlatformHandlerMetadataOpts;
+    compiledHandler: ($ctx: DIContext) => any;
+    constructor(props: PlatformHandlerMetadataProps);
+    get target(): any;
+    get token(): any;
+    get handler(): any;
+    get scope(): ProviderScope;
+    get hasErrorParam(): boolean;
+    get store(): import("@tsed/schema").JsonMethodStore;
+    static from(injector: InjectorService, input: any, opts?: PlatformHandlerMetadataOpts): PlatformHandlerMetadata;
+    getParams(): JsonParameterStore[];
+    hasParamType(paramType: any): boolean;
+    isInjectable(): boolean;
+    isRawFn(): boolean;
+    isEndpoint(): boolean;
+    isCtxFn(): boolean;
+    isResponseFn(): boolean;
+    toString(): string;
+}

package/lib/types-esm/domain/PlatformHandlerType.d.ts

@@ -0,0 +1,10 @@
+export declare enum PlatformHandlerType {
+    CUSTOM = "custom",
+    ENDPOINT = "endpoint",
+    MIDDLEWARE = "middleware",
+    ERR_MIDDLEWARE = "err:middleware",
+    CTX_FN = "context",
+    RESPONSE_FN = "response",
+    RAW_FN = "raw:middleware",
+    RAW_ERR_FN = "raw:err:middleware"
+}

package/lib/types-esm/domain/PlatformLayer.d.ts

@@ -0,0 +1,44 @@
+import { Type } from "@tsed/core";
+import { Provider } from "@tsed/di";
+import type { PlatformParamsCallback } from "@tsed/platform-params";
+import { PlatformHandlerMetadata } from "./PlatformHandlerMetadata.js";
+import type { PlatformRouter } from "./PlatformRouter.js";
+import { SinglePathType } from "./SinglePathType.js";
+export interface PlatformLayerOptions extends Record<string, any> {
+    token?: Type<any>;
+}
+export interface PlatformLayerProps {
+    parent: PlatformLayer;
+    provider: Provider;
+    path: SinglePathType;
+    basePath: SinglePathType;
+    method: string;
+    handlers: any[];
+    router: PlatformRouter;
+    opts: PlatformLayerOptions;
+}
+export declare class PlatformLayer {
+    #private;
+    provider: Provider;
+    path: SinglePathType;
+    method: string;
+    handlers: PlatformHandlerMetadata[];
+    router?: PlatformRouter;
+    opts: PlatformLayerOptions;
+    layers: PlatformLayer[];
+    parent?: PlatformLayer;
+    basePath: SinglePathType;
+    constructor(props?: Partial<PlatformLayerProps>);
+    set(args: PlatformParamsCallback[]): void;
+    getArgs(): (SinglePathType | PlatformParamsCallback<import("@tsed/di").DIContext>)[];
+    isProvider(): boolean;
+    inspect(): {
+        basePath: string;
+        path: SinglePathType;
+        method: string;
+        handlers: string[];
+        opts: {};
+    };
+    getBasePath(): string;
+    setLayers(layers: PlatformLayer[]): void;
+}

package/lib/types-esm/domain/PlatformRouter.d.ts

@@ -0,0 +1,29 @@
+import { InjectorService, Provider } from "@tsed/di";
+import { PlatformLayer, PlatformLayerOptions } from "./PlatformLayer.js";
+import { SinglePathType } from "./SinglePathType.js";
+export declare class PlatformRouter {
+    #private;
+    protected readonly injector: InjectorService;
+    readonly layers: PlatformLayer[];
+    provider: Provider;
+    constructor(injector: InjectorService);
+    use(...handlers: any[]): this;
+    addRoute(method: string, path: SinglePathType, handlers: any[], opts?: PlatformLayerOptions): this;
+    all(path: SinglePathType, ...handlers: any[]): this;
+    get(path: SinglePathType, ...handlers: any[]): this;
+    post(path: SinglePathType, ...handlers: any[]): this;
+    put(path: SinglePathType, ...handlers: any[]): this;
+    delete(path: SinglePathType, ...handlers: any[]): this;
+    patch(path: SinglePathType, ...handlers: any[]): this;
+    head(path: SinglePathType, ...handlers: any[]): this;
+    options(path: SinglePathType, ...handlers: any[]): this;
+    statics(path: string, options: any): this;
+    inspect(): {
+        handlers: any[];
+        path: any;
+        basePath: string;
+        method: string;
+        opts: {};
+    }[];
+    isBuilt(): boolean;
+}

package/lib/types-esm/domain/PlatformRouters.d.ts

@@ -0,0 +1,21 @@
+import { Hooks, Type } from "@tsed/core";
+import { InjectorService, TokenProvider } from "@tsed/di";
+import { JsonMethodStore } from "@tsed/schema";
+import { PlatformLayer } from "./PlatformLayer.js";
+import { PlatformRouter } from "./PlatformRouter.js";
+export interface AlterEndpointHandlersArg {
+    before: (Type<any> | Function)[];
+    endpoint: JsonMethodStore;
+    after: (Type<any> | Function)[];
+}
+export declare class PlatformRouters {
+    protected readonly injector: InjectorService;
+    readonly hooks: Hooks;
+    readonly allowedVerbs: import("@tsed/schema").OperationVerbs[];
+    constructor(injector: InjectorService);
+    prebuild(): void;
+    from(token: TokenProvider, parentMiddlewares?: any[]): PlatformRouter;
+    getLayers(router: PlatformRouter): PlatformLayer[];
+    private sortHandlers;
+    private flatMapLayers;
+}

package/lib/types-esm/domain/SinglePathType.d.ts

@@ -0,0 +1 @@
+export type SinglePathType = string | RegExp;

package/lib/types-esm/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./domain/PlatformHandlerMetadata.js";
+export * from "./domain/PlatformHandlerType.js";
+export * from "./domain/PlatformLayer.js";
+export * from "./domain/PlatformRouter.js";
+export * from "./domain/PlatformRouters.js";
+export * from "./domain/SinglePathType.js";
+export * from "./utils/formatMethod.js";
+export * from "./utils/useContextHandler.js";

package/lib/types-esm/utils/formatMethod.d.ts

@@ -0,0 +1 @@
+export declare function formatMethod(method: string | undefined): string;

package/lib/types-esm/utils/useContextHandler.d.ts

@@ -0,0 +1,18 @@
+import { DIContext } from "@tsed/di";
+import { PlatformHandlerType } from "../domain/PlatformHandlerType.js";
+export type PlatformContextHandler<Context = DIContext> = ($ctx: Context) => any | Promise<any>;
+/**
+ * Create Ts.ED context handler
+ * @param fn
+ * @ignore
+ */
+export declare function useContextHandler(fn: PlatformContextHandler & {
+    type?: PlatformHandlerType;
+}): PlatformContextHandler<DIContext> & {
+    type?: PlatformHandlerType | undefined;
+};
+export declare function useResponseHandler(fn: PlatformContextHandler & {
+    type?: PlatformHandlerType;
+}): PlatformContextHandler<DIContext> & {
+    type?: PlatformHandlerType | undefined;
+};

package/package.json

@@ -1,45 +1,49 @@
 {
   "name": "@tsed/platform-router",
-  "version": "7.79.4",
   "description": "Router",
+  "type": "commonjs",
+  "version": "7.80.1",
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
-    "types": "./lib/types/index.d.ts",
-    "import": "./lib/esm/index.js",
-    "require": "./lib/cjs/index.js",
-    "default": "./lib/esm/index.js"
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "default": "./lib/cjs/index.js"
+    }
   },
   "scripts": {
     "build": "yarn barrels && yarn build:ts",
     "barrels": "barrels",
-    "test": "jest --max-workers=2 && jest-coverage-thresholds-bumper",
-    "build:ts": "tsc --build tsconfig.json && tsc --build tsconfig.esm.json"
+    "test": "vitest run",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {
     "tslib": "2.6.1"
   },
   "devDependencies": {
-    "@tsed/barrels": "7.79.4",
-    "@tsed/core": "7.79.4",
-    "@tsed/di": "7.79.4",
-    "@tsed/exceptions": "7.79.4",
-    "@tsed/json-mapper": "7.79.4",
-    "@tsed/platform-params": "7.79.4",
-    "@tsed/schema": "7.79.4",
-    "@tsed/typescript": "7.79.4",
+    "@tsed/barrels": "7.80.1",
+    "@tsed/core": "7.80.1",
+    "@tsed/di": "7.80.1",
+    "@tsed/exceptions": "7.80.1",
+    "@tsed/json-mapper": "7.80.1",
+    "@tsed/platform-params": "7.80.1",
+    "@tsed/schema": "7.80.1",
+    "@tsed/typescript": "7.80.1",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0"
+    "typescript": "4.9.5",
+    "vitest": "2.0.4"
   },
   "peerDependencies": {
-    "@tsed/core": "7.79.4",
-    "@tsed/di": "7.79.4",
-    "@tsed/exceptions": "7.79.4",
-    "@tsed/json-mapper": "7.79.4",
-    "@tsed/platform-params": "7.79.4",
-    "@tsed/schema": "7.79.4"
+    "@tsed/core": "7.80.1",
+    "@tsed/di": "7.80.1",
+    "@tsed/exceptions": "7.80.1",
+    "@tsed/json-mapper": "7.80.1",
+    "@tsed/platform-params": "7.80.1",
+    "@tsed/schema": "7.80.1"
   },
   "peerDependenciesMeta": {
     "@tsed/core": {

package/vitest.config.mts

@@ -0,0 +1,21 @@
+// @ts-ignore
+import {presets} from "@tsed/vitest/presets";
+import {defineConfig} from "vitest/config";
+
+export default defineConfig(
+  {
+    ...presets,
+    test: {
+      ...presets.test,
+      coverage: {
+        ...presets.test.coverage,
+        thresholds: {
+          statements: 0,
+          branches: 0,
+          functions: 0,
+          lines: 0
+        }
+      }
+    }
+  }
+);

package/jest.config.js

@@ -1,20 +0,0 @@
-// For a detailed explanation regarding each configuration property, visit:
-// https://jestjs.io/docs/en/configuration.html
-const config = require("@tsed/jest-config");
-
-module.exports = {
-  ...config,
-  roots: ["<rootDir>/src", "<rootDir>/test"],
-  moduleNameMapper: {
-    ...config.moduleNameMapper,
-    "@tsed/platform-router": "<rootDir>/src/index.ts"
-  },
-  coverageThreshold: {
-    global: {
-      statements: 100,
-      branches: 93.28,
-      functions: 100,
-      lines: 100
-    }
-  }
-};

package/lib/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/tsconfig.esm.json

@@ -1,48 +0,0 @@
-{
-  "extends": "@tsed/typescript/tsconfig.node.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "module": "ES2020",
-    "rootDir": "src",
-    "outDir": "./lib/esm",
-    "declaration": true,
-    "declarationDir": "./lib/types",
-    "composite": true,
-    "noEmit": false
-  },
-  "include": ["src", "src/**/*.json"],
-  "exclude": [
-    "node_modules",
-    "test",
-    "lib",
-    "benchmark",
-    "coverage",
-    "spec",
-    "**/*.benchmark.ts",
-    "**/*.spec.ts",
-    "keys",
-    "jest.config.js",
-    "**/__mock__/**",
-    "webpack.config.js"
-  ],
-  "references": [
-    {
-      "path": "../../core"
-    },
-    {
-      "path": "../../di"
-    },
-    {
-      "path": "../../specs/exceptions"
-    },
-    {
-      "path": "../../specs/json-mapper"
-    },
-    {
-      "path": "../platform-params"
-    },
-    {
-      "path": "../../specs/schema"
-    }
-  ]
-}