@incloodsolutions/devkit 0.0.2 → 0.0.4

package/dist/aws-cdk/api-gateway-websocket.d.cts

@@ -0,0 +1,73 @@
+import { Construct } from 'constructs';
+import { Function } from 'aws-cdk-lib/aws-lambda';
+import { WebSocketApi, WebSocketApiProps, WebSocketStageProps, WebSocketRouteOptions } from 'aws-cdk-lib/aws-apigatewayv2';
+import { IBaseCdkConstructProps } from '../aws-types.cjs';
+import '@incloodsolutions/toolkit';
+
+/**
+ * Props for BaseApiGatewayWebSocketConstruct
+ *
+ * Provides configuration for:
+ * - WebSocket API (API Gateway v2)
+ * - WebSocket stage
+ * - Route handlers for lifecycle events
+ */
+interface IApiGatewayWebsocketConstructProps extends Omit<IBaseCdkConstructProps<{
+    /** WebSocket API configuration options */
+    readonly webSocketApiOptions: WebSocketApiProps;
+    /** WebSocket stage configuration options */
+    readonly webSocketStageOptions: WebSocketStageProps;
+}>, 'appName' | 'stage' | 'stackName'> {
+    /**
+     * Lambda handlers mapped to WebSocket lifecycle routes
+     *
+     * Includes:
+     * - $connect
+     * - $disconnect
+     * - $default
+     * - custom message route
+     */
+    readonly handlers: {
+        /** Handler for connection establishment ($connect) */
+        readonly connect: {
+            option: WebSocketRouteOptions;
+            function: Function;
+        };
+        /** Handler for unmatched routes ($default) */
+        readonly default: {
+            option: WebSocketRouteOptions;
+            function: Function;
+        };
+        /** Handler for custom message route (e.g. 'notifications') */
+        readonly message: {
+            option: WebSocketRouteOptions;
+            function: Function;
+        };
+        /** Handler for disconnection events ($disconnect) */
+        readonly disconnect: {
+            option: WebSocketRouteOptions;
+            function: Function;
+        };
+    };
+}
+/**
+ * CDK construct for WebSocket API Gateway
+ *
+ * Responsibilities:
+ * - Creates a WebSocket API with lifecycle route integrations
+ * - Registers a custom message route
+ * - Deploys a stage with auto-deploy enabled
+ * - Exposes WebSocket endpoint URL as a CloudFormation output
+ */
+declare class BaseApiGatewayWebSocketConstruct extends Construct {
+    /** The created WebSocket API instance */
+    readonly socketApi: WebSocketApi;
+    /**
+     * @param scope Parent construct
+     * @param id Unique construct identifier
+     * @param props Configuration for API, stage, and route handlers
+     */
+    constructor(scope: Construct, id: string, props: IApiGatewayWebsocketConstructProps);
+}
+
+export { BaseApiGatewayWebSocketConstruct };

package/dist/aws-cdk/api-gateway-websocket.d.ts

@@ -0,0 +1,73 @@
+import { Construct } from 'constructs';
+import { Function } from 'aws-cdk-lib/aws-lambda';
+import { WebSocketApi, WebSocketApiProps, WebSocketStageProps, WebSocketRouteOptions } from 'aws-cdk-lib/aws-apigatewayv2';
+import { IBaseCdkConstructProps } from '../aws-types.js';
+import '@incloodsolutions/toolkit';
+
+/**
+ * Props for BaseApiGatewayWebSocketConstruct
+ *
+ * Provides configuration for:
+ * - WebSocket API (API Gateway v2)
+ * - WebSocket stage
+ * - Route handlers for lifecycle events
+ */
+interface IApiGatewayWebsocketConstructProps extends Omit<IBaseCdkConstructProps<{
+    /** WebSocket API configuration options */
+    readonly webSocketApiOptions: WebSocketApiProps;
+    /** WebSocket stage configuration options */
+    readonly webSocketStageOptions: WebSocketStageProps;
+}>, 'appName' | 'stage' | 'stackName'> {
+    /**
+     * Lambda handlers mapped to WebSocket lifecycle routes
+     *
+     * Includes:
+     * - $connect
+     * - $disconnect
+     * - $default
+     * - custom message route
+     */
+    readonly handlers: {
+        /** Handler for connection establishment ($connect) */
+        readonly connect: {
+            option: WebSocketRouteOptions;
+            function: Function;
+        };
+        /** Handler for unmatched routes ($default) */
+        readonly default: {
+            option: WebSocketRouteOptions;
+            function: Function;
+        };
+        /** Handler for custom message route (e.g. 'notifications') */
+        readonly message: {
+            option: WebSocketRouteOptions;
+            function: Function;
+        };
+        /** Handler for disconnection events ($disconnect) */
+        readonly disconnect: {
+            option: WebSocketRouteOptions;
+            function: Function;
+        };
+    };
+}
+/**
+ * CDK construct for WebSocket API Gateway
+ *
+ * Responsibilities:
+ * - Creates a WebSocket API with lifecycle route integrations
+ * - Registers a custom message route
+ * - Deploys a stage with auto-deploy enabled
+ * - Exposes WebSocket endpoint URL as a CloudFormation output
+ */
+declare class BaseApiGatewayWebSocketConstruct extends Construct {
+    /** The created WebSocket API instance */
+    readonly socketApi: WebSocketApi;
+    /**
+     * @param scope Parent construct
+     * @param id Unique construct identifier
+     * @param props Configuration for API, stage, and route handlers
+     */
+    constructor(scope: Construct, id: string, props: IApiGatewayWebsocketConstructProps);
+}
+
+export { BaseApiGatewayWebSocketConstruct };

package/dist/aws-cdk/api-gateway-websocket.js

@@ -0,0 +1,75 @@
+import { Construct } from 'constructs';
+import { CfnOutput } from 'aws-cdk-lib';
+import { WebSocketLambdaIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';
+import { WebSocketApi, WebSocketStage } from 'aws-cdk-lib/aws-apigatewayv2';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var BaseApiGatewayWebSocketConstruct = class extends Construct {
+  static {
+    __name(this, "BaseApiGatewayWebSocketConstruct");
+  }
+  /** The created WebSocket API instance */
+  socketApi;
+  /**
+   * @param scope Parent construct
+   * @param id Unique construct identifier
+   * @param props Configuration for API, stage, and route handlers
+   */
+  constructor(scope, id, props) {
+    super(scope, id);
+    this.socketApi = new WebSocketApi(this, id, {
+      ...props.options.webSocketApiOptions,
+      /**
+       * Route for connection establishment ($connect)
+       */
+      connectRouteOptions: {
+        ...props.handlers.connect?.option,
+        integration: new WebSocketLambdaIntegration(
+          "connectIntegration",
+          props.handlers.connect.function
+        )
+      },
+      /**
+       * Route for disconnection events ($disconnect)
+       */
+      disconnectRouteOptions: {
+        ...props.handlers.disconnect?.option,
+        integration: new WebSocketLambdaIntegration(
+          "disconnectIntegration",
+          props.handlers.disconnect.function
+        )
+      },
+      /**
+       * Default route for unmatched messages ($default)
+       */
+      defaultRouteOptions: {
+        ...props.handlers.default?.option,
+        integration: new WebSocketLambdaIntegration(
+          "defaultIntegration",
+          props.handlers.default.function
+        )
+      }
+    });
+    this.socketApi.addRoute("notifications", {
+      ...props.handlers.message?.option,
+      /** Lambda integration for message handling */
+      integration: new WebSocketLambdaIntegration(
+        "routes",
+        props.handlers.message.function
+      )
+    });
+    const webSocketStage = new WebSocketStage(this, `${id}_stage`, {
+      ...props.options?.webSocketStageOptions,
+      webSocketApi: this.socketApi,
+      autoDeploy: true
+    });
+    new CfnOutput(this, "WebSocketURL", {
+      value: webSocketStage.url
+    });
+  }
+};
+
+export { BaseApiGatewayWebSocketConstruct };
+//# sourceMappingURL=api-gateway-websocket.js.map
+//# sourceMappingURL=api-gateway-websocket.js.map

package/dist/aws-cdk/api-gateway-websocket.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/aws/cdk/constructs/api-gateway-websocket-construct.ts"],"names":[],"mappings":";;;;;;;AA6EO,IAAM,gCAAA,GAAN,cAA+C,SAAA,CAAU;AAAA,EA7EhE;AA6EgE,IAAA,MAAA,CAAA,IAAA,EAAA,kCAAA,CAAA;AAAA;AAAA;AAAA,EAEtD,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,WAAA,CACC,KAAA,EACA,EAAA,EACA,KAAA,EACC;AACD,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,SAAA,GAAY,IAAI,YAAA,CAAa,IAAA,EAAM,EAAA,EAAI;AAAA,MAC3C,GAAG,MAAM,OAAA,CAAQ,mBAAA;AAAA;AAAA;AAAA;AAAA,MAKjB,mBAAA,EAAqB;AAAA,QACpB,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA,QAC3B,aAAa,IAAI,0BAAA;AAAA,UAChB,oBAAA;AAAA,UACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB,OACD;AAAA;AAAA;AAAA;AAAA,MAKA,sBAAA,EAAwB;AAAA,QACvB,GAAG,KAAA,CAAM,QAAA,CAAS,UAAA,EAAY,MAAA;AAAA,QAC9B,aAAa,IAAI,0BAAA;AAAA,UAChB,uBAAA;AAAA,UACA,KAAA,CAAM,SAAS,UAAA,CAAW;AAAA;AAC3B,OACD;AAAA;AAAA;AAAA;AAAA,MAKA,mBAAA,EAAqB;AAAA,QACpB,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA,QAC3B,aAAa,IAAI,0BAAA;AAAA,UAChB,oBAAA;AAAA,UACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB;AACD,KACA,CAAA;AAKD,IAAA,IAAA,CAAK,SAAA,CAAU,SAAS,eAAA,EAAiB;AAAA,MACxC,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA;AAAA,MAG3B,aAAa,IAAI,0BAAA;AAAA,QAChB,QAAA;AAAA,QACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB,KACA,CAAA;AAMD,IAAA,MAAM,iBAAiB,IAAI,cAAA,CAAe,IAAA,EAAM,CAAA,EAAG,EAAE,CAAA,MAAA,CAAA,EAAU;AAAA,MAC9D,GAAG,MAAM,OAAA,EAAS,qBAAA;AAAA,MAClB,cAAc,IAAA,CAAK,SAAA;AAAA,MACnB,UAAA,EAAY;AAAA,KACZ,CAAA;AAKD,IAAA,IAAI,SAAA,CAAU,MAAM,cAAA,EAAgB;AAAA,MACnC,OAAO,cAAA,CAAe;AAAA,KACtB,CAAA;AAAA,EACF;AACD","file":"api-gateway-websocket.js","sourcesContent":["import { Construct } from 'constructs';\nimport { CfnOutput } from 'aws-cdk-lib';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { WebSocketLambdaIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';\nimport {\n\tWebSocketApi,\n\tWebSocketApiProps,\n\tWebSocketRouteOptions,\n\tWebSocketStage,\n\tWebSocketStageProps,\n} from 'aws-cdk-lib/aws-apigatewayv2';\n\nimport { IBaseCdkConstructProps } from '../../types';\n\n/**\n * Props for BaseApiGatewayWebSocketConstruct\n *\n * Provides configuration for:\n * - WebSocket API (API Gateway v2)\n * - WebSocket stage\n * - Route handlers for lifecycle events\n */\ninterface IApiGatewayWebsocketConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** WebSocket API configuration options */\n\t\treadonly webSocketApiOptions: WebSocketApiProps;\n\n\t\t/** WebSocket stage configuration options */\n\t\treadonly webSocketStageOptions: WebSocketStageProps;\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda handlers mapped to WebSocket lifecycle routes\n\t *\n\t * Includes:\n\t * - $connect\n\t * - $disconnect\n\t * - $default\n\t * - custom message route\n\t */\n\treadonly handlers: {\n\t\t/** Handler for connection establishment ($connect) */\n\t\treadonly connect: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for unmatched routes ($default) */\n\t\treadonly default: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for custom message route (e.g. 'notifications') */\n\t\treadonly message: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for disconnection events ($disconnect) */\n\t\treadonly disconnect: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\t};\n}\n\n/**\n * CDK construct for WebSocket API Gateway\n *\n * Responsibilities:\n * - Creates a WebSocket API with lifecycle route integrations\n * - Registers a custom message route\n * - Deploys a stage with auto-deploy enabled\n * - Exposes WebSocket endpoint URL as a CloudFormation output\n */\nexport class BaseApiGatewayWebSocketConstruct extends Construct {\n\t/** The created WebSocket API instance */\n\treadonly socketApi: WebSocketApi;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, stage, and route handlers\n\t */\n\tconstructor(\n\t\tscope: Construct,\n\t\tid: string,\n\t\tprops: IApiGatewayWebsocketConstructProps,\n\t) {\n\t\tsuper(scope, id);\n\n\t\tthis.socketApi = new WebSocketApi(this, id, {\n\t\t\t...props.options.webSocketApiOptions,\n\n\t\t\t/**\n\t\t\t * Route for connection establishment ($connect)\n\t\t\t */\n\t\t\tconnectRouteOptions: {\n\t\t\t\t...props.handlers.connect?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'connectIntegration',\n\t\t\t\t\tprops.handlers.connect.function,\n\t\t\t\t),\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Route for disconnection events ($disconnect)\n\t\t\t */\n\t\t\tdisconnectRouteOptions: {\n\t\t\t\t...props.handlers.disconnect?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'disconnectIntegration',\n\t\t\t\t\tprops.handlers.disconnect.function,\n\t\t\t\t),\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Default route for unmatched messages ($default)\n\t\t\t */\n\t\t\tdefaultRouteOptions: {\n\t\t\t\t...props.handlers.default?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'defaultIntegration',\n\t\t\t\t\tprops.handlers.default.function,\n\t\t\t\t),\n\t\t\t},\n\t\t});\n\n\t\t/**\n\t\t * Custom message route (e.g. \"notifications\")\n\t\t */\n\t\tthis.socketApi.addRoute('notifications', {\n\t\t\t...props.handlers.message?.option,\n\n\t\t\t/** Lambda integration for message handling */\n\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t'routes',\n\t\t\t\tprops.handlers.message.function,\n\t\t\t),\n\t\t});\n\n\t\t/**\n\t\t * WebSocket stage deployment\n\t\t * Auto-deploy ensures changes are immediately available\n\t\t */\n\t\tconst webSocketStage = new WebSocketStage(this, `${id}_stage`, {\n\t\t\t...props.options?.webSocketStageOptions,\n\t\t\twebSocketApi: this.socketApi,\n\t\t\tautoDeploy: true,\n\t\t});\n\n\t\t/**\n\t\t * CloudFormation output exposing WebSocket endpoint URL\n\t\t */\n\t\tnew CfnOutput(this, 'WebSocketURL', {\n\t\t\tvalue: webSocketStage.url,\n\t\t});\n\t}\n}\n"]}

package/dist/aws-cdk/api-gateway.cjs

@@ -0,0 +1,98 @@
+'use strict';
+
+var constructs = require('constructs');
+var awsCdkLib = require('aws-cdk-lib');
+var awsApigateway = require('aws-cdk-lib/aws-apigateway');
+var toolkit = require('@incloodsolutions/toolkit');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var BaseApiGatewayConstruct = class _BaseApiGatewayConstruct extends constructs.Construct {
+  static {
+    __name(this, "BaseApiGatewayConstruct");
+  }
+  /** The created REST API instance */
+  api;
+  /** Enables debug logging for route creation */
+  enableDebug = false;
+  /**
+   * @param scope Parent construct
+   * @param id Unique construct identifier
+   * @param props Configuration for API, routes, and Lambda handler
+   */
+  constructor(scope, id, props) {
+    super(scope, id);
+    this.enableDebug = props.enableDebug;
+    this.api = new awsApigateway.RestApi(this, id, {
+      ...props?.options?.gatewayOptions,
+      /** Default API description if not provided */
+      description: props?.options?.gatewayOptions?.description || "This is a REST API using CDK",
+      /**
+       * CORS configuration
+       * Falls back to allowing all origins, methods, and standard headers
+       */
+      defaultCorsPreflightOptions: {
+        ...props?.options?.gatewayOptions?.defaultCorsPreflightOptions,
+        /** Allow all origins by default */
+        allowOrigins: props?.options?.gatewayOptions?.defaultCorsPreflightOptions?.allowOrigins || awsApigateway.Cors.ALL_ORIGINS,
+        /** Allow all HTTP methods by default */
+        allowMethods: props?.options?.gatewayOptions?.defaultCorsPreflightOptions?.allowMethods || awsApigateway.Cors.ALL_METHODS,
+        /** Merge default headers with user-defined headers */
+        allowHeaders: [
+          ...props.options?.gatewayOptions?.defaultCorsPreflightOptions?.allowHeaders,
+          "Content-Type",
+          "Accept",
+          "X-Amz-Date",
+          "Authorization",
+          "X-Api-Key",
+          "X-Amz-Security-Token",
+          "X-Amz-User-Agent"
+        ]
+      },
+      /** Minimum payload size (in bytes) before compression is applied */
+      minCompressionSize: props?.options?.gatewayOptions?.minCompressionSize || awsCdkLib.Size.bytes(1)
+    });
+    if (props?.options?.routeOptions?.length && props?.handlerFunction) {
+      const integration = new awsApigateway.LambdaIntegration(props.handlerFunction);
+      this.addRoutes(this.api.root, props.options.routeOptions, integration);
+    }
+    this.api.applyRemovalPolicy(awsCdkLib.RemovalPolicy.DESTROY);
+    new awsCdkLib.CfnOutput(this, "ApiGateway", {
+      value: this.api.url
+    });
+  }
+  /**
+   * Recursively attaches routes to the API Gateway
+   *
+   * Behaviour:
+   * - Creates a resource for each route segment
+   * - Attaches method + Lambda integration
+   * - Traverses child routes for nested paths
+   *
+   * @param parent Parent API resource
+   * @param routes Route definitions
+   * @param integration Lambda integration applied to each route
+   * @param previousPath Accumulated path (used for debug logging)
+   * @private
+   */
+  addRoutes(parent, routes, integration, previousPath) {
+    routes.forEach((route) => {
+      const currentPath = `${previousPath || ""}/${route.name}`;
+      const resource = parent.addResource(route.name);
+      resource.addMethod(route.method, integration);
+      if (route?.children.length) {
+        this.addRoutes(resource, route.children, integration, currentPath);
+      }
+      if (this.enableDebug) {
+        toolkit.printLog(
+          _BaseApiGatewayConstruct.name,
+          `Route created: ${route.method} ${currentPath}`
+        );
+      }
+    });
+  }
+};
+
+exports.BaseApiGatewayConstruct = BaseApiGatewayConstruct;
+//# sourceMappingURL=api-gateway.cjs.map
+//# sourceMappingURL=api-gateway.cjs.map

package/dist/aws-cdk/api-gateway.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/aws/cdk/constructs/api-gateway-construct.ts"],"names":["Construct","RestApi","Cors","Size","LambdaIntegration","RemovalPolicy","CfnOutput","printLog"],"mappings":";;;;;;;;;AAoEO,IAAM,uBAAA,GAAN,MAAM,wBAAA,SACJA,oBAAA,CAET;AAAA,EAvEA;AAuEA,IAAA,MAAA,CAAA,IAAA,EAAA,yBAAA,CAAA;AAAA;AAAA;AAAA,EAEU,GAAA;AAAA;AAAA,EAGT,WAAA,GAAc,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,WAAA,CAAY,KAAA,EAAkB,EAAA,EAAY,KAAA,EAAkC;AAC3E,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,cAAc,KAAA,CAAM,WAAA;AAEzB,IAAA,IAAA,CAAK,GAAA,GAAM,IAAIC,qBAAA,CAAQ,IAAA,EAAM,EAAA,EAAI;AAAA,MAChC,GAAG,OAAO,OAAA,EAAS,cAAA;AAAA;AAAA,MAGnB,WAAA,EACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,WAAA,IAChC,8BAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMD,2BAAA,EAA6B;AAAA,QAC5B,GAAG,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA;AAAA;AAAA,QAGnC,cACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC7B,gBAAgBC,kBAAA,CAAK,WAAA;AAAA;AAAA,QAGzB,cACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC7B,gBAAgBA,kBAAA,CAAK,WAAA;AAAA;AAAA,QAGzB,YAAA,EAAc;AAAA,UACb,GAAG,KAAA,CAAM,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC/B,YAAA;AAAA,UACH,cAAA;AAAA,UACA,QAAA;AAAA,UACA,YAAA;AAAA,UACA,eAAA;AAAA,UACA,WAAA;AAAA,UACA,sBAAA;AAAA,UACA;AAAA;AACD,OACD;AAAA;AAAA,MAGA,oBACC,KAAA,EAAO,OAAA,EAAS,gBAAgB,kBAAA,IAAsBC,cAAA,CAAK,MAAM,CAAC;AAAA,KACnE,CAAA;AAKD,IAAA,IAAI,KAAA,EAAO,OAAA,EAAS,YAAA,EAAc,MAAA,IAAU,OAAO,eAAA,EAAiB;AACnE,MAAA,MAAM,WAAA,GAAc,IAAIC,+BAAA,CAAkB,KAAA,CAAM,eAAe,CAAA;AAK/D,MAAA,IAAA,CAAK,UAAU,IAAA,CAAK,GAAA,CAAI,MAAM,KAAA,CAAM,OAAA,CAAQ,cAAc,WAAW,CAAA;AAAA,IACtE;AAKA,IAAA,IAAA,CAAK,GAAA,CAAI,kBAAA,CAAmBC,uBAAA,CAAc,OAAO,CAAA;AAKjD,IAAA,IAAIC,mBAAA,CAAU,MAAM,YAAA,EAAc;AAAA,MACjC,KAAA,EAAO,KAAK,GAAA,CAAI;AAAA,KAChB,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBQ,SAAA,CACP,MAAA,EACA,MAAA,EACA,WAAA,EACA,YAAA,EACC;AACD,IAAA,MAAA,CAAO,OAAA,CAAQ,CAAC,KAAA,KAAU;AACzB,MAAA,MAAM,cAAc,CAAA,EAAG,YAAA,IAAgB,EAAE,CAAA,CAAA,EAAI,MAAM,IAAI,CAAA,CAAA;AAEvD,MAAA,MAAM,QAAA,GAAW,MAAA,CAAO,WAAA,CAAY,KAAA,CAAM,IAAI,CAAA;AAG9C,MAAA,QAAA,CAAS,SAAA,CAAU,KAAA,CAAM,MAAA,EAAQ,WAAW,CAAA;AAG5C,MAAA,IAAI,KAAA,EAAO,SAAS,MAAA,EAAQ;AAC3B,QAAA,IAAA,CAAK,SAAA,CAAU,QAAA,EAAU,KAAA,CAAM,QAAA,EAAU,aAAa,WAAW,CAAA;AAAA,MAClE;AAGA,MAAA,IAAI,KAAK,WAAA,EAAa;AACrB,QAAAC,gBAAA;AAAA,UACC,wBAAA,CAAwB,IAAA;AAAA,UACxB,CAAA,eAAA,EAAkB,KAAA,CAAM,MAAM,CAAA,CAAA,EAAI,WAAW,CAAA;AAAA,SAC9C;AAAA,MACD;AAAA,IACD,CAAC,CAAA;AAAA,EACF;AACD","file":"api-gateway.cjs","sourcesContent":["import { Construct } from 'constructs';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { HttpMethod } from 'aws-cdk-lib/aws-apigatewayv2';\nimport { CfnOutput, RemovalPolicy, Size } from 'aws-cdk-lib';\nimport {\n\tCors,\n\tIResource,\n\tLambdaIntegration,\n\tRestApi,\n\tRestApiProps,\n} from 'aws-cdk-lib/aws-apigateway';\n\nimport { printLog } from '@incloodsolutions/toolkit';\n\nimport { IBaseCdkConstructProps, IBaseConstruct } from '../../types';\n\n/**\n * Route definition for API Gateway resources\n *\n * Supports hierarchical route structures using `children`\n */\ninterface IRouteOption {\n\t/** Path segment (e.g. 'users', 'orders') */\n\tname: string;\n\n\t/** HTTP method for the route */\n\tmethod: `${HttpMethod}`;\n\n\t/** Nested routes under this path */\n\tchildren?: IRouteOption[];\n}\n\n/**\n * Props for BaseApiGatewayConstruct\n *\n * Provides configuration for:\n * - REST API (API Gateway v1)\n * - Route definitions\n * - Lambda handler\n */\ninterface IApiGatewayConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** REST API configuration options */\n\t\treadonly gatewayOptions: RestApiProps;\n\n\t\t/** Route definitions used to build API resources */\n\t\treadonly routeOptions: IRouteOption[];\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda function handling all API routes\n\t *\n\t * Note:\n\t * A single Lambda integration is reused across all routes\n\t */\n\treadonly handlerFunction: Function;\n}\n\n/**\n * CDK construct for REST API Gateway with Lambda integration\n *\n * Responsibilities:\n * - Creates a REST API with configurable options\n * - Applies default CORS and compression settings when not provided\n * - Recursively builds API resources from route definitions\n * - Exposes API base URL as a CloudFormation output\n */\nexport class BaseApiGatewayConstruct\n\textends Construct\n\timplements IBaseConstruct\n{\n\t/** The created REST API instance */\n\treadonly api: RestApi;\n\n\t/** Enables debug logging for route creation */\n\tenableDebug = false;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, routes, and Lambda handler\n\t */\n\tconstructor(scope: Construct, id: string, props: IApiGatewayConstructProps) {\n\t\tsuper(scope, id);\n\n\t\tthis.enableDebug = props.enableDebug;\n\n\t\tthis.api = new RestApi(this, id, {\n\t\t\t...props?.options?.gatewayOptions,\n\n\t\t\t/** Default API description if not provided */\n\t\t\tdescription:\n\t\t\t\tprops?.options?.gatewayOptions?.description ||\n\t\t\t\t'This is a REST API using CDK',\n\n\t\t\t/**\n\t\t\t * CORS configuration\n\t\t\t * Falls back to allowing all origins, methods, and standard headers\n\t\t\t */\n\t\t\tdefaultCorsPreflightOptions: {\n\t\t\t\t...props?.options?.gatewayOptions?.defaultCorsPreflightOptions,\n\n\t\t\t\t/** Allow all origins by default */\n\t\t\t\tallowOrigins:\n\t\t\t\t\tprops?.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowOrigins || Cors.ALL_ORIGINS,\n\n\t\t\t\t/** Allow all HTTP methods by default */\n\t\t\t\tallowMethods:\n\t\t\t\t\tprops?.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowMethods || Cors.ALL_METHODS,\n\n\t\t\t\t/** Merge default headers with user-defined headers */\n\t\t\t\tallowHeaders: [\n\t\t\t\t\t...props.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowHeaders,\n\t\t\t\t\t'Content-Type',\n\t\t\t\t\t'Accept',\n\t\t\t\t\t'X-Amz-Date',\n\t\t\t\t\t'Authorization',\n\t\t\t\t\t'X-Api-Key',\n\t\t\t\t\t'X-Amz-Security-Token',\n\t\t\t\t\t'X-Amz-User-Agent',\n\t\t\t\t],\n\t\t\t},\n\n\t\t\t/** Minimum payload size (in bytes) before compression is applied */\n\t\t\tminCompressionSize:\n\t\t\t\tprops?.options?.gatewayOptions?.minCompressionSize || Size.bytes(1),\n\t\t});\n\n\t\t/**\n\t\t * Register routes if provided\n\t\t */\n\t\tif (props?.options?.routeOptions?.length && props?.handlerFunction) {\n\t\t\tconst integration = new LambdaIntegration(props.handlerFunction);\n\n\t\t\t/**\n\t\t\t * Attach routes recursively starting from API root\n\t\t\t */\n\t\t\tthis.addRoutes(this.api.root, props.options.routeOptions, integration);\n\t\t}\n\n\t\t/**\n\t\t * Apply removal policy (useful for non-production environments)\n\t\t */\n\t\tthis.api.applyRemovalPolicy(RemovalPolicy.DESTROY);\n\n\t\t/**\n\t\t * CloudFormation output exposing API base URL\n\t\t */\n\t\tnew CfnOutput(this, 'ApiGateway', {\n\t\t\tvalue: this.api.url,\n\t\t});\n\t}\n\n\t/**\n\t * Recursively attaches routes to the API Gateway\n\t *\n\t * Behaviour:\n\t * - Creates a resource for each route segment\n\t * - Attaches method + Lambda integration\n\t * - Traverses child routes for nested paths\n\t *\n\t * @param parent Parent API resource\n\t * @param routes Route definitions\n\t * @param integration Lambda integration applied to each route\n\t * @param previousPath Accumulated path (used for debug logging)\n\t * @private\n\t */\n\tprivate addRoutes(\n\t\tparent: IResource,\n\t\troutes: IRouteOption[],\n\t\tintegration: LambdaIntegration,\n\t\tpreviousPath?: string,\n\t) {\n\t\troutes.forEach((route) => {\n\t\t\tconst currentPath = `${previousPath || ''}/${route.name}`;\n\n\t\t\tconst resource = parent.addResource(route.name);\n\n\t\t\t/** Attach HTTP method with Lambda integration */\n\t\t\tresource.addMethod(route.method, integration);\n\n\t\t\t/** Recursively process child routes */\n\t\t\tif (route?.children.length) {\n\t\t\t\tthis.addRoutes(resource, route.children, integration, currentPath);\n\t\t\t}\n\n\t\t\t/** Optional debug logging */\n\t\t\tif (this.enableDebug) {\n\t\t\t\tprintLog(\n\t\t\t\t\tBaseApiGatewayConstruct.name,\n\t\t\t\t\t`Route created: ${route.method} ${currentPath}`,\n\t\t\t\t);\n\t\t\t}\n\t\t});\n\t}\n}\n"]}

package/dist/aws-cdk/api-gateway.d.cts

@@ -0,0 +1,80 @@
+import { Construct } from 'constructs';
+import { Function } from 'aws-cdk-lib/aws-lambda';
+import { HttpMethod } from 'aws-cdk-lib/aws-apigatewayv2';
+import { RestApi, RestApiProps } from 'aws-cdk-lib/aws-apigateway';
+import { IBaseConstruct, IBaseCdkConstructProps } from '../aws-types.cjs';
+import '@incloodsolutions/toolkit';
+
+/**
+ * Route definition for API Gateway resources
+ *
+ * Supports hierarchical route structures using `children`
+ */
+interface IRouteOption {
+    /** Path segment (e.g. 'users', 'orders') */
+    name: string;
+    /** HTTP method for the route */
+    method: `${HttpMethod}`;
+    /** Nested routes under this path */
+    children?: IRouteOption[];
+}
+/**
+ * Props for BaseApiGatewayConstruct
+ *
+ * Provides configuration for:
+ * - REST API (API Gateway v1)
+ * - Route definitions
+ * - Lambda handler
+ */
+interface IApiGatewayConstructProps extends Omit<IBaseCdkConstructProps<{
+    /** REST API configuration options */
+    readonly gatewayOptions: RestApiProps;
+    /** Route definitions used to build API resources */
+    readonly routeOptions: IRouteOption[];
+}>, 'appName' | 'stage' | 'stackName'> {
+    /**
+     * Lambda function handling all API routes
+     *
+     * Note:
+     * A single Lambda integration is reused across all routes
+     */
+    readonly handlerFunction: Function;
+}
+/**
+ * CDK construct for REST API Gateway with Lambda integration
+ *
+ * Responsibilities:
+ * - Creates a REST API with configurable options
+ * - Applies default CORS and compression settings when not provided
+ * - Recursively builds API resources from route definitions
+ * - Exposes API base URL as a CloudFormation output
+ */
+declare class BaseApiGatewayConstruct extends Construct implements IBaseConstruct {
+    /** The created REST API instance */
+    readonly api: RestApi;
+    /** Enables debug logging for route creation */
+    enableDebug: boolean;
+    /**
+     * @param scope Parent construct
+     * @param id Unique construct identifier
+     * @param props Configuration for API, routes, and Lambda handler
+     */
+    constructor(scope: Construct, id: string, props: IApiGatewayConstructProps);
+    /**
+     * Recursively attaches routes to the API Gateway
+     *
+     * Behaviour:
+     * - Creates a resource for each route segment
+     * - Attaches method + Lambda integration
+     * - Traverses child routes for nested paths
+     *
+     * @param parent Parent API resource
+     * @param routes Route definitions
+     * @param integration Lambda integration applied to each route
+     * @param previousPath Accumulated path (used for debug logging)
+     * @private
+     */
+    private addRoutes;
+}
+
+export { BaseApiGatewayConstruct };

package/dist/aws-cdk/api-gateway.d.ts

@@ -0,0 +1,80 @@
+import { Construct } from 'constructs';
+import { Function } from 'aws-cdk-lib/aws-lambda';
+import { HttpMethod } from 'aws-cdk-lib/aws-apigatewayv2';
+import { RestApi, RestApiProps } from 'aws-cdk-lib/aws-apigateway';
+import { IBaseConstruct, IBaseCdkConstructProps } from '../aws-types.js';
+import '@incloodsolutions/toolkit';
+
+/**
+ * Route definition for API Gateway resources
+ *
+ * Supports hierarchical route structures using `children`
+ */
+interface IRouteOption {
+    /** Path segment (e.g. 'users', 'orders') */
+    name: string;
+    /** HTTP method for the route */
+    method: `${HttpMethod}`;
+    /** Nested routes under this path */
+    children?: IRouteOption[];
+}
+/**
+ * Props for BaseApiGatewayConstruct
+ *
+ * Provides configuration for:
+ * - REST API (API Gateway v1)
+ * - Route definitions
+ * - Lambda handler
+ */
+interface IApiGatewayConstructProps extends Omit<IBaseCdkConstructProps<{
+    /** REST API configuration options */
+    readonly gatewayOptions: RestApiProps;
+    /** Route definitions used to build API resources */
+    readonly routeOptions: IRouteOption[];
+}>, 'appName' | 'stage' | 'stackName'> {
+    /**
+     * Lambda function handling all API routes
+     *
+     * Note:
+     * A single Lambda integration is reused across all routes
+     */
+    readonly handlerFunction: Function;
+}
+/**
+ * CDK construct for REST API Gateway with Lambda integration
+ *
+ * Responsibilities:
+ * - Creates a REST API with configurable options
+ * - Applies default CORS and compression settings when not provided
+ * - Recursively builds API resources from route definitions
+ * - Exposes API base URL as a CloudFormation output
+ */
+declare class BaseApiGatewayConstruct extends Construct implements IBaseConstruct {
+    /** The created REST API instance */
+    readonly api: RestApi;
+    /** Enables debug logging for route creation */
+    enableDebug: boolean;
+    /**
+     * @param scope Parent construct
+     * @param id Unique construct identifier
+     * @param props Configuration for API, routes, and Lambda handler
+     */
+    constructor(scope: Construct, id: string, props: IApiGatewayConstructProps);
+    /**
+     * Recursively attaches routes to the API Gateway
+     *
+     * Behaviour:
+     * - Creates a resource for each route segment
+     * - Attaches method + Lambda integration
+     * - Traverses child routes for nested paths
+     *
+     * @param parent Parent API resource
+     * @param routes Route definitions
+     * @param integration Lambda integration applied to each route
+     * @param previousPath Accumulated path (used for debug logging)
+     * @private
+     */
+    private addRoutes;
+}
+
+export { BaseApiGatewayConstruct };

package/dist/aws-cdk/api-gateway.js

@@ -0,0 +1,96 @@
+import { Construct } from 'constructs';
+import { Size, RemovalPolicy, CfnOutput } from 'aws-cdk-lib';
+import { RestApi, Cors, LambdaIntegration } from 'aws-cdk-lib/aws-apigateway';
+import { printLog } from '@incloodsolutions/toolkit';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var BaseApiGatewayConstruct = class _BaseApiGatewayConstruct extends Construct {
+  static {
+    __name(this, "BaseApiGatewayConstruct");
+  }
+  /** The created REST API instance */
+  api;
+  /** Enables debug logging for route creation */
+  enableDebug = false;
+  /**
+   * @param scope Parent construct
+   * @param id Unique construct identifier
+   * @param props Configuration for API, routes, and Lambda handler
+   */
+  constructor(scope, id, props) {
+    super(scope, id);
+    this.enableDebug = props.enableDebug;
+    this.api = new RestApi(this, id, {
+      ...props?.options?.gatewayOptions,
+      /** Default API description if not provided */
+      description: props?.options?.gatewayOptions?.description || "This is a REST API using CDK",
+      /**
+       * CORS configuration
+       * Falls back to allowing all origins, methods, and standard headers
+       */
+      defaultCorsPreflightOptions: {
+        ...props?.options?.gatewayOptions?.defaultCorsPreflightOptions,
+        /** Allow all origins by default */
+        allowOrigins: props?.options?.gatewayOptions?.defaultCorsPreflightOptions?.allowOrigins || Cors.ALL_ORIGINS,
+        /** Allow all HTTP methods by default */
+        allowMethods: props?.options?.gatewayOptions?.defaultCorsPreflightOptions?.allowMethods || Cors.ALL_METHODS,
+        /** Merge default headers with user-defined headers */
+        allowHeaders: [
+          ...props.options?.gatewayOptions?.defaultCorsPreflightOptions?.allowHeaders,
+          "Content-Type",
+          "Accept",
+          "X-Amz-Date",
+          "Authorization",
+          "X-Api-Key",
+          "X-Amz-Security-Token",
+          "X-Amz-User-Agent"
+        ]
+      },
+      /** Minimum payload size (in bytes) before compression is applied */
+      minCompressionSize: props?.options?.gatewayOptions?.minCompressionSize || Size.bytes(1)
+    });
+    if (props?.options?.routeOptions?.length && props?.handlerFunction) {
+      const integration = new LambdaIntegration(props.handlerFunction);
+      this.addRoutes(this.api.root, props.options.routeOptions, integration);
+    }
+    this.api.applyRemovalPolicy(RemovalPolicy.DESTROY);
+    new CfnOutput(this, "ApiGateway", {
+      value: this.api.url
+    });
+  }
+  /**
+   * Recursively attaches routes to the API Gateway
+   *
+   * Behaviour:
+   * - Creates a resource for each route segment
+   * - Attaches method + Lambda integration
+   * - Traverses child routes for nested paths
+   *
+   * @param parent Parent API resource
+   * @param routes Route definitions
+   * @param integration Lambda integration applied to each route
+   * @param previousPath Accumulated path (used for debug logging)
+   * @private
+   */
+  addRoutes(parent, routes, integration, previousPath) {
+    routes.forEach((route) => {
+      const currentPath = `${previousPath || ""}/${route.name}`;
+      const resource = parent.addResource(route.name);
+      resource.addMethod(route.method, integration);
+      if (route?.children.length) {
+        this.addRoutes(resource, route.children, integration, currentPath);
+      }
+      if (this.enableDebug) {
+        printLog(
+          _BaseApiGatewayConstruct.name,
+          `Route created: ${route.method} ${currentPath}`
+        );
+      }
+    });
+  }
+};
+
+export { BaseApiGatewayConstruct };
+//# sourceMappingURL=api-gateway.js.map
+//# sourceMappingURL=api-gateway.js.map

package/dist/aws-cdk/api-gateway.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/aws/cdk/constructs/api-gateway-construct.ts"],"names":[],"mappings":";;;;;;;AAoEO,IAAM,uBAAA,GAAN,MAAM,wBAAA,SACJ,SAAA,CAET;AAAA,EAvEA;AAuEA,IAAA,MAAA,CAAA,IAAA,EAAA,yBAAA,CAAA;AAAA;AAAA;AAAA,EAEU,GAAA;AAAA;AAAA,EAGT,WAAA,GAAc,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,WAAA,CAAY,KAAA,EAAkB,EAAA,EAAY,KAAA,EAAkC;AAC3E,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,cAAc,KAAA,CAAM,WAAA;AAEzB,IAAA,IAAA,CAAK,GAAA,GAAM,IAAI,OAAA,CAAQ,IAAA,EAAM,EAAA,EAAI;AAAA,MAChC,GAAG,OAAO,OAAA,EAAS,cAAA;AAAA;AAAA,MAGnB,WAAA,EACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,WAAA,IAChC,8BAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMD,2BAAA,EAA6B;AAAA,QAC5B,GAAG,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA;AAAA;AAAA,QAGnC,cACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC7B,gBAAgB,IAAA,CAAK,WAAA;AAAA;AAAA,QAGzB,cACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC7B,gBAAgB,IAAA,CAAK,WAAA;AAAA;AAAA,QAGzB,YAAA,EAAc;AAAA,UACb,GAAG,KAAA,CAAM,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC/B,YAAA;AAAA,UACH,cAAA;AAAA,UACA,QAAA;AAAA,UACA,YAAA;AAAA,UACA,eAAA;AAAA,UACA,WAAA;AAAA,UACA,sBAAA;AAAA,UACA;AAAA;AACD,OACD;AAAA;AAAA,MAGA,oBACC,KAAA,EAAO,OAAA,EAAS,gBAAgB,kBAAA,IAAsB,IAAA,CAAK,MAAM,CAAC;AAAA,KACnE,CAAA;AAKD,IAAA,IAAI,KAAA,EAAO,OAAA,EAAS,YAAA,EAAc,MAAA,IAAU,OAAO,eAAA,EAAiB;AACnE,MAAA,MAAM,WAAA,GAAc,IAAI,iBAAA,CAAkB,KAAA,CAAM,eAAe,CAAA;AAK/D,MAAA,IAAA,CAAK,UAAU,IAAA,CAAK,GAAA,CAAI,MAAM,KAAA,CAAM,OAAA,CAAQ,cAAc,WAAW,CAAA;AAAA,IACtE;AAKA,IAAA,IAAA,CAAK,GAAA,CAAI,kBAAA,CAAmB,aAAA,CAAc,OAAO,CAAA;AAKjD,IAAA,IAAI,SAAA,CAAU,MAAM,YAAA,EAAc;AAAA,MACjC,KAAA,EAAO,KAAK,GAAA,CAAI;AAAA,KAChB,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBQ,SAAA,CACP,MAAA,EACA,MAAA,EACA,WAAA,EACA,YAAA,EACC;AACD,IAAA,MAAA,CAAO,OAAA,CAAQ,CAAC,KAAA,KAAU;AACzB,MAAA,MAAM,cAAc,CAAA,EAAG,YAAA,IAAgB,EAAE,CAAA,CAAA,EAAI,MAAM,IAAI,CAAA,CAAA;AAEvD,MAAA,MAAM,QAAA,GAAW,MAAA,CAAO,WAAA,CAAY,KAAA,CAAM,IAAI,CAAA;AAG9C,MAAA,QAAA,CAAS,SAAA,CAAU,KAAA,CAAM,MAAA,EAAQ,WAAW,CAAA;AAG5C,MAAA,IAAI,KAAA,EAAO,SAAS,MAAA,EAAQ;AAC3B,QAAA,IAAA,CAAK,SAAA,CAAU,QAAA,EAAU,KAAA,CAAM,QAAA,EAAU,aAAa,WAAW,CAAA;AAAA,MAClE;AAGA,MAAA,IAAI,KAAK,WAAA,EAAa;AACrB,QAAA,QAAA;AAAA,UACC,wBAAA,CAAwB,IAAA;AAAA,UACxB,CAAA,eAAA,EAAkB,KAAA,CAAM,MAAM,CAAA,CAAA,EAAI,WAAW,CAAA;AAAA,SAC9C;AAAA,MACD;AAAA,IACD,CAAC,CAAA;AAAA,EACF;AACD","file":"api-gateway.js","sourcesContent":["import { Construct } from 'constructs';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { HttpMethod } from 'aws-cdk-lib/aws-apigatewayv2';\nimport { CfnOutput, RemovalPolicy, Size } from 'aws-cdk-lib';\nimport {\n\tCors,\n\tIResource,\n\tLambdaIntegration,\n\tRestApi,\n\tRestApiProps,\n} from 'aws-cdk-lib/aws-apigateway';\n\nimport { printLog } from '@incloodsolutions/toolkit';\n\nimport { IBaseCdkConstructProps, IBaseConstruct } from '../../types';\n\n/**\n * Route definition for API Gateway resources\n *\n * Supports hierarchical route structures using `children`\n */\ninterface IRouteOption {\n\t/** Path segment (e.g. 'users', 'orders') */\n\tname: string;\n\n\t/** HTTP method for the route */\n\tmethod: `${HttpMethod}`;\n\n\t/** Nested routes under this path */\n\tchildren?: IRouteOption[];\n}\n\n/**\n * Props for BaseApiGatewayConstruct\n *\n * Provides configuration for:\n * - REST API (API Gateway v1)\n * - Route definitions\n * - Lambda handler\n */\ninterface IApiGatewayConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** REST API configuration options */\n\t\treadonly gatewayOptions: RestApiProps;\n\n\t\t/** Route definitions used to build API resources */\n\t\treadonly routeOptions: IRouteOption[];\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda function handling all API routes\n\t *\n\t * Note:\n\t * A single Lambda integration is reused across all routes\n\t */\n\treadonly handlerFunction: Function;\n}\n\n/**\n * CDK construct for REST API Gateway with Lambda integration\n *\n * Responsibilities:\n * - Creates a REST API with configurable options\n * - Applies default CORS and compression settings when not provided\n * - Recursively builds API resources from route definitions\n * - Exposes API base URL as a CloudFormation output\n */\nexport class BaseApiGatewayConstruct\n\textends Construct\n\timplements IBaseConstruct\n{\n\t/** The created REST API instance */\n\treadonly api: RestApi;\n\n\t/** Enables debug logging for route creation */\n\tenableDebug = false;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, routes, and Lambda handler\n\t */\n\tconstructor(scope: Construct, id: string, props: IApiGatewayConstructProps) {\n\t\tsuper(scope, id);\n\n\t\tthis.enableDebug = props.enableDebug;\n\n\t\tthis.api = new RestApi(this, id, {\n\t\t\t...props?.options?.gatewayOptions,\n\n\t\t\t/** Default API description if not provided */\n\t\t\tdescription:\n\t\t\t\tprops?.options?.gatewayOptions?.description ||\n\t\t\t\t'This is a REST API using CDK',\n\n\t\t\t/**\n\t\t\t * CORS configuration\n\t\t\t * Falls back to allowing all origins, methods, and standard headers\n\t\t\t */\n\t\t\tdefaultCorsPreflightOptions: {\n\t\t\t\t...props?.options?.gatewayOptions?.defaultCorsPreflightOptions,\n\n\t\t\t\t/** Allow all origins by default */\n\t\t\t\tallowOrigins:\n\t\t\t\t\tprops?.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowOrigins || Cors.ALL_ORIGINS,\n\n\t\t\t\t/** Allow all HTTP methods by default */\n\t\t\t\tallowMethods:\n\t\t\t\t\tprops?.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowMethods || Cors.ALL_METHODS,\n\n\t\t\t\t/** Merge default headers with user-defined headers */\n\t\t\t\tallowHeaders: [\n\t\t\t\t\t...props.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowHeaders,\n\t\t\t\t\t'Content-Type',\n\t\t\t\t\t'Accept',\n\t\t\t\t\t'X-Amz-Date',\n\t\t\t\t\t'Authorization',\n\t\t\t\t\t'X-Api-Key',\n\t\t\t\t\t'X-Amz-Security-Token',\n\t\t\t\t\t'X-Amz-User-Agent',\n\t\t\t\t],\n\t\t\t},\n\n\t\t\t/** Minimum payload size (in bytes) before compression is applied */\n\t\t\tminCompressionSize:\n\t\t\t\tprops?.options?.gatewayOptions?.minCompressionSize || Size.bytes(1),\n\t\t});\n\n\t\t/**\n\t\t * Register routes if provided\n\t\t */\n\t\tif (props?.options?.routeOptions?.length && props?.handlerFunction) {\n\t\t\tconst integration = new LambdaIntegration(props.handlerFunction);\n\n\t\t\t/**\n\t\t\t * Attach routes recursively starting from API root\n\t\t\t */\n\t\t\tthis.addRoutes(this.api.root, props.options.routeOptions, integration);\n\t\t}\n\n\t\t/**\n\t\t * Apply removal policy (useful for non-production environments)\n\t\t */\n\t\tthis.api.applyRemovalPolicy(RemovalPolicy.DESTROY);\n\n\t\t/**\n\t\t * CloudFormation output exposing API base URL\n\t\t */\n\t\tnew CfnOutput(this, 'ApiGateway', {\n\t\t\tvalue: this.api.url,\n\t\t});\n\t}\n\n\t/**\n\t * Recursively attaches routes to the API Gateway\n\t *\n\t * Behaviour:\n\t * - Creates a resource for each route segment\n\t * - Attaches method + Lambda integration\n\t * - Traverses child routes for nested paths\n\t *\n\t * @param parent Parent API resource\n\t * @param routes Route definitions\n\t * @param integration Lambda integration applied to each route\n\t * @param previousPath Accumulated path (used for debug logging)\n\t * @private\n\t */\n\tprivate addRoutes(\n\t\tparent: IResource,\n\t\troutes: IRouteOption[],\n\t\tintegration: LambdaIntegration,\n\t\tpreviousPath?: string,\n\t) {\n\t\troutes.forEach((route) => {\n\t\t\tconst currentPath = `${previousPath || ''}/${route.name}`;\n\n\t\t\tconst resource = parent.addResource(route.name);\n\n\t\t\t/** Attach HTTP method with Lambda integration */\n\t\t\tresource.addMethod(route.method, integration);\n\n\t\t\t/** Recursively process child routes */\n\t\t\tif (route?.children.length) {\n\t\t\t\tthis.addRoutes(resource, route.children, integration, currentPath);\n\t\t\t}\n\n\t\t\t/** Optional debug logging */\n\t\t\tif (this.enableDebug) {\n\t\t\t\tprintLog(\n\t\t\t\t\tBaseApiGatewayConstruct.name,\n\t\t\t\t\t`Route created: ${route.method} ${currentPath}`,\n\t\t\t\t);\n\t\t\t}\n\t\t});\n\t}\n}\n"]}