Update types for verify methods (#92)

* return user authenticator object

* update types

Author: hwhmeikle

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@authsignal/browser",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",

src/api/email-api-client.ts

@@ -1,6 +1,5 @@
-import {ChallengeResponse, EnrollResponse} from "../types";
 import {buildHeaders, handleTokenExpired} from "./helpers";
-import {ApiClientOptions, ErrorResponse, VerifyResponse} from "./types/shared";
+import {ApiClientOptions, ChallengeResponse, EnrollResponse, ErrorResponse, VerifyResponse} from "./types/shared";
 
 export class EmailApiClient {
   tenantId: string;

src/api/email-magic-link-api-client.ts

@@ -1,7 +1,5 @@
-import {ChallengeResponse, EnrollResponse} from "../types";
 import {buildHeaders, handleTokenExpired} from "./helpers";
-import {CheckVerificationStatusResponse} from "./types/email-magic-link";
-import {ApiClientOptions, ErrorResponse} from "./types/shared";
+import {ApiClientOptions, ChallengeResponse, EnrollResponse, ErrorResponse, VerifyResponse} from "./types/shared";
 
 export class EmailMagicLinkApiClient {
   tenantId: string;
@@ -43,8 +41,8 @@ export class EmailMagicLinkApiClient {
     return responseJson;
   }
 
-  async checkVerificationStatus({token}: {token: string}): Promise<CheckVerificationStatusResponse | ErrorResponse> {
-    const pollVerificationStatus = async (): Promise<CheckVerificationStatusResponse | ErrorResponse> => {
+  async checkVerificationStatus({token}: {token: string}): Promise<VerifyResponse | ErrorResponse> {
+    const pollVerificationStatus = async (): Promise<VerifyResponse | ErrorResponse> => {
       const response = await fetch(`${this.baseUrl}/client/verify/email-magic-link/finalize`, {
         method: "POST",
         headers: buildHeaders({token, tenantId: this.tenantId}),

src/api/index.ts

@@ -1,6 +1,5 @@
-import {ChallengeResponse, EnrollResponse} from "../types";
 import {buildHeaders, handleTokenExpired} from "./helpers";
-import {ApiClientOptions, ErrorResponse, VerifyResponse} from "./types/shared";
+import {ApiClientOptions, ChallengeResponse, EnrollResponse, ErrorResponse, VerifyResponse} from "./types/shared";
 
 export class SmsApiClient {
   tenantId: string;

src/api/sms-api-client.ts

@@ -1,6 +1,6 @@
 import {buildHeaders, handleTokenExpired} from "./helpers";
 import {ApiClientOptions, ErrorResponse, VerifyResponse} from "./types/shared";
-import {EnrollTotpResponse} from "../types";
+import {EnrollTotpResponse} from "./types/totp";
 
 export class TotpApiClient {
   tenantId: string;

src/api/totp-api-client.ts

@@ -4,6 +4,7 @@ import {
   PublicKeyCredentialCreationOptionsJSON,
   RegistrationResponseJSON,
 } from "@simplewebauthn/types";
+import {Authenticator} from "./shared";
 
 export type RegistrationOptsRequest = {
   username?: string;
@@ -34,6 +35,7 @@ export type AddAuthenticatorResponse = {
   accessToken?: string;
   userAuthenticatorId?: string;
   userId?: string;
+  userAuthenticator?: Authenticator;
 };
 
 export type VerifyRequest = {

src/api/types/email-magic-link.ts

@@ -1,13 +1,28 @@
+import {CredentialDeviceType} from "@simplewebauthn/types";
+
 export type ApiClientOptions = {
   baseUrl: string;
   tenantId: string;
   onTokenExpired?: () => void;
 };
 
+export type EnrollResponse = {
+  userAuthenticatorId: string;
+  userId: string;
+};
+
+export type ChallengeResponse = {
+  challengeId: string;
+};
+
 export type VerifyResponse = {
   isVerified: boolean;
   accessToken?: string;
   failureReason?: string;
+  /**
+   * Only present when successfully verifying an authenticator during enrollment.
+   */
+  userAuthenticator?: Authenticator;
 };
 
 export type ErrorResponse = {
@@ -16,3 +31,87 @@ export type ErrorResponse = {
   errorCode?: "expired_token" | (string & {});
   errorDescription?: string;
 };
+
+export enum VerificationMethod {
+  SMS = "SMS",
+  AUTHENTICATOR_APP = "AUTHENTICATOR_APP",
+  RECOVERY_CODE = "RECOVERY_CODE",
+  EMAIL_MAGIC_LINK = "EMAIL_MAGIC_LINK",
+  EMAIL_OTP = "EMAIL_OTP",
+  PUSH = "PUSH",
+  SECURITY_KEY = "SECURITY_KEY",
+  PASSKEY = "PASSKEY",
+  VERIFF = "VERIFF",
+  IPROOV = "IPROOV",
+  PALM_BIOMETRICS_RR = "PALM_BIOMETRICS_RR",
+  IDVERSE = "IDVERSE",
+}
+
+enum SmsChannel {
+  "DEFAULT" = "DEFAULT",
+  "WHATSAPP" = "WHATSAPP",
+  "SMS" = "SMS",
+}
+
+enum DevicePlatform {
+  "IOS" = "IOS",
+  "ANDROID" = "ANDROID",
+  "WEB" = "WEB",
+}
+
+type WebauthnCredential = {
+  credentialId: string;
+  deviceId: string;
+  name: string;
+  aaguid?: string;
+  credentialBackedUp: boolean;
+  credentialDeviceType?: CredentialDeviceType;
+  parsedUserAgent?: {
+    ua: string;
+    browser: {
+      name?: string;
+      version?: string;
+      major?: string;
+    };
+    device: {
+      model?: string;
+      type?: string;
+      vendor?: string;
+    };
+    engine: {
+      name?: string;
+      version?: string;
+    };
+    os: {
+      name?: string;
+      version?: string;
+    };
+    cpu: {
+      architecture?: string;
+    };
+  };
+  verifiedAt: string;
+  authenticatorAttachment?: AuthenticatorAttachment;
+  aaguidMapping?: {
+    name: string;
+    svgIconLight?: string;
+    svgIconDark?: string;
+  };
+};
+
+export type Authenticator = {
+  userAuthenticatorId: string;
+  verificationMethod: VerificationMethod;
+  createdAt: string;
+  verifiedAt?: string;
+  lastVerifiedAt?: string;
+  isDefault?: boolean;
+  email?: string;
+  phoneNumber?: string;
+  displayName?: string;
+  authenticatorAttachment?: AuthenticatorAttachment;
+  previousSmsChannel?: SmsChannel;
+  devicePlatform?: DevicePlatform;
+  username?: string;
+  webauthnCredential?: WebauthnCredential;
+};

src/api/types/passkey.ts

@@ -0,0 +1,6 @@
+import {EnrollResponse} from "./shared";
+
+export type EnrollTotpResponse = {
+  uri: string;
+  secret: string;
+} & EnrollResponse;

src/api/types/shared.ts

@@ -1,7 +1,8 @@
+import {EnrollResponse, ChallengeResponse} from "./api/types/shared";
 import {EmailMagicLinkApiClient} from "./api/email-magic-link-api-client";
 import {handleApiResponse} from "./helpers";
 import {TokenCache} from "./token-cache";
-import {AuthsignalResponse, ChallengeResponse, EnrollResponse, CheckVerificationStatusResponse} from "./types";
+import {AuthsignalResponse, VerifyResponse} from "./types";
 
 type EmailMagicLinkOptions = {
   baseUrl: string;
@@ -41,7 +42,7 @@ export class EmailMagicLink {
     return handleApiResponse(response);
   }
 
-  async checkVerificationStatus(): Promise<AuthsignalResponse<CheckVerificationStatusResponse>> {
+  async checkVerificationStatus(): Promise<AuthsignalResponse<VerifyResponse>> {
     if (!this.cache.token) {
       return this.cache.handleTokenNotSetError();
     }

src/api/types/totp.ts

@@ -1,7 +1,8 @@
 import {EmailApiClient} from "./api/email-api-client";
+import {EnrollResponse, ChallengeResponse} from "./api/types/shared";
 import {handleApiResponse} from "./helpers";
 import {TokenCache} from "./token-cache";
-import {AuthsignalResponse, ChallengeResponse, EnrollResponse, VerifyResponse} from "./types";
+import {AuthsignalResponse, VerifyResponse} from "./types";
 
 type EmailOptions = {
   baseUrl: string;

src/email-magic-link.ts

@@ -1,2 +1,4 @@
 export * from "./authsignal";
 export * from "./types";
+export type {Authenticator, VerificationMethod, EnrollResponse, ChallengeResponse} from "./api/types/shared";
+export type {EnrollTotpResponse} from "./api/types/totp";

src/email.ts

@@ -1,11 +1,11 @@
 import {startAuthentication, startRegistration} from "@simplewebauthn/browser";
 
-import {PasskeyApiClient} from "./api";
+import {PasskeyApiClient} from "./api/passkey-api-client";
 import {AuthenticationResponseJSON, RegistrationResponseJSON, AuthenticatorAttachment} from "@simplewebauthn/types";
 import {TokenCache} from "./token-cache";
 import {handleErrorResponse, handleWebAuthnError} from "./helpers";
 import {AuthsignalResponse} from "./types";
-
+import {Authenticator} from "./api/types/shared";
 type PasskeyOptions = {
   baseUrl: string;
   tenantId: string;
@@ -23,6 +23,7 @@ type SignUpParams = {
 
 type SignUpResponse = {
   token?: string;
+  userAuthenticator?: Authenticator;
   registrationResponse?: RegistrationResponseJSON;
 };
 
@@ -109,6 +110,7 @@ export class Passkey {
       return {
         data: {
           token: addAuthenticatorResponse.accessToken,
+          userAuthenticator: addAuthenticatorResponse.userAuthenticator,
           registrationResponse,
         },
       };

src/index.ts

@@ -1,7 +1,8 @@
 import {SmsApiClient} from "./api/sms-api-client";
+import {EnrollResponse, ChallengeResponse} from "./api/types/shared";
 import {handleApiResponse} from "./helpers";
 import {TokenCache} from "./token-cache";
-import {AuthsignalResponse, ChallengeResponse, EnrollResponse, VerifyResponse} from "./types";
+import {AuthsignalResponse, VerifyResponse} from "./types";
 
 type SmsOptions = {
   baseUrl: string;

src/passkey.ts

@@ -1,7 +1,8 @@
 import {TotpApiClient} from "./api/totp-api-client";
+import {EnrollTotpResponse} from "./api/types/totp";
 import {handleApiResponse} from "./helpers";
 import {TokenCache} from "./token-cache";
-import {AuthsignalResponse, EnrollTotpResponse, VerifyResponse} from "./types";
+import {AuthsignalResponse, VerifyResponse} from "./types";
 
 type TotpOptions = {
   baseUrl: string;

src/sms.ts

@@ -1,5 +1,5 @@
 import {WebAuthnError} from "@simplewebauthn/browser";
-
+import {VerifyResponse as ApiVerifyResponse} from "./api/types/shared";
 type BaseLaunchOptions = {
   /**
    *  How the Authsignal Prebuilt MFA page should launch.
@@ -81,28 +81,7 @@ export type AuthsignalResponse<T> = {
   data?: T;
 };
 
-export type EnrollResponse = {
-  userAuthenticatorId: string;
-  userId: string;
-};
-
-export type EnrollTotpResponse = {
-  uri: string;
-  secret: string;
-} & EnrollResponse;
-
-export type ChallengeResponse = {
-  challengeId: string;
-};
-
-export type VerifyResponse = {
-  isVerified: boolean;
-  token?: string;
-  failureReason?: string;
-};
-
-export type CheckVerificationStatusResponse = {
-  isVerified: boolean;
+export type VerifyResponse = Omit<ApiVerifyResponse, "accessToken"> & {
   token?: string;
 };