@fy-stack/apigateway-construct 0.0.125 → 0.0.127

package/README.md

@@ -1,7 +1,20 @@
-# apigateway-construct
+# API Gateway Construct Documentation
 
-This library was generated with [Nx](https://nx.dev).
+## `ApiGatewayConstruct`
 
-## Building
+The `ApiGatewayConstruct` class is a custom AWS CDK construct that sets up an API Gateway with defined routes and integrations. The constructor initializes the API Gateway with default and additional integrations based on the provided properties. It also configures CORS to allow headers, origins, and methods from any source.
 
-Run `nx build apigateway-construct` to build the library.
+- **Properties**
+    - `api: HttpApi`
+        - The API Gateway instance managed by this construct.
+
+- **Constructor**
+    - `constructor(scope: Construct, id: string, props: ApiGatewayConstructProps)`
+        - Initializes the API Gateway construct with a unique identifier and configuration options defined by `ApiGatewayConstructProps`.
+        - **Parameters**
+            - `scope`: The scope in which this construct is defined.
+            - `id`: The unique identifier for this construct.
+            - `props`: Properties required to set up the API Gateway construct, including route mappings and resource configurations.
+
+- **Error Handling**
+    - Throws an error if the base route or default integration is missing.

package/dist/lib/apigateway-construct.d.ts

@@ -1,6 +1,14 @@
-import { HttpApi } from "aws-cdk-lib/aws-apigatewayv2";
+import { HttpApi } from 'aws-cdk-lib/aws-apigatewayv2';
 import { Construct } from "constructs";
 import { ApiGatewayConstructProps } from "./types";
+/**
+ * ApiGatewayConstruct is a construct class for creating an API Gateway with defined routes and integrations.
+ *
+ * The constructor initializes the API Gateway with default and additional integrations based on the provided props.
+ * It sets up CORS preflight options to allow headers, origins, and methods from any source.
+ *
+ * @throws {Error} Throws an error if the base route is not found.
+ */
 export declare class ApiGatewayConstruct extends Construct {
     readonly api: HttpApi;
     constructor(scope: Construct, id: string, props: ApiGatewayConstructProps);

package/dist/lib/apigateway-construct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apigateway-construct.d.ts","sourceRoot":"","sources":["../../src/lib/apigateway-construct.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAc,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAEnD,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,SAAgB,GAAG,EAAE,OAAO,CAAC;gBAEjB,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,wBAAwB;CAuC1E"}
+{"version":3,"file":"apigateway-construct.d.ts","sourceRoot":"","sources":["../../src/lib/apigateway-construct.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,OAAO,EAAc,MAAM,8BAA8B,CAAC;AACnF,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAEnD;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,SAAgB,GAAG,EAAE,OAAO,CAAC;gBAEjB,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,wBAAwB;CA8C1E"}

package/dist/lib/apigateway-construct.js

@@ -3,6 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiGatewayConstruct = void 0;
 const aws_apigatewayv2_1 = require("aws-cdk-lib/aws-apigatewayv2");
 const constructs_1 = require("constructs");
+/**
+ * ApiGatewayConstruct is a construct class for creating an API Gateway with defined routes and integrations.
+ *
+ * The constructor initializes the API Gateway with default and additional integrations based on the provided props.
+ * It sets up CORS preflight options to allow headers, origins, and methods from any source.
+ *
+ * @throws {Error} Throws an error if the base route is not found.
+ */
 class ApiGatewayConstruct extends constructs_1.Construct {
     api;
     constructor(scope, id, props) {
@@ -24,7 +32,14 @@ class ApiGatewayConstruct extends constructs_1.Construct {
         for (const i in otherRoutes) {
             Object.assign(additionalIntegrations, otherRoutes[i]?.api(i));
         }
-        this.api = new aws_apigatewayv2_1.HttpApi(this, "Api", { defaultIntegration });
+        this.api = new aws_apigatewayv2_1.HttpApi(this, "Api", {
+            defaultIntegration,
+            corsPreflight: {
+                allowHeaders: ["*"],
+                allowOrigins: ["*"],
+                allowMethods: [aws_apigatewayv2_1.CorsHttpMethod.ANY],
+            }
+        });
         for (const i in additionalIntegrations) {
             this.api.addRoutes({
                 integration: additionalIntegrations[i],

package/dist/lib/types.d.ts

@@ -1,6 +1,15 @@
 import type { ApiResource, ResourceRef } from '@fy-stack/types';
 export type ApiGatewayConstructProps = {
+    /**
+     * A map of route names to their respective resource references.
+     * Each key in the record represents a unique route name, and the associated value is an instance of ResourceRef.
+     */
     routes: Record<string, ResourceRef>;
+    /**
+     * An optional object mapping resource names to their corresponding `ApiResource` objects.
+     * Each key in this object represents a unique resource identifier, and the associated
+     * value implements `ApiResource`
+     */
     resources?: Record<string, ApiResource | undefined>;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAC,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE/D,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;CACrD,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAC,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE/D,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;CACrD,CAAC"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@fy-stack/apigateway-construct",
-  "version": "0.0.125",
+  "version": "0.0.127",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@fy-stack/types": "0.0.125"
+    "@fy-stack/types": "0.0.127"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "2.164.1",
+    "aws-cdk-lib": "2.166.0",
     "constructs": "10.4.2"
   },
   "type": "commonjs",