@creator.co/wapi 1.2.1-beta6 → 1.2.3

package/.eslintrc.cjs

@@ -1,42 +1,49 @@
 /* eslint-env node */
 module.exports = {
   extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended",
-    "plugin:import/recommended",
-    "plugin:import/typescript",
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
   ],
-  parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint", "prettier"],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'prettier'],
   root: true,
   rules: {
-    "prettier/prettier": [
-      "error",
+    'prettier/prettier': [
+      'error',
       {
         semi: false,
+        printWidth: 100,
+        tabWidth: 2,
+        useTabs: false,
+        bracketSameLine: true,
+        arrowParens: 'avoid',
+        singleQuote: true,
+        trailingComma: 'es5',
       },
     ],
-    "@typescript-eslint/ban-ts-comment": 0,
-    "@typescript-eslint/no-explicit-any": 0,
+    '@typescript-eslint/ban-ts-comment': 0,
+    '@typescript-eslint/no-explicit-any': 0,
     // turn on errors for missing imports
-    "import/no-unresolved": "error",
+    'import/no-unresolved': 'error',
     // 'import/no-named-as-default-member': 'off',
-    "import/order": [
-      "error",
+    'import/order': [
+      'error',
       {
         groups: [
-          "builtin", // Built-in imports (come from NodeJS native) go first
-          "external", // <- External imports
-          "internal", // <- Absolute imports
-          ["sibling", "parent"], // <- Relative imports, the sibling and parent types they can be mingled together
-          "index", // <- index imports
-          "unknown", // <- unknown
+          'builtin', // Built-in imports (come from NodeJS native) go first
+          'external', // <- External imports
+          'internal', // <- Absolute imports
+          ['sibling', 'parent'], // <- Relative imports, the sibling and parent types they can be mingled together
+          'index', // <- index imports
+          'unknown', // <- unknown
         ],
-        "newlines-between": "always",
+        'newlines-between': 'always',
         alphabetize: {
           /* sort in ascending order. Options: ["ignore", "asc", "desc"] */
-          order: "asc",
+          order: 'asc',
           /* ignore case. Options: [true, false] */
           caseInsensitive: true,
         },

package/.github/workflows/npmpublish.yml

@@ -1,22 +1,14 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
-name: Node.js Package
-
+name: NPM Publish
 on:
-  release:
-    types: [created]
+  push: 
+    branches: [ "main" ]
 
 jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish --access='public'
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+  Publish:
+    uses: Creator-co/tool-github-workflows/.github/workflows/npmpublish.yml@main
+    secrets: inherit
+    with:
+      disablieSASTFailure: false
+      disableLintFailure: false
+      disableUTestFailure: false
+      NODE_VERSION: "16.x"

package/.github/workflows/prs.yml

@@ -0,0 +1,13 @@
+name: PR Checks
+on:
+  pull_request:
+    branches:
+      - master
+      - main
+
+jobs:
+  Checks:
+    uses: Creator-co/tool-github-workflows/.github/workflows/prs-check.yml@main
+    secrets: inherit
+    with:
+      NODE_VERSION: "16.x"

package/index.ts

@@ -1,13 +1,13 @@
-import Response from "./src/API/Response"
-import Utils from "./src/API/Utils"
-import EventProcessor from "./src/BaseEvent/EventProcessor"
-import Process from "./src/BaseEvent/Process"
-import Transaction from "./src/BaseEvent/Transaction"
-import Configuration from "./src/Config/Configuration"
-import Crypto from "./src/Crypto/Crypto"
-import JWT from "./src/Crypto/JWT"
-import Mailer from "./src/Mailer/Mailer"
-import Router, { Route } from "./src/Server/Router"
+import Response, { ResponseErrorType } from './src/API/Response'
+import Utils from './src/API/Utils'
+import EventProcessor from './src/BaseEvent/EventProcessor'
+import Process from './src/BaseEvent/Process'
+import Transaction from './src/BaseEvent/Transaction'
+import Configuration from './src/Config/Configuration'
+import Crypto from './src/Crypto/Crypto'
+import JWT from './src/Crypto/JWT'
+import Mailer from './src/Mailer/Mailer'
+import Router, { Route } from './src/Server/Router'
 
 export {
   // Base Events
@@ -25,4 +25,6 @@ export {
   // Helpers
   Utils,
   Route,
+  // Misc types
+  ResponseErrorType,
 }

package/jest.config.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creator.co/wapi",
-  "version": "1.2.1-beta6",
+  "version": "1.2.3",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,7 +8,10 @@
   "scripts": {
     "build": "npm run lint && tsc --build",
     "clean": "tsc --build --clean",
-    "lint": "eslint . --ext .ts --fix"
+    "lint-fix": "eslint . --ext .ts --fix",
+    "lint": "eslint . --ext .ts",
+    "test": "jest --coverage --silent --runInBand",
+    "test-dev": "jest --coverage --runInBand"
   },
   "author": "",
   "license": "ISC",
@@ -33,21 +36,29 @@
     "parse-duration": "^1.1.0",
     "sha1": "^1.1.1",
     "stack-trace": "0.0.10",
-    "unflatten": "^1.0.4",
     "zod": "^3.22.4"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.119",
     "@types/express": "^4.17.19",
+    "@types/jest": "^29.5.6",
     "@types/jsonwebtoken": "^9.0.3",
     "@types/node": "^20.5.7",
     "@typescript-eslint/eslint-plugin": "^6.5.0",
     "@typescript-eslint/parser": "^6.5.0",
     "aws-lambda": "^1.0.7",
+    "aws-sdk-client-mock": "^3.0.0",
+    "chai": "^4.3.10",
     "eslint": "^8.48.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-prettier": "^5.0.0",
-    "prettier": "^3.0.3"
+    "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
+    "prettier": "^3.0.3",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
   }
 }

package/src/API/Request.ts

@@ -1,97 +1,189 @@
-import type { Context, APIGatewayEvent } from "aws-lambda"
+import type { Context, APIGatewayEvent } from 'aws-lambda'
 
-import Utils from "./Utils"
-import Logger from "../Logger/Logger"
-//
+import Utils from './Utils'
+import Logger from '../Logger/Logger'
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @class Request
+ * @typedef {Request}
+ * @template InputType
+ */
 export default class Request<InputType> {
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @type {APIGatewayEvent}
+   */
   private requestEvent: APIGatewayEvent
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @type {Context}
+   */
   private context: Context
+  /**
+   * Creates an instance of Request.
+   *
+   * @constructor
+   * @param {APIGatewayEvent} requestEvent
+   * @param {Context} context
+   * @param {Logger} logger
+   */
   constructor(requestEvent: APIGatewayEvent, context: Context, logger: Logger) {
     this.requestEvent = requestEvent
     this.context = context
-    logger.debug("Request info:", JSON.stringify(requestEvent))
-    logger.debug("Request context:", JSON.stringify(context))
+    logger.debug('Request info:', JSON.stringify(requestEvent))
+    logger.debug('Request context:', JSON.stringify(context))
   }
-  //query
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @param {string} paramName
+   * @returns {boolean}
+   */
   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)}
+   */
   public getQueryParam(paramName: string): string | null {
-    return Utils.caseInsensitiveObjectForKey(
-      this.requestEvent.queryStringParameters,
-      paramName,
-    )
+    return Utils.caseInsensitiveObjectForKey(this.requestEvent.queryStringParameters, paramName)
   }
-  //header
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @param {string} headerName
+   * @returns {(string | null)}
+   */
   public getHeader(headerName: string): string | null {
-    return Utils.caseInsensitiveObjectForKey(
-      this.requestEvent.headers,
-      headerName,
-    )
+    return Utils.caseInsensitiveObjectForKey(this.requestEvent.headers, headerName)
   }
   //context params
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @param {string} cxtParam
+   * @returns {(any | null)}
+   */
   public getContextParam(cxtParam: string): any | null {
-    return Utils.caseInsensitiveObjectForKey(
-      this.requestEvent.requestContext,
-      cxtParam,
-    )
+    return Utils.caseInsensitiveObjectForKey(this.requestEvent.requestContext, cxtParam)
   }
-  //path param
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @param {string} paramName
+   * @returns {boolean}
+   */
   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)}
+   */
   public getPathParam(paramName: string): string | null {
-    return Utils.caseInsensitiveObjectForKey(
-      this.requestEvent.pathParameters,
-      paramName,
-    )
+    return Utils.caseInsensitiveObjectForKey(this.requestEvent.pathParameters, paramName)
   }
-  //body
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @returns {InputType}
+   */
   public getBody(): InputType {
     let b: any = null
     try {
       b = this.requestEvent.body
-      if (typeof b === "string" || b instanceof String)
-        b = JSON.parse(b as string)
+      if (typeof b === 'string' || b instanceof String) b = JSON.parse(b as string)
     } catch (e) {
-      console.error("Error while getting request body!", e)
+      console.error('Error while getting request body!', e)
     }
     return b
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @returns {string}
+   */
   public getPath(): string {
     return this.requestEvent.path
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @returns {string}
+   */
   public getMethod(): string {
     return this.requestEvent.httpMethod
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @returns {(object | null)}
+   */
   public getPathParams(): object | null {
     return this.requestEvent.pathParameters
   }
-
-  //Shortcuts
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @returns {(string | null)}
+   */
   public getAuthorizationHeader(): string | null {
-    return this.getHeader("Authorization")
+    return this.getHeader('Authorization')
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @returns {string}
+   */
   public getRequestID(): string {
     if (this.context.awsRequestId) return this.context.awsRequestId
-    return this.requestEvent.requestContext
-      ? this.requestEvent.requestContext.requestId
-      : "unknown"
+    return this.requestEvent.requestContext ? this.requestEvent.requestContext.requestId : 'unknown'
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @returns {string}
+   */
   public getOriginIP(): string {
-    const origin = this.getContextParam("identity")?.sourceIp
-    const hOrigin = this.getHeader("X-Forwarded-For")
-    return origin ? origin : hOrigin ? hOrigin : "unknow"
+    const origin = this.getContextParam('identity')?.sourceIp
+    const hOrigin = this.getHeader('X-Forwarded-For')
+    return origin ? origin : hOrigin ? hOrigin : 'unknown'
   }
-
-  //ugly fix
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @param {any[]} keys
+   * @param {any[]} result
+   */
   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) => (this.requestEvent.pathParameters[key.name] = result[index + 1]))
   }
 }