feat!: update auth.createRegisterTransaction and user.revokeDevice signatures to use two separate arguments (#83)

Author: ctran88

src/classes/Auth/Auth.spec.ts

@@ -15,10 +15,7 @@ describe('Auth e2e', () => {
 
     describe('createRegisterTransaction', () => {
         it('should return the transaction ID', async () => {
-            const transactionId = await passage.auth.createRegisterTransaction({
-                externalId: 'test',
-                passkeyDisplayName: 'test',
-            });
+            const transactionId = await passage.auth.createRegisterTransaction('test', 'test');
             expect(transactionId).toEqual(expect.any(String));
         });
     });

src/classes/Auth/Auth.ts

@@ -1,6 +1,5 @@
 import { AuthenticateApi, TransactionsApi } from '../../generated';
 import { PassageBase, PassageInstanceConfig } from '../PassageBase';
-import { RegisterTransactionArgs } from './types';
 
 /**
  * Auth class that provides methods for creating and validating passkey transactions.
@@ -22,14 +21,18 @@ export class Auth extends PassageBase {
     /**
      * Create a transaction to start a user's registration process
      *
-     * @param {RegisterTransactionArgs} args The required values to create a transaction
+     * @param {string} externalId The external ID of the user to register
+     * @param {string} passkeyDisplayName The display name of the passkey to use
      * @return {Promise<string>} The transaction ID
      */
-    public async createRegisterTransaction(args: RegisterTransactionArgs): Promise<string> {
+    public async createRegisterTransaction(externalId: string, passkeyDisplayName: string): Promise<string> {
         try {
             const response = await this.transactionClient.createRegisterTransaction({
                 appId: this.config.appId,
-                registerTransactionArgs: args,
+                registerTransactionArgs: {
+                    externalId,
+                    passkeyDisplayName,
+                },
             });
 
             return response.transactionId;

src/classes/Auth/index.ts

@@ -1,2 +1 @@
 export * from './Auth';
-export * from './types';

src/classes/Auth/types.ts

@@ -1,6 +1,6 @@
 import { ResponseError, UserDevicesApi, UserInfo, UsersApi, WebAuthnDevices } from '../../generated';
 import { PassageBase, PassageInstanceConfig } from '../PassageBase';
-import { PassageUser, RevokeDeviceArgs } from './types';
+import { PassageUser } from './types';
 
 /**
  * User class for handling operations to get and update user information.
@@ -77,16 +77,17 @@ export class User extends PassageBase {
     /**
      * Revoke a user's device by their external ID and the device ID
      *
-     * @param {RevokeDeviceArgs} args The external ID used to associate the user with Passage and the device ID
+     * @param {string} externalId The external ID of the user whose device to revoke
+     * @param {string} deviceId The device ID to revoke
      * @return {Promise<void>}
      */
-    public async revokeDevice(args: RevokeDeviceArgs): Promise<void> {
+    public async revokeDevice(externalId: string, deviceId: string): Promise<void> {
         try {
-            const user = await this.get(args.externalId);
+            const user = await this.get(externalId);
             await this.deviceClient.deleteUserDevices({
                 appId: this.config.appId,
-                deviceId: args.deviceId,
                 userId: user.id,
+                deviceId,
             });
         } catch (err) {
             throw await this.parseError(err);

src/classes/User/User.ts

@@ -14,9 +14,4 @@ export interface PassageUser {
     webauthnTypes: WebAuthnType[];
 }
 
-export interface RevokeDeviceArgs {
-    externalId: string;
-    deviceId: string;
-}
-
 export { UserStatus, WebAuthnDevices, WebAuthnType, WebAuthnIcons };