@h4ad/serverless-adapter 2.3.1 → 2.5.0

package/lib/adapters/huawei/huawei-api-gateway.adapter.d.ts

@@ -1,59 +1,66 @@
-import { HuaweiApiGatewayEvent, HuaweiContext } from '../../@types/huawei';
-import { HuaweiApiGatewayResponse } from '../../@types/huawei/huawei-api-gateway-response';
+import { HuaweiApiGatewayEvent, HuaweiApiGatewayResponse, HuaweiContext } from '../../@types/huawei';
 import { AdapterContract, AdapterRequest, GetResponseAdapterProps, OnErrorProps } from '../../contracts';
 /**
  * The options to customize the {@link HuaweiApiGatewayAdapter}
+ *
+ * @breadcrumb Adapters / Huawei / HuaweiApiGatewayAdapter
+ * @public
  */
 export interface HuaweiApiGatewayOptions {
     /**
      * Strip base path for custom domains
      *
-     * @default ''
+     * @defaultValue ''
      */
     stripBasePath?: string;
 }
 /**
  * The adapter to handle requests from Huawei Api Gateway
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const stripBasePath = '/any/custom/base/path'; // default ''
  * const adapter = new ApiGatewayAdapter({ stripBasePath });
  * ```
  *
- * {@link https://support.huaweicloud.com/intl/en-us/devg-functiongraph/functiongraph_02_0102.html#functiongraph_02_0102__li5178638110137 Event Reference}
+ * @breadcrumb Adapters / Huawei / HuaweiApiGatewayAdapter
+ * @public
+ *
+ * {@link https://support.huaweicloud.com/intl/en-us/devg-functiongraph/functiongraph_02_0102.html#functiongraph_02_0102__li5178638110137 | Event Reference}
  */
 export declare class HuaweiApiGatewayAdapter implements AdapterContract<HuaweiApiGatewayEvent, HuaweiContext, HuaweiApiGatewayResponse> {
     protected readonly options?: HuaweiApiGatewayOptions | undefined;
     /**
      * Default constructor
      *
-     * @param options The options to customize the {@link HuaweiApiGatewayAdapter}
+     * @param options - The options to customize the {@link HuaweiApiGatewayAdapter}
      */
     constructor(options?: HuaweiApiGatewayOptions | undefined);
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getAdapterName(): string;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     canHandle(event: unknown): event is HuaweiApiGatewayEvent;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getRequest(event: HuaweiApiGatewayEvent): AdapterRequest;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getResponse({ headers: responseHeaders, body, isBase64Encoded, statusCode, }: GetResponseAdapterProps<HuaweiApiGatewayEvent>): HuaweiApiGatewayResponse;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     onErrorWhileForwarding({ error, delegatedResolver, respondWithErrors, event, log, }: OnErrorProps<HuaweiApiGatewayEvent, HuaweiApiGatewayResponse>): void;
     /**
      * Get path from event with query strings
      *
-     * @param event The event sent by serverless
+     * @param event - The event sent by serverless
      */
     protected getPathFromEvent(event: HuaweiApiGatewayEvent): string;
 }
+//# sourceMappingURL=huawei-api-gateway.adapter.d.ts.map

package/lib/adapters/huawei/huawei-api-gateway.adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"huawei-api-gateway.adapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/huawei/huawei-api-gateway.adapter.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,aAAa,EACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,eAAe,EACf,cAAc,EACd,uBAAuB,EACvB,YAAY,EACb,MAAM,iBAAiB,CAAC;AAWzB;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,uBACX,YACE,eAAe,CACb,qBAAqB,EACrB,aAAa,EACb,wBAAwB,CACzB;IASS,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC;IALvC;;;;OAIG;gBAC4B,OAAO,CAAC,qCAAyB;IAMhE;;OAEG;IACI,cAAc,IAAI,MAAM;IAI/B;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,qBAAqB;IAehE;;OAEG;IACI,UAAU,CAAC,KAAK,EAAE,qBAAqB,GAAG,cAAc;IA6B/D;;OAEG;IACI,WAAW,CAAC,EACjB,OAAO,EAAE,eAAe,EACxB,IAAI,EACJ,eAAe,EACf,UAAU,GACX,EAAE,uBAAuB,CAAC,qBAAqB,CAAC,GAAG,wBAAwB;IAW5E;;OAEG;IACI,sBAAsB,CAAC,EAC5B,KAAK,EACL,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,EACL,GAAG,GACJ,EAAE,YAAY,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,GAAG,IAAI;IAkBvE;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,MAAM;CAcjE"}

package/lib/adapters/huawei/huawei-api-gateway.adapter.js

@@ -6,19 +6,23 @@ const core_1 = require("../../core");
 /**
  * The adapter to handle requests from Huawei Api Gateway
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const stripBasePath = '/any/custom/base/path'; // default ''
  * const adapter = new ApiGatewayAdapter({ stripBasePath });
  * ```
  *
- * {@link https://support.huaweicloud.com/intl/en-us/devg-functiongraph/functiongraph_02_0102.html#functiongraph_02_0102__li5178638110137 Event Reference}
+ * @breadcrumb Adapters / Huawei / HuaweiApiGatewayAdapter
+ * @public
+ *
+ * {@link https://support.huaweicloud.com/intl/en-us/devg-functiongraph/functiongraph_02_0102.html#functiongraph_02_0102__li5178638110137 | Event Reference}
  */
 class HuaweiApiGatewayAdapter {
     //#region Constructor
     /**
      * Default constructor
      *
-     * @param options The options to customize the {@link HuaweiApiGatewayAdapter}
+     * @param options - The options to customize the {@link HuaweiApiGatewayAdapter}
      */
     constructor(options) {
         this.options = options;
@@ -26,13 +30,13 @@ class HuaweiApiGatewayAdapter {
     //#endregion
     //#region Public Methods
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getAdapterName() {
         return HuaweiApiGatewayAdapter.name;
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     canHandle(event) {
         const apiGatewayEvent = event;
@@ -46,7 +50,7 @@ class HuaweiApiGatewayAdapter {
             !('multiValueQueryStringParameters' in apiGatewayEvent));
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getRequest(event) {
         const method = event.httpMethod;
@@ -68,7 +72,7 @@ class HuaweiApiGatewayAdapter {
         };
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getResponse({ headers: responseHeaders, body, isBase64Encoded, statusCode, }) {
         const headers = (0, core_1.getMultiValueHeadersMap)(responseHeaders);
@@ -80,7 +84,7 @@ class HuaweiApiGatewayAdapter {
         };
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     onErrorWhileForwarding({ error, delegatedResolver, respondWithErrors, event, log, }) {
         const body = respondWithErrors ? error.stack : '';
@@ -99,7 +103,7 @@ class HuaweiApiGatewayAdapter {
     /**
      * Get path from event with query strings
      *
-     * @param event The event sent by serverless
+     * @param event - The event sent by serverless
      */
     getPathFromEvent(event) {
         var _a;
@@ -111,3 +115,4 @@ class HuaweiApiGatewayAdapter {
     }
 }
 exports.HuaweiApiGatewayAdapter = HuaweiApiGatewayAdapter;
+//# sourceMappingURL=huawei-api-gateway.adapter.js.map

package/lib/adapters/huawei/huawei-api-gateway.adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"huawei-api-gateway.adapter.js","sourceRoot":"","sources":["../../../src/adapters/huawei/huawei-api-gateway.adapter.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAajB,qCAMoB;AAmBpB;;;;;;;;;;;;;GAaG;AACH,MAAa,uBAAuB;IAQlC,qBAAqB;IAErB;;;;OAIG;IACH,YAA+B,OAAiC;QAAjC,YAAO,GAAP,OAAO,CAA0B;IAAG,CAAC;IAEpE,YAAY;IAEZ,wBAAwB;IAExB;;OAEG;IACI,cAAc;QACnB,OAAO,uBAAuB,CAAC,IAAI,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAc;QAC7B,MAAM,eAAe,GAAG,KAAuC,CAAC;QAEhE,OAAO,CAAC,CAAC,CACP,eAAe;YACf,eAAe,CAAC,UAAU;YAC1B,eAAe,CAAC,cAAc;YAC9B,eAAe,CAAC,cAAc,CAAC,KAAK;YACpC,eAAe,CAAC,cAAc,CAAC,KAAK;YACpC,eAAe,CAAC,cAAc,CAAC,SAAS;YACxC,+CAA+C;YAC/C,CAAC,CAAC,iCAAiC,IAAI,eAAe,CAAC,CACxD,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,KAA4B;QAC5C,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC;QAChC,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE1C,MAAM,OAAO,GAAG,IAAA,6BAAsB,EAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAEjE,IAAI,IAAwB,CAAC;QAE7B,IAAI,KAAK,CAAC,IAAI,EAAE;YACd,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,IAAA,2BAAoB,EACtD,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,eAAe,CACtB,CAAC;YAEF,IAAI,GAAG,UAAU,CAAC;YAClB,OAAO,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;SACnD;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;QAE3C,OAAO;YACL,MAAM;YACN,OAAO;YACP,IAAI;YACJ,aAAa;YACb,IAAI;SACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,EACjB,OAAO,EAAE,eAAe,EACxB,IAAI,EACJ,eAAe,EACf,UAAU,GACqC;QAC/C,MAAM,OAAO,GAAG,IAAA,8BAAuB,EAAC,eAAe,CAAC,CAAC;QAEzD,OAAO;YACL,UAAU;YACV,IAAI;YACJ,OAAO;YACP,eAAe;SAChB,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,EAC5B,KAAK,EACL,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,EACL,GAAG,GAC2D;QAC9D,MAAM,IAAI,GAAG,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;YACrC,KAAK;YACL,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,IAAI,EAAE;YAChB,OAAO,EAAE,EAAE;YACX,eAAe,EAAE,KAAK;YACtB,GAAG;SACJ,CAAC,CAAC;QAEH,iBAAiB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,YAAY;IAEZ,2BAA2B;IAE3B;;;;OAIG;IACO,gBAAgB,CAAC,KAA4B;;QACrD,MAAM,aAAa,GAAG,IAAA,4BAAqB,EACzC,MAAA,IAAI,CAAC,OAAO,0CAAE,aAAa,EAC3B,EAAE,CACH,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAElD,MAAM,WAAW,GAAG,KAAK,CAAC,qBAAqB,CAAC;QAEhD,OAAO,IAAA,mCAA4B,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;CAGF;AA/ID,0DA+IC"}

package/lib/adapters/huawei/index.d.ts

@@ -1 +1,2 @@
 export * from './huawei-api-gateway.adapter';
+//# sourceMappingURL=index.d.ts.map

package/lib/adapters/huawei/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/adapters/huawei/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}

package/lib/adapters/huawei/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -11,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./huawei-api-gateway.adapter"), exports);
+//# sourceMappingURL=index.js.map

package/lib/adapters/huawei/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/huawei/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+DAA6C"}

package/lib/contracts/adapter.contract.d.ts

@@ -3,25 +3,11 @@ import { BothValueHeaders, SingleValueHeaders } from '../@types';
 import { ILogger } from '../core';
 import { ServerlessResponse } from '../network';
 import { DelegatedResolver } from './resolver.contract';
-/**
- * The props of the method that verify if this handler should handle the event.
- */
-export interface CanHandleProps<TEvent, TContext> {
-    /**
-     * The event sent by the serverless
-     */
-    event: TEvent | unknown;
-    /**
-     * The context sent by the serverless
-     */
-    context: TContext | unknown;
-    /**
-     * The instance of the logger.
-     */
-    log: ILogger;
-}
 /**
  * The request interface used to bridge any event source to the framework.
+ *
+ * @breadcrumb Contracts / AdapterContract
+ * @public
  */
 export interface AdapterRequest {
     /**
@@ -39,22 +25,29 @@ export interface AdapterRequest {
     /**
      * The body as buffer to use to create the request to the framework
      */
-    body: Buffer | undefined;
+    body?: Buffer;
     /**
      * The remote address (client ip) to use to create the request to the framework
      */
     remoteAddress?: string;
     /**
-     * The address of the event source (used in Lambda@edge)
+     * The address of the event source (used in Lambda\@edge)
+     *
+     * @deprecated It is no longer used in the library and will be removed in the next major release.
      */
     host?: string;
     /**
-     * The address of the event source (used in Lambda@edge)
+     * The address of the event source (used in Lambda\@edge)
+     *
+     * @deprecated It is no longer used in the library and will be removed in the next major release.
      */
     hostname?: string;
 }
 /**
  * The props of the method that get the response from the framework and transform it into a format that the event source can handle
+ *
+ * @breadcrumb Contracts / AdapterContract
+ * @public
  */
 export interface GetResponseAdapterProps<TEvent> {
     /**
@@ -62,9 +55,9 @@ export interface GetResponseAdapterProps<TEvent> {
      */
     event: TEvent;
     /**
-     * The framework {@link ServerlessResponse response}.
+     * The framework {@link ServerlessResponse | response}.
      *
-     * @note It can be optional, as this method can be used when an error occurs during the handling of the request by the framework.
+     * @remarks It can be optional, as this method can be used when an error occurs during the handling of the request by the framework.
      */
     response?: ServerlessResponse;
     /**
@@ -90,6 +83,9 @@ export interface GetResponseAdapterProps<TEvent> {
 }
 /**
  * The props of the method that handle the response when an error occurs while forwarding the request to the framework
+ *
+ * @breadcrumb Contracts / AdapterContract
+ * @public
  */
 export interface OnErrorProps<TEvent, TResponse> {
     /**
@@ -115,6 +111,9 @@ export interface OnErrorProps<TEvent, TResponse> {
 }
 /**
  * The interface that represents a contract between the adapter and the actual implementation of the adapter.
+ *
+ * @breadcrumb Contracts / AdapterContract
+ * @public
  */
 export interface AdapterContract<TEvent, TContext, TResponse> {
     /**
@@ -124,29 +123,30 @@ export interface AdapterContract<TEvent, TContext, TResponse> {
     /**
      * Decide if this adapter can handle a request based in the event payload
      *
-     * @param event The event sent by serverless
-     * @param context The context sent by the serverless
-     * @param log The instance of logger
+     * @param event - The event sent by serverless
+     * @param context - The context sent by the serverless
+     * @param log - The instance of logger
      */
     canHandle(event: unknown, context: TContext, log: ILogger): boolean;
     /**
      * Maps the serverless payload to an actual request that a framework can handle
      *
-     * @param event The event sent by serverless
-     * @param context The context sent by the serverless
-     * @param log The instance of logger
+     * @param event - The event sent by serverless
+     * @param context - The context sent by the serverless
+     * @param log - The instance of logger
      */
     getRequest(event: TEvent, context: TContext, log: ILogger): AdapterRequest;
     /**
      * Maps the response of the framework to a payload that serverless can handle
      *
-     * @param props The props sent by serverless
+     * @param props - The props sent by serverless
      */
     getResponse(props: GetResponseAdapterProps<TEvent>): TResponse;
     /**
      * When an error occurs while forwarding the request to the framework
      *
-     * @note You must call resolver.fail or resolver.succeed when implementing this method.
+     * @remarks You must call resolver.fail or resolver.succeed when implementing this method.
      */
     onErrorWhileForwarding(props: OnErrorProps<TEvent, TResponse>): void;
 }
+//# sourceMappingURL=adapter.contract.d.ts.map

package/lib/contracts/adapter.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.contract.d.ts","sourceRoot":"","sources":["../../src/contracts/adapter.contract.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB,CAAC,MAAM;IAC7C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC;IAE1B;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY,CAAC,MAAM,EAAE,SAAS;IAC7C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAEhD;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS;IAC1D;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;IAEzB;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC;IAEpE;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,GAAG,cAAc,CAAC;IAE3E;;;;OAIG;IACH,WAAW,CAAC,KAAK,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAE/D;;;;OAIG;IACH,sBAAsB,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC;CACtE"}

package/lib/contracts/adapter.contract.js

@@ -1,2 +1,4 @@
 "use strict";
+//#region Imports
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=adapter.contract.js.map

package/lib/contracts/adapter.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.contract.js","sourceRoot":"","sources":["../../src/contracts/adapter.contract.ts"],"names":[],"mappings":";AAAA,iBAAiB"}

package/lib/contracts/framework.contract.d.ts

@@ -2,14 +2,18 @@
 import { IncomingMessage, ServerResponse } from 'http';
 /**
  * The interface that represents a contract between the framework and the framework implementation
+ *
+ * @breadcrumb Contracts
+ * @public
  */
 export interface FrameworkContract<TApp> {
     /**
      * Send the request and response objects to the framework
      *
-     * @param app
-     * @param request
-     * @param response
+     * @param app - The instance of your app (Express, Fastify, Koa, etc...)
+     * @param request - The request object that will be forward to your app
+     * @param response - The response object that will be forward to your app to output the response
      */
     sendRequest(app: TApp, request: IncomingMessage, response: ServerResponse): void;
 }
+//# sourceMappingURL=framework.contract.d.ts.map

package/lib/contracts/framework.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework.contract.d.ts","sourceRoot":"","sources":["../../src/contracts/framework.contract.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAIvD;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB,CAAC,IAAI;IACrC;;;;;;OAMG;IACH,WAAW,CACT,GAAG,EAAE,IAAI,EACT,OAAO,EAAE,eAAe,EACxB,QAAQ,EAAE,cAAc,GACvB,IAAI,CAAC;CACT"}

package/lib/contracts/framework.contract.js

@@ -1,3 +1,4 @@
 "use strict";
 //#region Imports
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=framework.contract.js.map

package/lib/contracts/framework.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework.contract.js","sourceRoot":"","sources":["../../src/contracts/framework.contract.ts"],"names":[],"mappings":";AAAA,iBAAiB"}

package/lib/contracts/handler.contract.d.ts

@@ -5,10 +5,16 @@ import { FrameworkContract } from './framework.contract';
 import { ResolverContract } from './resolver.contract';
 /**
  * The function used to handle serverless requests
+ *
+ * @breadcrumb Contracts / HandlerContract
+ * @public
  */
 export declare type ServerlessHandler<TReturn> = (...args: any[]) => TReturn;
 /**
  * The interface that represents the contract between the handler and the real implementation
+ *
+ * @breadcrumb Contracts / HandlerContract
+ * @public
  */
 export interface HandlerContract<TApp, TEvent, TContext, TCallback, TResponse, TReturn> {
     /**
@@ -16,3 +22,4 @@ export interface HandlerContract<TApp, TEvent, TContext, TCallback, TResponse, T
      */
     getHandler(app: TApp, framework: FrameworkContract<TApp>, adapters: AdapterContract<TEvent, TContext, TResponse>[], resolverFactory: ResolverContract<TEvent, TContext, TCallback, TResponse, TReturn>, binarySettings: BinarySettings, respondWithErrors: boolean, log: ILogger): ServerlessHandler<TReturn>;
 }
+//# sourceMappingURL=handler.contract.d.ts.map

package/lib/contracts/handler.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.contract.d.ts","sourceRoot":"","sources":["../../src/contracts/handler.contract.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;;;;GAKG;AACH,oBAAY,iBAAiB,CAAC,OAAO,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC;AAErE;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAC9B,IAAI,EACJ,MAAM,EACN,QAAQ,EACR,SAAS,EACT,SAAS,EACT,OAAO;IAEP;;OAEG;IACH,UAAU,CACR,GAAG,EAAE,IAAI,EACT,SAAS,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAClC,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EACxD,eAAe,EAAE,gBAAgB,CAC/B,MAAM,EACN,QAAQ,EACR,SAAS,EACT,SAAS,EACT,OAAO,CACR,EACD,cAAc,EAAE,cAAc,EAC9B,iBAAiB,EAAE,OAAO,EAC1B,GAAG,EAAE,OAAO,GACX,iBAAiB,CAAC,OAAO,CAAC,CAAC;CAC/B"}

package/lib/contracts/handler.contract.js

@@ -1,3 +1,4 @@
 "use strict";
 //#region Imports
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=handler.contract.js.map

package/lib/contracts/handler.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.contract.js","sourceRoot":"","sources":["../../src/contracts/handler.contract.ts"],"names":[],"mappings":";AAAA,iBAAiB"}

package/lib/contracts/index.d.ts

@@ -2,3 +2,4 @@ export * from './adapter.contract';
 export * from './framework.contract';
 export * from './handler.contract';
 export * from './resolver.contract';
+//# sourceMappingURL=index.d.ts.map

package/lib/contracts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/contracts/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC"}

package/lib/contracts/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -14,3 +18,4 @@ __exportStar(require("./adapter.contract"), exports);
 __exportStar(require("./framework.contract"), exports);
 __exportStar(require("./handler.contract"), exports);
 __exportStar(require("./resolver.contract"), exports);
+//# sourceMappingURL=index.js.map

package/lib/contracts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contracts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,uDAAqC;AACrC,qDAAmC;AACnC,sDAAoC"}

package/lib/contracts/resolver.contract.d.ts

@@ -2,34 +2,43 @@ import { ILogger } from '../core';
 import { AdapterContract } from './adapter.contract';
 /**
  * The type that represents a resolver used to send the response, error or success, to the client
+ *
+ * @breadcrumb Contracts / ResolverContract
+ * @public
  */
 export declare type Resolver<TResponse, TReturn> = {
     /**
      * The method that will perform the task of forwarding the request to the framework and waiting for the promise to be resolved with the response
      *
-     * @param task The task to be executed
+     * @param task - The task to be executed
      */
     run(task: () => Promise<TResponse>): TReturn;
 };
 /**
  * The type that represents a delegate resolver that is passed to the adapter to handle what to do when an error occurs during forwarding.
+ *
+ * @breadcrumb Contracts / ResolverContract
+ * @public
  */
 export declare type DelegatedResolver<TResponse> = {
     /**
      * Send the success response to the client
      *
-     * @param success The serverless response
+     * @param success - The serverless response
      */
     succeed: (response: TResponse) => void;
     /**
      * Send the error response to the client
      *
-     * @param error The error object
+     * @param error - The error object
      */
     fail: (error: Error) => void;
 };
 /**
  * The createResolver contract props
+ *
+ * @breadcrumb Contracts / ResolverContract
+ * @public
  */
 export declare type ResolverProps<TEvent, TContext, TCallback, TResponse> = {
     /**
@@ -59,12 +68,16 @@ export declare type ResolverProps<TEvent, TContext, TCallback, TResponse> = {
 };
 /**
  * The interface that represents the contract used to send the response to the client
+ *
+ * @breadcrumb Contracts / ResolverContract
+ * @public
  */
 export interface ResolverContract<TEvent, TContext, TCallback, TResponse, TReturn> {
     /**
      * Create the resolver based on the context, callback or promise
      *
-     * @param props The props used to create the resolver
+     * @param props - The props used to create the resolver
      */
     createResolver(props: ResolverProps<TEvent, TContext, TCallback, TResponse>): Resolver<TResponse, TReturn>;
 }
+//# sourceMappingURL=resolver.contract.d.ts.map

package/lib/contracts/resolver.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.contract.d.ts","sourceRoot":"","sources":["../../src/contracts/resolver.contract.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAIrD;;;;;GAKG;AACH,oBAAY,QAAQ,CAAC,SAAS,EAAE,OAAO,IAAI;IACzC;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC;CAC9C,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,iBAAiB,CAAC,SAAS,IAAI;IACzC;;;;OAIG;IACH,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,IAAI,CAAC;IAEvC;;;;OAIG;IACH,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC9B,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,IAAI;IAClE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IAEtD;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB,CAC/B,MAAM,EACN,QAAQ,EACR,SAAS,EACT,SAAS,EACT,OAAO;IAEP;;;;OAIG;IACH,cAAc,CACZ,KAAK,EAAE,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,GAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;CACjC"}

package/lib/contracts/resolver.contract.js

@@ -1,3 +1,4 @@
 "use strict";
 //#region Imports
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=resolver.contract.js.map

package/lib/contracts/resolver.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.contract.js","sourceRoot":"","sources":["../../src/contracts/resolver.contract.ts"],"names":[],"mappings":";AAAA,iBAAiB"}

package/lib/core/base-handler.d.ts

@@ -4,6 +4,9 @@ import { ServerlessRequest, ServerlessResponse } from '../network';
 import { ILogger } from './index';
 /**
  * The abstract class that represents the base class for a handler
+ *
+ * @breadcrumb Core
+ * @public
  */
 export declare abstract class BaseHandler<TApp, TEvent, TContext, TCallback, TResponse, TReturn> implements HandlerContract<TApp, TEvent, TContext, TCallback, TResponse, TReturn> {
     /**
@@ -13,16 +16,17 @@ export declare abstract class BaseHandler<TApp, TEvent, TContext, TCallback, TRe
     /**
      * Get the adapter to handle a specific event and context
      *
-     * @param event The event sent by serverless
-     * @param context The context sent by serverless
-     * @param adapters The list of adapters
-     * @param log The instance of logger
+     * @param event - The event sent by serverless
+     * @param context - The context sent by serverless
+     * @param adapters - The list of adapters
+     * @param log - The instance of logger
      */
     protected getAdapterByEventAndContext(event: TEvent, context: TContext, adapters: AdapterContract<TEvent, TContext, TResponse>[], log: ILogger): AdapterContract<TEvent, TContext, TResponse>;
     /**
      * Get serverless request and response frmo the adapter request
      *
-     * @param requestValues The request values from adapter
+     * @param requestValues - The request values from adapter
      */
     protected getServerlessRequestResponseFromAdapterRequest(requestValues: AdapterRequest): [request: ServerlessRequest, response: ServerlessResponse];
 }
+//# sourceMappingURL=base-handler.d.ts.map

package/lib/core/base-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-handler.d.ts","sourceRoot":"","sources":["../../src/core/base-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EACL,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAIlC;;;;;GAKG;AACH,8BAAsB,WAAW,CAC/B,IAAI,EACJ,MAAM,EACN,QAAQ,EACR,SAAS,EACT,SAAS,EACT,OAAO,CACP,YACE,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC;IAIxE;;OAEG;aACa,UAAU,CACxB,GAAG,EAAE,IAAI,EACT,SAAS,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAClC,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EACxD,eAAe,EAAE,gBAAgB,CAC/B,MAAM,EACN,QAAQ,EACR,SAAS,EACT,SAAS,EACT,OAAO,CACR,EACD,cAAc,EAAE,cAAc,EAC9B,iBAAiB,EAAE,OAAO,EAC1B,GAAG,EAAE,OAAO,GACX,iBAAiB,CAAC,OAAO,CAAC;IAM7B;;;;;;;OAOG;IACH,SAAS,CAAC,2BAA2B,CACnC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,QAAQ,EACjB,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EACxD,GAAG,EAAE,OAAO,GACX,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;IAsB/C;;;;OAIG;IACH,SAAS,CAAC,8CAA8C,CACtD,aAAa,EAAE,cAAc,GAC5B,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,kBAAkB,CAAC;CAiB9D"}

package/lib/core/base-handler.js

@@ -6,6 +6,9 @@ const network_1 = require("../network");
 //#endregion
 /**
  * The abstract class that represents the base class for a handler
+ *
+ * @breadcrumb Core
+ * @public
  */
 class BaseHandler {
     //#endregion
@@ -13,10 +16,10 @@ class BaseHandler {
     /**
      * Get the adapter to handle a specific event and context
      *
-     * @param event The event sent by serverless
-     * @param context The context sent by serverless
-     * @param adapters The list of adapters
-     * @param log The instance of logger
+     * @param event - The event sent by serverless
+     * @param context - The context sent by serverless
+     * @param adapters - The list of adapters
+     * @param log - The instance of logger
      */
     getAdapterByEventAndContext(event, context, adapters, log) {
         const resolvedAdapters = adapters.filter(adapter => adapter.canHandle(event, context, log));
@@ -33,7 +36,7 @@ class BaseHandler {
     /**
      * Get serverless request and response frmo the adapter request
      *
-     * @param requestValues The request values from adapter
+     * @param requestValues - The request values from adapter
      */
     getServerlessRequestResponseFromAdapterRequest(requestValues) {
         const request = new network_1.ServerlessRequest({
@@ -50,3 +53,4 @@ class BaseHandler {
     }
 }
 exports.BaseHandler = BaseHandler;
+//# sourceMappingURL=base-handler.js.map

package/lib/core/base-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-handler.js","sourceRoot":"","sources":["../../src/core/base-handler.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAWjB,wCAAmE;AAGnE,YAAY;AAEZ;;;;;GAKG;AACH,MAAsB,WAAW;IA+B/B,YAAY;IAEZ,2BAA2B;IAE3B;;;;;;;OAOG;IACO,2BAA2B,CACnC,KAAa,EACb,OAAiB,EACjB,QAAwD,EACxD,GAAY;QAEZ,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CACjD,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,CACvC,CAAC;QAEF,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;SACH;QAED,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,MAAM,IAAI,KAAK,CACb,yFAAyF,QAAQ;iBAC9F,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;iBACxC,IAAI,CAAC,IAAI,CAAC,GAAG,CACjB,CAAC;SACH;QAED,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACO,8CAA8C,CACtD,aAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,2BAAiB,CAAC;YACpC,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,aAAa,EAAE,aAAa,CAAC,aAAa;YAC1C,GAAG,EAAE,aAAa,CAAC,IAAI;SACxB,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAI,4BAAkB,CAAC;YACtC,MAAM,EAAE,aAAa,CAAC,MAAM;SAC7B,CAAC,CAAC;QAEH,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC7B,CAAC;CAGF;AA9FD,kCA8FC"}