Merge pull request #299 from ForgeRock/type-client

ryanbas21 · web-flow · commit a16b79475951 · 2025-05-20T21:47:28.000-06:00
feat: add-davinci-client-type
diff --git a/.changeset/deep-hornets-hunt.md b/.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
diff --git a/e2e/davinci-app/main.ts b/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 = '';
diff --git a/e2e/mock-api-v2/package.json b/e2e/mock-api-v2/package.json
@@ -6,6 +6,7 @@
   "type": "module",
   "main": "./dist/index.js",
   "scripts": {
+    "build": "pnpm nx nxBuild",
     "lint": "pnpm nx nxLint",
     "serve": "node dist/e2e/mock-api-v2/src/main.js",
     "serve:dev": "nodemon dist/e2e/mock-api-v2/src/main.js",
diff --git a/nx.json b/nx.json
@@ -121,7 +121,7 @@
           "targetName": "typecheck"
         },
         "build": {
-          "targetName": "build",
+          "targetName": "nxBuild",
           "configName": "tsconfig.lib.json"
         }
       },
diff --git a/packages/davinci-client/package.json b/packages/davinci-client/package.json
@@ -17,6 +17,7 @@
   "typings": "./dist/src/index.d.ts",
   "files": ["dist", "!dist/tsconfig.lib.tsbuildinfo", "./LICENSE"],
   "scripts": {
+    "build": "pnpm nx nxBuild",
     "lint": "pnpm nx nxLint",
     "test": "pnpm nx nxTest",
     "test:watch": "pnpm nx nxTest --watch"
@@ -35,19 +36,6 @@
     "access": "public"
   },
   "nx": {
-    "tags": ["scope:package"],
-    "targets": {
-      "build": {
-        "executor": "@nx/js:tsc",
-        "outputs": ["{options.outputPath}"],
-        "options": {
-          "outputPath": "packages/davinci-client/dist",
-          "main": "packages/davinci-client/src/index.ts",
-          "tsConfig": "packages/davinci-client/tsconfig.lib.json",
-          "generatePackageJson": false,
-          "assets": []
-        }
-      }
-    }
+    "tags": ["scope:package"]
   }
 }
diff --git a/packages/davinci-client/src/lib/client.store.ts b/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
diff --git a/packages/davinci-client/src/lib/client.types.ts b/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;
diff --git a/packages/davinci-client/src/types.test-d.ts b/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', () => {
diff --git a/packages/davinci-client/src/types.ts b/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;
 
diff --git a/packages/device-client/package.json b/packages/device-client/package.json
@@ -20,6 +20,7 @@
   "typings": "./dist/index.d.ts",
   "files": ["./dist"],
   "scripts": {
+    "build": "pnpm nx nxBuild",
     "lint": "pnpm nx nxLint",
     "test": "pnpm nx nxTest",
     "test:watch": "pnpm nx nxTest --watch"
@@ -32,18 +33,6 @@
     "msw": "^2.5.1"
   },
   "nx": {
-    "targets": {
-      "build": {
-        "executor": "@nx/js:tsc",
-        "outputs": ["{options.outputPath}"],
-        "options": {
-          "outputPath": "packages/device-client/dist",
-          "main": "packages/device-client/src/index.ts",
-          "tsConfig": "packages/device-client/tsconfig.lib.json",
-          "generatePackageJson": false,
-          "assets": []
-        }
-      }
-    }
+    "tags": ["scope:package"]
   }
 }
diff --git a/packages/oidc-client/package.json b/packages/oidc-client/package.json
@@ -20,6 +20,7 @@
   "module": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
   "scripts": {
+    "build": "pnpm nx nxBuild",
     "lint": "pnpm nx nxLint",
     "test": "pnpm nx nxTest",
     "test:watch": "pnpm nx nxTest --watch"
diff --git a/packages/sdk-effects/iframe-manager/package.json b/packages/sdk-effects/iframe-manager/package.json
@@ -19,6 +19,12 @@
   "main": "./dist/src/index.js",
   "module": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "build": "pnpm nx nxBuild",
+    "lint": "pnpm nx nxLint",
+    "test": "pnpm nx nxTest",
+    "test:watch": "pnpm nx nxTest --watch"
+  },
   "dependencies": {},
   "nx": {
     "tags": ["scope:sdk-effects"]
diff --git a/packages/sdk-effects/iframe-manager/vite.config.ts b/packages/sdk-effects/iframe-manager/vite.config.ts
@@ -9,6 +9,7 @@ export default defineConfig(() => ({
   //  plugins: [ nxViteTsPaths() ],
   // },
   test: {
+    passWithNoTests: true,
     watch: false,
     globals: true,
     environment: 'node',
diff --git a/packages/sdk-effects/logger/package.json b/packages/sdk-effects/logger/package.json
@@ -20,6 +20,7 @@
   "module": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
   "scripts": {
+    "build": "pnpm nx nxBuild",
     "lint": "pnpm nx nxLint",
     "test": "pnpm nx nxTest",
     "test:watch": "pnpm nx nxTest --watch"
diff --git a/packages/sdk-effects/oidc/package.json b/packages/sdk-effects/oidc/package.json
@@ -20,6 +20,7 @@
   "module": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
   "scripts": {
+    "build": "pnpm nx nxBuild",
     "lint": "pnpm nx nxLint",
     "test": "pnpm nx nxTest",
     "test:watch": "pnpm nx nxTest --watch"
diff --git a/packages/sdk-effects/sdk-request-middleware/package.json b/packages/sdk-effects/sdk-request-middleware/package.json
@@ -20,6 +20,7 @@
   "module": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
   "scripts": {
+    "build": "pnpm nx nxBuild",
     "lint": "pnpm nx nxLint",
     "test": "pnpm nx nxTest",
     "test:watch": "pnpm nx nxTest --watch"
diff --git a/packages/sdk-effects/storage/package.json b/packages/sdk-effects/storage/package.json
@@ -19,6 +19,12 @@
   "main": "./dist/src/index.js",
   "module": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "build": "pnpm nx nxBuild",
+    "lint": "pnpm nx nxLint",
+    "test": "pnpm nx nxTest",
+    "test:watch": "pnpm nx nxTest --watch"
+  },
   "dependencies": {
     "@forgerock/sdk-types": "workspace:*"
   },
diff --git a/packages/sdk-effects/storage/src/lib/storage.effects.test.ts b/packages/sdk-effects/storage/src/lib/storage.effects.test.ts
@@ -46,9 +46,15 @@ Object.defineProperty(global, 'localStorage', { value: localStorageMock });
 const sessionStorageMock = (() => {
   let store: Record<string, string> = {};
   return {
-    getItem: vi.fn((key: string) => Promise.resolve(store[key] || null)),
+    getItem: vi.fn((key: string) => {
+      const value = store[key];
+      if (value === undefined || value === null) {
+        return Promise.resolve(null);
+      }
+      return Promise.resolve(JSON.parse(value));
+    }),
     setItem: vi.fn((key: string, value: string) => {
-      store[key] = value;
+      store[key] = JSON.stringify(value);
       return Promise.resolve();
     }),
     removeItem: vi.fn((key: string) => {
@@ -201,8 +207,11 @@ describe('storage Effect', () => {
     it('should call sessionStorage.setItem with the correct key and value', async () => {
       await storageInstance.set(testValue);
       expect(sessionStorageMock.setItem).toHaveBeenCalledTimes(1);
-      expect(sessionStorageMock.setItem).toHaveBeenCalledWith(expectedKey, testValue);
-      expect(await sessionStorageMock.getItem(expectedKey)).toBe(testValue);
+      expect(sessionStorageMock.setItem).toHaveBeenCalledWith(
+        expectedKey,
+        JSON.stringify(testValue),
+      );
+      expect(await sessionStorageMock.getItem(expectedKey)).toBe(JSON.stringify(testValue));
       expect(localStorageMock.setItem).not.toHaveBeenCalled();
       expect(mockCustomStore.set).not.toHaveBeenCalled();
     });
diff --git a/packages/sdk-effects/storage/tsconfig.lib.json b/packages/sdk-effects/storage/tsconfig.lib.json
@@ -5,6 +5,8 @@
     "outDir": "dist",
     "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
     "emitDeclarationOnly": false,
+    "declaration": true,
+    "declarationMap": true,
     "module": "nodenext",
     "moduleResolution": "nodenext",
     "forceConsistentCasingInFileNames": true,
diff --git a/packages/sdk-types/package.json b/packages/sdk-types/package.json
@@ -20,8 +20,14 @@
   "module": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
   "files": ["dist"],
+  "scripts": {
+    "build": "pnpm nx nxBuild",
+    "lint": "pnpm nx nxLint",
+    "test": "pnpm nx nxTest",
+    "test:watch": "pnpm nx nxTest --watch"
+  },
+  "dependencies": {},
   "nx": {
-    "tags": ["scope:sdk-types"],
-    "name": "@forgerock/sdk-types"
+    "tags": ["scope:sdk-types"]
   }
 }
diff --git a/packages/sdk-types/vite.config.ts b/packages/sdk-types/vite.config.ts
@@ -9,6 +9,7 @@ export default defineConfig(() => ({
   //  plugins: [ nxViteTsPaths() ],
   // },
   test: {
+    passWithNoTests: true,
     watch: false,
     globals: true,
     environment: 'node',
diff --git a/packages/sdk-utilities/package.json b/packages/sdk-utilities/package.json
@@ -22,11 +22,11 @@
   "module": "./dist/src/index.js",
   "files": ["dist"],
   "scripts": {
+    "build": "pnpm nx nxBuild",
     "lint": "pnpm nx nxLint",
     "test": "pnpm nx nxTest",
     "test:watch": "pnpm nx nxTest --watch"
   },
-  "dependencies": {},
   "nx": {
     "tags": ["scope:sdk-utilities"]
   }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -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
Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@`
`121`	`121`	`"targetName": "typecheck"`
`122`	`122`	`},`
`123`	`123`	`"build": {`
`124`		`- "targetName": "build",`
	`124`	`+ "targetName": "nxBuild",`
`125`	`125`	`"configName": "tsconfig.lib.json"`
`126`	`126`	`}`
`127`	`127`	`},`