@h4ad/serverless-adapter 2.2.0 → 2.3.2

package/README.md

@@ -23,7 +23,7 @@ Run REST APIs and other web applications using your existing Node.js application
 Fastify), on top of AWS Lambda, Huawei and many other clouds.
 
 This library was a refactored version of [@vendia/serverless-express](https://github.com/vendia/serverless-express), I
-created a new way to interact and extend event sources by creating contracts to abstract the integrations between each
+create a new way to interact and extend event sources by creating contracts to abstract the integrations between each
 library layer.
 
 Why you would use this libray instead of [@vendia/serverless-express](https://github.com/vendia/serverless-express)?
@@ -35,266 +35,17 @@ Why you would use this libray instead of [@vendia/serverless-express](https://gi
   - This is important because if you find a bug, you can quickly resolve it by extending the class, _and then you can
     submit a PR to fix the bug_.
 - All code was written in Typescript.
+- Well documented, any method, class, or interface has comments to explain the behavior.
 - We have >99% coverage.
 
-# Install
+# Documentation
 
-Using NPM:
-
-```bash
-npm install --save @h4ad/serverless-adapter
-```
-
-Using Yarn:
-
-```bash
-yarn add @h4ad/serverless-adapter
-```
-
-# Usage
-
-You can quickly use this library as follows:
-
-```ts
-import { ServerlessAdapter } from '@h4ad/serverless-adapter';
-import { ApiGatewayV2Adapter, AlbAdapter, SQSAdapter, SNSAdapter } from '@h4ad/serverless-adapter/lib/adapters/aws';
-import { ExpressFramework } from '@h4ad/serverless-adapter/lib/frameworks/express';
-import { DefaultHandler } from '@h4ad/serverless-adapter/lib/handlers/default';
-import { PromiseResolver } from '@h4ad/serverless-adapter/lib/resolvers/promise';
-import app from './app';
-
-export const handler = ServerlessAdapter.new(app)
-  .setFramework(new ExpressFramework())
-  .setHandler(new DefaultHandler())
-  .setResolver(new PromiseResolver())
-  .addAdapter(new AlbAdapter())
-  .addAdapter(new SQSAdapter())
-  .addAdapter(new SNSAdapter())
-  .build();
-```
-
-Too fast? Ok, I can explain.
-
-First, you need to create an instance of the builder with `ServerlessAdapter.new(app)`. The variable `app` is the
-instance of your framework (Express, Fastify, Koa, etc).
-
-So you need to specify for this library which `framework` you will use to handle the `request` with `setFramework`, you
-can only use one. If you use express in our backend, use [ExpressFramework](src/frameworks/express/express.framework.ts)
-, see more in [support](#support).
-
-Then you specify which `handler` you will use to interact with the serverless cloud with `setHandler`, currently we only
-have one, the [DefaultHandler](src/handlers/default/default.handler.ts). In the next releases, maybe we will add support
-for Azure, Huawei and others, for now, you can use this default.
-
-Then you specify with `setResolver` which `resolver` you will use to wait for the library to forward the request to
-your `framework`, and then get the `response` back to your cloud. I recommend you
-use [PromiseResolver](src/resolvers/promise/promise.resolver.ts), it's the most cloud-agnostic `resolver`.
-
-By now, you've already added the basic abstractions of this library, now, you can add the `adapters` that will add
-support for receiving and processing different sources of `addAdapter` events. In the example I
-added [AlbAdapter](./src/adapters/aws/alb.adapter.ts), [SQSAdapter](./src/adapters/aws/sqs.adapter.ts)
-and [SNSAdapter](./src/adapters/aws/sns.adapter.ts). With these adapters you can connect your lambda to three different
-event sources and you can add more if you wish.
-
-Finally, we call `build` which will assemble your handler that you can expose directly to your cloud.
-
-Final thoughts:
-
-- You can set the `framework` only once.
-- You can set the `handler` only once.
-- You can set the `resolver` only once.
-- You can have as many `adapters` as you like, use and extend as you wish.
-
-# Support
-
-> We are in beta, so some adapters may not work as expected, feel free to create an issue or provide feedback on current behavior.
-
-By design we have these contracts that define the layers of the library: Frameworks, Adapters, Resolvers and Handlers.
-
-> If you don't know what each thing means, see [Architecture](#architecture).
-
-Currently, we support these frameworks:
-
-- [Express](https://expressjs.com/) by using ([ExpressFramework](src/frameworks/express/express.framework.ts))
-- [Fastify](https://www.fastify.io/) by using ([FastifyFramework](src/frameworks/fastify/fastify.framework.ts))
-- [Hapi](https://hapi.dev/) by using ([HapiFramework](src/frameworks/hapi/hapi.framework.ts))
-- [Koa](https://koajs.com/) by using ([KoaFramework](src/frameworks/koa/koa.framework.ts))
-
-We support these event sources:
-
-- AWS
-  - [AWS Load Balancer](https://docs.aws.amazon.com/lambda/latest/dg/services-alb.html) by
-    using ([AlbAdapter](./src/adapters/aws/alb.adapter.ts))
-  - [AWS Api Gateway V1](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html)
-    by using ([ApiGatewayV1Adapter](./src/adapters/aws/api-gateway-v1.adapter.ts))
-  - [AWS Api Gateway V2](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html)
-    by using ([ApiGatewayV2Adapter](./src/adapters/aws/api-gateway-v2.adapter.ts))
-  - [AWS DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html) by
-    using ([DynamoDBAdapter](./src/adapters/aws/dynamodb.adapter.ts))
-  - [AWS Event Bridge / CloudWatch Events](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudwatchevents.html)
-    by using ([EventBridgeAdapter](./src/adapters/aws/event-bridge.adapter.ts))
-  - [AWS Lambda Edge](https://docs.aws.amazon.com/lambda/latest/dg/lambda-edge.html) by
-    using ([LambdaEdgeAdapter](./src/adapters/aws/lambda-edge.adapter.ts))
-  - [AWS SNS](https://docs.aws.amazon.com/pt_br/lambda/latest/dg/with-sns.html) by
-    using ([SNSAdapter](./src/adapters/aws/sns.adapter.ts))
-  - [AWS SQS](https://docs.aws.amazon.com/pt_br/lambda/latest/dg/with-sqs.html) by
-    using ([SQSAdapter](./src/adapters/aws/sqs.adapter.ts))
-- Huawei
-  - [Http Function](https://support.huaweicloud.com/intl/en-us/usermanual-functiongraph/functiongraph_01_1442.html): Look [this section](#huawei-http-function) about Huawei support for Http Function.
-  - [Event Function](https://support.huaweicloud.com/intl/en-us/usermanual-functiongraph/functiongraph_01_1441.html): 
-    - [Api Gateway](https://support.huaweicloud.com/intl/en-us/devg-functiongraph/functiongraph_02_0102.html#functiongraph_02_0102__li5178638110137) by using ([HuaweiApiGatewayAdapter](src/adapters/huawei/huawei-api-gateway.adapter.ts)).
-- Azure
-  - [The support is coming soon.](https://github.com/H4ad/serverless-adapter/issues/3)
-- Firebase
-  - The support is coming soon.
-- GCP
-  - The support is coming soon.
-
-We support these resolvers:
-
-- Promise by using ([PromiseResolver](src/resolvers/promise/promise.resolver.ts))
-- Callback by using ([CallbackResolver](src/resolvers/callback/callback.resolver.ts))
-- AWS Context by using ([AwsContextResolver](src/resolvers/aws-context/aws-context.resolver.ts))
-
-We support these handlers:
-
-- Default by using ([DefaultHandler](src/handlers/default/default.handler.ts))
-- Huawei by using ([HttpHuaweiHandler](src/handlers/huawei/http-huawei.handler.ts)) and ([EventHuaweiHandler](#huawei-event-function))
-
-## Huawei
-
-In Huawei, we added support to FunctionGraphV2 with Http Function and Event Function.
-
-The difference between Http Function and Event Function is that in Http Function you must expose port 8000 and Huawei will proxy Api Gateway requests to your application.
-So, on implementation, this library will create an http server to listen on port 8000 and forward the request to your framework.
-
-In Event Function, you will receive the event from event source in the same way you receive in AWS, an object with some structure, you can see the supported event sources [here](https://support.huaweicloud.com/intl/en-us/devg-functiongraph/functiongraph_02_0102.html).
-
-### Huawei Http Function
-
-To integrate your app with Huawei FunctionGrapth with the Http Function type, you must do the following:
-
-```ts
-import { ServerlessAdapter } from '@h4ad/serverless-adapter';
-import { ExpressFramework } from '@h4ad/serverless-adapter/lib/frameworks/express';
-import { HttpHuaweiHandler } from '@h4ad/serverless-adapter/lib/handlers/huawei';
-import { DummyResolver } from '@h4ad/serverless-adapter/lib/resolvers/dummy';
-import { DummyAdapter } from '@h4ad/serverless-adapter/lib/adapters/dummy';
-import app from './app';
-
-// instead exposing handler, you have the dispose function
-// this dispose function is never called
-// but you can to close the http server created with him
-const dispose = ServerlessAdapter.new(app)
-    .setHandler(new HttpHuaweiHandler())
-    .setFramework(new ExpressFramework())
-    // dummy resolver and adapter is used because
-    // they are necessary in the core of the library to build
-    // but is optional to make huawei http function works.
-    .setResolver(new DummyResolver())
-    .addAdapter(new DummyAdapter())
-    .build();
-```
-
-> You don't need to expose a variable called `handler` when you choose Http Function, you just need to call build to the library create a http server.
-
-By the way of Huawei architecture in Http Function, they have no use for Resolvers and Adapters, so you need to use the dummy versions because the library requires it.
-
-#### ONE IMPORTANT THING
-
-You need to configure a file called `bootstrap` in the root of folder that you upload to Huawei, is like the file `Procfile` but for Huawei.
-
-In my setup, I configure like:
-```
-node /opt/function/code/index.js
-```
-
-The path `/opt/function/code` is where your code is uploaded when you deploy something and `index.js` is the file that contains the `ServerlessAdapter`.
-
-In the end, the structure of the zip file you upload looks like this:
-
-- `bootstrap`
-- `index.js`
-
-### Huawei Event Function
-
-With Http Function you need to use [HttpHuaweiHandler](src/handlers/huawei/http-huawei.handler.ts), 
-but with Event Function you should use [DefaultHandler](src/handlers/default/default.handler.ts).
-
-So, to add support to Api Gateway you do the following:
-
-```ts
-import { ServerlessAdapter } from '@h4ad/serverless-adapter';
-import { HuaweiApiGatewayAdapter } from '@h4ad/serverless-adapter/lib/adapters/huawei';
-import { ExpressFramework } from '@h4ad/serverless-adapter/lib/frameworks/express';
-import { DefaultHandler } from '@h4ad/serverless-adapter/lib/handlers/default';
-import { CallbackResolver } from '@h4ad/serverless-adapter/lib/resolvers/callback';
-import app from './app';
-
-export const handler = ServerlessAdapter.new(app)
-  .setFramework(new ExpressFramework())
-  .setHandler(new DefaultHandler())
-  .setResolver(new CallbackResolver())
-  .addAdapter(new HuaweiApiGatewayAdapter())
-  .build();
-```
-
-#### One important thing
-
-You must use the callback resolver because I couldn't get it to work with the PromiseResolver.
-Maybe it's a bug in the library or something specific in Huawei, if you have a tip please create an issue.
+See how to use this library [here](https://viniciusl.com.br/serverless-adapter/docs/category/getting-started).
 
 # Examples
 
 You can see some examples of how to use this library [here](https://github.com/H4ad/serverless-adapter-examples).
 
-# Architecture
-
-The main purpose of this library is to allow the developer to add support for any cloud and as many event sources as he
-wants, without having to create an issue to request the feature or copy the library code because the library doesn't
-expose good APIs for you to extend its functionality
-
-So I refactored [@vendia/serverless-express](https://github.com/vendia/serverless-express) with 4 layers of abstraction:
-Framework, Handler, Resolver and Adapter.
-
-The [FrameworkContract](./src/contracts/framework.contract.ts) is responsible for forwarding
-to [IncomingMessage](https://nodejs.org/api/http.html#class-httpincomingmessage)
-and [ServerResponse](https://nodejs.org/api/http.html#class-httpserverresponse) for your application instance. With this
-abstraction you can implement any framework you want, they just need to accept both parameters and
-call [end](https://nodejs.org/api/http.html#class-httpserverresponse)
-in [ServerResponse](https://nodejs.org/api/http.html#class-httpserverresponse), so the library knows when to continue
-and return the response.
-
-The [HandlerContract](./src/contracts/handler.contract.ts) is responsible to get the input from the serverless and then
-manage to call each layer of abstraction to return a response. With this abstraction, you can implement different ways
-to receive input from your serverless environment. They usually have the same structure, but if you need to deal with a
-very different cloud, you can use this abstraction to add support for that cloud.
-
-> Handler is a good choice for implementing (~~monsters~~) ways to receive input.
-> For example, we can create an http server as its handler to test our serverless code without having to launch the framework. Because? I don't know, but you can.
-
-The [ResolverContract](./src/contracts/resolver.contract.ts) is responsible for waiting for the framework to handle the
-request and then returning the response to the cloud. Using AWS for example, you have three ways to wait for the
-response: returning a promise, calling the callback, and ~~using in-context methods~~, each option has its own benefits,
-but generally the promise option will be the better because any good cloud provider will support promises.
-
-Finally, the masterpiece of this library, the [AdapterContract](./src/contracts/adapter.contract.ts) is responsible for
-handling the received event, transforming the request in a way that your application can understand and then
-transforming the response in a way your cloud can understand.
-
-Well, with these four contracts, you'll be able to add support to any cloud that exists (no more excuses not to use
-cloud X with NodeJS).
-
-## Why you create this library?
-
-The real reason I created this library was because I wanted to add API Gateway and SQS support at the same time to save
-some money. But, [@vendia/serverless-express](https://github.com/vendia/serverless-express) was not supported, so
-I [created a PR](https://github.com/vendia/serverless-express/pull/483), but until I finished this library, that PR was
-never accepted.
-
-So I build my own library based on that library with better APIs so I never have to wait for the maintainer to accept my
-PR just to extend the library's functionality :)
-
 # Credits
 
 Honestly, I just refactored all the code that the @vendia team and many other contributors wrote, thanks so much to them

package/lib/@types/binary-settings.d.ts

@@ -1,17 +1,25 @@
 /**
- * The interface representing the settings for whether the response should be treated as binary or not
+ * The interface representing the binary settings implementation by function
  *
- * @note Encoded as binary means the response body will be converted to base64
+ * @breadcrumb Types / BinarySettings
+ * @public
  */
-export declare type BinarySettings = {
+export interface BinarySettingsFunction {
     /**
      * This property can be a function that receives the response headers and returns whether that response should be encoded as binary.
      * Otherwise, you can specify not to treat any response as binary by putting `false` in this property.
      *
-     * @note Setting this property prevents the `contentTypes` and `contentEncodings` properties from being used.
+     * @remarks Setting this property prevents the `contentTypes` and `contentEncodings` properties from being used.
      */
     isBinary: ((headers: Record<string, string | string[] | undefined>) => boolean) | false;
-} | {
+}
+/**
+ * The interface representing the binary settings implementation by looking inside the headers
+ *
+ * @breadcrumb Types / BinarySettings
+ * @public
+ */
+export interface BinarySettingsContentHeaders {
     /**
      * The list of content types that will be treated as binary
      */
@@ -20,4 +28,14 @@ export declare type BinarySettings = {
      * The list of content encodings that will be treated as binary
      */
     contentEncodings: string[];
-};
+}
+/**
+ * The interface representing the settings for whether the response should be treated as binary or not
+ *
+ * @remarks Encoded as binary means the response body will be converted to base64
+ *
+ * @breadcrumb Types / BinarySettings
+ * @public
+ */
+export declare type BinarySettings = BinarySettingsFunction | BinarySettingsContentHeaders;
+//# sourceMappingURL=binary-settings.d.ts.map

package/lib/@types/binary-settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-settings.d.ts","sourceRoot":"","sources":["../../src/@types/binary-settings.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,QAAQ,EACJ,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,OAAO,CAAC,GACrE,KAAK,CAAC;CACX;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,YAAY,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAElC;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,oBAAY,cAAc,GACtB,sBAAsB,GACtB,4BAA4B,CAAC"}

package/lib/@types/binary-settings.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=binary-settings.js.map

package/lib/@types/binary-settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-settings.js","sourceRoot":"","sources":["../../src/@types/binary-settings.ts"],"names":[],"mappings":""}

package/lib/@types/headers.d.ts

@@ -1,24 +1,37 @@
 /**
  * The record that represents the headers that doesn't have multiple values in the value
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * { 'Accept-Encoding': 'gzip, deflate, br' }
  * ```
+ *
+ * @breadcrumb Types
+ * @public
  */
 export declare type SingleValueHeaders = Record<string, string | undefined>;
 /**
  * The record that represents the headers that have multiple values in the value
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * { 'Accept-Encoding': ['gzip', 'deflate', 'br'] }
  * ```
+ *
+ * @breadcrumb Types
+ * @public
  */
 export declare type MultiValueHeaders = Record<string, string[] | undefined>;
 /**
  * The record that represents the headers that can both single or multiple values in the value
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * { 'Accept-Encoding': ['gzip', 'deflate', 'br'], 'Host': 'xyz.execute-api.us-east-1.amazonaws.com' }
  * ```
+ *
+ * @breadcrumb Types
+ * @public
  */
 export declare type BothValueHeaders = Record<string, string | string[] | undefined>;
+//# sourceMappingURL=headers.d.ts.map

package/lib/@types/headers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"headers.d.ts","sourceRoot":"","sources":["../../src/@types/headers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,oBAAY,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;AAEpE;;;;;;;;;;GAUG;AACH,oBAAY,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;AAErE;;;;;;;;;;GAUG;AACH,oBAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC"}

package/lib/@types/headers.js

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

package/lib/@types/headers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headers.js","sourceRoot":"","sources":["../../src/@types/headers.ts"],"names":[],"mappings":""}

package/lib/@types/helpers.d.ts

@@ -1,6 +1,10 @@
 /**
  * Removes 'optional' attributes from a type's properties
+ *
+ * @breadcrumb Types
+ * @public
  */
 export declare type Concrete<Type> = {
     [Property in keyof Type]-?: Type[Property];
 };
+//# sourceMappingURL=helpers.d.ts.map

package/lib/@types/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/@types/helpers.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oBAAY,QAAQ,CAAC,IAAI,IAAI;KAC1B,QAAQ,IAAI,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;CAC3C,CAAC"}

package/lib/@types/helpers.js

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

package/lib/@types/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/@types/helpers.ts"],"names":[],"mappings":""}

package/lib/@types/huawei/huawei-api-gateway-event.d.ts

@@ -1,19 +1,81 @@
 import { BothValueHeaders } from '../index';
+/**
+ * The interface that represents the Api Gateway Event of Huawei when integrate with Function Graph of Event Type.
+ * See more in {@link https://support.huaweicloud.com/intl/en-us/devg-functiongraph/functiongraph_02_0102.html#functiongraph_02_0102__li5178638110137 | Reference}.
+ *
+ * @public
+ * @breadcrumb Types / Huawei / HuaweiApiGatewayEvent
+ */
 export interface HuaweiApiGatewayEvent {
+    /**
+     * The body value with the content of this event serialized in JSON
+     */
     body: string;
+    /**
+     * The headers of the request which this event represents
+     */
     headers: BothValueHeaders;
+    /**
+     * The HTTP Method of the request which this event represents
+     */
     httpMethod: string;
+    /**
+     * Tells if the body is base64 encoded
+     */
     isBase64Encoded: boolean;
+    /**
+     * The path of the request which this event represents
+     */
     path: string;
+    /**
+     * The path parameters of the request which this event represents
+     */
     pathParameters: HuaweiRequestPathParameters;
+    /**
+     * The query strings of the request which this event represents
+     */
     queryStringParameters: HuaweiRequestQueryStringParameters;
+    /**
+     * The request context with information about the stage, api and requestId
+     */
     requestContext: HuaweiRequestContext;
+    /**
+     * It can have more properties that I could not discover yet
+     */
     [key: string]: any;
 }
+/**
+ * The path parameters of the request, usually is the name of the wildcard you create in FunctionGraph, such as /\{proxy\}.
+ *
+ * @public
+ * @breadcrumb Types / Huawei / HuaweiApiGatewayEvent
+ */
 export declare type HuaweiRequestPathParameters = Record<string, string>;
+/**
+ * The query strings of the request
+ *
+ * @public
+ * @breadcrumb Types / Huawei / HuaweiApiGatewayEvent
+ */
 export declare type HuaweiRequestQueryStringParameters = Record<string, string | string[]>;
+/**
+ * The interface that represents the values you can get inside request context.
+ *
+ * @public
+ * @breadcrumb Types / Huawei / HuaweiApiGatewayEvent
+ */
 export interface HuaweiRequestContext {
+    /**
+     * The ID of your API inside Api Gateway
+     */
     apiId: string;
+    /**
+     * The ID of this request
+     */
     requestId: string;
+    /**
+     * The name of the stage running this Function Graph
+     */
     stage: string;
 }
+//# sourceMappingURL=huawei-api-gateway-event.d.ts.map

package/lib/@types/huawei/huawei-api-gateway-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"huawei-api-gateway-event.d.ts","sourceRoot":"","sources":["../../../src/@types/huawei/huawei-api-gateway-event.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAI5C;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,2BAA2B,CAAC;IAE5C;;OAEG;IACH,qBAAqB,EAAE,kCAAkC,CAAC;IAE1D;;OAEG;IACH,cAAc,EAAE,oBAAoB,CAAC;IAErC;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;;GAKG;AACH,oBAAY,2BAA2B,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEjE;;;;;GAKG;AACH,oBAAY,kCAAkC,GAAG,MAAM,CACrD,MAAM,EACN,MAAM,GAAG,MAAM,EAAE,CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf"}

package/lib/@types/huawei/huawei-api-gateway-event.js

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

package/lib/@types/huawei/huawei-api-gateway-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"huawei-api-gateway-event.js","sourceRoot":"","sources":["../../../src/@types/huawei/huawei-api-gateway-event.ts"],"names":[],"mappings":";AAAA,iBAAiB"}

package/lib/@types/huawei/huawei-api-gateway-response.d.ts

@@ -1,7 +1,27 @@
 import { MultiValueHeaders } from '../headers';
+/**
+ * The interface that represents the Api Gateway Response of Huawei when integrate with Function Graph of Event Type.
+ * See more in {@link https://support.huaweicloud.com/intl/en-us/devg-functiongraph/functiongraph_02_0102.html#functiongraph_02_0102__li5178638110137 | Reference}.
+ *
+ * @public
+ * @breadcrumb Types / Huawei / HuaweiApiGatewayResponse
+ */
 export interface HuaweiApiGatewayResponse {
+    /**
+     * Tells if the body was encoded as base64
+     */
     isBase64Encoded: boolean;
+    /**
+     * The HTTP Status code of this response
+     */
     statusCode: number;
+    /**
+     * The headers sent with this response
+     */
     headers: MultiValueHeaders;
+    /**
+     * The body value with the content of this response serialized in JSON
+     */
     body: string;
 }
+//# sourceMappingURL=huawei-api-gateway-response.d.ts.map

package/lib/@types/huawei/huawei-api-gateway-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"huawei-api-gateway-response.d.ts","sourceRoot":"","sources":["../../../src/@types/huawei/huawei-api-gateway-response.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAI/C;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}

package/lib/@types/huawei/huawei-api-gateway-response.js

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

package/lib/@types/huawei/huawei-api-gateway-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"huawei-api-gateway-response.js","sourceRoot":"","sources":["../../../src/@types/huawei/huawei-api-gateway-response.ts"],"names":[],"mappings":";AAAA,iBAAiB"}