alchemy 0.62.3 → 0.63.0

package/src/cloudflare/worker.ts

@@ -134,7 +134,7 @@ export interface BaseWorkerProps<
   /**
    * Name for the worker
    *
-   * @default id
+   * @default ${app}-${stage}-${id}
    */
   name?: string;
 
@@ -709,12 +709,14 @@ const _Worker = Resource(
     id: string,
     props: WorkerProps<B>,
   ) {
+    const adopt = props.adopt ?? this.scope.adopt;
     const options = (() => {
       if (props.projectRoot) {
         logger.warn("projectRoot is deprecated, use cwd instead");
         props.cwd = props.projectRoot;
       }
-      const name = props.name ?? id;
+      const name =
+        props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
       const cwd = path.resolve(props.cwd ?? process.cwd());
       const compatibilityDate =
         props.compatibilityDate ?? DEFAULT_COMPATIBILITY_DATE;
@@ -826,12 +828,18 @@ const _Worker = Resource(
         });
         this.onCleanup(() => controller.dispose());
       }
-      await provisionResources(props, {
-        name: options.name,
-        local: true,
-        dispatchNamespace: options.dispatchNamespace,
-        containers: options.containers,
-      });
+      await provisionResources(
+        {
+          ...props,
+          adopt,
+        },
+        {
+          name: options.name,
+          local: true,
+          dispatchNamespace: options.dispatchNamespace,
+          containers: options.containers,
+        },
+      );
       return this({
         ...props,
         type: "service",
@@ -878,13 +886,9 @@ const _Worker = Resource(
           });
         }
         // We always "adopt" when publishing versions
-      } else if (!props.adopt) {
+      } else if (!adopt) {
         await assertWorkerDoesNotExist(api, options.name);
-      } else if (
-        props.adopt &&
-        !options.dispatchNamespace &&
-        props.url === false
-      ) {
+      } else if (adopt && !options.dispatchNamespace && props.url === false) {
         // explicitly disable the workers.dev subdomain
         await disableWorkerSubdomain(api, options.name);
       }
@@ -964,14 +968,20 @@ const _Worker = Resource(
       ),
     );
 
-    const { domains, routes, subdomain } = await provisionResources(props, {
-      name: options.name,
-      local: false,
-      dispatchNamespace: options.dispatchNamespace,
-      containers: options.containers,
-      result,
-      api,
-    });
+    const { domains, routes, subdomain } = await provisionResources(
+      {
+        ...props,
+        adopt,
+      },
+      {
+        name: options.name,
+        local: false,
+        dispatchNamespace: options.dispatchNamespace,
+        containers: options.containers,
+        result,
+        api,
+      },
+    );
 
     const now = new Date();
     return this({
@@ -1044,7 +1054,9 @@ const assertUnique = <T, Key extends keyof T>(
 };
 
 async function provisionResources<B extends Bindings>(
-  props: WorkerProps<B>,
+  props: WorkerProps<B> & {
+    adopt: boolean;
+  },
   options:
     | {
         name: string;

package/src/cloudflare/wrangler.json.ts

@@ -1,7 +1,6 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 import type { Context } from "../context.ts";
-import { formatJson } from "../fs/static-json-file.ts";
 import { Resource } from "../resource.ts";
 import { isSecret } from "../secret.ts";
 import { assertNever } from "../util/assert-never.ts";
@@ -29,7 +28,7 @@ export interface WranglerJsonProps {
    * The worker to generate the wrangler.json file for
    */
   worker:
-    | Worker
+    | Worker<any>
     | (WorkerProps<any> & {
         name: string;
       });
@@ -218,9 +217,9 @@ export const WranglerJson = Resource(
           ),
         },
       };
-      await fs.writeFile(filePath, await formatJson(withSecretsUnwrapped));
+      await writeJSON(filePath, withSecretsUnwrapped);
     } else {
-      await fs.writeFile(filePath, await formatJson(finalSpec));
+      await writeJSON(filePath, finalSpec);
     }
 
     // Return the resource
@@ -234,6 +233,10 @@ export const WranglerJson = Resource(
   },
 );
 
+const writeJSON = async (filePath: string, content: any) => {
+  await fs.writeFile(filePath, `${JSON.stringify(content, null, 2)}\n`);
+};
+
 /**
  * Wrangler.json configuration specification based on Cloudflare's schema
  */

package/src/docker/container.ts

@@ -71,6 +71,8 @@ export interface ContainerProps {
 
   /**
    * Container name
+   *
+   * @default ${app}-${stage}-${id}
    */
   name?: string;
 
@@ -126,6 +128,11 @@ export interface Container
    */
   id: string;
 
+  /**
+   * Container name
+   */
+  name: string;
+
   /**
    * Container state
    */
@@ -184,7 +191,11 @@ export const Container = Resource(
 
     // Use provided name or generate one based on resource ID
     const containerName =
-      props.name || `alchemy-${id.replace(/[^a-zA-Z0-9_.-]/g, "-")}`;
+      props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
+
+    if (this.phase === "update" && this.output.name !== containerName) {
+      this.replace();
+    }
 
     // Handle delete phase
     if (this.phase === "delete") {
@@ -259,6 +270,7 @@ export const Container = Resource(
       return this({
         ...props,
         id: containerId,
+        name: containerName,
         state: containerState,
         createdAt: Date.now(),
       });

package/src/docker/network.ts

@@ -8,8 +8,10 @@ import { DockerApi } from "./api.ts";
 export interface NetworkProps {
   /**
    * Network name
+   *
+   * @default ${app}-${stage}-${id}
    */
-  name: string;
+  name?: string;
 
   /**
    * Network driver to use
@@ -38,6 +40,11 @@ export interface Network extends Resource<"docker::Network">, NetworkProps {
    */
   id: string;
 
+  /**
+   * Network name
+   */
+  name: string;
+
   /**
    * Time when the network was created
    */
@@ -70,12 +77,19 @@ export const Network = Resource(
   "docker::Network",
   async function (
     this: Context<Network>,
-    _id: string,
+    id: string,
     props: NetworkProps,
   ): Promise<Network> {
     // Initialize Docker API client
     const api = new DockerApi();
 
+    const networkName =
+      props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
+
+    if (this.phase === "update" && this.output.name !== networkName) {
+      this.replace();
+    }
+
     // Handle delete phase
     if (this.phase === "delete") {
       if (this.output?.id) {
@@ -88,12 +102,13 @@ export const Network = Resource(
     } else {
       // Create the network
       props.driver = props.driver || "bridge";
-      const networkId = await api.createNetwork(props.name, props.driver);
+      const networkId = await api.createNetwork(networkName, props.driver);
 
       // Return the resource using this() to construct output
       return this({
         ...props,
         id: networkId,
+        name: networkName,
         createdAt: Date.now(),
       });
     }

package/src/docker/volume.ts

@@ -23,8 +23,10 @@ export interface VolumeLabel {
 export interface VolumeProps {
   /**
    * Volume name
+   *
+   * @default ${app}-${stage}-${id}
    */
-  name: string;
+  name?: string;
 
   /**
    * Volume driver to use
@@ -52,6 +54,11 @@ export interface Volume extends Resource<"docker::Volume">, VolumeProps {
    */
   id: string;
 
+  /**
+   * Volume name
+   */
+  name: string;
+
   /**
    * Volume mountpoint path on the host
    */
@@ -94,12 +101,15 @@ export const Volume = Resource(
   "docker::Volume",
   async function (
     this: Context<Volume>,
-    _id: string,
+    id: string,
     props: VolumeProps,
   ): Promise<Volume> {
     // Initialize Docker API client
     const api = new DockerApi();
 
+    const volumeName =
+      props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
+
     // Process labels to ensure consistent format
     const processedLabels: Record<string, string> = {};
     if (props.labels) {
@@ -129,21 +139,22 @@ export const Volume = Resource(
       const driverOpts = props.driverOpts || {};
 
       // Create the volume
-      const volumeName = await api.createVolume(
-        props.name,
+      const volumeId = await api.createVolume(
+        volumeName,
         props.driver,
         driverOpts,
         processedLabels,
       );
 
       // Get volume details to retrieve mountpoint
-      const volumeInfos = await api.inspectVolume(volumeName);
+      const volumeInfos = await api.inspectVolume(volumeId);
       const mountpoint = volumeInfos[0].Mountpoint;
 
       // Return the resource using this() to construct output
       return this({
         ...props,
-        id: volumeName,
+        id: volumeId,
+        name: volumeName,
         mountpoint,
         createdAt: Date.now(),
         labels: Array.isArray(props.labels) ? props.labels : undefined,

package/src/fs/index.ts

@@ -3,11 +3,3 @@ export * from "./file-collection.ts";
 export * from "./file-ref.ts";
 export * from "./file.ts";
 export * from "./folder.ts";
-export * from "./static-astro-file.ts";
-export * from "./static-css-file.ts";
-export * from "./static-html-file.ts";
-export * from "./static-json-file.ts";
-export * from "./static-text-file.ts";
-export * from "./static-typescript-file.ts";
-export * from "./static-vue-file.ts";
-export * from "./static-yaml-file.ts";

package/src/github/client.ts

@@ -1,7 +1,8 @@
-import { Octokit } from "@octokit/rest";
+import type { Octokit } from "@octokit/rest";
 import { exec } from "node:child_process";
 import { promisify } from "node:util";
 import { logger } from "../util/logger.ts";
+import { importPeer } from "../util/peer.ts";
 
 // Convert exec to promise-based
 const execAsync = promisify(exec);
@@ -52,7 +53,10 @@ export async function createGitHubClient(
   options: { token?: string } = {},
 ): Promise<Octokit> {
   const token = await getGitHubToken(options.token);
-
+  const { Octokit } = await importPeer(
+    import("@octokit/rest"),
+    "GitHub resources",
+  );
   return new Octokit({
     auth: token,
   });

package/src/github/repository-environment.ts

@@ -19,8 +19,10 @@ export interface RepositoryEnvironmentProps {
 
   /**
    * Environment name
+   *
+   * @default ${app}-${stage}-${id}
    */
-  name: string;
+  name?: string;
 
   /**
    * Wait timer before allowing deployments to proceed (in minutes)
@@ -104,6 +106,11 @@ export interface RepositoryEnvironment
    */
   id: string;
 
+  /**
+   * Environment name
+   */
+  name: string;
+
   /**
    * The numeric ID of the environment in GitHub
    */
@@ -174,7 +181,7 @@ export const RepositoryEnvironment = Resource(
   "github::RepositoryEnvironment",
   async function (
     this: Context<RepositoryEnvironment>,
-    _id: string,
+    id: string,
     props: RepositoryEnvironmentProps,
   ): Promise<RepositoryEnvironment> {
     // Create authenticated Octokit client
@@ -187,6 +194,13 @@ export const RepositoryEnvironment = Resource(
       await verifyGitHubAuth(octokit, props.owner, props.repository);
     }
 
+    const environmentName =
+      props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
+
+    if (this.phase === "update" && this.output.name !== environmentName) {
+      this.replace();
+    }
+
     if (this.phase === "delete") {
       if (this.output?.id) {
         try {
@@ -194,7 +208,7 @@ export const RepositoryEnvironment = Resource(
           await octokit.rest.repos.deleteAnEnvironment({
             owner: props.owner,
             repo: props.repository,
-            environment_name: props.name,
+            environment_name: environmentName,
           });
         } catch (error: any) {
           // Ignore 404 errors (environment already deleted)
@@ -220,7 +234,7 @@ export const RepositoryEnvironment = Resource(
           });
 
         const existingEnv = environments.environments?.find(
-          (env) => env.name.toLowerCase() === props.name.toLowerCase(),
+          (env) => env.name.toLowerCase() === environmentName.toLowerCase(),
         );
 
         if (existingEnv?.id) {
@@ -303,7 +317,7 @@ export const RepositoryEnvironment = Resource(
           await octokit.rest.repos.createOrUpdateEnvironment({
             owner: props.owner,
             repo: props.repository,
-            environment_name: props.name,
+            environment_name: environmentName,
             wait_timer: props.waitTimer,
             prevent_self_review: props.preventSelfReview,
             reviewers: reviewers.length > 0 ? reviewers : undefined,
@@ -330,7 +344,7 @@ export const RepositoryEnvironment = Resource(
             await octokit.rest.repos.createDeploymentBranchPolicy({
               owner: props.owner,
               repo: props.repository,
-              environment_name: props.name,
+              environment_name: environmentName,
               name: pattern,
             });
           }
@@ -340,7 +354,7 @@ export const RepositoryEnvironment = Resource(
         await octokit.rest.repos.createOrUpdateEnvironment({
           owner: props.owner,
           repo: props.repository,
-          environment_name: props.name,
+          environment_name: environmentName,
           wait_timer: props.waitTimer,
           prevent_self_review: props.preventSelfReview,
           reviewers: reviewers.length > 0 ? reviewers : undefined,
@@ -361,7 +375,7 @@ export const RepositoryEnvironment = Resource(
             await octokit.rest.repos.listDeploymentBranchPolicies({
               owner: props.owner,
               repo: props.repository,
-              environment_name: props.name,
+              environment_name: environmentName,
             });
 
           const existingPatterns = existingPolicies.branch_policies.map(
@@ -402,7 +416,7 @@ export const RepositoryEnvironment = Resource(
               await octokit.rest.repos.deleteDeploymentBranchPolicy({
                 owner: props.owner,
                 repo: props.repository,
-                environment_name: props.name,
+                environment_name: environmentName,
                 branch_policy_id: policy.id,
               });
             }
@@ -413,7 +427,7 @@ export const RepositoryEnvironment = Resource(
             await octokit.rest.repos.createDeploymentBranchPolicy({
               owner: props.owner,
               repo: props.repository,
-              environment_name: props.name,
+              environment_name: environmentName,
               name: pattern,
             });
           }
@@ -424,16 +438,16 @@ export const RepositoryEnvironment = Resource(
       const { data: env } = await octokit.rest.repos.getEnvironment({
         owner: props.owner,
         repo: props.repository,
-        environment_name: props.name,
+        environment_name: environmentName,
       });
 
       // Return environment details
       return this({
-        id: `${props.owner}/${props.repository}/${props.name}`,
+        id: `${props.owner}/${props.repository}/${environmentName}`,
         environmentId: environmentId || env.id,
         owner: props.owner,
         repository: props.repository,
-        name: props.name,
+        name: environmentName,
         waitTimer: props.waitTimer,
         preventSelfReview: props.preventSelfReview,
         adminBypass: props.adminBypass,

package/src/neon/project.ts

@@ -28,8 +28,10 @@ export type NeonRegion =
 export interface NeonProjectProps extends NeonApiOptions {
   /**
    * Name of the project
+   *
+   * @default ${app}-${stage}-${id}
    */
-  name: string;
+  name?: string;
 
   /**
    * Region where the project will be provisioned
@@ -440,6 +442,11 @@ export interface NeonProject
    */
   id: string;
 
+  /**
+   * Name of the Project.
+   */
+  name: string;
+
   /**
    * Time at which the project was created
    */
@@ -515,6 +522,12 @@ export const NeonProject = Resource(
   ): Promise<NeonProject> {
     const api = createNeonApi(props);
     const projectId = props.existing_project_id || this.output?.id;
+    const projectName =
+      props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
+
+    if (this.phase === "update" && this.output.name !== projectName) {
+      this.replace();
+    }
 
     if (this.phase === "delete") {
       try {
@@ -540,7 +553,7 @@ export const NeonProject = Resource(
         // Neon only allows updating the project name
         const projectResponse = await api.patch(`/projects/${projectId}`, {
           project: {
-            name: props.name,
+            name: projectName,
           },
         });
 
@@ -564,7 +577,7 @@ export const NeonProject = Resource(
             // Project exists, update it
             const projectResponse = await api.patch(`/projects/${projectId}`, {
               project: {
-                name: props.name,
+                name: projectName,
               },
             });
 
@@ -585,11 +598,11 @@ export const NeonProject = Resource(
             throw new Error("Failed to check if project exists");
           } else {
             // Project doesn't exist, create new
-            response = await createNewProject(api, props);
+            response = await createNewProject(api, projectName, props);
           }
         } else {
           // No output ID, create new project
-          response = await createNewProject(api, props);
+          response = await createNewProject(api, projectName, props);
         }
       }
 
@@ -640,12 +653,13 @@ export const NeonProject = Resource(
  */
 async function createNewProject(
   api: any,
+  projectName: string,
   props: NeonProjectProps,
 ): Promise<NeonApiResponse> {
   const defaultEndpoint = props.default_endpoint ?? true;
   const projectResponse = await api.post("/projects", {
     project: {
-      name: props.name,
+      name: projectName,
       region_id: props.region_id || "aws-us-east-1",
       pg_version: props.pg_version || 16,
       default_endpoint: defaultEndpoint,

package/src/planetscale/branch.ts

@@ -14,8 +14,10 @@ import {
 export interface BranchProps {
   /**
    * The name of the branch
+   *
+   * @default ${app}-${stage}-${id}
    */
-  name: string;
+  name?: string;
 
   /**
    * The organization ID
@@ -152,9 +154,10 @@ export const Branch = Resource(
   "planetscale::Branch",
   async function (
     this: Context<Branch>,
-    _id: string,
+    id: string,
     props: BranchProps,
   ): Promise<Branch> {
+    const adopt = props.adopt ?? this.scope.adopt;
     const apiKey =
       props.apiKey?.unencrypted || process.env.PLANETSCALE_API_TOKEN;
     if (!apiKey) {
@@ -163,6 +166,14 @@ export const Branch = Resource(
 
     const api = new PlanetScaleApi({ apiKey });
 
+    const branchName =
+      props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
+
+    if (this.phase === "update" && this.output.name !== branchName) {
+      // TODO(sam): maybe we don't need to replace? just branch again? or rename?
+      this.replace();
+    }
+
     if (this.phase === "delete") {
       try {
         if (this.output?.name) {
@@ -201,7 +212,7 @@ export const Branch = Resource(
 
       // Check if branch exists
       const getResponse = await api.get(
-        `/organizations/${props.organizationId}/databases/${props.databaseName}/branches/${props.name}`,
+        `/organizations/${props.organizationId}/databases/${props.databaseName}/branches/${branchName}`,
       );
 
       if (!getResponse.ok && getResponse.status !== 404) {
@@ -213,9 +224,9 @@ export const Branch = Resource(
 
       if (getResponse.ok) {
         // Branch exists
-        if (!props.adopt) {
+        if (!adopt) {
           throw new Error(
-            `Branch ${props.name} already exists and adopt is false`,
+            `Branch ${branchName} already exists and adopt is false`,
           );
         }
 
@@ -245,7 +256,7 @@ export const Branch = Resource(
           const safeMigrationsResponse = await api[
             props.safeMigrations ? "post" : "delete"
           ](
-            `/organizations/${props.organizationId}/databases/${props.databaseName}/branches/${props.name}/safe-migrations`,
+            `/organizations/${props.organizationId}/databases/${props.databaseName}/branches/${branchName}/safe-migrations`,
           );
 
           if (!safeMigrationsResponse.ok) {
@@ -257,7 +268,7 @@ export const Branch = Resource(
 
         if (props.clusterSize && data.cluster_size !== props.clusterSize) {
           const clusterResponse = await api.patch(
-            `/organizations/${props.organizationId}/databases/${props.databaseName}/branches/${props.name}/cluster`,
+            `/organizations/${props.organizationId}/databases/${props.databaseName}/branches/${branchName}/cluster`,
             {
               cluster_size: props.clusterSize,
             },
@@ -272,7 +283,7 @@ export const Branch = Resource(
 
         return this({
           ...props,
-          name: props.name,
+          name: branchName,
           parentBranch: currentParentBranch,
           createdAt: data.created_at,
           updatedAt: data.updated_at,
@@ -285,7 +296,7 @@ export const Branch = Resource(
       const createResponse = await api.post(
         `/organizations/${props.organizationId}/databases/${props.databaseName}/branches`,
         {
-          name: props.name,
+          name: branchName,
           parent_branch: parentBranchName,
           backup_id: props.backupId,
           seed_data: props.seedData,
@@ -308,12 +319,12 @@ export const Branch = Resource(
           api,
           props.organizationId,
           props.databaseName,
-          props.name,
+          branchName,
         );
         const safeMigrationsResponse = await api[
           props.safeMigrations ? "post" : "delete"
         ](
-          `/organizations/${props.organizationId}/databases/${props.databaseName}/branches/${props.name}/safe-migrations`,
+          `/organizations/${props.organizationId}/databases/${props.databaseName}/branches/${branchName}/safe-migrations`,
         );
 
         if (!safeMigrationsResponse.ok) {
@@ -330,7 +341,7 @@ export const Branch = Resource(
           api,
           props.organizationId,
           props.databaseName,
-          props.name,
+          branchName,
           props.clusterSize,
           true,
         );
@@ -338,7 +349,7 @@ export const Branch = Resource(
 
       return this({
         ...props,
-        name: props.name,
+        name: branchName,
         parentBranch: data.parent_branch,
         createdAt: data.created_at,
         updatedAt: data.updated_at,