alchemy 0.3.1 → 0.4.1

package/lib/fs/file.d.ts

@@ -45,6 +45,24 @@ 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>;
     }
 }
 /**

package/lib/fs/file.js

@@ -17,6 +17,12 @@ alchemy.files = async (...args) => {
         ]))),
     };
 };
+alchemy.folder = async (dir, props) => {
+    const files = await fs.promises.readdir(dir, {
+        recursive: props?.recursive ?? false,
+    });
+    return alchemy.files(files.map((file) => path.join(dir, file)));
+};
 /**
  * File Resource
  *

package/lib/internal/{providers.d.ts → docs/providers.d.ts}

@@ -1,5 +1,5 @@
-import { Document } from "../ai";
-import { Folder } from "../fs";
+import { Document } from "../../ai";
+import { Folder } from "../../fs";
 export interface DocsProps {
     /**
      * The output directory for the docs.
@@ -18,10 +18,16 @@ export interface DocsProps {
      * @default true (all docs)
      */
     filter?: boolean | number;
+    /**
+     * Whether to run in parallel.
+     *
+     * @default true
+     */
+    parallel?: boolean;
 }
-export type AlchemyProviderDocs = {
+export type Providers = {
     dir: string;
     provider: string;
     documents: Document[];
 }[];
-export declare function AlchemyProviderDocs({ srcDir, outDir, filter, }: DocsProps): Promise<AlchemyProviderDocs>;
+export declare function Providers({ srcDir, outDir, filter, parallel, }: DocsProps): Promise<Providers>;

package/lib/internal/docs/providers.js

@@ -0,0 +1,196 @@
+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 async function Providers({ srcDir, outDir, filter, parallel = true, }) {
+    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, }) {
+    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"));
+    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 = [];
+    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) {
+        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/lib/secret.d.ts

@@ -72,3 +72,6 @@ export declare function isSecret(binding: any): binding is Secret;
  * @throws {Error} If no password is set in the alchemy application options or current scope
  */
 export declare function secret<S extends string | undefined>(unencrypted: S): Secret;
+export declare namespace secret {
+    function env(name: string, value?: string, error?: string): Promise<Secret>;
+}

package/lib/secret.js

@@ -82,3 +82,16 @@ export function secret(unencrypted) {
     }
     return new Secret(unencrypted);
 }
+(function (secret) {
+    async function env(name, value, error) {
+        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`);
+        }
+    }
+    secret.env = env;
+})(secret || (secret = {}));

package/lib/{util/serde.d.ts → serde.d.ts}

@@ -1,4 +1,4 @@
-import { Scope } from "../scope";
+import { Scope } from "./scope";
 export declare function serialize(scope: Scope, value: any, options?: {
     encrypt?: boolean;
 }): Promise<any>;

package/lib/{util/serde.js → serde.js}

@@ -1,6 +1,6 @@
-import { Scope } from "../scope";
-import { Secret } from "../secret";
-import { decryptWithKey, encryptWithKey } from "./encrypt";
+import { decryptWithKey, encrypt } from "./encrypt";
+import { Scope } from "./scope";
+import { Secret } from "./secret";
 // zero-dependency type guard for ArkType
 function isType(value) {
     return (value &&
@@ -17,7 +17,7 @@ export async function serialize(scope, value, options) {
         }
         return {
             "@secret": options?.encrypt !== false
-                ? await encryptWithKey(value.unencrypted, scope.password)
+                ? await encrypt(value.unencrypted, scope.password)
                 : value.unencrypted,
         };
     }
@@ -26,6 +26,11 @@ export async function serialize(scope, value, options) {
             "@schema": value.toJSON(),
         };
     }
+    else if (value instanceof Date) {
+        return {
+            "@date": value.toISOString(),
+        };
+    }
     else if (value instanceof Scope) {
         return undefined;
     }
@@ -51,6 +56,9 @@ export async function deserialize(scope, value) {
         else if ("@schema" in value) {
             return value["@schema"];
         }
+        else if ("@date" in value) {
+            return new Date(value["@date"]);
+        }
         else {
             return Object.fromEntries(await Promise.all(Object.entries(value).map(async ([key, value]) => [
                 key,

package/lib/test/bun.js

@@ -32,12 +32,13 @@ alchemy.test = test;
  * ```
  */
 export function test(meta, defaultOptions) {
+    let isFailed = false;
     defaultOptions = defaultOptions ?? {};
     if (defaultOptions.stateStore === undefined &&
         // process.env.CI &&
         process.env.ALCHEMY_STATE_STORE === "cloudflare") {
         defaultOptions.stateStore = (scope) => new R2RestStateStore(scope, {
-            apiKey: process.env.CLOUDFLARE_API_KEY,
+            apiKey: alchemy.secret(process.env.CLOUDFLARE_API_KEY),
             email: process.env.CLOUDFLARE_EMAIL,
             bucketName: process.env.CLOUDFLARE_BUCKET_NAME,
         });
@@ -70,7 +71,7 @@ export function test(meta, defaultOptions) {
     };
     // Clean up test scope after all tests complete
     afterAll(async () => {
-        if (defaultOptions?.destroy !== false) {
+        if (defaultOptions?.destroy !== false && !isFailed) {
             await alchemy.destroy(test.scope);
         }
     });

package/lib/util/sha256.d.ts

@@ -0,0 +1 @@
+export declare function sha256(value: string): string;

package/lib/util/sha256.js

@@ -0,0 +1,4 @@
+import { createHash } from "node:crypto";
+export function sha256(value) {
+    return createHash("sha256").update(value).digest("hex");
+}

package/lib/web/vitepress/config.d.ts

@@ -1,8 +1,9 @@
-import type { DefaultTheme, ThemeOptions } from "vitepress";
+import type { DefaultTheme, HeadConfig, ThemeOptions } from "vitepress";
 export type VitePressConfigProps = {
     cwd: string;
     title?: string;
     description?: string;
+    head?: HeadConfig[];
     theme?: ThemeOptions;
     themeConfig: DefaultTheme.Config;
 };

package/lib/web/vitepress/config.js

@@ -9,6 +9,7 @@ import { defineConfig } from "vitepress";
 export default defineConfig({
   title: ${JSON.stringify(props.title || "Alchemy")},
   description: ${JSON.stringify(props.description || "Alchemy Docs")},
+  head: ${JSON.stringify(props.head || [])},
   markdown: {
     // @ts-ignore
     codeTransformers: [transformerTwoslash()],

package/lib/web/vitepress/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./config";
 export * from "./custom-theme";
 export * from "./home-page";
+export * from "./process-front-matter-files";
 export * from "./vitepress";

package/lib/web/vitepress/index.js

@@ -1,4 +1,5 @@
 export * from "./config";
 export * from "./custom-theme";
 export * from "./home-page";
+export * from "./process-front-matter-files";
 export * from "./vitepress";

package/lib/web/vitepress/process-front-matter-files.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Process markdown files with frontmatter to generate navigation items
+ * @param directoryPath The directory containing markdown files
+ * @param linkPrefix The prefix for navigation links
+ * @returns Sorted array of navigation items with text and link properties
+ */
+export declare function processFrontmatterFiles(directoryPath: string, linkPrefix: string): Promise<{
+    text: string;
+    link: string;
+    items?: {
+        text: string;
+        link: string;
+        items?: {
+            text: string;
+            link: string;
+        }[];
+    }[];
+}[]>;

package/lib/web/vitepress/process-front-matter-files.js

@@ -0,0 +1,68 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+/**
+ * Process markdown files with frontmatter to generate navigation items
+ * @param directoryPath The directory containing markdown files
+ * @param linkPrefix The prefix for navigation links
+ * @returns Sorted array of navigation items with text and link properties
+ */
+export async function processFrontmatterFiles(directoryPath, linkPrefix) {
+    const entries = await fs.readdir(directoryPath, { withFileTypes: true });
+    const processedEntries = await Promise.all(entries
+        .filter((entry) => !entry.name.endsWith("index.md"))
+        .map(async (entry) => {
+        const fullPath = path.join(directoryPath, entry.name);
+        if (entry.isDirectory()) {
+            // Process subdirectory recursively
+            const items = await processFrontmatterFiles(fullPath, `${linkPrefix}/${entry.name}`);
+            // Create section for subdirectory
+            return {
+                text: entry.name.charAt(0).toUpperCase() + entry.name.slice(1),
+                collapsed: false,
+                items,
+                order: 10000, // Default order for directories
+            };
+        }
+        // Process markdown file
+        if (!entry.name.endsWith(".md")) {
+            return null;
+        }
+        const content = await fs.readFile(fullPath, "utf-8");
+        const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
+        let order = 10000;
+        let title;
+        if (frontmatterMatch) {
+            const frontmatter = frontmatterMatch[1];
+            const orderMatch = frontmatter.match(/order:\s*(\d+)/);
+            if (orderMatch) {
+                order = parseInt(orderMatch[1]);
+            }
+            const titleMatch = frontmatter.match(/title:\s*(.+)/);
+            if (titleMatch) {
+                title = titleMatch[1].trim();
+            }
+        }
+        // If no title in frontmatter, try to get first heading
+        if (!title) {
+            const headingMatch = content.match(/^#\s+(.+)$/m);
+            if (headingMatch) {
+                title = headingMatch[1].trim();
+            }
+        }
+        // Fall back to filename if no title found
+        if (!title) {
+            const name = entry.name.replace(".md", "");
+            title = name.charAt(0).toUpperCase() + name.slice(1);
+        }
+        return {
+            text: title,
+            link: `${linkPrefix}/${entry.name}`,
+            order,
+        };
+    }));
+    // Filter out null entries and sort by order
+    return processedEntries
+        .filter((entry) => entry !== null)
+        .sort((a, b) => a.order - b.order)
+        .map(({ text, link, items }) => items ? { text, items, collapsed: true } : { text, link });
+}

package/lib/web/vitepress/vitepress.js

@@ -14,8 +14,9 @@ export const VitepressProject = Resource("project::VitepressProject", {
         try {
             if (props.delete !== false) {
                 if (await fs.exists(dir)) {
-                    // Delete the entire project directory
-                    await execAsync(`rm -rf ${dir}`);
+                    await fs.rm(dir, { recursive: true, force: true });
+                    // // Delete the entire project directory
+                    // await execAsync(`rm -rf ${dir}`);
                 }
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alchemy",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "type": "module",
   "module": "./lib/index.js",
   "scripts": {
@@ -38,16 +38,18 @@
     "@aws-sdk/client-sesv2": "^3.0.0",
     "@aws-sdk/client-sqs": "^3.0.0",
     "@aws-sdk/client-sts": "^3.0.0",
-    "arktype": "^2.0.0",
-    "prettier": "^3.0.0",
     "@octokit/rest": "^21.1.1",
     "ai": "^4.0.0",
+    "arktype": "^2.0.0",
+    "aws4fetch": "^1.0.20",
+    "cloudflare": "^4.0.0",
     "diff": "^7.0.0",
     "esbuild": "^0.25.1",
     "glob": "^10.0.0",
     "hono": "^4.0.0",
-    "libsodium-wrappers": "^0.7.15",
     "jszip": "^3.0.0",
+    "libsodium-wrappers": "^0.7.15",
+    "prettier": "^3.0.0",
     "stripe": "^17.0.0",
     "turndown": "^7.0.0",
     "yaml": "^2.0.0",
@@ -56,6 +58,7 @@
   "devDependencies": {
     "@ai-sdk/anthropic": "^1.1.6",
     "@ai-sdk/openai": "^1.1.9",
+    "@aws-sdk/client-s3": "3.726.1",
     "@biomejs/biome": "^1.9.4",
     "@cloudflare/workers-types": "^4.20250303.0",
     "@octokit/rest": "^21.1.1",
@@ -67,6 +70,7 @@
     "ai": "^4.1.16",
     "arktype": "^2.1.16",
     "change-case": "^5.4.4",
+    "cloudflare": "^4.2.0",
     "libsodium-wrappers": "^0.7.15",
     "openpgp": "^6.1.0",
     "prettier": "^3.5.3",

package/src/ai/document.ts

@@ -11,8 +11,10 @@ import { createModel, withRateLimitRetry, type ModelConfig } from "./client";
 export interface DocumentProps {
   /**
    * Title of the document
+   *
+   * @default id
    */
-  title: string;
+  title?: string;
 
   /**
    * Optional path to the markdown document
@@ -82,12 +84,23 @@ export interface DocumentProps {
    * @default 10000
    */
   maxTokens?: number;
+
+  /**
+   * Freeze the document after creation (do not re-generate on updates)
+   * @default false
+   */
+  freeze?: boolean;
 }
 
 /**
  * A markdown document that can be created, updated, and deleted
  */
 export interface Document extends DocumentProps, Resource<"docs::Document"> {
+  /**
+   * The title of the document
+   */
+  title: string;
+
   /**
    * Content of the document
    */
@@ -221,6 +234,16 @@ export const Document = Resource(
       return this.destroy();
     }
 
+    if (this.phase === "update" && props.freeze) {
+      if (props.path) {
+        const filePath = props.path;
+        const fileId = `${id}-file`;
+
+        await StaticTextFile(fileId, filePath, this.output!.content);
+      }
+      return this(this.output);
+    }
+
     // Use provided system prompt or default
     const system = props.system || DEFAULT_MD_SYSTEM_PROMPT;
 
@@ -266,7 +289,7 @@ export const Document = Resource(
 
       if (retryResult.error) {
         throw new Error(
-          `Failed to generate valid markdown content: ${retryResult.error}`
+          `Failed to generate valid markdown content: ${retryResult.error}\n${retryText}`
         );
       }
 
@@ -283,6 +306,7 @@ export const Document = Resource(
       ],
       createdAt: this.output?.createdAt || Date.now(),
       updatedAt: Date.now(),
+      title: props.title || id,
     };
 
     // Write file if path is provided

package/src/ai/index.ts

@@ -1,4 +1,3 @@
-export * from "./approve";
 export * from "./ark";
 export * from "./astro-file";
 export * from "./css-file";
@@ -6,7 +5,6 @@ export * from "./data";
 export * from "./document";
 export * from "./html-file";
 export * from "./json-file";
-export * from "./review";
 export * from "./typescript-file";
 export * from "./vue-file";
 export * from "./yaml-file";