passport.d.ts

// Type definitions for Passport v0.2.0
// Project: http://passportjs.org
// Definitions by: Horiuchi_H <https://github.com/horiuchi/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped

/// <reference path="../express/express.d.ts" />

declare module Express {
    export interface Request {
        authInfo?: any;

        // These declarations are merged into express's Request type
        login(user: any, done: (err: any) => void): void;
        login(user: any, options: Object, done: (err: any) => void): void;
        logIn(user: any, done: (err: any) => void): void;
        logIn(user: any, options: Object, done: (err: any) => void): void;

        logout(): void;
        logOut(): void;

        isAuthenticated(): boolean;
        isUnauthenticated(): boolean;
    }
}

declare module 'passport' {
    import express = require('express');

    function use(strategy: Strategy): Passport;
    function use(name: string, strategy: Strategy): Passport;
    function unuse(name: string): Passport;
    function framework(fw: string): Passport;
    function initialize(options?: { userProperty: string; }): express.Handler;
    function session(options?: { pauseStream: boolean; }): express.Handler;

    function authenticate(strategy: string, callback?: Function): express.Handler;
    function authenticate(strategy: string, options: Object, callback?: Function): express.Handler;
    function authenticate(strategies: string[], callback?: Function): express.Handler;
    function authenticate(strategies: string[], options: Object, callback?: Function): express.Handler;
    function authorize(strategy: string, callback?: Function): express.Handler;
    function authorize(strategy: string, options: Object, callback?: Function): express.Handler;
    function authorize(strategies: string[], callback?: Function): express.Handler;
    function authorize(strategies: string[], options: Object, callback?: Function): express.Handler;
    function serializeUser(fn: (user: any, done: (err: any, id: any) => void) => void): void;
    function deserializeUser(fn: (id: any, done: (err: any, user: any) => void) => void): void;
    function transformAuthInfo(fn: (info: any, done: (err: any, info: any) => void) => void): void;

    interface Passport {
        use(strategy: Strategy): Passport;
        use(name: string, strategy: Strategy): Passport;
        unuse(name: string): Passport;
        framework(fw: string): Passport;
        initialize(options?: { userProperty: string; }): express.Handler;
        session(options?: { pauseStream: boolean; }): express.Handler;

        authenticate(strategy: string, callback?: Function): express.Handler;
        authenticate(strategy: string, options: Object, callback?: Function): express.Handler;
        authenticate(strategies: string[], callback?: Function): express.Handler;
        authenticate(strategies: string[], options: Object, callback?: Function): express.Handler;
        authorize(strategy: string, callback?: Function): express.Handler;
        authorize(strategy: string, options: Object, callback?: Function): express.Handler;
        authorize(strategies: string[], callback?: Function): express.Handler;
        authorize(strategies: string[], options: Object, callback?: Function): express.Handler;
        serializeUser(fn: (user: any, done: (err: any, id: any) => void) => void): void;
        deserializeUser(fn: (id: any, done: (err: any, user: any) => void) => void): void;
        transformAuthInfo(fn: (info: any, done: (err: any, info: any) => void) => void): void;
    }

    interface Strategy {
        name?: string;
        authenticate(req: express.Request, options?: Object): void;
    }

    interface Profile {
        provider: string;
        id: string;
        displayName: string;
        name? : {
            familyName: string;
            givenName: string;
            middleName?: string;
        };
        emails?: {
            value: string;
            type?: string;
        }[];
        photos?: {
            value: string;
        }[];
    }
}