Support field type

.changeset/brave-pears-help.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/davinci-client': minor
+---
+
+adding support for fields in DROPDOWN, CHECKBOX, COMBOBOX, RADIO, FLOW_LINK.

.changeset/config.json

@@ -7,13 +7,14 @@
     }
   ],
   "commit": false,
-  "fixed": [],
+  "fixed": [["@forgerock/*"]],
+  "privatePackages": false,
   "linked": [],
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
   "ignore": [
-    "@forgerock/*",
+    "@forgerock/mock-api-v2",
     "@forgerock/davinci-app",
     "@forgerock/davinci-suites",
     "@forgerock/mock-api-v2"

.github/workflows/publish.yml

@@ -76,7 +76,7 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }}
 
       - name: Send GitHub Action data to a Slack workflow
-        if: steps.changesets.outputs.published === 'true'
+        if: steps.changesets.outputs.published == 'true'
         uses: slackapi/[email protected]
         with:
           payload-delimiter: '_'

contributing_docs/testing.md

@@ -0,0 +1,17 @@
+# Testing
+
+## Testing Types
+
+You can test types using vitest. It's important to note that testing types does not actually _run_ a test file.
+
+When you test types, these are statically analyzed by the compiler.
+
+Vitest defaults state that all files matching `*.test-d.ts` are considered type-tests
+
+From the vitest docs:
+
+```
+Under the hood Vitest calls tsc or vue-tsc, depending on your config, and parses results. Vitest will also print out type errors in your source code, if it finds any. You can disable it with typecheck.ignoreSourceErrors config option.
+
+Keep in mind that Vitest doesn't run these files, they are only statically analyzed by the compiler. Meaning, that if you use a dynamic name or test.each or test.for, the test name will not be evaluated - it will be displayed as is.
+```

e2e/davinci-app/components/flow-link.ts

@@ -1,4 +1,4 @@
-import { FlowCollector, InitFlow } from '@forgerock/davinci-client/types';
+import type { FlowCollector, InitFlow } from '@forgerock/davinci-client/types';
 
 export default function flowLinkComponent(
   formEl: HTMLFormElement,

e2e/davinci-app/components/password.ts

@@ -1,4 +1,4 @@
-import { PasswordCollector, Updater } from '@forgerock/davinci-client/types';
+import type { PasswordCollector, Updater } from '@forgerock/davinci-client/types';
 
 export default function passwordComponent(
   formEl: HTMLFormElement,

e2e/davinci-app/components/protect.ts

@@ -1,4 +1,4 @@
-import { TextCollector, Updater } from '@forgerock/davinci-client/types';
+import type { TextCollector, Updater } from '@forgerock/davinci-client/types';
 
 export default function (formEl: HTMLFormElement, collector: TextCollector, updater: Updater) {
   // create paragraph element with text of "Loading ... "

e2e/davinci-app/components/social-login-button.ts

@@ -1,4 +1,4 @@
-import { SocialLoginCollector } from '@forgerock/davinci-client/types';
+import type { SocialLoginCollector } from '@forgerock/davinci-client/types';
 
 export default function submitButtonComponent(
   formEl: HTMLFormElement,

e2e/davinci-app/components/submit-button.ts

@@ -1,4 +1,4 @@
-import { SubmitCollector } from '@forgerock/davinci-client/types';
+import type { SubmitCollector } from '@forgerock/davinci-client/types';
 
 export default function submitButtonComponent(formEl: HTMLFormElement, collector: SubmitCollector) {
   const button = document.createElement('button');

e2e/davinci-app/components/text.ts

@@ -1,4 +1,4 @@
-import { TextCollector, Updater } from '@forgerock/davinci-client/types';
+import type { TextCollector, Updater } from '@forgerock/davinci-client/types';
 
 export default function usernameComponent(
   formEl: HTMLFormElement,

e2e/davinci-app/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@forgerock/davinci-app",
+  "version": "0.0.0",
   "description": "Ping DaVinci Client Test App",
   "type": "module",
   "private": true,
+  "nx": {
+    "tags": ["scope:app"]
+  },
   "dependencies": {
     "@forgerock/davinci-client": "workspace:*",
     "@forgerock/javascript-sdk": "4.6.0"
   },
   "devDependencies": {},
-  "version": "0.0.0",
   "scripts": {
     "build": "nx exec -- vite build --watch false",
     "serve": "vite dev",

e2e/davinci-app/tsconfig.app.json

@@ -4,6 +4,6 @@
     "outDir": "../../dist/out-tsc",
     "moduleResolution": "Bundler"
   },
-  "exclude": ["src/**/*.spec.ts", "src/**/*.test.ts"],
-  "include": ["src/**/*.ts"]
+  "exclude": ["**/*.spec.ts", "**/*.test.ts"],
+  "include": ["./main.ts", "components/**/*.ts"]
 }

e2e/davinci-app/tsconfig.json

@@ -7,6 +7,8 @@
     "lib": ["ESNext", "DOM"],
     "strict": true,
     "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "verbatimModuleSyntax": true,
     "isolatedModules": true,
     "esModuleInterop": true,
     "noUnusedLocals": true,

e2e/davinci-suites/package.json

@@ -7,6 +7,9 @@
   "main": "src/index.js",
   "author": "",
   "license": "ISC",
+  "nx": {
+    "implicitDependencies": ["@forgerock/davinci-app", "@forgerock/mock-api-v2"]
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ForgeRock/ping-javascript-sdk.git"

e2e/mock-api-v2/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@forgerock/mock-api-v2",
+  "private": true,
   "version": "1.0.0",
   "description": "",
   "main": "./dist/index.js",

e2e/mock-api-v2/tsconfig.app.json

@@ -9,7 +9,13 @@
     "types": ["node"],
     "exactOptionalPropertyTypes": true,
     "strictNullChecks": true,
-    "noErrorTruncation": true
+    "noErrorTruncation": true,
+    "skipLibCheck": true,
+    "plugins": [
+      {
+        "name": "@effect/language-service"
+      }
+    ]
   },
   "exclude": ["src/**/*.spec.ts", "src/**/*.test.ts"],
   "include": ["src/**/*.ts"]

package.json

@@ -41,11 +41,11 @@
     "@commitlint/cli": "^19.1.0",
     "@commitlint/config-conventional": "^19.1.0",
     "@commitlint/prompt": "^19.1.0",
-    "@effect/language-service": "^0.1.0",
-    "@effect/platform": "^0.58.27",
-    "@effect/platform-node": "^0.53.26",
-    "@effect/schema": "^0.68.23",
-    "@effect/vitest": "^0.6.7",
+    "@effect/language-service": "^0.2.0",
+    "@effect/platform": "^0.72.1",
+    "@effect/platform-node": "^0.68.1",
+    "@effect/schema": "^0.75.5",
+    "@effect/vitest": "^0.16.1",
     "@forgerock/create-package": "workspace:*",
     "@nx/devkit": "20.2.2",
     "@nx/eslint": "20.2.2",
@@ -69,14 +69,14 @@
     "@typescript-eslint/parser": "7.16.1",
     "@typescript-eslint/typescript-estree": "5.59.5",
     "@typescript-eslint/utils": "^8.13.0",
-    "@vitest/coverage-v8": "^1.5.0",
-    "@vitest/ui": "^1.4.0",
+    "@vitest/coverage-v8": "^2.1.8",
+    "@vitest/ui": "^2.1.8",
     "conventional-changelog-conventionalcommits": "^7.0.2",
     "cz-conventional-changelog": "^3.3.0",
     "cz-git": "^1.6.1",
     "effect": "^3.5.3",
-    "effect-http": "^0.73.0",
-    "effect-http-node": "^0.16.1",
+    "effect-http": "0.73.0",
+    "effect-http-node": "0.24.0",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-import": "2.27.5",
@@ -107,7 +107,7 @@
     "vite-plugin-eslint": "^1.8.1",
     "vite-plugin-externalize-deps": "^0.8.0",
     "vite-tsconfig-paths": "^4.3.2",
-    "vitest": "^1.4.0",
+    "vitest": "^2.1.8",
     "vitest-canvas-mock": "^0.3.3"
   },
   "config": {

packages/davinci-client/package.json

@@ -6,6 +6,10 @@
   "typings": "./dist/index.d.ts",
   "type": "module",
   "files": ["dist"],
+  "sideEffects": ["./src/types.js"],
+  "nx": {
+    "tags": ["scope:package"]
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com:ForgeRock/forgerock-javascript-sdk.git",
@@ -19,9 +23,6 @@
     "@reduxjs/toolkit": "catalog:",
     "immer": "catalog:"
   },
-  "devDependencies": {
-    "vitest": "^1.4.0"
-  },
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -31,6 +32,7 @@
   },
   "scripts": {
     "build": "nx exec -- vite build",
+    "serve": "nx exec -- vite dev",
     "test": "vitest",
     "test:watch": "vitest --watch",
     "test:coverage": "vitest --coverage",

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

@@ -57,7 +57,10 @@ export async function davinci({ config }: { config: DaVinciConfig }) {
       if (!action.action) {
         console.error('Missing `argument.action`');
         return async function () {
-          return { error: { message: 'Missing argument.action', type: 'argument_error' } };
+          return {
+            error: { message: 'Missing argument.action', type: 'argument_error' },
+            type: 'internal_error',
+          };
         };
       }
 
@@ -107,6 +110,7 @@ export async function davinci({ config }: { config: DaVinciConfig }) {
         return function () {
           return {
             error: { message: 'Argument for `collector` has no ID', type: 'argument_error' },
+            type: 'internal_error',
           };
         };
       }
@@ -118,6 +122,7 @@ export async function davinci({ config }: { config: DaVinciConfig }) {
         return function () {
           console.error('Collector not found');
           return {
+            type: 'internal_error',
             error: { message: 'Collector not found', type: 'state_error' },
           };
         };
@@ -127,6 +132,7 @@ export async function davinci({ config }: { config: DaVinciConfig }) {
         console.error('Collector is not a SingleValueCollector and cannot be updated');
         return function () {
           return {
+            type: 'internal_error',
             error: {
               message: 'Collector is not a SingleValueCollector and cannot be updated',
               type: 'state_error',
@@ -141,7 +147,10 @@ export async function davinci({ config }: { config: DaVinciConfig }) {
           return null;
         } catch (err) {
           const error = err as Error;
-          return { error: { message: error.message, type: 'internal_error' } };
+          return {
+            type: 'internal_error',
+            error: { message: error.message, type: 'internal_error' },
+          };
         }
       };
     },