alchemy 0.49.1 → 0.51.0

package/src/apply.ts

@@ -223,6 +223,14 @@ async function _apply<Out extends Resource>(
               output: resource,
             },
           });
+        } else {
+          const pendingDeletions =
+            (await scope.get<PendingDeletions>("pendingDeletions")) ?? [];
+          pendingDeletions.push({
+            resource: oldOutput,
+            oldProps: state.oldProps,
+          });
+          await scope.set("pendingDeletions", pendingDeletions);
         }
 
         output = await alchemy.run(
@@ -237,8 +245,8 @@ async function _apply<Out extends Resource>(
                 id: resource[ResourceID],
                 fqn: resource[ResourceFQN],
                 seq: resource[ResourceSeq],
-                props: state.props,
-                state,
+                props: state!.props,
+                state: state!,
                 isReplacement: true,
                 replace: () => {
                   throw new Error(
@@ -248,16 +256,6 @@ async function _apply<Out extends Resource>(
               }),
             )(resource[ResourceID], props),
         );
-
-        if (!error.force) {
-          const pendingDeletions =
-            (await scope.get<PendingDeletions>("pendingDeletions")) ?? [];
-          pendingDeletions.push({
-            resource: oldOutput,
-            oldProps: state.oldProps,
-          });
-          await scope.set("pendingDeletions", pendingDeletions);
-        }
       } else {
         throw error;
       }
@@ -282,6 +280,7 @@ async function _apply<Out extends Resource>(
       replaced: isReplaced,
     });
 
+    state = (await scope.state.get(resource[ResourceID]))!;
     await scope.state.set(resource[ResourceID], {
       kind: resource[ResourceKind],
       id: resource[ResourceID],

package/src/aws/control/types.ts

@@ -9717,7 +9717,7 @@ declare namespace AWS {
     ): Promise<SchedulingPolicy>;
   }
   namespace Bedrock {
-    interface APISchema {
+    interface ApiSchema {
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-s3 */
       S3?: S3Identifier;
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-payload */
@@ -9733,7 +9733,7 @@ declare namespace AWS {
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-description */
       Description?: string;
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-apischema */
-      ApiSchema?: APISchema;
+      ApiSchema?: ApiSchema;
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-functionschema */
       FunctionSchema?: FunctionSchema;
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-skipresourceinusecheckondelete */
@@ -61212,7 +61212,7 @@ declare namespace AWS {
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-textdocumentstatistics.html#cfn-qbusiness-index-textdocumentstatistics-indexedtextdocumentcount */
       IndexedTextDocumentCount?: number;
     }
-    interface APISchema {
+    interface ApiSchema {
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.html#cfn-qbusiness-plugin-apischema-s3 */
       S3?: S3;
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.html#cfn-qbusiness-plugin-apischema-payload */
@@ -61228,7 +61228,7 @@ declare namespace AWS {
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-description */
       Description: string;
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischema */
-      ApiSchema: APISchema;
+      ApiSchema: ApiSchema;
       /** http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischematype */
       ApiSchemaType: string;
     }

package/src/cloudflare/api-gateway-operation.ts

@@ -0,0 +1,340 @@
+import type { Context } from "../context.ts";
+import { Resource } from "../resource.ts";
+import { handleApiError } from "./api-error.ts";
+import type { APIMitigation } from "./api-mitigation.ts";
+import {
+  createCloudflareApi,
+  type CloudflareApi,
+  type CloudflareApiOptions,
+} from "./api.ts";
+import type { Zone } from "./zone.ts";
+
+/**
+ * HTTP methods supported by API Gateway
+ */
+export type HTTPMethod =
+  | "get"
+  | "post"
+  | "put"
+  | "patch"
+  | "delete"
+  | "head"
+  | "options"
+  | "trace";
+
+/**
+ * Properties for creating or updating an API Operation
+ */
+export interface APIGatewayOperationProps extends CloudflareApiOptions {
+  /**
+   * The zone this operation belongs to
+   */
+  zone: string | Zone;
+
+  /**
+   * The API endpoint path (can contain path variables like /users/{id})
+   */
+  endpoint: string;
+
+  /**
+   * The host for this operation
+   */
+  host: string;
+
+  /**
+   * The HTTP method (GET, POST, PUT, DELETE, etc.)
+   */
+  method: string;
+
+  /**
+   * Mitigation action for this operation
+   * @default "none"
+   */
+  mitigation?: APIMitigation;
+}
+
+/**
+ * API Operation output
+ */
+export interface APIGatewayOperation
+  extends Resource<"cloudflare::APIGatewayOperation"> {
+  /**
+   * Zone ID
+   */
+  zoneId: string;
+
+  /**
+   * Zone name
+   */
+  zoneName: string;
+
+  /**
+   * Operation ID assigned by Cloudflare
+   */
+  operationId: string;
+
+  /**
+   * The API endpoint path
+   */
+  endpoint: string;
+
+  /**
+   * The host for this operation
+   */
+  host: string;
+
+  /**
+   * The HTTP method
+   */
+  method: string;
+
+  /**
+   * The mitigation action for this operation
+   */
+  action: APIMitigation;
+}
+
+/**
+ * Cloudflare API Gateway Operation manages individual API endpoints that can be
+ * monitored, secured, and configured through Cloudflare's API Shield.
+ *
+ * Operations are the building blocks for API management, representing specific
+ * HTTP method + endpoint + host combinations that your API exposes.
+ *
+ * @example
+ * ## Basic API operation
+ *
+ * Create a simple GET endpoint for user retrieval
+ *
+ * const getUserOp = await APIGatewayOperation("get-users", {
+ *   zone: myZone,
+ *   endpoint: "/users",
+ *   host: "api.example.com",
+ *   method: "GET"
+ * });
+ *
+ * @example
+ * ## API operation with path parameters
+ *
+ * Create an operation that includes path variables
+ *
+ * const getUserByIdOp = await APIGatewayOperation("get-user-by-id", {
+ *   zone: "api.example.com",
+ *   endpoint: "/users/{id}",
+ *   host: "api.example.com",
+ *   method: "GET"
+ * });
+ *
+ * @example
+ * ## RESTful CRUD operations
+ *
+ * Create a complete set of CRUD operations for a resource
+ *
+ * const createUserOp = await APIGatewayOperation("create-user", {
+ *   zone: myZone,
+ *   endpoint: "/users",
+ *   host: "api.example.com",
+ *   method: "POST"
+ * });
+ *
+ * const updateUserOp = await APIGatewayOperation("update-user", {
+ *   zone: myZone,
+ *   endpoint: "/users/{id}",
+ *   host: "api.example.com",
+ *   method: "PUT"
+ * });
+ *
+ * const deleteUserOp = await APIGatewayOperation("delete-user", {
+ *   zone: myZone,
+ *   endpoint: "/users/{id}",
+ *   host: "api.example.com",
+ *   method: "DELETE"
+ * });
+ *
+ * @see https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/
+ * @see https://developers.cloudflare.com/api-shield/management-and-monitoring/endpoint-management/
+ */
+export const APIGatewayOperation = Resource(
+  "cloudflare::APIGatewayOperation",
+  async function (
+    this: Context<APIGatewayOperation>,
+    _id: string,
+    props: APIGatewayOperationProps,
+  ): Promise<APIGatewayOperation> {
+    const api = await createCloudflareApi(props);
+
+    // Resolve zone ID and name
+    const zoneId = typeof props.zone === "string" ? props.zone : props.zone.id;
+    const zoneName =
+      typeof props.zone === "string" ? props.zone : props.zone.name;
+
+    if (this.phase === "delete") {
+      if (this.output?.operationId) {
+        await deleteOperation(api, zoneId, this.output.operationId);
+      }
+      return this.destroy();
+    }
+    let operationId: string;
+    if (this.phase === "update") {
+      if (
+        props.endpoint !== this.output?.endpoint ||
+        props.host !== this.output?.host ||
+        props.method !== this.output?.method
+      ) {
+        // delete and then re-create (cloudflare doesn't allow updating these properties)
+        this.replace(true);
+      }
+      if (props.mitigation !== this.output?.action) {
+        // we can update the mitigation action
+        await updateOperationSettings(api, zoneId, this.output.operationId, {
+          mitigation_action: props.mitigation ?? null,
+        });
+      }
+      operationId = this.output.operationId;
+    } else {
+      const operation = await createOperation(api, zoneId, props);
+      operationId = operation.operation_id;
+
+      if (props.mitigation) {
+        await updateOperationSettings(api, zoneId, operationId, {
+          mitigation_action: props.mitigation ?? "none",
+        });
+      }
+    }
+
+    return this({
+      zoneId,
+      zoneName,
+      operationId,
+      endpoint: props.endpoint,
+      host: props.host,
+      method: props.method.toUpperCase(),
+      action: props.mitigation ?? null,
+    });
+  },
+);
+
+async function createOperation(
+  api: CloudflareApi,
+  zoneId: string,
+  props: APIGatewayOperationProps,
+) {
+  // Create the operation
+  const response = await api.post(
+    `/zones/${zoneId}/api_gateway/operations/item`,
+    {
+      endpoint: props.endpoint,
+      host: props.host,
+      method: props.method.toUpperCase(),
+    },
+  );
+
+  if (!response.ok) {
+    await handleApiError(
+      response,
+      "creating",
+      "operation",
+      `${props.method} ${props.endpoint}`,
+    );
+  }
+
+  const data = (await response.json()) as {
+    result: {
+      operation_id: string;
+      endpoint: string;
+      host: string;
+      method: string;
+      last_updated: string;
+    };
+  };
+
+  return data.result;
+}
+
+async function deleteOperation(
+  api: CloudflareApi,
+  zoneId: string,
+  operationId: string,
+) {
+  const deleteResponse = await api.delete(
+    `/zones/${zoneId}/api_gateway/operations/${operationId}`,
+  );
+
+  if (!deleteResponse.ok && deleteResponse.status !== 404) {
+    await handleApiError(deleteResponse, "deleting", "operation", operationId);
+  }
+}
+
+/**
+ * Update validation settings for a specific operation
+ */
+async function updateOperationSettings(
+  api: CloudflareApi,
+  zoneId: string,
+  operationId: string,
+  params: {
+    mitigation_action: APIMitigation;
+  },
+): Promise<void> {
+  const response = await api.put(
+    `/zones/${zoneId}/schema_validation/settings/operations/${operationId}`,
+    params,
+  );
+
+  if (!response.ok) {
+    await handleApiError(
+      response,
+      "updating",
+      "operation settings",
+      operationId,
+    );
+  }
+}
+
+export interface CloudflareOperation {
+  operation_id: string;
+  method: string;
+  host: string;
+  endpoint: string;
+}
+
+export async function getOperations(
+  api: CloudflareApi,
+  zoneId: string,
+): Promise<CloudflareOperation[]> {
+  const response = await api.get(`/zones/${zoneId}/api_gateway/operations`);
+
+  if (!response.ok) {
+    await handleApiError(response, "getting", "operations");
+  }
+
+  return ((await response.json()) as { result: CloudflareOperation[] }).result;
+}
+
+export async function getOperationSchemaValidationSetting(
+  api: CloudflareApi,
+  zoneId: string,
+  operationId: string,
+) {
+  const response = await api.get(
+    `/zones/${zoneId}/schema_validation/settings/operations/${operationId}`,
+  );
+
+  if (!response.ok) {
+    await handleApiError(
+      response,
+      "getting",
+      "operation mitigation status",
+      operationId,
+    );
+  }
+
+  const data = (await response.json()) as {
+    result: {
+      mitigation_action: APIMitigation;
+      operation_id: string;
+    };
+  };
+
+  return data.result;
+}

package/src/cloudflare/api-mitigation.ts

@@ -0,0 +1,22 @@
+import type { OpenAPIV3 } from "openapi-types";
+
+/**
+ * Specifies the mitigation action to apply when a request does not conform to
+ * the schema for this operation:
+ * - `"log"`: Log the request.
+ * - `"block"`: Deny access to the site.
+ * - `"none"`: Skip mitigation for this operation.
+ * - `null`: Clear any mitigation action.
+ */
+export type APIMitigation = "none" | "log" | "block" | null;
+
+/**
+ * Mitigation actions for a given API schema.
+ */
+export type APIMitigations<S extends OpenAPIV3.Document> = {
+  [path in keyof S["paths"]]?:
+    | APIMitigation
+    | {
+        [method in keyof S["paths"][path]]?: APIMitigation;
+      };
+};

package/src/cloudflare/api-response.ts

@@ -1,3 +1,5 @@
+import { CloudflareApiError } from "./api-error.ts";
+
 /**
  * Cloudflare API response format
  */
@@ -15,7 +17,7 @@ export interface CloudflareApiResponse<T> {
   /**
    * Error details if success is false
    */
-  errors: CloudflareApiError[];
+  errors: CloudflareApiErrorPayload[];
 
   /**
    * Response messages
@@ -37,7 +39,7 @@ export interface CloudflareApiResponse<T> {
 /**
  * Cloudflare API error format
  */
-export interface CloudflareApiError {
+export interface CloudflareApiErrorPayload {
   /**
    * Error code
    */
@@ -89,8 +91,10 @@ export async function extractCloudflareResult<T>(
   if (json.success) {
     return json.result;
   } else {
-    const error = new Error(
+    const error = new CloudflareApiError(
       `Failed to ${label} (${response.status} ${response.statusText}):\n${json.errors.map((e) => `- [${e.code}] ${e.message}${e.documentation_url ? ` (${e.documentation_url})` : ""}`).join("\n")}`,
+      response,
+      json.errors,
     );
     Error.captureStackTrace(error, extractCloudflareResult);
     Object.assign(error, {