@aligent/cdk-secure-rest-api 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @aligent/cdk-secure-rest-api
 
+## 1.1.2
+
+### Patch Changes
+
+- [#1688](https://github.com/aligent/cdk-constructs/pull/1688) [`5fc3de2`](https://github.com/aligent/cdk-constructs/commit/5fc3de2da74962c1e11a57a375fb11c71406d5c8) Thanks [@dependabot](https://github.com/apps/dependabot)! - chore(deps): bump the aws group across 1 directory with 10 updates
+
+## 1.1.1
+
+### Patch Changes
+
+- [#1689](https://github.com/aligent/cdk-constructs/pull/1689) [`6f1930f`](https://github.com/aligent/cdk-constructs/commit/6f1930f8d8b6d646252217a4c7363458bd22f597) Thanks [@toddhainsworth](https://github.com/toddhainsworth)! - Fix published artifact: declarations (`*.d.ts`) were missing from the tarball because the package had no `.npmignore`, so `npm pack` fell back to the workspace `.gitignore` (which excludes build outputs). Consumers with `isolatedModules: true` then resolved `index.ts` directly and hit `TS1205` on the type re-exports. This release adds the package's own `.npmignore` (matching sibling packages) and converts the type re-exports in `index.ts` to `export type`.
+
 ## 1.1.0
 
 ### Minor Changes

package/index.d.ts

@@ -0,0 +1,3 @@
+import { SecureRestApi, SecureRestApiProps, SecureRestApiRoute } from "./lib/secure-rest-api";
+export { SecureRestApi };
+export type { SecureRestApiProps, SecureRestApiRoute };

package/index.js

@@ -3,4 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SecureRestApi = void 0;
 const secure_rest_api_1 = require("./lib/secure-rest-api");
 Object.defineProperty(exports, "SecureRestApi", { enumerable: true, get: function () { return secure_rest_api_1.SecureRestApi; } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyREFJK0I7QUFFdEIsOEZBTFAsK0JBQWEsT0FLTyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7XG4gIFNlY3VyZVJlc3RBcGksXG4gIFNlY3VyZVJlc3RBcGlQcm9wcyxcbiAgU2VjdXJlUmVzdEFwaVJvdXRlLFxufSBmcm9tIFwiLi9saWIvc2VjdXJlLXJlc3QtYXBpXCI7XG5cbmV4cG9ydCB7IFNlY3VyZVJlc3RBcGksIFNlY3VyZVJlc3RBcGlQcm9wcywgU2VjdXJlUmVzdEFwaVJvdXRlIH07XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyREFJK0I7QUFFdEIsOEZBTFAsK0JBQWEsT0FLTyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7XG4gIFNlY3VyZVJlc3RBcGksXG4gIFNlY3VyZVJlc3RBcGlQcm9wcyxcbiAgU2VjdXJlUmVzdEFwaVJvdXRlLFxufSBmcm9tIFwiLi9saWIvc2VjdXJlLXJlc3QtYXBpXCI7XG5cbmV4cG9ydCB7IFNlY3VyZVJlc3RBcGkgfTtcbmV4cG9ydCB0eXBlIHsgU2VjdXJlUmVzdEFwaVByb3BzLCBTZWN1cmVSZXN0QXBpUm91dGUgfTtcbiJdfQ==

package/lib/secure-rest-api.d.ts

@@ -0,0 +1,58 @@
+import { ApiKey, Integration, RestApi, UsagePlan } from "aws-cdk-lib/aws-apigateway";
+import { HttpMethod } from "aws-cdk-lib/aws-apigatewayv2";
+import { Construct } from "constructs";
+export interface SecureRestApiRoute {
+    path: string;
+    methods: HttpMethod[];
+    integration: Integration;
+}
+export interface SecureRestApiProps {
+    /**
+     * The name of the API.
+     */
+    apiName: string;
+    /**
+     * Description for the API.
+     */
+    description?: string;
+    /**
+     * CORS configuration.
+     *
+     * `allowOrigins` overrides the default (all origins).
+     * `additionalMethods` and `additionalHeaders` are appended to the defaults
+     * (GET/OPTIONS and Content-Type/X-Api-Key respectively).
+     */
+    corsOptions?: {
+        allowOrigins?: string[];
+        additionalMethods?: string[];
+        additionalHeaders?: string[];
+    };
+    /**
+     * Routes to register on the API.
+     */
+    routes: SecureRestApiRoute[];
+    /**
+     * Throttling limits for the usage plan.
+     * @default { rateLimit: 100, burstLimit: 200 }
+     */
+    throttle?: {
+        rateLimit: number;
+        burstLimit: number;
+    };
+    /**
+     * Override the generated API key name.
+     * @default `{apiName}-api-key`
+     */
+    apiKeyName?: string;
+    /**
+     * Override the generated usage plan name.
+     * @default `{apiName}-usage-plan`
+     */
+    usagePlanName?: string;
+}
+export declare class SecureRestApi extends Construct {
+    readonly api: RestApi;
+    readonly apiKey: ApiKey;
+    readonly usagePlan: UsagePlan;
+    constructor(scope: Construct, id: string, props: SecureRestApiProps);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aligent/cdk-secure-rest-api",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "A CDK construct for creating API Gateway REST APIs secured with API Key authentication and usage plan throttling",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,8 +20,8 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.10",
-    "@types/node": "^20.19.39",
-    "aws-cdk": "^2.1120.0",
+    "@types/node": "^24.12.4",
+    "aws-cdk": "^2.1124.1",
     "jest": "^29.7.0",
     "ts-jest": "^29.4.9",
     "ts-node": "^10.9.1",

package/index.ts

@@ -1,7 +0,0 @@
-import {
-  SecureRestApi,
-  SecureRestApiProps,
-  SecureRestApiRoute,
-} from "./lib/secure-rest-api";
-
-export { SecureRestApi, SecureRestApiProps, SecureRestApiRoute };

package/jest.config.ts

@@ -1,11 +0,0 @@
-/* eslint-disable */
-export default {
-  displayName: "secure-rest-api",
-  preset: "../../../jest.preset.js",
-  testEnvironment: "node",
-  transform: {
-    "^.+\\.[tj]s$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.spec.json" }],
-  },
-  moduleFileExtensions: ["ts", "js", "html"],
-  coverageDirectory: "../../../coverage/packages/secure-rest-api",
-};

package/lib/secure-rest-api.test.ts

@@ -1,308 +0,0 @@
-import { App, Stack } from "aws-cdk-lib";
-import { Template } from "aws-cdk-lib/assertions";
-import { LambdaIntegration, MockIntegration } from "aws-cdk-lib/aws-apigateway";
-import { HttpMethod } from "aws-cdk-lib/aws-apigatewayv2";
-import { Function, InlineCode, Runtime } from "aws-cdk-lib/aws-lambda";
-import { Construct } from "constructs";
-import { SecureRestApi } from "./secure-rest-api";
-
-const createStack = () => {
-  const app = new App();
-  const stack = new Stack(app, "TestStack");
-  return { app, stack };
-};
-
-const mockIntegration = () =>
-  new MockIntegration({
-    integrationResponses: [{ statusCode: "200" }],
-  });
-
-const lambdaIntegration = (scope: Construct) => {
-  const fn = new Function(scope, "Handler", {
-    runtime: Runtime.NODEJS_22_X,
-    handler: "index.handler",
-    code: InlineCode.fromInline("exports.handler = () => {}"),
-  });
-  return new LambdaIntegration(fn);
-};
-
-describe("SecureRestApi", () => {
-  describe("API Gateway", () => {
-    it("creates a REST API with the given name", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::RestApi",
-        { Name: "my-api" }
-      );
-    });
-
-    it("uses the provided description", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        description: "Custom description",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::RestApi",
-        { Description: "Custom description" }
-      );
-    });
-
-    it("registers each route method with apiKeyRequired", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET, HttpMethod.POST],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      const template = Template.fromStack(stack);
-      template.hasResourceProperties("AWS::ApiGateway::Method", {
-        HttpMethod: "GET",
-        ApiKeyRequired: true,
-      });
-      template.hasResourceProperties("AWS::ApiGateway::Method", {
-        HttpMethod: "POST",
-        ApiKeyRequired: true,
-      });
-    });
-
-    it("accepts a LambdaIntegration as route integration", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: lambdaIntegration(stack),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).resourceCountIs("AWS::Lambda::Function", 1);
-    });
-  });
-
-  describe("API Key", () => {
-    it("creates an API key with a default name", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::ApiKey",
-        { Name: "my-api-api-key" }
-      );
-    });
-
-    it("uses a custom API key name when provided", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        apiKeyName: "custom-key",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::ApiKey",
-        { Name: "custom-key" }
-      );
-    });
-  });
-
-  describe("Usage Plan", () => {
-    it("creates a usage plan with default throttle settings", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::UsagePlan",
-        {
-          Throttle: {
-            BurstLimit: 200,
-            RateLimit: 100,
-          },
-        }
-      );
-    });
-
-    it("uses custom throttle settings when provided", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        throttle: { rateLimit: 50, burstLimit: 100 },
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::UsagePlan",
-        {
-          Throttle: {
-            BurstLimit: 100,
-            RateLimit: 50,
-          },
-        }
-      );
-    });
-
-    it("uses a custom usage plan name when provided", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        usagePlanName: "custom-plan",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::UsagePlan",
-        { UsagePlanName: "custom-plan" }
-      );
-    });
-  });
-
-  describe("CORS", () => {
-    it("applies default CORS settings", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::Method",
-        { HttpMethod: "OPTIONS" }
-      );
-    });
-
-    it("appends additionalHeaders to the defaults", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        corsOptions: { additionalHeaders: ["Authorization"] },
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      // OPTIONS mock integration response headers include the allow-headers value
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::Method",
-        {
-          HttpMethod: "OPTIONS",
-          Integration: {
-            IntegrationResponses: [
-              {
-                ResponseParameters: {
-                  "method.response.header.Access-Control-Allow-Headers":
-                    "'Content-Type,X-Api-Key,Authorization'",
-                },
-              },
-            ],
-          },
-        }
-      );
-    });
-
-    it("appends additionalMethods to the defaults", () => {
-      const { stack } = createStack();
-      new SecureRestApi(stack, "Api", {
-        apiName: "my-api",
-        corsOptions: { additionalMethods: ["POST"] },
-        routes: [
-          {
-            path: "items",
-            methods: [HttpMethod.GET],
-            integration: mockIntegration(),
-          },
-        ],
-      });
-
-      Template.fromStack(stack).hasResourceProperties(
-        "AWS::ApiGateway::Method",
-        {
-          HttpMethod: "OPTIONS",
-          Integration: {
-            IntegrationResponses: [
-              {
-                ResponseParameters: {
-                  "method.response.header.Access-Control-Allow-Methods":
-                    "'GET,OPTIONS,POST'",
-                },
-              },
-            ],
-          },
-        }
-      );
-    });
-  });
-});

package/lib/secure-rest-api.ts

@@ -1,129 +0,0 @@
-import {
-  ApiKey,
-  Cors,
-  Integration,
-  IRestApi,
-  RestApi,
-  UsagePlan,
-} from "aws-cdk-lib/aws-apigateway";
-import { HttpMethod } from "aws-cdk-lib/aws-apigatewayv2";
-import { Construct } from "constructs";
-
-export interface SecureRestApiRoute {
-  path: string;
-  methods: HttpMethod[];
-  integration: Integration;
-}
-
-export interface SecureRestApiProps {
-  /**
-   * The name of the API.
-   */
-  apiName: string;
-
-  /**
-   * Description for the API.
-   */
-  description?: string;
-
-  /**
-   * CORS configuration.
-   *
-   * `allowOrigins` overrides the default (all origins).
-   * `additionalMethods` and `additionalHeaders` are appended to the defaults
-   * (GET/OPTIONS and Content-Type/X-Api-Key respectively).
-   */
-  corsOptions?: {
-    allowOrigins?: string[];
-    additionalMethods?: string[];
-    additionalHeaders?: string[];
-  };
-
-  /**
-   * Routes to register on the API.
-   */
-  routes: SecureRestApiRoute[];
-
-  /**
-   * Throttling limits for the usage plan.
-   * @default { rateLimit: 100, burstLimit: 200 }
-   */
-  throttle?: {
-    rateLimit: number;
-    burstLimit: number;
-  };
-
-  /**
-   * Override the generated API key name.
-   * @default `{apiName}-api-key`
-   */
-  apiKeyName?: string;
-
-  /**
-   * Override the generated usage plan name.
-   * @default `{apiName}-usage-plan`
-   */
-  usagePlanName?: string;
-}
-
-export class SecureRestApi extends Construct {
-  public readonly api: RestApi;
-  public readonly apiKey: ApiKey;
-  public readonly usagePlan: UsagePlan;
-
-  constructor(scope: Construct, id: string, props: SecureRestApiProps) {
-    super(scope, id);
-
-    const {
-      apiName,
-      description,
-      corsOptions,
-      routes,
-      throttle = { rateLimit: 100, burstLimit: 200 },
-      apiKeyName,
-      usagePlanName,
-    } = props;
-
-    this.api = new RestApi(this, "Api", {
-      restApiName: apiName,
-      description: description ?? `REST API for ${apiName} service`,
-      defaultCorsPreflightOptions: {
-        allowOrigins: corsOptions?.allowOrigins ?? Cors.ALL_ORIGINS,
-        allowMethods: [
-          "GET",
-          "OPTIONS",
-          ...(corsOptions?.additionalMethods ?? []),
-        ],
-        allowHeaders: [
-          "Content-Type",
-          "X-Api-Key",
-          ...(corsOptions?.additionalHeaders ?? []),
-        ],
-      },
-    });
-
-    for (const route of routes) {
-      const resource = this.api.root.addResource(route.path.replace(/^\//, ""));
-      for (const method of route.methods) {
-        resource.addMethod(method, route.integration, { apiKeyRequired: true });
-      }
-    }
-
-    this.apiKey = new ApiKey(this, "ApiKey", {
-      description: `API Key for ${apiName} service`,
-      apiKeyName: apiKeyName ?? `${apiName}-api-key`,
-    });
-
-    this.usagePlan = new UsagePlan(this, "UsagePlan", {
-      name: usagePlanName ?? `${apiName}-usage-plan`,
-      description: `Usage plan for ${apiName} service`,
-      throttle,
-    });
-
-    this.usagePlan.addApiStage({
-      api: this.api as IRestApi,
-      stage: this.api.deploymentStage,
-    });
-    this.usagePlan.addApiKey(this.apiKey);
-  }
-}

package/project.json

@@ -1,36 +0,0 @@
-{
-  "name": "secure-rest-api",
-  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/constructs/secure-rest-api/lib",
-  "projectType": "application",
-  "targets": {
-    "build": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "tsc --project tsconfig.app.json",
-        "cwd": "packages/constructs/secure-rest-api"
-      }
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint",
-      "outputs": ["{options.outputFile}"]
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "jestConfig": "packages/constructs/secure-rest-api/jest.config.ts",
-        "passWithNoTests": true
-      }
-    },
-    "publish": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "npm publish --access public",
-        "cwd": "packages/constructs/secure-rest-api"
-      },
-      "dependsOn": ["build"]
-    }
-  },
-  "tags": []
-}

package/tsconfig.app.json

@@ -1,11 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": ".",
-    "rootDir": ".",
-    "module": "commonjs",
-    "types": ["node"]
-  },
-  "exclude": ["./jest.config.ts", "**/*.test.ts", "**/*.spec.ts"],
-  "include": ["lib/**/*.ts", "index.ts"]
-}

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.app.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ],
-  "compilerOptions": {
-    "esModuleInterop": true
-  }
-}

package/tsconfig.spec.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "module": "commonjs",
-    "types": ["jest", "node"]
-  }
-}