b23-lib 1.2.9 → 1.2.11

package/dist/index.d.mts

@@ -236,25 +236,28 @@ declare const Schema: {
 };
 
 type StringifiedJSONArray = string;
-type AuthUtilityConfig = {
-    maxTokenAge?: string;
-    userPrivateKeys?: StringifiedJSONArray;
-    userPublicKeys?: StringifiedJSONArray;
-    anonymousPrivateKeys?: StringifiedJSONArray;
-    anonymousPublicKeys?: StringifiedJSONArray;
-    systemPrivateKeys?: StringifiedJSONArray;
-    systemPublicKeys?: StringifiedJSONArray;
-    adminPrivateKeys?: StringifiedJSONArray;
-    adminPublicKeys?: StringifiedJSONArray;
-};
-declare const DefaultAuthUtilityConfig: AuthUtilityConfig;
+interface AuthUtilityConfig {
+    maxTokenAge: string;
+    userPrivateKeys: StringifiedJSONArray;
+    userPublicKeys: StringifiedJSONArray;
+    anonymousPrivateKeys: StringifiedJSONArray;
+    anonymousPublicKeys: StringifiedJSONArray;
+    systemPrivateKeys: StringifiedJSONArray;
+    systemPublicKeys: StringifiedJSONArray;
+    adminPrivateKeys: StringifiedJSONArray;
+    adminPublicKeys: StringifiedJSONArray;
+}
+declare const DefaultAuthUtilityConfig: Readonly<AuthUtilityConfig>;
 type AuthTokenType = 'Anon' | 'User' | 'System' | 'Admin';
-type AuthMiddlewareConfig = {
-    allowAnonymous?: boolean;
-    allowSystem?: boolean;
-    allowUser?: boolean;
-};
-declare const DefaultAuthMiddlewareConfig: AuthMiddlewareConfig;
+interface AuthMiddlewareConfig {
+    allowAnonymous: boolean;
+    allowSystem: boolean;
+    allowUser: boolean;
+}
+declare const DefaultAuthMiddlewareConfig: Readonly<AuthMiddlewareConfig>;
+/**
+ * A utility class for JWT authentication and authorization.
+ */
 declare class AuthUtility {
     private maxTokenAge;
     private userPrivateKeys;
@@ -265,7 +268,15 @@ declare class AuthUtility {
     private systemPublicKeys;
     private adminPrivateKeys;
     private adminPublicKeys;
-    constructor({ maxTokenAge, userPrivateKeys, userPublicKeys, anonymousPrivateKeys, anonymousPublicKeys, systemPrivateKeys, systemPublicKeys, adminPrivateKeys, adminPublicKeys }?: AuthUtilityConfig);
+    /**
+     * Initializes the AuthUtility class with a configuration.
+     * @param config The configuration for the utility (optional).
+     */
+    constructor(config?: Partial<AuthUtilityConfig>);
+    /**
+     * Logs warnings if the number of keys exceeds recommended limits.
+     */
+    private logWarnings;
     private createSignedJWT;
     private verifySignedJWT;
     createAnonymousToken(id: string, additionalData?: object): Promise<string>;
@@ -276,7 +287,11 @@ declare class AuthUtility {
     verifySystemToken(token: string): Promise<jose.JWTPayload>;
     createAdminToken(id: string, additionalData?: object): Promise<string>;
     verifyAdminToken(token: string): Promise<jose.JWTPayload>;
-    AuthMiddleware({ allowAnonymous, allowSystem, allowUser }?: AuthMiddlewareConfig): (req: any, res: any, next: any) => Promise<void>;
+    /**
+     * Middleware for handling JWT authentication.
+     * @param config Configuration for middleware behavior.
+     */
+    AuthMiddleware(config?: Partial<AuthMiddlewareConfig>): (req: any, res: any, next: any) => Promise<void>;
 }
 
 declare const Utils: {
@@ -304,6 +319,11 @@ declare const ResponseUtility: {
     };
 };
 
+type ErrorType = {
+    status: number;
+    statusText: string;
+    error: any;
+};
 type SuccessType = {
     status: number;
     statusText: string;
@@ -319,4 +339,4 @@ declare const Logger: {
     logInvalidPayload: (functionName: string, errorMessage: string) => void;
 };
 
-export { type AuthMiddlewareConfig, type AuthTokenType, AuthUtility, type AuthUtilityConfig, DefaultAuthMiddlewareConfig, DefaultAuthUtilityConfig, DynamoDBUtility as DynamoDB, Fetch, Logger, ResponseUtility, Schema, Utils };
+export { type AuthMiddlewareConfig, type AuthTokenType, AuthUtility, type AuthUtilityConfig, DefaultAuthMiddlewareConfig, DefaultAuthUtilityConfig, DynamoDBUtility as DynamoDB, type ErrorType, Fetch, Logger, ResponseUtility, Schema, type SuccessType, Utils };

package/dist/index.d.ts

@@ -236,25 +236,28 @@ declare const Schema: {
 };
 
 type StringifiedJSONArray = string;
-type AuthUtilityConfig = {
-    maxTokenAge?: string;
-    userPrivateKeys?: StringifiedJSONArray;
-    userPublicKeys?: StringifiedJSONArray;
-    anonymousPrivateKeys?: StringifiedJSONArray;
-    anonymousPublicKeys?: StringifiedJSONArray;
-    systemPrivateKeys?: StringifiedJSONArray;
-    systemPublicKeys?: StringifiedJSONArray;
-    adminPrivateKeys?: StringifiedJSONArray;
-    adminPublicKeys?: StringifiedJSONArray;
-};
-declare const DefaultAuthUtilityConfig: AuthUtilityConfig;
+interface AuthUtilityConfig {
+    maxTokenAge: string;
+    userPrivateKeys: StringifiedJSONArray;
+    userPublicKeys: StringifiedJSONArray;
+    anonymousPrivateKeys: StringifiedJSONArray;
+    anonymousPublicKeys: StringifiedJSONArray;
+    systemPrivateKeys: StringifiedJSONArray;
+    systemPublicKeys: StringifiedJSONArray;
+    adminPrivateKeys: StringifiedJSONArray;
+    adminPublicKeys: StringifiedJSONArray;
+}
+declare const DefaultAuthUtilityConfig: Readonly<AuthUtilityConfig>;
 type AuthTokenType = 'Anon' | 'User' | 'System' | 'Admin';
-type AuthMiddlewareConfig = {
-    allowAnonymous?: boolean;
-    allowSystem?: boolean;
-    allowUser?: boolean;
-};
-declare const DefaultAuthMiddlewareConfig: AuthMiddlewareConfig;
+interface AuthMiddlewareConfig {
+    allowAnonymous: boolean;
+    allowSystem: boolean;
+    allowUser: boolean;
+}
+declare const DefaultAuthMiddlewareConfig: Readonly<AuthMiddlewareConfig>;
+/**
+ * A utility class for JWT authentication and authorization.
+ */
 declare class AuthUtility {
     private maxTokenAge;
     private userPrivateKeys;
@@ -265,7 +268,15 @@ declare class AuthUtility {
     private systemPublicKeys;
     private adminPrivateKeys;
     private adminPublicKeys;
-    constructor({ maxTokenAge, userPrivateKeys, userPublicKeys, anonymousPrivateKeys, anonymousPublicKeys, systemPrivateKeys, systemPublicKeys, adminPrivateKeys, adminPublicKeys }?: AuthUtilityConfig);
+    /**
+     * Initializes the AuthUtility class with a configuration.
+     * @param config The configuration for the utility (optional).
+     */
+    constructor(config?: Partial<AuthUtilityConfig>);
+    /**
+     * Logs warnings if the number of keys exceeds recommended limits.
+     */
+    private logWarnings;
     private createSignedJWT;
     private verifySignedJWT;
     createAnonymousToken(id: string, additionalData?: object): Promise<string>;
@@ -276,7 +287,11 @@ declare class AuthUtility {
     verifySystemToken(token: string): Promise<jose.JWTPayload>;
     createAdminToken(id: string, additionalData?: object): Promise<string>;
     verifyAdminToken(token: string): Promise<jose.JWTPayload>;
-    AuthMiddleware({ allowAnonymous, allowSystem, allowUser }?: AuthMiddlewareConfig): (req: any, res: any, next: any) => Promise<void>;
+    /**
+     * Middleware for handling JWT authentication.
+     * @param config Configuration for middleware behavior.
+     */
+    AuthMiddleware(config?: Partial<AuthMiddlewareConfig>): (req: any, res: any, next: any) => Promise<void>;
 }
 
 declare const Utils: {
@@ -304,6 +319,11 @@ declare const ResponseUtility: {
     };
 };
 
+type ErrorType = {
+    status: number;
+    statusText: string;
+    error: any;
+};
 type SuccessType = {
     status: number;
     statusText: string;
@@ -319,4 +339,4 @@ declare const Logger: {
     logInvalidPayload: (functionName: string, errorMessage: string) => void;
 };
 
-export { type AuthMiddlewareConfig, type AuthTokenType, AuthUtility, type AuthUtilityConfig, DefaultAuthMiddlewareConfig, DefaultAuthUtilityConfig, DynamoDBUtility as DynamoDB, Fetch, Logger, ResponseUtility, Schema, Utils };
+export { type AuthMiddlewareConfig, type AuthTokenType, AuthUtility, type AuthUtilityConfig, DefaultAuthMiddlewareConfig, DefaultAuthUtilityConfig, DynamoDBUtility as DynamoDB, type ErrorType, Fetch, Logger, ResponseUtility, Schema, type SuccessType, Utils };

package/dist/index.js

@@ -697,40 +697,49 @@ var AuthUtility = class {
   systemPublicKeys;
   adminPrivateKeys;
   adminPublicKeys;
-  constructor({ maxTokenAge = "30 days", userPrivateKeys = "[]", userPublicKeys = "[]", anonymousPrivateKeys = "[]", anonymousPublicKeys = "[]", systemPrivateKeys = "[]", systemPublicKeys = "[]", adminPrivateKeys = "[]", adminPublicKeys = "[]" } = DefaultAuthUtilityConfig) {
+  /**
+   * Initializes the AuthUtility class with a configuration.
+   * @param config The configuration for the utility (optional).
+   */
+  constructor(config = DefaultAuthUtilityConfig) {
+    const {
+      maxTokenAge,
+      userPrivateKeys,
+      userPublicKeys,
+      anonymousPrivateKeys,
+      anonymousPublicKeys,
+      systemPrivateKeys,
+      systemPublicKeys,
+      adminPrivateKeys,
+      adminPublicKeys
+    } = { ...DefaultAuthUtilityConfig, ...config };
     this.maxTokenAge = maxTokenAge;
     this.userPrivateKeys = JSON.parse(userPrivateKeys);
-    if (this.userPrivateKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 1 user private key provided. The last key will be used for signing.");
-    }
     this.userPublicKeys = JSON.parse(userPublicKeys);
-    if (this.userPublicKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 3 user public keys provided. This is not recommended.");
-    }
     this.anonymousPrivateKeys = JSON.parse(anonymousPrivateKeys);
-    if (this.anonymousPrivateKeys.length > 1) {
-      Logger_default.logWarning("AuthUtility", "More than 1 anonymous private key provided. The last key will be used for signing.");
-    }
     this.anonymousPublicKeys = JSON.parse(anonymousPublicKeys);
-    if (this.anonymousPublicKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 3 anonymous public keys provided. This is not recommended.");
-    }
     this.systemPrivateKeys = JSON.parse(systemPrivateKeys);
-    if (this.systemPrivateKeys.length > 1) {
-      Logger_default.logWarning("AuthUtility", "More than 1 system private key provided. The last key will be used for signing.");
-    }
     this.systemPublicKeys = JSON.parse(systemPublicKeys);
-    if (this.systemPublicKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 3 system public keys provided. This is not recommended.");
-    }
     this.adminPrivateKeys = JSON.parse(adminPrivateKeys);
-    if (this.adminPrivateKeys.length > 1) {
-      Logger_default.logWarning("AuthUtility", "More than 1 admin private key provided. The last key will be used for signing.");
-    }
     this.adminPublicKeys = JSON.parse(adminPublicKeys);
-    if (this.adminPublicKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 3 admin public keys provided. This is not recommended.");
-    }
+    this.logWarnings();
+  }
+  /**
+   * Logs warnings if the number of keys exceeds recommended limits.
+   */
+  logWarnings() {
+    const warn = (type, keys, limit) => keys.length > limit && Logger_default.logWarning(
+      "AuthUtility",
+      `More than ${limit} ${type} keys provided. This is not recommended.`
+    );
+    warn("user private", this.userPrivateKeys, 3);
+    warn("user public", this.userPublicKeys, 3);
+    warn("anonymous private", this.anonymousPrivateKeys, 1);
+    warn("anonymous public", this.anonymousPublicKeys, 3);
+    warn("system private", this.systemPrivateKeys, 1);
+    warn("system public", this.systemPublicKeys, 3);
+    warn("admin private", this.adminPrivateKeys, 1);
+    warn("admin public", this.adminPublicKeys, 3);
   }
   async createSignedJWT(payload, privateKeyString, expiration) {
     const privateKey = await (0, import_jose.importPKCS8)(privateKeyString, "RS256");
@@ -814,50 +823,47 @@ var AuthUtility = class {
     (0, import_assert.default)(payload.type === "Admin", ErrorTypes_default.INVALID_AUTH_TYPE);
     return payload;
   }
-  AuthMiddleware({ allowAnonymous = false, allowSystem = true, allowUser = true } = DefaultAuthMiddlewareConfig) {
+  /**
+   * Middleware for handling JWT authentication.
+   * @param config Configuration for middleware behavior.
+   */
+  AuthMiddleware(config = DefaultAuthMiddlewareConfig) {
+    const { allowAnonymous, allowSystem, allowUser } = { ...DefaultAuthMiddlewareConfig, ...config };
     return async (req, res, next) => {
       try {
-        const [authType, token] = req.get("Authorization")?.split(" ");
-        if (!token) {
-          throw new Error(ErrorTypes_default.INVALID_TOKEN);
-        }
+        const [authType, token] = req.get("Authorization")?.split(" ") || [];
+        if (!token) throw new Error(ErrorTypes_default.INVALID_TOKEN);
         let payload;
         switch (authType) {
           case "Anon":
-            if (!allowAnonymous) {
-              throw response_default.generateError(403, ErrorTypes_default.ANONYMOUS_SESSION_NOT_ALLOWED);
-            }
+            if (!allowAnonymous) throw response_default.generateError(403, ErrorTypes_default.ANONYMOUS_SESSION_NOT_ALLOWED);
             payload = await this.verifyAnonymousToken(token);
             break;
           case "User":
-            if (!allowUser) {
-              throw response_default.generateError(403, ErrorTypes_default.USER_SESSION_NOT_ALLOWED);
-            }
+            if (!allowUser) throw response_default.generateError(403, ErrorTypes_default.USER_SESSION_NOT_ALLOWED);
             payload = await this.verifyUserToken(token);
             break;
           case "System":
-            if (!allowSystem) {
-              throw response_default.generateError(403, ErrorTypes_default.SYSTEM_SESSION_NOT_ALLOWED);
-            }
+            if (!allowSystem) throw response_default.generateError(403, ErrorTypes_default.SYSTEM_SESSION_NOT_ALLOWED);
             payload = await this.verifySystemToken(token);
-            Logger_default.logMessage("AuthMiddleware", "System Name - " + payload.id);
+            Logger_default.logMessage("AuthMiddleware", `System Name - ${payload.id}`);
             break;
           case "Admin":
             payload = await this.verifyAdminToken(token);
-            Logger_default.logMessage("AuthMiddleware", "Admin Id - " + payload.id);
+            Logger_default.logMessage("AuthMiddleware", `Admin Id - ${payload.id}`);
             break;
           default:
             throw response_default.generateError(403, ErrorTypes_default.INVALID_AUTH_TYPE);
         }
-        res.locals.auth = {
-          authType,
-          token,
-          ...payload
-        };
+        res.locals.auth = { authType, token, ...payload };
         next();
       } catch (error) {
         Logger_default.logError("AuthMiddleware", import_util2.default.inspect(error));
-        response_default.handleException("AuthMiddleware", response_default.generateError(401, error.error ? error.error : ErrorTypes_default.TOKEN_EXPIRED, true), res);
+        response_default.handleException(
+          "AuthMiddleware",
+          response_default.generateError(401, error.error || ErrorTypes_default.TOKEN_EXPIRED, true),
+          res
+        );
       }
     };
   }

package/dist/index.mjs

@@ -668,40 +668,49 @@ var AuthUtility = class {
   systemPublicKeys;
   adminPrivateKeys;
   adminPublicKeys;
-  constructor({ maxTokenAge = "30 days", userPrivateKeys = "[]", userPublicKeys = "[]", anonymousPrivateKeys = "[]", anonymousPublicKeys = "[]", systemPrivateKeys = "[]", systemPublicKeys = "[]", adminPrivateKeys = "[]", adminPublicKeys = "[]" } = DefaultAuthUtilityConfig) {
+  /**
+   * Initializes the AuthUtility class with a configuration.
+   * @param config The configuration for the utility (optional).
+   */
+  constructor(config = DefaultAuthUtilityConfig) {
+    const {
+      maxTokenAge,
+      userPrivateKeys,
+      userPublicKeys,
+      anonymousPrivateKeys,
+      anonymousPublicKeys,
+      systemPrivateKeys,
+      systemPublicKeys,
+      adminPrivateKeys,
+      adminPublicKeys
+    } = { ...DefaultAuthUtilityConfig, ...config };
     this.maxTokenAge = maxTokenAge;
     this.userPrivateKeys = JSON.parse(userPrivateKeys);
-    if (this.userPrivateKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 1 user private key provided. The last key will be used for signing.");
-    }
     this.userPublicKeys = JSON.parse(userPublicKeys);
-    if (this.userPublicKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 3 user public keys provided. This is not recommended.");
-    }
     this.anonymousPrivateKeys = JSON.parse(anonymousPrivateKeys);
-    if (this.anonymousPrivateKeys.length > 1) {
-      Logger_default.logWarning("AuthUtility", "More than 1 anonymous private key provided. The last key will be used for signing.");
-    }
     this.anonymousPublicKeys = JSON.parse(anonymousPublicKeys);
-    if (this.anonymousPublicKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 3 anonymous public keys provided. This is not recommended.");
-    }
     this.systemPrivateKeys = JSON.parse(systemPrivateKeys);
-    if (this.systemPrivateKeys.length > 1) {
-      Logger_default.logWarning("AuthUtility", "More than 1 system private key provided. The last key will be used for signing.");
-    }
     this.systemPublicKeys = JSON.parse(systemPublicKeys);
-    if (this.systemPublicKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 3 system public keys provided. This is not recommended.");
-    }
     this.adminPrivateKeys = JSON.parse(adminPrivateKeys);
-    if (this.adminPrivateKeys.length > 1) {
-      Logger_default.logWarning("AuthUtility", "More than 1 admin private key provided. The last key will be used for signing.");
-    }
     this.adminPublicKeys = JSON.parse(adminPublicKeys);
-    if (this.adminPublicKeys.length > 3) {
-      Logger_default.logWarning("AuthUtility", "More than 3 admin public keys provided. This is not recommended.");
-    }
+    this.logWarnings();
+  }
+  /**
+   * Logs warnings if the number of keys exceeds recommended limits.
+   */
+  logWarnings() {
+    const warn = (type, keys, limit) => keys.length > limit && Logger_default.logWarning(
+      "AuthUtility",
+      `More than ${limit} ${type} keys provided. This is not recommended.`
+    );
+    warn("user private", this.userPrivateKeys, 3);
+    warn("user public", this.userPublicKeys, 3);
+    warn("anonymous private", this.anonymousPrivateKeys, 1);
+    warn("anonymous public", this.anonymousPublicKeys, 3);
+    warn("system private", this.systemPrivateKeys, 1);
+    warn("system public", this.systemPublicKeys, 3);
+    warn("admin private", this.adminPrivateKeys, 1);
+    warn("admin public", this.adminPublicKeys, 3);
   }
   async createSignedJWT(payload, privateKeyString, expiration) {
     const privateKey = await importPKCS8(privateKeyString, "RS256");
@@ -785,50 +794,47 @@ var AuthUtility = class {
     assert(payload.type === "Admin", ErrorTypes_default.INVALID_AUTH_TYPE);
     return payload;
   }
-  AuthMiddleware({ allowAnonymous = false, allowSystem = true, allowUser = true } = DefaultAuthMiddlewareConfig) {
+  /**
+   * Middleware for handling JWT authentication.
+   * @param config Configuration for middleware behavior.
+   */
+  AuthMiddleware(config = DefaultAuthMiddlewareConfig) {
+    const { allowAnonymous, allowSystem, allowUser } = { ...DefaultAuthMiddlewareConfig, ...config };
     return async (req, res, next) => {
       try {
-        const [authType, token] = req.get("Authorization")?.split(" ");
-        if (!token) {
-          throw new Error(ErrorTypes_default.INVALID_TOKEN);
-        }
+        const [authType, token] = req.get("Authorization")?.split(" ") || [];
+        if (!token) throw new Error(ErrorTypes_default.INVALID_TOKEN);
         let payload;
         switch (authType) {
           case "Anon":
-            if (!allowAnonymous) {
-              throw response_default.generateError(403, ErrorTypes_default.ANONYMOUS_SESSION_NOT_ALLOWED);
-            }
+            if (!allowAnonymous) throw response_default.generateError(403, ErrorTypes_default.ANONYMOUS_SESSION_NOT_ALLOWED);
             payload = await this.verifyAnonymousToken(token);
             break;
           case "User":
-            if (!allowUser) {
-              throw response_default.generateError(403, ErrorTypes_default.USER_SESSION_NOT_ALLOWED);
-            }
+            if (!allowUser) throw response_default.generateError(403, ErrorTypes_default.USER_SESSION_NOT_ALLOWED);
             payload = await this.verifyUserToken(token);
             break;
           case "System":
-            if (!allowSystem) {
-              throw response_default.generateError(403, ErrorTypes_default.SYSTEM_SESSION_NOT_ALLOWED);
-            }
+            if (!allowSystem) throw response_default.generateError(403, ErrorTypes_default.SYSTEM_SESSION_NOT_ALLOWED);
             payload = await this.verifySystemToken(token);
-            Logger_default.logMessage("AuthMiddleware", "System Name - " + payload.id);
+            Logger_default.logMessage("AuthMiddleware", `System Name - ${payload.id}`);
             break;
           case "Admin":
             payload = await this.verifyAdminToken(token);
-            Logger_default.logMessage("AuthMiddleware", "Admin Id - " + payload.id);
+            Logger_default.logMessage("AuthMiddleware", `Admin Id - ${payload.id}`);
             break;
           default:
             throw response_default.generateError(403, ErrorTypes_default.INVALID_AUTH_TYPE);
         }
-        res.locals.auth = {
-          authType,
-          token,
-          ...payload
-        };
+        res.locals.auth = { authType, token, ...payload };
         next();
       } catch (error) {
         Logger_default.logError("AuthMiddleware", util2.inspect(error));
-        response_default.handleException("AuthMiddleware", response_default.generateError(401, error.error ? error.error : ErrorTypes_default.TOKEN_EXPIRED, true), res);
+        response_default.handleException(
+          "AuthMiddleware",
+          response_default.generateError(401, error.error || ErrorTypes_default.TOKEN_EXPIRED, true),
+          res
+        );
       }
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "b23-lib",
-  "version": "1.2.9",
+  "version": "1.2.11",
   "description": "This repo hold common classes, type and util functiona",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",