@h4ad/serverless-adapter 2.2.0 → 2.3.2

package/lib/adapters/aws/sqs.adapter.d.ts

@@ -3,18 +3,21 @@ import { AdapterContract, AdapterRequest, OnErrorProps } from '../../contracts';
 import { IEmptyResponse } from '../../core';
 /**
  * The options to customize the {@link SQSAdapter}
+ *
+ * @breadcrumb Adapters / AWS / SQSAdapter
+ * @public
  */
 export interface SQSAdapterOptions {
     /**
      * The path that will be used to create a request to be forwarded to the framework.
      *
-     * @default /sqs
+     * @defaultValue /sqs
      */
     sqsForwardPath?: string;
     /**
      * The http method that will be used to create a request to be forwarded to the framework.
      *
-     * @default POST
+     * @defaultValue POST
      */
     sqsForwardMethod?: string;
 }
@@ -23,40 +26,45 @@ export interface SQSAdapterOptions {
  *
  * The option of `responseWithErrors` is ignored by this adapter and we always call `resolver.fail` with the error.
  *
- * {@link https://docs.aws.amazon.com/pt_br/lambda/latest/dg/with-sqs.html Event Reference}
+ * {@link https://docs.aws.amazon.com/pt_br/lambda/latest/dg/with-sqs.html | Event Reference}
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const sqsForwardPath = '/your/route/sqs'; // default /sqs
  * const sqsForwardMethod = 'POST'; // default POST
  * const adapter = new SQSAdapter({ sqsForwardPath, sqsForwardMethod });
  * ```
+ *
+ * @breadcrumb Adapters / AWS / SQSAdapter
+ * @public
  */
 export declare class SQSAdapter implements AdapterContract<SQSEvent, Context, IEmptyResponse> {
     protected readonly options?: SQSAdapterOptions | undefined;
     /**
      * Default constructor
      *
-     * @param options The options to customize the {@link SQSAdapter}
+     * @param options - The options to customize the {@link SQSAdapter}
      */
     constructor(options?: SQSAdapterOptions | undefined);
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getAdapterName(): string;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     canHandle(event: unknown): event is SQSEvent;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getRequest(event: SQSEvent): AdapterRequest;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getResponse(): IEmptyResponse;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     onErrorWhileForwarding({ error, delegatedResolver, }: OnErrorProps<SQSEvent, IEmptyResponse>): void;
 }
+//# sourceMappingURL=sqs.adapter.d.ts.map

package/lib/adapters/aws/sqs.adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqs.adapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/aws/sqs.adapter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAEL,cAAc,EAGf,MAAM,YAAY,CAAC;AAIpB;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,UACX,YAAW,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,cAAc,CAAC;IASjD,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC;IALvC;;;;OAIG;gBAC4B,OAAO,CAAC,+BAAmB;IAM1D;;OAEG;IACI,cAAc,IAAI,MAAM;IAI/B;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ;IAUnD;;OAEG;IACI,UAAU,CAAC,KAAK,EAAE,QAAQ,GAAG,cAAc;IA0BlD;;OAEG;IACI,WAAW,IAAI,cAAc;IAIpC;;OAEG;IACI,sBAAsB,CAAC,EAC5B,KAAK,EACL,iBAAiB,GAClB,EAAE,YAAY,CAAC,QAAQ,EAAE,cAAc,CAAC,GAAG,IAAI;CAKjD"}

package/lib/adapters/aws/sqs.adapter.js

@@ -8,20 +8,24 @@ const core_1 = require("../../core");
  *
  * The option of `responseWithErrors` is ignored by this adapter and we always call `resolver.fail` with the error.
  *
- * {@link https://docs.aws.amazon.com/pt_br/lambda/latest/dg/with-sqs.html Event Reference}
+ * {@link https://docs.aws.amazon.com/pt_br/lambda/latest/dg/with-sqs.html | Event Reference}
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const sqsForwardPath = '/your/route/sqs'; // default /sqs
  * const sqsForwardMethod = 'POST'; // default POST
  * const adapter = new SQSAdapter({ sqsForwardPath, sqsForwardMethod });
  * ```
+ *
+ * @breadcrumb Adapters / AWS / SQSAdapter
+ * @public
  */
 class SQSAdapter {
     //#region Constructor
     /**
      * Default constructor
      *
-     * @param options The options to customize the {@link SQSAdapter}
+     * @param options - The options to customize the {@link SQSAdapter}
      */
     constructor(options) {
         this.options = options;
@@ -29,13 +33,13 @@ class SQSAdapter {
     //#endregion
     //#region Public Methods
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getAdapterName() {
         return SQSAdapter.name;
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     canHandle(event) {
         var _a;
@@ -46,7 +50,7 @@ class SQSAdapter {
         return eventSource === 'aws:sqs';
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getRequest(event) {
         var _a, _b;
@@ -66,16 +70,17 @@ class SQSAdapter {
         };
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getResponse() {
         return core_1.EmptyResponse;
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     onErrorWhileForwarding({ error, delegatedResolver, }) {
         delegatedResolver.fail(error);
     }
 }
 exports.SQSAdapter = SQSAdapter;
+//# sourceMappingURL=sqs.adapter.js.map

package/lib/adapters/aws/sqs.adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqs.adapter.js","sourceRoot":"","sources":["../../../src/adapters/aws/sqs.adapter.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAIjB,qCAKoB;AA0BpB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,UAAU;IAGrB,qBAAqB;IAErB;;;;OAIG;IACH,YAA+B,OAA2B;QAA3B,YAAO,GAAP,OAAO,CAAoB;IAAG,CAAC;IAE9D,YAAY;IAEZ,wBAAwB;IAExB;;OAEG;IACI,cAAc;QACnB,OAAO,UAAU,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAc;;QAC7B,MAAM,QAAQ,GAAG,KAA0B,CAAC;QAE5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,CAAC;YAAE,OAAO,KAAK,CAAC;QAEpD,MAAM,WAAW,GAAG,MAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,WAAW,CAAC;QAErD,OAAO,WAAW,KAAK,SAAS,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,KAAe;;QAC/B,MAAM,IAAI,GAAG,IAAA,4BAAqB,EAAC,MAAA,IAAI,CAAC,OAAO,0CAAE,cAAc,EAAE,MAAM,CAAC,CAAC;QACzE,MAAM,MAAM,GAAG,IAAA,4BAAqB,EAClC,MAAA,IAAI,CAAC,OAAO,0CAAE,gBAAgB,EAC9B,MAAM,CACP,CAAC;QAEF,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,GAAG,IAAA,2BAAoB,EAChD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,KAAK,CACN,CAAC;QAEF,MAAM,OAAO,GAAG;YACd,IAAI,EAAE,mBAAmB;YACzB,cAAc,EAAE,kBAAkB;YAClC,gBAAgB,EAAE,MAAM,CAAC,aAAa,CAAC;SACxC,CAAC;QAEF,OAAO;YACL,MAAM;YACN,OAAO;YACP,IAAI;YACJ,IAAI;SACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,oBAAa,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,EAC5B,KAAK,EACL,iBAAiB,GACsB;QACvC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;CAGF;AAnFD,gCAmFC"}

package/lib/adapters/dummy/dummy.adapter.d.ts

@@ -2,26 +2,30 @@ import { AdapterContract, AdapterRequest, OnErrorProps } from '../../contracts';
 import { IEmptyResponse } from '../../core';
 /**
  * The class that represents a dummy adapter that does nothing and can be used by the cloud that doesn't use adapters.
+ *
+ * @breadcrumb Adapters / DummyAdapter
+ * @public
  */
 export declare class DummyAdapter implements AdapterContract<any, any, void> {
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     canHandle(): boolean;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getAdapterName(): string;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getRequest(): AdapterRequest;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getResponse(): IEmptyResponse;
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     onErrorWhileForwarding(props: OnErrorProps<any, void>): void;
 }
+//# sourceMappingURL=dummy.adapter.d.ts.map

package/lib/adapters/dummy/dummy.adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dummy.adapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/dummy/dummy.adapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAiB,cAAc,EAAE,MAAM,YAAY,CAAC;AAI3D;;;;;GAKG;AACH,qBAAa,YAAa,YAAW,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;IAClE;;OAEG;IACI,SAAS,IAAI,OAAO;IAI3B;;OAEG;IACI,cAAc,IAAI,MAAM;IAI/B;;OAEG;IACI,UAAU,IAAI,cAAc;IASnC;;OAEG;IACI,WAAW,IAAI,cAAc;IAIpC;;OAEG;IACI,sBAAsB,CAAC,KAAK,EAAE,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI;CAGpE"}

package/lib/adapters/dummy/dummy.adapter.js

@@ -6,22 +6,25 @@ const core_1 = require("../../core");
 //#endregion
 /**
  * The class that represents a dummy adapter that does nothing and can be used by the cloud that doesn't use adapters.
+ *
+ * @breadcrumb Adapters / DummyAdapter
+ * @public
  */
 class DummyAdapter {
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     canHandle() {
         return true;
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getAdapterName() {
         return DummyAdapter.name;
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getRequest() {
         return {
@@ -32,16 +35,17 @@ class DummyAdapter {
         };
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     getResponse() {
         return core_1.EmptyResponse;
     }
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     onErrorWhileForwarding(props) {
         props.delegatedResolver.succeed();
     }
 }
 exports.DummyAdapter = DummyAdapter;
+//# sourceMappingURL=dummy.adapter.js.map

package/lib/adapters/dummy/dummy.adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dummy.adapter.js","sourceRoot":"","sources":["../../../src/adapters/dummy/dummy.adapter.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAGjB,qCAA2D;AAE3D,YAAY;AAEZ;;;;;GAKG;AACH,MAAa,YAAY;IACvB;;OAEG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,OAAO,YAAY,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO;YACL,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK,CAAC;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,oBAAa,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,KAA8B;QAC1D,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;IACpC,CAAC;CACF;AAxCD,oCAwCC"}

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

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

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

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

package/lib/adapters/dummy/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("./dummy.adapter"), exports);
+//# sourceMappingURL=index.js.map

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

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

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