add typescript types

auth0 · Oct 9, 2019 · 222ad6f · 222ad6f
1 parent 559d4ac
commit 222ad6f
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,24 @@
+// Type definitions for express-openid-connect
+
+import { AuthorizationParameters, TokenSet } from 'openid-client';
+import { Request, RequestHandler } from 'express';
+
+interface AuthParams {
+    issuerBaseURL?: string;
+    baseURL?: string;
+    clientID?: string;
+    clientSecret?: string;
+    clockTolerance?: number;
+    getUser?: (tokenSet: TokenSet) => any;
+    required?: boolean | ((request: Request) => boolean);
+    errorOnRequiredAuth?: boolean;
+    idpLogout?: boolean;
+    auth0Logout?: boolean;
+    routes?: boolean;
+    redirectUriPath?: string;
+    authorizationParams?: AuthorizationParameters
+}
+
+export function auth(params?: AuthParams): RequestHandler;
+export function requiresAuth(): RequestHandler;
+export function unauthorizedHandler(): RequestHandler;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
     "url-join": "^4.0.1"
   },
   "devDependencies": {
+    "@types/express": "^4.17.1",
     "body-parser": "^1.19.0",
     "chai": "^4.2.0",
     "cookie-session": "^2.0.0-beta.3",