@composurecdk/apigateway 0.6.0 → 0.8.0

package/dist/commonjs/spec-rest-api-builder.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSpecRestApiBuilder = createSpecRestApiBuilder;
+const aws_apigateway_1 = require("aws-cdk-lib/aws-apigateway");
+const core_1 = require("@composurecdk/core");
+const cloudformation_1 = require("@composurecdk/cloudformation");
+const cloudwatch_1 = require("@composurecdk/cloudwatch");
+const defaults_js_1 = require("./defaults.js");
+const deploy_options_js_1 = require("./deploy-options.js");
+const rest_api_alarms_js_1 = require("./rest-api-alarms.js");
+class SpecRestApiBuilder {
+    props = {};
+    #customAlarms = [];
+    addAlarm(key, configure) {
+        this.#customAlarms.push(configure(new cloudwatch_1.AlarmDefinitionBuilder(key)));
+        return this;
+    }
+    /** @internal — see ADR-0005. */
+    [core_1.COPY_STATE](target) {
+        target.#customAlarms.push(...this.#customAlarms);
+    }
+    build(scope, id) {
+        const { accessLogging, recommendedAlarms: alarmConfig, ...specRestApiProps } = this.props;
+        const { accessLogGroup, deployOptions } = (0, deploy_options_js_1.resolveDeployOptions)(scope, id, accessLogging, defaults_js_1.SPEC_REST_API_DEFAULTS.deployOptions ?? {}, specRestApiProps.deployOptions ?? {});
+        const api = new aws_apigateway_1.SpecRestApi(scope, id, {
+            ...specRestApiProps,
+            deployOptions,
+        });
+        const alarms = (0, rest_api_alarms_js_1.createRestApiAlarms)(scope, id, api, alarmConfig, this.#customAlarms);
+        return { api, accessLogGroup, alarms };
+    }
+}
+/**
+ * Creates a new {@link ISpecRestApiBuilder} for configuring an API Gateway
+ * REST API from an OpenAPI specification.
+ *
+ * This is the entry point for defining a spec-driven REST API component. The
+ * returned builder exposes every {@link SpecRestApiProps} property as a fluent
+ * setter/getter. It implements {@link Lifecycle} for use with {@link compose}.
+ *
+ * The API structure — resources, methods, and integrations — is defined
+ * entirely by the OpenAPI specification passed to {@link apiDefinition}.
+ * Use CDK's {@link ApiDefinition} static methods to load the spec from an
+ * inline object, a local file, or an S3 bucket.
+ *
+ * @returns A fluent builder for a spec-driven API Gateway REST API.
+ *
+ * @example
+ * ```ts
+ * // From a local OpenAPI file
+ * const api = createSpecRestApiBuilder()
+ *   .restApiName("PetStore")
+ *   .apiDefinition(ApiDefinition.fromAsset("openapi/petstore.yaml"));
+ *
+ * // From an inline definition
+ * const api = createSpecRestApiBuilder()
+ *   .restApiName("PetStore")
+ *   .apiDefinition(ApiDefinition.fromInline({
+ *     openapi: "3.0.2",
+ *     info: { title: "PetStore", version: "1.0" },
+ *     paths: { "/pets": { get: { ... } } },
+ *   }));
+ *
+ * // Compose into a system
+ * const system = compose(
+ *   { api },
+ *   { api: [] },
+ * );
+ * ```
+ */
+function createSpecRestApiBuilder() {
+    return (0, cloudformation_1.taggedBuilder)(SpecRestApiBuilder);
+}
+//# sourceMappingURL=spec-rest-api-builder.js.map

package/dist/commonjs/spec-rest-api-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec-rest-api-builder.js","sourceRoot":"","sources":["../../src/spec-rest-api-builder.ts"],"names":[],"mappings":";;AA2HA,4DAEC;AA7HD,+DAAkG;AAElG,6CAAgE;AAChE,iEAAkF;AAClF,yDAAkE;AAElE,+CAAuD;AACvD,2DAA2D;AAC3D,6DAA2D;AAuC3D,MAAM,kBAAkB;IACtB,KAAK,GAAqC,EAAE,CAAC;IACpC,aAAa,GAA0C,EAAE,CAAC;IAEnE,QAAQ,CACN,GAAW,EACX,SAA8F;QAE9F,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,mCAAsB,CAAc,GAAG,CAAC,CAAC,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gCAAgC;IAChC,CAAC,iBAAU,CAAC,CAAC,MAA0B;QACrC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,KAAiB,EAAE,EAAU;QACjC,MAAM,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1F,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,IAAA,wCAAoB,EAC5D,KAAK,EACL,EAAE,EACF,aAAa,EACb,oCAAsB,CAAC,aAAa,IAAI,EAAE,EAC1C,gBAAgB,CAAC,aAAa,IAAI,EAAE,CACrC,CAAC;QAEF,MAAM,GAAG,GAAG,IAAI,4BAAW,CAAC,KAAK,EAAE,EAAE,EAAE;YACrC,GAAG,gBAAgB;YACnB,aAAa;SACM,CAAC,CAAC;QAEvB,MAAM,MAAM,GAAG,IAAA,wCAAmB,EAAC,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpF,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC;IACzC,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,wBAAwB;IACtC,OAAO,IAAA,8BAAa,EAA8C,kBAAkB,CAAC,CAAC;AACxF,CAAC"}

package/dist/esm/alarm-config.d.ts

@@ -0,0 +1,47 @@
+import type { AlarmConfig } from "@composurecdk/cloudwatch";
+/**
+ * Controls which recommended alarms are created for an API Gateway REST API.
+ * All applicable alarms are enabled by default with AWS-recommended thresholds.
+ * Set individual alarms to `false` to disable them, or provide an
+ * {@link AlarmConfig} to tune thresholds.
+ *
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway
+ */
+export interface RestApiAlarmConfig {
+    /**
+     * Master switch: set to `false` to disable all recommended alarms.
+     * Individual alarms can also be disabled via their own entry.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Alarm when the API returns an elevated rate of client-side errors
+     * (4XX HTTP status codes).
+     *
+     * Metric: `AWS/ApiGateway 4XXError`, statistic Average, period 1 minute.
+     * Default threshold: > 0.05 (5% of requests).
+     *
+     * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway
+     */
+    clientError?: AlarmConfig | false;
+    /**
+     * Alarm when the API returns an elevated rate of server-side errors
+     * (5XX HTTP status codes).
+     *
+     * Metric: `AWS/ApiGateway 5XXError`, statistic Average, period 1 minute.
+     * Default threshold: > 0.05 (5% of requests).
+     *
+     * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway
+     */
+    serverError?: AlarmConfig | false;
+    /**
+     * Alarm when API latency is elevated.
+     *
+     * Metric: `AWS/ApiGateway Latency`, statistic p90, period 1 minute.
+     * Default threshold: >= 2500ms.
+     *
+     * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway
+     */
+    latency?: AlarmConfig | false;
+}
+//# sourceMappingURL=alarm-config.d.ts.map

package/dist/esm/alarm-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alarm-config.d.ts","sourceRoot":"","sources":["../../src/alarm-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE5D;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,KAAK,CAAC;IAElC;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,KAAK,CAAC;IAElC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,KAAK,CAAC;CAC/B"}

package/dist/esm/alarm-config.js.map

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

package/dist/esm/alarm-defaults.d.ts

@@ -0,0 +1,15 @@
+import type { AlarmConfigDefaults } from "@composurecdk/cloudwatch";
+interface RestApiAlarmDefaults {
+    enabled: true;
+    clientError: AlarmConfigDefaults;
+    serverError: AlarmConfigDefaults;
+    latency: AlarmConfigDefaults;
+}
+/**
+ * AWS-recommended default alarm configuration for API Gateway REST APIs.
+ *
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway
+ */
+export declare const REST_API_ALARM_DEFAULTS: RestApiAlarmDefaults;
+export {};
+//# sourceMappingURL=alarm-defaults.d.ts.map

package/dist/esm/alarm-defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alarm-defaults.d.ts","sourceRoot":"","sources":["../../src/alarm-defaults.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,UAAU,oBAAoB;IAC5B,OAAO,EAAE,IAAI,CAAC;IACd,WAAW,EAAE,mBAAmB,CAAC;IACjC,WAAW,EAAE,mBAAmB,CAAC;IACjC,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,oBAsCrC,CAAC"}

package/dist/esm/alarm-defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alarm-defaults.js","sourceRoot":"","sources":["../../src/alarm-defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAU9D;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAyB;IAC3D,OAAO,EAAE,IAAI;IAEb;;;;OAIG;IACH,WAAW,EAAE;QACX,SAAS,EAAE,IAAI;QACf,iBAAiB,EAAE,CAAC;QACpB,iBAAiB,EAAE,CAAC;QACpB,gBAAgB,EAAE,gBAAgB,CAAC,aAAa;KACjD;IAED;;;;OAIG;IACH,WAAW,EAAE;QACX,SAAS,EAAE,IAAI;QACf,iBAAiB,EAAE,CAAC;QACpB,iBAAiB,EAAE,CAAC;QACpB,gBAAgB,EAAE,gBAAgB,CAAC,aAAa;KACjD;IAED;;;;OAIG;IACH,OAAO,EAAE;QACP,SAAS,EAAE,IAAI;QACf,iBAAiB,EAAE,CAAC;QACpB,iBAAiB,EAAE,CAAC;QACpB,gBAAgB,EAAE,gBAAgB,CAAC,aAAa;KACjD;CACF,CAAC"}

package/dist/esm/builder-common.d.ts

@@ -0,0 +1,68 @@
+import type { Alarm } from "aws-cdk-lib/aws-cloudwatch";
+import type { RestApiBase } from "aws-cdk-lib/aws-apigateway";
+import type { LogGroup } from "aws-cdk-lib/aws-logs";
+import type { RestApiAlarmConfig } from "./alarm-config.js";
+/**
+ * Builder-specific properties shared by both {@link RestApiBuilderProps}
+ * and {@link SpecRestApiBuilderProps}.
+ */
+export interface RestApiBuilderPropsBase {
+    /**
+     * Whether to automatically create a CloudWatch log group for access logging.
+     *
+     * When `true`, the builder creates a log group using
+     * {@link createLogGroupBuilder} (with its secure defaults) and configures it
+     * as the stage's access log destination with JSON-formatted output. The
+     * created log group is returned in the build result as `accessLogGroup`.
+     *
+     * When `false`, no access log group is created. You can still provide your
+     * own destination via `deployOptions.accessLogDestination`.
+     *
+     * This setting is ignored when `deployOptions.accessLogDestination` is
+     * provided — the user-supplied destination takes precedence.
+     */
+    accessLogging?: boolean;
+    /**
+     * Configuration for AWS-recommended CloudWatch alarms.
+     *
+     * By default, the builder creates recommended alarms for client error rate,
+     * server error rate, and latency. Individual alarms can be customized or
+     * disabled. Set to `false` to disable all alarms.
+     *
+     * No alarm actions are configured by default since notification
+     * methods are user-specific. Access alarms from the build result
+     * or use an `afterBuild` hook to apply actions.
+     *
+     * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway
+     */
+    recommendedAlarms?: RestApiAlarmConfig | false;
+}
+/**
+ * Build result properties shared by both {@link RestApiBuilderResult}
+ * and {@link SpecRestApiBuilderResult}.
+ *
+ * @typeParam T - The concrete REST API type (`RestApi` or `SpecRestApi`).
+ */
+export interface RestApiBuilderResultBase<T extends RestApiBase> {
+    /** The REST API construct created by the builder. */
+    api: T;
+    /**
+     * The CloudWatch log group created for access logging, or `undefined` if
+     * access logging was disabled or the user provided their own destination.
+     */
+    accessLogGroup?: LogGroup;
+    /**
+     * CloudWatch alarms created for the API, keyed by alarm name.
+     *
+     * Includes both AWS-recommended alarms and any custom alarms added
+     * via `addAlarm()`. Access individual alarms by key
+     * (e.g., `result.alarms.serverError`).
+     *
+     * No alarm actions are configured — apply them via the result or an
+     * `afterBuild` hook.
+     *
+     * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway
+     */
+    alarms: Record<string, Alarm>;
+}
+//# sourceMappingURL=builder-common.d.ts.map

package/dist/esm/builder-common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder-common.d.ts","sourceRoot":"","sources":["../../src/builder-common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAAE,kBAAkB,GAAG,KAAK,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,WAAW;IAC7D,qDAAqD;IACrD,GAAG,EAAE,CAAC,CAAC;IAEP;;;OAGG;IACH,cAAc,CAAC,EAAE,QAAQ,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAC/B"}

package/dist/esm/builder-common.js.map

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

package/dist/esm/defaults.d.ts

@@ -0,0 +1,22 @@
+import { type StageOptions } from "aws-cdk-lib/aws-apigateway";
+import type { RestApiBuilderProps } from "./rest-api-builder.js";
+import type { SpecRestApiBuilderProps } from "./spec-rest-api-builder.js";
+/**
+ * Secure, AWS-recommended deploy-stage defaults shared by all API Gateway
+ * builders. Each property can be individually overridden via the builder's
+ * fluent API.
+ */
+export declare const DEPLOY_OPTIONS_DEFAULTS: StageOptions;
+/**
+ * Secure, AWS-recommended defaults applied to every REST API built with
+ * {@link createRestApiBuilder}. Each property can be individually overridden
+ * via the builder's fluent API.
+ */
+export declare const REST_API_DEFAULTS: Partial<RestApiBuilderProps>;
+/**
+ * Secure, AWS-recommended defaults applied to every spec-driven REST API
+ * built with {@link createSpecRestApiBuilder}. Each property can be
+ * individually overridden via the builder's fluent API.
+ */
+export declare const SPEC_REST_API_DEFAULTS: Partial<SpecRestApiBuilderProps>;
+//# sourceMappingURL=defaults.d.ts.map

package/dist/esm/defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,YAAY,EAAE,MAAM,4BAA4B,CAAC;AACnF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,YAmBrC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAO,CAAC,mBAAmB,CAU1D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,EAAE,OAAO,CAAC,uBAAuB,CAQnE,CAAC"}

package/dist/esm/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../src/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAqB,MAAM,4BAA4B,CAAC;AAInF;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAiB;IACnD;;;OAGG;IACH,cAAc,EAAE,IAAI;IAEpB;;;OAGG;IACH,YAAY,EAAE,kBAAkB,CAAC,IAAI;IAErC;;;;OAIG;IACH,gBAAgB,EAAE,KAAK;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAiC;IAC7D;;;;;OAKG;IACH,aAAa,EAAE,IAAI;IAEnB,aAAa,EAAE,uBAAuB;CACvC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAqC;IACtE;;;OAGG;IACH,aAAa,EAAE,IAAI;IAEnB,aAAa,EAAE,uBAAuB;CACvC,CAAC"}

package/dist/esm/deploy-options.d.ts

@@ -0,0 +1,17 @@
+import { type StageOptions } from "aws-cdk-lib/aws-apigateway";
+import { type LogGroup } from "aws-cdk-lib/aws-logs";
+import { type IConstruct } from "constructs";
+interface AccessLoggingResult {
+    accessLogGroup?: LogGroup;
+    deployOptions: StageOptions;
+}
+/**
+ * Resolves access logging configuration and merges deploy options with
+ * the provided defaults. Shared by {@link RestApiBuilder} and
+ * {@link SpecRestApiBuilder}.
+ *
+ * @internal
+ */
+export declare function resolveDeployOptions(scope: IConstruct, id: string, accessLogging: boolean | undefined, defaults: StageOptions, userDeployOptions: StageOptions): AccessLoggingResult;
+export {};
+//# sourceMappingURL=deploy-options.d.ts.map

package/dist/esm/deploy-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-options.d.ts","sourceRoot":"","sources":["../../src/deploy-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,YAAY,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,UAAU,mBAAmB;IAC3B,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,aAAa,EAAE,YAAY,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,UAAU,EACjB,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,OAAO,GAAG,SAAS,EAClC,QAAQ,EAAE,YAAY,EACtB,iBAAiB,EAAE,YAAY,GAC9B,mBAAmB,CAsBrB"}

package/dist/esm/deploy-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-options.js","sourceRoot":"","sources":["../../src/deploy-options.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,sBAAsB,GAEvB,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAO3D;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAiB,EACjB,EAAU,EACV,aAAkC,EAClC,QAAsB,EACtB,iBAA+B;IAE/B,MAAM,aAAa,GAAG,CAAC,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;IAEzF,IAAI,cAAoC,CAAC;IACzC,IAAI,cAAc,GAAG,EAAE,CAAC;IAExB,IAAI,aAAa,EAAE,CAAC;QAClB,cAAc,GAAG,qBAAqB,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC;QAClF,cAAc,GAAG;YACf,oBAAoB,EAAE,IAAI,sBAAsB,CAAC,cAAc,CAAC;YAChE,eAAe,EAAE,eAAe,CAAC,sBAAsB,EAAE;SAC1D,CAAC;IACJ,CAAC;IAED,OAAO;QACL,cAAc;QACd,aAAa,EAAE;YACb,GAAG,QAAQ;YACX,GAAG,cAAc;YACjB,GAAG,iBAAiB;SACrB;KACF,CAAC;AACJ,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+export { createRestApiBuilder, type RestApiBuilderProps, type RestApiBuilderResult, type IRestApiBuilder, } from "./rest-api-builder.js";
+export { type RestApiBuilderPropsBase } from "./builder-common.js";
+export { createSpecRestApiBuilder, type SpecRestApiBuilderProps, type SpecRestApiBuilderResult, type ISpecRestApiBuilder, } from "./spec-rest-api-builder.js";
+export { REST_API_DEFAULTS, SPEC_REST_API_DEFAULTS } from "./defaults.js";
+export { type RestApiAlarmConfig } from "./alarm-config.js";
+export { REST_API_ALARM_DEFAULTS } from "./alarm-defaults.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,eAAe,GACrB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EACL,wBAAwB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,GACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAIrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,wBAAwB,GAIzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAE1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/resource-builder.d.ts

@@ -0,0 +1,70 @@
+import { type Integration, type IResource, type MethodOptions } from "aws-cdk-lib/aws-apigateway";
+import { type Resolvable } from "@composurecdk/core";
+interface MethodDefinition {
+    httpMethod: string;
+    integration?: Resolvable<Integration>;
+    options?: MethodOptions;
+}
+interface ResourceDefinition {
+    methods: MethodDefinition[];
+    children: Map<string, ResourceDefinition>;
+}
+/**
+ * A declarative builder for defining API Gateway resources and methods.
+ *
+ * `ResourceBuilder` captures a tree of resource paths and HTTP methods as
+ * data. The tree is applied to actual CDK constructs during
+ * {@link RestApiBuilder.build}. Users do not construct `ResourceBuilder`
+ * directly — instances are provided via the {@link IRestApiBuilder.addResource}
+ * callback.
+ *
+ * @example
+ * ```ts
+ * createRestApiBuilder()
+ *   .addResource("users", users => users
+ *     .addMethod("GET", listIntegration)
+ *     .addResource("{id}", user => user
+ *       .addMethod("GET", getIntegration)
+ *       .addMethod("DELETE", deleteIntegration)
+ *     )
+ *   );
+ * ```
+ */
+export declare class ResourceBuilder {
+    /** @internal */
+    readonly definition: ResourceDefinition;
+    /**
+     * Adds an HTTP method to this resource.
+     *
+     * @param httpMethod - The HTTP verb (GET, POST, PUT, DELETE, etc.).
+     * @param integration - The backend integration for this method. Accepts a concrete
+     *   {@link Integration} or a {@link Ref} that resolves to one at build time.
+     * @param options - Additional method configuration such as authorization or method responses.
+     * @returns This builder for chaining.
+     */
+    addMethod(httpMethod: string, integration?: Resolvable<Integration>, options?: MethodOptions): this;
+    /**
+     * Adds a child resource under this resource.
+     *
+     * @param pathPart - The path segment for the child resource (e.g. "users" or "\{id\}").
+     * @param configure - Optional callback to configure the child resource's methods and nested resources.
+     * @returns This builder for chaining.
+     */
+    addResource(pathPart: string, configure?: (resource: ResourceBuilder) => void): this;
+    /**
+     * Copies this builder's resource tree onto `target`. Used by
+     * `RestApiBuilder.[COPY_STATE]` per ADR-0005's containers-fresh,
+     * elements-shared rule: the `methods` array and `children` Map are
+     * reconstructed on `target`, but `MethodDefinition` and child
+     * `ResourceDefinition` entries are shared by reference. Sharing the
+     * child entries is safe because the public API (`addResource`)
+     * replaces a child wholesale rather than mutating it in place.
+     *
+     * @internal
+     */
+    copyInto(target: ResourceBuilder): void;
+    /** @internal */
+    applyTo(resource: IResource, context?: Record<string, object>): void;
+}
+export {};
+//# sourceMappingURL=resource-builder.d.ts.map

package/dist/esm/resource-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-builder.d.ts","sourceRoot":"","sources":["../../src/resource-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAClG,OAAO,EAAW,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE9D,UAAU,gBAAgB;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,UAAU,kBAAkB;IAC1B,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;CAC3C;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAe;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAwC;IAE/E;;;;;;;;OAQG;IACH,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EACrC,OAAO,CAAC,EAAE,aAAa,GACtB,IAAI;IAKP;;;;;;OAMG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI;IASpF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAOvC,gBAAgB;IAChB,OAAO,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAAG,IAAI;CAczE"}

package/dist/{resource-builder.js → esm/resource-builder.js}

@@ -51,6 +51,23 @@ export class ResourceBuilder {
         this.definition.children.set(pathPart, child.definition);
         return this;
     }
+    /**
+     * Copies this builder's resource tree onto `target`. Used by
+     * `RestApiBuilder.[COPY_STATE]` per ADR-0005's containers-fresh,
+     * elements-shared rule: the `methods` array and `children` Map are
+     * reconstructed on `target`, but `MethodDefinition` and child
+     * `ResourceDefinition` entries are shared by reference. Sharing the
+     * child entries is safe because the public API (`addResource`)
+     * replaces a child wholesale rather than mutating it in place.
+     *
+     * @internal
+     */
+    copyInto(target) {
+        target.definition.methods.push(...this.definition.methods);
+        for (const [pathPart, childDef] of this.definition.children) {
+            target.definition.children.set(pathPart, childDef);
+        }
+    }
     /** @internal */
     applyTo(resource, context = {}) {
         for (const method of this.definition.methods) {

package/dist/esm/resource-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-builder.js","sourceRoot":"","sources":["../../src/resource-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAmB,MAAM,oBAAoB,CAAC;AAa9D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,eAAe;IAC1B,gBAAgB;IACP,UAAU,GAAuB,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IAE/E;;;;;;;;OAQG;IACH,SAAS,CACP,UAAkB,EAClB,WAAqC,EACrC,OAAuB;QAEvB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,QAAgB,EAAE,SAA+C;QAC3E,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,CAAC,KAAK,CAAC,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAuB;QAC9B,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC3D,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC5D,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,gBAAgB;IAChB,OAAO,CAAC,QAAmB,EAAE,UAAkC,EAAE;QAC/D,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YAC7C,MAAM,WAAW,GACf,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACrE,CAAC;QACD,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC5D,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YACrD,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAC;YAC3C,YAAY,CAAC,UAAU,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;YACnD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAChF,YAAY,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;CACF"}

package/dist/esm/rest-api-alarms.d.ts

@@ -0,0 +1,26 @@
+import { type Alarm } from "aws-cdk-lib/aws-cloudwatch";
+import type { RestApiBase } from "aws-cdk-lib/aws-apigateway";
+import type { IConstruct } from "constructs";
+import type { AlarmDefinition } from "@composurecdk/cloudwatch";
+import { AlarmDefinitionBuilder } from "@composurecdk/cloudwatch";
+import type { RestApiAlarmConfig } from "./alarm-config.js";
+/**
+ * Resolves the recommended alarm configuration into fully-resolved
+ * {@link AlarmDefinition}s for an API Gateway REST API.
+ */
+export declare function resolveRestApiAlarmDefinitions(api: RestApiBase, config: RestApiAlarmConfig | undefined): AlarmDefinition[];
+/**
+ * Creates AWS-recommended CloudWatch alarms for an API Gateway REST API,
+ * merging recommended definitions with any custom alarm builders.
+ *
+ * @param scope - CDK construct scope for creating alarm constructs.
+ * @param id - Base identifier for alarm construct ids.
+ * @param api - The REST API to create alarms for.
+ * @param config - User-provided alarm configuration, or `false` to disable all.
+ * @param customAlarms - Custom alarm builders added via `addAlarm()`.
+ * @returns A record mapping alarm keys to their created Alarm constructs.
+ *
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway
+ */
+export declare function createRestApiAlarms(scope: IConstruct, id: string, api: RestApiBase, config: RestApiAlarmConfig | false | undefined, customAlarms?: AlarmDefinitionBuilder<RestApiBase>[]): Record<string, Alarm>;
+//# sourceMappingURL=rest-api-alarms.d.ts.map

package/dist/esm/rest-api-alarms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-api-alarms.d.ts","sourceRoot":"","sources":["../../src/rest-api-alarms.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,KAAK,EAAqC,MAAM,4BAA4B,CAAC;AAC3F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAoC,MAAM,0BAA0B,CAAC;AACpG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAuB5D;;;GAGG;AACH,wBAAgB,8BAA8B,CAC5C,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,kBAAkB,GAAG,SAAS,GACrC,eAAe,EAAE,CAmDnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,UAAU,EACjB,EAAE,EAAE,MAAM,EACV,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,kBAAkB,GAAG,KAAK,GAAG,SAAS,EAC9C,YAAY,GAAE,sBAAsB,CAAC,WAAW,CAAC,EAAO,GACvD,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAUvB"}

package/dist/esm/rest-api-alarms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-api-alarms.js","sourceRoot":"","sources":["../../src/rest-api-alarms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAc,kBAAkB,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAI3F,OAAO,EAA0B,YAAY,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAEpG,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAE9D,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC1C,MAAM,mBAAmB,GAAG,GAAG,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC;AAE1E;;;GAGG;AACH,SAAS,SAAS,CAAC,GAAgB,EAAE,UAAkB,EAAE,SAAiB;IACxE,OAAO,IAAI,MAAM,CAAC;QAChB,SAAS,EAAE,gBAAgB;QAC3B,UAAU;QACV,aAAa,EAAE;YACb,OAAO,EAAE,GAAG,CAAC,WAAW;YACxB,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC,SAAS;SACrC;QACD,SAAS;QACT,MAAM,EAAE,aAAa;KACtB,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAC5C,GAAgB,EAChB,MAAsC;IAEtC,IAAI,MAAM,EAAE,OAAO,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IAEzC,MAAM,WAAW,GAAsB,EAAE,CAAC;IAE1C,IAAI,MAAM,EAAE,WAAW,KAAK,KAAK,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,kBAAkB,CAAC,MAAM,EAAE,WAAW,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;QACzF,WAAW,CAAC,IAAI,CAAC;YACf,GAAG,EAAE,aAAa;YAClB,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,MAAM,EAAE,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC;YACjD,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,kBAAkB,EAAE,kBAAkB,CAAC,sBAAsB;YAC7D,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;YACtC,WAAW,EAAE,wDAAwD,MAAM,CAAC,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,oBAAoB,mBAAmB,GAAG;SAC3I,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,WAAW,KAAK,KAAK,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,kBAAkB,CAAC,MAAM,EAAE,WAAW,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;QACzF,WAAW,CAAC,IAAI,CAAC;YACf,GAAG,EAAE,aAAa;YAClB,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,MAAM,EAAE,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC;YACjD,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,kBAAkB,EAAE,kBAAkB,CAAC,sBAAsB;YAC7D,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;YACtC,WAAW,EAAE,wDAAwD,MAAM,CAAC,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,oBAAoB,mBAAmB,GAAG;SAC3I,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,OAAO,KAAK,KAAK,EAAE,CAAC;QAC9B,MAAM,GAAG,GAAG,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;QACjF,WAAW,CAAC,IAAI,CAAC;YACf,GAAG,EAAE,SAAS;YACd,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,MAAM,EAAE,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YACvD,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,kBAAkB,EAAE,kBAAkB,CAAC,kCAAkC;YACzE,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;YACtC,WAAW,EAAE,mDAAmD,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,mBAAmB,GAAG;SACrH,CAAC,CAAC;IACL,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAiB,EACjB,EAAU,EACV,GAAgB,EAChB,MAA8C,EAC9C,eAAsD,EAAE;IAExD,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IAEhC,MAAM,OAAO,GAAG,MAAM,EAAE,OAAO,IAAI,uBAAuB,CAAC,OAAO,CAAC;IACnE,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IAExB,MAAM,WAAW,GAAG,8BAA8B,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAEvD,OAAO,YAAY,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;AAC9D,CAAC"}

package/dist/esm/rest-api-builder.d.ts

@@ -0,0 +1,116 @@
+import { type Integration, type MethodOptions, RestApi, type RestApiBase, type RestApiProps } from "aws-cdk-lib/aws-apigateway";
+import { type IConstruct } from "constructs";
+import { COPY_STATE, type Lifecycle, type Resolvable } from "@composurecdk/core";
+import { type ITaggedBuilder } from "@composurecdk/cloudformation";
+import { AlarmDefinitionBuilder } from "@composurecdk/cloudwatch";
+import type { RestApiBuilderPropsBase, RestApiBuilderResultBase } from "./builder-common.js";
+import { ResourceBuilder } from "./resource-builder.js";
+/**
+ * Configuration properties for the REST API builder.
+ *
+ * Extends the CDK {@link RestApiProps} with additional builder-specific options.
+ */
+export interface RestApiBuilderProps extends RestApiProps, RestApiBuilderPropsBase {
+}
+/**
+ * The build output of a {@link IRestApiBuilder}. Contains the CDK constructs
+ * created during {@link Lifecycle.build}, keyed by role.
+ */
+export type RestApiBuilderResult = RestApiBuilderResultBase<RestApi>;
+/**
+ * A fluent builder for configuring and creating an API Gateway REST API.
+ *
+ * Configuration properties from CDK {@link RestApiProps} are exposed as
+ * overloaded getter/setter methods via the builder proxy. The resource tree
+ * (paths and HTTP methods) is defined using {@link addResource} and
+ * {@link addMethod}, which accept the same arguments as their CDK equivalents.
+ *
+ * The builder implements {@link Lifecycle}, so it can be used directly as a
+ * component in a {@link compose | composed system}. When built, it creates
+ * a REST API with the configured properties and resource tree, and returns
+ * a {@link RestApiBuilderResult}.
+ *
+ * @example
+ * ```ts
+ * const api = createRestApiBuilder()
+ *   .restApiName("My Service")
+ *   .description("Public API")
+ *   .addResource("users", users => users
+ *     .addMethod("GET", listUsersIntegration)
+ *     .addResource("{id}", user => user
+ *       .addMethod("GET", getUserIntegration)
+ *     )
+ *   );
+ * ```
+ */
+export type IRestApiBuilder = ITaggedBuilder<RestApiBuilderProps, RestApiBuilder>;
+declare class RestApiBuilder implements Lifecycle<RestApiBuilderResult> {
+    #private;
+    props: Partial<RestApiBuilderProps>;
+    addAlarm(key: string, configure: (alarm: AlarmDefinitionBuilder<RestApiBase>) => AlarmDefinitionBuilder<RestApiBase>): this;
+    /**
+     * Adds an HTTP method to the API root resource (`/`).
+     *
+     * @param httpMethod - The HTTP verb (GET, POST, PUT, DELETE, etc.).
+     * @param integration - The backend integration for this method. Accepts a concrete
+     *   {@link Integration} or a {@link Ref} that resolves to one at build time.
+     * @param options - Additional method configuration such as authorization or method responses.
+     * @returns This builder for chaining.
+     */
+    addMethod(httpMethod: string, integration?: Resolvable<Integration>, options?: MethodOptions): this;
+    /**
+     * Adds a child resource under the API root resource (`/`).
+     *
+     * @param pathPart - The path segment for the resource (e.g. "users" or "\{id\}").
+     * @param configure - Optional callback to configure the resource's methods and nested resources.
+     * @returns This builder for chaining.
+     */
+    addResource(pathPart: string, configure?: (resource: ResourceBuilder) => void): this;
+    /**
+     * Copies non-`props` state onto a freshly cloned builder. The resource
+     * tree is deep-cloned via `ResourceBuilder.copyInto` so mutations on
+     * either side after `.copy()` do not leak; the alarm-builder array is
+     * spread into a fresh container with elements shared by reference per
+     * ADR-0005's shallow-clone stance.
+     *
+     * @internal
+     */
+    [COPY_STATE](target: RestApiBuilder): void;
+    build(scope: IConstruct, id: string, context?: Record<string, object>): RestApiBuilderResult;
+}
+/**
+ * Creates a new {@link IRestApiBuilder} for configuring an API Gateway REST API.
+ *
+ * This is the entry point for defining a REST API component. The returned
+ * builder exposes every {@link RestApiProps} property as a fluent setter/getter,
+ * plus {@link IRestApiBuilder.addResource | addResource} and
+ * {@link IRestApiBuilder.addMethod | addMethod} for defining the resource tree.
+ * It implements {@link Lifecycle} for use with {@link compose}.
+ *
+ * @returns A fluent builder for an API Gateway REST API.
+ *
+ * @example
+ * ```ts
+ * const api = createRestApiBuilder()
+ *   .restApiName("My Service")
+ *   .description("Public API")
+ *   .addResource("users", users => users
+ *     .addMethod("GET", listUsersIntegration)
+ *     .addResource("{id}", user => user
+ *       .addMethod("GET", getUserIntegration)
+ *     )
+ *   );
+ *
+ * // Use standalone:
+ * const result = api.build(stack, "MyApi");
+ *
+ * // Or compose into a system:
+ * const system = compose(
+ *   { api, handler: createFunctionBuilder() },
+ *   { api: ["handler"], handler: [] },
+ * );
+ * ```
+ */
+export declare function createRestApiBuilder(): IRestApiBuilder;
+export {};
+//# sourceMappingURL=rest-api-builder.d.ts.map

package/dist/esm/rest-api-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-api-builder.d.ts","sourceRoot":"","sources":["../../src/rest-api-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,OAAO,EACP,KAAK,WAAW,EAChB,KAAK,YAAY,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,KAAK,cAAc,EAAiB,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAG7F,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAGxD;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY,EAAE,uBAAuB;CAAG;AAErF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,eAAe,GAAG,cAAc,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC;AAElF,cAAM,cAAe,YAAW,SAAS,CAAC,oBAAoB,CAAC;;IAC7D,KAAK,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAM;IAIzC,QAAQ,CACN,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,CAAC,KAAK,EAAE,sBAAsB,CAAC,WAAW,CAAC,KAAK,sBAAsB,CAAC,WAAW,CAAC,GAC7F,IAAI;IAKP;;;;;;;;OAQG;IACH,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EACrC,OAAO,CAAC,EAAE,aAAa,GACtB,IAAI;IAKP;;;;;;OAMG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI;IAKpF;;;;;;;;OAQG;IACH,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI;IAK1C,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,oBAAoB;CAoB7F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,oBAAoB,IAAI,eAAe,CAEtD"}

package/dist/{rest-api-builder.js → esm/rest-api-builder.js}

@@ -1,5 +1,6 @@
 import { RestApi, } from "aws-cdk-lib/aws-apigateway";
-import { Builder } from "@composurecdk/core";
+import { COPY_STATE } from "@composurecdk/core";
+import { taggedBuilder } from "@composurecdk/cloudformation";
 import { AlarmDefinitionBuilder } from "@composurecdk/cloudwatch";
 import { REST_API_DEFAULTS } from "./defaults.js";
 import { resolveDeployOptions } from "./deploy-options.js";
@@ -37,6 +38,19 @@ class RestApiBuilder {
         this.#root.addResource(pathPart, configure);
         return this;
     }
+    /**
+     * Copies non-`props` state onto a freshly cloned builder. The resource
+     * tree is deep-cloned via `ResourceBuilder.copyInto` so mutations on
+     * either side after `.copy()` do not leak; the alarm-builder array is
+     * spread into a fresh container with elements shared by reference per
+     * ADR-0005's shallow-clone stance.
+     *
+     * @internal
+     */
+    [COPY_STATE](target) {
+        this.#root.copyInto(target.#root);
+        target.#customAlarms.push(...this.#customAlarms);
+    }
     build(scope, id, context) {
         const { accessLogging, recommendedAlarms: alarmConfig, ...restApiProps } = this.props;
         const { accessLogGroup, deployOptions } = resolveDeployOptions(scope, id, accessLogging, REST_API_DEFAULTS.deployOptions ?? {}, restApiProps.deployOptions ?? {});
@@ -83,6 +97,6 @@ class RestApiBuilder {
  * ```
  */
 export function createRestApiBuilder() {
-    return Builder(RestApiBuilder);
+    return taggedBuilder(RestApiBuilder);
 }
 //# sourceMappingURL=rest-api-builder.js.map

package/dist/esm/rest-api-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-api-builder.js","sourceRoot":"","sources":["../../src/rest-api-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,OAAO,GAGR,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,UAAU,EAAmC,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAuB,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AA2C3D,MAAM,cAAc;IAClB,KAAK,GAAiC,EAAE,CAAC;IAChC,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9B,aAAa,GAA0C,EAAE,CAAC;IAEnE,QAAQ,CACN,GAAW,EACX,SAA8F;QAE9F,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,sBAAsB,CAAc,GAAG,CAAC,CAAC,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CACP,UAAkB,EAClB,WAAqC,EACrC,OAAuB;QAEvB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,QAAgB,EAAE,SAA+C;QAC3E,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,CAAC,UAAU,CAAC,CAAC,MAAsB;QACjC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,KAAiB,EAAE,EAAU,EAAE,OAAgC;QACnE,MAAM,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtF,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,oBAAoB,CAC5D,KAAK,EACL,EAAE,EACF,aAAa,EACb,iBAAiB,CAAC,aAAa,IAAI,EAAE,EACrC,YAAY,CAAC,aAAa,IAAI,EAAE,CACjC,CAAC;QAEF,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE;YACjC,GAAG,YAAY;YACf,aAAa;SACd,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;QAE5C,MAAM,MAAM,GAAG,mBAAmB,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpF,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC;IACzC,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO,aAAa,CAAsC,cAAc,CAAC,CAAC;AAC5E,CAAC"}