@creator.co/wapi 1.2.5 → 1.2.6

package/dist/src/Validation/Validator.d.ts

@@ -1,21 +1,17 @@
 import { z } from 'zod';
 import Response, { ResponseErrorType } from '../API/Response';
 /**
- * Description placeholder
- *
- * @export
- * @class Validator
- * @typedef {Validator}
+ * Validates the given data against the provided schema.
+ * @param {any} data - The data to be validated.
+ * @param {z.ZodObject<any>} schema - The schema to validate against.
+ * @returns {boolean | Response<ResponseErrorType>} - Returns true if the data is valid, otherwise returns a response object with an error message.
  */
 export default class Validator {
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @param {*} data
-     * @param {z.ZodObject<any>} schema
-     * @returns {(boolean | Response<ResponseErrorType>)}
+     * Validates the given data against the provided schema.
+     * @param {any} data - The data to be validated.
+     * @param {z.ZodObject<any> | z.ZodUnion<any>} schema - The schema to validate against.
+     * @returns {boolean | Response<ResponseErrorType>} - Returns either true if the data is valid or a Response object with an error message if validation fails.
      */
-    static validateSchema(data: any, schema: z.ZodObject<any>): boolean | Response<ResponseErrorType>;
+    static validateSchema(data: any, schema: z.ZodObject<any> | z.ZodUnion<any>): boolean | Response<ResponseErrorType>;
 }

package/dist/src/Validation/Validator.js

@@ -4,23 +4,19 @@ var zod_1 = require("zod");
 var Response_1 = require("../API/Response");
 var Globals_1 = require("../Globals");
 /**
- * Description placeholder
- *
- * @export
- * @class Validator
- * @typedef {Validator}
+ * Validates the given data against the provided schema.
+ * @param {any} data - The data to be validated.
+ * @param {z.ZodObject<any>} schema - The schema to validate against.
+ * @returns {boolean | Response<ResponseErrorType>} - Returns true if the data is valid, otherwise returns a response object with an error message.
  */
 var Validator = /** @class */ (function () {
     function Validator() {
     }
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @param {*} data
-     * @param {z.ZodObject<any>} schema
-     * @returns {(boolean | Response<ResponseErrorType>)}
+     * Validates the given data against the provided schema.
+     * @param {any} data - The data to be validated.
+     * @param {z.ZodObject<any> | z.ZodUnion<any>} schema - The schema to validate against.
+     * @returns {boolean | Response<ResponseErrorType>} - Returns either true if the data is valid or a Response object with an error message if validation fails.
      */
     Validator.validateSchema = function (data, schema) {
         var error, validatedInput;

package/dist/src/Validation/Validator.js.map

@@ -1 +1 @@
-{"version":3,"file":"Validator.js","sourceRoot":"","sources":["../../../src/Validation/Validator.ts"],"names":[],"mappings":";;AAAA,2BAAuB;AAEvB,4CAA6D;AAC7D,sCAAgC;AAEhC;;;;;;GAMG;AACH;IAAA;IAiCA,CAAC;IAhCC;;;;;;;;OAQG;IACW,wBAAc,GAA5B,UACE,IAAS,EACT,MAAwB;QAExB,IAAI,KAAK,EAAE,cAAc,CAAA;QACzB,yCAAyC;QACzC,IAAI;YACF,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAkB,CAAA;SACrD;QAAC,OAAO,GAAqB,EAAE;YAC9B,IAAI,GAAG,YAAY,OAAC,CAAC,QAAQ;gBAAE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;;gBACzD,KAAK,GAAG,2BAA2B,CAAA,CAAC,8BAA8B;SACxE;QACD,mBAAmB;QACnB,IAAI,CAAC,cAAc,IAAI,KAAK,EAAE;YAC5B,OAAO,kBAAQ,CAAC,kBAAkB,CAChC,iBAAO,CAAC,2BAA2B,EACnC,iBAAO,CAAC,sBAAsB,EAC9B,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAC7B,CAAA;SACF;aAAM;YACL,OAAO,IAAI,CAAA;SACZ;IACH,CAAC;IACH,gBAAC;AAAD,CAAC,AAjCD,IAiCC"}
+{"version":3,"file":"Validator.js","sourceRoot":"","sources":["../../../src/Validation/Validator.ts"],"names":[],"mappings":";;AAAA,2BAAuB;AAEvB,4CAA6D;AAC7D,sCAAgC;AAEhC;;;;;GAKG;AACH;IAAA;IAgCA,CAAC;IA/BC;;;;;OAKG;IACW,wBAAc,GAA5B,UACE,IAAS,EACT,MAA0C;QAE1C,IAAI,KAAK,EAAE,cAAc,CAAA;QAEzB,yCAAyC;QACzC,IAAI;YACF,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAkB,CAAA;SACrD;QAAC,OAAO,GAAqB,EAAE;YAC9B,IAAI,GAAG,YAAY,OAAC,CAAC,QAAQ;gBAAE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;;gBACzD,KAAK,GAAG,2BAA2B,CAAA,CAAC,8BAA8B;SACxE;QAED,mBAAmB;QACnB,IAAI,CAAC,cAAc,IAAI,KAAK,EAAE;YAC5B,OAAO,kBAAQ,CAAC,kBAAkB,CAChC,iBAAO,CAAC,2BAA2B,EACnC,iBAAO,CAAC,sBAAsB,EAC9B,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAC7B,CAAA;SACF;aAAM;YACL,OAAO,IAAI,CAAA;SACZ;IACH,CAAC;IACH,gBAAC;AAAD,CAAC,AAhCD,IAgCC"}

package/index.ts

@@ -9,6 +9,21 @@ import JWT from './src/Crypto/JWT'
 import Mailer from './src/Mailer/Mailer'
 import Router, { Route } from './src/Server/Router'
 
+/**
+ * Exported modules:
+ * - Transaction: A module for handling transactions.
+ * - Process: A module for managing processes.
+ * - EventProcessor: A module for processing events.
+ * - Router: A module for routing requests.
+ * - Mailer: A module for sending emails.
+ * - Crypto: A module for cryptographic operations.
+ * - JWT: A module for handling JSON Web Tokens.
+ * - Configuration: A module for managing configuration settings.
+ * - Response: A module for constructing HTTP responses.
+ * - Utils: A module containing utility functions.
+ * - Route: A module for defining routes.
+ * - ResponseErrorType: An enumeration of possible response error types.
+ */
 export {
   // Base Events
   Transaction,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creator.co/wapi",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -37,19 +37,24 @@
     "node-cache": "^5.1.2",
     "object-hash": "^3.0.0",
     "parse-duration": "^1.1.0",
+    "path-to-regexp": "^6.2.1",
     "pg": "^8.11.3",
     "sha1": "^1.1.1",
     "stack-trace": "0.0.10",
     "zod": "^3.22.4"
   },
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@types/aws-lambda": "^8.10.119",
     "@types/chai": "^4.3.9",
+    "@types/cors": "^2.8.15",
     "@types/express": "^4.17.19",
     "@types/jest": "^29.5.6",
     "@types/jsonwebtoken": "^9.0.3",
     "@types/node": "^20.5.7",
+    "@types/path-to-regexp": "^1.7.0",
     "@types/pg": "^8.10.5",
+    "@types/supertest": "^2.0.15",
     "@typescript-eslint/eslint-plugin": "^6.5.0",
     "@typescript-eslint/parser": "^6.5.0",
     "aws-lambda": "^1.0.7",

package/src/API/Request.ts

@@ -2,36 +2,28 @@ import type { Context, APIGatewayEvent } from 'aws-lambda'
 
 import Utils from './Utils'
 import Logger from '../Logger/Logger'
+
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Request
- * @typedef {Request}
- * @template InputType
+ * Represents a request object with utility methods for accessing request information.
+ * @template InputType - The type of the request body.
  */
 export default class Request<InputType> {
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
+   * Represents an API Gateway event for a request.
    * @type {APIGatewayEvent}
    */
   private requestEvent: APIGatewayEvent
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @type {Context}
+   * The context object for the current instance.
    */
   private context: Context
+
   /**
-   * Creates an instance of Request.
-   *
-   * @constructor
-   * @param {APIGatewayEvent} requestEvent
-   * @param {Context} context
-   * @param {Logger} logger
+   * Constructs a new instance of the class.
+   * @param {APIGatewayEvent} requestEvent - The API Gateway event object.
+   * @param {Context} context - The context object.
+   * @param {Logger} logger - The logger object.
+   * @returns None
    */
   constructor(requestEvent: APIGatewayEvent, context: Context, logger: Logger) {
     this.requestEvent = requestEvent
@@ -39,74 +31,66 @@ export default class Request<InputType> {
     logger.debug('Request info:', JSON.stringify(requestEvent))
     logger.debug('Request context:', JSON.stringify(context))
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @param {string} paramName
-   * @returns {boolean}
+   * Checks if the given query parameter exists and has a valid value.
+   * @param {string} paramName - The name of the query parameter to check.
+   * @returns {boolean} - True if the query parameter exists and has a valid value, false otherwise.
    */
   public containsQueryParam(paramName: string): boolean {
     const val = this.getQueryParam(paramName)
     return !!val && (Utils.isValidString(val) || Utils.isValidNumber(val))
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @param {string} paramName
-   * @returns {(string | null)}
+   * Retrieves the value of a query parameter from the request event's query string parameters.
+   * @param {string} paramName - The name of the query parameter to retrieve.
+   * @returns {string | null} The value of the query parameter, or null if it does not exist.
    */
   public getQueryParam(paramName: string): string | null {
     return Utils.caseInsensitiveObjectForKey(this.requestEvent.queryStringParameters, paramName)
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @param {string} headerName
-   * @returns {(string | null)}
+   * Retrieves the value of the specified header from the request event headers.
+   * @param {string} headerName - The name of the header to retrieve.
+   * @returns {string | null} - The value of the header, or null if the header is not found.
    */
   public getHeader(headerName: string): string | null {
     return Utils.caseInsensitiveObjectForKey(this.requestEvent.headers, headerName)
   }
-  //context params
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @param {string} cxtParam
-   * @returns {(any | null)}
+   * Retrieves the value of a context parameter from the request context object.
+   * @param {string} cxtParam - The name of the context parameter to retrieve.
+   * @returns The value of the context parameter, or null if it does not exist.
    */
   public getContextParam(cxtParam: string): any | null {
     return Utils.caseInsensitiveObjectForKey(this.requestEvent.requestContext, cxtParam)
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @param {string} paramName
-   * @returns {boolean}
+   * Checks if the given parameter name exists in the path parameters and if its value is a valid string or number.
+   * @param {string} paramName - The name of the parameter to check.
+   * @returns {boolean} - True if the parameter exists and its value is a valid string or number, false otherwise.
    */
   public containsPathParam(paramName: string): boolean {
     const val = this.getPathParam(paramName)
     return !!val && (Utils.isValidString(val) || Utils.isValidNumber(val))
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @param {string} paramName
-   * @returns {(string | null)}
+   * Retrieves the value of a path parameter from the request event.
+   * @param {string} paramName - The name of the path parameter to retrieve.
+   * @returns {string | null} The value of the path parameter, or null if it does not exist.
    */
   public getPathParam(paramName: string): string | null {
     return Utils.caseInsensitiveObjectForKey(this.requestEvent.pathParameters, paramName)
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @returns {InputType}
+   * Retrieves the body of the request event and parses it if it is a string.
+   * @returns {InputType} The parsed body of the request event.
    */
   public getBody(): InputType {
     let b: any = null
@@ -118,72 +102,70 @@ export default class Request<InputType> {
     }
     return b
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @returns {string}
+   * Retrieves the path from the request event.
+   * @returns {string} The path of the request event.
    */
   public getPath(): string {
     return this.requestEvent.path
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @returns {string}
+   * Retrieves the HTTP method of the current request.
+   * @returns {string} The HTTP method of the request.
    */
   public getMethod(): string {
     return this.requestEvent.httpMethod
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @returns {(object | null)}
+   * Retrieves the path parameters from the request event.
+   * @returns {object | null} - The path parameters object, or null if not found.
    */
   public getPathParams(): object | null {
     return this.requestEvent.pathParameters
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @returns {(string | null)}
+   * Retrieves the value of the 'Authorization' header from the request.
+   * @returns The value of the 'Authorization' header, or null if it is not present.
    */
   public getAuthorizationHeader(): string | null {
     return this.getHeader('Authorization')
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @returns {string}
+   * Retrieves the request ID associated with the current execution context.
+   * @returns {string} The request ID.
    */
   public getRequestID(): string {
     if (this.context.awsRequestId) return this.context.awsRequestId
     return this.requestEvent.requestContext ? this.requestEvent.requestContext.requestId : 'unknown'
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @returns {string}
+   * Retrieves the origin IP address of the request.
+   * @returns {string} The origin IP address. If the IP address is not available, it returns 'unknown'.
    */
   public getOriginIP(): string {
     const origin = this.getContextParam('identity')?.sourceIp
     const hOrigin = this.getHeader('X-Forwarded-For')
     return origin ? origin : hOrigin ? hOrigin : 'unknown'
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @param {any[]} keys
-   * @param {any[]} result
+   * Sets the fixed path parameters in the request event object.
+   * @param {any[]} keys - An array of keys representing the path parameter names.
+   * @param {any[]} result - An array of values representing the path parameter values.
+   * @returns None
    */
   public setFixedPathParams(keys: any[], result: any[]): void {
     this.requestEvent.pathParameters = {}
-    keys.forEach((key, index) => (this.requestEvent.pathParameters[key.name] = result[index + 1]))
+    keys.forEach((key, index) => {
+      if (this.requestEvent?.pathParameters) {
+        this.requestEvent.pathParameters[key.name] = result[index + 1]
+      }
+    })
   }
 }