Installation

npm install --save @types/passport-auth0

Summary

This package contains type definitions for passport-auth0 (https://github.com/auth0/passport-auth0).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/passport-auth0.

index.d.ts

1import passport = require("passport");
2import express = require("express");
3
4declare class StrategyInternal extends passport.Strategy {
5    constructor(
6        options: StrategyInternal.StrategyOptionWithRequest,
7        verify: StrategyInternal.VerifyFunctionWithRequest,
8    );
9    constructor(options: StrategyInternal.StrategyOption, verify: StrategyInternal.VerifyFunction);
10
11    name: string;
12    authenticate(req: express.Request, options?: object): void;
13}
14
15declare namespace StrategyInternal {
16    interface Profile extends passport.Profile {
17        id: string;
18        displayName: string;
19        gender?: string | undefined;
20        ageRange?: {
21            min: number;
22            max?: number | undefined;
23        } | undefined;
24        profileUrl?: string | undefined;
25        username?: string | undefined;
26        birthday: string;
27
28        _raw: string;
29        _json: any;
30    }
31
32    interface AuthenticateOptions extends passport.AuthenticateOptions {
33        authType?: string | undefined;
34    }
35
36    interface StrategyOption {
37        clientID: string;
38        clientSecret: string;
39        callbackURL: string;
40        domain: string;
41        scopeSeparator?: string | undefined;
42        enableProof?: boolean | undefined;
43        profileFields?: string[] | undefined;
44        state?: boolean | undefined;
45    }
46
47    interface StrategyOptionWithRequest extends StrategyOption {
48        passReqToCallback: true;
49    }
50    interface ExtraVerificationParams {
51        audience?: string | undefined;
52        connection?: string | undefined;
53        prompt?: string | undefined;
54    }
55
56    type VerifyFunction = (
57        accessToken: string,
58        refreshToken: string,
59        extraParams: ExtraVerificationParams,
60        profile: Profile,
61        done: (error: any, user?: any, info?: any) => void,
62    ) => void;
63
64    type VerifyFunctionWithRequest = (
65        req: express.Request,
66        accessToken: string,
67        refreshToken: string,
68        extraParams: ExtraVerificationParams,
69        profile: Profile,
70        done: (error: any, user?: any, info?: any) => void,
71    ) => void;
72
73    // NOTE: not true for `export import` statements
74    // eslint-disable-next-line @definitelytyped/strict-export-declare-modifiers
75    export import Strategy = StrategyInternal;
76}
77
78export = StrategyInternal;
79

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/express, @types/passport

Credits

These definitions were written by John Umeh, Vishnu Sankar, Duncan Hall, and Karl Horky.