chore: publish-only-dist-jc by ryanbas21 · Pull Request #509 · ForgeRock/ping-javascript-sdk

ryanbas21 · 2025-12-22T20:59:25Z

JIRA Ticket

N/A

Description

Noticed some dirs were part of the snapshot that shouldn't have been.

Summary by CodeRabbit

Chores
- Package config updated to include built distribution files in releases.
- Development tooling consolidated; test/build packages replaced with internal catalog entries.
- Workspace configuration normalized (formatting and catalog entries) with minor metadata adjustments.
Documentation
- Added TypeDoc configuration to generate package API docs from source and build outputs.

changeset-bot · 2025-12-22T20:59:28Z

⚠️ No Changeset found

Latest commit: 42c5eac

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

coderabbitai · 2025-12-22T20:59:35Z

📝 Walkthrough

Walkthrough

Added a files field to packages/journey-client/package.json, moved Vite/Vitest-related packages to catalog-based dev entries, added packages/journey-client/typedoc.json declaring packageName and entryPoints, and normalized quoting plus added a vitest-canvas-mock catalog entry in pnpm-workspace.yaml.

Changes

Cohort / File(s)	Summary
Package metadata `packages/journey-client/package.json`	Added `"files": ["dist"]`; removed direct `vite`/`@vitest/coverage-v8`/`vitest` from deps/devDeps and replaced with `vitest`: `catalog:vitest` and `vitest-canvas-mock`: `catalog:vitest`; kept `tslib`. No public API changes.
Typedoc config `packages/journey-client/typedoc.json`	New Typedoc config: `packageName` set to `@forgerock/journey-client` and `entryPoints` include `src/index.ts`, `src/types.ts`, plus compiled JS under `src/lib/...`.
Workspace config `pnpm-workspace.yaml`	Normalized quoting (single → double), added `vitest-canvas-mock` under the `vitest` catalog, and adjusted `save-prefix` normalization; package globs and exclusions unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

cerebrl
spetrov

Poem

I'm a rabbit in a code-filled den,
Moved test tools to catalogs and tidied when.
Typedoc now knows where source and builds play,
Dist will be packed and ready to sway.
🐇✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'chore: publish-only-dist-jc' is somewhat vague and abbreviated. While it references the journey-client package and distribution publishing, the abbreviation 'jc' and lack of clarity about the specific problem (snapshot directories) make it unclear.	Consider a more descriptive title like 'chore: exclude non-dist directories from journey-client package snapshot' to clarify the intent.
Description check	❓ Inconclusive	The description mentions removing unintended directories from a snapshot but lacks detail. It does not explain what was changed, why, or provide context about the specific configuration changes made.	Expand the description to explain which directories were removed, how package.json and typedoc.json changes address the issue, and how this affects the package distribution.

✅ Passed checks (1 passed)

Check name	Status	Explanation
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 unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch update-dist-dir-publish

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.}

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between af4bf4c and 624ef2f.

📒 Files selected for processing (1)

packages/journey-client/package.json

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-10-22T15:14:00.044Z

Learnt from: ryanbas21
Repo: ForgeRock/ping-javascript-sdk PR: 430
File: packages/journey-client/src/lib/callbacks/name-callback.ts:9-15
Timestamp: 2025-10-22T15:14:00.044Z
Learning: In packages/journey-client, callback classes are internal implementation details not part of the public API. The callbacks barrel (src/lib/callbacks/index.ts) intentionally only exports the base JourneyCallback class. Internal code imports concrete callback classes directly from their individual files (e.g., factory.ts, journey-client.ts).

Applied to files:

packages/journey-client/package.json

packages/journey-client/package.json

coderabbitai · 2025-12-22T21:02:43Z

packages/journey-client/package.json

    "vite": "6.4.1",
-    "vitest": "^1.2.0"
+    "vitest": "^1.2.0",
+    "vitest-canvas-mock": "^0.3.3"


⚠️ Potential issue | 🔴 Critical

Upgrade dependencies to current versions — vite 6.4.1 and vitest ^1.2.0 are significantly outdated.

The current stable vite version is 7.2, and the latest vitest version is 4.0.15 (as of December 2025). Your pinned versions are critically behind:

Vite 7 requires Vitest 3.2+ for testing environments, but you have vitest ^1.2.0

Vitest 1.2.0 predates Vitest 3 and 4 releases and lacks compatibility with current Vite versions

For vitest-canvas-mock, the latest version is 1.1.3 with active maintenance showing at least one new version released in the past 3 months, not 0.3.3

Also address the inconsistency: vite is pinned to 6.4.1 (exact version) while vitest and vitest-canvas-mock use caret ranges. Adopt a consistent versioning strategy across all dev dependencies.

🤖 Prompt for AI Agents

packages/journey-client/package.json lines 36-38: dev dependencies are pinned to old/inconsistent versions; update "vite" to "^7.2.0", "vitest" to "^4.0.15", and "vitest-canvas-mock" to "^1.1.3" (or to the current latest stable), and make versioning consistent (use caret ranges for all devDependencies), then run npm/yarn install and adjust vitest/Vite config if required for breaking changes (e.g., update test environment/config keys to match Vitest 4 and Vite 7 compatibility).

nx-cloud · 2026-01-06T22:55:59Z

View your CI Pipeline Execution ↗ for commit 42c5eac

Command	Status	Duration	Result
`nx affected -t build lint test e2e-ci`	❌ Failed	2m 15s	View ↗

☁️ Nx Cloud last updated this comment at 2026-02-05 22:17:34 UTC

pkg-pr-new · 2026-01-06T22:58:06Z

Open in StackBlitz

@forgerock/davinci-client

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

@forgerock/device-client

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

@forgerock/journey-client

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

@forgerock/oidc-client

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

@forgerock/protect

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

@forgerock/sdk-types

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

@forgerock/sdk-utilities

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

@forgerock/iframe-manager

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

@forgerock/sdk-logger

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

@forgerock/sdk-oidc

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

@forgerock/sdk-request-middleware

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

@forgerock/storage

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

commit: a331fe1

github-actions · 2026-01-06T22:58:32Z

Deployed 3f6c262 to https://ForgeRock.github.io/ping-javascript-sdk/pr-509/3f6c262c464bae3996fb433472b13ea29484117e branch gh-pages in ForgeRock/ping-javascript-sdk

github-actions · 2026-01-06T22:58:38Z

📦 Bundle Size Analysis

🚨 Significant Changes

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

📊 Minor Changes

📈 @forgerock/journey-client - 82.4 KB (+0.0 KB)

➖ No Changes

➖ @forgerock/device-client - 9.2 KB
➖ @forgerock/oidc-client - 23.4 KB
➖ @forgerock/protect - 150.1 KB
➖ @forgerock/sdk-utilities - 7.5 KB
➖ @forgerock/sdk-types - 8.0 KB
➖ @forgerock/storage - 1.4 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.5 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-01-06T23:04:11Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 18.81%. Comparing base (b89ad58) to head (a331fe1).
⚠️ Report is 19 commits behind head on main.

❌ Your project status has failed because the head coverage (18.81%) 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     #509      +/-   ##
==========================================
+ Coverage   18.79%   18.81%   +0.02%     
==========================================
  Files         140      140              
  Lines       27640    27647       +7     
  Branches      980      981       +1     
==========================================
+ Hits         5195     5202       +7     
  Misses      22445    22445

🚀 New features to boost your workflow:

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

ancheetah

Thanks for catching these Ryan. Do we need a typedoc.json as well?

ancheetah · 2026-02-05T18:18:49Z

packages/journey-client/package.json

    "@vitest/coverage-v8": "^1.2.0",
    "vite": "6.4.1",
-    "vitest": "^1.2.0"
+    "vitest": "^1.2.0",


vitest: catalog?

packages/journey-client/package.json

ancheetah · 2026-02-05T18:22:30Z

packages/journey-client/package.json

  },
  "devDependencies": {
    "@vitest/coverage-v8": "^1.2.0",
    "vite": "6.4.1",


why do we need vite at all in this package?

nx-cloud

Nx Cloud has identified a flaky task in your failed CI:

🔂 Since the failure was identified as flaky, we triggered a CI rerun by adding an empty commit to this branch.

View detailed reasoning in Nx Cloud ↗

_{🎓 Learn more about Self-Healing CI on nx.dev}

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@packages/journey-client/package.json`:
- Around line 35-36: The package.json entry for "vitest-canvas-mock" currently
uses the catalog alias "catalog:vitest" which is invalid because that package
isn't listed in the vitest catalog; either add "vitest-canvas-mock": "^0.3.3" to
the vitest catalog in pnpm-workspace.yaml under catalogs.vitest, or change the
dependency in packages/journey-client/package.json to a direct version string
(e.g., "^0.3.3") so the resolver can find it; update the "vitest-canvas-mock"
dependency key accordingly and keep "vitest" as-is.

packages/journey-client/package.json

coderabbitai bot reviewed Dec 22, 2025

View reviewed changes

ryanbas21 force-pushed the update-dist-dir-publish branch from 624ef2f to a331fe1 Compare January 6, 2026 22:55

ancheetah reviewed Feb 5, 2026

View reviewed changes

ryanbas21 added 2 commits February 5, 2026 13:28

chore: publish-only-dist-jc

f0f3f27

chore: add-typedoc-to-journey-client

81c49e1

ryanbas21 force-pushed the update-dist-dir-publish branch from d63c564 to 9cc3d20 Compare February 5, 2026 20:28

This comment was marked as outdated.

Sign in to view

nx-cloud bot reviewed Feb 5, 2026

View reviewed changes

ryanbas21 force-pushed the update-dist-dir-publish branch from dac117b to 134385b Compare February 5, 2026 20:56

coderabbitai bot reviewed Feb 5, 2026

View reviewed changes

packages/journey-client/package.json Show resolved Hide resolved

chore: add-typedoc-to-journey-client

42c5eac

ryanbas21 force-pushed the update-dist-dir-publish branch from 134385b to 42c5eac Compare February 5, 2026 22:14

ancheetah approved these changes Feb 5, 2026

View reviewed changes

Conversation

ryanbas21 commented Dec 22, 2025 • 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 Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Dec 22, 2025 • 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!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

nx-cloud bot commented Jan 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 Jan 6, 2026

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

github-actions bot commented Jan 6, 2026

📦 Bundle Size Analysis

📦 Bundle Size Analysis

🚨 Significant Changes

Legend

Uh oh!

codecov-commenter commented Jan 6, 2026

Codecov Report

Uh oh!

ancheetah left a comment

Choose a reason for hiding this comment

Uh oh!

ancheetah Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

ryanbas21 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ancheetah Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

ryanbas21 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

nx-cloud bot left a comment

Choose a reason for hiding this comment

Nx Cloud has identified a flaky task in your failed CI:

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

ryanbas21 commented Dec 22, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Dec 22, 2025 •

edited

Loading

coderabbitai bot commented Dec 22, 2025 •

edited

Loading

nx-cloud bot commented Jan 6, 2026 •

edited

Loading