alchemy 0.68.0 → 0.69.0

package/src/cloudflare/api.ts

@@ -1,5 +1,6 @@
 import { Provider, type Credentials } from "../auth.ts";
 import type { Secret } from "../secret.ts";
+import { isBinary } from "../serde.ts";
 import { memoize } from "../util/memoize.ts";
 import { withExponentialBackoff } from "../util/retry.ts";
 import { safeFetch } from "../util/safe-fetch.ts";
@@ -257,7 +258,7 @@ export class CloudflareApi {
     return this.fetch(path, {
       ...init,
       method: "POST",
-      body: this.toBody(body),
+      body: await this.toBody(body),
     });
   }
 
@@ -272,18 +273,16 @@ export class CloudflareApi {
     return this.fetch(path, {
       ...init,
       method: "PUT",
-      body: this.toBody(body),
+      body: await this.toBody(body),
     });
   }
 
-  toBody(body: BodyInit): BodyInit {
-    return body instanceof FormData
+  async toBody(body: BodyInit): Promise<BodyInit> {
+    return body instanceof FormData ||
+      typeof body === "string" ||
+      isBinary(body)
       ? body
-      : typeof body === "string"
-        ? body
-        : body instanceof ReadableStream
-          ? body
-          : JSON.stringify(body);
+      : JSON.stringify(body);
   }
 
   /**
@@ -297,7 +296,7 @@ export class CloudflareApi {
     return this.fetch(path, {
       ...init,
       method: "PATCH",
-      body: this.toBody(body),
+      body: await this.toBody(body),
     });
   }
 

package/src/cloudflare/astro/astro.ts

@@ -3,7 +3,12 @@ import { getPackageManagerRunner } from "../../util/detect-package-manager.ts";
 import type { Assets } from "../assets.ts";
 import type { Bindings } from "../bindings.ts";
 import { withSkipPathValidation } from "../miniflare/paths.ts";
-import { Website, type WebsiteProps } from "../website.ts";
+import {
+  spreadBuildProps,
+  spreadDevProps,
+  Website,
+  type WebsiteProps,
+} from "../website.ts";
 import type { Worker } from "../worker.ts";
 
 /**
@@ -75,8 +80,8 @@ export async function Astro<B extends Bindings>(
   return await Website(id, {
     ...props,
     noBundle: props.noBundle ?? true,
-    build: props.build ?? `${runner} astro build`,
-    dev: props.dev ?? `${runner} astro dev`,
+    build: spreadBuildProps(props, `${runner} astro build`),
+    dev: spreadDevProps(props, `${runner} astro dev`),
     entrypoint:
       props.entrypoint ??
       (output === "server" ? "dist/_worker.js/index.js" : undefined),

package/src/cloudflare/bucket-object.ts

@@ -0,0 +1,117 @@
+import type { Context } from "../context.ts";
+import { Resource } from "../resource.ts";
+import { createCloudflareApi, type CloudflareApiOptions } from "./api.ts";
+import { deleteObject, type PutObjectObject, type R2Bucket } from "./bucket.ts";
+
+/**
+ * Properties for creating or updating an R2 Object
+ */
+export interface R2ObjectProps extends CloudflareApiOptions {
+  /**
+   * The R2 bucket where the object will be stored
+   */
+  bucket: R2Bucket;
+
+  /**
+   * The key (path/name) of the object within the bucket
+   * Must be a valid object key as defined by R2 storage requirements
+   */
+  key: string;
+
+  /**
+   * The content to store in the object
+   * Supports various data types including streams, buffers, strings, and blobs
+   */
+  content: PutObjectObject;
+}
+
+/**
+ * Output returned after R2 Object creation/update
+ */
+export interface R2Object {
+  /**
+   * The resource identifier
+   */
+  id: string;
+
+  /**
+   * The key (path/name) of the object within the bucket
+   */
+  key: string;
+
+  /**
+   * The etag of the object
+   */
+  etag: string;
+}
+
+/**
+ * Creates and manages objects within Cloudflare R2 Buckets.
+ *
+ * R2 Objects represent individual files or data stored within an R2 bucket.
+ * This resource provides lifecycle management for object creation, updates, and deletion.
+ *
+ * @example
+ * // Create a simple text object in a bucket
+ * const textObject = await R2Object("readme", {
+ *   bucket: myBucket,
+ *   key: "docs/README.txt",
+ *   content: "Welcome to our application!"
+ * });
+ *
+ * @example
+ * // Store JSON data as an object
+ * const configObject = await R2Object("app-config", {
+ *   bucket: configBucket,
+ *   key: "config/app.json",
+ *   content: JSON.stringify({ version: "1.0.0", debug: false })
+ * });
+ *
+ * @example
+ * // Store binary data from a buffer
+ * const imageObject = await R2Object("user-avatar", {
+ *   bucket: assetsBucket,
+ *   key: "avatars/user-123.png",
+ *   content: imageBuffer
+ * });
+ *
+ * @example
+ * // Store data from a readable stream
+ * const streamObject = await R2Object("upload", {
+ *   bucket: uploadsBucket,
+ *   key: "uploads/file.dat",
+ *   content: readableStream
+ * });
+ *
+ * @see https://developers.cloudflare.com/r2/api/workers/workers-api-reference/
+ */
+export const R2Object = Resource(
+  "cloudflare::R2Object",
+  async function (
+    this: Context<R2Object>,
+    id: string,
+    props: R2ObjectProps,
+  ): Promise<R2Object> {
+    if (this.phase === "delete") {
+      const api = await createCloudflareApi(props);
+      // Delete the object from the bucket
+      await deleteObject(api, {
+        bucketName: props.bucket.name,
+        key: props.key,
+      });
+      return this.destroy();
+    } else {
+      if (this.phase === "update" && this.output?.key !== props.key) {
+        this.replace();
+      }
+      // Create or update the object in the bucket
+      const response = await props.bucket.put(props.key, props.content);
+
+      return {
+        id,
+        key: props.key,
+        etag: response.etag,
+      };
+    }
+  },
+);

package/src/cloudflare/bucket.ts

@@ -1,7 +1,9 @@
+import * as mf from "miniflare";
 import { isDeepStrictEqual } from "node:util";
 import type { Context } from "../context.ts";
 import { Resource, ResourceKind } from "../resource.ts";
 import { Scope } from "../scope.ts";
+import { streamToBuffer } from "../serde.ts";
 import { isRetryableError } from "../state/r2-rest-state-store.ts";
 import { withExponentialBackoff } from "../util/retry.ts";
 import { CloudflareApiError, handleApiError } from "./api-error.ts";
@@ -15,6 +17,7 @@ import {
   type CloudflareApiOptions,
 } from "./api.ts";
 import { deleteMiniflareBinding } from "./miniflare/delete.ts";
+import { getDefaultPersistPath } from "./miniflare/paths.ts";
 
 export type R2BucketJurisdiction = "default" | "eu" | "fedramp";
 
@@ -89,6 +92,11 @@ export interface BucketProps extends CloudflareApiOptions {
    */
   lock?: R2BucketLockRule[];
 
+  /**
+   * Enable data catalog for bucket
+   */
+  dataCatalog?: boolean;
+
   /**
    * Whether to emulate the bucket locally when Alchemy is running in watch mode.
    */
@@ -247,7 +255,7 @@ export type R2ObjectMetadata = {
   size: number;
 };
 
-export type R2Object = R2ObjectMetadata & {
+export type R2ObjectContent = R2ObjectMetadata & {
   arrayBuffer(): Promise<ArrayBuffer>;
   bytes(): Promise<Uint8Array>;
   text(): Promise<string>;
@@ -278,7 +286,7 @@ export type R2Objects = {
 
 export type R2Bucket = _R2Bucket & {
   head(key: string): Promise<R2ObjectMetadata | null>;
-  get(key: string): Promise<R2Object | null>;
+  get(key: string): Promise<R2ObjectContent | null>;
   put(
     key: string,
     value:
@@ -337,6 +345,24 @@ type _R2Bucket = Omit<BucketProps, "delete" | "dev"> & {
      */
     remote: boolean;
   };
+
+  /**
+   * Data catalog for the bucket
+   */
+  catalog?: {
+    /**
+     * ID of the data catalog
+     */
+    id: string;
+    /**
+     * Name of the data catalog
+     */
+    name: string;
+    /**
+     * Host of the data catalog
+     */
+    host: string;
+  };
 };
 
 export function isBucket(resource: any): resource is R2Bucket {
@@ -391,6 +417,8 @@ export async function R2Bucket(
   id: string,
   props: BucketProps = {},
 ): Promise<R2Bucket> {
+  const scope = Scope.current;
+  const isLocal = scope.local && props.dev?.remote !== true;
   const api = await createCloudflareApi(props);
   const bucket = await _R2Bucket(id, {
     ...props,
@@ -399,14 +427,44 @@ export async function R2Bucket(
       force: Scope.current.local,
     },
   });
+
+  let _miniflare: mf.Miniflare | undefined;
+  const miniflare = () => {
+    if (_miniflare) {
+      return _miniflare;
+    }
+    _miniflare = new mf.Miniflare({
+      script: "",
+      modules: true,
+      defaultPersistRoot: getDefaultPersistPath(scope.rootDir),
+      r2Buckets: [bucket.dev.id],
+      log: process.env.DEBUG ? new mf.Log(mf.LogLevel.DEBUG) : undefined,
+    });
+    scope.onCleanup(async () => _miniflare?.dispose());
+    return _miniflare;
+  };
+  const localBucket = () => miniflare().getR2Bucket(bucket.dev.id);
+
   return {
     ...bucket,
-    head: async (key: string) =>
-      headObject(api, {
+    head: async (key: string) => {
+      if (isLocal) {
+        return (await localBucket()).head(key);
+      }
+      return headObject(api, {
         bucketName: bucket.name,
         key,
-      }),
+      });
+    },
     get: async (key: string) => {
+      if (isLocal) {
+        const result = await (await localBucket()).get(key);
+        if (result) {
+          // cast because workers vs node built-ins
+          return result as unknown as R2ObjectContent;
+        }
+        return null;
+      }
       const response = await getObject(api, {
         bucketName: bucket.name,
         key,
@@ -419,15 +477,36 @@ export async function R2Bucket(
         throw await handleApiError(response, "get", "object", key);
       }
     },
-    list: async (options?: R2ListOptions): Promise<R2Objects> =>
-      listObjects(api, bucket.name, {
+    list: async (options?: R2ListOptions): Promise<R2Objects> => {
+      if (isLocal) {
+        return (await localBucket()).list(options);
+      }
+      return listObjects(api, bucket.name, {
         ...options,
         jurisdiction: bucket.jurisdiction,
-      }),
+      });
+    },
     put: async (
       key: string,
       value: PutObjectObject,
     ): Promise<PutR2ObjectResponse> => {
+      if (isLocal) {
+        // @ts-expect-error - node built-ins vs cloudflare built-ins
+        return await (await localBucket()).put(
+          key,
+          typeof value === "string"
+            ? value
+            : Buffer.isBuffer(value) ||
+                value instanceof Uint8Array ||
+                value instanceof ArrayBuffer
+              ? new Uint8Array(value)
+              : value instanceof Blob
+                ? new Uint8Array(await value.arrayBuffer())
+                : value instanceof ReadableStream
+                  ? new Uint8Array(await streamToBuffer(value))
+                  : value,
+        );
+      }
       const response = await putObject(api, {
         bucketName: bucket.name,
         key: key,
@@ -450,15 +529,19 @@ export async function R2Bucket(
         size: Number(body.result.size),
       };
     },
-    delete: async (key: string) =>
-      deleteObject(api, {
+    delete: async (key: string) => {
+      if (isLocal) {
+        await (await localBucket()).delete(key);
+      }
+      return deleteObject(api, {
         bucketName: bucket.name,
         key: key,
-      }),
+      });
+    },
   };
 }
 
-const parseR2Object = (key: string, response: Response): R2Object => ({
+const parseR2Object = (key: string, response: Response): R2ObjectContent => ({
   etag: response.headers.get("ETag")!,
   uploaded: parseDate(response.headers),
   key,
@@ -481,7 +564,7 @@ const _R2Bucket = Resource(
     props: BucketProps = {},
   ): Promise<_R2Bucket> {
     const bucketName =
-      props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
+      props.name ?? (this.output?.name || this.scope.createPhysicalName(id));
 
     if (this.phase === "update" && this.output?.name !== bucketName) {
       this.replace();
@@ -513,6 +596,9 @@ const _R2Bucket = Resource(
 
     if (this.phase === "delete") {
       if (props.delete !== false) {
+        if (this.output?.catalog) {
+          await disableDataCatalog(api, bucketName);
+        }
         if (this.output.dev?.id) {
           await deleteMiniflareBinding(this.scope, "r2", this.output.dev.id);
         }
@@ -552,6 +638,16 @@ const _R2Bucket = Resource(
       if (props.lock?.length) {
         await putBucketLockRules(api, bucketName, props);
       }
+      let dataCatalog:
+        | {
+            id: string;
+            name: string;
+            host: string;
+          }
+        | undefined;
+      if (props.dataCatalog) {
+        dataCatalog = await enableDataCatalog(api, bucketName);
+      }
       return {
         name: bucketName,
         location: bucket.location,
@@ -565,6 +661,7 @@ const _R2Bucket = Resource(
         lock: props.lock,
         cors: props.cors,
         dev,
+        catalog: dataCatalog,
       };
     } else {
       if (bucketName !== this.output.name) {
@@ -572,6 +669,13 @@ const _R2Bucket = Resource(
           `Cannot update R2Bucket name after creation. Bucket name is immutable. Before: ${this.output.name}, After: ${bucketName}`,
         );
       }
+      if (this.output?.catalog && !props.dataCatalog) {
+        await disableDataCatalog(api, bucketName);
+        this.output.catalog = undefined;
+      }
+      if (!this.output.catalog && props.dataCatalog) {
+        this.output.catalog = await enableDataCatalog(api, bucketName);
+      }
       let domain = this.output.domain;
       if (!!domain !== allowPublicAccess) {
         domain = await putManagedDomain(
@@ -1079,11 +1183,13 @@ export async function getObject(
   });
 }
 
-type PutObjectObject =
+export type PutObjectObject =
   | ReadableStream
   | ArrayBuffer
   | ArrayBufferView
+  | Uint8Array
   | string
+  | Buffer
   | Blob;
 
 export async function putObject(
@@ -1132,3 +1238,31 @@ export async function deleteObject(
     return response;
   });
 }
+
+export async function enableDataCatalog(
+  api: CloudflareApi,
+  bucketName: string,
+) {
+  const response = await extractCloudflareResult<{
+    id: string;
+    name: string;
+  }>(
+    `enable data catalog for bucket "${bucketName}"`,
+    api.post(`/accounts/${api.accountId}/r2-catalog/${bucketName}/enable`, {}),
+  );
+  return {
+    id: response.id,
+    name: response.name,
+    host: `https://catalog.cloudflarestorage.com/${response.name.replace("_", "/")}`,
+  };
+}
+
+export async function disableDataCatalog(
+  api: CloudflareApi,
+  bucketName: string,
+) {
+  await api.post(
+    `/accounts/${api.accountId}/r2-catalog/${bucketName}/disable`,
+    {},
+  );
+}

package/src/cloudflare/compatibility-date.gen.ts

@@ -4,4 +4,4 @@
 /**
  * The default Cloudflare Workers compatibility date, set based on the latest workerd release at the time of build.
  */
-export const DEFAULT_COMPATIBILITY_DATE = "2025-09-24";
+export const DEFAULT_COMPATIBILITY_DATE = "2025-09-27";

package/src/cloudflare/container.ts

@@ -950,14 +950,13 @@ export async function updateContainerApplication(
   );
   const result = (await response.json()) as {
     result: ContainerApplicationData;
-    errors: { message: string }[];
+    errors: { message: string; code: number }[];
   };
   if (response.ok) {
     return result.result;
   }
-
   throw Error(
-    `Failed to create container application: ${result.errors?.map((e: { message: string }) => e.message).join(", ") ?? "Unknown error"}`,
+    `Failed to create container application: ${result.errors?.map((e) => `[${e.code}] ${e.message}`).join(", ") ?? "Unknown error"}`,
   );
 }
 

package/src/cloudflare/index.ts

@@ -13,6 +13,7 @@ export * from "./astro/astro.ts";
 export * from "./bindings.ts";
 export * from "./bound.ts";
 export * from "./browser-rendering.ts";
+export * from "./bucket-object.ts";
 export * from "./bucket.ts";
 export * from "./certificate-pack.ts";
 export * from "./cloudflare-env-proxy.ts";

package/src/cloudflare/next.ts

@@ -113,7 +113,7 @@ const normalizeCommand = (
     command: string;
     env: Record<string, string>;
   },
-): WebsiteProps<any>["build"] => {
+) => {
   return {
     command:
       typeof input === "string" ? input : (input?.command ?? defaults.command),
@@ -122,5 +122,5 @@ const normalizeCommand = (
       ...(typeof input === "object" ? (input?.env ?? {}) : {}),
     },
     memoize: typeof input === "object" ? input?.memoize : undefined,
-  };
+  } satisfies WebsiteProps<any>["build"];
 };

package/src/cloudflare/nuxt/nuxt.ts

@@ -2,7 +2,12 @@ import path from "node:path";
 import { getPackageManagerRunner } from "../../util/detect-package-manager.ts";
 import type { Assets } from "../assets.ts";
 import type { Bindings } from "../bindings.ts";
-import { Website, type WebsiteProps } from "../website.ts";
+import {
+  spreadBuildProps,
+  spreadDevProps,
+  Website,
+  type WebsiteProps,
+} from "../website.ts";
 import type { Worker } from "../worker.ts";
 
 /**
@@ -55,8 +60,8 @@ export async function Nuxt<B extends Bindings>(
   return await Website(id, {
     ...props,
     noBundle: props?.noBundle ?? true,
-    build: props?.build ?? `${runner} nuxt build`,
-    dev: props?.dev ?? `${runner} nuxt dev`,
+    build: spreadBuildProps(props, `${runner} nuxt build`),
+    dev: spreadDevProps(props, `${runner} nuxt dev`),
     compatibility: "node",
     // Default entry point for cloudflare-module preset
     entrypoint: props?.entrypoint ?? "./.output/server/index.mjs",

package/src/cloudflare/vite/vite.ts

@@ -1,7 +1,12 @@
 import { getPackageManagerRunner } from "../../util/detect-package-manager.ts";
 import type { Assets } from "../assets.ts";
 import type { Bindings } from "../bindings.ts";
-import { Website, type WebsiteProps } from "../website.ts";
+import {
+  spreadBuildProps,
+  spreadDevProps,
+  Website,
+  type WebsiteProps,
+} from "../website.ts";
 import type { Worker } from "../worker.ts";
 
 export interface ViteProps<B extends Bindings> extends WebsiteProps<B> {}
@@ -27,7 +32,7 @@ export async function Vite<B extends Bindings>(
               props.assets?.directory ??
               (props.entrypoint || props.script ? "dist/client" : "dist"),
           },
-    build: props.build ?? `${runner} vite build`,
-    dev: props.dev ?? `${runner} vite dev`,
+    build: spreadBuildProps(props, `${runner} vite build`),
+    dev: spreadDevProps(props, `${runner} vite dev`),
   });
 }

package/src/cloudflare/website.ts

@@ -27,7 +27,7 @@ export interface WebsiteProps<B extends Bindings>
         /**
          * The command to run to build the site
          */
-        command: string;
+        command?: string;
         /**
          * Additional environment variables to set when running the build command
          */
@@ -287,7 +287,7 @@ export async function Website<B extends Bindings>(
 
   const scope = Scope.current;
 
-  if (build && !scope.local) {
+  if (build?.command && !scope.local) {
     await Exec(`${id}-build`, {
       cwd: path.relative(process.cwd(), paths.cwd),
       command: build.command,
@@ -353,3 +353,29 @@ export async function Website<B extends Bindings>(
     dev: url ? { url } : undefined,
   })) as Website<B>;
 }
+
+export const spreadBuildProps = (
+  props: { build?: WebsiteProps<Bindings>["build"] } | undefined,
+  defaultCommand: string,
+): WebsiteProps<Bindings>["build"] => {
+  if (typeof props?.build === "object") {
+    return {
+      ...props.build,
+      command: props.build.command ?? defaultCommand,
+    };
+  }
+  return props?.build ?? defaultCommand;
+};
+
+export const spreadDevProps = (
+  props: { dev?: WebsiteProps<Bindings>["dev"] } | undefined,
+  defaultCommand: string,
+): WebsiteProps<Bindings>["dev"] => {
+  if (typeof props?.dev === "object") {
+    return {
+      ...props.dev,
+      command: props.dev.command ?? defaultCommand,
+    };
+  }
+  return props?.dev ?? defaultCommand;
+};