b23-lib 1.4.0 → 1.5.0

package/dist/index.d.mts

@@ -281,19 +281,84 @@ declare class AuthUtility {
     private logWarnings;
     private createSignedJWT;
     private verifySignedJWT;
+    /**
+     * Creates an anonymous token with the given ID and additional data.
+     *
+     * @param id - The unique identifier for the token. Must be a valid UUID.
+     * @param additionalData - Optional additional data to include in the token payload.
+     * @returns A promise that resolves to the signed JWT as a string.
+     * @throws Will throw an error if no anonymous private keys are found or if the ID is not a valid UUID.
+     */
     createAnonymousToken(id: string, additionalData?: object): Promise<string>;
+    /**
+     * Verifies an anonymous token by checking its signature and payload type.
+     *
+     * @param token - The JWT token to be verified.
+     * @returns The payload of the verified token.
+     * @throws Will throw an error if no anonymous public keys are found or if the token type is invalid.
+     */
     verifyAnonymousToken(token: string): Promise<jose.JWTPayload>;
+    /**
+     * Creates a signed JWT token for a user.
+     *
+     * @param id - The UUID of the user.
+     * @param additionalData - Optional additional data to include in the token payload.
+     * @returns A promise that resolves to the signed JWT token as a string.
+     * @throws Will throw an error if no user private keys are found or if the provided id is not a valid UUID.
+     */
     createUserToken(id: string, additionalData?: object): Promise<string>;
+    /**
+     * Verifies the provided user token by checking its signature and payload.
+     *
+     * @param token - The JWT token to be verified.
+     * @returns The payload of the verified token if valid.
+     * @throws Will throw an error if no user public keys are found or if the token type is invalid.
+     */
     verifyUserToken(token: string): Promise<jose.JWTPayload>;
+    /**
+     * Creates a signed JWT (JSON Web Token) for a system with the given ID and optional additional data.
+     *
+     * @param id - The unique identifier for the system.
+     * @param additionalData - Optional additional data to include in the token payload.
+     * @returns A promise that resolves to the signed JWT as a string.
+     * @throws Will throw an error if no system private keys are found.
+     */
     createSystemToken(id: string, additionalData?: object): Promise<string>;
+    /**
+     * Verifies a system token by checking its signature and payload type.
+     *
+     * @param token - The JWT token to be verified.
+     * @returns The payload of the verified token.
+     * @throws Will throw an error if no system public keys are found or if the token type is not 'System'.
+     */
     verifySystemToken(token: string): Promise<jose.JWTPayload>;
+    /**
+     * Creates a signed JWT token for an admin user.
+     *
+     * @param id - The UUID of the admin user.
+     * @param additionalData - Optional additional data to include in the token payload.
+     * @returns A promise that resolves to the signed JWT token string.
+     * @throws Will throw an error if no admin private keys are found or if the provided id is not a valid UUID.
+     */
     createAdminToken(id: string, additionalData?: object): Promise<string>;
+    /**
+     * Verifies the provided admin token by checking its signature and payload.
+     * Ensures that the token is signed with one of the known admin public keys
+     * and that the payload type is 'Admin'.
+     *
+     * @param token - The JWT token to be verified.
+     * @returns The payload of the verified token.
+     * @throws Will throw an error if no admin public keys are found or if the token is invalid.
+     */
     verifyAdminToken(token: string): Promise<jose.JWTPayload>;
     /**
-     * Middleware for handling JWT authentication.
-     * @param config Configuration for middleware behavior.
+     * Middleware function to handle authentication based on different token types.
+     * It verifies the token and sets the authentication details in the response locals.
+     *
+     * @param {Partial<AuthMiddlewareConfig>} [config=DefaultAuthMiddlewareConfig] - Configuration object to customize the middleware behavior.
+     * @returns {Function} Middleware function to handle authentication.
      */
-    AuthMiddleware(config?: Partial<AuthMiddlewareConfig>): (req: any, res: any, next: any) => Promise<void>;
+    AuthMiddleware(config?: Partial<AuthMiddlewareConfig>): Function;
 }
 
 declare const Utils: {
@@ -331,14 +396,26 @@ type SuccessType = {
     statusText: string;
     data: any;
 };
+/**
+ * Makes an HTTP request to the specified endpoint using the provided parameters.
+ *
+ * @param {string} baseURL - The base URL of the API.
+ * @param {string} endpoint - The specific endpoint to call.
+ * @param {'GET' | 'POST' | 'PATCH' | 'DELETE'} [method='GET'] - The HTTP method to use for the request.
+ * @param {Record<string, string>} [headers={}] - Additional headers to include in the request.
+ * @param {any} [payload] - The payload to send with the request, if applicable.
+ * @returns {Promise<SuccessType>} - A promise that resolves to the response data if the request is successful.
+ * @throws {ErrorType} - Throws an error if the request fails.
+ */
 declare const Fetch: (baseURL: string, endpoint: string, method?: "GET" | "POST" | "PATCH" | "DELETE", headers?: Record<string, string>, payload?: any) => Promise<SuccessType>;
 
 declare const Logger: {
     logException: (functionName: string, error: any) => void;
-    logError: (functionName: string, errorMessage: string) => void;
+    logError: (functionName: string, error: any) => void;
     logWarning: (functionName: string, message: any) => void;
     logMessage: (functionName: string, message: any) => void;
     logInvalidPayload: (functionName: string, errorMessage: string) => void;
+    inspect: (context: any) => string;
 };
 
 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

@@ -281,19 +281,84 @@ declare class AuthUtility {
     private logWarnings;
     private createSignedJWT;
     private verifySignedJWT;
+    /**
+     * Creates an anonymous token with the given ID and additional data.
+     *
+     * @param id - The unique identifier for the token. Must be a valid UUID.
+     * @param additionalData - Optional additional data to include in the token payload.
+     * @returns A promise that resolves to the signed JWT as a string.
+     * @throws Will throw an error if no anonymous private keys are found or if the ID is not a valid UUID.
+     */
     createAnonymousToken(id: string, additionalData?: object): Promise<string>;
+    /**
+     * Verifies an anonymous token by checking its signature and payload type.
+     *
+     * @param token - The JWT token to be verified.
+     * @returns The payload of the verified token.
+     * @throws Will throw an error if no anonymous public keys are found or if the token type is invalid.
+     */
     verifyAnonymousToken(token: string): Promise<jose.JWTPayload>;
+    /**
+     * Creates a signed JWT token for a user.
+     *
+     * @param id - The UUID of the user.
+     * @param additionalData - Optional additional data to include in the token payload.
+     * @returns A promise that resolves to the signed JWT token as a string.
+     * @throws Will throw an error if no user private keys are found or if the provided id is not a valid UUID.
+     */
     createUserToken(id: string, additionalData?: object): Promise<string>;
+    /**
+     * Verifies the provided user token by checking its signature and payload.
+     *
+     * @param token - The JWT token to be verified.
+     * @returns The payload of the verified token if valid.
+     * @throws Will throw an error if no user public keys are found or if the token type is invalid.
+     */
     verifyUserToken(token: string): Promise<jose.JWTPayload>;
+    /**
+     * Creates a signed JWT (JSON Web Token) for a system with the given ID and optional additional data.
+     *
+     * @param id - The unique identifier for the system.
+     * @param additionalData - Optional additional data to include in the token payload.
+     * @returns A promise that resolves to the signed JWT as a string.
+     * @throws Will throw an error if no system private keys are found.
+     */
     createSystemToken(id: string, additionalData?: object): Promise<string>;
+    /**
+     * Verifies a system token by checking its signature and payload type.
+     *
+     * @param token - The JWT token to be verified.
+     * @returns The payload of the verified token.
+     * @throws Will throw an error if no system public keys are found or if the token type is not 'System'.
+     */
     verifySystemToken(token: string): Promise<jose.JWTPayload>;
+    /**
+     * Creates a signed JWT token for an admin user.
+     *
+     * @param id - The UUID of the admin user.
+     * @param additionalData - Optional additional data to include in the token payload.
+     * @returns A promise that resolves to the signed JWT token string.
+     * @throws Will throw an error if no admin private keys are found or if the provided id is not a valid UUID.
+     */
     createAdminToken(id: string, additionalData?: object): Promise<string>;
+    /**
+     * Verifies the provided admin token by checking its signature and payload.
+     * Ensures that the token is signed with one of the known admin public keys
+     * and that the payload type is 'Admin'.
+     *
+     * @param token - The JWT token to be verified.
+     * @returns The payload of the verified token.
+     * @throws Will throw an error if no admin public keys are found or if the token is invalid.
+     */
     verifyAdminToken(token: string): Promise<jose.JWTPayload>;
     /**
-     * Middleware for handling JWT authentication.
-     * @param config Configuration for middleware behavior.
+     * Middleware function to handle authentication based on different token types.
+     * It verifies the token and sets the authentication details in the response locals.
+     *
+     * @param {Partial<AuthMiddlewareConfig>} [config=DefaultAuthMiddlewareConfig] - Configuration object to customize the middleware behavior.
+     * @returns {Function} Middleware function to handle authentication.
      */
-    AuthMiddleware(config?: Partial<AuthMiddlewareConfig>): (req: any, res: any, next: any) => Promise<void>;
+    AuthMiddleware(config?: Partial<AuthMiddlewareConfig>): Function;
 }
 
 declare const Utils: {
@@ -331,14 +396,26 @@ type SuccessType = {
     statusText: string;
     data: any;
 };
+/**
+ * Makes an HTTP request to the specified endpoint using the provided parameters.
+ *
+ * @param {string} baseURL - The base URL of the API.
+ * @param {string} endpoint - The specific endpoint to call.
+ * @param {'GET' | 'POST' | 'PATCH' | 'DELETE'} [method='GET'] - The HTTP method to use for the request.
+ * @param {Record<string, string>} [headers={}] - Additional headers to include in the request.
+ * @param {any} [payload] - The payload to send with the request, if applicable.
+ * @returns {Promise<SuccessType>} - A promise that resolves to the response data if the request is successful.
+ * @throws {ErrorType} - Throws an error if the request fails.
+ */
 declare const Fetch: (baseURL: string, endpoint: string, method?: "GET" | "POST" | "PATCH" | "DELETE", headers?: Record<string, string>, payload?: any) => Promise<SuccessType>;
 
 declare const Logger: {
     logException: (functionName: string, error: any) => void;
-    logError: (functionName: string, errorMessage: string) => void;
+    logError: (functionName: string, error: any) => void;
     logWarning: (functionName: string, message: any) => void;
     logMessage: (functionName: string, message: any) => void;
     logInvalidPayload: (functionName: string, errorMessage: string) => void;
+    inspect: (context: any) => string;
 };
 
 export { type AuthMiddlewareConfig, type AuthTokenType, AuthUtility, type AuthUtilityConfig, DefaultAuthMiddlewareConfig, DefaultAuthUtilityConfig, DynamoDBUtility as DynamoDB, type ErrorType, Fetch, Logger, ResponseUtility, Schema, type SuccessType, Utils };