feat(davinci-client): add fido2 collectors

Author: ancheetah

.changeset/tired-melons-wish.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/davinci-client': minor
+---
+
+Added WebAuthn/FIDO2 collectors

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

@@ -34,6 +34,8 @@ import type {
   PhoneNumberInputValue,
   AutoCollectors,
   MultiValueCollectors,
+  Fido2RegistrationInputValue,
+  Fido2AuthenticationInputValue,
 } from './collector.types.js';
 import type {
   InitFlow,
@@ -266,16 +268,25 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
         collectorToUpdate.category !== 'SingleValueCollector' &&
         collectorToUpdate.category !== 'ValidatedSingleValueCollector' &&
         collectorToUpdate.category !== 'ObjectValueCollector' &&
-        collectorToUpdate.category !== 'SingleValueAutoCollector'
+        collectorToUpdate.category !== 'SingleValueAutoCollector' &&
+        collectorToUpdate.category !== 'ObjectValueAutoCollector'
       ) {
         return handleUpdateValidateError(
-          'Collector is not a MultiValueCollector, SingleValueCollector, ValidatedSingleValueCollector, ObjectValueCollector, or SingleValueAutoCollector and cannot be updated',
+          'Collector does not fall into a category that can be updated',
           'state_error',
           log.error,
         );
       }
 
-      return function (value: string | string[] | PhoneNumberInputValue, index?: number) {
+      return function (
+        value:
+          | string
+          | string[]
+          | PhoneNumberInputValue
+          | Fido2RegistrationInputValue
+          | Fido2AuthenticationInputValue,
+        index?: number,
+      ) {
         try {
           store.dispatch(nodeSlice.actions.update({ id, value, index }));
           return null;
@@ -291,12 +302,16 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
 
     /**
      * @method validate - Method for validating the value against validation rules
-     * @param {SingleValueCollectors | ObjectValueCollectors | MultiValueCollectors} collector - the collector to validate
+     * @param {SingleValueCollectors | ObjectValueCollectors | MultiValueCollectors | AutoCollectors} collector - the collector to validate
      * @returns {function} - a function to call for validating collector value
      * @throws {Error} - if the collector cannot be validated
      */
     validate: (
-      collector: SingleValueCollectors | ObjectValueCollectors | MultiValueCollectors,
+      collector:
+        | SingleValueCollectors
+        | ObjectValueCollectors
+        | MultiValueCollectors
+        | AutoCollectors,
     ): Validator => {
       if (!collector.id) {
         return handleUpdateValidateError(
@@ -323,10 +338,11 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
       if (
         collectorToUpdate.category !== 'ValidatedSingleValueCollector' &&
         collectorToUpdate.category !== 'ObjectValueCollector' &&
-        collectorToUpdate.category !== 'MultiValueCollector'
+        collectorToUpdate.category !== 'MultiValueCollector' &&
+        collectorToUpdate.category !== 'ObjectValueAutoCollector'
       ) {
         return handleUpdateValidateError(
-          'Collector is not a SingleValueCollector, ObjectValueCollector, or MultiValueCollector and cannot be validated',
+          'Collector does not fall into a category that can be validated',
           'state_error',
           log.error,
         );

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

@@ -302,6 +302,7 @@ describe('Collector Types', () => {
           key: '',
           value: [''],
           type: '',
+          validation: null,
         },
         output: {
           key: '',

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

@@ -202,7 +202,7 @@ export interface MultiValueCollectorWithValue<T extends MultiValueCollectorTypes
     key: string;
     value: string[];
     type: string;
-    validation?: ValidationRequired[];
+    validation: ValidationRequired[] | null;
   };
   output: {
     key: string;
@@ -223,7 +223,7 @@ export interface MultiValueCollectorNoValue<T extends MultiValueCollectorTypes>
     key: string;
     value: string[];
     type: string;
-    validation?: ValidationRequired[];
+    validation: ValidationRequired[] | null;
   };
   output: {
     key: string;
@@ -302,6 +302,14 @@ export interface PhoneNumberOutputValue {
   phoneNumber?: string;
 }
 
+export interface Fido2RegistrationInputValue {
+  attestationValue?: PublicKeyCredential;
+}
+
+export interface Fido2AuthenticationInputValue {
+  assertionValue?: PublicKeyCredential;
+}
+
 export interface ObjectOptionsCollectorWithStringValue<
   T extends ObjectValueCollectorTypes,
   V = string,
@@ -315,7 +323,7 @@ export interface ObjectOptionsCollectorWithStringValue<
     key: string;
     value: V;
     type: string;
-    validation?: ValidationRequired[];
+    validation: ValidationRequired[] | null;
   };
   output: {
     key: string;
@@ -339,7 +347,7 @@ export interface ObjectOptionsCollectorWithObjectValue<
     key: string;
     value: V;
     type: string;
-    validation?: ValidationRequired[];
+    validation: ValidationRequired[] | null;
   };
   output: {
     key: string;
@@ -364,7 +372,7 @@ export interface ObjectValueCollectorWithObjectValue<
     key: string;
     value: IV;
     type: string;
-    validation?: (ValidationRequired | ValidationPhoneNumber)[];
+    validation: (ValidationRequired | ValidationPhoneNumber)[] | null;
   };
   output: {
     key: string;
@@ -536,13 +544,18 @@ export type UnknownCollector = {
  * @interface AutoCollector - Represents a collector that collects a value programmatically without user intervention.
  */
 
-export type AutoCollectorCategories = 'SingleValueAutoCollector';
-export type AutoCollectorTypes = AutoCollectorCategories | 'ProtectCollector';
+export type AutoCollectorCategories = 'SingleValueAutoCollector' | 'ObjectValueAutoCollector';
+export type SingleValueAutoCollectorTypes = 'SingleValueAutoCollector' | 'ProtectCollector';
+export type ObjectValueAutoCollectorTypes =
+  | 'ObjectValueAutoCollector'
+  | 'Fido2RegistrationCollector'
+  | 'Fido2AuthenticationCollector';
+export type AutoCollectorTypes = SingleValueAutoCollectorTypes | ObjectValueAutoCollectorTypes;
 
 export interface AutoCollector<
   C extends AutoCollectorCategories,
   T extends AutoCollectorTypes,
-  V = string,
+  IV = string,
 > {
   category: C;
   error: string | null;
@@ -551,8 +564,9 @@ export interface AutoCollector<
   name: string;
   input: {
     key: string;
-    value: V;
+    value: IV;
     type: string;
+    validation?: ValidationRequired[] | null;
   };
   output: {
     key: string;
@@ -566,13 +580,33 @@ export type ProtectCollector = AutoCollector<
   'ProtectCollector',
   string
 >;
+export type Fido2RegistrationCollector = AutoCollector<
+  'ObjectValueAutoCollector',
+  'Fido2RegistrationCollector',
+  Fido2RegistrationInputValue
+>;
+export type Fido2AuthenticationCollector = AutoCollector<
+  'ObjectValueAutoCollector',
+  'Fido2AuthenticationCollector',
+  Fido2AuthenticationInputValue
+>;
 export type SingleValueAutoCollector = AutoCollector<
   'SingleValueAutoCollector',
   'SingleValueAutoCollector',
   string
 >;
+export type ObjectValueAutoCollector = AutoCollector<
+  'ObjectValueAutoCollector',
+  'ObjectValueAutoCollector',
+  Record<string, unknown>
+>;
 
-export type AutoCollectors = ProtectCollector | SingleValueAutoCollector;
+export type AutoCollectors =
+  | ProtectCollector
+  | Fido2RegistrationCollector
+  | Fido2AuthenticationCollector
+  | SingleValueAutoCollector
+  | ObjectValueAutoCollector;
 
 /**
  * Type to help infer the collector based on the collector type
@@ -583,8 +617,14 @@ export type AutoCollectors = ProtectCollector | SingleValueAutoCollector;
  */
 export type InferAutoCollectorType<T extends AutoCollectorTypes> = T extends 'ProtectCollector'
   ? ProtectCollector
-  : /**
-     * At this point, we have not passed in a collector type
-     * so we can return a SingleValueAutoCollector
-     **/
-    SingleValueAutoCollector;
+  : T extends 'Fido2RegistrationCollector'
+    ? Fido2RegistrationCollector
+    : T extends 'Fido2AuthenticationCollector'
+      ? Fido2AuthenticationCollector
+      : T extends 'ObjectValueAutoCollector'
+        ? ObjectValueAutoCollector
+        : /**
+           * At this point, we have not passed in a collector type
+           * so we can return a SingleValueAutoCollector
+           **/
+          SingleValueAutoCollector;