@ikonintegration/ikapi 4.0.0-alpha8 → 5.0.0-alpha1

package/jest.config.ts

@@ -0,0 +1,37 @@
+import type { Config } from '@jest/types'
+/* eslint-env node */
+const config: Config.InitialOptions = {
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ['smoke-tests'],
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: 'coverage',
+        outputName: 'jest-junit.xml',
+        ancestorSeparator: ' › ',
+        uniqueOutputName: 'false',
+        suiteNameTemplate: '{filepath}',
+        classNameTemplate: '{classname}',
+        titleTemplate: '{title}',
+      },
+    ],
+  ],
+  coverageReporters: ['clover', 'json', 'lcov', ['text', { file: 'coverage.txt' }], 'json-summary'],
+  collectCoverageFrom: ['src/**/*.(t|j)s', '!src/**/*.d.(t|j)s'],
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80,
+    },
+  },
+  // .js imports support
+  moduleNameMapper: {
+    '^(\\.\\.?\\/.+)\\.jsx?$': '$1',
+  },
+}
+export default config

package/jest.smoke.config.ts

@@ -0,0 +1,34 @@
+import type { Config } from '@jest/types'
+/* eslint-env node */
+const config: Config.InitialOptions = {
+  testEnvironment: 'node',
+  // ECMA suppport https://jestjs.io/docs/ecmascript-modules
+  transform: {},
+  //
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: 'coverage',
+        outputName: 'jest-junit.xml',
+        ancestorSeparator: ' › ',
+        uniqueOutputName: 'false',
+        suiteNameTemplate: '{filepath}',
+        classNameTemplate: '{classname}',
+        titleTemplate: '{title}',
+      },
+    ],
+  ],
+  coverageReporters: ['clover', 'json', 'lcov', ['text', { file: 'coverage.txt' }], 'json-summary'],
+  collectCoverageFrom: ['src/**/*.(t|j)s', '!src/**/*.d.(t|j)s'],
+  coverageThreshold: {
+    global: {
+      branches: 70,
+      functions: 70,
+      lines: 70,
+      statements: 70,
+    },
+  },
+}
+export default config

package/package.json

@@ -1,37 +1,81 @@
 {
   "name": "@ikonintegration/ikapi",
-  "version": "4.0.0-alpha8",
+  "version": "5.0.0-alpha1",
   "description": "",
-  "main": "index.js",
-  "module": "main.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "pre-publish": "npm i -production && curl -sf https://gobinaries.com/tj/node-prune | sh && node-prune"
+    "build": "tsc --build",
+    "clean": "tsc --build --clean",
+    "lint-fix": "eslint . --fix",
+    "lint": "eslint .",
+    "docs": "npx typedoc --tsconfig tsconfig.json index.ts src/**/* --includeVersion --entryPointStrategy expand",
+    "test": "npm run test-ts && npm run test-js",
+    "test-ts": "jest --coverage --silent --runInBand --logHeapUsage && cat coverage/coverage.txt",
+    "test-js": "rm -rf ./smoke-tests; tsc -p tsconfig.smoke.json && cd smoke-tests && npm i && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --config=./jest.smoke.config.js --coverage --silent --runInBand --logHeapUsage && cat coverage/coverage.txt",
+    "test-dev": "jest --coverage --runInBand && cat coverage/coverage.txt"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.363.0",
-    "@aws-sdk/client-ses": "^3.363.0",
-    "@aws-sdk/client-sns": "^3.363.0",
-    "@aws-sdk/credential-provider-node": "^3.363.0",
-    "@aws-sdk/node-http-handler": "^3.360.0",
-    "@aws-sdk/util-dynamodb": "^3.365.0",
-    "@aws-sdk/util-endpoints": "^3.357.0",
-    "@ikonintegration/mod-resources-tracker-client": "0.0.19",
+    "@aws-sdk/client-dynamodb": "^3.574.0",
+    "@aws-sdk/client-kms": "^3.556.0",
+    "@aws-sdk/client-secrets-manager": "^3.576.0",
+    "@aws-sdk/client-ses": "^3.576.0",
+    "@aws-sdk/client-sns": "^3.576.0",
+    "@aws-sdk/client-ssm": "^3.576.0",
+    "@aws-sdk/credential-provider-node": "^3.576.0",
+    "@aws-sdk/util-dynamodb": "^3.619.0",
+    "@smithy/node-http-handler": "^3.0.0",
+    "@types/email-templates": "^10.0.1",
+    "@types/nodemailer": "^6.4.10",
+    "@types/object-hash": "^3.0.4",
     "abind": "^1.0.5",
-    "bluebird": "^3.7.2",
-    "email-templates": "^11.0.5",
-    "is-email": "^1.0.2",
-    "is-uuid": "^1.0.2",
+    "cors": "^2.8.5",
+    "cuid": "^3.0.0",
+    "dotenv": "^16.4.1",
+    "email-templates": "^12.0.1",
+    "express": "^4.18.2",
     "json-stringify-safe": "^5.0.1",
-    "ksuid": "^3.0.0",
-    "nodemailer": "^6.9.3",
-    "path-to-regexp": "^6.2.0",
-    "pg": "^8.11.1",
+    "kysely": "^0.27.2",
+    "node-cache": "^5.1.2",
+    "object-hash": "^3.0.0",
+    "parse-duration": "^1.1.0",
+    "path-to-regexp": "^7.1.0",
+    "pg": "^8.11.3",
+    "redis": "^4.6.13",
     "sha1": "^1.1.1",
     "stack-trace": "0.0.10",
-    "superstruct": "0.8.4"
+    "zod": "^3.23.4"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@types/aws-lambda": "^8.10.137",
+    "@types/chai": "^4.3.9",
+    "@types/cors": "^2.8.15",
+    "@types/express": "^4.17.19",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.7",
+    "@types/path-to-regexp": "^1.7.0",
+    "@types/pg": "^8.11.5",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "aws-lambda": "^1.0.7",
+    "aws-sdk-client-mock": "^4.0.0",
+    "chai": "^4.4.1",
+    "eslint": "^8.48.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-require-extensions": "^0.1.3",
+    "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
+    "prettier": "^3.2.5",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.4.5"
   }
 }

package/src/API/Request.ts

@@ -0,0 +1,214 @@
+import type { Context, APIGatewayEvent } from 'aws-lambda'
+
+import Logger from '../Logger/Logger.js'
+import Utils from '../Util/Utils.js'
+
+/**
+ * Represents a request object with generic types for input, query parameters, and path parameters.
+ * @class Request
+ * @template InputType - The type of the input data for the request.
+ * @template PathParamsType - The type of the path parameters for the request.
+ * @template QueryParamsType - The type of the query parameters for the request.
+ */
+export default class Request<InputType, PathParamsType, QueryParamsType> {
+  /**
+   * Represents an API Gateway event for a request.
+   * @type {APIGatewayEvent}
+   */
+  private requestEvent: APIGatewayEvent
+  /**
+   * The context object for the current instance.
+   */
+  private context: Context
+
+  /**
+   * 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
+    this.context = context
+    logger.debug('Request info:', requestEvent)
+    logger.debug('Request context:', context)
+  }
+
+  /**
+   * Checks if the specified query parameter exists and has a valid value.
+   * @param {keyof QueryParamsType} 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: keyof QueryParamsType): boolean {
+    const val = this.getQueryParam(paramName)
+    return !!val && (Utils.isValidString(val) || Utils.isValidNumber(val))
+  }
+
+  /**
+   * Retrieves the value of a query parameter from the URL.
+   * @param {keyof QueryParamsType} 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: keyof QueryParamsType): string {
+    return Utils.caseInsensitiveObjectForKey(
+      this.requestEvent.queryStringParameters,
+      String(paramName)
+    )
+  }
+
+  /**
+   * 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)
+  }
+
+  /**
+   * 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)
+  }
+
+  /**
+   * Checks if the given parameter name exists in the PathParamsType object.
+   * @param {keyof PathParamsType} paramName - The name of the parameter to check.
+   * @returns {boolean} - True if the parameter exists, false otherwise.
+   */
+  public containsPathParam(paramName: keyof PathParamsType): boolean {
+    const val = this.getPathParam(paramName)
+    return !!val && (Utils.isValidString(val) || Utils.isValidNumber(val))
+  }
+
+  /**
+   * Retrieves the value of a specific path parameter from the URL.
+   * @param {keyof PathParamsType} paramName - The name of the path parameter to retrieve.
+   * @returns {string} The value of the path parameter, or null if it does not exist.
+   */
+  public getPathParam(paramName: keyof PathParamsType): string {
+    return Utils.caseInsensitiveObjectForKey(this.requestEvent.pathParameters, String(paramName))
+  }
+
+  /**
+   * 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(raw?: boolean): InputType {
+    const body: any = this.requestEvent.body
+
+    if (raw) return Utils.isHybridlessContainer() ? this.requestEvent['rawBody'] : body
+
+    if (typeof body === 'string' || body instanceof String) {
+      try {
+        return JSON.parse(body as string)
+      } catch (e) {
+        console.error('Error while getting request body!', e)
+      }
+    }
+
+    return body
+  }
+
+  /**
+   * Retrieves the path from the request event.
+   * @returns {string} The path of the request event.
+   */
+  public getPath(): string {
+    return this.requestEvent.path
+  }
+
+  /**
+   * Retrieves the HTTP method of the current request.
+   * @returns {string} The HTTP method of the request.
+   */
+  public getMethod(): HttpMethod {
+    if (this.requestEvent.httpMethod) {
+      const httpMethod = this.requestEvent.httpMethod.toUpperCase()
+      if (httpMethod in HttpMethod) {
+        return HttpMethod[httpMethod]
+      }
+    }
+
+    throw new Error(`Invalid HTTP method: ${this.requestEvent.httpMethod}`)
+  }
+
+  /**
+   * Retrieves the path parameters from the request event.
+   * @returns {PathParamsType | null} - The path parameters object, or null if not found.
+   */
+  public getPathParams(): PathParamsType {
+    // type conversion guaranteed by validation
+    return this.requestEvent.pathParameters as PathParamsType
+  }
+
+  /**
+   * Retrieves the query parameters from the request event.
+   * @returns {QueryParamsType | null} - The query parameters object, or null if not found.
+   */
+  public getQueryParams(): QueryParamsType {
+    // type conversion guaranteed by validation
+    return this.requestEvent.queryStringParameters as QueryParamsType
+  }
+
+  /**
+   * 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')
+  }
+
+  /**
+   * 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'
+  }
+
+  /**
+   * 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'
+  }
+
+  /**
+   * 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 {
+    if (!this.requestEvent.pathParameters) this.requestEvent.pathParameters = {}
+    keys.forEach((key, index) => {
+      if (this.requestEvent?.pathParameters) {
+        this.requestEvent.pathParameters[key.name] = result[index + 1]
+      }
+    })
+  }
+}
+
+/**
+ * Enum representing the HTTP methods.
+ */
+export enum HttpMethod {
+  GET = 'GET',
+  HEAD = 'HEAD',
+  POST = 'POST',
+  PUT = 'PUT',
+  DELETE = 'DELETE',
+  CONNECT = 'CONNECT',
+  OPTIONS = 'OPTIONS',
+  TRACE = 'TRACE',
+  PATCH = 'PATCH',
+}