-
Notifications
You must be signed in to change notification settings - Fork 3
Add fido entry point to davinci client package #744
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ancheetah
wants to merge
2
commits into
main
Choose a base branch
from
aj-fix-types
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
packages/davinci-client/api-report/davinci-client.fido.api.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| ## API Report File for "@forgerock/davinci-client" | ||
|
|
||
| > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). | ||
|
|
||
| ```ts | ||
|
|
||
| import type { GenericError } from '@forgerock/sdk-types'; | ||
|
|
||
| // @public (undocumented) | ||
| export interface AssertionValue extends Omit<PublicKeyCredential, 'rawId' | 'response' | 'getClientExtensionResults' | 'toJSON'> { | ||
| // (undocumented) | ||
| rawId: string; | ||
| // (undocumented) | ||
| response: { | ||
| clientDataJSON: string; | ||
| authenticatorData: string; | ||
| signature: string; | ||
| userHandle: string | null; | ||
| }; | ||
| } | ||
|
|
||
| // @public (undocumented) | ||
| export interface AttestationValue extends Omit<PublicKeyCredential, 'rawId' | 'response' | 'getClientExtensionResults' | 'toJSON'> { | ||
| // (undocumented) | ||
| rawId: string; | ||
| // (undocumented) | ||
| response: { | ||
| clientDataJSON: string; | ||
| attestationObject: string; | ||
| }; | ||
| } | ||
|
|
||
| // @public | ||
| export function fido(): FidoClient; | ||
|
|
||
| // @public (undocumented) | ||
| export interface FidoAuthenticationInputValue { | ||
| // (undocumented) | ||
| assertionValue?: AssertionValue; | ||
| } | ||
|
|
||
| // @public (undocumented) | ||
| export interface FidoAuthenticationOptions extends Omit<PublicKeyCredentialRequestOptions, 'challenge' | 'allowCredentials'> { | ||
| // (undocumented) | ||
| allowCredentials?: { | ||
| id: number[]; | ||
| transports?: AuthenticatorTransport[]; | ||
| type: PublicKeyCredentialType; | ||
| }[]; | ||
| // (undocumented) | ||
| challenge: number[]; | ||
| } | ||
|
|
||
| // @public (undocumented) | ||
| export interface FidoClient { | ||
| authenticate: (options: FidoAuthenticationOptions) => Promise<FidoAuthenticationInputValue | GenericError>; | ||
| register: (options: FidoRegistrationOptions) => Promise<FidoRegistrationInputValue | GenericError>; | ||
| } | ||
|
|
||
| // @public | ||
| export type FidoErrorCode = 'NotAllowedError' | 'AbortError' | 'InvalidStateError' | 'NotSupportedError' | 'SecurityError' | 'TimeoutError' | 'UnknownError'; | ||
|
|
||
| // @public (undocumented) | ||
| export interface FidoRegistrationInputValue { | ||
| // (undocumented) | ||
| attestationValue?: AttestationValue; | ||
| } | ||
|
|
||
| // @public (undocumented) | ||
| export interface FidoRegistrationOptions extends Omit<PublicKeyCredentialCreationOptions, 'challenge' | 'user' | 'pubKeyCredParams' | 'excludeCredentials'> { | ||
| // (undocumented) | ||
| challenge: number[]; | ||
| // (undocumented) | ||
| excludeCredentials?: { | ||
| id: number[]; | ||
| transports?: AuthenticatorTransport[]; | ||
| type: PublicKeyCredentialType; | ||
| }[]; | ||
| // (undocumented) | ||
| pubKeyCredParams: { | ||
| alg: string | number; | ||
| type: PublicKeyCredentialType; | ||
| }[]; | ||
| // (undocumented) | ||
| user: { | ||
| id: number[]; | ||
| name: string; | ||
| displayName: string; | ||
| }; | ||
| } | ||
|
|
||
| // (No @packageDocumentation comment for this package) | ||
|
|
||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,11 @@ | ||
| /* | ||
| * Copyright (c) 2025 Ping Identity Corporation. All rights reserved. | ||
| * Copyright (c) 2025 - 2026 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. | ||
| */ | ||
| import { fido } from './lib/fido/fido.js'; | ||
|
|
||
| // davinci is re-exported via types.ts | ||
| export { fido }; | ||
| export { davinci } from './lib/client.store.js'; | ||
| export { fido } from './lib/fido/fido.js'; | ||
|
|
||
| export * from './types.js'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /* | ||
| * Copyright (c) 2026 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. | ||
| */ | ||
|
|
||
| // Re-export FIDO module and types for package.json `./fido` entry point | ||
| export { fido } from './fido.js'; | ||
| export * from './fido.types.js'; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| /* | ||
| * Copyright (c) 2025 Ping Identity Corporation. All rights reserved. | ||
| * Copyright (c) 2025 - 2026 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. | ||
| */ | ||
| // deviceClient is re-exported via types.js | ||
| export { deviceClient } from './lib/device.store.js'; | ||
| export * from './types.js'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| /* | ||
| * Copyright (c) 2025 Ping Identity Corporation. All rights reserved. | ||
| * Copyright (c) 2025 - 2026 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. | ||
| */ | ||
| // oidc and createClientStore are re-exported via types.js | ||
| export { oidc } from './lib/client.store.js'; | ||
| export * from './types.js'; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Cover the new FIDO barrel before merging.
Codecov reports this changed file as uncovered, leaving patch coverage at 14.28571% against the 40% gate. Add a focused test that imports
@forgerock/davinci-client/fidoand exercises the exportedfidopath, with a compile-time import for the type re-exports.🤖 Prompt for AI Agents