@tsed/passport 7.79.3 → 7.80.0

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

@@ -0,0 +1,19 @@
+import { BeforeRoutesInit, OnInit, PlatformApplication, Logger } from "@tsed/common";
+import { PassportSerializerService } from "./services/PassportSerializerService.js";
+import { ProtocolsService } from "./services/ProtocolsService.js";
+/**
+ * @ignore
+ */
+export declare class PassportModule implements OnInit, BeforeRoutesInit {
+    private app;
+    private protocolsService;
+    private passportSerializer;
+    userProperty: string;
+    pauseStream: boolean;
+    disableSession: boolean;
+    platformName: string;
+    logger: Logger;
+    constructor(app: PlatformApplication, protocolsService: ProtocolsService, passportSerializer: PassportSerializerService);
+    $onInit(): Promise<any>;
+    $beforeRoutesInit(): void | Promise<any>;
+}

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

@@ -0,0 +1 @@
+export declare const PROVIDER_TYPE_PROTOCOL = "protocol";

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

@@ -0,0 +1,6 @@
+/**
+ * Inject args resolve by the passport strategy on verify method.
+ * @decorator
+ */
+export declare function Args(): any;
+export declare function Arg(index: number): any;

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

@@ -0,0 +1,6 @@
+import { AuthenticateOptions as PassportAuthenticateOptions } from "passport";
+export interface AuthenticateOptions extends PassportAuthenticateOptions {
+    security?: Record<string, string[]>;
+    originalUrl?: boolean;
+}
+export declare function Authenticate(protocol?: string | string[], options?: AuthenticateOptions): Function;

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

@@ -0,0 +1,6 @@
+import { AuthenticateOptions } from "passport";
+export interface AuthorizeOptions extends AuthenticateOptions {
+    security?: Record<string, string[]>;
+    originalUrl?: boolean;
+}
+export declare function Authorize(protocol?: string | string[], options?: AuthorizeOptions): Function;

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

@@ -0,0 +1,11 @@
+import { ProtocolOptions } from "../interfaces/ProtocolOptions.js";
+/**
+ * Declare a new Protocol base on a Passport Strategy
+ *
+ * @decorator
+ * @class
+ */
+export declare function Protocol<T = any>(options: ProtocolOptionsDecorator<T>): any;
+export type ProtocolOptionsDecorator<T = any> = {
+    name: string;
+} & Partial<ProtocolOptions<T>>;

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

@@ -0,0 +1,5 @@
+export declare class UserInfo {
+    id: string;
+    email: string;
+    password: string;
+}

package/lib/types-esm/errors/PassportException.d.ts

@@ -0,0 +1,4 @@
+import { Exception } from "@tsed/exceptions";
+export declare class PassportException extends Exception {
+    constructor(error: any);
+}

package/lib/types-esm/errors/PassportMessage.d.ts

@@ -0,0 +1,5 @@
+import { Unauthorized } from "@tsed/exceptions";
+export declare class PassportMessage extends Unauthorized {
+    opts: Record<string, unknown>;
+    constructor(message: string, opts?: Record<string, unknown>);
+}

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

@@ -0,0 +1,22 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./contants/constants.js";
+export * from "./decorators/args.js";
+export * from "./decorators/authenticate.js";
+export * from "./decorators/authorize.js";
+export * from "./decorators/protocol.js";
+export * from "./domain/UserInfo.js";
+export * from "./errors/PassportException.js";
+export * from "./errors/PassportMessage.js";
+export * from "./interfaces/BeforeInstall.js";
+export * from "./interfaces/interfaces.js";
+export * from "./interfaces/OnInstall.js";
+export * from "./interfaces/OnVerify.js";
+export * from "./interfaces/ProtocolMethods.js";
+export * from "./interfaces/ProtocolOptions.js";
+export * from "./middlewares/PassportMiddleware.js";
+export * from "./PassportModule.js";
+export * from "./services/PassportSerializerService.js";
+export * from "./services/ProtocolsService.js";
+export * from "./utils/getProtocolsFromRequest.js";

package/lib/types-esm/interfaces/BeforeInstall.d.ts

@@ -0,0 +1,3 @@
+export interface BeforeInstall<Settings = any> {
+    $beforeInstall(setting: Settings): Promise<Settings> | Settings | void;
+}

package/lib/types-esm/interfaces/OnInstall.d.ts

@@ -0,0 +1,4 @@
+import { Strategy } from "passport";
+export interface OnInstall {
+    $onInstall(strategy: Strategy): void | Promise<void>;
+}

package/lib/types-esm/interfaces/OnVerify.d.ts

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

package/lib/types-esm/interfaces/ProtocolMethods.d.ts

@@ -0,0 +1,5 @@
+import { OnInstall } from "./OnInstall.js";
+import { OnVerify } from "./OnVerify.js";
+import { BeforeInstall } from "./BeforeInstall.js";
+export interface ProtocolMethods<Settings = any> extends OnVerify, OnInstall, BeforeInstall<Settings> {
+}

package/lib/types-esm/interfaces/ProtocolOptions.d.ts

@@ -0,0 +1,7 @@
+import { Type } from "@tsed/core";
+import { Strategy } from "passport";
+export interface ProtocolOptions<Settings = any> {
+    name: string;
+    useStrategy: Type<Strategy>;
+    settings: Settings;
+}

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

@@ -0,0 +1,19 @@
+import { Type } from "@tsed/core";
+import { PassportStatic } from "passport";
+import { ProtocolOptions } from "./ProtocolOptions.js";
+declare global {
+    namespace TsED {
+        interface Configuration {
+            passport: {
+                userProperty?: string;
+                pauseStream?: string;
+                disableSession?: boolean;
+                userInfoModel?: Type<any> | false;
+                module?: PassportStatic;
+                protocols?: {
+                    [protocolName: string]: Partial<ProtocolOptions>;
+                };
+            };
+        }
+    }
+}

package/lib/types-esm/middlewares/PassportMiddleware.d.ts

@@ -0,0 +1,7 @@
+import { Context } from "@tsed/common";
+import { ProtocolsService } from "../services/ProtocolsService.js";
+export declare class PassportMiddleware {
+    protocolsService: ProtocolsService;
+    shouldSkip(ctx: Context): any;
+    use(ctx: Context): Promise<void>;
+}

package/lib/types-esm/services/PassportSerializerService.d.ts

@@ -0,0 +1,9 @@
+import { UserInfo } from "../domain/UserInfo.js";
+/**
+ * @ignore
+ */
+export declare class PassportSerializerService {
+    private model;
+    serialize(user: UserInfo, done: any): void;
+    deserialize(obj: any, done: any): void;
+}

package/lib/types-esm/services/ProtocolsService.d.ts

@@ -0,0 +1,54 @@
+import { PlatformContext, PlatformHandler } from "@tsed/common";
+import { Provider } from "@tsed/di";
+import { Strategy } from "passport";
+import type { ProtocolMethods } from "../interfaces/ProtocolMethods.js";
+/**
+ * @ignore
+ */
+export declare class ProtocolsService {
+    readonly strategies: Map<string, Strategy>;
+    protected platformHandler: PlatformHandler;
+    private injector;
+    getProtocols(): Provider[];
+    getProtocolsNames(): string[];
+    /**
+     * Invoke provider and bind it to passport.
+     * @param provider
+     */
+    invoke(provider: Provider): Promise<ProtocolMethods<any> & Record<string, any>>;
+    /**
+     * Call authenticate passport method.
+     * @param protocols
+     * @param options
+     * @param ctx
+     */
+    authenticate(protocols: string | string[], options: Record<string, any>, ctx: PlatformContext): Promise<void>;
+    /**
+     * Call authorize passport method.
+     * @param protocols
+     * @param options
+     * @param ctx
+     */
+    authorize(protocols: string | string[], options: Record<string, any>, ctx: PlatformContext): Promise<void>;
+    /**
+     * Call passport authenticate or authorize depending on the chosen method.
+     * @param method
+     * @param protocols
+     * @param options
+     * @param ctx
+     * @private
+     */
+    private call;
+    /**
+     * Create strategy options based on decorator metadata and global configuration
+     * @param provider
+     * @private
+     */
+    private getOptions;
+    /**
+     * Create the verifier handler for passport
+     * @param provider
+     * @private
+     */
+    private createHandler;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * @ignore
+ */
+export declare function getProtocolsFromRequest(req: any, protocol: string | string[], defaultProtocols: string[]): string[];

package/package.json

@@ -1,48 +1,52 @@
 {
   "name": "@tsed/passport",
-  "version": "7.79.3",
   "description": "Passport package 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": {
     "clean": "rm -rf lib",
     "build": "yarn clean && yarn barrels && yarn build:ts",
     "barrels": "barrels",
-    "test": "jest --max-workers=2 && jest-coverage-thresholds-bumper",
+    "test": "vitest run",
     "start": "ts-node src/index.ts",
-    "build:ts": "tsc --build tsconfig.json && tsc --build tsconfig.esm.json"
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {
     "tslib": "2.6.1"
   },
   "devDependencies": {
-    "@tsed/barrels": "7.79.3",
-    "@tsed/common": "7.79.3",
-    "@tsed/core": "7.79.3",
-    "@tsed/di": "7.79.3",
-    "@tsed/platform-router": "7.79.3",
-    "@tsed/typescript": "7.79.3",
+    "@tsed/barrels": "7.80.0",
+    "@tsed/common": "7.80.0",
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/platform-router": "7.80.0",
+    "@tsed/typescript": "7.80.0",
     "@types/passport": "1.0.16",
     "@types/passport-http": "0.3.11",
     "@types/passport-local": "1.0.38",
     "@types/passport-strategy": "0.2.38",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0",
     "passport": "0.7.0",
     "passport-http": "0.3.0",
     "passport-local": "1.0.0",
-    "passport-strategy": "1.0.0"
+    "passport-strategy": "1.0.0",
+    "typescript": "4.9.5",
+    "vitest": "2.0.4"
   },
   "peerDependencies": {
-    "@tsed/common": "7.79.3",
+    "@tsed/common": "7.80.0",
     "passport": ">=0.4.1"
   },
   "peerDependenciesMeta": {

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/passport": "<rootDir>/src/index.ts"
-  },
-  coverageThreshold: {
-    global: {
-      statements: 0,
-      branches: 0,
-      functions: 0,
-      lines: 0
-    }
-  }
-};

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,42 +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": "../../platform/common"
-    },
-    {
-      "path": "../../core"
-    },
-    {
-      "path": "../../di"
-    },
-    {
-      "path": "../../platform/platform-router"
-    }
-  ]
-}