refactor(oidc-client): complete rename of parAuthorizeµ to createParAuthorizeUrlµ

Update all remaining touchpoints: JSDoc @function tag, test section header,
and test description strings. Fix Prettier formatting for longer call sites.

Author: ryanbas21

packages/oidc-client/src/lib/authorize.request.ts

@@ -59,7 +59,7 @@ function dispatchAuthorizeµ(
 // ─── PAR flow ─────────────────────────────────────────────────────────────────
 
 /**
- * @function parAuthorizeµ
+ * @function createParAuthorizeUrlµ
  * @description Pushed Authorization Request (RFC 9126): POSTs all authorize
  *   parameters to the PAR endpoint, then returns a slim URL containing only
  *   `client_id` and `request_uri` — keeping sensitive params out of the
@@ -75,7 +75,7 @@ function dispatchAuthorizeµ(
  * @returns A `Micro` that resolves to the slim authorize URL string or
  *   fails with a typed `AuthorizationError`.
  */
-export function parAuthorizeµ(
+export function createParAuthorizeUrlµ(
   wellknown: WellknownResponse,
   config: OidcConfig,
   log: CustomLogger,
@@ -160,7 +160,7 @@ export function authorizeµ(
     ...options,
   };
 
-  const parFlow = parAuthorizeµ(wellknown, config, log, store, options).pipe(
+  const parFlow = createParAuthorizeUrlµ(wellknown, config, log, store, options).pipe(
     Micro.tap((url) => log.debug('PAR authorize URL created', url)),
     Micro.tapError((err) =>
       Micro.sync(() => log.error(`PAR authorize failed [${err.type}]: ${err.error}`, err)),

packages/oidc-client/src/lib/authorize.request.utils.test.ts

@@ -8,7 +8,7 @@ import { it, expect } from '@effect/vitest';
 import { Micro } from 'effect';
 import { vi, afterEach } from 'vitest';
 import * as sdkOidc from '@forgerock/sdk-oidc';
-import { parAuthorizeµ, authorizeµ } from './authorize.request.js';
+import { createParAuthorizeUrlµ, authorizeµ } from './authorize.request.js';
 import {
   toAuthorizationError,
   isFetchBaseQueryError,
@@ -128,12 +128,14 @@ it('toDispatchError delegates to toAuthorizationError for FetchBaseQueryError',
   });
 });
 
-// ─── parAuthorizeµ ───────────────────────────────────────────────────────────
+// ─── createParAuthorizeUrlµ ───────────────────────────────────────────────────────────
 
-it.effect('parAuthorizeµ fails with PAR_NOT_CONFIGURED when par endpoint is missing', () =>
+it.effect('createParAuthorizeUrlµ fails with PAR_NOT_CONFIGURED when par endpoint is missing', () =>
   Micro.gen(function* () {
     const configWithPar: OidcConfig = { ...config, par: true };
-    const result = yield* Micro.exit(parAuthorizeµ(wellknown, configWithPar, mockLog, mockStore));
+    const result = yield* Micro.exit(
+      createParAuthorizeUrlµ(wellknown, configWithPar, mockLog, mockStore),
+    );
     expect(Micro.exitIsFailure(result)).toBe(true);
     if (!Micro.exitIsFailure(result)) return;
     expect(Micro.causeIsFail(result.cause)).toBe(true);
@@ -147,7 +149,7 @@ it.effect('parAuthorizeµ fails with PAR_NOT_CONFIGURED when par endpoint is mis
   }),
 );
 
-it.effect('parAuthorizeµ succeeds and returns slim authorize URL', () =>
+it.effect('createParAuthorizeUrlµ succeeds and returns slim authorize URL', () =>
   Micro.gen(function* () {
     const configWithPar: OidcConfig = { ...config, par: true };
     const requestUri = 'urn:ietf:params:oauth:request_uri:abc123';
@@ -157,7 +159,7 @@ it.effect('parAuthorizeµ succeeds and returns slim authorize URL', () =>
       data: { request_uri: requestUri, expires_in: 60 },
     } as unknown as ReturnType<typeof mockStore.dispatch>);
 
-    const url = yield* parAuthorizeµ(wellknownWithPar, configWithPar, mockLog, mockStore);
+    const url = yield* createParAuthorizeUrlµ(wellknownWithPar, configWithPar, mockLog, mockStore);
 
     expect(url).toContain('client_id=123456789');
     expect(url).toContain(`request_uri=${encodeURIComponent(requestUri)}`);
@@ -167,7 +169,7 @@ it.effect('parAuthorizeµ succeeds and returns slim authorize URL', () =>
   }),
 );
 
-it.effect('parAuthorizeµ fails with network_error when PAR POST returns error', () =>
+it.effect('createParAuthorizeUrlµ fails with network_error when PAR POST returns error', () =>
   Micro.gen(function* () {
     const configWithPar: OidcConfig = { ...config, par: true };
 
@@ -181,7 +183,7 @@ it.effect('parAuthorizeµ fails with network_error when PAR POST returns error',
     } as unknown as ReturnType<typeof mockStore.dispatch>);
 
     const result = yield* Micro.exit(
-      parAuthorizeµ(wellknownWithPar, configWithPar, mockLog, mockStore),
+      createParAuthorizeUrlµ(wellknownWithPar, configWithPar, mockLog, mockStore),
     );
 
     expect(Micro.exitIsFailure(result)).toBe(true);
@@ -194,34 +196,36 @@ it.effect('parAuthorizeµ fails with network_error when PAR POST returns error',
   }),
 );
 
-it.effect('parAuthorizeµ fails with network_error when PAR response is missing request_uri', () =>
-  Micro.gen(function* () {
-    const configWithPar: OidcConfig = { ...config, par: true };
-
-    vi.stubGlobal('sessionStorage', sessionStorageStub);
-    vi.mocked(mockStore.dispatch).mockResolvedValueOnce({
-      data: {},
-    } as unknown as ReturnType<typeof mockStore.dispatch>);
+it.effect(
+  'createParAuthorizeUrlµ fails with network_error when PAR response is missing request_uri',
+  () =>
+    Micro.gen(function* () {
+      const configWithPar: OidcConfig = { ...config, par: true };
 
-    const result = yield* Micro.exit(
-      parAuthorizeµ(wellknownWithPar, configWithPar, mockLog, mockStore),
-    );
+      vi.stubGlobal('sessionStorage', sessionStorageStub);
+      vi.mocked(mockStore.dispatch).mockResolvedValueOnce({
+        data: {},
+      } as unknown as ReturnType<typeof mockStore.dispatch>);
 
-    expect(Micro.exitIsFailure(result)).toBe(true);
-    if (!Micro.exitIsFailure(result)) return;
-    expect(Micro.causeIsFail(result.cause)).toBe(true);
-    if (Micro.causeIsFail(result.cause)) {
-      expect(result.cause.error.type).toBe('network_error');
-      expect(result.cause.error.error_description).toBe(
-        "PAR response missing required 'request_uri' field",
+      const result = yield* Micro.exit(
+        createParAuthorizeUrlµ(wellknownWithPar, configWithPar, mockLog, mockStore),
       );
-    }
-    expect(sessionStorageStub.setItem).not.toHaveBeenCalled();
-  }),
+
+      expect(Micro.exitIsFailure(result)).toBe(true);
+      if (!Micro.exitIsFailure(result)) return;
+      expect(Micro.causeIsFail(result.cause)).toBe(true);
+      if (Micro.causeIsFail(result.cause)) {
+        expect(result.cause.error.type).toBe('network_error');
+        expect(result.cause.error.error_description).toBe(
+          "PAR response missing required 'request_uri' field",
+        );
+      }
+      expect(sessionStorageStub.setItem).not.toHaveBeenCalled();
+    }),
 );
 
 it.effect(
-  'parAuthorizeµ with prompt=none includes prompt on slim authorize URL and in PAR body',
+  'createParAuthorizeUrlµ with prompt=none includes prompt on slim authorize URL and in PAR body',
   () =>
     Micro.gen(function* () {
       const configWithPar: OidcConfig = { ...config, par: true };
@@ -235,9 +239,15 @@ it.effect(
         data: { request_uri: requestUri, expires_in: 60 },
       } as unknown as ReturnType<typeof mockStore.dispatch>);
 
-      const url = yield* parAuthorizeµ(wellknownWithPar, configWithPar, mockLog, mockStore, {
-        prompt: 'none',
-      });
+      const url = yield* createParAuthorizeUrlµ(
+        wellknownWithPar,
+        configWithPar,
+        mockLog,
+        mockStore,
+        {
+          prompt: 'none',
+        },
+      );
 
       expect(url).toContain('prompt=none');
       const parBodyArg = buildParamsSpy.mock.calls[0][0] as unknown as Record<string, unknown>;

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

@@ -10,7 +10,7 @@ import { createStorage } from '@forgerock/storage';
 import { Micro } from 'effect';
 import { causeIsDie, exitIsFail, exitIsSuccess } from 'effect/Micro';
 
-import { authorizeµ, parAuthorizeµ } from './authorize.request.js';
+import { authorizeµ, createParAuthorizeUrlµ } from './authorize.request.js';
 import { buildTokenExchangeµ } from './exchange.request.js';
 import { createClientStore, createTokenError } from './client.store.utils.js';
 import { oidcApi } from './oidc.api.js';
@@ -132,7 +132,7 @@ export async function oidc<ActionType extends ActionTypes = ActionTypes>({
 
         if (useParFlow) {
           const result = await Micro.runPromiseExit(
-            parAuthorizeµ(wellknown, config, log, store, options).pipe(
+            createParAuthorizeUrlµ(wellknown, config, log, store, options).pipe(
               Micro.tapError((err) =>
                 Micro.sync(() =>
                   log.error(`PAR authorize.url() failed [${err.type}]: ${err.error}`, err),