alchemy 0.71.0 → 0.72.0

package/src/cloudflare/wrangler.json.ts

@@ -4,7 +4,6 @@ import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import { Scope } from "../scope.ts";
 import { isSecret } from "../secret.ts";
-import { unencryptSecrets } from "./util/filter-env-bindings.ts";
 import { assertNever } from "../util/assert-never.ts";
 import type { Bindings, WorkerBindingRateLimit } from "./bindings.ts";
 import type { R2BucketJurisdiction } from "./bucket.ts";
@@ -12,6 +11,7 @@ import type { DurableObjectNamespace } from "./durable-object-namespace.ts";
 import type { EventSource } from "./event-source.ts";
 import { isQueueEventSource } from "./event-source.ts";
 import { isQueue } from "./queue.ts";
+import { unencryptSecrets } from "./util/filter-env-bindings.ts";
 import { isWorker, type Worker, type WorkerProps } from "./worker.ts";
 
 type WranglerJsonRateLimit = Omit<WorkerBindingRateLimit, "type"> & {
@@ -301,7 +301,7 @@ export interface WranglerJsonSpec {
    */
   ai?: {
     binding: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   };
 
   /**
@@ -309,7 +309,7 @@ export interface WranglerJsonSpec {
    */
   browser?: {
     binding: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   };
 
   /**
@@ -317,7 +317,7 @@ export interface WranglerJsonSpec {
    */
   images?: {
     binding: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   };
 
   /**
@@ -330,7 +330,7 @@ export interface WranglerJsonSpec {
      * The ID of the KV namespace used during `wrangler dev`
      */
     preview_id?: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[];
 
   /**
@@ -355,7 +355,7 @@ export interface WranglerJsonSpec {
      * The preview name of this R2 bucket at the edge.
      */
     preview_bucket_name?: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[];
 
   /**
@@ -396,7 +396,7 @@ export interface WranglerJsonSpec {
   vectorize?: {
     binding: string;
     index_name: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[];
 
   /**
@@ -416,7 +416,7 @@ export interface WranglerJsonSpec {
      * The ID of the D1 database used during `wrangler dev`
      */
     preview_database_id?: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[];
 
   /**
@@ -499,7 +499,7 @@ export interface WranglerJsonSpec {
   dispatch_namespaces?: {
     binding: string;
     namespace: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[];
 
   /**
@@ -559,7 +559,7 @@ function processBindings(
     binding: string;
     id: string;
     preview_id: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[] = [];
   const durableObjects: {
     name: string;
@@ -592,7 +592,7 @@ function processBindings(
     database_name: string;
     migrations_dir?: string;
     preview_database_id: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[] = [];
   const queues: {
     producers: { queue: string; binding: string }[];
@@ -608,7 +608,7 @@ function processBindings(
   const vectorizeIndexes: {
     binding: string;
     index_name: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[] = [];
   const analyticsEngineDatasets: { binding: string; dataset: string }[] = [];
   const hyperdrive: {
@@ -625,7 +625,7 @@ function processBindings(
   const dispatchNamespaces: {
     binding: string;
     namespace: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
   }[] = [];
   const unsafeBindings: WranglerJsonRateLimit[] = [];
   const containers: {
@@ -693,9 +693,7 @@ function processBindings(
         binding: bindingName,
         id: id,
         preview_id: id,
-        ...("dev" in binding && binding.dev?.remote
-          ? { experimental_remote: true }
-          : {}),
+        ...("dev" in binding && binding.dev?.remote ? { remote: true } : {}),
       });
     } else if (
       typeof binding === "object" &&
@@ -725,7 +723,7 @@ function processBindings(
         preview_bucket_name: name,
         jurisdiction:
           binding.jurisdiction === "default" ? undefined : binding.jurisdiction,
-        ...(binding.dev?.remote ? { experimental_remote: true } : {}),
+        ...(binding.dev?.remote ? { remote: true } : {}),
       });
     } else if (binding.type === "secret") {
       // Secret binding
@@ -753,7 +751,7 @@ function processBindings(
         database_name: binding.name,
         migrations_dir: binding.migrationsDir,
         preview_database_id: id,
-        ...(binding.dev?.remote ? { experimental_remote: true } : {}),
+        ...(binding.dev?.remote ? { remote: true } : {}),
       });
     } else if (binding.type === "queue") {
       const id =
@@ -769,7 +767,7 @@ function processBindings(
         binding: bindingName,
         index_name: binding.name,
         // https://developers.cloudflare.com/workers/development-testing/#recommended-remote-bindings
-        experimental_remote: true,
+        remote: true,
       });
     } else if (binding.type === "browser") {
       if (spec.browser) {
@@ -778,7 +776,7 @@ function processBindings(
       spec.browser = {
         binding: bindingName,
         // https://developers.cloudflare.com/workers/development-testing/#recommended-remote-bindings
-        experimental_remote: true,
+        remote: true,
       };
     } else if (binding.type === "ai") {
       if (spec.ai) {
@@ -787,7 +785,7 @@ function processBindings(
       spec.ai = {
         binding: bindingName,
         // https://developers.cloudflare.com/workers/development-testing/#recommended-remote-bindings
-        experimental_remote: true,
+        remote: true,
       };
     } else if (binding.type === "images") {
       if (spec.images) {
@@ -796,7 +794,7 @@ function processBindings(
       spec.images = {
         binding: bindingName,
         // https://developers.cloudflare.com/workers/development-testing/#recommended-remote-bindings
-        experimental_remote: true,
+        remote: true,
       };
     } else if (binding.type === "analytics_engine") {
       analyticsEngineDatasets.push({
@@ -837,7 +835,7 @@ function processBindings(
       dispatchNamespaces.push({
         binding: bindingName,
         namespace: binding.namespaceName,
-        experimental_remote: true,
+        remote: true,
       });
     } else if (binding.type === "ratelimit") {
       unsafeBindings.push({

package/src/cloudflare/zone.ts

@@ -414,7 +414,7 @@ export const Zone = Resource(
 
     // Add a small delay to ensure settings are propagated
     // TODO(michael): do we need this?
-    // https://github.com/sam-goodwin/alchemy/issues/681
+    // https://github.com/alchemy-run/alchemy/issues/681
     await new Promise((resolve) => setTimeout(resolve, 2000));
 
     // Update Bot Management configuration if provided

package/src/destroy.ts

@@ -14,6 +14,7 @@ import { isScope, type PendingDeletions, Scope } from "./scope.ts";
 import type { State } from "./state.ts";
 import { formatFQN } from "./util/cli.ts";
 import { logger } from "./util/logger.ts";
+import { createAndSendEvent } from "./util/telemetry.ts";
 
 export function isDestroyedSignal(error: any): error is DestroyedSignal {
   return error instanceof Error && (error as any).kind === "DestroyedSignal";
@@ -109,6 +110,7 @@ export async function destroy(
     logger.warn(`Resource "${instance[ResourceFQN]}" has no scope`);
   }
   const quiet = options?.quiet ?? scope.quiet;
+  const start = performance.now();
 
   try {
     if (!quiet && !options?.noop) {
@@ -122,6 +124,15 @@ export async function destroy(
       });
     }
 
+    await createAndSendEvent({
+      event: "resource.start",
+      resource: instance[ResourceKind],
+      status: "deleting",
+      phase: "destroy",
+      duration: performance.now() - start,
+      replaced: !!options?.replace,
+    });
+
     let state: State;
     let props: ResourceProps | undefined;
     if (options?.replace) {
@@ -224,7 +235,28 @@ export async function destroy(
         status: "success",
       });
     }
+
+    await createAndSendEvent({
+      event: "resource.success",
+      resource: instance[ResourceKind],
+      status: "deleted",
+      phase: "destroy",
+      duration: performance.now() - start,
+      replaced: !!options?.replace,
+    });
   } catch (error) {
+    let errorToSend = error instanceof Error ? error : new Error(String(error));
+    await createAndSendEvent(
+      {
+        event: "resource.error",
+        resource: instance[ResourceKind],
+        duration: performance.now() - start,
+        phase: "destroy",
+        status: "deleting",
+        replaced: !!options?.replace,
+      },
+      errorToSend,
+    );
     logger.error(error);
     throw error;
   }

package/src/docker/image.ts

@@ -190,7 +190,7 @@ export const Image = Resource(
 
       // Add build arguments
       for (const [key, value] of Object.entries(buildOptions)) {
-        buildArgs.push("--build-arg", `${key}="${value}"`);
+        buildArgs.push("--build-arg", `${key}=${value}`);
       }
 
       buildArgs.push("-f", dockerfile);

package/src/planetscale/api.ts

@@ -28,10 +28,6 @@ export interface PlanetScaleProps {
    * @deprecated Use serviceTokenId and serviceToken instead.
    */
   apiKey?: Secret;
-  /**
-   * The organization to use for authentication. Defaults to the value of the PLANETSCALE_ORGANIZATION or PLANETSCALE_ORG_ID environment variable.
-   */
-  organizationId?: string;
 }
 
 export class PlanetScaleError extends Error {

package/src/planetscale/branch.ts

@@ -1,6 +1,7 @@
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import { createPlanetScaleClient, type PlanetScaleProps } from "./api.ts";
+import type { Database } from "./database.ts";
 import {
   ensureProductionBranchClusterSize,
   sanitizeClusterSize,
@@ -20,14 +21,14 @@ export interface BranchProps extends PlanetScaleProps {
   name?: string;
 
   /**
-   * The organization ID
+   * The organization name. Automatically inferred from the database if the database is provided as an object.
    */
-  organizationId: string;
+  organization?: string;
 
   /**
    * The database name
    */
-  databaseName: string;
+  database: string | Database;
 
   /**
    * Whether or not the branch should be set to a production branch or not.
@@ -114,8 +115,8 @@ export interface Branch extends BranchProps {
  * // Create a branch from 'main'
  * const branch = await Branch("feature-123", {
  *   name: "feature-123",
- *   organizationId: "my-org",
- *   databaseName: "my-database",
+ *   organization: "my-org",
+ *   database: "my-database",
  *   parentBranch: "main"
  * });
  *
@@ -123,15 +124,15 @@ export interface Branch extends BranchProps {
  * // Create a branch from another branch object
  * const parentBranch = await Branch("staging", {
  *   name: "staging",
- *   organizationId: "my-org",
- *   databaseName: "my-database",
+ *   organization: "my-org",
+ *   database: "my-database",
  *   parentBranch: "main"
  * });
  *
  * const featureBranch = await Branch("feature-456", {
  *   name: "feature-456",
- *   organizationId: "my-org",
- *   databaseName: "my-database",
+ *   organization: "my-org",
+ *   database: "my-database",
  *   parentBranch: parentBranch // Using Branch object instead of string
  * });
  *
@@ -139,8 +140,8 @@ export interface Branch extends BranchProps {
  * // Create a branch from a backup
  * const branch = await Branch("restored-branch", {
  *   name: "restored-branch",
- *   organizationId: "my-org",
- *   databaseName: "my-database",
+ *   organization: "my-org",
+ *   database: "my-database",
  *   parentBranch: "main",
  *   backupId: "backup-123",
  *   clusterSize: "PS_10"
@@ -164,6 +165,26 @@ export const Branch = Resource(
       : typeof props.parentBranch === "string"
         ? props.parentBranch
         : props.parentBranch.name;
+    const organization =
+      // @ts-expect-error - organizationId is a legacy thing, we keep this so we can destroy
+      this.output?.organizationId ??
+      props.organization ??
+      (typeof props.database !== "string"
+        ? props.database.organization
+        : (process.env.PLANETSCALE_ORGANIZATION ??
+          process.env.PLANETSCALE_ORG_ID));
+    const database =
+      // @ts-expect-error - databaseName is a legacy thing, we keep this so we can destroy
+      this.output?.databaseName ??
+      (typeof props.database === "string"
+        ? props.database
+        : props.database.name);
+
+    if (!organization) {
+      throw new Error(
+        "PlanetScale organization is required. Please set the `organization` property or the `PLANETSCALE_ORGANIZATION` environment variable.",
+      );
+    }
 
     if (this.phase === "update" && this.output.name !== branchName) {
       // TODO(sam): maybe we don't need to replace? just branch again? or rename?
@@ -174,8 +195,8 @@ export const Branch = Resource(
       if (this.output?.name) {
         const response = await api.deleteBranch({
           path: {
-            organization: props.organizationId,
-            database: props.databaseName,
+            organization,
+            database,
             name: this.output.name,
           },
           throwOnError: false,
@@ -196,8 +217,8 @@ export const Branch = Resource(
     if (typeof props.parentBranch !== "string" && props.parentBranch) {
       await waitForBranchReady(
         api,
-        props.organizationId,
-        props.databaseName,
+        organization,
+        database,
         props.parentBranch.name,
       );
     }
@@ -205,8 +226,8 @@ export const Branch = Resource(
     // Check if branch exists
     const getResponse = await api.getBranch({
       path: {
-        organization: props.organizationId,
-        database: props.databaseName,
+        organization,
+        database,
         name: branchName,
       },
       throwOnError: false,
@@ -256,8 +277,8 @@ export const Branch = Resource(
             : "disableSafeMigrations"
         ]({
           path: {
-            organization: props.organizationId,
-            database: props.databaseName,
+            organization,
+            database,
             name: branchName,
           },
         });
@@ -279,8 +300,8 @@ export const Branch = Resource(
         }
         await ensureProductionBranchClusterSize(
           api,
-          props.organizationId,
-          props.databaseName,
+          organization,
+          database,
           branchName,
           data.kind,
           clusterSize,
@@ -299,8 +320,8 @@ export const Branch = Resource(
     let clusterSize: string | undefined;
     const parent = await waitForBranchReady(
       api,
-      props.organizationId,
-      props.databaseName,
+      organization,
+      database,
       parentBranchName,
     );
     if (props.clusterSize) {
@@ -315,8 +336,8 @@ export const Branch = Resource(
     // Branch doesn't exist, create it
     const { data } = await api.createBranch({
       path: {
-        organization: props.organizationId,
-        database: props.databaseName,
+        organization,
+        database,
       },
       body: {
         name: branchName,
@@ -331,18 +352,13 @@ export const Branch = Resource(
     // Handle safe migrations if specified
     if (props.safeMigrations !== undefined) {
       // We can't change the migrations mode if the branch is not ready
-      await waitForBranchReady(
-        api,
-        props.organizationId,
-        props.databaseName,
-        branchName,
-      );
+      await waitForBranchReady(api, organization, database, branchName);
       await api[
         props.safeMigrations ? "enableSafeMigrations" : "disableSafeMigrations"
       ]({
         path: {
-          organization: props.organizationId,
-          database: props.databaseName,
+          organization,
+          database,
           name: branchName,
         },
       });
@@ -352,8 +368,8 @@ export const Branch = Resource(
     if (clusterSize) {
       await ensureProductionBranchClusterSize(
         api,
-        props.organizationId,
-        props.databaseName,
+        organization,
+        database,
         branchName,
         data.kind,
         clusterSize,

package/src/planetscale/database.ts

@@ -18,9 +18,10 @@ interface BaseDatabaseProps extends PlanetScaleProps {
   name?: string;
 
   /**
-   * The organization ID where the database will be created
+   * The organization name where the database will be created
+   * @default process.env.PLANETSCALE_ORGANIZATION
    */
-  organizationId: string;
+  organization?: string;
 
   /**
    * Whether to adopt the database if it already exists in Planetscale
@@ -157,6 +158,11 @@ export type Database = DatabaseProps & {
    * HTML URL to access the database
    */
   htmlUrl: string;
+
+  /**
+   * The organization of the database
+   */
+  organization: string;
 };
 
 /**
@@ -166,7 +172,7 @@ export type Database = DatabaseProps & {
  * // Create a basic database in a specific organization
  * const db = await Database("my-app-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   clusterSize: "PS_10"
  * });
  *
@@ -174,7 +180,7 @@ export type Database = DatabaseProps & {
  * // Create a database with specific region and settings
  * const db = await Database("my-app-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   region: {
  *     slug: "us-east"
  *   },
@@ -188,7 +194,7 @@ export type Database = DatabaseProps & {
  * // Create a database with custom API key
  * const db = await Database("my-app-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   apiKey: alchemy.secret(process.env.CUSTOM_PLANETSCALE_TOKEN),
  *   clusterSize: "PS_10"
  * });
@@ -210,11 +216,22 @@ export const Database = Resource(
       arch: props.arch,
       region: props.region?.slug,
     });
+    const organization =
+      // @ts-expect-error - organizationId is a legacy thing, we keep this so we can destroy
+      this.output?.organizationId ??
+      props.organization ??
+      process.env.PLANETSCALE_ORGANIZATION ??
+      process.env.PLANETSCALE_ORG_ID;
+    if (!organization) {
+      throw new Error(
+        "PlanetScale organization is required. Please set the `organization` property or the `PLANETSCALE_ORGANIZATION` environment variable.",
+      );
+    }
 
     if (this.phase === "update" && this.output.name !== databaseName) {
       await api.updateDatabaseSettings({
         path: {
-          organization: props.organizationId,
+          organization,
           name: this.output.name,
         },
         body: { new_name: databaseName },
@@ -225,7 +242,7 @@ export const Database = Resource(
       if (this.output?.name) {
         const response = await api.deleteDatabase({
           path: {
-            organization: props.organizationId,
+            organization,
             name: this.output.name,
           },
           throwOnError: false,
@@ -243,7 +260,7 @@ export const Database = Resource(
     // Check if database exists
     const getResponse = await api.getDatabase({
       path: {
-        organization: props.organizationId,
+        organization,
         name: databaseName,
       },
       throwOnError: false,
@@ -259,20 +276,20 @@ export const Database = Resource(
       if (props.defaultBranch && props.defaultBranch !== "main") {
         const branchResponse = await api.getBranch({
           path: {
-            organization: props.organizationId,
+            organization,
             database: databaseName,
             name: props.defaultBranch,
           },
           throwOnError: false,
         });
         if (!branchResponse.data) {
-          await waitForDatabaseReady(api, props.organizationId, databaseName);
+          await waitForDatabaseReady(api, organization, databaseName);
         }
         if (branchResponse.error && branchResponse.response.status === 404) {
           // Create the branch
           await api.createBranch({
             path: {
-              organization: props.organizationId,
+              organization,
               database: databaseName,
             },
             body: {
@@ -285,7 +302,7 @@ export const Database = Resource(
 
       const { data } = await api.updateDatabaseSettings({
         path: {
-          organization: props.organizationId,
+          organization,
           name: databaseName,
         },
         body: {
@@ -303,7 +320,7 @@ export const Database = Resource(
 
       await ensureProductionBranchClusterSize(
         api,
-        props.organizationId,
+        organization,
         databaseName,
         props.defaultBranch || "main",
         data.kind,
@@ -320,6 +337,7 @@ export const Database = Resource(
         createdAt: data.created_at,
         updatedAt: data.updated_at,
         htmlUrl: data.html_url,
+        organization,
       };
     }
 
@@ -330,7 +348,7 @@ export const Database = Resource(
     // Create new database
     await api.createDatabase({
       path: {
-        organization: props.organizationId,
+        organization,
       },
       body: {
         name: databaseName,
@@ -343,7 +361,7 @@ export const Database = Resource(
     // These settings can't be set on creation, so we need to patch them after creation.
     const { data } = await api.updateDatabaseSettings({
       path: {
-        organization: props.organizationId,
+        organization,
         name: databaseName,
       },
       body: {
@@ -360,12 +378,12 @@ export const Database = Resource(
 
     // If a non-'main' default branch is specified, create it
     if (props.defaultBranch && props.defaultBranch !== "main") {
-      await waitForDatabaseReady(api, props.organizationId, databaseName);
+      await waitForDatabaseReady(api, organization, databaseName);
 
       // Check if branch exists
       const branchResponse = await api.getBranch({
         path: {
-          organization: props.organizationId,
+          organization,
           database: databaseName,
           name: props.defaultBranch,
         },
@@ -376,7 +394,7 @@ export const Database = Resource(
         // Create the branch
         await api.createBranch({
           path: {
-            organization: props.organizationId,
+            organization,
             database: databaseName,
           },
           body: {
@@ -387,7 +405,7 @@ export const Database = Resource(
 
         await ensureProductionBranchClusterSize(
           api,
-          props.organizationId,
+          organization,
           databaseName,
           props.defaultBranch || "main",
           data.kind,
@@ -397,7 +415,7 @@ export const Database = Resource(
         // Update database to use new branch as default
         const { data: updatedData } = await api.updateDatabaseSettings({
           path: {
-            organization: props.organizationId,
+            organization,
             name: databaseName,
           },
           body: {
@@ -415,6 +433,7 @@ export const Database = Resource(
           createdAt: updatedData.created_at,
           updatedAt: updatedData.updated_at,
           htmlUrl: updatedData.html_url,
+          organization,
         };
       }
     }
@@ -429,6 +448,7 @@ export const Database = Resource(
       createdAt: data.created_at,
       updatedAt: data.updated_at,
       htmlUrl: data.html_url,
+      organization,
     };
   },
 );