alchemy 0.12.21 → 0.13.0

package/src/alchemy.ts

@@ -98,10 +98,12 @@ async function _alchemy(
 ): Promise<Scope | string | never> {
   if (typeof args[0] === "string") {
     const [appName, options] = args as [string, AlchemyOptions?];
+    const phase = options?.phase ?? "up";
     const root = new Scope({
       ...options,
       appName,
       stage: options?.stage,
+      phase,
     });
     root.enter();
     if (options?.phase === "destroy") {
@@ -109,118 +111,123 @@ async function _alchemy(
       return process.exit(0);
     }
     return root;
-  } else {
-    const [template, ...values] = args;
-    const [, secondLine] = template[0].split("\n");
-    const leadingSpaces = secondLine
-      ? secondLine.match(/^(\s*)/)?.[1]?.length || 0
-      : 0;
-    const indent = " ".repeat(leadingSpaces);
+  }
+  const [template, ...values] = args;
+  const [, secondLine] = template[0].split("\n");
+  const leadingSpaces = secondLine
+    ? secondLine.match(/^(\s*)/)?.[1]?.length || 0
+    : 0;
+  const indent = " ".repeat(leadingSpaces);
 
-    const [{ isFileRef }, { isFileCollection }] = await Promise.all([
-      import("./fs/file-ref"),
-      import("./fs/file-collection"),
-    ]);
+  const [{ isFileRef }, { isFileCollection }] = await Promise.all([
+    import("./fs/file-ref.js"),
+    import("./fs/file-collection.js"),
+  ]);
 
-    const appendices: Record<string, string> = {};
+  const appendices: Record<string, string> = {};
 
-    const stringValues = await Promise.all(
-      values.map(async function resolve(value): Promise<string> {
-        if (typeof value === "string") {
-          return indent + value;
-        } else if (value === null) {
-          return "null";
-        } else if (value === undefined) {
-          return "undefined";
-        } else if (
-          typeof value === "number" ||
-          typeof value === "boolean" ||
-          typeof value === "bigint"
-        ) {
-          return value.toString();
-        } else if (value instanceof Promise) {
-          return resolve(await value);
-        } else if (isFileRef(value)) {
-          if (!(value.path in appendices)) {
-            appendices[value.path] = await fs.readFile(value.path, "utf-8");
-          }
+  const stringValues = await Promise.all(
+    values.map(async function resolve(value): Promise<string> {
+      if (typeof value === "string") {
+        return indent + value;
+      }
+      if (value === null) {
+        return "null";
+      }
+      if (value === undefined) {
+        return "undefined";
+      }
+      if (
+        typeof value === "number" ||
+        typeof value === "boolean" ||
+        typeof value === "bigint"
+      ) {
+        return value.toString();
+      }
+      if (value instanceof Promise) {
+        return resolve(await value);
+      }
+      if (isFileRef(value)) {
+        if (!(value.path in appendices)) {
+          appendices[value.path] = await fs.readFile(value.path, "utf-8");
+        }
+        return `[${path.basename(value.path)}](${value.path})`;
+      }
+      if (isFileCollection(value)) {
+        return Object.entries(value.files)
+          .map(([filePath, content]) => {
+            appendices[filePath] = content;
+            return `[${path.basename(filePath)}](${filePath})`;
+          })
+          .join("\n\n");
+      }
+      if (Array.isArray(value)) {
+        return (
+          await Promise.all(
+            value.map(async (value, i) => `${i}. ${await resolve(value)}`),
+          )
+        ).join("\n");
+      }
+      if (typeof value === "object" && typeof value.path === "string") {
+        if (typeof value.content === "string") {
+          appendices[value.path] = value.content;
           return `[${path.basename(value.path)}](${value.path})`;
-        } else if (isFileCollection(value)) {
-          return Object.entries(value.files)
-            .map(([filePath, content]) => {
-              appendices[filePath] = content;
-              return `[${path.basename(filePath)}](${filePath})`;
-            })
-            .join("\n\n");
-        } else if (Array.isArray(value)) {
-          return (
-            await Promise.all(
-              value.map(async (value, i) => `${i}. ${await resolve(value)}`)
-            )
-          ).join("\n");
-        } else if (
-          typeof value === "object" &&
-          typeof value.path === "string"
-        ) {
-          if (typeof value.content === "string") {
-            appendices[value.path] = value.content;
-            return `[${path.basename(value.path)}](${value.path})`;
-          } else {
-            appendices[value.path] = await fs.readFile(value.path, "utf-8");
-            return `[${path.basename(value.path)}](${value.path})`;
-          }
-        } else if (typeof value === "object") {
-          return (
-            await Promise.all(
-              Object.entries(value).map(async ([key, value]) => {
-                return `* ${key}: ${await resolve(value)}`;
-              })
-            )
-          ).join("\n");
-        } else {
-          // TODO: support other types
-          console.log(value);
-          throw new Error(`Unsupported value type: ${value}`);
         }
-      })
-    );
-
-    // Construct the string template by joining template parts with interpolated values
-    const lines = template
-      .map((part) =>
-        part
-          .split("\n")
-          .map((line) =>
-            line.startsWith(indent) ? line.slice(indent.length) : line
+        appendices[value.path] = await fs.readFile(value.path, "utf-8");
+        return `[${path.basename(value.path)}](${value.path})`;
+      }
+      if (typeof value === "object") {
+        return (
+          await Promise.all(
+            Object.entries(value).map(async ([key, value]) => {
+              return `* ${key}: ${await resolve(value)}`;
+            }),
           )
-          .join("\n")
-      )
-      .flatMap((part, i) =>
-        i < stringValues.length ? [part, stringValues[i] ?? ""] : [part]
-      )
-      .join("")
-      .split("\n");
+        ).join("\n");
+      }
+      // TODO: support other types
+      console.log(value);
+      throw new Error(`Unsupported value type: ${value}`);
+    }),
+  );
 
-    // Collect and sort appendices by file path
-    return [
-      // format the user prompt and trim the first line if it's empty
-      lines.length > 1 && lines[0].replaceAll(" ", "").length === 0
-        ? lines.slice(1).join("\n")
-        : lines.join("\n"),
+  // Construct the string template by joining template parts with interpolated values
+  const lines = template
+    .map((part) =>
+      part
+        .split("\n")
+        .map((line) =>
+          line.startsWith(indent) ? line.slice(indent.length) : line,
+        )
+        .join("\n"),
+    )
+    .flatMap((part, i) =>
+      i < stringValues.length ? [part, stringValues[i] ?? ""] : [part],
+    )
+    .join("")
+    .split("\n");
 
-      // sort appendices by path and include at the end of the prompt
-      Object.entries(appendices)
-        .sort(([a], [b]) => a.localeCompare(b))
-        .map(([filePath, content]) => {
-          const extension = path.extname(filePath).slice(1);
-          const codeTag = extension ? extension : "";
-          return `// ${filePath}\n\`\`\`${codeTag}\n${content}\n\`\`\``;
-        })
-        .join("\n\n"),
-    ].join("\n");
-  }
+  // Collect and sort appendices by file path
+  return [
+    // format the user prompt and trim the first line if it's empty
+    lines.length > 1 && lines[0].replaceAll(" ", "").length === 0
+      ? lines.slice(1).join("\n")
+      : lines.join("\n"),
+
+    // sort appendices by path and include at the end of the prompt
+    Object.entries(appendices)
+      .sort(([a], [b]) => a.localeCompare(b))
+      .map(([filePath, content]) => {
+        const extension = path.extname(filePath).slice(1);
+        const codeTag = extension ? extension : "";
+        return `// ${filePath}\n\`\`\`${codeTag}\n${content}\n\`\`\``;
+      })
+      .join("\n\n"),
+  ].join("\n");
 }
 
+export type Phase = "up" | "destroy" | "read";
+
 export interface AlchemyOptions {
   /**
    * The name of the application.
@@ -231,7 +238,7 @@ export interface AlchemyOptions {
    *
    * @default "up"
    */
-  phase?: "up" | "destroy";
+  phase?: Phase;
   /**
    * Name to scope the resource state under (e.g. `.alchemy/{stage}/..`).
    *
@@ -337,7 +344,7 @@ async function run<T>(
       await _scope.parent!.state.set(id, resource);
       _scope.parent!.resources.set(
         id,
-        Object.assign(Promise.resolve(resource), output) as PendingResource
+        Object.assign(Promise.resolve(resource), output) as PendingResource,
       );
     }
     return await _scope.run(async () => fn.bind(_scope)(_scope));

package/src/apply.ts

@@ -18,7 +18,7 @@ export interface ApplyOptions {
 export async function apply<Out extends Resource>(
   resource: PendingResource<Out>,
   props: ResourceProps | undefined,
-  options?: ApplyOptions
+  options?: ApplyOptions,
 ): Promise<Awaited<Out>> {
   const scope = resource.Scope;
   try {
@@ -29,6 +29,14 @@ export async function apply<Out extends Resource>(
     if (provider === undefined) {
       throw new Error(`Provider "${resource.Kind}" not found`);
     }
+    if (scope.phase === "read") {
+      if (state === undefined) {
+        throw new Error(
+          `Resource "${resource.FQN}" not found and running in 'read' phase.`,
+        );
+      }
+      return state.output as Awaited<Out>;
+    }
     if (state === undefined) {
       state = {
         kind: resource.Kind,
@@ -79,7 +87,7 @@ export async function apply<Out extends Resource>(
 
     if (!quiet) {
       console.log(
-        `${phase === "create" ? "Create" : "Update"}:  "${resource.FQN}"`
+        `${phase === "create" ? "Create" : "Update"}:  "${resource.FQN}"`,
       );
     }
 
@@ -99,7 +107,7 @@ export async function apply<Out extends Resource>(
       replace: () => {
         if (isReplaced) {
           console.warn(
-            `Resource ${resource.Kind} ${resource.FQN} is already marked as REPLACE`
+            `Resource ${resource.Kind} ${resource.FQN} is already marked as REPLACE`,
           );
           return;
         }
@@ -112,11 +120,11 @@ export async function apply<Out extends Resource>(
       {
         isResource: true,
       },
-      async () => provider.handler.bind(ctx)(resource.ID, props)
+      async () => provider.handler.bind(ctx)(resource.ID, props),
     );
     if (!quiet) {
       console.log(
-        `${phase === "create" ? "Created" : "Updated"}: "${resource.FQN}"`
+        `${phase === "create" ? "Created" : "Updated"}: "${resource.FQN}"`,
       );
     }
 

package/src/aws/bucket.ts

@@ -136,99 +136,96 @@ export const Bucket = Resource(
         client.send(
           new DeleteBucketCommand({
             Bucket: props.bucketName,
-          })
-        )
+          }),
+        ),
       );
       return this.destroy();
-    } else {
-      try {
-        // Check if bucket exists
+    }
+    try {
+      // Check if bucket exists
+      await client.send(
+        new HeadBucketCommand({
+          Bucket: props.bucketName,
+        }),
+      );
+
+      // Update tags if they changed and bucket exists
+      if (this.phase === "update" && props.tags) {
         await client.send(
-          new HeadBucketCommand({
+          new PutBucketTaggingCommand({
             Bucket: props.bucketName,
-          })
+            Tagging: {
+              TagSet: Object.entries(props.tags).map(([Key, Value]) => ({
+                Key,
+                Value,
+              })),
+            },
+          }),
         );
-
-        // Update tags if they changed and bucket exists
-        if (this.phase === "update" && props.tags) {
-          await client.send(
-            new PutBucketTaggingCommand({
-              Bucket: props.bucketName,
+      }
+    } catch (error: any) {
+      if (error.name === "NotFound") {
+        // Create bucket if it doesn't exist
+        await client.send(
+          new CreateBucketCommand({
+            Bucket: props.bucketName,
+            // Add tags during creation if specified
+            ...(props.tags && {
               Tagging: {
                 TagSet: Object.entries(props.tags).map(([Key, Value]) => ({
                   Key,
                   Value,
                 })),
               },
-            })
-          );
-        }
-      } catch (error: any) {
-        if (error.name === "NotFound") {
-          // Create bucket if it doesn't exist
-          await client.send(
-            new CreateBucketCommand({
-              Bucket: props.bucketName,
-              // Add tags during creation if specified
-              ...(props.tags && {
-                Tagging: {
-                  TagSet: Object.entries(props.tags).map(([Key, Value]) => ({
-                    Key,
-                    Value,
-                  })),
-                },
-              }),
-            })
-          );
-        } else {
-          throw error;
-        }
+            }),
+          }),
+        );
+      } else {
+        throw error;
       }
+    }
 
-      // Get bucket details
-      const [locationResponse, versioningResponse, aclResponse] =
-        await Promise.all([
-          client.send(
-            new GetBucketLocationCommand({ Bucket: props.bucketName })
-          ),
-          client.send(
-            new GetBucketVersioningCommand({ Bucket: props.bucketName })
-          ),
-          client.send(new GetBucketAclCommand({ Bucket: props.bucketName })),
-        ]);
+    // Get bucket details
+    const [locationResponse, versioningResponse, aclResponse] =
+      await Promise.all([
+        client.send(new GetBucketLocationCommand({ Bucket: props.bucketName })),
+        client.send(
+          new GetBucketVersioningCommand({ Bucket: props.bucketName }),
+        ),
+        client.send(new GetBucketAclCommand({ Bucket: props.bucketName })),
+      ]);
 
-      const region = locationResponse.LocationConstraint || "us-east-1";
+    const region = locationResponse.LocationConstraint || "us-east-1";
 
-      // Get tags if they exist
-      let tags = props.tags;
-      if (!tags) {
-        try {
-          const taggingResponse = await client.send(
-            new GetBucketTaggingCommand({ Bucket: props.bucketName })
-          );
-          tags = Object.fromEntries(
-            taggingResponse.TagSet?.map(({ Key, Value }) => [Key, Value]) || []
-          );
-        } catch (error: any) {
-          if (error.name !== "NoSuchTagSet") {
-            throw error;
-          }
+    // Get tags if they exist
+    let tags = props.tags;
+    if (!tags) {
+      try {
+        const taggingResponse = await client.send(
+          new GetBucketTaggingCommand({ Bucket: props.bucketName }),
+        );
+        tags = Object.fromEntries(
+          taggingResponse.TagSet?.map(({ Key, Value }) => [Key, Value]) || [],
+        );
+      } catch (error: any) {
+        if (error.name !== "NoSuchTagSet") {
+          throw error;
         }
       }
-
-      return this({
-        bucketName: props.bucketName,
-        arn: `arn:aws:s3:::${props.bucketName}`,
-        bucketDomainName: `${props.bucketName}.s3.amazonaws.com`,
-        bucketRegionalDomainName: `${props.bucketName}.s3.${region}.amazonaws.com`,
-        region,
-        hostedZoneId: getHostedZoneId(region),
-        versioningEnabled: versioningResponse.Status === "Enabled",
-        acl: aclResponse.Grants?.[0]?.Permission?.toLowerCase(),
-        ...(tags && { tags }),
-      });
     }
-  }
+
+    return this({
+      bucketName: props.bucketName,
+      arn: `arn:aws:s3:::${props.bucketName}`,
+      bucketDomainName: `${props.bucketName}.s3.amazonaws.com`,
+      bucketRegionalDomainName: `${props.bucketName}.s3.${region}.amazonaws.com`,
+      region,
+      hostedZoneId: getHostedZoneId(region),
+      versioningEnabled: versioningResponse.Status === "Enabled",
+      acl: aclResponse.Grants?.[0]?.Permission?.toLowerCase(),
+      ...(tags && { tags }),
+    });
+  },
 );
 
 /**