chore: adding-tests

added unit tests using msw to the client

Author: ryanbas21

.changeset/config.json

@@ -7,13 +7,12 @@
     }
   ],
   "commit": false,
-  "fixed": [],
+  "fixed": [["@forgerock/*"]],
   "linked": [],
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
   "ignore": [
-    "@forgerock/*",
     "@forgerock/davinci-app",
     "@forgerock/davinci-suites",
     "@forgerock/mock-api-v2"

.changeset/old-phones-explain.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/device-client': patch
+---
+
+small changes to the device api. align with other platforms.

packages/device-client/README.md

@@ -163,11 +163,7 @@ apiClient.push
 ### WebAuthn Management Example
 
 ```typescript
-const webAuthnQuery: WebAuthnQuery = {
-  /* your query parameters */
-};
-
-apiClient.webauthn
+apiClient.webAuthn
   .get(webAuthnQuery)
   .then((response) => {
     console.log('WebAuthn Devices:', response);
@@ -180,7 +176,7 @@ const updateWebAuthnQuery: WebAuthnQueryWithUUID & WebAuthnBody = {
   /* your update query */
 };
 
-apiClient.webauthn
+apiClient.webAuthn
   .update(updateWebAuthnQuery)
   .then((response) => {
     console.log('Updated WebAuthn Device:', response);
@@ -193,7 +189,7 @@ const deleteWebAuthnQuery: WebAuthnQueryWithUUID & WebAuthnBody = {
   /* your delete query */
 };
 
-apiClient.webauthn
+apiClient.webAuthn
   .delete(deleteWebAuthnQuery)
   .then((response) => {
     console.log('Deleted WebAuthn Device:', response);
@@ -206,7 +202,7 @@ apiClient.webauthn
 ### Bound Devices Management Example
 
 ```typescript const bindingQuery: BindingDeviceQuery = { /* your query parameters */ };
-apiClient.boundDevices
+apiClient.bound
   .get(bindingQuery)
   .then((response) => {
     console.log('Bound Devices:', response);
@@ -219,7 +215,7 @@ const deleteBindingQuery: BindingDeviceQuery = {
   /* your delete query */
 };
 
-apiClient.boundDevices
+apiClient.bound
   .delete(deleteBindingQuery)
   .then((response) => {
     console.log('Deleted Bound Device:', response);
@@ -232,7 +228,7 @@ const updateBindingQuery: BindingDeviceQuery = {
   /* your update query */
 };
 
-apiClient.boundDevices
+apiClient.bound
   .update(updateBindingQuery)
   .then((response) => {
     console.log('Updated Bound Device:', response);

packages/device-client/package.json

@@ -14,11 +14,13 @@
   },
   "files": ["./dist"],
   "dependencies": {
-    "@reduxjs/toolkit": "catalog:",
     "@forgerock/javascript-sdk": "4.6.0",
+    "@reduxjs/toolkit": "catalog:",
     "immer": "catalog:"
   },
   "devDependencies": {
+    "@testing-library/react": "16.1.0",
+    "msw": "2.7.0",
     "vitest": "^1.4.0"
   },
   "scripts": {

packages/device-client/src/lib/device.store.test.ts

@@ -0,0 +1,210 @@
+import { http, HttpResponse } from 'msw';
+import { setupServer } from 'msw/node';
+import { deviceClient } from './device.store';
+
+import {
+  MOCK_PUSH_DEVICES,
+  MOCK_BINDING_DEVICES,
+  MOCK_OATH_DEVICES,
+  MOCK_DELETED_OATH_DEVICE,
+  MOCK_WEBAUTHN_DEVICES,
+} from './mock-data/msw-mock-data';
+
+// Create handlers
+export const handlers = [
+  // OATH Devices
+  http.get('*/devices/2fa/oath', () => {
+    return HttpResponse.json(MOCK_OATH_DEVICES);
+  }),
+
+  http.delete('*/devices/2fa/oath/:uuid', () => {
+    return HttpResponse.json(MOCK_DELETED_OATH_DEVICE);
+  }),
+
+  // Push Devices
+  http.get('*/devices/2fa/push', () => {
+    return HttpResponse.json(MOCK_PUSH_DEVICES);
+  }),
+
+  http.delete('*/devices/2fa/push/:uuid', () => {
+    return HttpResponse.json(MOCK_PUSH_DEVICES[0]);
+  }),
+
+  // WebAuthn Devices
+  http.get('*/devices/2fa/webauthn', () => {
+    return HttpResponse.json(MOCK_WEBAUTHN_DEVICES);
+  }),
+
+  http.put('*/devices/2fa/webauthn/:uuid', () => {
+    return HttpResponse.json({
+      ...MOCK_WEBAUTHN_DEVICES.result[0],
+      deviceName: 'Updated WebAuthn Device',
+    });
+  }),
+
+  http.delete('*/devices/2fa/webauthn/:uuid', () => {
+    return HttpResponse.json(MOCK_WEBAUTHN_DEVICES.result[0]);
+  }),
+
+  // Binding Devices
+  http.get('*/devices/2fa/binding', () => {
+    return HttpResponse.json(MOCK_BINDING_DEVICES);
+  }),
+
+  http.put('*/devices/2fa/binding/:uuid', () => {
+    return HttpResponse.json({
+      ...MOCK_BINDING_DEVICES.result[0],
+      deviceName: 'Updated Binding Device',
+    });
+  }),
+
+  http.delete('*/devices/2fa/binding/:uuid', () => {
+    return HttpResponse.json(MOCK_BINDING_DEVICES.result[0]);
+  }),
+];
+
+export const server = setupServer(...handlers);
+
+// Establish API mocking before all tests.
+beforeAll(() => server.listen({ onUnhandledRequest: 'error' }));
+
+// Reset any request handlers that we may add during the tests,
+// so they don't affect other tests.
+afterEach(() => server.resetHandlers());
+
+// Clean up after the tests are finished.
+afterAll(() => server.close());
+
+describe('Device Client Store', () => {
+  const config = {
+    serverConfig: {
+      baseUrl: 'https://api.example.com',
+    },
+    realmPath: 'test-realm',
+  };
+
+  describe('OATH Device Management', () => {
+    const client = deviceClient(config);
+
+    it('should fetch OATH devices', async () => {
+      const result = await client.oath.get({
+        userId: 'test-user',
+      });
+
+      expect(result).toEqual(MOCK_OATH_DEVICES);
+    });
+
+    it('should delete OATH device', async () => {
+      const result = await client.oath.delete({
+        userId: 'test-user',
+        uuid: 'oath-uuid-1',
+        deviceName: 'Test OATH Device',
+        id: 'test-id',
+        createdDate: new Date(1705555555555),
+        lastAccessDate: new Date(1705555555555),
+      });
+
+      expect(result).toEqual(MOCK_DELETED_OATH_DEVICE);
+    });
+  });
+
+  describe('Push Device Management', () => {
+    const client = deviceClient(config);
+
+    it('should fetch push devices', async () => {
+      const result = await client.push.get({
+        userId: 'test-user',
+      });
+
+      expect(result).toEqual(MOCK_PUSH_DEVICES);
+    });
+
+    it('should delete push device', async () => {
+      const result = await client.push.delete({
+        userId: 'test-user',
+        uuid: 'push-uuid-1',
+      });
+
+      expect(result).toEqual(MOCK_PUSH_DEVICES[0]);
+    });
+  });
+  describe('WebAuthn Device Management', () => {
+    const client = deviceClient(config);
+
+    it('should fetch webauthn devices', async () => {
+      const result = await client.webAuthn.get({
+        userId: 'test-user',
+      });
+
+      expect(result).toEqual(MOCK_WEBAUTHN_DEVICES);
+    });
+
+    it('should update webauthn device name', async () => {
+      const mockDevice = MOCK_WEBAUTHN_DEVICES.result[0];
+      const result = await client.webAuthn.update({
+        userId: 'test-user',
+        uuid: mockDevice.uuid,
+        id: mockDevice._id,
+        deviceName: 'Updated WebAuthn Device',
+        credentialId: mockDevice.credentialId,
+        createdDate: mockDevice.createdDate,
+        lastAccessDate: mockDevice.lastAccessDate,
+      });
+
+      expect(result).toEqual({
+        ...mockDevice,
+        deviceName: 'Updated WebAuthn Device',
+      });
+    });
+
+    it('should delete webauthn device', async () => {
+      const mockDevice = MOCK_WEBAUTHN_DEVICES.result[0];
+      const result = await client.webAuthn.delete({
+        userId: 'test-user',
+        uuid: mockDevice.uuid,
+        id: mockDevice._id,
+        deviceName: mockDevice.deviceName,
+        credentialId: mockDevice.credentialId,
+        createdDate: mockDevice.createdDate,
+        lastAccessDate: mockDevice.lastAccessDate,
+      });
+
+      expect(result).toEqual(mockDevice);
+    });
+  });
+
+  describe('Bound Device Management', () => {
+    const client = deviceClient(config);
+    const mockDevice = MOCK_BINDING_DEVICES.result[0];
+
+    it('should fetch bound devices', async () => {
+      const result = await client.bound.get({
+        userId: 'test-user',
+        ...mockDevice,
+      });
+
+      expect(result).toEqual(MOCK_BINDING_DEVICES);
+    });
+
+    it('should update bound device name', async () => {
+      const result = await client.bound.update({
+        userId: 'test-user',
+        ...mockDevice,
+      });
+
+      expect(result).toEqual({
+        ...mockDevice,
+        deviceName: 'Updated Binding Device',
+      });
+    });
+
+    it('should delete bound device', async () => {
+      const result = await client.bound.delete({
+        userId: 'test-user',
+        ...mockDevice,
+      });
+
+      expect(result).toEqual(mockDevice);
+    });
+  });
+});