@igxjs/node-components 1.0.0

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,378 @@
+# Node Components
+
+Shared components for Express.js applications providing session management, routing utilities, error handling, and Redis integration.
+
+## Installation
+
+```bash
+npm install @igxjs/node-components
+```
+
+## Modules
+
+### 1. Session Manager
+
+Provides SSO (Single Sign-On) session management with support for Redis and memory-based session stores.
+
+#### Configuration Options
+
+```javascript
+// Example configuration object
+// All fields are strings except SESSION_AGE which is a number
+
+const config = {
+  // SSO Configuration
+  SSO_ENDPOINT_URL: 'https://sso.example.com',
+  SSO_CLIENT_ID: 'your-client-id',
+  SSO_CLIENT_SECRET: 'your-client-secret',
+  SSO_SUCCESS_URL: '/dashboard',
+  SSO_FAILURE_URL: '/login',
+  
+  // Session Configuration
+  SESSION_AGE: 64800000, // 18 hours in milliseconds
+  SESSION_COOKIE_PATH: '/',
+  SESSION_SECRET: 'your-session-secret',
+  SESSION_PREFIX: 'ibmid:',  // Default value when not provided
+  
+  // Redis Configuration (optional - uses memory store if not provided)
+  REDIS_URL: 'redis://localhost:6379',
+  REDIS_CERT_PATH: '/path/to/cert.pem' // For TLS connections
+};
+```
+
+#### Usage Example
+
+```javascript
+import express from 'express';
+import { session } from '@igxjs/node-components';
+
+const app = express();
+
+// Initialize session
+await session.setup(app, config, (user) => {
+  // Process user object - compute permissions, avatar URL, etc.
+  return {
+    ...user,
+    displayName: user.email?.split('@')[0],
+    hasAdminAccess: user.authorized && user.email?.endsWith('@admin.com')
+  };
+});
+
+// Protect routes with authentication
+app.get('/protected', session.authenticate(), (req, res) => {
+  res.json({ user: req.user });
+});
+
+// SSO callback endpoint
+app.get('/auth/callback', session.callback((user) => {
+  // Initialize user object after successful login
+  return {
+    ...user,
+    loginTime: new Date()
+  };
+}));
+
+// Get available identity providers
+app.get('/auth/providers', session.identityProviders());
+
+// Refresh user session
+app.post('/auth/refresh', session.refresh((user) => {
+  return { ...user, refreshedAt: new Date() };
+}));
+
+// Logout endpoint
+app.get('/auth/logout', session.logout());
+```
+
+#### API Methods
+
+- **`setup(app, config, updateUser)`** - Initialize session configurations
+- **`sessionHandler()`** - Session RequestHandler (returns Promise<RequestHandler>)
+- **`authenticate(isDebugging?, redirectUrl?)`** - Resource protection middleware
+- **`callback(initUser)`** - SSO callback handler for successful login
+- **`identityProviders()`** - Get available identity providers
+- **`logout()`** - Application logout handler (not SSO logout)
+- **`refresh(initUser)`** - Refresh user session with new token
+- **`redisManager()`** - Get the RedisManager instance (returns RedisManager or null)
+- **`hasLock(email)`** - Check if email has a session refresh lock
+- **`lock(email)`** - Lock email for session refresh (prevents concurrent refreshes)
+- **`clearLocks()`** - Clear expired session refresh locks
+
+---
+
+### 2. FlexRouter
+
+A flexible routing utility for Express.js that allows mounting routers with custom context paths and middleware handlers.
+
+#### Usage Example
+
+```javascript
+import { Router } from 'express';
+import { FlexRouter } from '@igxjs/node-components';
+// Assuming you have an authenticate middleware
+// import { authenticate } from './middlewares/auth.js';
+
+// Create routers
+const publicRouter = Router();
+const privateRouter = Router();
+
+publicRouter.get('/health', (req, res) => {
+  res.send('OK');
+});
+
+privateRouter.get('/users', (req, res) => {
+  res.json({ users: [] });
+});
+
+// Define flex routers with context paths and optional middleware
+export const routers = [
+  new FlexRouter('/api/v1/public', publicRouter),
+  new FlexRouter('/api/v1/protected', privateRouter, [authenticate]), // with middleware
+];
+
+// Mount all routers to your Express app
+const app = express();
+const basePath = '';
+
+routers.forEach(router => {
+  router.mount(app, basePath);
+});
+
+// Routes will be available at:
+// - /api/v1/public/health
+// - /api/v1/protected/users (with authenticate middleware)
+```
+
+#### API
+
+- **`constructor(context, router, handlers?)`** - Create a new FlexRouter
+  - `context` (string) - The context path for the router
+  - `router` - Express Router instance
+  - `handlers` - Optional array of middleware handlers
+  
+- **`mount(app, basePath)`** - Mount the router to an Express application
+  - `app` - Express application instance
+  - `basePath` (string) - Base path to prepend to the context
+
+---
+
+### 3. RedisManager
+
+Redis connection management with TLS support and automatic reconnection handling.
+
+* Note: the RedisManager is used internally by the `SessionManager`, so you don't need to use it directly.
+
+#### Usage Example
+
+```javascript
+import { RedisManager } from '@igxjs/node-components';
+
+const redisManager = new RedisManager();
+
+// Connect to Redis (with optional TLS certificate)
+const connected = await redisManager.connect(
+  'rediss://localhost:6379',
+  '/path/to/cert.pem'
+);
+
+if (connected) {
+  // Get Redis client for direct operations
+  const client = redisManager.getClient();
+  await client.set('key', 'value');
+  
+  // Check connection status
+  const isConnected = await redisManager.isConnected();
+  
+  // Disconnect when done
+  await redisManager.disConnect();
+}
+```
+
+#### API Methods
+
+- **`connect(redisUrl, certPath)`** - Connect to Redis server
+  - Returns: `Promise<boolean>` - Returns true if connected successfully
+  - Supports both `redis://` and `rediss://` (TLS) URLs
+  - Automatically handles TLS certificate loading when using `rediss://`
+
+- **`getClient()`** - Get the Redis client instance
+  - Returns: Redis client for direct operations
+
+- **`isConnected()`** - Check if Redis connection is active
+  - Returns: `Promise<boolean>` - Returns true if connected and responsive
+
+- **`disConnect()`** - Disconnect from Redis server
+  - Returns: `Promise<void>`
+
+---
+
+### 4. HTTP Handlers
+
+Custom error handling utilities with standardized HTTP status codes and error responses.
+
+#### Available Exports
+
+```javascript
+import { 
+  CustomError, 
+  httpErrorHandler, 
+  httpCodes, 
+  httpMessages,
+  httpHelper 
+} from '@igxjs/node-components';
+```
+
+#### Usage Examples
+
+**Creating Custom Errors:**
+
+```javascript
+// Basic custom error
+throw new CustomError(httpCodes.BAD_REQUEST, 'Invalid input data');
+
+// With error details and additional data
+throw new CustomError(
+  httpCodes.UNAUTHORIZED,
+  'Authentication failed',
+  { originalError: err },
+  { attemptedEmail: email }
+);
+```
+
+**Handling Axios/HTTP Errors:**
+
+```javascript
+// Use httpHelper to handle Axios errors
+try {
+  await axios.get('https://api.example.com/data');
+} catch (error) {
+  // Convert Axios error to CustomError
+  throw httpHelper.handleAxiosError(error, 'Failed to fetch data');
+}
+
+// Or use it in error handling
+app.get('/api/data', async (req, res, next) => {
+  try {
+    const response = await axios.get('https://external-api.com/data');
+    res.json(response.data);
+  } catch (error) {
+    return next(httpHelper.handleAxiosError(error, 'Failed to fetch external data'));
+  }
+});
+```
+
+**Error Handler Middleware:**
+
+```javascript
+import express from 'express';
+import { httpErrorHandler } from '@igxjs/node-components';
+
+const app = express();
+
+// Your routes here
+app.get('/api/data', async (req, res, next) => {
+  try {
+    // Your logic
+  } catch (error) {
+    next(error);
+  }
+});
+
+// Add error handler as the last middleware
+app.use(httpErrorHandler);
+```
+
+#### HTTP Codes & Messages
+
+```javascript
+httpCodes.OK               // 200
+httpCodes.CREATED          // 201
+httpCodes.NO_CONTENT       // 204
+httpCodes.BAD_REQUEST      // 400
+httpCodes.UNAUTHORIZED     // 401
+httpCodes.FORBIDDEN        // 403
+httpCodes.NOT_FOUND        // 404
+httpCodes.NOT_ACCEPTABLE   // 406
+httpCodes.CONFLICT         // 409
+httpCodes.SYSTEM_FAILURE   // 500
+
+// Corresponding messages
+httpMessages.OK            // 'OK'
+httpMessages.BAD_REQUEST   // 'Bad Request'
+// ... etc
+```
+
+#### CustomError API
+
+**Constructor:**
+```javascript
+// new CustomError(code, message, error, data)
+// - code: number - HTTP status code
+// - message: string - Error message
+// - error: object (optional) - Original error object
+// -  object (optional) - Additional error data
+```
+
+**Properties:**
+- **`code`** - HTTP status code (number)
+- **`message`** - Error message (string)
+- **`error`** - Original error object (if provided)
+- **`data`** - Additional error data (if provided)
+
+#### httpHelper API
+
+The `httpHelper` object provides utility methods for error handling:
+
+**Methods:**
+
+- **`httpHelper.handleAxiosError(error, defaultMessage)`** - Analyze and convert Axios/HTTP errors to CustomError
+  - `error` (Error | AxiosError) - The error object to analyze
+  - `defaultMessage` (string, optional) - Default message if error message cannot be extracted (default: 'An error occurred')
+  - Returns: `CustomError` instance with extracted status code, message, and data
+
+- **`httpHelper.format(str, ...args)`** - Format a string with placeholders
+  - `str` (string) - String with `{0}`, `{1}`, etc. placeholders
+  - `...args` - Values to replace placeholders
+  - Returns: Formatted string
+
+- **`httpHelper.toZodMessage(error)`** - Generate friendly Zod validation error message
+  - `error` (ZodError) - Zod validation error
+  - Returns: Formatted error message string
+
+---
+
+## Features
+
+- ✅ **Session Management** - Full SSO integration with Redis or memory storage
+- ✅ **Flexible Routing** - Easy mounting of routers with context paths and middleware
+- ✅ **Redis Integration** - Robust Redis connection management with TLS support
+- ✅ **Error Handling** - Standardized error responses and HTTP status codes
+- ✅ **TypeScript Support** - Complete type definitions included
+- ✅ **Session Locking** - Prevents concurrent session refresh operations
+- ✅ **Automatic Reconnection** - Redis auto-reconnect with event handling
+
+## Requirements
+
+- Node.js >= 18
+- Express.js >= 4.x
+- Redis (optional, for session storage)
+
+## TypeScript
+
+This package includes TypeScript definitions. You can import types in TypeScript projects:
+
+```typescript
+import type { 
+  SessionConfig, 
+  SessionManager,
+  SessionUser,
+  SessionUserAttributes,
+  FlexRouter,
+  RedisManager,
+  CustomError 
+} from '@igxjs/node-components';
+```
+
+## License
+
+[Apache 2.0](LICENSE.md)