alchemy 0.3.0 → 0.4.0

package/src/fs/file.ts

@@ -52,6 +52,28 @@ declare module "../alchemy" {
      */
     files(paths: string[]): Promise<FileCollection>;
     files(path: string, ...paths: string[]): Promise<FileCollection>;
+
+    /**
+     * Gets all of the files in a directory.
+     * @param path Path to the directory
+     * @param props Optional properties
+     * @returns Promise resolving to a FileCollection
+     *
+     * @example
+     * // Get all files in a directory
+     * const files = await alchemy.folder("./docs");
+     *
+     */
+    folder(
+      path: string,
+      props?: {
+        /**
+         * Whether to recursively get all files in the directory
+         * @default false
+         */
+        recursive?: boolean;
+      }
+    ): Promise<FileCollection>;
   }
 }
 
@@ -72,12 +94,19 @@ alchemy.files = async (
         paths.map(async (path) => [
           path,
           await fs.promises.readFile(path, "utf-8"),
-        ]),
-      ),
+        ])
+      )
     ),
   };
 };
 
+alchemy.folder = async (dir: string, props?: { recursive?: boolean }) => {
+  const files = await fs.promises.readdir(dir, {
+    recursive: props?.recursive ?? false,
+  });
+  return alchemy.files(files.map((file) => path.join(dir, file)));
+};
+
 /**
  * Base file resource type
  */
@@ -111,6 +140,19 @@ export interface File extends Resource<"fs::File"> {
  *   path: "logs/app.log",
  *   content: "application log entry"
  * });
+ *
+ * @example
+ * // Update file content and path
+ * let file = await File("config.json", {
+ *   path: "config.json",
+ *   content: '{ "version": "1.0.0" }'
+ * });
+ *
+ * // Later, update the path and content (old file will be removed)
+ * file = await File("config.json", {
+ *   path: "config/config.json",
+ *   content: '{ "version": "1.0.1" }'
+ * });
  */
 export const File = Resource(
   "fs::File",
@@ -120,21 +162,34 @@ export const File = Resource(
     props: {
       path: string;
       content: string;
-    },
+    }
   ): Promise<File> {
     const filePath = props?.path ?? id;
+
     if (this.phase === "delete") {
       await ignore("ENOENT", async () => fs.promises.unlink(filePath));
       return this.destroy();
-    } else {
-      await fs.promises.mkdir(path.dirname(filePath), {
-        recursive: true,
-      });
-      await fs.promises.writeFile(filePath, props.content);
+    } else if (
+      this.phase === "update" &&
+      this.output &&
+      this.output.path !== filePath
+    ) {
+      // If path has changed, delete the old file
+      console.log(
+        `File: Path changed from ${this.output.path} to ${filePath}, removing old file`
+      );
+      await ignore("ENOENT", async () => fs.promises.unlink(this.output.path));
     }
+
+    // Create directory and write file
+    await fs.promises.mkdir(path.dirname(filePath), {
+      recursive: true,
+    });
+    await fs.promises.writeFile(filePath, props.content);
+
     return this({
       path: filePath,
       content: props.content,
     });
-  },
+  }
 );

package/src/fs/index.ts

@@ -1,8 +1,14 @@
+export * from "./copy-file";
 export * from "./file";
 export * from "./file-collection";
 export * from "./file-ref";
+export * from "./file-system-state-store";
 export * from "./folder";
+export * from "./static-astro-file";
+export * from "./static-css-file";
+export * from "./static-html-file";
 export * from "./static-json-file";
 export * from "./static-text-file";
 export * from "./static-typescript-file";
+export * from "./static-vue-file";
 export * from "./static-yaml-file";

package/src/fs/static-astro-file.ts

@@ -0,0 +1,45 @@
+import { File } from "./file";
+
+export type StaticAstroFile = File;
+
+/**
+ * Creates a static Astro component file
+ *
+ * @example
+ * // Create an Astro component file with content
+ * const header = await StaticAstroFile("Header.astro",
+ *   `---
+ *   import Logo from '../components/Logo.astro';
+ *   const navItems = ['Home', 'About', 'Contact'];
+ *   ---
+ *
+ *   <header class="header">
+ *     <Logo />
+ *     <nav>
+ *       <ul>
+ *         {navItems.map(item => (
+ *           <li><a href={`/${item.toLowerCase()}`}>{item}</a></li>
+ *         ))}
+ *       </ul>
+ *     </nav>
+ *   </header>
+ *
+ *   <style>
+ *     .header {
+ *       display: flex;
+ *       justify-content: space-between;
+ *       padding: 1rem;
+ *     }
+ *   </style>`
+ * );
+ */
+export function StaticAstroFile(
+  id: string,
+  ...args: [content: string] | [path: string, content: string]
+): Promise<StaticAstroFile> {
+  const [path, content] = args.length === 1 ? [id, args[0]] : args;
+  return File(id, {
+    path,
+    content,
+  });
+}

package/src/fs/static-css-file.ts

@@ -0,0 +1,35 @@
+import { File } from "./file";
+
+export type StaticCSSFile = File;
+
+/**
+ * Creates a static CSS file
+ *
+ * @example
+ * // Create a CSS file with styles
+ * const styles = await StaticCSSFile("styles.css",
+ *   `.container {
+ *     max-width: 1200px;
+ *     margin: 0 auto;
+ *     padding: 0 1rem;
+ *   }
+ *
+ *   .button {
+ *     background-color: #0062ff;
+ *     color: white;
+ *     border: none;
+ *     padding: 0.5rem 1rem;
+ *     border-radius: 4px;
+ *   }`
+ * );
+ */
+export function StaticCSSFile(
+  id: string,
+  ...args: [content: string] | [path: string, content: string]
+): Promise<StaticCSSFile> {
+  const [path, content] = args.length === 1 ? [id, args[0]] : args;
+  return File(id, {
+    path,
+    content,
+  });
+}

package/src/fs/static-html-file.ts

@@ -0,0 +1,42 @@
+import { File } from "./file";
+
+export type StaticHTMLFile = File;
+
+/**
+ * Creates a static HTML file
+ *
+ * @example
+ * // Create an HTML file with content
+ * const page = await StaticHTMLFile("index.html",
+ *   `<!DOCTYPE html>
+ *   <html lang="en">
+ *   <head>
+ *     <meta charset="UTF-8">
+ *     <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ *     <title>My Website</title>
+ *     <link rel="stylesheet" href="styles.css">
+ *   </head>
+ *   <body>
+ *     <header>
+ *       <h1>Welcome to My Website</h1>
+ *     </header>
+ *     <main>
+ *       <p>This is the main content of the page.</p>
+ *     </main>
+ *     <footer>
+ *       <p>&copy; 2024 My Company</p>
+ *     </footer>
+ *   </body>
+ *   </html>`
+ * );
+ */
+export function StaticHTMLFile(
+  id: string,
+  ...args: [content: string] | [path: string, content: string]
+): Promise<StaticHTMLFile> {
+  const [path, content] = args.length === 1 ? [id, args[0]] : args;
+  return File(id, {
+    path,
+    content,
+  });
+}

package/src/fs/static-json-file.ts

@@ -5,7 +5,7 @@ import { File } from "./file";
  *
  * @example
  * // Create a JSON configuration file
- * const config = await JsonFile("config.json", {
+ * const config = await StaticJsonFile("config.json", {
  *   api: {
  *     endpoint: "https://api.example.com",
  *     version: "v1"
@@ -17,11 +17,12 @@ export type StaticJsonFile = File;
 
 export async function StaticJsonFile(
   id: string,
-  content: any,
+  ...args: [content: any] | [path: string, content: any]
 ): Promise<StaticJsonFile> {
+  const [path, content] = args.length === 1 ? [id, args[0]] : args;
   const prettier = await import("prettier");
   return File(id, {
-    path: id,
+    path,
     content: await prettier.format(JSON.stringify(content), {
       parser: "json",
       editor: {

package/src/fs/static-text-file.ts

@@ -13,10 +13,13 @@ export type StaticTextFile = File;
 
 export function StaticTextFile(
   id: string,
-  content: string,
+  ...args: 
+  | [content: string]
+  | [path: string, content: string]
 ): Promise<StaticTextFile> {
+  const [path, content] = args.length === 1 ? [id, args[0]] : args;
   return File(id, {
-    path: id,
+    path,
     content,
   });
 }

package/src/fs/static-typescript-file.ts

@@ -5,7 +5,7 @@ import { File } from "./file";
  *
  * @example
  * // Create a TypeScript file
- * const component = await TypeScriptFile("Component.ts", `
+ * const component = await StaticTypeScriptFile("Component.ts", `
  *   interface Props {
  *     name: string;
  *     age: number;
@@ -20,11 +20,12 @@ export type StaticTypeScriptFile = File;
 
 export async function StaticTypeScriptFile(
   id: string,
-  content: string,
+  ...args: [content: string] | [path: string, content: string]
 ): Promise<StaticTypeScriptFile> {
+  const [path, content] = args.length === 1 ? [id, args[0]] : args;
   const prettier = await import("prettier");
   return File(id, {
-    path: id,
+    path,
     content: await prettier.format(content, {
       parser: "typescript",
       editor: {

package/src/fs/static-vue-file.ts

@@ -0,0 +1,39 @@
+import { File } from "./file";
+
+export type StaticVueFile = File;
+
+/**
+ * Creates a static Vue component file
+ *
+ * @example
+ * // Create a Vue component file with content
+ * const button = await StaticVueFile("Button.vue",
+ *   `<template>
+ *     <button class="btn">{{ text }}</button>
+ *   </template>
+ *
+ *   <script>
+ *   export default {
+ *     props: {
+ *       text: String
+ *     }
+ *   }
+ *   </script>
+ *
+ *   <style>
+ *   .btn {
+ *     padding: 0.5rem 1rem;
+ *   }
+ *   </style>`
+ * );
+ */
+export function StaticVueFile(
+  id: string,
+  ...args: [content: string] | [path: string, content: string]
+): Promise<StaticVueFile> {
+  const [path, content] = args.length === 1 ? [id, args[0]] : args;
+  return File(id, {
+    path,
+    content,
+  });
+}

package/src/fs/static-yaml-file.ts

@@ -4,26 +4,30 @@ import { File } from "./file";
  *
  * @example
  * // Create a YAML configuration file
- * const config = await YamlFile("config.yaml", {
- *   server:
- *     host: "localhost"
+ * const config = await StaticYamlFile("config.yaml", {
+ *   server: {
+ *     host: "localhost",
  *     port: 3000
- *   database:
- *     url: "postgresql://localhost:5432/db"
- *     pool:
- *       min: 1
+ *   },
+ *   database: {
+ *     url: "postgresql://localhost:5432/db",
+ *     pool: {
+ *       min: 1,
  *       max: 10
+ *     }
+ *   }
  * });
  */
 export type StaticYamlFile = File;
 
 export async function StaticYamlFile(
   id: string,
-  content: any,
+  ...args: [content: any] | [path: string, content: any]
 ): Promise<StaticYamlFile> {
+  const [path, content] = args.length === 1 ? [id, args[0]] : args;
   const yaml = await import("yaml");
   return File(id, {
-    path: id,
+    path,
     content: yaml.stringify(content),
   });
 }

package/src/internal/docs/providers.ts

@@ -0,0 +1,281 @@
+import { type } from "arktype";
+import fs from "fs/promises";
+import path from "path";
+import { Data, Document } from "../../ai";
+import { alchemy } from "../../alchemy";
+import { Folder } from "../../fs";
+
+export interface DocsProps {
+  /**
+   * The output directory for the docs.
+   */
+  outDir: string | Folder;
+
+  /**
+   * The source directory for the docs.
+   */
+  srcDir: string;
+
+  /**
+   * Whether to filter the docs.
+   * If true, include all docs.
+   * If false, include none.
+   * If a number, include that many providers.
+   *
+   * @default true (all docs)
+   */
+  filter?: boolean | number;
+
+  /**
+   * Whether to run in parallel.
+   *
+   * @default true
+   */
+  parallel?: boolean;
+}
+
+export type Providers = {
+  dir: string;
+  provider: string;
+  documents: Document[];
+}[];
+
+export async function Providers({
+  srcDir,
+  outDir,
+  filter,
+  parallel = true,
+}: DocsProps): Promise<Providers> {
+  outDir = typeof outDir === "string" ? outDir : outDir.path;
+
+  const exclude = [
+    "util",
+    "test",
+    "vitepress",
+    "vite",
+    "shadcn",
+    "internal",
+    "web",
+  ];
+
+  // Get all folders in the alchemy/src directory
+  let providers = (
+    await fs.readdir(srcDir, {
+      withFileTypes: true,
+    })
+  )
+    .filter((dirent) => dirent.isDirectory() && !exclude.includes(dirent.name))
+    .map((dirent) => path.join(dirent.parentPath, dirent.name));
+
+  // For each provider, list all files
+  if (filter === false) {
+    return [];
+  } else if (typeof filter === "number") {
+    providers = providers.slice(0, filter);
+  }
+
+  if (parallel) {
+    return await Promise.all(
+      providers.map((provider) =>
+        generateProviderDocs({ provider, outDir, parallel })
+      )
+    );
+  } else {
+    const generatedProviders = [];
+    for (const provider of providers) {
+      generatedProviders.push(
+        await generateProviderDocs({ provider, outDir, parallel })
+      );
+    }
+    return generatedProviders;
+  }
+}
+
+async function generateProviderDocs({
+  provider,
+  outDir,
+  parallel,
+}: {
+  provider: string;
+  outDir: string;
+  parallel: boolean;
+}) {
+  const providerName = path.basename(provider);
+  const files = (
+    await fs.readdir(path.resolve(provider), {
+      withFileTypes: true,
+    })
+  )
+    .filter((dirent) => dirent.isFile())
+    .map((dirent) =>
+      path.relative(process.cwd(), path.resolve(provider, dirent.name))
+    )
+    .filter((file) => file.endsWith(".ts") && !file.endsWith("index.ts"));
+
+  type Group = (typeof groups)[number];
+
+  const {
+    object: { groups },
+  } = await Data(`docs/${providerName}`, {
+    model: {
+      id: "o3-mini",
+      provider: "openai",
+      options: {
+        reasoningEffort: "high",
+      },
+    },
+    temperature: 0.1,
+    schema: type({
+      groups: type({
+        identifier: type("string").describe(
+          "The identifier of the file's primary exported Resource/Function/Type, e.g. Bucket or StaticSite, AstroFile, TypeScriptFile"
+        ),
+        filename: type("string").describe(
+          "The filename of the Resource's Document, e.g. bucket.md or static-site.md"
+        ),
+        category: type("'Resource'|'Client'|'Utility'|'Types'").describe(
+          "The classification of the Resource's Document, one of: Resource, Client, Utility, or Types."
+        ),
+      }).array(),
+    }),
+    system: await alchemy`
+      You are a technical writer tasked with identifying the distinct documents that need to be written for a document group (folder) in a documentation site.
+      You will be provided with a list of documents and instructions on how to classify them.
+      Each document has a title, file name, and category.
+    `,
+    prompt: await alchemy`
+      Identify and classify the documents that need to be written for the '${provider}' Service's Alchemy Resources.
+      For background knowledge on Alchemy, see ${alchemy.file("./README.md")}.
+      For background knowledge on the structure of an Alchemy Resource, see ${alchemy.file("./.cursorrules")}.
+
+      The ${provider} Service has the following resources:
+      ${alchemy.files(files)}
+
+      A file is considered a "Resource" if it contains a const <ResourceName> = Resource(...) call or if it is a function that calls a Resource function, e.g. const TypeScriptFile = () => File(...).
+      A file is considered a "Client" if it exposes a wrapper around creating a SDK client or fetch.
+      A file is considered a "Utility" if it contains utility functions that are not resources or clients.
+      A file is considered a "Types" if it contains just type definitions and maybe helpers around working with those types.
+
+      The title should be simply the name of the resource's const in code (with spaces added in between each word), e.g. "Bucket" or "Function", except with spaces, e.g. "Static Site" for "const StaticSite". Maintain all other casing.
+
+      // "Resource Name"
+      const ResourceName = Resource(...)
+    `,
+  });
+
+  const providerDocsDir = (await Folder(path.join(outDir, providerName))).path;
+
+  let documents: Document[] = [];
+  if (parallel) {
+    documents = await Promise.all(
+      groups.filter((g) => g.category === "Resource").map(generateDocument)
+    );
+  } else {
+    for (const g of groups.filter((g) => g.category === "Resource")) {
+      documents.push(await generateDocument(g));
+    }
+  }
+
+  async function generateDocument(g: Group) {
+    return Document(`docs/${providerName}/${g.identifier}`, {
+      title: g.identifier,
+      path: path.join(
+        providerDocsDir,
+        `${g.filename.replace(".ts", "").replace(".md", "")}.md`
+      ),
+      freeze: true,
+      model: {
+        id: "claude-3-5-sonnet-latest",
+        provider: "anthropic",
+        // options: {
+        //   reasoningEffort: "high",
+        // },
+      },
+      prompt: await alchemy`
+        You are a technical writer writing API documentation for an Alchemy IaC Resource.
+        See ${alchemy.file("./README.md")} to understand the overview of Alchemy.
+        See ${alchemy.file("./.cursorrules")} to better understand the structure and convention of an Alchemy Resource.
+
+        Relevant files for the ${providerName} Service:
+        ${alchemy.files(files)}
+        
+        Write concise documentation for the "${g.identifier}" Resource.
+
+        > [!CAUTION]
+        > Avoid the temptation to over explain or over describe. Focus on concise, simple, high value snippets. One heading and 0-1 descriptions per snippet.
+        
+        > [!TIP]
+        > Make sure the examples follow a natural progression from the minimal example to logical next steps of how the Resource might be used.
+
+        Each document must follow the following format:
+        
+        # ${g.identifier}
+
+        (simple description with an external link to the provider's website)
+        e.g.
+        The Efs component lets you add [Amazon Elastic File System (EFS)](https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html) to your app.
+
+        # Minimal Example
+
+        (brief 1-2 sentences of what it does)
+
+        \`\`\`ts
+        import { ${g.identifier.replaceAll(" ", "")} } from "alchemy/${providerName}";
+
+        (example)
+        \`\`\`
+
+        # (one heading per variation)
+
+        (brief 1-2 sentences of what it does)
+
+        \`\`\`ts
+        import { ${g.identifier.replaceAll(" ", "")} } from "alchemy/${providerName}";
+
+        (example)
+        \`\`\`
+
+        Before writing the document, think through:
+        1. What is the minimal, most common example use case for this resource?
+        2. What are the variations (e.g. combination of different options) that are also commonly used, e.g. specifying the memory size of a lambda function.
+        3. Make sure to draw from the examples and your understanding of Alchemy.
+
+        Refer to alchemy docs to understand the context of how this documentation is consumed:
+        - ${alchemy.file("./alchemy-web/docs/what-is-alchemy.md")}
+        - ${alchemy.file("./alchemy-web/docs/getting-started.md")}
+        - ${alchemy.folder("./alchemy-web/docs/concepts/")}
+        
+        ${
+          providerName === "cloudflare"
+            ? await alchemy`# Bind to a Worker
+        (if it is a Cloudflare Resource)
+
+        (brief 1-2 sentences of what it does)
+
+        \`\`\`ts
+        import { Worker, ${g.identifier.replaceAll(" ", "")} } from "alchemy/${providerName}";
+
+        const myResource = await ${g.identifier.replaceAll(" ", "")}("my-resource", {
+          // ...
+        });
+
+        await Worker("my-worker", {
+          name: "my-worker",
+          script: "console.log('Hello, world!')",
+          bindings: {
+            myResource,
+          },
+        });
+        \`\`\``
+            : ""
+        }
+      `,
+    });
+  }
+
+  return {
+    dir: providerDocsDir,
+    provider: providerName,
+    documents,
+  };
+}

package/src/secret.ts

@@ -83,3 +83,19 @@ export function secret<S extends string | undefined>(unencrypted: S): Secret {
   }
   return new Secret(unencrypted);
 }
+
+export namespace secret {
+  export async function env(
+    name: string,
+    value?: string,
+    error?: string
+  ): Promise<Secret> {
+    const alchemy = await import("./alchemy");
+    const result = await alchemy.env(name, value, error);
+    if (typeof result === "string") {
+      return secret(result);
+    } else {
+      throw new Error(`Secret environment variable ${name} is not a string`);
+    }
+  }
+}