Add login_method with default of unknown (#32)

* Add login_method with default of unknown

* Bump version

* Export types

Author: andrew-propelauth

package-lock.json

@@ -4,7 +4,7 @@
         "type": "git",
         "url": "https://github.com/PropelAuth/node"
     },
-    "version": "2.1.9",
+    "version": "2.1.10",
     "license": "MIT",
     "keywords": [
         "auth",

package.json

@@ -40,6 +40,7 @@ export {
     UpdateUserMetadataException,
     UserNotFoundException,
 } from "./exceptions"
+export { LoginMethod, SamlLoginProvider, SocialLoginProvider } from "./loginMethod"
 export {
     CreatedOrg,
     CreatedUser,

src/index.ts

@@ -0,0 +1,93 @@
+export type SocialLoginProvider =
+    | "Google"
+    | "GitHub"
+    | "Microsoft"
+    | "Slack"
+    | "LinkedIn"
+    | "Salesforce"
+    | "Xero"
+    | "QuickBooks Online"
+export type SamlLoginProvider = "Google" | "Rippling" | "OneLogin" | "JumpCloud" | "Okta" | "Azure" | "Duo" | "Generic"
+
+export type LoginMethod =
+    | {
+          loginMethod: "password"
+      }
+    | {
+          loginMethod: "magic_link"
+      }
+    | {
+          loginMethod: "social_sso"
+          provider: SocialLoginProvider
+      }
+    | {
+          loginMethod: "email_confirmation_link"
+      }
+    | {
+          loginMethod: "saml_sso"
+          provider: SamlLoginProvider
+          orgId: string
+      }
+    | {
+          loginMethod: "impersonation"
+      }
+    | {
+          loginMethod: "generated_from_backend_api"
+      }
+    | {
+          loginMethod: "unknown"
+      }
+
+export type InternalLoginMethod =
+    | {
+          login_method: "password"
+      }
+    | {
+          login_method: "magic_link"
+      }
+    | {
+          login_method: "social_sso"
+          provider: SocialLoginProvider
+      }
+    | {
+          login_method: "email_confirmation_link"
+      }
+    | {
+          login_method: "saml_sso"
+          provider: SamlLoginProvider
+          org_id: string
+      }
+    | {
+          login_method: "impersonation"
+      }
+    | {
+          login_method: "generated_from_backend_api"
+      }
+    | {
+          login_method: "unknown"
+      }
+
+export function toLoginMethod(snake_case?: InternalLoginMethod): LoginMethod {
+    if (!snake_case) {
+        return { loginMethod: "unknown" }
+    }
+
+    switch (snake_case.login_method) {
+        case "password":
+            return { loginMethod: "password" }
+        case "magic_link":
+            return { loginMethod: "magic_link" }
+        case "social_sso":
+            return { loginMethod: "social_sso", provider: snake_case.provider }
+        case "email_confirmation_link":
+            return { loginMethod: "email_confirmation_link" }
+        case "saml_sso":
+            return { loginMethod: "saml_sso", provider: snake_case.provider, orgId: snake_case.org_id }
+        case "impersonation":
+            return { loginMethod: "impersonation" }
+        case "generated_from_backend_api":
+            return { loginMethod: "generated_from_backend_api" }
+        default:
+            return { loginMethod: "unknown" }
+    }
+}

src/loginMethod.ts

@@ -1,3 +1,5 @@
+import { InternalLoginMethod, LoginMethod, toLoginMethod } from "./loginMethod"
+
 export type UserProperties = { [key: string]: unknown }
 
 export type User = {
@@ -11,6 +13,7 @@ export type User = {
     impersonatorUserId?: string
     metadata?: { [key: string]: any }
     properties?: UserProperties
+    loginMethod: LoginMethod
 }
 
 export class UserClass {
@@ -23,6 +26,7 @@ export class UserClass {
     public lastName?: string
     public username?: string
     public properties?: UserProperties
+    public loginMethod: LoginMethod
 
     // If you used our migration APIs to migrate this user from a different system,
     // this is their original ID from that system.
@@ -41,6 +45,7 @@ export class UserClass {
         this.legacyUserId = user.legacyUserId
         this.impersonatorUserId = user.impersonatorUserId
         this.properties = user.properties
+        this.loginMethod = user.loginMethod
     }
 
     public getOrg(orgId: string): OrgMemberInfo | undefined {
@@ -292,6 +297,7 @@ export type InternalUser = {
     username?: string
     metadata?: { [key: string]: any }
     properties?: { [key: string]: unknown }
+    login_method?: InternalLoginMethod
 
     // If you used our migration APIs to migrate this user from a different system, this is their original ID from that system.
     legacy_user_id?: string
@@ -310,6 +316,7 @@ export function toUser(snake_case: InternalUser): User {
         impersonatorUserId: snake_case.impersonator_user_id,
         metadata: snake_case.metadata,
         properties: snake_case.properties,
+        loginMethod: toLoginMethod(snake_case.login_method),
     }
 
     return camelCase

src/user.ts

@@ -193,6 +193,7 @@ test("toUser converts correctly with orgs", async () => {
                 []
             ),
         },
+        loginMethod: { loginMethod: "unknown" },
     }
 
     expect(toUser(internalUser)).toEqual(user)
@@ -210,6 +211,25 @@ test("toUser converts correctly without orgs", async () => {
         email: "[email protected]",
         username: "easteregg",
         legacyUserId: "something",
+        loginMethod: { loginMethod: "unknown" },
+    }
+    expect(toUser(internalUser)).toEqual(user)
+})
+
+test("toUser converts login_method correctly", async () => {
+    const internalUser: InternalUser = {
+        user_id: "cbf064e2-edaa-4d35-b413-a8d857329c12",
+        email: "[email protected]",
+        username: "easteregg",
+        legacy_user_id: "something",
+        login_method: { login_method: "saml_sso", org_id: "someOrgId", provider: "Okta" },
+    }
+    const user: User = {
+        userId: "cbf064e2-edaa-4d35-b413-a8d857329c12",
+        email: "[email protected]",
+        username: "easteregg",
+        legacyUserId: "something",
+        loginMethod: { loginMethod: "saml_sso", orgId: "someOrgId", provider: "Okta" },
     }
     expect(toUser(internalUser)).toEqual(user)
 })
@@ -226,6 +246,7 @@ test("parseSnakeCaseToCamelCase converts correctly", async () => {
                 org_metadata: { orgdata_a: "orgvalue_a" },
             },
         },
+        login_method: { login_method: "password" },
     }
     const camelCase = {
         userId: "cbf064e2-edaa-4d35-b413-a8d857329c12",
@@ -238,6 +259,7 @@ test("parseSnakeCaseToCamelCase converts correctly", async () => {
                 orgMetadata: { orgdata_a: "orgvalue_a" },
             },
         },
+        loginMethod: { loginMethod: "password" },
     }
 
     expect(parseSnakeCaseToCamelCase(JSON.stringify(snakeCase))).toEqual(camelCase)