Merge 5f72acf into ad2948d

index.d.ts

@@ -0,0 +1,52 @@
+declare module '@articulate/authentic' {
+  interface VerifyOpts {
+    algorithms?: string[]
+    audience?: string | RegExp | Array<string | RegExp>
+    clockTimestamp?: number
+    clockTolerance?: number
+    issuer?: string | string[]
+    ignoreExpiration?: boolean
+    ignoreNotBefore?: boolean
+    jwtid?: string
+    subject?: string
+    maxAge?: string
+  }
+
+  interface JWKSOpts {
+    cache?: boolean,
+    rateLimit?: boolean
+  }
+
+  interface AuthenticOpts {
+    issWhitelist: string[],
+    jwks?: JWKSOpts,
+    verify?: VerifyOpts
+  }
+
+  interface Validator {
+    (token: string): Promise<Authentic.JWT>
+  }
+
+  function Authentic(opts: AuthenticOpts): Validator
+
+  namespace Authentic {
+    interface JWT {
+      // Standard JWT claims
+      aud: string,
+      cid?: number,
+      exp: number,
+      iat: number,
+      iss: string
+      jti?: number,
+      scp?: Array<String>
+      sub: string
+      uid?: number,
+
+      // Custom JWT claims
+      aid?: string,
+      staff?: boolean,
+    }
+  }
+
+  export = Authentic
+}

package.json

@@ -3,6 +3,7 @@
   "version": "1.1.0",
   "description": "Proper validation of JWT's against JWK's",
   "main": "index.js",
+  "types": "index.d.ts",
   "repository": "git@github.com:articulate/authentic.git",
   "author": "articulate",
   "license": "MIT",