@tsed/platform-middlewares 7.79.4 → 7.80.0

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

@@ -0,0 +1 @@
+export declare const HTTP_METHODS: string[];

package/lib/types-esm/decorators/authOptions.d.ts

@@ -0,0 +1,23 @@
+import { Type } from "@tsed/core";
+/**
+ * Change authentication options.
+ *
+ * ```typescript
+ * @Controller('/mypath')
+ * @UseAuth(MyAuthStrategy, {role: ''})
+ * class MyCtrl {
+ *
+ *   @Get('/')
+ *   @AuthOptions(MyAuthStrategy, {role: 'admin'})
+ *   public getResource(){}
+ * }
+ * ```
+ *
+ * @param guardAuth
+ * @param options {Object} Object passed to the customer auth strategy
+ * @returns {Function}
+ * @decorator
+ * @decorator
+ * @operation
+ */
+export declare function AuthOptions(guardAuth: Type<any>, options?: Record<string, unknown>): Function;

package/lib/types-esm/decorators/middleware.d.ts

@@ -0,0 +1,8 @@
+import { ProviderOpts } from "@tsed/di";
+/**
+ * Register a new Middleware class.
+ *
+ * @decorator
+ * @classDecorator
+ */
+export declare function Middleware(opts?: Partial<Omit<ProviderOpts, "type">>): ClassDecorator;

package/lib/types-esm/decorators/use.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Mounts the specified middleware function or functions at the specified path: the middleware function is executed when
+ * the base of the requested path matches `path.
+ *
+ * ```typescript
+ * @Controller('/')
+ * @Use(Middleware1)
+ * export class Ctrl {
+ *
+ *    @Get('/')
+ *    @Use(Middleware2)
+ *    get() { }
+ * }
+ *
+ * ```
+ *
+ * @returns {Function}
+ * @param args
+ * @decorator
+ * @operation
+ */
+export declare function Use(...args: any[]): Function;

package/lib/types-esm/decorators/useAfter.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Mounts the specified middleware function or functions at the specified path: the middleware function is executed when
+ * the base of the requested path matches `path.
+ *
+ * ```typescript
+ * @Controller('/')
+ * @UseAfter(Middleware1)
+ * export class Ctrl {
+ *
+ *    @Get('/')
+ *    @UseAfter(Middleware2)
+ *    get() { }
+ * }
+ * ```
+ *
+ * @returns {function(any, any, any): *}
+ * @param args
+ * @decorator
+ * @operation
+ */
+export declare function UseAfter(...args: any[]): Function;

package/lib/types-esm/decorators/useAuth.d.ts

@@ -0,0 +1,22 @@
+import { Type } from "@tsed/core";
+/**
+ * Use custom authentication strategy on your endpoint.
+ *
+ * ```typescript
+ * @Controller('/mypath')
+ * @UseAuth(MyAuthStrategy)
+ * class MyCtrl {
+ *
+ *   @Get('/')
+ *   @UseAuth(MyAuthStrategy, {role: 'admin'})
+ *   public getResource(){}
+ * }
+ * ```
+ *
+ * @param guardAuth {Type<any>} A middleware which implement a custom auth strategy
+ * @param options {Object} Object passed to the customer auth strategy
+ * @returns {Function}
+ * @decorator
+ * @operation
+ */
+export declare function UseAuth(guardAuth: Type<any>, options?: Record<string, unknown>): Function;

package/lib/types-esm/decorators/useBefore.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Mounts the specified middleware function or functions at the specified path: the middleware function is executed when
+ * the base of the requested path matches `path.
+ *
+ * ```typescript
+ * @Controller('/')
+ * @UseBefore(Middleware1) // called only one time before all endpoint
+ * export class Ctrl {
+ *
+ *    @Get('/')
+ *    @UseBefore(Middleware2)
+ *    get() { }
+ * }
+ * ```
+ *
+ * @returns {function(any, any, any): *}
+ * @param args
+ * @decorator
+ * @operation
+ */
+export declare function UseBefore(...args: any[]): Function;

package/lib/types-esm/decorators/useBeforeEach.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Mounts the specified middleware function or functions at the specified path: the middleware function is executed when
+ * the base of the requested path matches `path.
+ *
+ * ```typescript
+ * @Controller('/')
+ * @UseBeforeEach(Middleware1)  // Called before each endpoint
+ * export class Ctrl {
+ *
+ *    @Get('/')
+ *    get() { }
+ * }
+ *
+ * ```
+ *
+ * @returns {Function}
+ * @param args
+ * @decorator
+ * @operation
+ */
+export declare function UseBeforeEach(...args: any[]): Function;

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

@@ -0,0 +1,3 @@
+export interface MiddlewareMethods {
+    use(...args: any[]): void | any | Promise<any>;
+}

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

@@ -0,0 +1,18 @@
+import { Env, Type } from "@tsed/core";
+export type PlatformMiddlewareLoadingOptions = {
+    env?: Env;
+    use: Function | Type<any> | string;
+    hook?: string;
+    options?: any;
+};
+export type PlatformMiddlewareSettings = Function | Type<any> | PlatformMiddlewareLoadingOptions | string | any;
+declare global {
+    namespace TsED {
+        interface Configuration {
+            /**
+             * Load middlewares on the $beforeRoutesInit hook (or on the specified hook event name).
+             */
+            middlewares: PlatformMiddlewareSettings[];
+        }
+    }
+}

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

@@ -0,0 +1,14 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./constants/constants.js";
+export * from "./decorators/authOptions.js";
+export * from "./decorators/middleware.js";
+export * from "./decorators/use.js";
+export * from "./decorators/useAfter.js";
+export * from "./decorators/useAuth.js";
+export * from "./decorators/useBefore.js";
+export * from "./decorators/useBeforeEach.js";
+export * from "./domain/MiddlewareMethods.js";
+export * from "./domain/PlatformMiddlewareSettings.js";
+export * from "./utils/getMiddlewaresForHook.js";

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

@@ -0,0 +1,3 @@
+import { DIConfiguration } from "@tsed/di";
+import { PlatformMiddlewareLoadingOptions } from "../domain/PlatformMiddlewareSettings.js";
+export declare function getMiddlewaresForHook(hook: string, settings: DIConfiguration, defaultHook?: string): PlatformMiddlewareLoadingOptions[];

package/package.json

@@ -1,39 +1,43 @@
 {
   "name": "@tsed/platform-middlewares",
-  "version": "7.79.4",
   "description": "Middlewares module for Ts.ED Framework",
+  "type": "commonjs",
+  "version": "7.80.0",
   "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/schema": "7.79.4",
-    "@tsed/typescript": "7.79.4",
+    "@tsed/barrels": "7.80.0",
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/schema": "7.80.0",
+    "@tsed/typescript": "7.80.0",
     "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/schema": "7.79.4"
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/schema": "7.80.0"
   },
   "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,14 +0,0 @@
-// For a detailed explanation regarding each configuration property, visit:
-// https://jestjs.io/docs/en/configuration.html
-
-module.exports = {
-  ...require("@tsed/jest-config"),
-  coverageThreshold: {
-    global: {
-      statements: 100,
-      branches: 100,
-      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,39 +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/schema"
-    }
-  ]
-}