@types/passport-linkedin-oauth2

Installation

npm install --save @types/passport-linkedin-oauth2

Summary

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

Details

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

index.d.ts

// Type definitions for passport-linkedin-oauth2 1.5
// Project: https://github.com/auth0/passport-linkedin-oauth2
// Definitions by: Andrew Vetovitz <https://github.com/andrewvetovitz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

import { Request } from "express";
import {
    AuthenticateOptions as PassportAuthenticateOptions,
    Profile as passportProfile,
    Strategy as passportStrategy,
} from "passport";

export interface Profile extends passportProfile {
    id: string;
    displayName: string;
    name: {
        familyName: string;
        givenName: string;
    };
    emails: [{ value: string }];
    photos: [{ value: string }];
    _raw: string;
    _json: any;
}

export interface AuthenticateOptions extends PassportAuthenticateOptions {
    authType?: string | undefined;
}

export interface StrategyOption {
    clientID: string;
    clientSecret: string;
    callbackURL: string;

    scope?: string[] | undefined;
    scopeSeparator?: string | undefined;
    enableProof?: boolean | undefined;
    profileFields?: string[] | undefined;
}

export interface StrategyOptionWithRequest extends StrategyOption {
    passReqToCallback: true;
}

export type VerifyFunction = (
    accessToken: string,
    refreshToken: string,
    profile: Profile,
    done: (error: any, user?: any, info?: any) => void,
) => void;

export type VerifyFunctionWithRequest = (
    req: Request,
    accessToken: string,
    refreshToken: string,
    profile: Profile,
    done: (error: any, user?: any, info?: any) => void,
) => void;

export class Strategy extends passportStrategy {
    constructor(options: StrategyOptionWithRequest, verify: VerifyFunctionWithRequest);
    constructor(options: StrategyOption, verify: VerifyFunction);

    name: string;
    authenticate(req: Request, options?: object): void;
}

Additional Details

• Last updated: Sun, 24 Sep 2023 06:37:28 GMT
• Dependencies: @types/express, @types/passport
• Global values: none

Credits

These definitions were written by Andrew Vetovitz.