@igxjs/node-components 1.0.0 → 1.0.1

package/README.md

@@ -44,12 +44,13 @@ const config = {
 
 ```javascript
 import express from 'express';
-import { session } from '@igxjs/node-components';
+import { SessionManager } from '@igxjs/node-components';
 
 const app = express();
+const session = new SessionManager(config);
 
 // Initialize session
-await session.setup(app, config, (user) => {
+await session.setup(app, (user) => {
   // Process user object - compute permissions, avatar URL, etc.
   return {
     ...user,
@@ -87,7 +88,6 @@ 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

package/components/http-handlers.js

@@ -24,6 +24,7 @@ export const httpCodes = {
   NOT_ACCEPTABLE: 406,
   CONFLICT: 409,
   SYSTEM_FAILURE: 500,
+  NOT_IMPLEMENTED: 501,
 };
 
 export class CustomError extends Error {
@@ -47,7 +48,7 @@ export class CustomError extends Error {
 }
 
 /**
- * Custom error handler
+ * Custom Error handler
  *
  * @param {CustomError} err Error
  * @param {import('@types/express').Request} req Request
@@ -98,6 +99,16 @@ export const httpErrorHandler = (err, req, res, next) => {
   console.error('### /ERROR ###');
 };
 
+/**
+ * HTTP not found error handler
+ * @param {Request} _req Request object
+ * @param {Response} _res Response object
+ * @param {NextFunction} next Next function
+ */
+export const httpNotFoundHandler = (_req, _res, next) => {
+  next(new CustomError(httpCodes.NOT_FOUND, httpMessages.NOT_FOUND));
+};
+
 /**
  * Extract HTTP status code from error
  * @param {Error} error Error object
@@ -165,3 +176,15 @@ export const httpHelper = {
     return new CustomError(errorCode, errorMessage, error, errorData);
   }
 };
+
+/**
+ * HTTP Error - alias of `new CustomError()`
+ * @param {Number} code Error code
+ * @param {string} message Error message
+ * @param {Error} error Original Error instance
+ * @param {any} data Error data
+ * @returns {CustomError} Returns a new instance of CustomError
+ */
+export const httpError = (code, message, error, data) => {
+  return new CustomError(code, message, error, data);
+};

package/components/session.js

@@ -1,8 +1,8 @@
 import axios from 'axios';
 import session from 'express-session';
-import { jwtDecrypt } from 'jose';
-import { RedisStore } from 'connect-redis';
 import memStore from 'memorystore';
+import { RedisStore } from 'connect-redis';
+import { jwtDecrypt } from 'jose';
 
 import { CustomError, httpCodes, httpHelper, httpMessages } from './http-handlers.js';
 import { RedisManager } from './redis.js';
@@ -46,6 +46,29 @@ export class SessionManager {
   /** @type {import('axios').AxiosInstance} */
   #idpRequest = null;
 
+  /**
+   * Create a new session manager
+   * @param {SessionConfig} config Session configuration
+   */
+  constructor(config) {
+    this.#config = {
+      // Session
+      SESSION_AGE: config.SESSION_AGE || 64800000,
+      SESSION_COOKIE_PATH: config.SESSION_COOKIE_PATH || '/',
+      SESSION_SECRET: config.SESSION_SECRET,
+      SESSION_PREFIX: config.SESSION_PREFIX || 'ibmid:',
+      // Identity Provider
+      SSO_ENDPOINT_URL: config.SSO_ENDPOINT_URL,
+      SSO_CLIENT_ID: config.SSO_CLIENT_ID,
+      SSO_CLIENT_SECRET: config.SSO_CLIENT_SECRET,
+      SSO_SUCCESS_URL: config.SSO_SUCCESS_URL,
+      SSO_FAILURE_URL: config.SSO_FAILURE_URL,
+      // Redis
+      REDIS_URL: config.REDIS_URL,
+      REDIS_CERT_PATH: config.REDIS_CERT_PATH,
+    };
+  }
+
   /**
    * Check if the email has a session refresh lock
    * @param {string} email Email address
@@ -99,34 +122,17 @@ export class SessionManager {
   /**
    * Setup the session/user handlers with configurations
    * @param {import('@types/express').Application} app Express application
-   * @param {SessionConfig} config Redis configurations
    * @param {(user: object) => object} updateUser Update user object if user should have proper attributes, e.g. permissions, avatar URL
    */
-  async setup(app, config, updateUser) {
+  async setup(app, updateUser) {
     this.#redisManager = new RedisManager();
-    this.#config = {
-      // Session
-      SESSION_AGE: config.SESSION_AGE || 64800000,
-      SESSION_COOKIE_PATH: config.SESSION_COOKIE_PATH || '/',
-      SESSION_SECRET: config.SESSION_SECRET,
-      SESSION_PREFIX: config.SESSION_PREFIX || 'ibmid:',
-      // Identity Provider
-      SSO_ENDPOINT_URL: config.SSO_ENDPOINT_URL,
-      SSO_CLIENT_ID: config.SSO_CLIENT_ID,
-      SSO_CLIENT_SECRET: config.SSO_CLIENT_SECRET,
-      SSO_SUCCESS_URL: config.SSO_SUCCESS_URL,
-      SSO_FAILURE_URL: config.SSO_FAILURE_URL,
-      // Redis
-      REDIS_URL: config.REDIS_URL,
-      REDIS_CERT_PATH: config.REDIS_CERT_PATH,
-    };
     // Identity Provider Request
     this.#idpRequest = axios.create({
       baseURL: this.#config.SSO_ENDPOINT_URL,
       timeout: 30000,
     });
     app.set('trust proxy', 1);
-    app.use(await this.sessionHandler());
+    app.use(await this.#sessionHandler());
     app.use(this.#userHandler(updateUser));
   }
 
@@ -164,7 +170,7 @@ export class SessionManager {
    * Get session RequestHandler
    * @returns {Promise<import('@types/express').RequestHandler>} Returns RequestHandler instance of Express
    */
-  async sessionHandler() {
+  async #sessionHandler() {
     if(this.#config.REDIS_URL?.length > 0) {
       await this.#redisManager.connect(this.#config.REDIS_URL, this.#config.REDIS_CERT_PATH);
       return this.#redisSession();

package/index.d.ts

@@ -91,12 +91,6 @@ export class SessionManager {
     updateUser: (user: SessionUser | undefined) => any
   ): Promise<void>;
   
-  /**
-   * Get session RequestHandler
-   * @returns Returns RequestHandler instance of Express
-   */
-  sessionHandler(): Promise<RequestHandler>;
-  
   /**
    * Resource protection middleware
    * @param isDebugging Debugging flag (default: false)

package/index.js

@@ -1,8 +1,4 @@
-import { SessionManager } from './components/session.js';
-
 export { SessionConfig, SessionManager } from './components/session.js';
 export { httpCodes, httpMessages, httpErrorHandler, CustomError, httpHelper } from './components/http-handlers.js';
 export { RedisManager } from './components/redis.js';
 export { FlexRouter } from './components/router.js';
-
-export const session = new SessionManager();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@igxjs/node-components",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Node components for igxjs",
   "main": "index.js",
   "type": "module",

package/tests/session.test.js

@@ -9,7 +9,6 @@ describe('SessionManager', () => {
   let clock;
 
   beforeEach(() => {
-    sessionManager = new SessionManager();
     clock = sinon.useFakeTimers();
   });
 
@@ -24,6 +23,7 @@ describe('SessionManager', () => {
       expect(config).to.have.property('SSO_ENDPOINT_URL');
       expect(config).to.have.property('SESSION_SECRET');
       expect(config).to.have.property('REDIS_URL');
+      sessionManager = new SessionManager(config);
     });
   });