Update response types and make fields consistent with other client sd…

…ks (#77)
authsignal · Oct 17, 2024 · 607adbb · 607adbb
1 parent ad890f8
commit 607adbb
Show file tree

Hide file tree

Showing 15 changed files with 181 additions and 109 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@authsignal/browser",
-  "version": "0.6.2",
+  "version": "1.0.0-alpha1",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",

diff --git a/src/api/email-api-client.ts b/src/api/email-api-client.ts
@@ -1,5 +1,5 @@
 import {buildHeaders, handleTokenExpired} from "./helpers";
-import {ApiClientOptions, AuthsignalResponse, ChallengeResponse, EnrollResponse, VerifyResponse} from "./types/shared";
+import {ApiClientOptions, ChallengeResponse, EnrollResponse, ErrorResponse, VerifyResponse} from "./types/shared";
 
 export class EmailApiClient {
   tenantId: string;
@@ -12,7 +12,7 @@ export class EmailApiClient {
     this.onTokenExpired = onTokenExpired;
   }
 
-  async enroll({token, email}: {token: string; email: string}) {
+  async enroll({token, email}: {token: string; email: string}): Promise<EnrollResponse | ErrorResponse> {
     const body = {email};
 
     const response = await fetch(`${this.baseUrl}/client/user-authenticators/email-otp`, {
@@ -21,27 +21,27 @@ export class EmailApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<EnrollResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
     return responseJson;
   }
 
-  async challenge({token}: {token: string}) {
+  async challenge({token}: {token: string}): Promise<ChallengeResponse | ErrorResponse> {
     const response = await fetch(`${this.baseUrl}/client/challenge/email-otp`, {
       method: "POST",
       headers: buildHeaders({token, tenantId: this.tenantId}),
     });
 
-    const responseJson: AuthsignalResponse<ChallengeResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
     return responseJson;
   }
 
-  async verify({token, code}: {token: string; code: string}) {
+  async verify({token, code}: {token: string; code: string}): Promise<VerifyResponse | ErrorResponse> {
     const body = {verificationCode: code};
 
     const response = await fetch(`${this.baseUrl}/client/verify/email-otp`, {
@@ -50,7 +50,7 @@ export class EmailApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<VerifyResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 

diff --git a/src/api/helpers.ts b/src/api/helpers.ts
@@ -1,4 +1,4 @@
-import {AuthsignalResponse} from "./types/shared";
+import {ErrorResponse} from "./types/shared";
 
 type BuildHeadersParams = {
   token?: string;
@@ -15,7 +15,7 @@ export function buildHeaders({token, tenantId}: BuildHeadersParams) {
 }
 
 type HandleTokenExpiredParams<T> = {
-  response: AuthsignalResponse<T>;
+  response: T | ErrorResponse;
   onTokenExpired?: () => void;
 };
 

diff --git a/src/api/passkey-api-client.ts b/src/api/passkey-api-client.ts
@@ -4,13 +4,14 @@ import {
   AddAuthenticatorResponse,
   AuthenticationOptsRequest,
   AuthenticationOptsResponse,
+  ErrorResponse,
   PasskeyAuthenticatorResponse,
   RegistrationOptsRequest,
   RegistrationOptsResponse,
   VerifyRequest,
   VerifyResponse,
 } from "./types/passkey";
-import {ApiClientOptions, AuthsignalResponse, ChallengeResponse} from "./types/shared";
+import {ApiClientOptions, ChallengeResponse} from "./types/shared";
 
 export class PasskeyApiClient {
   tenantId: string;
@@ -23,7 +24,11 @@ export class PasskeyApiClient {
     this.onTokenExpired = onTokenExpired;
   }
 
-  async registrationOptions({token, username, authenticatorAttachment}: {token: string} & RegistrationOptsRequest) {
+  async registrationOptions({
+    token,
+    username,
+    authenticatorAttachment,
+  }: {token: string} & RegistrationOptsRequest): Promise<RegistrationOptsResponse | ErrorResponse> {
     const body: RegistrationOptsRequest = Boolean(authenticatorAttachment)
       ? {username, authenticatorAttachment}
       : {username};
@@ -34,14 +39,17 @@ export class PasskeyApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<RegistrationOptsResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
     return responseJson;
   }
 
-  async authenticationOptions({token, challengeId}: {token?: string} & AuthenticationOptsRequest) {
+  async authenticationOptions({
+    token,
+    challengeId,
+  }: {token?: string} & AuthenticationOptsRequest): Promise<AuthenticationOptsResponse | ErrorResponse> {
     const body: AuthenticationOptsRequest = {challengeId};
 
     const response = await fetch(`${this.baseUrl}/client/user-authenticators/passkey/authentication-options`, {
@@ -50,14 +58,18 @@ export class PasskeyApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<AuthenticationOptsResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
     return responseJson;
   }
 
-  async addAuthenticator({token, challengeId, registrationCredential}: {token: string} & AddAuthenticatorRequest) {
+  async addAuthenticator({
+    token,
+    challengeId,
+    registrationCredential,
+  }: {token: string} & AddAuthenticatorRequest): Promise<AddAuthenticatorResponse | ErrorResponse> {
     const body: AddAuthenticatorRequest = {
       challengeId,
       registrationCredential,
@@ -69,14 +81,19 @@ export class PasskeyApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<AddAuthenticatorResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
     return responseJson;
   }
 
-  async verify({token, challengeId, authenticationCredential, deviceId}: {token?: string} & VerifyRequest) {
+  async verify({
+    token,
+    challengeId,
+    authenticationCredential,
+    deviceId,
+  }: {token?: string} & VerifyRequest): Promise<VerifyResponse | ErrorResponse> {
     const body: VerifyRequest = {challengeId, authenticationCredential, deviceId};
 
     const response = await fetch(`${this.baseUrl}/client/verify/passkey`, {
@@ -85,7 +102,7 @@ export class PasskeyApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<VerifyResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
@@ -96,7 +113,7 @@ export class PasskeyApiClient {
     credentialIds,
   }: {
     credentialIds: string[];
-  }): Promise<AuthsignalResponse<PasskeyAuthenticatorResponse>> {
+  }): Promise<PasskeyAuthenticatorResponse | ErrorResponse> {
     const response = await fetch(`${this.baseUrl}/client/user-authenticators/passkey?credentialIds=${credentialIds}`, {
       method: "GET",
       headers: buildHeaders({tenantId: this.tenantId}),
@@ -109,14 +126,14 @@ export class PasskeyApiClient {
     return response.json();
   }
 
-  async challenge(action: string) {
+  async challenge(action: string): Promise<ChallengeResponse | ErrorResponse> {
     const response = await fetch(`${this.baseUrl}/client/challenge`, {
       method: "POST",
       headers: buildHeaders({tenantId: this.tenantId}),
       body: JSON.stringify({action}),
     });
 
-    const responseJson: AuthsignalResponse<ChallengeResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 

diff --git a/src/api/sms-api-client.ts b/src/api/sms-api-client.ts
@@ -1,5 +1,5 @@
 import {buildHeaders, handleTokenExpired} from "./helpers";
-import {ApiClientOptions, AuthsignalResponse, ChallengeResponse, EnrollResponse, VerifyResponse} from "./types/shared";
+import {ApiClientOptions, ChallengeResponse, EnrollResponse, ErrorResponse, VerifyResponse} from "./types/shared";
 
 export class SmsApiClient {
   tenantId: string;
@@ -12,7 +12,7 @@ export class SmsApiClient {
     this.onTokenExpired = onTokenExpired;
   }
 
-  async enroll({token, phoneNumber}: {token: string; phoneNumber: string}) {
+  async enroll({token, phoneNumber}: {token: string; phoneNumber: string}): Promise<EnrollResponse | ErrorResponse> {
     const body = {phoneNumber};
 
     const response = await fetch(`${this.baseUrl}/client/user-authenticators/sms`, {
@@ -21,27 +21,27 @@ export class SmsApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<EnrollResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
     return responseJson;
   }
 
-  async challenge({token}: {token: string}) {
+  async challenge({token}: {token: string}): Promise<ChallengeResponse | ErrorResponse> {
     const response = await fetch(`${this.baseUrl}/client/challenge/sms`, {
       method: "POST",
       headers: buildHeaders({token, tenantId: this.tenantId}),
     });
 
-    const responseJson: AuthsignalResponse<ChallengeResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
     return responseJson;
   }
 
-  async verify({token, code}: {token: string; code: string}) {
+  async verify({token, code}: {token: string; code: string}): Promise<VerifyResponse | ErrorResponse> {
     const body = {verificationCode: code};
 
     const response = await fetch(`${this.baseUrl}/client/verify/sms`, {
@@ -50,7 +50,7 @@ export class SmsApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<VerifyResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 

diff --git a/src/api/totp-api-client.ts b/src/api/totp-api-client.ts
@@ -1,6 +1,6 @@
 import {buildHeaders, handleTokenExpired} from "./helpers";
-import {ApiClientOptions, AuthsignalResponse, VerifyResponse} from "./types/shared";
-import {EnrollResponse} from "./types/totp";
+import {ApiClientOptions, ErrorResponse, VerifyResponse} from "./types/shared";
+import {EnrollTotpResponse} from "./types/totp";
 
 export class TotpApiClient {
   tenantId: string;
@@ -13,20 +13,20 @@ export class TotpApiClient {
     this.onTokenExpired = onTokenExpired;
   }
 
-  async enroll({token}: {token: string}) {
+  async enroll({token}: {token: string}): Promise<EnrollTotpResponse | ErrorResponse> {
     const response = await fetch(`${this.baseUrl}/client/user-authenticators/totp`, {
       method: "POST",
       headers: buildHeaders({token, tenantId: this.tenantId}),
     });
 
-    const responseJson: AuthsignalResponse<EnrollResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 
     return responseJson;
   }
 
-  async verify({token, code}: {token: string; code: string}) {
+  async verify({token, code}: {token: string; code: string}): Promise<VerifyResponse | ErrorResponse> {
     const body = {verificationCode: code};
 
     const response = await fetch(`${this.baseUrl}/client/verify/totp`, {
@@ -35,7 +35,7 @@ export class TotpApiClient {
       body: JSON.stringify(body),
     });
 
-    const responseJson: AuthsignalResponse<VerifyResponse> = await response.json();
+    const responseJson = await response.json();
 
     handleTokenExpired({response: responseJson, onTokenExpired: this.onTokenExpired});
 

diff --git a/src/api/types/passkey.ts b/src/api/types/passkey.ts
@@ -55,3 +55,12 @@ export type PasskeyAuthenticatorResponse = {
   credentialId: string;
   verifiedAt: string;
 };
+
+export type ChallengeResponse = {
+  challengeId: string;
+};
+
+export type ErrorResponse = {
+  error: string;
+  errorDescription?: string;
+};
diff --git a/src/api/types/shared.ts b/src/api/types/shared.ts
@@ -25,5 +25,3 @@ export type ErrorResponse = {
   errorCode?: "expired_token" | (string & {});
   errorDescription?: string;
 };
-
-export type AuthsignalResponse<T> = T | ErrorResponse;
diff --git a/src/api/types/totp.ts b/src/api/types/totp.ts
@@ -1,4 +1,4 @@
-export type EnrollResponse = {
+export type EnrollTotpResponse = {
   userAuthenticatorId: string;
   userId: string;
   uri: string;

diff --git a/src/email.ts b/src/email.ts
@@ -1,5 +1,8 @@
 import {EmailApiClient} from "./api/email-api-client";
+import {ChallengeResponse, EnrollResponse, VerifyResponse} from "./api/types/shared";
+import {handleApiResponse} from "./helpers";
 import {TokenCache} from "./token-cache";
+import {AuthsignalResponse} from "./types";
 
 type EmailOptions = {
   baseUrl: string;
@@ -23,33 +26,37 @@ export class Email {
     this.api = new EmailApiClient({baseUrl, tenantId, onTokenExpired});
   }
 
-  async enroll({email}: EnrollParams) {
+  async enroll({email}: EnrollParams): Promise<AuthsignalResponse<EnrollResponse>> {
     if (!this.cache.token) {
       return this.cache.handleTokenNotSetError();
     }
 
-    return this.api.enroll({token: this.cache.token, email});
+    const response = await this.api.enroll({token: this.cache.token, email});
+
+    return handleApiResponse(response);
   }
 
-  async challenge() {
+  async challenge(): Promise<AuthsignalResponse<ChallengeResponse>> {
     if (!this.cache.token) {
       return this.cache.handleTokenNotSetError();
     }
 
-    return this.api.challenge({token: this.cache.token});
+    const response = await this.api.challenge({token: this.cache.token});
+
+    return handleApiResponse(response);
   }
 
-  async verify({code}: VerifyParams) {
+  async verify({code}: VerifyParams): Promise<AuthsignalResponse<VerifyResponse>> {
     if (!this.cache.token) {
       return this.cache.handleTokenNotSetError();
     }
 
-    const verifyResponse = await this.api.verify({token: this.cache.token, code});
+    const response = await this.api.verify({token: this.cache.token, code});
 
-    if ("accessToken" in verifyResponse && verifyResponse.accessToken) {
-      this.cache.token = verifyResponse.accessToken;
+    if ("accessToken" in response && response.accessToken) {
+      this.cache.token = response.accessToken;
     }
 
-    return verifyResponse;
+    return handleApiResponse(response);
   }
 }