@h4ad/serverless-adapter 2.3.1 → 2.5.0

package/lib/serverless-adapter.js

@@ -7,7 +7,8 @@ const core_1 = require("./core");
 /**
  * The class used to build the serverless handler.
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const app = express();
  * export const handler = ServerlessAdapter.new(app)
  *   .setFramework(new ExpressFramework())
@@ -19,6 +20,9 @@ const core_1 = require("./core");
  *   .addAdapter(new SNSAdapter())
  *   .build();
  * ```
+ *
+ * @breadcrumb ServerlessAdapter
+ * @public
  */
 class ServerlessAdapter {
     //#region Constructor
@@ -31,7 +35,7 @@ class ServerlessAdapter {
         /**
          * Settings for whether the response should be treated as binary or not
          *
-         * @default `contentEncodings` and `contentTypes` are set with {@link DEFAULT_BINARY_ENCODINGS} and {@link DEFAULT_BINARY_CONTENT_TYPES}, respectively.
+         * @defaultValue `contentEncodings` and `contentTypes` are set with {@link DEFAULT_BINARY_ENCODINGS} and {@link DEFAULT_BINARY_CONTENT_TYPES}, respectively.
          */
         this.binarySettings = {
             contentEncodings: core_1.DEFAULT_BINARY_ENCODINGS,
@@ -40,8 +44,8 @@ class ServerlessAdapter {
         /**
          * Indicates whether the error stack should be included in the response or not
          *
-         * @note These errors will only be included when an error occurs while forwarding the event to the framework
-         * @default True when NODE_ENV is equal to `development`
+         * @remarks These errors will only be included when an error occurs while forwarding the event to the framework
+         * @defaultValue True when NODE_ENV is equal to `development`
          */
         this.respondWithErrors = process.env.NODE_ENV === 'development';
         /**
@@ -59,7 +63,7 @@ class ServerlessAdapter {
     /**
      * Creates a new instance of the builder with app (express, hapi, koa, etc...)
      *
-     * @param app The instance of the app
+     * @param app - The instance of the app
      */
     static new(app) {
         return new ServerlessAdapter(app);
@@ -69,7 +73,7 @@ class ServerlessAdapter {
     /**
      * Defines the handler that will get the event, context and callback and pass it to the adapter and framework
      *
-     * @param handler The implementation of the handler contract
+     * @param handler - The implementation of the handler contract
      */
     setHandler(handler) {
         if (this.handler)
@@ -80,7 +84,7 @@ class ServerlessAdapter {
     /**
      * Defines the resolver that aims to resolve the response to serverless and stop its execution when the request ends
      *
-     * @param resolver The implementation of the resolver contract
+     * @param resolver - The implementation of the resolver contract
      */
     setResolver(resolver) {
         if (this.resolver)
@@ -91,7 +95,7 @@ class ServerlessAdapter {
     /**
      * Defines the framework that will process requests
      *
-     * @param framework The implementation of the framework contract
+     * @param framework - The implementation of the framework contract
      */
     setFramework(framework) {
         if (this.framework) {
@@ -103,7 +107,7 @@ class ServerlessAdapter {
     /**
      * Defines the logger service used during the execution of the handler
      *
-     * @param logger The implementation of the logger
+     * @param logger - The implementation of the logger
      */
     setLogger(logger) {
         this.log = logger;
@@ -112,7 +116,7 @@ class ServerlessAdapter {
     /**
      * Defines the binary settings for whether the response should be treated as binary or not
      *
-     * @param binarySettings The binary settings
+     * @param binarySettings - The binary settings
      */
     setBinarySettings(binarySettings) {
         this.binarySettings = binarySettings;
@@ -121,7 +125,7 @@ class ServerlessAdapter {
     /**
      * Defines the responseWithErrors, a property that indicates whether the error stack should be included in the response or not
      *
-     * @param respondWithErrors Should include or not the errors in response
+     * @param respondWithErrors - Should include or not the errors in response
      */
     setRespondWithErrors(respondWithErrors) {
         this.respondWithErrors = respondWithErrors;
@@ -130,7 +134,7 @@ class ServerlessAdapter {
     /**
      * Add an adapter to the adapters list to handle the event coming from any serverless event source
      *
-     * @param adapter The implementation of the adapter contract
+     * @param adapter - The implementation of the adapter contract
      */
     addAdapter(adapter) {
         this.adapters.push(adapter);
@@ -156,3 +160,4 @@ class ServerlessAdapter {
     }
 }
 exports.ServerlessAdapter = ServerlessAdapter;
+//# sourceMappingURL=serverless-adapter.js.map

package/lib/serverless-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serverless-adapter.js","sourceRoot":"","sources":["../src/serverless-adapter.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAUjB,iCAKgB;AAEhB,YAAY;AAEZ;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,iBAAiB;IAQ5B,qBAAqB;IAErB;;OAEG;IACH,YAAoB,GAAS;QAa7B,YAAY;QAEZ,8BAA8B;QAE9B;;;;WAIG;QACO,mBAAc,GAAmB;YACzC,gBAAgB,EAAE,+BAAwB;YAC1C,YAAY,EAAE,mCAA4B;SAC3C,CAAC;QAEF;;;;;WAKG;QACO,sBAAiB,GAAY,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,CAAC;QAE9E;;WAEG;QACO,QAAG,GAAY,IAAA,0BAAmB,GAAE,CAAC;QAE/C;;WAEG;QACO,aAAQ,GAAmD,EAAE,CAAC;QA1CtE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAuED,YAAY;IAEZ,wBAAwB;IAExB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAQf,GAAS;QAET,OAAO,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,YAAY;IAEZ,yBAAyB;IAEzB;;;;OAIG;IACI,UAAU,CACf,OAOC;QAED,IAAI,IAAI,CAAC,OAAO;YACd,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAE3E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,WAAW,CAChB,QAA2E;QAE3E,IAAI,IAAI,CAAC,QAAQ;YACf,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAE5E,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,YAAY,CACjB,SAAkC;QAElC,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;SACH;QAED,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,MAAe;QAC9B,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC;QAElB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CACtB,cAA8B;QAE9B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QAErC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CACzB,iBAA0B;QAE1B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAE3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,UAAU,CACf,OAAqD;QAErD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;SACH;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;SACH;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;SACH;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,GAAG,CACT,CAAC;IACJ,CAAC;CAGF;AApQD,8CAoQC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@h4ad/serverless-adapter",
-  "version": "2.3.1",
-  "description": "This library enables you to utilize any Cloud or Event Source to respond to web and API requests using your existing Node.js application framework.",
+  "version": "2.5.0",
+  "description": "Run REST APIs and other web applications using your existing Node.js application framework (NestJS, Express, Koa, Hapi, Fastify and many others), on top of AWS, Azure, Huawei and many other clouds.",
   "main": "./lib/index.js",
   "files": [
     "lib/**/*"
@@ -10,11 +10,16 @@
     "install:peers": "npx npm-install-peers",
     "prepare": "husky install",
     "build": "tsc -p tsconfig.build.json",
+    "build:docs": "tsc -p tsconfig.doc.json",
     "clean": "rm -rf ./lib/",
     "cm": "cz",
     "coverage": "codecov",
     "lint": "eslint ./src/ ./test/  --fix",
     "semantic-release": "semantic-release",
+    "docs:generate": "npm run docs:generate:parsing && npm run docs:generate:markdown && npm run docs:generate:api-pages",
+    "docs:generate:parsing": "npm run build:docs && ts-node scripts/parse-docs.ts",
+    "docs:generate:markdown": "ts-node scripts/generate-markdown.ts",
+    "docs:generate:api-pages": "ts-node scripts/generate-api-pages.ts",
     "test:watch": "jest --watch",
     "test": "jest --coverage",
     "typecheck": "tsc --noEmit"
@@ -48,13 +53,22 @@
     "node.js",
     "http",
     "huawei",
-    "functiongraph"
+    "functiongraph",
+    "trpc",
+    "azure",
+    "azure-functions",
+    "http-trigger-v4"
   ],
   "bugs": {
     "url": "https://github.com/H4ad/serverless-adapter/issues"
   },
   "homepage": "https://github.com/H4ad/serverless-adapter#readme",
   "devDependencies": {
+    "@microsoft/api-documenter": "7.17.16",
+    "@microsoft/api-extractor": "7.24.2",
+    "@microsoft/api-extractor-model": "7.17.3",
+    "@microsoft/tsdoc": "0.14.1",
+    "@rushstack/node-core-library": "^3.45.2",
     "@types/aws-lambda": "^8.10.92",
     "@types/body-parser": "^1.19.2",
     "@types/jest": "^27.4.0",
@@ -72,19 +86,24 @@
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-tsdoc": "^0.2.14",
     "husky": "^6.0.0",
     "jest": "^27.5.1",
     "lint-staged": "^10.5.4",
     "prettier": "^2.5.1",
-    "semantic-release": "^19.0.2",
+    "semantic-release": "^19.0.3",
     "stream-mock": "^2.0.5",
     "supertest": "^6.2.3",
     "ts-jest": "^27.1.3",
     "ts-node": "^10.4.0",
+    "typedoc": "^0.22.13",
     "typescript": "^4.5.5"
   },
   "peerDependencies": {
+    "@azure/functions": ">= 2.0.0",
     "@hapi/hapi": ">= 20.0.0",
+    "@trpc/server": ">= 9.0.0",
+    "@types/aws-lambda": ">= 8.10.92",
     "@types/express": ">= 4.15.4",
     "@types/hapi": ">= 18.0.7",
     "@types/koa": ">= 2.11.2",
@@ -94,9 +113,18 @@
     "koa": ">= 2.5.1"
   },
   "peerDependenciesMeta": {
+    "@azure/functions": {
+      "optional": true
+    },
     "@hapi/hapi": {
       "optional": true
     },
+    "@trpc/server": {
+      "optional": true
+    },
+    "@types/aws-lambda": {
+      "optional": true
+    },
     "express": {
       "optional": true
     },

package/lib/@types/proxy-params.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="node" />
-import { RequestListener } from 'http';
-import { BinarySettings } from './binary-settings';
-export interface ProxyParams {
-    app: RequestListener;
-    binaryMimeTypes?: string[];
-    binarySettings?: BinarySettings;
-}

package/lib/@types/proxy-params.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });