@forgerock/sdk-request-middleware 1.3.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @forgerock/sdk-request-middleware
 
+## 2.0.0
+
+### Major Changes
+
+- [#502](https://github.com/ForgeRock/ping-javascript-sdk/pull/502) [`9ad4062`](https://github.com/ForgeRock/ping-javascript-sdk/commit/9ad406268dd568d8d6f6447a07b656e317a9da8d) Thanks [@ryanbas21](https://github.com/ryanbas21)! - releasing version 2 of the ping javascript sdk
+
+### Patch Changes
+
+- [#526](https://github.com/ForgeRock/ping-javascript-sdk/pull/526) [`5a9ea40`](https://github.com/ForgeRock/ping-javascript-sdk/commit/5a9ea4079af4698f2d7df4bb5e7b40261aece15c) Thanks [@ancheetah](https://github.com/ancheetah)! - Update READMES. Fix types and comments.
+
 ## 1.3.0
 
 ## 1.2.0

package/README.md

@@ -50,11 +50,12 @@ const requestMiddleware = [
 const fetchArgs = { url: 'https://api.example.com/resource' };
 
 // Initialize a query and apply middleware
-const response = await initQuery(fetchArgs, 'start')
+const response = await initQuery(fetchArgs, 'authorize')
   .applyMiddleware(requestMiddleware)
-  .applyQuery(async (args) => {
+  .applyQuery(async (request) => {
     // Your fetch implementation here
-    return fetch(args.url, args);
+    const response = await fetch(request.url, request);
+    return { data: await response.json() };
   });
 ```
 
@@ -85,7 +86,7 @@ const authMiddleware = [
 ];
 
 // Use the middleware with specific action type
-const response = await initQuery(fetchArgs, 'login')
+const response = await initQuery(fetchArgs, 'start')
   .applyMiddleware(authMiddleware)
   .applyQuery(queryCallback);
 ```
@@ -121,21 +122,51 @@ Executes the request with the provided callback function.
 
 **Parameters:**
 
-- `callback`: A function that takes the modified request and returns a Promise with the API response
+- `callback`: An async function that takes the modified `FetchArgs` (with `url` as a string) and returns a Promise that resolves to a `QueryReturnValue`
 
 **Returns:**
-A Promise with the result of the callback function
+A Promise that resolves to a `QueryReturnValue<unknown, FetchBaseQueryError, FetchBaseQueryMeta>`
 
-### RequestMiddleware Type
+### RequestMiddleware Types
 
 ```typescript
-type RequestMiddleware<Type, Payload> = (
+type RequestMiddleware<Type extends ActionTypes = ActionTypes, Payload = unknown> = (
   req: ModifiedFetchArgs,
   action: Action<Type, Payload>,
   next: () => ModifiedFetchArgs,
 ) => void;
 ```
 
+The `endpoint` parameter for `initQuery` accepts an action type which maps to the type of request you want to intercept.
+
+```typescript
+const actionTypes = {
+  // Journey
+  begin: 'JOURNEY_START',
+  continue: 'JOURNEY_NEXT',
+  terminate: 'JOURNEY_TERMINATE',
+
+  // DaVinci
+  start: 'DAVINCI_START',
+  next: 'DAVINCI_NEXT',
+  flow: 'DAVINCI_FLOW',
+  success: 'DAVINCI_SUCCESS',
+  error: 'DAVINCI_ERROR',
+  failure: 'DAVINCI_FAILURE',
+  resume: 'DAVINCI_RESUME',
+
+  // OIDC
+  authorize: 'AUTHORIZE',
+  tokenExchange: 'TOKEN_EXCHANGE',
+  revoke: 'REVOKE',
+  userInfo: 'USER_INFO',
+  endSession: 'END_SESSION',
+} as const;
+
+type ActionTypes = (typeof actionTypes)[keyof typeof actionTypes];
+type EndpointTypes = keyof typeof actionTypes;
+```
+
 ## Building
 
 Run `nx build sdk-request-middleware` to build the library.

package/coverage/index.html

@@ -116,7 +116,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-11-24T21:08:53.840Z
+                at 2026-03-19T17:04:15.856Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/src/index.html

@@ -101,7 +101,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-11-24T21:08:53.840Z
+                at 2026-03-19T17:04:15.856Z
             </div>
         <script src="../prettify.js"></script>
         <script>

package/coverage/src/index.ts.html

@@ -79,7 +79,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-11-24T21:08:53.840Z
+                at 2026-03-19T17:04:15.856Z
             </div>
         <script src="../prettify.js"></script>
         <script>

package/coverage/src/lib/index.html

@@ -131,7 +131,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-11-24T21:08:53.840Z
+                at 2026-03-19T17:04:15.856Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/coverage/src/lib/request-mware.derived.ts.html

@@ -166,7 +166,7 @@ export type EndpointTypes = keyof typeof actionTypes;
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-11-24T21:08:53.840Z
+                at 2026-03-19T17:04:15.856Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/coverage/src/lib/request-mware.effects.ts.html

@@ -355,7 +355,7 @@ export function initQuery(
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-11-24T21:08:53.840Z
+                at 2026-03-19T17:04:15.856Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/coverage/src/lib/request-mware.types.ts.html

@@ -205,7 +205,7 @@ export interface RequestObj {
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-11-24T21:08:53.840Z
+                at 2026-03-19T17:04:15.856Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forgerock/sdk-request-middleware",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "private": false,
   "repository": {
     "type": "git",