alchemy 0.12.3 → 0.12.5

package/src/cloudflare/ai-gateway.ts

@@ -0,0 +1,299 @@
+import type { Context } from "../context.js";
+import { Resource } from "../resource.js";
+import { handleApiError } from "./api-error.js";
+import { createCloudflareApi, type CloudflareApiOptions } from "./api.js";
+
+/**
+ * Properties for creating or updating a Cloudflare AI Gateway.
+ */
+export interface AiGatewayProps extends CloudflareApiOptions {
+  /**
+   * Invalidate cache on update.
+   * @default true
+   */
+  cacheInvalidateOnUpdate?: boolean;
+
+  /**
+   * Cache TTL in seconds. Set to 0 to disable caching.
+   * @default 0
+   * @minimum 0
+   */
+  cacheTtl?: number;
+
+  /**
+   * Collect logs for the gateway.
+   * @default true
+   */
+  collectLogs?: boolean;
+
+  /**
+   * Rate limiting interval in seconds. Set to 0 to disable rate limiting.
+   * @default 0
+   * @minimum 0
+   */
+  rateLimitingInterval?: number;
+
+  /**
+   * Rate limiting limit per interval. Set to 0 to disable rate limiting.
+   * @default 0
+   * @minimum 0
+   */
+  rateLimitingLimit?: number;
+
+  /**
+   * Rate limiting technique.
+   * @default "fixed"
+   */
+  rateLimitingTechnique?: "fixed" | "sliding";
+
+  /**
+   * Enable authentication for the gateway.
+   * @default false
+   */
+  authentication?: boolean;
+
+  /**
+   * Log retention limit in requests.
+   * @default undefined
+   * @minimum 10000
+   * @maximum 10000000
+   */
+  logManagement?: number;
+
+  /**
+   * Strategy for handling log limits.
+   * @default undefined
+   */
+  logManagementStrategy?: "STOP_INSERTING" | "DELETE_OLDEST";
+
+  /**
+   * Enable logpush for the gateway.
+   * @default false
+   */
+  logpush?: boolean;
+
+  /**
+   * Public key for logpush encryption.
+   * @default undefined
+   * @minLength 16
+   * @maxLength 1024
+   */
+  logpushPublicKey?: string;
+}
+
+/**
+ * Output returned after Cloudflare AI Gateway creation/update.
+ * IMPORTANT: The interface name MUST match the exported resource name.
+ */
+export interface AiGateway
+  extends Resource<"cloudflare::AiGateway">,
+    AiGatewayProps {
+  /**
+   * The ID (name) of the gateway.
+   */
+  id: string;
+
+  /**
+   * Cloudflare account ID associated with the gateway.
+   */
+  accountId: string;
+
+  /**
+   * Cloudflare account tag associated with the gateway.
+   */
+  accountTag: string;
+
+  /**
+   * Time at which the gateway was created (ISO 8601 format).
+   */
+  createdAt: string;
+
+  /**
+   * The internal UUID of the gateway.
+   */
+  internalId: string;
+
+  /**
+   * Time at which the gateway was last modified (ISO 8601 format).
+   */
+  modifiedAt: string;
+
+  /**
+   * Resource type identifier for binding.
+   * @internal
+   */
+  type: "ai_gateway";
+}
+
+/**
+ * Represents a Cloudflare AI Gateway.
+ *
+ * @example
+ * // Create a basic AI Gateway with default settings:
+ * const basicGateway = await AiGateway("my-ai-gateway", {});
+ *
+ * @example
+ * // Create an AI Gateway with authentication and rate limiting:
+ * const secureGateway = await AiGateway("secure-ai-gateway", {
+ *   authentication: true,
+ *   rateLimitingInterval: 60, // 60 seconds
+ *   rateLimitingLimit: 100,   // 100 requests
+ *   rateLimitingTechnique: "sliding"
+ * });
+ *
+ * @example
+ * // Create an AI Gateway with logging enabled and logpush:
+ * const loggingGateway = await AiGateway("logging-ai-gateway", {
+ *   collectLogs: true,
+ *   logpush: true,
+ *   logpushPublicKey: "mypublickey..." // Replace with actual public key
+ * });
+ */
+export const AiGateway = Resource(
+  "cloudflare::AiGateway",
+  { alwaysUpdate: true }, // AI Gateway PUT updates, so always run update logic
+  async function (
+    this: Context<AiGateway>,
+    id: string,
+    props: AiGatewayProps = {}
+  ): Promise<AiGateway> {
+    const api = await createCloudflareApi(props);
+    const gatewayPath = `/accounts/${api.accountId}/ai-gateway/gateways/${id}`;
+    const gatewaysPath = `/accounts/${api.accountId}/ai-gateway/gateways`;
+
+    if (this.phase === "delete") {
+      try {
+        const deleteResponse = await api.delete(gatewayPath);
+        // Only swallow 404 Not Found errors, all other errors should be handled
+        if (!deleteResponse.ok && deleteResponse.status !== 404) {
+          await handleApiError(deleteResponse, "delete", "ai gateway", id);
+        }
+      } catch (error) {
+        console.error(`Error deleting AI Gateway ${id}:`, error);
+        throw error;
+      }
+      return this.destroy();
+    }
+
+    // Default values as per Cloudflare documentation examples
+    const mergedProps: AiGatewayProps = {
+      cacheInvalidateOnUpdate: true,
+      cacheTtl: 0,
+      collectLogs: true,
+      rateLimitingInterval: 0,
+      rateLimitingLimit: 0,
+      rateLimitingTechnique: "fixed",
+      ...props, // User props override defaults
+    };
+
+    let response: Response | undefined;
+    let apiResource: any;
+
+    try {
+      if (this.phase === "update") {
+        // Update existing gateway (PUT request)
+        const requestBody = mapPropsToApi(id, mergedProps, false);
+        response = await api.put(gatewayPath, requestBody);
+      } else {
+        // Check if gateway exists before creating (to avoid conflict)
+        const getResponse = await api.get(gatewayPath);
+        if (getResponse.status === 200) {
+          // Gateway exists, treat as update (PUT)
+          console.log(
+            `AI Gateway '${id}' already exists. Updating existing resource.`
+          );
+          const requestBody = mapPropsToApi(id, mergedProps, false);
+          response = await api.put(gatewayPath, requestBody);
+        } else if (getResponse.status === 404) {
+          // Gateway doesn't exist, create new (POST request)
+          const requestBody = mapPropsToApi(id, mergedProps, true); // Include 'id' in POST body
+          response = await api.post(gatewaysPath, requestBody);
+        } else {
+          // Unexpected error during GET check
+          await handleApiError(getResponse, "get", "ai gateway", id);
+        }
+      }
+
+      if (!response?.ok) {
+        const action = this.phase === "update" ? "update" : "create";
+        await handleApiError(response!, action, "ai gateway", id);
+      }
+
+      const data: { result: Record<string, any> } = await response!.json();
+      apiResource = data.result;
+    } catch (error) {
+      console.error(`Error ${this.phase} AI Gateway '${id}':`, error);
+      throw error; // Re-throw the error to fail the deployment
+    }
+
+    // Construct the output object from API response and merged props
+    return this({
+      ...mergedProps, // Start with the input props (including defaults)
+      id: apiResource.id,
+      accountId: apiResource.account_id,
+      accountTag: apiResource.account_tag,
+      createdAt: apiResource.created_at,
+      internalId: apiResource.internal_id,
+      modifiedAt: apiResource.modified_at,
+      // Update props based on the actual response from the API (Cloudflare might set defaults)
+      cacheInvalidateOnUpdate: apiResource.cache_invalidate_on_update,
+      cacheTtl: apiResource.cache_ttl,
+      collectLogs: apiResource.collect_logs,
+      rateLimitingInterval: apiResource.rate_limiting_interval,
+      rateLimitingLimit: apiResource.rate_limiting_limit,
+      rateLimitingTechnique: apiResource.rate_limiting_technique,
+      authentication: apiResource.authentication,
+      logManagement: apiResource.log_management,
+      logManagementStrategy: apiResource.log_management_strategy,
+      logpush: apiResource.logpush,
+      logpushPublicKey: apiResource.logpush_public_key,
+      type: "ai_gateway",
+    });
+  }
+);
+
+// Helper function to map props to the API request body format
+function mapPropsToApi(
+  id: string,
+  props: AiGatewayProps,
+  includeIdInBody: boolean = false
+): Record<string, any> {
+  const body: Record<string, any> = {};
+  if (includeIdInBody) {
+    body.id = id;
+  }
+  if (props.cacheInvalidateOnUpdate !== undefined) {
+    body.cache_invalidate_on_update = props.cacheInvalidateOnUpdate;
+  }
+  if (props.cacheTtl !== undefined) {
+    body.cache_ttl = props.cacheTtl;
+  }
+  if (props.collectLogs !== undefined) {
+    body.collect_logs = props.collectLogs;
+  }
+  if (props.rateLimitingInterval !== undefined) {
+    body.rate_limiting_interval = props.rateLimitingInterval;
+  }
+  if (props.rateLimitingLimit !== undefined) {
+    body.rate_limiting_limit = props.rateLimitingLimit;
+  }
+  if (props.rateLimitingTechnique !== undefined) {
+    body.rate_limiting_technique = props.rateLimitingTechnique;
+  }
+  if (props.authentication !== undefined) {
+    body.authentication = props.authentication;
+  }
+  if (props.logManagement !== undefined) {
+    body.log_management = props.logManagement;
+  }
+  if (props.logManagementStrategy !== undefined) {
+    body.log_management_strategy = props.logManagementStrategy;
+  }
+  if (props.logpush !== undefined) {
+    body.logpush = props.logpush;
+  }
+  if (props.logpushPublicKey !== undefined) {
+    body.logpush_public_key = props.logpushPublicKey;
+  }
+  return body;
+}

package/src/cloudflare/api.ts

@@ -1,6 +1,6 @@
-import type { Secret } from "../secret";
-import { withExponentialBackoff } from "../util/retry";
-import { getCloudflareAuthHeaders, getCloudflareUserInfo } from "./auth";
+import type { Secret } from "../secret.js";
+import { withExponentialBackoff } from "../util/retry.js";
+import { getCloudflareAuthHeaders, getCloudflareUserInfo } from "./auth.js";
 
 /**
  * Options for Cloudflare API requests

package/src/cloudflare/assets.ts

@@ -1,8 +1,8 @@
 import * as fs from "node:fs/promises";
 import * as path from "node:path";
-import type { Context } from "../context";
-import { Resource } from "../resource";
-import { getContentType } from "../util/content-type";
+import type { Context } from "../context.js";
+import { Resource } from "../resource.js";
+import { getContentType } from "../util/content-type.js";
 
 /**
  * Properties for creating or updating Assets

package/src/cloudflare/auth.ts

@@ -1,9 +1,9 @@
 import fs from "node:fs/promises";
 import os from "node:os";
 import path from "node:path";
-import type { Secret } from "../secret";
-import type { CloudflareAccountId } from "./account-id";
-import { handleApiError } from "./api-error";
+import type { Secret } from "../secret.js";
+import type { CloudflareAccountId } from "./account-id.js";
+import { handleApiError } from "./api-error.js";
 /**
  * Authentication options for Cloudflare API
  */
@@ -260,7 +260,7 @@ async function getRefreshedAuthConfig(): Promise<WranglerConfig> {
 }
 
 async function writeWranglerConfig(config: WranglerConfig) {
-  if (config.exists === false) return
+  if (config.exists === false) return;
 
   const TOML = await import("@iarna/toml");
   const configPath = await findWranglerConfig();
@@ -284,17 +284,17 @@ async function readWranglerConfig(): Promise<WranglerConfig> {
     ));
     config.path = configPath;
 
-    return config
+    return config;
   } catch (e: any) {
     if (e.code === "ENOENT") {
       // The config doesn't exist
       return {
         path: configPath,
-        exists: false
-      }
+        exists: false,
+      };
     }
 
-    throw e
+    throw e;
   }
 }
 

package/src/cloudflare/bindings.ts

@@ -3,17 +3,18 @@
  * Based on Cloudflare API documentation:
  * https://developers.cloudflare.com/api/resources/workers/subresources/scripts/methods/update/
  */
-import type { Secret } from "../secret";
-import type { Assets } from "./assets";
-import type { R2Bucket } from "./bucket";
-import type { D1Database } from "./d1-database";
-import type { DurableObjectNamespace } from "./durable-object-namespace";
-import type { KVNamespace } from "./kv-namespace";
-import type { Pipeline } from "./pipeline";
-import type { Queue } from "./queue";
-import type { VectorizeIndex } from "./vectorize-index";
-import type { Worker } from "./worker";
-import type { Workflow } from "./workflow";
+import type { Secret } from "../secret.js";
+import type { AiGateway } from "./ai-gateway.js";
+import type { Assets } from "./assets.js";
+import type { R2Bucket } from "./bucket.js";
+import type { D1Database } from "./d1-database.js";
+import type { DurableObjectNamespace } from "./durable-object-namespace.js";
+import type { KVNamespace } from "./kv-namespace.js";
+import type { Pipeline } from "./pipeline.js";
+import type { Queue } from "./queue.js";
+import type { VectorizeIndex } from "./vectorize-index.js";
+import type { Worker } from "./worker.js";
+import type { Workflow } from "./workflow.js";
 
 export type Bindings = {
   [bindingName: string]: Binding;
@@ -34,7 +35,8 @@ export type Binding =
   | string
   | VectorizeIndex
   | Worker
-  | Workflow;
+  | Workflow
+  | AiGateway;
 
 /**
  * Union type for all Worker binding types (API spec)

package/src/cloudflare/bound.ts

@@ -1,16 +1,17 @@
 import type { Pipeline } from "cloudflare:pipelines";
-import type { Secret } from "../secret";
-import type { Assets } from "./assets";
-import type { Binding } from "./bindings";
-import type { R2Bucket as _R2Bucket } from "./bucket";
-import type { D1Database as _D1Database } from "./d1-database";
-import type { DurableObjectNamespace as _DurableObjectNamespace } from "./durable-object-namespace";
-import type { KVNamespace as _KVNamespace } from "./kv-namespace";
-import type { Pipeline as _Pipeline } from "./pipeline";
-import type { Queue as _Queue } from "./queue";
-import type { VectorizeIndex as _VectorizeIndex } from "./vectorize-index";
-import type { Worker as _Worker } from "./worker";
-import type { Workflow as _Workflow } from "./workflow";
+import type { Secret } from "../secret.js";
+import type { AiGateway as _AiGateway } from "./ai-gateway.js";
+import type { Assets } from "./assets.js";
+import type { Binding } from "./bindings.js";
+import type { R2Bucket as _R2Bucket } from "./bucket.js";
+import type { D1Database as _D1Database } from "./d1-database.js";
+import type { DurableObjectNamespace as _DurableObjectNamespace } from "./durable-object-namespace.js";
+import type { KVNamespace as _KVNamespace } from "./kv-namespace.js";
+import type { Pipeline as _Pipeline } from "./pipeline.js";
+import type { Queue as _Queue } from "./queue.js";
+import type { VectorizeIndex as _VectorizeIndex } from "./vectorize-index.js";
+import type { Worker as _Worker } from "./worker.js";
+import type { Workflow as _Workflow } from "./workflow.js";
 
 export type Bound<T extends Binding> = T extends _DurableObjectNamespace
   ? DurableObjectNamespace
@@ -20,20 +21,22 @@ export type Bound<T extends Binding> = T extends _DurableObjectNamespace
       ? Worker
       : T extends _R2Bucket
         ? R2Bucket
-        : T extends Secret
-          ? string
-          : T extends Assets
-            ? Service
-            : T extends _Workflow<infer P>
-              ? Workflow<P>
-              : T extends _D1Database
-                ? D1Database
-                : T extends _VectorizeIndex
-                  ? VectorizeIndex
-                  : T extends _Queue
-                    ? Queue
-                    : T extends _Pipeline<infer R>
-                      ? Pipeline<R>
-                      : T extends string
-                        ? string
-                        : Service;
+        : T extends _AiGateway
+          ? AiGateway
+          : T extends Secret
+            ? string
+            : T extends Assets
+              ? Service
+              : T extends _Workflow<infer P>
+                ? Workflow<P>
+                : T extends _D1Database
+                  ? D1Database
+                  : T extends _VectorizeIndex
+                    ? VectorizeIndex
+                    : T extends _Queue
+                      ? Queue
+                      : T extends _Pipeline<infer R>
+                        ? Pipeline<R>
+                        : T extends string
+                          ? string
+                          : Service;

package/src/cloudflare/bucket.ts

@@ -1,9 +1,9 @@
 import { AwsClient } from "aws4fetch";
-import type { Context } from "../context";
-import { Resource } from "../resource";
-import type { Secret } from "../secret";
-import { CloudflareApi, createCloudflareApi } from "./api";
-import { CloudflareApiError, handleApiError } from "./api-error";
+import type { Context } from "../context.js";
+import { Resource } from "../resource.js";
+import type { Secret } from "../secret.js";
+import { CloudflareApiError, handleApiError } from "./api-error.js";
+import { CloudflareApi, createCloudflareApi } from "./api.js";
 
 /**
  * Properties for creating or updating an R2 Bucket

package/src/cloudflare/custom-domain.ts

@@ -1,11 +1,11 @@
-import type { Context } from "../context";
-import { Resource } from "../resource";
+import type { Context } from "../context.js";
+import { Resource } from "../resource.js";
+import { handleApiError } from "./api-error.js";
 import {
   CloudflareApi,
   createCloudflareApi,
   type CloudflareApiOptions,
-} from "./api";
-import { handleApiError } from "./api-error";
+} from "./api.js";
 
 /**
  * Properties for creating or updating a CustomDomain

package/src/cloudflare/d1-database.ts

@@ -1,12 +1,12 @@
-import type { Context } from "../context";
-import { Resource } from "../resource";
+import type { Context } from "../context.js";
+import { Resource } from "../resource.js";
+import { CloudflareApiError, handleApiError } from "./api-error.js";
 import {
   CloudflareApi,
   createCloudflareApi,
   type CloudflareApiOptions,
-} from "./api";
-import { CloudflareApiError, handleApiError } from "./api-error";
-import { applyMigrations, listMigrationsFiles } from "./d1-migrations";
+} from "./api.js";
+import { applyMigrations, listMigrationsFiles } from "./d1-migrations.js";
 
 /**
  * Properties for creating or updating a D1 Database

package/src/cloudflare/d1-migrations.ts

@@ -1,7 +1,7 @@
-import * as fs from "fs/promises";
+import * as fs from "node:fs/promises";
 import * as path from "node:path";
-import { CloudflareApi } from "./api";
-import { handleApiError } from "./api-error";
+import { handleApiError } from "./api-error.js";
+import { CloudflareApi } from "./api.js";
 
 export interface D1MigrationOptions {
   migrationsFiles: Array<{ id: string; sql: string }>;

package/src/cloudflare/dns-records.ts

@@ -1,16 +1,16 @@
-import type { Context } from "../context";
+import type { Context } from "../context.js";
 import type {
   DnsRecord as BaseDnsRecord,
   DnsRecordType,
   DnsRecordWithMetadata,
-} from "../dns/record";
-import { Resource } from "../resource";
+} from "../dns/record.js";
+import { Resource } from "../resource.js";
 import {
   type CloudflareApi,
   type CloudflareApiOptions,
   createCloudflareApi,
-} from "./api";
-import type { CloudflareResponse } from "./response";
+} from "./api.js";
+import type { CloudflareResponse } from "./response.js";
 
 /**
  * Cloudflare DNS Record response format

package/src/cloudflare/index.ts

@@ -1,27 +1,28 @@
-export * from "./account-api-token";
-export * from "./api";
-export * from "./api-error";
-export * from "./assets";
-export * from "./bindings";
-export * from "./bucket";
-export * from "./custom-domain";
-export * from "./d1-database";
-export * from "./dns-records";
-export * from "./durable-object-namespace";
-export * from "./kv-namespace";
-export * from "./local-dev-cloudflare-shim";
-export * from "./nuxt";
-export * from "./permission-groups";
-export * from "./pipeline";
-export * from "./queue";
-export * from "./r2-rest-state-store";
-export * from "./redwood";
-export * from "./tanstack-start";
-export * from "./vectorize-index";
-export * from "./vectorize-metadata-index";
-export * from "./vite";
-export * from "./website";
-export * from "./worker";
-export { Workflow } from "./workflow";
-export * from "./wrangler.json";
-export * from "./zone";
+export * from "./account-api-token.js";
+export * from "./ai-gateway.js";
+export * from "./api-error.js";
+export * from "./api.js";
+export * from "./assets.js";
+export * from "./bindings.js";
+export * from "./bucket.js";
+export * from "./custom-domain.js";
+export * from "./d1-database.js";
+export * from "./dns-records.js";
+export * from "./durable-object-namespace.js";
+export * from "./kv-namespace.js";
+export * from "./local-dev-cloudflare-shim.js";
+export * from "./nuxt.js";
+export * from "./permission-groups.js";
+export * from "./pipeline.js";
+export * from "./queue.js";
+export * from "./r2-rest-state-store.js";
+export * from "./redwood.js";
+export * from "./tanstack-start.js";
+export * from "./vectorize-index.js";
+export * from "./vectorize-metadata-index.js";
+export * from "./vite.js";
+export * from "./website.js";
+export * from "./worker.js";
+export { Workflow } from "./workflow.js";
+export * from "./wrangler.json.js";
+export * from "./zone.js";

package/src/cloudflare/kv-namespace.ts

@@ -1,12 +1,12 @@
-import type { Context } from "../context";
-import { Resource } from "../resource";
-import { withExponentialBackoff } from "../util/retry";
+import type { Context } from "../context.js";
+import { Resource } from "../resource.js";
+import { withExponentialBackoff } from "../util/retry.js";
+import { handleApiError } from "./api-error.js";
 import {
   CloudflareApi,
   createCloudflareApi,
   type CloudflareApiOptions,
-} from "./api";
-import { handleApiError } from "./api-error";
+} from "./api.js";
 
 /**
  * Properties for creating or updating a KV Namespace

package/src/cloudflare/nuxt.ts

@@ -1,7 +1,7 @@
-import type { Assets } from "./assets";
-import type { Bindings } from "./bindings";
-import { Website, type WebsiteProps } from "./website";
-import type { Worker } from "./worker";
+import type { Assets } from "./assets.js";
+import type { Bindings } from "./bindings.js";
+import { Website, type WebsiteProps } from "./website.js";
+import type { Worker } from "./worker.js";
 
 /**
  * Properties for creating a Nuxt resource.

package/src/cloudflare/permission-groups.ts

@@ -1,6 +1,6 @@
-import type { Context } from "../context";
-import { Resource } from "../resource";
-import { createCloudflareApi, type CloudflareApiOptions } from "./api";
+import type { Context } from "../context.js";
+import { Resource } from "../resource.js";
+import { createCloudflareApi, type CloudflareApiOptions } from "./api.js";
 
 /**
  * Cloudflare permission group as returned by the API