@forgerock/device-client 0.0.0-beta-20251222204813

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ping Identity Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,253 @@
+# Device Client API
+
+The `deviceClient` API provides a structured interface for managing various types of devices including OATH devices, PUSH devices, WebAuthn devices, bound devices, and device profiles. This API leverages Redux Toolkit Query (RTK Query) for efficient data fetching and state management.
+
+## Table of Contents
+
+1. [Overview](#overview)
+2. [Installation](#installation)
+3. [Configuration](#configuration)
+4. [API Methods](#api-methods)
+
+   - [OATH Management](#oath-management)
+   - [PUSH Management](#push-management)
+   - [WebAuthn Management](#webauthn-management)
+   - [Bound Devices Management](#bound-devices-management)
+   - [Device Profiling Management](#device-profiling-management)
+
+5. [Example Usage](#example-usage)
+6. [Error Handling](#error-handling)
+7. [License](#license)
+
+## Overview
+
+The `deviceClient` function initializes the API client with the provided configuration options and sets up the Redux store with the necessary middleware and reducers.
+
+## Installation
+
+To install the necessary dependencies for using the `deviceClient`, run:
+
+```bash
+npm install @forgerock/device-client --save
+```
+
+## Configuration
+
+To configure the `deviceClient`, you need to provide a `ConfigOptions` object that includes the base URL for the server and the realm path.
+
+```typescript
+import { deviceClient } from '@forgerock/device-client';
+import { type ConfigOptions } from '@forgerock/javascript-sdk';
+
+const config: ConfigOptions = {
+  serverConfig: {
+    baseUrl: 'https://api.example.com',
+  },
+  realmPath: '/your-realm-path',
+};
+```
+
+If there is no realmPath or you wish to override the value, you can do so in the api call itself where you pass in the query.
+
+```typescript
+const apiClient = deviceClient(config);
+```
+
+## API Methods
+
+### OATH Management
+
+#### Methods
+
+- **get(query: RetrieveOathQuery): Promise<OathDevice[]>**
+- Retrieves Oath devices based on the specified query.
+
+- **delete(query: RetrieveOathQuery & { device: OathDevice }): Promise\<null>**
+- Deletes an Oath device based on the provided query and device information.
+
+### PUSH Management
+
+#### Methods
+
+- **get(query: PushDeviceQuery): Promise<PushDevice[]>**
+- Retrieves Push devices based on the specified query.
+
+- **delete(query: DeleteDeviceQuery): Promise\<null>**
+- Deletes a Push device based on the provided query.
+
+### WebAuthn Management
+
+#### Methods
+
+- **get(query: WebAuthnQuery): Promise<WebAuthnDevice[]>**
+- Retrieves WebAuthn devices based on the specified query.
+
+- **update(query: WebAuthnQuery & { device: WebAuthnDevice }): Promise\<UpdatedWebAuthnDevice>**
+- Updates the name of a WebAuthn device based on the provided query and body.
+
+- **delete(query: WebAuthnQuery & { device: WebAuthnDevice | UpdatedWebAuthnDevice }): Promise\<null>**
+- Deletes a WebAuthn device based on the provided query and body.
+
+### Bound Devices Management
+
+#### Methods
+
+- **get(query: GetBoundDevicesQuery): Promise\<Device[]>**
+- Retrieves bound devices based on the specified query.
+
+- **update(query: BoundDeviceQuery): Promise\<Device>**
+- Updates the name of a bound device based on the provided query.
+
+- **delete(query: BoundDeviceQuery): Promise\<null>**
+- Deletes a bound device based on the provided query.
+
+### Device Profiling Management
+
+#### Methods
+
+- **get(query: GetProfileDevices): Promise\<ProfileDevice[]>**
+- Retrieves device profiles based on the specified query.
+
+- **update(query: ProfileDevicesQuery): Promise\<ProfileDevice>**
+- Updates the name of a device profile based on the provided query.
+
+- **delete(query: ProfileDevicesQuery): Promise\<null>**
+- Deletes a device profile based on the provided query.
+
+## Example Usage
+
+### OATH Management Example
+
+```typescript
+const oathQuery: RetrieveOathQuery = {
+  /* your query parameters */
+};
+
+const getResponse = await apiClient.oath.get(oathQuery);
+console.log('Oath Devices:', getResponse);
+
+const deleteOathQuery: RetrieveOathQuery & { device: OathDevice } = {
+  /* your delete query */
+};
+
+const deleteResponse = await apiClient.oath.delete(deleteOathQuery);
+console.log('Deleted Oath Device:', deleteResponse);
+```
+
+### PUSH Management Example
+
+```typescript
+const pushQuery: PushDeviceQuery = {
+  /* your query parameters */
+};
+
+const getResponse = await apiClient.push.get(pushQuery);
+console.log('Push Devices:', getResponse);
+
+const deletePushQuery: DeleteDeviceQuery = {
+  /* your delete query */
+};
+
+const deleteResponse = await apiClient.push.delete(deletePushQuery);
+console.log('Deleted Push Device:', deleteResponse);
+```
+
+### WebAuthn Management Example
+
+```typescript
+const webAuthnQuery: WebAuthnQuery = {
+  /* your query parameters */
+};
+
+const getResponse = await apiClient.webAuthn.get(webAuthnQuery);
+console.log('WebAuthn Devices:', getResponse);
+
+const updateWebAuthnQuery: WebAuthnQuery & { device: WebAuthnDevice } = {
+  /* your update query */
+};
+
+const updateResponse = await apiClient.webAuthn.update(updateWebAuthnQuery);
+console.log('Updated WebAuthn Device:', updateResponse);
+
+const deleteWebAuthnQuery: WebAuthnQuery & { device: WebAuthnDevice | UpdatedWebAuthnDevice } = {
+  /* your delete query */
+};
+
+const deleteResponse = await apiClient.webAuthn.delete(deleteWebAuthnQuery);
+console.log('Deleted WebAuthn Device:', deleteResponse);
+```
+
+### Bound Devices Management Example
+
+```typescript
+const bindingQuery: GetBoundDevicesQuery = {
+  /* your query parameters */
+};
+
+const getResponse = await apiClient.bound.get(bindingQuery);
+console.log('Bound Devices:', getResponse);
+
+const updateBindingQuery: BoundDeviceQuery = {
+  /* your update query */
+};
+
+const updateResponse = await apiClient.bound.update(updateBindingQuery);
+console.log('Updated Bound Device:', updateResponse);
+
+const deleteBindingQuery: BoundDeviceQuery = {
+  /* your delete query */
+};
+
+const deleteResponse = await apiClient.bound.delete(deleteBindingQuery);
+console.log('Deleted Bound Device:', deleteResponse);
+```
+
+### Device Profiling Management Example
+
+```typescript
+const profileQuery: GetProfileDevices = {
+  /* your query parameters */
+};
+
+const getResponse = await apiClient.profile.get(profileQuery);
+console.log('Device Profiles:', getResponse);
+
+const updateProfileQuery: ProfileDevicesQuery = {
+  /* your update query */
+};
+
+const updateResponse = await apiClient.profile.update(updateProfileQuery);
+console.log('Updated Device Profile:', updateResponse);
+
+const deleteProfileQuery: ProfileDevicesQuery = {
+  /* your delete query */
+};
+
+const deleteResponse = await apiClient.profile.delete(deleteProfileQuery);
+console.log('Deleted Device Profile:', deleteResponse);
+```
+
+## Error Handling
+
+When a device client method makes a request to the server and the response is not valid, it will return a promise that resolves to an error object `{ error: unknown }`. For example, to handle WebAuthn device management errors:
+
+```typescript
+const getResponse = await apiClient.webAuthn.get(query);
+if (!Array.isArray(getResponse) || 'error' in getResponse) {
+  // handle get device error
+}
+
+const updateResponse = await apiClient.webAuthn.update(query);
+if ('error' in updateResponse) {
+  // handle update device error
+}
+
+const deleteResponse = await apiClient.webAuthn.delete(query);
+if (deleteResponse !== null && 'error' in deleteResponse) {
+  // handle delete device error
+}
+```
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/device.store.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAMA,cAAc,uBAAuB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+export * from './lib/device.store.js';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,cAAc,uBAAuB,CAAC"}

package/dist/src/lib/device.store.d.ts

@@ -0,0 +1,186 @@
+import { type ConfigOptions } from '@forgerock/javascript-sdk';
+import { OathDevice, RetrieveOathQuery } from './types/oath.types.js';
+import { DeleteDeviceQuery, PushDevice, PushDeviceQuery } from './types/push-device.types.js';
+import { UpdatedWebAuthnDevice, WebAuthnDevice, WebAuthnQuery } from './types/webauthn.types.js';
+import { BoundDeviceQuery, Device, GetBoundDevicesQuery } from './types/bound-device.types.js';
+import { GetProfileDevices, ProfileDevice, ProfileDevicesQuery } from './types/profile-device.types.js';
+/**
+ * @function deviceClient
+ * @description Returns a device management object containing methods for handling various device types
+ * @param {ConfigOptions} config The configuration options for the device client
+ * @returns Methods for handling various device types
+ */
+export declare const deviceClient: (config: ConfigOptions) => {
+    /**
+     * Oath device management methods.
+     */
+    oath: {
+        /**
+         * Retrieves Oath devices based on the specified query.
+         *
+         * @async
+         * @function get
+         * @param {RetrieveOathQuery} query - The query used to retrieve Oath devices.
+         * @returns {Promise<OathDevice[] | { error: unknown }>} - A promise that resolves to the retrieved data or an error object if the response is not valid.
+         */
+        get: (query: RetrieveOathQuery) => Promise<OathDevice[] | {
+            error: unknown;
+        }>;
+        /**
+         * Deletes an Oath device based on the provided query and device information.
+         *
+         * @async
+         * @function delete
+         * @param {RetrieveOathQuery & { device: OathDevice }} query - The query and device information used to delete the Oath device.
+         * @returns {Promise<null | { error: unknown }>} - A promise that resolves to null or an error object if the response is not valid.
+         */
+        delete: (query: RetrieveOathQuery & {
+            device: OathDevice;
+        }) => Promise<null | {
+            error: unknown;
+        }>;
+    };
+    /**
+     * Push device management methods.
+     */
+    push: {
+        /**
+         * Retrieves Push devices based on the specified query.
+         *
+         * @async
+         * @function get
+         * @param {PushDeviceQuery} query - The query used to retrieve Push devices.
+         * @returns {Promise<PushDevice[] | { error: unknown }>} - A promise that resolves to the retrieved data or an error object if the response is not valid.
+         */
+        get: (query: PushDeviceQuery) => Promise<PushDevice[] | {
+            error: unknown;
+        }>;
+        /**
+         * Deletes a Push device based on the provided query.
+         *
+         * @async
+         * @function delete
+         * @param {DeleteDeviceQuery} query - The query used to delete the Push device.
+         * @returns {Promise<null | { error: unknown }>} - A promise that resolves to null or an error object if the response is not valid.
+         */
+        delete: (query: DeleteDeviceQuery) => Promise<null | {
+            error: unknown;
+        }>;
+    };
+    /**
+     * WebAuthn device management methods.
+     */
+    webAuthn: {
+        /**
+         * Retrieves WebAuthn devices based on the specified query.
+         *
+         * @async
+         * @function get
+         * @param {WebAuthnQuery} query - The query used to retrieve WebAuthn devices.
+         * @returns {Promise<WebAuthnDevice[] | { error: unknown }>} - A promise that resolves to the retrieved data or an error object if the response is not valid.
+         */
+        get: (query: WebAuthnQuery) => Promise<WebAuthnDevice[] | {
+            error: unknown;
+        }>;
+        /**
+         * Updates the name of a WebAuthn device based on the provided query and body.
+         *
+         * @async
+         * @function update
+         * @param {WebAuthnQuery & { device: WebAuthnDevice }} query - The query and body used to update the WebAuthn device name.
+         * @returns {Promise<UpdatedWebAuthnDevice | { error: unknown }>} - A promise that resolves to the response data or an error object if the response is not valid.
+         */
+        update: (query: WebAuthnQuery & {
+            device: WebAuthnDevice;
+        }) => Promise<UpdatedWebAuthnDevice | {
+            error: unknown;
+        }>;
+        /**
+         * Deletes a WebAuthn device based on the provided query and body.
+         *
+         * @async
+         * @function delete
+         * @param {WebAuthnQuery & { device: WebAuthnDevice | UpdatedWebAuthnDevice }} query - The query and body used to delete the WebAuthn device.
+         * @returns {Promise<null | { error: unknown }>} - A promise that resolves to null or an error object if the response is not valid.
+         */
+        delete: (query: WebAuthnQuery & {
+            device: WebAuthnDevice | UpdatedWebAuthnDevice;
+        }) => Promise<null | {
+            error: unknown;
+        }>;
+    };
+    /**
+     * Bound devices management methods.
+     */
+    bound: {
+        /**
+         * Retrieves bound devices based on the specified query.
+         *
+         * @async
+         * @function get
+         * @param {GetBoundDevicesQuery} query - The query used to retrieve bound devices.
+         * @returns {Promise<Device[] | { error: unknown }>} - A promise that resolves to the retrieved data or an error object if the response is not valid.
+         */
+        get: (query: GetBoundDevicesQuery) => Promise<Device[] | {
+            error: unknown;
+        }>;
+        /**
+         * Deletes a bound device based on the provided query.
+         *
+         * @async
+         * @function delete
+         * @param {BoundDeviceQuery} query - The query used to delete the bound device.
+         * @returns {Promise<null | { error: unknown }>} - A promise that resolves to null or an error object if the response is not valid.
+         */
+        delete: (query: BoundDeviceQuery) => Promise<null | {
+            error: unknown;
+        }>;
+        /**
+         * Updates the name of a bound device based on the provided query.
+         *
+         * @async
+         * @function update
+         * @param {BoundDeviceQuery} query - The query used to update the bound device name.
+         * @returns {Promise<Device | { error: unknown }>} - A promise that resolves to the response data or an error object if the response is not valid.
+         */
+        update: (query: BoundDeviceQuery) => Promise<Device | {
+            error: unknown;
+        }>;
+    };
+    profile: {
+        /**
+         * Get profile devices
+         *
+         * @async
+         * @function update
+         * @param {GetProfileDevices} query - The query used to get profile devices
+         * @returns {Promise<ProfileDevice[] | { error: unknown }>} - A promise that resolves to the response data or an error object if the response is not valid.
+         */
+        get: (query: GetProfileDevices) => Promise<ProfileDevice[] | {
+            error: unknown;
+        }>;
+        /**
+         * Get profile devices
+         *
+         * @async
+         * @function update
+         * @param {ProfileDevicesQuery} query - The query used to update a profile device
+         * @returns {Promise<ProfileDevice | { error: unknown }>} - A promise that resolves to the response data or or an error object if the response is not valid.
+         */
+        update: (query: ProfileDevicesQuery) => Promise<ProfileDevice | {
+            error: unknown;
+        }>;
+        /**
+         * Get profile devices
+         *
+         * @async
+         * @function update
+         * @param {ProfileDevicesQuery} query - The query used to update a profile device
+         * @returns {Promise<null | { error: unknown }>} - A promise that resolves to null or an error object if the response is not valid.
+         */
+        delete: (query: ProfileDevicesQuery) => Promise<null | {
+            error: unknown;
+        }>;
+    };
+};
+//# sourceMappingURL=device.store.d.ts.map

package/dist/src/lib/device.store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.store.d.ts","sourceRoot":"","sources":["../../../src/lib/device.store.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAG/D,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACjG,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC/F,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACpB,MAAM,iCAAiC,CAAC;AAGzC;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,aAAa;IAc9C;;OAEG;;QAED;;;;;;;WAOG;qBACyB,iBAAiB,KAAG,OAAO,CAAC,UAAU,EAAE,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QAc1F;;;;;;;WAOG;wBAEM,iBAAiB,GAAG;YAAE,MAAM,EAAE,UAAU,CAAA;SAAE,KAChD,OAAO,CAAC,IAAI,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;;IAevC;;OAEG;;QAED;;;;;;;WAOG;qBACyB,eAAe,KAAG,OAAO,CAAC,UAAU,EAAE,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QAcxF;;;;;;;WAOG;wBAC4B,iBAAiB,KAAG,OAAO,CAAC,IAAI,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;;IAevF;;OAEG;;QAED;;;;;;;WAOG;qBACyB,aAAa,KAAG,OAAO,CAAC,cAAc,EAAE,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QAc1F;;;;;;;WAOG;wBAEM,aAAa,GAAG;YAAE,MAAM,EAAE,cAAc,CAAA;SAAE,KAChD,OAAO,CAAC,qBAAqB,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QActD;;;;;;;WAOG;wBAEM,aAAa,GAAG;YAAE,MAAM,EAAE,cAAc,GAAG,qBAAqB,CAAA;SAAE,KACxE,OAAO,CAAC,IAAI,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;;IAiBvC;;OAEG;;QAED;;;;;;;WAOG;qBACyB,oBAAoB,KAAG,OAAO,CAAC,MAAM,EAAE,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QAczF;;;;;;;WAOG;wBAC4B,gBAAgB,KAAG,OAAO,CAAC,IAAI,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QAcpF;;;;;;;WAOG;wBAC4B,gBAAgB,KAAG,OAAO,CAAC,MAAM,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;;;QAetF;;;;;;;WAOG;qBAEM,iBAAiB,KACvB,OAAO,CAAC,aAAa,EAAE,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QAahD;;;;;;;WAOG;wBAEM,mBAAmB,KACzB,OAAO,CAAC,aAAa,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QAa9C;;;;;;;WAOG;wBAC4B,mBAAmB,KAAG,OAAO,CAAC,IAAI,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;;CAe5F,CAAC"}