feat(davinci-client): add fido module

Author: ancheetah

.changeset/sparkly-dragons-lay.md

@@ -0,0 +1,6 @@
+---
+'@forgerock/davinci-client': minor
+'@forgerock/sdk-types': minor
+---
+
+Adds FIDO feature module to `@forgerock/davinci-client` package

package.json

@@ -18,7 +18,7 @@
     "ci:release": "pnpm publish -r --no-git-checks && changeset tag",
     "ci:version": "changeset version && pnpm install --no-frozen-lockfile && pnpm nx format:write --uncommitted",
     "circular-dep-check": "madge --circular .",
-    "clean": "shx rm -rf ./{coverage,dist,docs,node_modules,tmp}/ ./{packages,e2e}/*/{dist,node_modules}/ && git clean -fX -e \"!.env*,nx-cloud.env\" -e \"!**/GEMINI.md\"",
+    "clean": "shx rm -rf ./{coverage,dist,docs,node_modules,tmp}/ ./{packages,e2e}/*/{dist,node_modules}/ ./e2e/node_modules/ && git clean -fX -e \"!.env*,nx-cloud.env\" -e \"!**/GEMINI.md\"",
     "commit": "git cz",
     "commitlint": "commitlint --edit",
     "create-package": "nx g @nx/js:library",

packages/davinci-client/package.json

@@ -29,6 +29,7 @@
     "@forgerock/sdk-types": "workspace:*",
     "@forgerock/storage": "workspace:*",
     "@reduxjs/toolkit": "catalog:",
+    "effect": "catalog:effect",
     "immer": "catalog:"
   },
   "devDependencies": {

packages/davinci-client/src/index.ts

@@ -5,5 +5,6 @@
  * of the MIT license. See the LICENSE file for details.
  */
 import { davinci } from './lib/client.store.js';
+import { fido } from './lib/fido/fido.js';
 
-export { davinci };
+export { davinci, fido };

packages/davinci-client/src/lib/client.store.ts

@@ -45,7 +45,7 @@ import type {
   Validator,
 } from './client.types.js';
 import { returnValidator } from './collector.utils.js';
-import { ContinueNode, StartNode } from './node.types.js';
+import type { ContinueNode, StartNode } from './node.types.js';
 
 /**
  * Create a client function that returns a set of methods

packages/davinci-client/src/lib/client.types.test-d.ts

@@ -11,7 +11,11 @@ import type { GenericError } from '@forgerock/sdk-types';
 
 import type { InitFlow, InternalErrorResponse, Updater } from './client.types.js';
 import type { ErrorNode, FailureNode, ContinueNode, StartNode, SuccessNode } from './node.types.js';
-import type { PhoneNumberInputValue } from './collector.types.js';
+import type {
+  FidoAuthenticationInputValue,
+  FidoRegistrationInputValue,
+  PhoneNumberInputValue,
+} from './collector.types.js';
 
 describe('Client Types', () => {
   it('should allow function returning error', async () => {
@@ -170,15 +174,29 @@ describe('Client Types', () => {
 describe('Updater', () => {
   it('should accept string value and optional index', () => {
     const updater: Updater = (
-      value: string | string[] | boolean | PhoneNumberInputValue,
+      value:
+        | string
+        | string[]
+        | boolean
+        | PhoneNumberInputValue
+        | FidoRegistrationInputValue
+        | FidoAuthenticationInputValue,
       index?: number,
     ) => {
       return {
         error: { message: 'Invalid value', code: 'INVALID', type: 'state_error' },
         type: 'internal_error',
       };
     };
-    expectTypeOf(updater).parameter(0).toEqualTypeOf<string | string[] | PhoneNumberInputValue>();
+    expectTypeOf(updater)
+      .parameter(0)
+      .toEqualTypeOf<
+        | string
+        | string[]
+        | PhoneNumberInputValue
+        | FidoRegistrationInputValue
+        | FidoAuthenticationInputValue
+      >();
     expectTypeOf(updater).parameter(1).toBeNullable();
     expectTypeOf(updater).parameter(1).toBeNullable();
   });

packages/davinci-client/src/lib/client.types.ts

@@ -6,7 +6,11 @@
  */
 import type { GenericError } from '@forgerock/sdk-types';
 
-import type { PhoneNumberInputValue } from './collector.types.js';
+import type {
+  FidoRegistrationInputValue,
+  FidoAuthenticationInputValue,
+  PhoneNumberInputValue,
+} from './collector.types.js';
 import type { ErrorNode, FailureNode, ContinueNode, StartNode, SuccessNode } from './node.types.js';
 
 export type FlowNode = ContinueNode | ErrorNode | StartNode | SuccessNode | FailureNode;
@@ -19,7 +23,12 @@ export interface InternalErrorResponse {
 export type InitFlow = () => Promise<FlowNode | InternalErrorResponse>;
 
 export type Updater = (
-  value: string | string[] | PhoneNumberInputValue,
+  value:
+    | string
+    | string[]
+    | PhoneNumberInputValue
+    | FidoRegistrationInputValue
+    | FidoAuthenticationInputValue,
   index?: number,
 ) => InternalErrorResponse | null;
 export type Validator = (value: string) =>

packages/davinci-client/src/lib/collector.types.ts

@@ -5,6 +5,8 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
+import type { FidoAuthenticationOptions, FidoRegistrationOptions } from './davinci.types.js';
+
 /** *********************************************************************
  * SINGLE-VALUE COLLECTORS
  */
@@ -302,14 +304,6 @@ export interface PhoneNumberOutputValue {
   phoneNumber?: string;
 }
 
-export interface FidoRegistrationInputValue {
-  attestationValue?: PublicKeyCredential;
-}
-
-export interface FidoAuthenticationInputValue {
-  assertionValue?: PublicKeyCredential;
-}
-
 export interface ObjectOptionsCollectorWithStringValue<
   T extends ObjectValueCollectorTypes,
   V = string,
@@ -544,6 +538,51 @@ export type UnknownCollector = {
  * @interface AutoCollector - Represents a collector that collects a value programmatically without user intervention.
  */
 
+export interface ProtectOutputValue {
+  behavioralDataCollection: boolean;
+  universalDeviceIdentification: boolean;
+}
+
+export interface AttestationValue
+  extends Omit<PublicKeyCredential, 'rawId' | 'response' | 'getClientExtensionResults' | 'toJSON'> {
+  rawId: string;
+  response: {
+    // https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAttestationResponse
+    clientDataJSON: string;
+    attestationObject: string;
+  };
+}
+export interface FidoRegistrationInputValue {
+  attestationValue?: AttestationValue;
+}
+
+export interface FidoRegistrationOutputValue {
+  publicKeyCredentialCreationOptions: FidoRegistrationOptions;
+  action: 'REGISTER';
+  trigger: string;
+}
+
+export interface AssertionValue
+  extends Omit<PublicKeyCredential, 'rawId' | 'response' | 'getClientExtensionResults' | 'toJSON'> {
+  rawId: string;
+  response: {
+    // https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAssertionResponse
+    clientDataJSON: string;
+    authenticatorData: string;
+    signature: string;
+    userHandle: string | null;
+  };
+}
+export interface FidoAuthenticationInputValue {
+  assertionValue?: AssertionValue;
+}
+
+export interface FidoAuthenticationOutputValue {
+  publicKeyCredentialRequestOptions: FidoAuthenticationOptions;
+  action: 'AUTHENTICATE';
+  trigger: string;
+}
+
 export type AutoCollectorCategories = 'SingleValueAutoCollector' | 'ObjectValueAutoCollector';
 export type SingleValueAutoCollectorTypes = 'SingleValueAutoCollector' | 'ProtectCollector';
 export type ObjectValueAutoCollectorTypes =
@@ -556,6 +595,7 @@ export interface AutoCollector<
   C extends AutoCollectorCategories,
   T extends AutoCollectorTypes,
   IV = string,
+  OV = Record<string, unknown>,
 > {
   category: C;
   error: string | null;
@@ -571,24 +611,27 @@ export interface AutoCollector<
   output: {
     key: string;
     type: string;
-    config: Record<string, unknown>;
+    config: OV;
   };
 }
 
 export type ProtectCollector = AutoCollector<
   'SingleValueAutoCollector',
   'ProtectCollector',
-  string
+  string,
+  ProtectOutputValue
 >;
 export type FidoRegistrationCollector = AutoCollector<
   'ObjectValueAutoCollector',
   'FidoRegistrationCollector',
-  FidoRegistrationInputValue
+  FidoRegistrationInputValue,
+  FidoRegistrationOutputValue
 >;
 export type FidoAuthenticationCollector = AutoCollector<
   'ObjectValueAutoCollector',
   'FidoAuthenticationCollector',
-  FidoAuthenticationInputValue
+  FidoAuthenticationInputValue,
+  FidoAuthenticationOutputValue
 >;
 export type SingleValueAutoCollector = AutoCollector<
   'SingleValueAutoCollector',

packages/davinci-client/src/lib/davinci.types.ts

@@ -161,13 +161,25 @@ export type ProtectField = {
 };
 
 export interface FidoRegistrationOptions
-  extends Omit<PublicKeyCredentialCreationOptions, 'challenge' | 'user'> {
+  extends Omit<
+    PublicKeyCredentialCreationOptions,
+    'challenge' | 'user' | 'pubKeyCredParams' | 'excludeCredentials'
+  > {
   challenge: number[];
   user: {
     id: number[];
     name: string;
     displayName: string;
   };
+  pubKeyCredParams: {
+    alg: string | number;
+    type: PublicKeyCredentialType;
+  }[];
+  excludeCredentials?: {
+    id: number[];
+    transports?: AuthenticatorTransport[];
+    type: PublicKeyCredentialType;
+  }[];
 }
 
 export type FidoRegistrationField = {

packages/davinci-client/src/lib/davinci.utils.ts

@@ -44,7 +44,8 @@ export function transformSubmitRequest(
       collector.category === 'SingleValueCollector' ||
       collector.category === 'ValidatedSingleValueCollector' ||
       collector.category === 'ObjectValueCollector' ||
-      collector.category === 'SingleValueAutoCollector',
+      collector.category === 'SingleValueAutoCollector' ||
+      collector.category === 'ObjectValueAutoCollector',
   );
 
   const formData = collectors?.reduce<{