Added definition for passport-strategy module.

2026-08-20 12:00:53 +08:00 · 2014-07-09 10:23:20 +03:00
parent b3ffb84c7e
commit 994c3dcd66
2 changed files with 99 additions and 0 deletions
@@ -0,0 +1,98 @@
+// Type definitions for Passport v0.2.0 Strategy module.
+// Project: http://passportjs.org
+// Definitions by: Lior Mualem <https://github.com/liorm/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../express/express.d.ts"/>
+/// <reference path="../passport/passport.d.ts"/>
+
+/**
+ * Using this module, one can easily implement a strategy using typescript by
+ * inheriting the 'Strategy' class and reimplementing the 'authenticate' method.
+ */
+
+declare module 'passport-strategy' {
+
+    import passport = require('passport');
+    import express = require('express');
+
+    class Strategy implements passport.Strategy {
+        /**
+         * Performs authentication for the request.
+         * Note: Virtual function - re-implement in the strategy.
+         * @param req The request to authenticate.
+         * @param options Options passed to the strategy.
+         */
+        authenticate(req: express.Request, options?: any): void;
+
+        //
+        // Augmented strategy functions.
+        // These are available only from the 'authenticate' function.
+        // They are added manually by the passport framework.
+        //
+
+        /**
+         * Authenticate `user`, with optional `info`.
+         *
+         * Strategies should call this function to successfully authenticate a
+         * user.  `user` should be an object supplied by the application after it
+         * has been given an opportunity to verify credentials.  `info` is an
+         * optional argument containing additional user information.  This is
+         * useful for third-party authentication strategies to pass profile
+         * details.
+         *
+         * @param {Object} user
+         * @param {Object} info
+         * @api public
+         */
+        success(user: any, info: any): void;
+
+        /**
+         * Fail authentication, with optional `challenge` and `status`, defaulting
+         * to 401.
+         *
+         * Strategies should call this function to fail an authentication attempt.
+         *
+         * @param {String} challenge (Can also be an object with 'message' and 'type' fields).
+         * @param {Number} status
+         * @api public
+         */
+        fail(challenge: any, status: number): void;
+        fail(status: number): void;
+
+        /**
+         * Redirect to `url` with optional `status`, defaulting to 302.
+         *
+         * Strategies should call this function to redirect the user (via their
+         * user agent) to a third-party website for authentication.
+         *
+         * @param {String} url
+         * @param {Number} status
+         * @api public
+         */
+        redirect(url: string, status?: number): void;
+
+        /**
+         * Pass without making a success or fail decision.
+         *
+         * Under most circumstances, Strategies should not need to call this
+         * function.  It exists primarily to allow previous authentication state
+         * to be restored, for example from an HTTP session.
+         *
+         * @api public
+         */
+        pass(): void;
+
+        /**
+         * Internal error while performing authentication.
+         *
+         * Strategies should call this function when an internal error occurs
+         * during the process of performing authentication; for example, if the
+         * user directory is not available.
+         *
+         * @param {Error} err
+         * @api public
+         */
+        error(err: Error): void;
+    }
+}