Releases: ForgeRock/ping-javascript-sdk
@forgerock/storage@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Patch Changes
-
#510
3c63979Thanks @ryanbas21! - Fix error handling in storage client and davinci-client- Add
isGenericErrortype guard to sdk-utilities for runtime error validation - Fix storage client to properly catch errors from custom storage implementations, honoring the errors-as-values contract
- Improve davinci-client error handling to use explicit error checks instead of try-catch
- Add
-
#526
5a9ea40Thanks @ancheetah! - Update READMES. Fix types and comments. -
Updated dependencies [
9ad4062,5a9ea40]:- @forgerock/sdk-types@2.0.0
@forgerock/sdk-utilities@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Minor Changes
-
#525
9a8ca14Thanks @ryanbas21! - ### @forgerock/journey-clientAdd well-known OIDC endpoint discovery support. The journey client can now fetch configuration from the
.well-known/openid-configurationendpoint. The realm path can be automatically inferred from the well-known issuer URL.@forgerock/sdk-oidc
Add shared well-known module with RTK Query API for OIDC endpoint discovery:
wellknownApi- RTK Query API for fetching well-known configurationcreateWellknownSelector- Selector factory for cached well-known datacreateWellknownError- Typed error creation from fetch failures- Re-exports pure utilities from
@forgerock/sdk-utilities
@forgerock/sdk-utilities
Add pure well-known utilities:
inferRealmFromIssuer- Extract realm path from AM issuer URLsisValidWellknownUrl- Validate well-known URLs (HTTPS required, HTTP allowed for localhost)
@forgerock/davinci-client
Refactored to use shared well-known module from
@forgerock/sdk-oidc.@forgerock/oidc-client
Refactored to use shared well-known module from
@forgerock/sdk-oidc.
Patch Changes
-
#510
3c63979Thanks @ryanbas21! - Fix error handling in storage client and davinci-client- Add
isGenericErrortype guard to sdk-utilities for runtime error validation - Fix storage client to properly catch errors from custom storage implementations, honoring the errors-as-values contract
- Improve davinci-client error handling to use explicit error checks instead of try-catch
- Add
-
#526
5a9ea40Thanks @ancheetah! - Update READMES. Fix types and comments. -
Updated dependencies [
9ad4062,5a9ea40]:- @forgerock/sdk-types@2.0.0
@forgerock/sdk-types@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Patch Changes
- #526
5a9ea40Thanks @ancheetah! - Update READMES. Fix types and comments.
@forgerock/sdk-request-middleware@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Patch Changes
- #526
5a9ea40Thanks @ancheetah! - Update READMES. Fix types and comments.
@forgerock/sdk-oidc@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Minor Changes
-
#525
9a8ca14Thanks @ryanbas21! - ### @forgerock/journey-clientAdd well-known OIDC endpoint discovery support. The journey client can now fetch configuration from the
.well-known/openid-configurationendpoint. The realm path can be automatically inferred from the well-known issuer URL.@forgerock/sdk-oidc
Add shared well-known module with RTK Query API for OIDC endpoint discovery:
wellknownApi- RTK Query API for fetching well-known configurationcreateWellknownSelector- Selector factory for cached well-known datacreateWellknownError- Typed error creation from fetch failures- Re-exports pure utilities from
@forgerock/sdk-utilities
@forgerock/sdk-utilities
Add pure well-known utilities:
inferRealmFromIssuer- Extract realm path from AM issuer URLsisValidWellknownUrl- Validate well-known URLs (HTTPS required, HTTP allowed for localhost)
@forgerock/davinci-client
Refactored to use shared well-known module from
@forgerock/sdk-oidc.@forgerock/oidc-client
Refactored to use shared well-known module from
@forgerock/sdk-oidc.
Patch Changes
@forgerock/sdk-logger@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Patch Changes
-
#528
ad81c13Thanks @ancheetah! - Fixes double logging when using custom logger. Custom logger should override default console logs. -
#526
5a9ea40Thanks @ancheetah! - Update READMES. Fix types and comments.
@forgerock/protect@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Patch Changes
- #526
5a9ea40Thanks @ancheetah! - Update READMES. Fix types and comments.
@forgerock/oidc-client@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Minor Changes
- #527
bca228eThanks @ancheetah! - Expose return types for clients
Patch Changes
-
#525
9a8ca14Thanks @ryanbas21! - ### @forgerock/journey-clientAdd well-known OIDC endpoint discovery support. The journey client can now fetch configuration from the
.well-known/openid-configurationendpoint. The realm path can be automatically inferred from the well-known issuer URL.@forgerock/sdk-oidc
Add shared well-known module with RTK Query API for OIDC endpoint discovery:
wellknownApi- RTK Query API for fetching well-known configurationcreateWellknownSelector- Selector factory for cached well-known datacreateWellknownError- Typed error creation from fetch failures- Re-exports pure utilities from
@forgerock/sdk-utilities
@forgerock/sdk-utilities
Add pure well-known utilities:
inferRealmFromIssuer- Extract realm path from AM issuer URLsisValidWellknownUrl- Validate well-known URLs (HTTPS required, HTTP allowed for localhost)
@forgerock/davinci-client
Refactored to use shared well-known module from
@forgerock/sdk-oidc.@forgerock/oidc-client
Refactored to use shared well-known module from
@forgerock/sdk-oidc. -
#526
5a9ea40Thanks @ancheetah! - Update READMES. Fix types and comments. -
Updated dependencies [
3c63979,ad81c13,9ad4062,9a8ca14,5a9ea40]:- @forgerock/storage@2.0.0
- @forgerock/sdk-logger@2.0.0
- @forgerock/iframe-manager@2.0.0
- @forgerock/sdk-oidc@2.0.0
- @forgerock/sdk-request-middleware@2.0.0
- @forgerock/sdk-types@2.0.0
@forgerock/journey-client@2.0.0
Major Changes
-
#524
4c17ba5Thanks @ryanbas21! - BREAKING CHANGE: Journey client methods now returnGenericErrorinstead ofundefinedfor error cases.What Changed
The
start,next,resume, andterminatemethods now return aGenericErrorobject instead ofundefinedwhen encountering unknown step types or error conditions. This aligns the journey client with the DaVinci client's error handling patterns.Return Type Changes
Method Before After startJourneyStep | JourneyLoginSuccess | JourneyLoginFailure | undefinedJourneyStep | JourneyLoginSuccess | JourneyLoginFailure | GenericErrornextJourneyStep | JourneyLoginSuccess | JourneyLoginFailure | undefinedJourneyStep | JourneyLoginSuccess | JourneyLoginFailure | GenericErrorresumeJourneyStep | JourneyLoginSuccess | JourneyLoginFailure | undefinedJourneyStep | JourneyLoginSuccess | JourneyLoginFailure | GenericErrorterminatevoidvoid | GenericErrorMigration Guide
Before:
const step = await client.start(); if (step) { // Use step } After: const result = await client.start(); if ('error' in result) { // Handle error console.error(result.message); } else { // Use step }
-
#502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk -
#525
9a8ca14Thanks @ryanbas21! - BREAKING: Unify journey-client around wellknown-only configurationThis release simplifies the configuration API by requiring the
wellknownURL and automatically inferringbaseUrlandrealmPath.Breaking Changes
- Removed
baseUrlfromJourneyServerConfig: ThebaseUrlis now always inferred from the wellknown URL. If inference fails (non-AM server), an error is returned. - Removed
hasWellknownConfigexport: This type guard is no longer needed since all configs use wellknown.
Migration
Before:
journey({ config: { serverConfig: { baseUrl: 'https://am.example.com/am/' }, realmPath: 'alpha', }, });
After:
journey({ config: { serverConfig: { wellknown: 'https://am.example.com/am/oauth2/alpha/.well-known/openid-configuration', }, // realmPath is now optional - inferred from wellknown issuer }, });
Features
- Automatic
baseUrlinference from wellknown URL (extracts path before/oauth2/) - Automatic
realmPathinference from wellknown issuer - Improved error messages for non-AM servers, guiding users to appropriate clients
- Updated README with comprehensive API documentation
- Removed
Minor Changes
-
#527
bca228eThanks @ancheetah! - Expose return types for clients -
#525
9a8ca14Thanks @ryanbas21! - ### @forgerock/journey-clientAdd well-known OIDC endpoint discovery support. The journey client can now fetch configuration from the
.well-known/openid-configurationendpoint. The realm path can be automatically inferred from the well-known issuer URL.@forgerock/sdk-oidc
Add shared well-known module with RTK Query API for OIDC endpoint discovery:
wellknownApi- RTK Query API for fetching well-known configurationcreateWellknownSelector- Selector factory for cached well-known datacreateWellknownError- Typed error creation from fetch failures- Re-exports pure utilities from
@forgerock/sdk-utilities
@forgerock/sdk-utilities
Add pure well-known utilities:
inferRealmFromIssuer- Extract realm path from AM issuer URLsisValidWellknownUrl- Validate well-known URLs (HTTPS required, HTTP allowed for localhost)
@forgerock/davinci-client
Refactored to use shared well-known module from
@forgerock/sdk-oidc.@forgerock/oidc-client
Refactored to use shared well-known module from
@forgerock/sdk-oidc.
Patch Changes
-
#500
e99b374Thanks @ancheetah! - Add support for KBAallowUserDefinedQuestionsflag -
#544
15b8329Thanks @ancheetah! - Removed duplicate middleware config and added support for typed middleware -
Updated dependencies [
3c63979,ad81c13,9ad4062,9a8ca14,5a9ea40]:- @forgerock/sdk-utilities@2.0.0
- @forgerock/storage@2.0.0
- @forgerock/sdk-logger@2.0.0
- @forgerock/sdk-oidc@2.0.0
- @forgerock/sdk-request-middleware@2.0.0
- @forgerock/sdk-types@2.0.0
@forgerock/iframe-manager@2.0.0
Major Changes
- #502
9ad4062Thanks @ryanbas21! - releasing version 2 of the ping javascript sdk
Patch Changes
- #526
5a9ea40Thanks @ancheetah! - Update READMES. Fix types and comments.