feat: add-effects-package

Refactored some types to allow for better passing of types through and
narrowing.

Author: ryanbas21

.changeset/config.json

@@ -8,7 +8,6 @@
   ],
   "commit": false,
   "fixed": [["@forgerock/*"]],
-  "privatePackages": false,
   "linked": [],
   "access": "public",
   "baseBranch": "main",

.changeset/lemon-rocks-dream.md

@@ -0,0 +1,6 @@
+---
+'@forgerock/davinci-client': minor
+'@forgerock/effects': minor
+---
+
+add effects package

.gitignore

@@ -17,6 +17,7 @@ packages/**/coverage/
 node_modules/
 tests/**/app/index.js*
 tests/**/ie11/ie-bundle.js*
+**/out-tsc/*
 .swc
 .vite
 

e2e/davinci-app/main.ts

@@ -21,7 +21,7 @@ const searchParams = new URLSearchParams(qs);
 const config: DaVinciConfig =
   serverConfigs[searchParams.get('clientId') || '724ec718-c41c-4d51-98b0-84a583f450f9'];
 
-const requestMiddleware: RequestMiddleware[] = [
+const requestMiddleware: RequestMiddleware<'DAVINCI_NEXT' | 'DAVINCI_START'>[] = [
   (fetchArgs, action, next) => {
     if (action.type === 'DAVINCI_START') {
       fetchArgs.url.searchParams.set('start', 'true');

eslint.config.mjs

@@ -57,6 +57,7 @@ export default [
   {
     files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'],
     rules: {
+      'import/extensions': [2, 'ignorePackages'],
       '@nx/enforce-module-boundaries': [
         'warn',
         {
@@ -69,12 +70,16 @@ export default [
             },
             {
               sourceTag: 'scope:package',
-              onlyDependOnLibsWithTags: [],
+              onlyDependOnLibsWithTags: ['scope:effects'],
             },
             {
               sourceTag: 'scope:types',
               onlyDependOnLibsWithTags: [],
             },
+            {
+              sourceTag: 'scope:effects',
+              onlyDependOnLibsWithTags: [],
+            },
           ],
         },
       ],

nx.json

@@ -25,7 +25,8 @@
       "!{projectRoot}/test-setup.[jt]s",
       "noEslintConfig",
       "noMarkdown",
-      "workspaceRootIgnores"
+      "workspaceRootIgnores",
+      "!{projectRoot}/**/?(*.)+(spec|test).[jt]s?(x)?(.snap)"
     ],
     "noMarkdown": ["!{projectRoot}/*.md", "!{projectRoot}/**/*.md"],
     "noTests": [
@@ -69,7 +70,7 @@
     },
     "test": {
       "inputs": ["default", "^default", "noMarkdown", "^noMarkdown"],
-      "dependsOn": ["^test"],
+      "dependsOn": ["^test", "^build"],
       "outputs": ["{projectRoot}/coverage"],
       "cache": true
     },
@@ -152,6 +153,20 @@
         "typecheckTargetName": "typecheck"
       },
       "include": ["packages/**/**/*", "e2e/**/**/*"]
+    },
+    {
+      "plugin": "@nx/vite/plugin",
+      "options": {
+        "buildTargetName": "vite:build",
+        "testTargetName": "vite:test",
+        "serveTargetName": "vite:serve",
+        "devTargetName": "vite:dev",
+        "previewTargetName": "vite:preview",
+        "serveStaticTargetName": "vite:serve-static",
+        "typecheckTargetName": "vite:typecheck",
+        "buildDepsTargetName": "vite:build-deps",
+        "watchDepsTargetName": "vite:watch-deps"
+      }
     }
   ],
   "parallel": 1,
@@ -161,7 +176,6 @@
   },
   "generators": {
     "@nx/js:library": {
-      "publishable": true,
       "outDir": "{projectRoot}/dist",
       "bundler": "tsc",
       "linter": "eslint",

package.json

@@ -1,19 +1,25 @@
 {
   "name": "ping-javascript-sdk",
+  "version": "0.0.0",
   "private": true,
   "description": "Ping JavaScript SDK",
-  "packageManager": "[email protected]+sha512.68046141893c66fad01c079231128e9afb89ef87e2691d69e4d40eee228988295fd4682181bae55b58418c3a253bde65a505ec7c5f9403ece5cc3cd37dcf2531",
-  "engines": {
-    "node": "^20 || ^22",
-    "pnpm": "9.15.9"
+  "homepage": "https://github.com/ForgeRock/ping-javascript-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/ForgeRock/ping-javascript-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ForgeRock/ping-javascript-sdk.git"
   },
+  "author": "ForgeRock",
   "scripts": {
     "build": "nx affected --target=build",
-    "clean": "shx rm -rf ./{coverage,dist,docs,node_modules,tmp}/ ./{packages,e2e}/*/{dist,node_modules}/ && git clean -fX -e \"!.env*,nx-cloud.env\"",
+    "changeset": "changeset",
     "ci:release": "pnpm publish -r --no-git-checks && changeset tag",
     "ci:version": "changeset version && pnpm install --no-frozen-lockfile && pnpm format",
-    "changeset": "changeset",
+    "clean": "shx rm -rf ./{coverage,dist,docs,node_modules,tmp}/ ./{packages,e2e}/*/{dist,node_modules}/ && git clean -fX -e \"!.env*,nx-cloud.env\"",
     "commit": "git cz",
+    "commitlint": "commitlint --edit",
     "create-package": "nx g @nx/js:library",
     "docs": "nx affected --target=typedoc",
     "format": "pnpm nx format:write",
@@ -24,9 +30,8 @@
     "serve": "nx serve",
     "test": "CI=true nx affected:test",
     "test:e2e": "CI=true nx affected:e2e",
-    "watch": "nx watch-deps",
     "verdaccio": "nx local-registry",
-    "commitlint": "commitlint --edit"
+    "watch": "nx watch-deps"
   },
   "lint-staged": {
     "*": [
@@ -36,15 +41,12 @@
       "git add"
     ]
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ForgeRock/ping-javascript-sdk.git"
-  },
-  "author": "ForgeRock",
-  "bugs": {
-    "url": "https://github.com/ForgeRock/ping-javascript-sdk/issues"
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   },
-  "homepage": "https://github.com/ForgeRock/ping-javascript-sdk#readme",
+  "dependencies": {},
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.9",
@@ -80,7 +82,7 @@
     "@types/node": "22.13.16",
     "@typescript-eslint/typescript-estree": "8.23.0",
     "@typescript-eslint/utils": "^8.13.0",
-    "@vitest/coverage-v8": "3.0.4",
+    "@vitest/coverage-v8": "^3.0.5",
     "@vitest/ui": "3.0.4",
     "conventional-changelog-conventionalcommits": "^8.0.0",
     "cz-conventional-changelog": "^3.3.0",
@@ -119,10 +121,10 @@
     "vitest": "3.0.5",
     "vitest-canvas-mock": "^0.3.3"
   },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
+  "packageManager": "[email protected]+sha512.68046141893c66fad01c079231128e9afb89ef87e2691d69e4d40eee228988295fd4682181bae55b58418c3a253bde65a505ec7c5f9403ece5cc3cd37dcf2531",
+  "engines": {
+    "node": "^20 || ^22",
+    "pnpm": "9.15.9"
   },
   "nx": {
     "includedScripts": []

packages/davinci-client/package.json

@@ -22,6 +22,7 @@
     "test:watch": "pnpm nx nxTest --watch"
   },
   "dependencies": {
+    "@forgerock/effects": "workspace:*",
     "@forgerock/javascript-sdk": "4.7.0",
     "@reduxjs/toolkit": "catalog:",
     "immer": "catalog:"

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

@@ -7,6 +7,7 @@ import { davinciApi } from './davinci.api.js';
 import { configSlice } from './config.slice.js';
 import { wellknownApi } from './wellknown.api.js';
 
+import type { RequestMiddleware } from '@forgerock/effects/types';
 /**
  * Import the DaVinciRequest types
  */
@@ -25,7 +26,7 @@ import type {
 import type { InitFlow, Updater, Validator } from './client.types.js';
 import { returnValidator } from './collector.utils.js';
 import { authorize } from './davinci.utils.js';
-import type { RequestMiddleware } from './effects/request.effect.types.js';
+import { ActionTypes } from '@forgerock/effects/unions';
 
 /**
  * Create a client function that returns a set of methods
@@ -35,12 +36,12 @@ import type { RequestMiddleware } from './effects/request.effect.types.js';
  * @param {ConfigurationOptions} options - the configuration options for the client
  * @returns {Observable} - an observable client for DaVinci flows
  */
-export async function davinci({
+export async function davinci<ActionType extends ActionTypes = ActionTypes>({
   config,
   requestMiddleware,
 }: {
   config: DaVinciConfig;
-  requestMiddleware?: RequestMiddleware[];
+  requestMiddleware?: RequestMiddleware<ActionType>[];
 }) {
   const store = createClientStore({ requestMiddleware });
 

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

@@ -1,17 +1,17 @@
 import { configureStore } from '@reduxjs/toolkit';
 
+import type { RequestMiddleware } from '@forgerock/effects/types';
 import { configSlice } from './config.slice.js';
 import { nodeSlice } from './node.slice.js';
 import { davinciApi } from './davinci.api.js';
 import { ErrorNode, ContinueNode, StartNode, SuccessNode } from '../types.js';
 import { wellknownApi } from './wellknown.api.js';
+import { ActionTypes } from '@forgerock/effects/unions';
 
-import type { RequestMiddleware } from './effects/request.effect.types.js';
-
-export function createClientStore({
+export function createClientStore<ActionType extends ActionTypes>({
   requestMiddleware,
 }: {
-  requestMiddleware?: RequestMiddleware[];
+  requestMiddleware?: RequestMiddleware<ActionType, unknown>[];
 }) {
   return configureStore({
     reducer: {

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

@@ -14,6 +14,9 @@ import {
 /**
  * Import internal modules
  */
+import { initQuery } from '@forgerock/effects';
+import { RequestMiddleware } from '@forgerock/effects/types';
+
 import { createAuthorizeUrl } from './authorize.utils.js';
 import { handleResponse, transformActionRequest, transformSubmitRequest } from './davinci.utils.js';
 
@@ -29,15 +32,14 @@ import type {
 } from './davinci.types.js';
 import type { ContinueNode } from './node.types.js';
 import type { StartNode } from '../types.js';
-import { initQuery } from './effects/request.effect.utils.js';
-import { RequestMiddleware } from './effects/request.effect.types.js';
+import { ActionTypes } from '@forgerock/effects/unions';
 
 type BaseQueryResponse = Promise<
   QueryReturnValue<unknown, FetchBaseQueryError, FetchBaseQueryMeta>
 >;
 
-interface Extras {
-  requestMiddleware: RequestMiddleware[];
+interface Extras<ActionType extends ActionTypes = ActionTypes, Payload = unknown> {
+  requestMiddleware: RequestMiddleware<ActionType, Payload>[];
 }
 
 /**

packages/davinci-client/src/types.ts

@@ -4,7 +4,7 @@ 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 type * as effect from './lib/effects/request.effect.types.js';
+import type { RequestMiddleware } from '@forgerock/effects/types';
 
 export type DaVinciConfig = config.DaVinciConfig;
 
@@ -37,5 +37,4 @@ export type ValidatedTextCollector = collectors.ValidatedTextCollector;
 export type ReadOnlyCollector = collectors.ReadOnlyCollector;
 export type MultiSelectCollector = collectors.MultiSelectCollector;
 export type SingleSelectCollector = collectors.SingleSelectCollector;
-
-export type RequestMiddleware = effect.RequestMiddleware;
+export type { RequestMiddleware };

packages/davinci-client/tsconfig.json

@@ -7,9 +7,13 @@
     "noPropertyAccessFromIndexSignature": true,
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+    "baseUrl": "."
   },
   "references": [
+    {
+      "path": "../effects"
+    },
     {
       "path": "./tsconfig.lib.json"
     },

packages/davinci-client/tsconfig.lib.json

@@ -28,5 +28,10 @@
     "src/**/*.types.test-d.ts",
     "src/**/*.utils.test-d.ts",
     "src/lib/mock-data/*"
+  ],
+  "references": [
+    {
+      "path": "../effects/tsconfig.lib.json"
+    }
   ]
 }

packages/effects/README.md

@@ -0,0 +1,11 @@
+# effects
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build effects` to build the library.
+
+## Running unit tests
+
+Run `nx test effects` to execute the unit tests via [Vitest](https://vitest.dev/).

packages/effects/eslint.config.mjs

@@ -0,0 +1,41 @@
+import baseConfig from '../../eslint.config.mjs';
+
+export default [
+  ...baseConfig,
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          ignoredFiles: [
+            '{projectRoot}/*.test.{js,cjs,mjs,ts}',
+            '{projectRoot}/eslint.config.{js,cjs,mjs}',
+            '{projectRoot}/vite.config.ts',
+          ],
+        },
+      ],
+    },
+    languageOptions: {
+      parser: await import('jsonc-eslint-parser'),
+    },
+  },
+  {
+    ignores: [
+      '**/*.md',
+      'LICENSE',
+      '.babelrc',
+      '.env*',
+      '.bin',
+      'dist',
+      '.eslintignore',
+      'docs',
+      'coverage',
+      'vite.config.*.timestamp*',
+      '*tsconfig.tsbuildinfo*',
+      '**/**/mock-data/*.d.ts*',
+      'out-tsc',
+      'node_modules',
+    ],
+  },
+];