feat: add-oidc-client-and-token-store

Author: ryanbas21

.changeset/clever-garlics-listen.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/oidc-client': patch
+---
+
+adds token-store module to newly created oidc-client for generic oidc interactions.

nx.json

@@ -70,7 +70,7 @@
     },
     "test": {
       "inputs": ["default", "^default", "noMarkdown", "^noMarkdown"],
-      "dependsOn": ["^test", "^build"],
+      "dependsOn": ["^test", "^build", "^build"],
       "outputs": ["{projectRoot}/coverage"],
       "cache": true
     },

packages/oidc-client/README.md

@@ -0,0 +1,3 @@
+# oidc-client
+
+A generic OpenID Connect (OIDC) client library for JavaScript and TypeScript, designed to work with any OIDC-compliant identity provider.

packages/oidc-client/eslint.config.mjs

@@ -0,0 +1,22 @@
+import baseConfig from '../../eslint.config.mjs';
+
+export default [
+  ...baseConfig,
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          ignoredFiles: [
+            '{projectRoot}/eslint.config.{js,cjs,mjs}',
+            '{projectRoot}/vite.config.{js,ts,mjs,mts}',
+          ],
+        },
+      ],
+    },
+    languageOptions: {
+      parser: await import('jsonc-eslint-parser'),
+    },
+  },
+];

packages/oidc-client/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@forgerock/oidc-client",
+  "version": "0.0.1",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "default": "./dist/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/src/index.js",
+  "module": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "lint": "pnpm nx nxLint",
+    "test": "pnpm nx nxTest",
+    "test:watch": "pnpm nx nxTest --watch"
+  },
+  "dependencies": {
+    "@forgerock/sdk-types": "workspace:*",
+    "@forgerock/storage": "workspace:*"
+  },
+  "nx": {
+    "tags": ["scope:package"]
+  }
+}

packages/oidc-client/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/token-store.js';

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

@@ -0,0 +1,52 @@
+import { describe, expectTypeOf, it } from 'vitest';
+import { CustomStorageObject, Tokens } from '@forgerock/sdk-types';
+import { GenericError, StorageConfig } from '@forgerock/storage';
+import { tokenStore } from './token-store.js';
+
+describe('tokenStore type tests', () => {
+  const mockTokens: Tokens = {
+    accessToken: 'test_access_token',
+    idToken: 'test_id_token',
+    refreshToken: 'test_refresh',
+    tokenExpiry: 3600,
+  };
+  it('should return a storage object with Tokens type when customStore is not provided', () => {
+    const storageConfig: StorageConfig = {
+      storeType: 'sessionStorage',
+    };
+    const store = tokenStore(storageConfig);
+    expectTypeOf<Promise<void | { code: string; message: string; type: string }>>(
+      store.set(mockTokens),
+    );
+
+    expectTypeOf<Promise<void>>(store.remove());
+    expectTypeOf<Promise<Tokens | GenericError | null>>(store.get());
+    const tokens = store.get();
+    if ('accessToken' in tokens) {
+      expectTypeOf<Promise<Tokens>>();
+    }
+  });
+
+  it('should return a storage object with Tokens type when customStore is provided', () => {
+    const storageConfig: StorageConfig = {
+      storeType: 'sessionStorage',
+    };
+    const customStore: CustomStorageObject = {
+      get: async (key: string) => {
+        return key;
+      },
+      set: async (key: string, value: any) => {
+        console.log(key, value);
+      },
+      remove: async (key: string) => {
+        console.log(key);
+      },
+    };
+    const store = tokenStore(storageConfig, customStore);
+    expectTypeOf<Promise<Tokens | GenericError | null>>(store.get());
+    expectTypeOf<Promise<void | { code: string; message: string; type: string }>>(
+      store.set(mockTokens),
+    );
+    expectTypeOf<Promise<void>>(store.remove());
+  });
+});

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

@@ -0,0 +1,38 @@
+import { vi } from 'vitest';
+import { tokenStore } from './token-store.js';
+import { createStorage, StorageConfig } from '@forgerock/storage';
+
+vi.mock('@forgerock/storage', () => {
+  const mockStorage = {
+    getItem: vi.fn(),
+    setItem: vi.fn(),
+    removeItem: vi.fn(),
+    clear: vi.fn(),
+  };
+
+  return {
+    createStorage: vi.fn(() => mockStorage),
+  };
+});
+
+describe('tokenStore', () => {
+  const storageConfig = {
+    storeType: 'sessionStorage',
+  } as StorageConfig;
+
+  it('should call createStorage with the correct arguments when customStore is not provided', () => {
+    tokenStore(storageConfig);
+    expect(createStorage).toHaveBeenCalledWith(storageConfig, 'tokenStore');
+  });
+
+  it('should call createStorage with the correct arguments when customStore is provided', () => {
+    const customStore = {
+      get: vi.fn(),
+      set: vi.fn(),
+      remove: vi.fn(),
+    };
+
+    tokenStore(storageConfig, customStore);
+    expect(createStorage).toHaveBeenCalledWith(storageConfig, 'tokenStore', customStore);
+  });
+});

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

@@ -0,0 +1,10 @@
+import { CustomStorageObject, Tokens } from '@forgerock/sdk-types';
+import { createStorage, StorageConfig } from '@forgerock/storage';
+
+export const tokenStore = (storage: StorageConfig, customStore?: CustomStorageObject) => {
+  if (customStore) {
+    return createStorage<Tokens>(storage, 'tokenStore', customStore);
+  } else {
+    return createStorage<Tokens>(storage, 'tokenStore');
+  }
+};

packages/oidc-client/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "../sdk-effects/storage"
+    },
+    {
+      "path": "../sdk-types"
+    },
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "nx": {
+    "addTypecheckTarget": false
+  }
+}