alchemy 0.7.1 → 0.7.3

package/lib/cloudflare/bindings.d.ts

@@ -9,6 +9,7 @@ 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 { Worker } from "./worker";
 import type { Workflow } from "./workflow";
@@ -18,11 +19,11 @@ export type Bindings = {
 /**
  * L2 Binding Resources.
  */
-export type Binding = Assets | D1Database | DurableObjectNamespace | KVNamespace | Queue | R2Bucket | Secret | string | Worker | Workflow;
+export type Binding = Assets | D1Database | DurableObjectNamespace | KVNamespace | Pipeline | Queue | R2Bucket | Secret | string | Worker | Workflow;
 /**
  * Union type for all Worker binding types (API spec)
  */
-export type WorkerBindingSpec = WorkerBindingAI | WorkerBindingAnalyticsEngine | WorkerBindingAssets | WorkerBindingBrowserRendering | WorkerBindingD1 | WorkerBindingDispatchNamespace | WorkerBindingDurableObjectNamespace | WorkerBindingHyperdrive | WorkerBindingJson | WorkerBindingKVNamespace | WorkerBindingMTLSCertificate | WorkerBindingPlainText | WorkerBindingQueue | WorkerBindingR2Bucket | WorkerBindingSecretText | WorkerBindingService | WorkerBindingStaticContent | WorkerBindingTailConsumer | WorkerBindingVectorize | WorkerBindingVersionMetadata | WorkerBindingWasmModule | WorkerBindingWorkflow;
+export type WorkerBindingSpec = WorkerBindingAI | WorkerBindingAnalyticsEngine | WorkerBindingAssets | WorkerBindingBrowserRendering | WorkerBindingD1 | WorkerBindingDispatchNamespace | WorkerBindingDurableObjectNamespace | WorkerBindingHyperdrive | WorkerBindingJson | WorkerBindingKVNamespace | WorkerBindingMTLSCertificate | WorkerBindingPipeline | WorkerBindingPlainText | WorkerBindingQueue | WorkerBindingR2Bucket | WorkerBindingSecretText | WorkerBindingService | WorkerBindingStaticContent | WorkerBindingTailConsumer | WorkerBindingVectorize | WorkerBindingVersionMetadata | WorkerBindingWasmModule | WorkerBindingWorkflow;
 /**
  * AI binding type
  */
@@ -278,3 +279,14 @@ export interface WorkerBindingWorkflow {
      */
     script_name?: string;
 }
+/**
+ * Pipeline binding type
+ */
+export interface WorkerBindingPipeline {
+    /** The name of the binding */
+    name: string;
+    /** Type identifier for Pipeline binding */
+    type: "pipelines";
+    /** Pipeline name */
+    pipeline: string;
+}

package/lib/cloudflare/bound.d.ts

@@ -1,3 +1,4 @@
+import type { Pipeline } from "cloudflare:pipelines";
 import type { Secret } from "../secret";
 import type { Assets } from "./assets";
 import type { Binding } from "./bindings";
@@ -5,7 +6,8 @@ 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 { Worker as _Worker } from "./worker";
 import type { Workflow as _Workflow } from "./workflow";
-export type Bound<T extends Binding> = T extends _DurableObjectNamespace ? DurableObjectNamespace : T extends _KVNamespace ? KVNamespace : T extends _Worker ? 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 _Queue ? Queue : Service;
+export type Bound<T extends Binding> = T extends _DurableObjectNamespace ? DurableObjectNamespace : T extends _KVNamespace ? KVNamespace : T extends _Worker ? 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 _Queue ? Queue : T extends _Pipeline<infer R> ? Pipeline<R> : Service;

package/lib/cloudflare/bucket.js

@@ -205,6 +205,7 @@ export async function emptyBucket(r2, bucketName, jurisdiction) {
     let totalDeleted = 0;
     try {
         do {
+            console.log(`Listing objects in bucket ${bucketName}`);
             // List objects in the bucket
             const { objects, continuationToken: nextToken } = await listObjects(r2, bucketName, continuationToken, jurisdiction);
             continuationToken = nextToken;

package/lib/cloudflare/d1-database.d.ts

@@ -33,6 +33,13 @@ export interface D1DatabaseProps extends CloudflareApiOptions {
      * @default true
      */
     delete?: boolean;
+    /**
+     * Whether to adopt an existing database with the same name if it exists
+     * If true and a database with the same name exists, it will be adopted rather than creating a new one
+     *
+     * @default false
+     */
+    adopt?: boolean;
 }
 /**
  * Output returned after D1 Database creation/update
@@ -84,6 +91,16 @@ export interface D1Database extends Resource<"cloudflare::D1Database">, D1Databa
  *   primaryLocationHint: "wnam"
  * });
  *
+ * @example
+ * // Adopt an existing database if it already exists instead of failing
+ * const existingDb = await D1Database("existing-db", {
+ *   name: "existing-db",
+ *   adopt: true,
+ *   readReplication: {
+ *     mode: "auto"
+ *   }
+ * });
+ *
  * @see https://developers.cloudflare.com/d1/
  */
 export declare const D1Database: (((this: any, id: string, props?: {}) => never) & (new (_: never) => never)) | ((this: Context<D1Database>, id: string, props: D1DatabaseProps) => Promise<D1Database>);
@@ -121,7 +138,7 @@ export declare function deleteDatabase(api: CloudflareApi, databaseId?: string):
 /**
  * List all D1 databases in an account
  */
-export declare function listDatabases(api: CloudflareApi): Promise<{
+export declare function listDatabases(api: CloudflareApi, name?: string): Promise<{
     name: string;
     id: string;
 }[]>;

package/lib/cloudflare/d1-database.js

@@ -20,6 +20,16 @@ import { CloudflareApiError, handleApiError } from "./api-error";
  *   primaryLocationHint: "wnam"
  * });
  *
+ * @example
+ * // Adopt an existing database if it already exists instead of failing
+ * const existingDb = await D1Database("existing-db", {
+ *   name: "existing-db",
+ *   adopt: true,
+ *   readReplication: {
+ *     mode: "auto"
+ *   }
+ * });
+ *
  * @see https://developers.cloudflare.com/d1/
  */
 export const D1Database = Resource("cloudflare::D1Database", async function (id, props) {
@@ -39,7 +49,34 @@ export const D1Database = Resource("cloudflare::D1Database", async function (id,
         let dbData;
         if (this.phase === "create") {
             console.log("Creating D1 database:", databaseName);
-            dbData = await createDatabase(api, databaseName, props);
+            try {
+                dbData = await createDatabase(api, databaseName, props);
+            }
+            catch (error) {
+                // Check if this is a "database already exists" error and adopt is enabled
+                if (props.adopt &&
+                    error instanceof CloudflareApiError &&
+                    error.message.includes("already exists")) {
+                    console.log(`Database ${databaseName} already exists, adopting it`);
+                    // Find the existing database by name
+                    const databases = await listDatabases(api, databaseName);
+                    const existingDb = databases.find((db) => db.name === databaseName);
+                    if (!existingDb) {
+                        throw new Error(`Failed to find existing database '${databaseName}' for adoption`);
+                    }
+                    // Get the database details using its ID
+                    dbData = await getDatabase(api, existingDb.id);
+                    // Update the database with the provided properties
+                    if (props.readReplication) {
+                        console.log(`Updating adopted database ${databaseName} with new properties`);
+                        dbData = await updateDatabase(api, existingDb.id, props);
+                    }
+                }
+                else {
+                    // Re-throw the error if adopt is false or it's not a "database already exists" error
+                    throw error;
+                }
+            }
         }
         else {
             // Update operation
@@ -117,8 +154,10 @@ export async function deleteDatabase(api, databaseId) {
 /**
  * List all D1 databases in an account
  */
-export async function listDatabases(api) {
-    const response = await api.get(`/accounts/${api.accountId}/d1/database`);
+export async function listDatabases(api, name) {
+    // Construct query string if name is provided
+    const queryParams = name ? `?name=${encodeURIComponent(name)}` : "";
+    const response = await api.get(`/accounts/${api.accountId}/d1/database${queryParams}`);
     if (!response.ok) {
         throw new CloudflareApiError(`Failed to list databases: ${response.statusText}`, response);
     }

package/lib/cloudflare/index.d.ts

@@ -10,6 +10,7 @@ export * from "./dns-records";
 export * from "./durable-object-namespace";
 export * from "./kv-namespace";
 export * from "./permission-groups";
+export * from "./pipeline";
 export * from "./queue";
 export * from "./r2-rest-state-store";
 export * from "./worker";

package/lib/cloudflare/index.js

@@ -10,6 +10,7 @@ export * from "./dns-records";
 export * from "./durable-object-namespace";
 export * from "./kv-namespace";
 export * from "./permission-groups";
+export * from "./pipeline";
 export * from "./queue";
 export * from "./r2-rest-state-store";
 export * from "./worker";

package/lib/cloudflare/pipeline.d.ts

@@ -0,0 +1,335 @@
+import type { Context } from "../context";
+import { Resource } from "../resource";
+import type { Secret } from "../secret";
+import { CloudflareApi, type CloudflareApiOptions } from "./api";
+/**
+ * Settings for compression of pipeline output
+ */
+export interface CompressionSettings {
+    /**
+     * Type of compression to use for pipeline output
+     * @default "gzip"
+     */
+    type: "gzip" | "none";
+}
+/**
+ * Settings for batching behavior of pipeline output
+ */
+export interface BatchSettings {
+    /**
+     * Maximum size of batch in megabytes before delivery (1-100 MB)
+     * @default 100
+     */
+    maxMb?: number;
+    /**
+     * Maximum number of rows in a batch before delivery (1-10,000,000 rows)
+     * @default 10000000
+     */
+    maxRows?: number;
+    /**
+     * Maximum duration of a batch in seconds before delivery (1-300 seconds)
+     * @default 300
+     */
+    maxSeconds?: number;
+}
+/**
+ * Configuration for a pipeline HTTP source
+ */
+export interface HttpSource {
+    /**
+     * Format of the source data
+     * @default "json"
+     */
+    format: "json";
+    /**
+     * Type of source
+     */
+    type: "http";
+    /**
+     * Whether authentication is required
+     * @default true
+     */
+    authentication?: boolean;
+    /**
+     * CORS configuration for HTTP endpoint source
+     */
+    cors?: {
+        /**
+         * Allowed origins for CORS requests
+         * @default ["*"]
+         */
+        origins: string[];
+    };
+}
+/**
+ * Configuration for a pipeline binding source
+ */
+export interface BindingSource {
+    /**
+     * Format of the source data
+     * @default "json"
+     */
+    format: "json";
+    /**
+     * Type of source
+     */
+    type: "binding";
+}
+/**
+ * Configuration for a pipeline source
+ */
+export type PipelineSource = HttpSource | BindingSource;
+/**
+ * Configuration for an R2 destination
+ */
+export interface R2DestinationConfig {
+    /**
+     * Type of destination (R2)
+     */
+    type: "r2";
+    /**
+     * Format of the output data
+     * @default "json"
+     */
+    format: "json" | "ndjson";
+    /**
+     * Path configuration for the R2 destination
+     */
+    path: {
+        /**
+         * R2 bucket name
+         */
+        bucket: string;
+        /**
+         * Optional prefix for files in the bucket
+         */
+        prefix?: string;
+        /**
+         * Optional filename pattern
+         * @default "${slug}${extension}"
+         */
+        filename?: string;
+        /**
+         * Optional filepath pattern
+         * @default "${date}/${hour}"
+         */
+        filepath?: string;
+    };
+    /**
+     * Compression settings
+     */
+    compression?: CompressionSettings;
+    /**
+     * Batch settings
+     */
+    batch?: BatchSettings;
+    /**
+     * Credentials for the R2 bucket
+     * Required for R2 destinations
+     */
+    credentials: {
+        /**
+         * Access key ID for the R2 bucket
+         */
+        accessKeyId: Secret;
+        /**
+         * Secret access key for the R2 bucket
+         */
+        secretAccessKey: Secret;
+        /**
+         * Endpoint for the R2 bucket
+         */
+        endpoint?: string;
+    };
+}
+/**
+ * Allowed destination types
+ */
+export type PipelineDestination = R2DestinationConfig;
+/**
+ * Properties for creating or updating a Pipeline
+ */
+export interface PipelineProps extends CloudflareApiOptions {
+    /**
+     * Name of the pipeline
+     */
+    name: string;
+    /**
+     * Source configuration for the pipeline
+     */
+    source: PipelineSource[];
+    /**
+     * Destination configuration for the pipeline
+     */
+    destination: PipelineDestination;
+    /**
+     * Compression settings for the pipeline
+     * @default { type: "gzip" }
+     */
+    compression?: CompressionSettings;
+    /**
+     * Whether to delete the pipeline.
+     * If set to false, the pipeline will remain but the resource will be removed from state
+     *
+     * @default true
+     */
+    delete?: boolean;
+}
+/**
+ * Base type for pipeline records
+ */
+export interface PipelineRecord {
+    [key: string]: any;
+}
+/**
+ * Output returned after Pipeline creation/update
+ */
+export interface Pipeline<T extends PipelineRecord = PipelineRecord> extends Resource<"cloudflare::Pipeline">, PipelineProps {
+    /**
+     * Type identifier for the Pipeline resource
+     */
+    type: "pipeline";
+    /**
+     * The unique ID of the pipeline
+     */
+    id: string;
+    /**
+     * HTTP endpoint URL for the pipeline
+     */
+    endpoint: string;
+    /**
+     * Version of the pipeline
+     */
+    version: number;
+}
+/**
+ * Creates and manages Cloudflare Pipelines.
+ *
+ * Pipelines provide a managed data pipeline service that lets you collect, transform,
+ * and route data to various destinations like R2 buckets.
+ *
+ * @example
+ * // Create a basic pipeline with an R2 bucket destination
+ * const bucket = await R2Bucket("logs-bucket", {
+ *   name: "logs-bucket"
+ * });
+ *
+ * const accessKey = alchemy.secret(process.env.R2_ACCESS_KEY_ID!);
+ * const secretKey = alchemy.secret(process.env.R2_SECRET_ACCESS_KEY!);
+ *
+ * const pipeline = await Pipeline("logs-pipeline", {
+ *   name: "logs-pipeline",
+ *   destination: {
+ *     type: "r2",
+ *     format: "json",
+ *     path: {
+ *       bucket: bucket.name,
+ *       prefix: "app-logs",
+ *     },
+ *     credentials: {
+ *       accessKeyId: accessKey,
+ *       secretAccessKey: secretKey
+ *     }
+ *   },
+ *   batch: {
+ *     maxMb: 50,
+ *     maxSeconds: 60
+ *   }
+ * });
+ *
+ * @example
+ * // Create a pipeline with custom source configuration
+ * const customPipeline = await Pipeline("custom-pipeline", {
+ *   name: "custom-pipeline",
+ *   source: [{
+ *     type: "http",
+ *     format: "json",
+ *     authentication: true,
+ *     cors: {
+ *       origins: ["https://example.com"]
+ *     }
+ *   }],
+ *   destination: {
+ *     type: "r2",
+ *     format: "json",
+ *     path: {
+ *       bucket: "my-bucket",
+ *       prefix: "data"
+ *     },
+ *     credentials: {
+ *       accessKeyId: alchemy.secret(process.env.R2_ACCESS_KEY_ID!),
+ *       secretAccessKey: alchemy.secret(process.env.R2_SECRET_ACCESS_KEY!)
+ *     },
+ *     compression: {
+ *       type: "gzip"
+ *     }
+ *   }
+ * });
+ *
+ * @see https://developers.cloudflare.com/pipelines/
+ */
+export declare const Pipeline: (((this: any, id: string, props?: {}) => never) & (new (_: never) => never)) | (<T extends PipelineRecord = PipelineRecord>(this: Context<Pipeline<T>>, id: string, props: PipelineProps) => Promise<Pipeline<T>>);
+interface CloudflarePipelineResponse {
+    result: {
+        id: string;
+        name: string;
+        endpoint: string;
+        version: number;
+        source: Array<{
+            type: "http" | "binding";
+            format: string;
+            authentication?: boolean;
+            cors?: {
+                origins: string[];
+            };
+        }>;
+        destination: {
+            type: string;
+            format: string;
+            path?: {
+                bucket: string;
+                prefix?: string;
+                filename?: string;
+                filepath?: string;
+            };
+            compression?: {
+                type: string;
+            };
+            batch: {
+                max_bytes?: number;
+                max_rows?: number;
+                max_duration_s?: number;
+            };
+        };
+    };
+    success: boolean;
+    errors: Array<{
+        code: number;
+        message: string;
+    }>;
+    messages: string[];
+}
+/**
+ * Get a pipeline
+ */
+export declare function getPipeline(api: CloudflareApi, pipelineName: string): Promise<CloudflarePipelineResponse>;
+/**
+ * Delete a pipeline
+ */
+export declare function deletePipeline(api: CloudflareApi, pipelineName: string): Promise<void>;
+/**
+ * Create a new pipeline
+ */
+export declare function createPipeline(api: CloudflareApi, pipelineName: string, props: PipelineProps): Promise<CloudflarePipelineResponse>;
+/**
+ * Update a pipeline
+ */
+export declare function updatePipeline(api: CloudflareApi, pipelineName: string, props: PipelineProps): Promise<CloudflarePipelineResponse>;
+/**
+ * List all pipelines in an account
+ */
+export declare function listPipelines(api: CloudflareApi): Promise<{
+    name: string;
+    id: string;
+}[]>;
+export {};