feat: add-device-client #530

ryanbas21 · 2025-01-21T19:18:27Z

JIRA Ticket

https://pingidentity.atlassian.net/browse/SDKS-3413

Description

adds device client to the SDK package

changeset-bot · 2025-01-21T19:18:31Z

🦋 Changeset detected

Latest commit: 5d68b9f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@forgerock/javascript-sdk	Minor
@forgerock/davinci-client	Patch
@forgerock/ping-protect	Minor
@forgerock/token-vault	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

nx-cloud · 2025-01-21T19:19:17Z

View your CI Pipeline Execution ↗ for commit 5d68b9f.

Command	Status	Duration	Result
`nx affected -t build lint test docs e2e-ci --ve...`	✅ Succeeded	5m 12s	View ↗
`nx-cloud record -- nx format:check --verbose`	✅ Succeeded	10s	View ↗

☁️ Nx Cloud last updated this comment at 2025-01-26 16:28:35 UTC

ryanbas21 · 2025-01-21T19:19:27Z

.changeset/config.json

  "baseBranch": "master",
  "updateInternalDependencies": "patch",
  "ignore": [
-    "@forgerock/device-client",


package no longer exists.

ryanbas21 · 2025-01-21T19:19:39Z

e2e/autoscript-apps/package.json

  "type": "module",
  "dependencies": {
    "@forgerock/javascript-sdk": "workspace:*",
-    "@forgerock/device-client": "workspace:*",


no longer exists

ryanbas21 · 2025-01-21T19:19:54Z

e2e/autoscript-apps/src/authn-basic-self-service/autoscript.ts

 // @ts-nocheck
 import * as forgerock from '@forgerock/javascript-sdk';
-import { deviceClient } from '@forgerock/device-client';
+import { deviceClient } from '@forgerock/javascript-sdk/device-client';


added as both an export from . and from /device-client.

ryanbas21 · 2025-01-21T19:20:41Z

packages/javascript-sdk/src/index.ts

 import ChoiceCallback from './fr-auth/callbacks/choice-callback';
 import ConfirmationCallback from './fr-auth/callbacks/confirmation-callback';
 import DeviceProfileCallback from './fr-auth/callbacks/device-profile-callback';
+import { deviceClient } from './device-client';


added it because if i dont i have to add a new entry point in the vite config, not a big problem if we do not want it exported from here though.

ryanbas21 · 2025-01-21T19:20:57Z

packages/javascript-sdk/vite.config.ts

      name: 'javascript-sdk',
      formats: ['es', 'cjs'],
      fileName: (format, fileName) => {
+        console.log(fileName);


will remove.

It looks like this is still here.

codecov-commenter · 2025-01-21T19:26:05Z

Codecov Report

Attention: Patch coverage is 94.55081% with 37 lines in your changes missing coverage. Please review.

Project coverage is 58.91%. Comparing base (d1340c6) to head (5d68b9f).
Report is 2 commits behind head on develop.

Files with missing lines	Patch %	Lines
...s/javascript-sdk/src/device-client/device.store.ts	90.27%	36 Missing ⚠️
...es/javascript-sdk/src/device-client/types/index.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #530      +/-   ##
===========================================
+ Coverage    57.25%   58.91%   +1.66%     
===========================================
  Files          123      123              
  Lines        26967    27295     +328     
  Branches      1717     1776      +59     
===========================================
+ Hits         15439    16080     +641     
+ Misses       11528    11215     -313

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

fix types, add tests, fix tests, fix manual e2e

cerebrl

Mostly some naming fixes needed.

cerebrl · 2025-01-24T20:50:12Z

e2e/autoscript-apps/src/authn-basic-self-service/autoscript.ts

+  const un = url.searchParams.get('un') || 'spetrov';
  const platformHeader = url.searchParams.get('platformHeader') === 'true' ? true : false;
-  const pw = url.searchParams.get('pw') || 'Demo1234!';
+  const pw = url.searchParams.get('pw') || '1111';


Did we mean to commit this?

cerebrl · 2025-01-24T21:28:39Z

packages/javascript-sdk/src/device-client/services/index.ts

+      deleteOathDevice: builder.mutation<
+        DeletedOAthDevice,
+        RetrieveOathQuery & { device: OathDevice }


I see this quite often throughout the codebase. Can we make sure all references to "oath" are either OATH, Oath or oath? Currently, I see OAth quite a bit, which I'd like to correct to Oath.

cerebrl · 2025-01-24T21:30:20Z

packages/javascript-sdk/src/device-client/services/index.ts

        query: ({ realm = realmPath, userId }) =>
          `/json/realms/${realm}/users/${userId}/devices/2fa/binding?_queryFilter=true`,
      }),
      updateBindingDeviceName: builder.mutation<Device, BindingDeviceQuery>({


We're also not consistent here. Can we make sure to use bound and not binding? So, it would be getBoundDevices, updateBoundDeviceName and deleteBoundDevice.

cerebrl · 2025-01-24T21:31:42Z

packages/javascript-sdk/src/device-client/services/index.ts

          body: device satisfies Device,
        }),
      }),
+      getDeviceProfile: builder.query<GeneralResponse<ProfileDevice[]>, GetProfileDevices>({


Are we querying for a single profile here, or are we querying for all of the user's profiles. I would think all, so I'd expect the name to be plural: getDeviceProfiles.

cerebrl · 2025-01-24T21:33:07Z

packages/javascript-sdk/vite.config.ts

      name: 'javascript-sdk',
      formats: ['es', 'cjs'],
      fileName: (format, fileName) => {
+        console.log(fileName);


It looks like this is still here.

cerebrl · 2025-01-24T21:34:49Z

packages/javascript-sdk/src/device-client/types/oath.types.ts

  userId: string;
 };

 export type OAthResponse = {


Another naming inconsistency.

cerebrl · 2025-01-24T21:35:35Z

packages/javascript-sdk/src/device-client/types/binding-device.types.ts

  realm?: string;
-} & Device;
+};
+export type BindingDeviceQuery = GetBoundDevicesQuery & { device: Device };


"Binding" instead of "Bound".

renamed all per comments to better fit naming schemes

feat: add-device-client

db41dcc

adds device client to the SDK package

github-actions bot added docs root sdk test NX labels Jan 21, 2025

ryanbas21 commented Jan 21, 2025

View reviewed changes

cerebrl approved these changes Jan 22, 2025

View reviewed changes

chore: update-device-client

38bb433

fix types, add tests, fix tests, fix manual e2e

cerebrl requested changes Jan 24, 2025

View reviewed changes

ryanbas21 force-pushed the device-client-sdk branch from 1fa8030 to 3f2cdfc Compare January 24, 2025 22:52

cerebrl approved these changes Jan 24, 2025

View reviewed changes

ryanbas21 force-pushed the device-client-sdk branch 2 times, most recently from e2bc5c1 to 856b3fb Compare January 26, 2025 16:15

chore: pr-comments

5d68b9f

renamed all per comments to better fit naming schemes

ryanbas21 force-pushed the device-client-sdk branch from 856b3fb to 5d68b9f Compare January 26, 2025 16:21

ryanbas21 merged commit 74d2352 into develop Jan 27, 2025
5 checks passed

github-actions bot mentioned this pull request Jan 27, 2025

Release PR #528

Merged

feat: add-device-client #530

feat: add-device-client #530

Uh oh!

Conversation

ryanbas21 commented Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

JIRA Ticket

Description

Uh oh!

changeset-bot bot commented Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

nx-cloud bot commented Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cerebrl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

ryanbas21 commented Jan 21, 2025 •

edited

Loading

changeset-bot bot commented Jan 21, 2025 •

edited

Loading

nx-cloud bot commented Jan 21, 2025 •

edited

Loading

codecov-commenter commented Jan 21, 2025 •

edited

Loading