docs: cleanup jsdoc for verify function

GovTechSG · Apr 26, 2023 · 0f05162 · 0f05162
1 parent 4c5341c
commit 0f05162
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## Unreleased
+
+### v1.0.0-beta4 (2023-04-26)
+
+- fix: define Profile interface locally
+- docs: clean up jsdoc for verify function
+
 ## v1.0.0-beta3 (2023-04-25)
 
 ### Changed

diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -277,7 +277,7 @@ declare namespace OpenIDConnectStrategy {
           ) => void)
         | ((
               issuer: string,
-              userInfoProfile: MergedProfile,
+              uiProfile: MergedProfile,
               idProfile: Profile,
               context: AuthContext,
               idToken: JwtToken,
@@ -331,7 +331,7 @@ declare namespace OpenIDConnectStrategy {
         | ((
               req: Request,
               issuer: string,
-              userInfoProfile: MergedProfile,
+              uiProfile: MergedProfile,
               idProfile: Profile,
               context: AuthContext,
               idToken: JwtToken,

diff --git a/lib/strategy.js b/lib/strategy.js
@@ -25,12 +25,20 @@ const passport = require("passport-strategy"),
  */
 
 /**
- * Function to process authenticated info and return a valid user profile.
+ * Function to process authenticated info and return a valid user profile via {@link VerifyCallback}
  *
- * @callback VerifyFunction
- * @param {string} issuer - identifier of the OIDC provider issuing the token claims
- * @param {Profile.Profile} profile - profile of the authenticated user
- * @param {VerifyCallback} done - callback to return the a user instance, false or error.
+ * @typedef {{
+ *  (issuer: string, profile: Profile.Profile, context: Context.AuthContext, done: VerifyCallback): void;
+ *  (issuer: string, profile: Profile.Profile, context: Context.AuthContext, idToken: any, done: VerifyCallback): void;
+ *  (issuer: string, profile: Profile.Profile, context: Context.AuthContext, idToken: any, accessToken: any, refreshToken: string, done: VerifyCallback): void;
+ *  (issuer: string, profile: Profile.Profile, context: Context.AuthContext, idToken: any, accessToken: any, refreshToken: string, params: any, done: VerifyCallback): void;
+ *  (issuer: string, uiProfile: Profile.MergedProfile, idProfile: Profile.Profile, context: Context.AuthContext, idToken: any, accessToken: any, refreshToken: string, params: any, done: VerifyCallback): void;
+ *  (req: http.IncomingMessage, issuer: string, profile: Profile.Profile, context: Context.AuthContext, done: VerifyCallback): void;
+ *  (req: http.IncomingMessage, issuer: string, profile: Profile.Profile, context: Context.AuthContext, idToken: any, done: VerifyCallback): void;
+ *  (req: http.IncomingMessage, issuer: string, profile: Profile.Profile, context: Context.AuthContext, idToken: any, accessToken: any, refreshToken: string, done: VerifyCallback): void;
+ *  (req: http.IncomingMessage, issuer: string, profile: Profile.Profile, context: Context.AuthContext, idToken: any, accessToken: any, refreshToken: string, params: any, done: VerifyCallback): void;
+ *  (req: http.IncomingMessage, issuer: string, uiProfile: Profile.MergedProfile, idProfile: Profile.Profile, context: Context.AuthContext, idToken: any, accessToken: any, refreshToken: string, params: any, done: VerifyCallback): void;
+ * }} VerifyFunction
  */
 
 /**

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@techpass/passport-openidconnect",
-    "version": "1.0.0-beta3",
+    "version": "1.0.0-beta4",
     "description": "OpenID Connect authentication strategy for Passport.",
     "keywords": [
         "auth",
@@ -22,6 +22,9 @@
     },
     "license": "MIT",
     "author": "Jared Hanson <[email protected]> (http://www.jaredhanson.net/)",
+    "contributors": [
+        "GovTechSG"
+    ],
     "main": "./lib",
     "types": "./lib/index.d.ts",
     "scripts": {