Merge pull request #251 from ForgeRock/storage-package

feat: storage-package

Author: ryanbas21

.changeset/orange-baths-vanish.md

@@ -0,0 +1,6 @@
+---
+'@forgerock/sdk-types': minor
+'@forgerock/storage': minor
+---
+
+created sdk-storage module, which includes session,local, and token storage

eslint.config.mjs

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
 import { FlatCompat } from '@eslint/eslintrc';
 import { dirname } from 'path';
 import { fileURLToPath } from 'url';

nx.json

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

package.json

@@ -132,5 +132,6 @@
   },
   "nx": {
     "includedScripts": []
-  }
+  },
+  "dependencies": {}
 }

packages/davinci-client/src/lib/config.types.test-d.ts

@@ -6,13 +6,13 @@
  */
 import { describe, expectTypeOf, it } from 'vitest';
 import type { DaVinciConfig, InternalDaVinciConfig } from './config.types.js';
-import type { AsyncConfigOptions } from '@forgerock/sdk-types';
+import type { AsyncLegacyConfigOptions } from '@forgerock/sdk-types';
 import type { WellknownResponse } from './wellknown.types.js';
 
 describe('Config Types', () => {
   describe('DaVinciConfig', () => {
-    it('should extend AsyncConfigOptions', () => {
-      expectTypeOf<DaVinciConfig>().toMatchTypeOf<AsyncConfigOptions>();
+    it('should extend AsyncLegacyConfigOptions', () => {
+      expectTypeOf<DaVinciConfig>().toMatchTypeOf<AsyncLegacyConfigOptions>();
     });
 
     it('should have optional responseType', () => {
@@ -24,7 +24,7 @@ describe('Config Types', () => {
       expectTypeOf<DaVinciConfig>().toHaveProperty('responseType').toBeNullable();
     });
 
-    it('should allow AsyncConfigOptions properties', () => {
+    it('should allow AsyncLegacyConfigOptions properties', () => {
       const config: DaVinciConfig = {
         clientId: 'test-client',
         scope: 'openid profile',

packages/davinci-client/src/lib/config.types.ts

@@ -5,12 +5,12 @@
  * of the MIT license. See the LICENSE file for details.
  */
 /**
- * Import ConfigOptions type from the JavaScript SDK
+ * Import LegacyConfigOptions type from the JavaScript SDK
  */
-import type { AsyncConfigOptions } from '@forgerock/sdk-types';
+import type { AsyncLegacyConfigOptions } from '@forgerock/sdk-types';
 import { WellknownResponse } from './wellknown.types.js';
 
-export interface DaVinciConfig extends AsyncConfigOptions {
+export interface DaVinciConfig extends AsyncLegacyConfigOptions {
   responseType?: string;
 }
 

packages/sdk-effects/storage/README.md

@@ -0,0 +1,82 @@
+# ForgeRock SDK Effects - Storage
+
+This package provides a storage effect for managing token storage within the ForgeRock JavaScript SDK ecosystem.
+
+## Installation
+
+```bash
+npm install @forgerock/sdk-effects-storage
+# or
+yarn add @forgerock/sdk-effects-storage
+```
+
+## Usage
+
+The `storage` effect facilitates getting, setting, and removing items from browser storage (`localStorage` or `sessionStorage`) or a custom token store implementation.
+
+```typescript
+import { storage } from '@forgerock/sdk-effects-storage';
+import { TokenStoreObject } from '@forgerock/sdk-types';
+
+// Example using localStorage
+const storageEffect = storage({
+  tokenStore: 'localStorage',
+  prefix: 'fr-auth',
+  clientId: 'my-client-id',
+});
+
+const storageApi = storageEffect();
+
+async function manageTokens() {
+  // Set a token
+  await storageApi.set('someTokenValue');
+
+  // Get a token
+  const token = await storageApi.get();
+  console.log(token); // Output: 'someTokenValue'
+
+  // Remove a token
+  await storageApi.remove();
+
+  // Verify removal
+  const removedToken = await storageApi.get();
+  console.log(removedToken); // Output: null
+}
+
+// Example using a custom token store
+const myCustomStore: TokenStoreObject = {
+  get: async (key) => {
+    /* ... custom logic ... */ return null;
+  },
+  set: async (key, value) => {
+    /* ... custom logic ... */
+  },
+  remove: async (key) => {
+    /* ... custom logic ... */
+  },
+};
+
+const customStorageEffect = storage(
+  {
+    tokenStore: 'localStorage', // This is ignored when customTokenStore is provided
+    prefix: 'fr-auth',
+    clientId: 'my-client-id',
+  },
+  myCustomStore,
+);
+
+const customStorageApi = customStorageEffect();
+// Use customStorageApi.get(), .set(), .remove() as above
+```
+
+## Configuration
+
+The `storage` function accepts a configuration object with the following properties:
+
+- `tokenStore`: Specifies the storage mechanism. Can be `'localStorage'`, `'sessionStorage'`, or a custom object conforming to the `TokenStoreObject` interface.
+- `prefix`: A string prefix used in generating the storage key.
+- `clientId`: The client ID, also used in generating the storage key.
+
+An optional second argument allows providing a `customTokenStore` object directly, which overrides the `tokenStore` configuration property if provided.
+
+The storage key is generated as \`\` `${prefix}-${clientId}`

packages/sdk-effects/storage/eslint.config.mjs

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+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/sdk-effects/storage/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@forgerock/storage",
+  "version": "0.0.1",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ForgeRock/ping-javascript-sdk.git",
+    "directory": "packages/sdk-effects/storage"
+  },
+  "type": "module",
+  "main": "./dist/src/index.js",
+  "module": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "dependencies": {
+    "@forgerock/sdk-types": "workspace:*",
+    "tslib": "^2.3.0"
+  },
+  "nx": {
+    "tags": ["scope:sdk-effects"]
+  }
+}

packages/sdk-effects/storage/src/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+export * from './lib/storage.effects.js';