Merge pull request #417 from ForgeRock/SDKS-4361-storage-client-type

SDKS-4361: Improve storage client type

Author: ancheetah

.changeset/slow-teeth-melt.md

@@ -0,0 +1,7 @@
+---
+'@forgerock/storage': minor
+'@forgerock/oidc-client': minor
+---
+
+- Standardizes return types on storage client and updates tests
+- Improves OIDC client where storage client methods are used

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

@@ -13,6 +13,8 @@ import { oidc } from './client.store.js';
 
 import type { OidcConfig } from './config.types.js';
 
+Object.defineProperty(global, 'localStorage', { value: null });
+
 vi.stubGlobal(
   'sessionStorage',
   (() => {

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

@@ -372,14 +372,10 @@ export async function oidc<ActionType extends ActionTypes = ActionTypes>({
           // Delete local token and return combined results
           Micro.flatMap((revokeResponse) =>
             Micro.promise(() => storageClient.remove()).pipe(
-              Micro.flatMap((deleteRes) => {
-                const deleteResponse = typeof deleteRes === 'undefined' ? null : deleteRes;
-
+              Micro.flatMap((deleteResponse) => {
                 const isInnerRequestError =
                   (revokeResponse && 'error' in revokeResponse) ||
-                  (deleteResponse &&
-                    typeof deleteResponse === 'object' &&
-                    'error' in deleteResponse);
+                  (deleteResponse && 'error' in deleteResponse);
 
                 if (isInnerRequestError) {
                   const result: RevokeErrorResult = {

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

@@ -9,20 +9,25 @@ export interface GetTokensOptions {
 }
 
 export type RevokeSuccessResult = {
-  revokeResponse: GenericError | null;
-  deleteResponse: GenericError | null;
+  revokeResponse: null;
+  deleteResponse: null;
 };
 
-export type RevokeErrorResult = RevokeSuccessResult & {
+export type RevokeErrorResult = {
   error: string;
+  revokeResponse: GenericError | null;
+  deleteResponse: GenericError | null;
 };
 
 export type LogoutSuccessResult = RevokeSuccessResult & {
-  sessionResponse: GenericError | null;
+  sessionResponse: null;
 };
 
-export type LogoutErrorResult = LogoutSuccessResult & {
+export type LogoutErrorResult = {
   error: string;
+  sessionResponse: GenericError | null;
+  revokeResponse: GenericError | null;
+  deleteResponse: GenericError | null;
 };
 
 export type UserInfoResponse = {

packages/oidc-client/src/lib/logout.request.test.ts

@@ -66,6 +66,9 @@ const config: OidcConfig = {
   responseType: 'code',
 };
 
+Object.defineProperty(global, 'sessionStorage', { value: null });
+Object.defineProperty(global, 'localStorage', { value: null });
+
 const customStorage: Record<string, string> = {};
 const storageClient = createStorage<OauthTokens>({
   type: 'custom',

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

@@ -7,10 +7,10 @@
 import { Micro } from 'effect';
 import { oidcApi } from './oidc.api.js';
 import { createClientStore, createLogoutError } from './client.store.utils.js';
-import { OauthTokens, OidcConfig } from './config.types.js';
-import { WellKnownResponse } from '@forgerock/sdk-types';
-import { createStorage } from '@forgerock/storage';
-import { LogoutErrorResult, LogoutSuccessResult } from './client.types.js';
+import type { OauthTokens, OidcConfig } from './config.types.js';
+import type { WellKnownResponse } from '@forgerock/sdk-types';
+import type { StorageClient } from '@forgerock/storage';
+import type { LogoutErrorResult, LogoutSuccessResult } from './client.types.js';
 
 export function logoutµ({
   tokens,
@@ -23,7 +23,7 @@ export function logoutµ({
   config: OidcConfig;
   wellknown: WellKnownResponse;
   store: ReturnType<typeof createClientStore>;
-  storageClient: ReturnType<typeof createStorage<OauthTokens>>;
+  storageClient: StorageClient<OauthTokens>;
 }) {
   return Micro.zip(
     // End session with the ID token
@@ -50,13 +50,11 @@ export function logoutµ({
     // Delete local token and return combined results
     Micro.flatMap(([sessionResponse, revokeResponse]) =>
       Micro.promise(() => storageClient.remove()).pipe(
-        Micro.flatMap((deleteRes) => {
-          const deleteResponse = typeof deleteRes === 'undefined' ? null : deleteRes;
-
+        Micro.flatMap((deleteResponse) => {
           const isInnerRequestError =
             (sessionResponse && 'error' in sessionResponse) ||
             (revokeResponse && 'error' in revokeResponse) ||
-            (deleteResponse && typeof deleteResponse === 'object' && 'error' in deleteResponse);
+            (deleteResponse && 'error' in deleteResponse);
 
           if (isInnerRequestError) {
             const result: LogoutErrorResult = {