alchemy 2.0.0-beta.30 → 2.0.0-beta.32

package/lib/AWS/ApiGateway/RestApi.js

@@ -0,0 +1,310 @@
+import { Region } from "@distilled.cloud/aws/Region";
+import * as ag from "@distilled.cloud/aws/api-gateway";
+import * as Effect from "effect/Effect";
+import { deepEqual, isResolved } from "../../Diff.js";
+import { createPhysicalName } from "../../PhysicalName.js";
+import * as Provider from "../../Provider.js";
+import { Resource } from "../../Resource.js";
+import { createInternalTags, tagRecord } from "../../Tags.js";
+import { restApiArn, retryOnApiStatusUpdating, syncTags } from "./common.js";
+/**
+ * An Amazon API Gateway REST API (v1).
+ *
+ * `RestApi` is the root of an API Gateway v1 stack. Every other ApiGateway
+ * resource — `Resource`, `Method`, `Authorizer`, `Deployment`, `Stage` —
+ * hangs off a `RestApi`. The only identity you need to thread through your
+ * stack is the `RestApi` value itself: child resources accept `restApi: api`
+ * and register themselves back onto the API so that deployments and stages
+ * wait for them without any user-authored dependency lists.
+ *
+ * @section Getting started
+ * A minimal API Gateway stack is four pieces: the `RestApi`, one or more
+ * `Method`s, a `Deployment` that snapshots those methods, and a `Stage` that
+ * exposes the deployment at a URL.
+ *
+ * @example Mock HTTP GET on the root path
+ * ```typescript
+ * import * as ApiGateway from "alchemy/AWS/ApiGateway";
+ *
+ * const api = yield* ApiGateway.RestApi("Api", {
+ *   endpointConfiguration: { types: ["REGIONAL"] },
+ * });
+ *
+ * yield* ApiGateway.Method("GetRoot", {
+ *   restApi: api,
+ *   httpMethod: "GET",
+ *   authorizationType: "NONE",
+ *   integration: { type: "MOCK" },
+ * });
+ *
+ * const deployment = yield* ApiGateway.Deployment("Release", {
+ *   restApi: api,
+ * });
+ *
+ * const stage = yield* ApiGateway.Stage("Prod", {
+ *   restApi: api,
+ *   stageName: "prod",
+ *   deploymentId: deployment.deploymentId,
+ * });
+ * ```
+ *
+ * @section How dependencies flow
+ * Writing `restApi: api` on a child (rather than `restApiId: api.restApiId`)
+ * does two things: it threads the restApi id through, and it registers a
+ * `RestApiBinding` back onto the API. The Alchemy scheduler sees those
+ * bindings as reverse edges from children into the API, and `Deployment`
+ * reads them to express a transitive dependency on every child. You never
+ * have to write a `DependsOn` list or a `triggers` hash — adding a new
+ * `Method` automatically orders it before the next `Deployment`.
+ *
+ * @section Private REST APIs
+ * @example Private REST API
+ * ```typescript
+ * const api = yield* ApiGateway.RestApi("PrivateApi", {
+ *   endpointConfiguration: {
+ *     types: ["PRIVATE"],
+ *     vpcEndpointIds: [endpoint.vpcEndpointId],
+ *   },
+ *   policy: JSON.stringify({
+ *     Version: "2012-10-17",
+ *     Statement: [{
+ *       Effect: "Allow",
+ *       Principal: "*",
+ *       Action: "execute-api:Invoke",
+ *       Resource: "*",
+ *     }],
+ *   }),
+ * });
+ * ```
+ *
+ * @section Binary payloads
+ * @example Enable binary media types
+ * ```typescript
+ * const api = yield* ApiGateway.RestApi("BinaryApi", {
+ *   binaryMediaTypes: ["application/octet-stream", "image/png"],
+ *   minimumCompressionSize: 1024,
+ * });
+ * ```
+ *
+ * @section Endpoint hardening
+ * @example Disable the default execute-api endpoint
+ * ```typescript
+ * const api = yield* ApiGateway.RestApi("CustomDomainOnlyApi", {
+ *   endpointConfiguration: { types: ["REGIONAL"] },
+ *   disableExecuteApiEndpoint: true,
+ * });
+ * ```
+ */
+export const RestApi = Resource("AWS.ApiGateway.RestApi");
+const generatedName = (id, props) => props.name
+    ? Effect.succeed(props.name)
+    : createPhysicalName({
+        id,
+        maxLength: 128,
+    });
+const snapshotFromApi = (api) => ({
+    restApiId: api.id,
+    rootResourceId: api.rootResourceId,
+    name: api.name ?? "",
+    description: api.description,
+    version: api.version,
+    binaryMediaTypes: api.binaryMediaTypes,
+    minimumCompressionSize: api.minimumCompressionSize,
+    apiKeySource: api.apiKeySource,
+    endpointConfiguration: api.endpointConfiguration,
+    policy: api.policy,
+    disableExecuteApiEndpoint: api.disableExecuteApiEndpoint,
+    securityPolicy: api.securityPolicy,
+    endpointAccessMode: api.endpointAccessMode,
+    tags: tagRecord(api.tags),
+});
+const patchReplace = (path, value) => ({
+    op: "replace",
+    path,
+    value,
+});
+const encodeJsonPointerSegment = (s) => s.replace(/~/g, "~0").replace(/\//g, "~1");
+const binaryMediaTypePath = (mediaType) => `/binaryMediaTypes/${encodeJsonPointerSegment(mediaType)}`;
+const buildBinaryMediaTypePatches = (prev, next) => {
+    const prevSet = [...new Set(prev ?? [])];
+    const nextSet = [...new Set(next ?? [])];
+    const patches = [];
+    for (const m of prevSet) {
+        if (!nextSet.includes(m)) {
+            patches.push({ op: "remove", path: binaryMediaTypePath(m) });
+        }
+    }
+    for (const m of nextSet) {
+        if (!prevSet.includes(m)) {
+            patches.push({
+                op: "add",
+                path: binaryMediaTypePath(m),
+                value: m,
+            });
+        }
+    }
+    return patches;
+};
+const buildUpdatePatches = (news, prev) => {
+    const patches = [];
+    if (news.name !== undefined && news.name !== prev.name) {
+        patches.push(patchReplace("/name", news.name));
+    }
+    if (news.description !== prev.description) {
+        patches.push(patchReplace("/description", news.description ?? ""));
+    }
+    if (news.version !== prev.version) {
+        patches.push(patchReplace("/version", news.version ?? ""));
+    }
+    patches.push(...buildBinaryMediaTypePatches(prev.binaryMediaTypes, news.binaryMediaTypes));
+    if (news.minimumCompressionSize !== prev.minimumCompressionSize) {
+        patches.push(patchReplace("/minimumCompressionSize", String(news.minimumCompressionSize ?? "")));
+    }
+    if (news.apiKeySource !== prev.apiKeySource) {
+        patches.push(patchReplace("/apiKeySource", news.apiKeySource ?? "HEADER"));
+    }
+    if (news.policy !== prev.policy) {
+        patches.push(patchReplace("/policy", news.policy ?? ""));
+    }
+    if (news.disableExecuteApiEndpoint !== prev.disableExecuteApiEndpoint) {
+        patches.push(patchReplace("/disableExecuteApiEndpoint", String(!!news.disableExecuteApiEndpoint)));
+    }
+    if (news.securityPolicy !== prev.securityPolicy) {
+        patches.push(patchReplace("/securityPolicy", news.securityPolicy ?? "TLS_1_0"));
+    }
+    if (news.endpointAccessMode !== prev.endpointAccessMode) {
+        patches.push(patchReplace("/endpointAccessMode", news.endpointAccessMode ?? ""));
+    }
+    return patches;
+};
+export const RestApiProvider = () => Provider.effect(RestApi, Effect.gen(function* () {
+    const awsRegion = yield* Region;
+    return {
+        stables: ["restApiId", "rootResourceId"],
+        diff: Effect.fn(function* ({ news: newsIn, olds }) {
+            if (!isResolved(newsIn))
+                return;
+            const news = newsIn;
+            if (
+            // Endpoint type, private endpoint IDs, and IP address type are part
+            // of the REST API endpoint shape; replacing avoids partial endpoint
+            // drift that API Gateway cannot consistently patch in place.
+            !deepEqual(news.endpointConfiguration?.types, olds.endpointConfiguration?.types) ||
+                !deepEqual(news.endpointConfiguration?.vpcEndpointIds, olds.endpointConfiguration?.vpcEndpointIds) ||
+                !deepEqual(news.endpointConfiguration?.ipAddressType, olds.endpointConfiguration?.ipAddressType)) {
+                return { action: "replace" };
+            }
+        }),
+        read: Effect.fn(function* ({ output }) {
+            if (!output?.restApiId)
+                return undefined;
+            const api = yield* ag
+                .getRestApi({ restApiId: output.restApiId })
+                .pipe(Effect.catchTag("NotFoundException", () => Effect.succeed(undefined)));
+            if (!api?.id)
+                return undefined;
+            return snapshotFromApi(api);
+        }),
+        // The REST API is brought up in two phases. `precreate` creates the
+        // REST API in full so child resources (`Method`, `Resource`, etc.)
+        // can resolve `api.restApiId` and start their own creates — this is
+        // the cycle-breaker that lets children register themselves back onto
+        // the API via `restApi.bind`. `create` then runs last — after every
+        // bound child — and is effectively a no-op that re-reads the API to
+        // publish the final snapshot. The key property is that any
+        // `Deployment` referencing `api.*` outputs will see a value produced
+        // only after every bound child has settled, because the bindings on
+        // the API force `create` to wait for them before returning.
+        precreate: Effect.fn(function* ({ id, news: newsIn, session }) {
+            if (!isResolved(newsIn)) {
+                return yield* Effect.die("RestApi props were not resolved");
+            }
+            const news = newsIn;
+            const name = yield* generatedName(id, news);
+            const internalTags = yield* createInternalTags(id);
+            const allTags = { ...(news.tags ?? {}), ...internalTags };
+            const created = yield* retryOnApiStatusUpdating(ag.createRestApi({
+                name,
+                description: news.description,
+                version: news.version,
+                cloneFrom: news.cloneFrom,
+                binaryMediaTypes: news.binaryMediaTypes,
+                minimumCompressionSize: news.minimumCompressionSize,
+                apiKeySource: news.apiKeySource,
+                endpointConfiguration: news.endpointConfiguration,
+                policy: news.policy,
+                tags: allTags,
+                disableExecuteApiEndpoint: news.disableExecuteApiEndpoint,
+                securityPolicy: news.securityPolicy,
+                endpointAccessMode: news.endpointAccessMode,
+            }));
+            if (!created.id || !created.rootResourceId) {
+                return yield* Effect.die("createRestApi missing id or rootResourceId");
+            }
+            yield* session.note(`Created REST API ${created.id}`);
+            const full = yield* ag.getRestApi({ restApiId: created.id });
+            return snapshotFromApi(full);
+        }),
+        reconcile: Effect.fn(function* ({ id, news: newsIn, output, session }) {
+            if (!isResolved(newsIn)) {
+                return yield* Effect.die("RestApi props were not resolved");
+            }
+            const news = newsIn;
+            // RestApi has a `precreate` that always runs before `reconcile`
+            // for greenfield deployments — it creates the REST API in full
+            // so that `restApi.restApiId` is resolvable and child resources
+            // (Method, Resource, Authorizer) can register themselves back on
+            // the API via `restApi.bind`. By the time `reconcile` runs the id
+            // is populated; we never expect `output === undefined` here, but
+            // we still handle it defensively.
+            if (!output?.restApiId) {
+                return yield* Effect.die("RestApi reconcile reached without a precreate output");
+            }
+            // Observe — fetch live cloud state. `output` is treated as a
+            // cache for the stable id only.
+            const observed = yield* ag
+                .getRestApi({ restApiId: output.restApiId })
+                .pipe(Effect.catchTag("NotFoundException", () => Effect.succeed(undefined)));
+            if (!observed?.id) {
+                return yield* Effect.die(`RestApi ${output.restApiId} disappeared between precreate and reconcile`);
+            }
+            const observedSnapshot = snapshotFromApi(observed);
+            // Sync mutable scalar fields — diff observed cloud state against
+            // desired and emit only the delta as PATCH operations.
+            const patches = buildUpdatePatches(news, observedSnapshot);
+            if (patches.length > 0) {
+                yield* retryOnApiStatusUpdating(ag.updateRestApi({
+                    restApiId: output.restApiId,
+                    patchOperations: patches,
+                }));
+            }
+            // Sync tags — observed ↔ desired so adoption converges without
+            // fighting the existing tag set.
+            const internalTags = yield* createInternalTags(id);
+            const desiredTags = { ...news.tags, ...internalTags };
+            if (!deepEqual(observedSnapshot.tags, desiredTags)) {
+                const arn = restApiArn(awsRegion, output.restApiId);
+                yield* syncTags({
+                    resourceArn: arn,
+                    oldTags: observedSnapshot.tags,
+                    newTags: desiredTags,
+                });
+            }
+            yield* session.note(`Reconciled REST API ${output.restApiId}`);
+            // Re-read so the returned attributes reflect what's actually in
+            // the cloud after all sync steps.
+            const final = yield* ag.getRestApi({ restApiId: output.restApiId });
+            if (!final.id) {
+                return yield* Effect.die("getRestApi missing id after reconcile");
+            }
+            return snapshotFromApi(final);
+        }),
+        delete: Effect.fn(function* ({ output, session }) {
+            yield* retryOnApiStatusUpdating(ag
+                .deleteRestApi({ restApiId: output.restApiId })
+                .pipe(Effect.catchTag("NotFoundException", () => Effect.void)));
+            yield* session.note(`Deleted REST API ${output.restApiId}`);
+        }),
+    };
+}));
+//# sourceMappingURL=RestApi.js.map

package/lib/AWS/ApiGateway/RestApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestApi.js","sourceRoot":"","sources":["../../../src/AWS/ApiGateway/RestApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,KAAK,EAAE,MAAM,kCAAkC,CAAC;AACvD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE9D,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAgF7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuFG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAU,wBAAwB,CAAC,CAAC;AAEnE,MAAM,aAAa,GAAG,CAAC,EAAU,EAAE,KAAmB,EAAE,EAAE,CACxD,KAAK,CAAC,IAAI;IACR,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;IAC5B,CAAC,CAAC,kBAAkB,CAAC;QACjB,EAAE;QACF,SAAS,EAAE,GAAG;KACf,CAAC,CAAC;AAET,MAAM,eAAe,GAAG,CAAC,GAAe,EAAE,EAAE,CAAC,CAAC;IAC5C,SAAS,EAAE,GAAG,CAAC,EAAG;IAClB,cAAc,EAAE,GAAG,CAAC,cAAe;IACnC,IAAI,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE;IACpB,WAAW,EAAE,GAAG,CAAC,WAAW;IAC5B,OAAO,EAAE,GAAG,CAAC,OAAO;IACpB,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;IACtC,sBAAsB,EAAE,GAAG,CAAC,sBAAsB;IAClD,YAAY,EAAE,GAAG,CAAC,YAAY;IAC9B,qBAAqB,EAAE,GAAG,CAAC,qBAAqB;IAChD,MAAM,EAAE,GAAG,CAAC,MAAM;IAClB,yBAAyB,EAAE,GAAG,CAAC,yBAAyB;IACxD,cAAc,EAAE,GAAG,CAAC,cAAc;IAClC,kBAAkB,EAAE,GAAG,CAAC,kBAAkB;IAC1C,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;CAC1B,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,KAAa,EAAqB,EAAE,CAAC,CAAC;IACxE,EAAE,EAAE,SAAS;IACb,IAAI;IACJ,KAAK;CACN,CAAC,CAAC;AAEH,MAAM,wBAAwB,GAAG,CAAC,CAAS,EAAE,EAAE,CAC7C,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAE7C,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAE,EAAE,CAChD,qBAAqB,wBAAwB,CAAC,SAAS,CAAC,EAAE,CAAC;AAE7D,MAAM,2BAA2B,GAAG,CAClC,IAA0B,EAC1B,IAA0B,EACL,EAAE;IACvB,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IACzC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IACzC,MAAM,OAAO,GAAwB,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,KAAK;gBACT,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC;gBAC5B,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACzB,IAAkB,EAClB,IAA2B,EACN,EAAE;IACvB,MAAM,OAAO,GAAwB,EAAE,CAAC;IACxC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QACvD,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1C,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,CAAC,IAAI,CACV,GAAG,2BAA2B,CAC5B,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,gBAAgB,CACtB,CACF,CAAC;IACF,IAAI,IAAI,CAAC,sBAAsB,KAAK,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAChE,OAAO,CAAC,IAAI,CACV,YAAY,CACV,yBAAyB,EACzB,MAAM,CAAC,IAAI,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAC1C,CACF,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5C,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,IAAI,QAAQ,CAAC,CAAC,CAAC;IAC7E,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,IAAI,CAAC,yBAAyB,KAAK,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACtE,OAAO,CAAC,IAAI,CACV,YAAY,CACV,4BAA4B,EAC5B,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CACzC,CACF,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,cAAc,EAAE,CAAC;QAChD,OAAO,CAAC,IAAI,CACV,YAAY,CAAC,iBAAiB,EAAE,IAAI,CAAC,cAAc,IAAI,SAAS,CAAC,CAClE,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,kBAAkB,KAAK,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxD,OAAO,CAAC,IAAI,CACV,YAAY,CAAC,qBAAqB,EAAE,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,CACnE,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,EAAE,CAClC,QAAQ,CAAC,MAAM,CACb,OAAO,EACP,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC;IAEhC,OAAO;QACL,OAAO,EAAE,CAAC,WAAW,EAAE,gBAAgB,CAAU;QACjD,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;YAC/C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;gBAAE,OAAO;YAChC,MAAM,IAAI,GAAG,MAAsB,CAAC;YACpC;YACE,oEAAoE;YACpE,oEAAoE;YACpE,6DAA6D;YAC7D,CAAC,SAAS,CACR,IAAI,CAAC,qBAAqB,EAAE,KAAK,EACjC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAClC;gBACD,CAAC,SAAS,CACR,IAAI,CAAC,qBAAqB,EAAE,cAAc,EAC1C,IAAI,CAAC,qBAAqB,EAAE,cAAc,CAC3C;gBACD,CAAC,SAAS,CACR,IAAI,CAAC,qBAAqB,EAAE,aAAa,EACzC,IAAI,CAAC,qBAAqB,EAAE,aAAa,CAC1C,EACD,CAAC;gBACD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAW,CAAC;YACxC,CAAC;QACH,CAAC,CAAC;QACF,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE;YACnC,IAAI,CAAC,MAAM,EAAE,SAAS;gBAAE,OAAO,SAAS,CAAC;YACzC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,EAAE;iBAClB,UAAU,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;iBAC3C,IAAI,CACH,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE,CACxC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAC1B,CACF,CAAC;YACJ,IAAI,CAAC,GAAG,EAAE,EAAE;gBAAE,OAAO,SAAS,CAAC;YAC/B,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC,CAAC;QACF,oEAAoE;QACpE,mEAAmE;QACnE,oEAAoE;QACpE,qEAAqE;QACrE,oEAAoE;QACpE,oEAAoE;QACpE,2DAA2D;QAC3D,qEAAqE;QACrE,oEAAoE;QACpE,4DAA4D;QAC5D,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;YAC3D,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxB,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,IAAI,GAAG,MAAsB,CAAC;YACpC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YAC5C,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACnD,MAAM,OAAO,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,YAAY,EAAE,CAAC;YAC1D,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,wBAAwB,CAC7C,EAAE,CAAC,aAAa,CAAC;gBACf,IAAI;gBACJ,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;gBACvC,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;gBACnD,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,qBAAqB,EAAE,IAAI,CAAC,qBAAqB;gBACjD,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,OAAO;gBACb,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;gBACzD,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;aAC5C,CAAC,CACH,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC3C,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CACtB,4CAA4C,CAC7C,CAAC;YACJ,CAAC;YACD,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YACtD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YAC7D,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC;QACF,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;YACnE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxB,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,IAAI,GAAG,MAAsB,CAAC;YAEpC,gEAAgE;YAChE,+DAA+D;YAC/D,gEAAgE;YAChE,iEAAiE;YACjE,kEAAkE;YAClE,iEAAiE;YACjE,kCAAkC;YAClC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;gBACvB,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CACtB,sDAAsD,CACvD,CAAC;YACJ,CAAC;YAED,6DAA6D;YAC7D,gCAAgC;YAChC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,EAAE;iBACvB,UAAU,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;iBAC3C,IAAI,CACH,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE,CACxC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAC1B,CACF,CAAC;YACJ,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;gBAClB,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CACtB,WAAW,MAAM,CAAC,SAAS,8CAA8C,CAC1E,CAAC;YACJ,CAAC;YACD,MAAM,gBAAgB,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;YAEnD,iEAAiE;YACjE,uDAAuD;YACvD,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YAC3D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,KAAK,CAAC,CAAC,wBAAwB,CAC7B,EAAE,CAAC,aAAa,CAAC;oBACf,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,eAAe,EAAE,OAAO;iBACzB,CAAC,CACH,CAAC;YACJ,CAAC;YAED,+DAA+D;YAC/D,iCAAiC;YACjC,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACnD,MAAM,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC;YACtD,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;gBACnD,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;gBACpD,KAAK,CAAC,CAAC,QAAQ,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,OAAO,EAAE,gBAAgB,CAAC,IAAI;oBAC9B,OAAO,EAAE,WAAW;iBACrB,CAAC,CAAC;YACL,CAAC;YAED,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YAE/D,gEAAgE;YAChE,kCAAkC;YAClC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YACpE,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;gBACd,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;YACpE,CAAC;YACD,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE;YAC9C,KAAK,CAAC,CAAC,wBAAwB,CAC7B,EAAE;iBACC,aAAa,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;iBAC9C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CACjE,CAAC;YACF,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QAC9D,CAAC,CAAC;KACH,CAAC;AACJ,CAAC,CAAC,CACH,CAAC"}

package/lib/AWS/ApiGateway/Stage.d.ts

@@ -0,0 +1,144 @@
+import { Region } from "@distilled.cloud/aws/Region";
+import * as ag from "@distilled.cloud/aws/api-gateway";
+import * as Effect from "effect/Effect";
+import type { Input } from "../../Input.ts";
+import * as Provider from "../../Provider.ts";
+import { Resource } from "../../Resource.ts";
+import type { Providers } from "../Providers.ts";
+import type { RestApi } from "./RestApi.ts";
+export interface StageProps {
+    /**
+     * The `RestApi` this stage belongs to. When supplied, `restApiId` is
+     * derived from `restApi.restApiId` automatically.
+     */
+    restApi?: RestApi;
+    /**
+     * ID of the REST API. Usually derived from `restApi.restApiId`.
+     */
+    restApiId?: Input<string>;
+    stageName: string;
+    /**
+     * The `deploymentId` this stage points at. Pass `deployment.deploymentId`
+     * — Alchemy will automatically wait for the deployment to be created
+     * before creating the stage.
+     */
+    deploymentId: Input<string>;
+    description?: string;
+    cacheClusterEnabled?: boolean;
+    cacheClusterSize?: ag.CacheClusterSize;
+    variables?: {
+        [key: string]: string | undefined;
+    };
+    documentationVersion?: string;
+    canarySettings?: ag.CanarySettings;
+    tracingEnabled?: boolean;
+    /**
+     * Map of resource path pattern to method settings; keys use `{resourcePath}/{httpMethod}`.
+     */
+    methodSettings?: {
+        [key: string]: ag.MethodSetting | undefined;
+    };
+    accessLogSettings?: ag.AccessLogSettings;
+    webAclArn?: string;
+    tags?: Record<string, string>;
+}
+export interface ApiGatewayStage extends Resource<"AWS.ApiGateway.Stage", StageProps, {
+    restApiId: string;
+    stageName: string;
+    deploymentId: string;
+    description: string | undefined;
+    cacheClusterEnabled: boolean | undefined;
+    cacheClusterSize: ag.CacheClusterSize | undefined;
+    variables: {
+        [key: string]: string | undefined;
+    } | undefined;
+    documentationVersion: string | undefined;
+    canarySettings: ag.CanarySettings | undefined;
+    tracingEnabled: boolean | undefined;
+    methodSettings: {
+        [key: string]: ag.MethodSetting | undefined;
+    } | undefined;
+    accessLogSettings: ag.AccessLogSettings | undefined;
+    webAclArn: string | undefined;
+    tags: Record<string, string>;
+}, never, Providers> {
+}
+/**
+ * A stage for a REST API deployment.
+ *
+ * A Stage is what clients actually call. It binds a name (`dev`, `prod`,
+ * `v2`) to a specific `Deployment` of a `RestApi` and exposes it at a
+ * stable URL:
+ *
+ * ```
+ * https://<restApiId>.execute-api.<region>.amazonaws.com/<stageName>/
+ * ```
+ *
+ * @section Stages
+ * @example A dev stage pointing at the latest deployment
+ * ```typescript
+ * const stage = yield* ApiGateway.Stage("Dev", {
+ *   restApi: api,
+ *   stageName: "dev",
+ *   deploymentId: deployment.deploymentId,
+ * });
+ * ```
+ *
+ * @section Stage variables
+ * @example Override values per stage
+ * ```typescript
+ * const stage = yield* ApiGateway.Stage("Prod", {
+ *   restApi: api,
+ *   stageName: "prod",
+ *   deploymentId: deployment.deploymentId,
+ *   variables: {
+ *     logLevel: "info",
+ *     featureFlag: "on",
+ *   },
+ * });
+ * ```
+ *
+ * @section Canary deployments
+ * Point `canarySettings` at a different `Deployment` to split traffic
+ * between the stable and canary versions. `percentTraffic` is the
+ * percent of requests routed to the canary deployment.
+ *
+ * @example Shift 10% of traffic to a canary deployment
+ * ```typescript
+ * const stage = yield* ApiGateway.Stage("Prod", {
+ *   restApi: api,
+ *   stageName: "prod",
+ *   deploymentId: stableDeployment.deploymentId,
+ *   canarySettings: {
+ *     percentTraffic: 10,
+ *     deploymentId: canaryDeployment.deploymentId,
+ *   },
+ * });
+ * ```
+ */
+export declare const StageResource: import("../../Resource.ts").ResourceClass<ApiGatewayStage>;
+interface StageInputProps {
+    restApi?: RestApi;
+    restApiId?: Input<string>;
+    stageName: Input<string>;
+    deploymentId: Input<string>;
+    description?: Input<string>;
+    cacheClusterEnabled?: Input<boolean>;
+    cacheClusterSize?: Input<ag.CacheClusterSize>;
+    variables?: Input<{
+        [key: string]: string | undefined;
+    }>;
+    documentationVersion?: Input<string>;
+    canarySettings?: Input<ag.CanarySettings>;
+    tracingEnabled?: Input<boolean>;
+    methodSettings?: Input<{
+        [key: string]: ag.MethodSetting | undefined;
+    }>;
+    accessLogSettings?: Input<ag.AccessLogSettings>;
+    webAclArn?: Input<string>;
+    tags?: Input<Record<string, string>>;
+}
+export declare const Stage: (id: string, props: StageInputProps) => Effect.Effect<ApiGatewayStage, never, Providers>;
+export declare const StageProvider: () => import("effect/Layer").Layer<Provider.Provider<ApiGatewayStage>, never, import("effect/unstable/http/HttpClient").HttpClient | import("../../Stage.ts").Stage | import("../../Stack.ts").Stack | Region | import("@distilled.cloud/aws/Credentials").Credentials>;
+export {};
+//# sourceMappingURL=Stage.d.ts.map

package/lib/AWS/ApiGateway/Stage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Stage.d.ts","sourceRoot":"","sources":["../../../src/AWS/ApiGateway/Stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,KAAK,EAAE,MAAM,kCAAkC,CAAC;AACvD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAG5C,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,gBAAgB,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC;IACvC,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC;IAClD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,cAAc,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC;IACnC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC;IACjE,iBAAiB,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,eAAgB,SAAQ,QAAQ,CAC/C,sBAAsB,EACtB,UAAU,EACV;IACE,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,mBAAmB,EAAE,OAAO,GAAG,SAAS,CAAC;IACzC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAClD,SAAS,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC;IAC7D,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,cAAc,EAAE,EAAE,CAAC,cAAc,GAAG,SAAS,CAAC;IAC9C,cAAc,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,aAAa,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC;IAC5E,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,GAAG,SAAS,CAAC;IACpD,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B,EACD,KAAK,EACL,SAAS,CACV;CAAG;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,eAAO,MAAM,aAAa,4DAAoD,CAAC;AAE/E,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,mBAAmB,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,gBAAgB,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC;IAC9C,SAAS,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC,CAAC;IACzD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,cAAc,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC;IAC1C,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAChC,cAAc,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC,CAAC;IACxE,iBAAiB,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC;IAChD,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACtC;AAiBD,eAAO,MAAM,KAAK,OAZK,MAAM,SAAS,eAAe,qDAYvB,CAAC;AAgX/B,eAAO,MAAM,aAAa,yQAgIvB,CAAC"}