feat: expose client return types by ancheetah · Pull Request #527 · ForgeRock/ping-javascript-sdk

ancheetah · 2026-02-06T21:52:52Z

JIRA Ticket

Description

Summary by CodeRabbit

New Features
- Exposed return types for device client, journey client, and OIDC client across three packages. These type definitions enhance TypeScript support and IDE assistance for developers integrating these libraries.

changeset-bot · 2026-02-06T21:52:56Z

🦋 Changeset detected

Latest commit: bca228e

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

This PR includes changesets to release 12 packages

Name	Type
@forgerock/journey-client	Minor
@forgerock/device-client	Minor
@forgerock/oidc-client	Minor
@forgerock/davinci-client	Minor
@forgerock/protect	Minor
@forgerock/sdk-types	Minor
@forgerock/sdk-utilities	Minor
@forgerock/iframe-manager	Minor
@forgerock/sdk-logger	Minor
@forgerock/sdk-oidc	Minor
@forgerock/sdk-request-middleware	Minor
@forgerock/storage	Minor

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

coderabbitai · 2026-02-06T21:53:11Z

📝 Walkthrough

Walkthrough

Three packages (device-client, journey-client, oidc-client) receive minor version bumps and now expose their client return types through new TypeScript type aliases, making the resolved client interfaces part of the public API surface.

Changes

Cohort / File(s)	Summary
Changeset Documentation `.changeset/lovely-cloths-sin.md`	Declares minor version bumps for three packages with note "Expose return types for clients".
Device Client Type Export `packages/device-client/src/lib/types/index.ts`	Adds import and exports `DeviceClient` type alias capturing the return type of the deviceClient store function.
Journey Client Type Exports `packages/journey-client/src/lib/client.types.ts`, `packages/journey-client/src/types.ts`	New file exports `JourneyClient` type alias for the awaited return type of journey function; re-exported via main types module.
OIDC Client Type Export `packages/oidc-client/src/lib/client.types.ts`	Adds new file exporting `OidcClient` type alias for the awaited return type of the oidc store function.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

ryanbas21
cerebrl

Poem

🐰 Three packages now reveal their types so bright,
Return types exposed, the API's set just right,
Device, journey, oidc—all with minor bumps,
Version harmony across the client lumps!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description contains only template placeholders with no substantive information about the changes, objectives, or changeset status.	Fill in the Description section explaining what types are exposed and why, and confirm whether a changeset was added (it appears one was based on the file summary).

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: exposing client return types across three packages (device-client, journey-client, oidc-client).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch client-types

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

nx-cloud · 2026-02-06T21:53:35Z

View your CI Pipeline Execution ↗ for commit bca228e

Command	Status	Duration	Result
`nx run-many -t build --no-agents`	✅ Succeeded	<1s	View ↗
`nx affected -t build lint test e2e-ci`	✅ Succeeded	3m 46s	View ↗

☁️ Nx Cloud last updated this comment at 2026-02-06 21:57:58 UTC

pkg-pr-new · 2026-02-06T21:58:27Z

Open in StackBlitz

@forgerock/davinci-client

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/davinci-client@527

@forgerock/device-client

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/device-client@527

@forgerock/journey-client

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/journey-client@527

@forgerock/oidc-client

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/oidc-client@527

@forgerock/protect

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/protect@527

@forgerock/sdk-types

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/sdk-types@527

@forgerock/sdk-utilities

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/sdk-utilities@527

@forgerock/iframe-manager

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/iframe-manager@527

@forgerock/sdk-logger

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/sdk-logger@527

@forgerock/sdk-oidc

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/sdk-oidc@527

@forgerock/sdk-request-middleware

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/sdk-request-middleware@527

@forgerock/storage

pnpm add https://pkg.pr.new/ForgeRock/ping-javascript-sdk/@forgerock/storage@527

commit: bca228e

github-actions · 2026-02-06T21:58:52Z

Deployed c5b87d9 to https://ForgeRock.github.io/ping-javascript-sdk/pr-527/c5b87d9c73eb910de12c26e6243d769ddd6fc363 branch gh-pages in ForgeRock/ping-javascript-sdk

github-actions · 2026-02-06T21:58:58Z

📦 Bundle Size Analysis

🚨 Significant Changes

🔻 @forgerock/journey-client - 0.0 KB (-82.5 KB, -100.0%)

📊 Minor Changes

📉 @forgerock/device-client - 9.1 KB (-0.1 KB)
📈 @forgerock/oidc-client - 23.5 KB (+0.0 KB)
📈 @forgerock/journey-client - 82.8 KB (+0.2 KB)

➖ No Changes

➖ @forgerock/protect - 150.1 KB
➖ @forgerock/sdk-utilities - 8.5 KB
➖ @forgerock/sdk-types - 8.0 KB
➖ @forgerock/storage - 1.5 KB
➖ @forgerock/sdk-logger - 1.6 KB
➖ @forgerock/iframe-manager - 2.4 KB
➖ @forgerock/sdk-request-middleware - 4.5 KB
➖ @forgerock/sdk-oidc - 2.6 KB
➖ @forgerock/davinci-client - 39.8 KB

13 packages analyzed • Baseline from latest main build

Legend

🆕 New package
🔺 Size increased
🔻 Size decreased
➖ No change

ℹ️ How bundle sizes are calculated

Current Size: Total gzipped size of all files in the package's dist directory
Baseline: Comparison against the latest build from the main branch
Files included: All build outputs except source maps and TypeScript build cache
Exclusions: .map, .tsbuildinfo, and .d.ts.map files

_{🔄 Updated automatically on each push to this PR}

codecov-commenter · 2026-02-06T21:59:48Z

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 18.82%. Comparing base (b89ad58) to head (bca228e).
⚠️ Report is 33 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/journey-client/src/types.ts	0.00%	1 Missing ⚠️

❌ Your patch status has failed because the patch coverage (0.00%) is below the target coverage (40.00%). You can increase the patch coverage or adjust the target coverage.
❌ Your project status has failed because the head coverage (18.82%) is below the target coverage (40.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #527      +/-   ##
==========================================
+ Coverage   18.79%   18.82%   +0.03%     
==========================================
  Files         140      142       +2     
  Lines       27640    27731      +91     
  Branches      980      990      +10     
==========================================
+ Hits         5195     5221      +26     
- Misses      22445    22510      +65

Files with missing lines	Coverage Δ
packages/device-client/src/lib/types/index.ts	`14.28% <ø> (ø)`
packages/oidc-client/src/lib/client.types.ts	`100.00% <ø> (ø)`
packages/journey-client/src/types.ts	`0.00% <0.00%> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

feat: expose client return types

bca228e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: expose client return types#527

feat: expose client return types#527
ancheetah wants to merge 1 commit intomainfrom
client-types

ancheetah commented Feb 6, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Feb 6, 2026

Uh oh!

coderabbitai bot commented Feb 6, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

nx-cloud bot commented Feb 6, 2026 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

codecov-commenter commented Feb 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Conversation

ancheetah commented Feb 6, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

JIRA Ticket

Description

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Feb 6, 2026

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

nx-cloud bot commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 6, 2026

📦 Bundle Size Analysis

📦 Bundle Size Analysis

🚨 Significant Changes

Legend

Uh oh!

codecov-commenter commented Feb 6, 2026

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

ancheetah commented Feb 6, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 6, 2026 •

edited

Loading

nx-cloud bot commented Feb 6, 2026 •

edited

Loading