feat: add-davinci-client-type

Author: ryanbas21

.changeset/deep-hornets-hunt.md

@@ -0,0 +1,5 @@
+---
+
+## '@forgerock/davinci-client': minor
+
+provide a client type that handles the awaiting of the davinci client initalization and a type for handling getClient call so consumers have the type available easily

e2e/davinci-app/main.ts

@@ -8,7 +8,12 @@ import './style.css';
 
 import { Config, FRUser, TokenManager } from '@forgerock/javascript-sdk';
 import { davinci } from '@forgerock/davinci-client';
-import type { DaVinciConfig, RequestMiddleware } from '@forgerock/davinci-client/types';
+import type {
+  DaVinciConfig,
+  RequestMiddleware,
+  DavinciClient,
+  GetClient,
+} from '@forgerock/davinci-client/types';
 
 import textComponent from './components/text.js';
 import passwordComponent from './components/password.js';
@@ -48,7 +53,7 @@ const requestMiddleware: RequestMiddleware<'DAVINCI_NEXT' | 'DAVINCI_START'>[] =
 const urlParams = new URLSearchParams(window.location.search);
 
 (async () => {
-  const davinciClient = await davinci({ config, requestMiddleware });
+  const davinciClient: DavinciClient = await davinci({ config, requestMiddleware });
   const continueToken = urlParams.get('continueToken');
   const formEl = document.getElementById('form') as HTMLFormElement;
   let resumed: any;
@@ -62,7 +67,7 @@ const urlParams = new URLSearchParams(window.location.search);
   }
 
   function renderComplete() {
-    const clientInfo = davinciClient.getClient();
+    const clientInfo: GetClient = davinciClient.getClient();
     const serverInfo = davinciClient.getServer();
 
     let code = '';

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

@@ -31,10 +31,10 @@ import type {
   ObjectValueCollectors,
   PhoneNumberInputValue,
 } from './collector.types.js';
-import type { InitFlow, Updater, Validator } from './client.types.js';
+import type { InitFlow, NodeStates, Updater, Validator } from './client.types.js';
 import { returnValidator } from './collector.utils.js';
 import { authorize } from './davinci.utils.js';
-import { NodeStates, StartNode } from '../types.js';
+import { StartNode } from './node.types.js';
 
 /**
  * Create a client function that returns a set of methods

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

@@ -30,3 +30,5 @@ export type Validator = (value: string) =>
       };
       type: string;
     };
+
+export type NodeStates = StartNode | ContinueNode | ErrorNode | SuccessNode | FailureNode;

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

@@ -7,7 +7,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { describe, expectTypeOf, it } from 'vitest';
 import type {
-  NodeStates,
   StartNode,
   ContinueNode,
   ErrorNode,
@@ -23,6 +22,7 @@ import type {
 } from './types.js';
 import type * as Types from './types.js';
 import { DaVinciError } from './lib/node.types.js';
+import { NodeStates } from './lib/client.types.js';
 
 describe('Type exports', () => {
   it('should validate all types are exported', () => {

packages/davinci-client/src/types.ts

@@ -11,21 +11,22 @@ import type * as collectors from './lib/collector.types.js';
 import type * as config from './lib/config.types.js';
 import type * as nodes from './lib/node.types.js';
 import type * as client from './lib/client.types.js';
+import { davinci } from './lib/client.store.js';
+import { nodeSlice } from './lib/node.slice.js';
 
 export type DaVinciConfig = config.DaVinciConfig;
 
+export type DavinciClient = Awaited<ReturnType<typeof davinci>>;
 export type Updater = client.Updater;
 export type InitFlow = client.InitFlow;
 export type Validator = client.Validator;
-
+export type GetClient = ReturnType<typeof nodeSlice.selectors.selectClient>;
 export type StartNode = nodes.StartNode;
 export type ContinueNode = nodes.ContinueNode;
 export type ErrorNode = nodes.ErrorNode;
 export type SuccessNode = nodes.SuccessNode;
 export type FailureNode = nodes.FailureNode;
 
-export type NodeStates = StartNode | ContinueNode | ErrorNode | SuccessNode | FailureNode;
-
 export type Collectors = nodes.Collectors;
 export type DaVinciValidationError = nodes.DaVinciError;