alchemy 0.3.0 → 0.3.1

package/lib/ai/document.js

@@ -1,9 +1,7 @@
 import { generateText } from "ai";
-import fs from "node:fs/promises";
-import path from "node:path";
+import { StaticTextFile } from "../fs/static-text-file";
 import { Resource } from "../resource";
-import { ignore } from "../util/ignore";
-import { createModel } from "./client";
+import { createModel, withRateLimitRetry } from "./client";
 /**
  * Default system prompt for markdown document generation
  */
@@ -13,7 +11,22 @@ const DEFAULT_MD_SYSTEM_PROMPT = "You are a technical documentation writer. Crea
  * Supports powerful context handling through the alchemy template literal tag.
  *
  * @example
- * // Create a document using alchemy template literals for context
+ * // Create an in-memory document (no file created)
+ * const apiDocs = await Document("api-docs", {
+ *   title: "API Documentation",
+ *   prompt: await alchemy`
+ *     Generate API documentation based on these source files:
+ *     ${alchemy.file("src/api.ts")}
+ *     ${alchemy.file("src/types.ts")}
+ *   `,
+ *   model: {
+ *     id: "gpt-4o",
+ *     provider: "openai"
+ *   }
+ * });
+ *
+ * @example
+ * // Create a document and write it to disk
  * const apiDocs = await Document("api-docs", {
  *   title: "API Documentation",
  *   path: "./docs/api.md",
@@ -29,6 +42,23 @@ const DEFAULT_MD_SYSTEM_PROMPT = "You are a technical documentation writer. Crea
  * });
  *
  * @example
+ * // Use message history for iterative document generation
+ * const apiDocs = await Document("api-docs", {
+ *   title: "API Documentation",
+ *   path: "./docs/api.md",
+ *   messages: [
+ *     { role: "user", content: "Create API documentation for these files" },
+ *     { role: "assistant", content: "I'll help you create API documentation. Please provide the files." },
+ *     { role: "user", content: "Here are the files: [file contents]" }
+ *   ],
+ *   system: "You are a technical documentation writer. Generate clear and concise API documentation.",
+ *   model: {
+ *     id: "gpt-4o",
+ *     provider: "openai"
+ *   }
+ * });
+ *
+ * @example
  * // Use alchemy template literals with file collections and temperature control
  * const modelDocs = await Document("models", {
  *   title: "Data Models",
@@ -61,67 +91,75 @@ const DEFAULT_MD_SYSTEM_PROMPT = "You are a technical documentation writer. Crea
  * });
  */
 export const Document = Resource("docs::Document", async function (id, props) {
-    // Ensure directory exists
-    await fs.mkdir(path.dirname(props.path), { recursive: true });
+    // Validate that either prompt or messages are provided
+    if (!props.prompt && !props.messages) {
+        throw new Error("Either prompt or messages must be provided");
+    }
+    // Handle deletion phase
     if (this.phase === "delete") {
-        try {
-            await fs.unlink(props.path);
-        }
-        catch (error) {
-            // Ignore if file doesn't exist
-            if (error.code !== "ENOENT") {
-                throw error;
-            }
-        }
         return this.destroy();
     }
     // Use provided system prompt or default
     const system = props.system || DEFAULT_MD_SYSTEM_PROMPT;
-    // Generate initial content
-    const { text } = await generateText({
-        model: createModel(props),
-        prompt: props.prompt,
-        system,
-        providerOptions: props.model?.options,
-        ...(props.temperature === undefined
-            ? {}
-            : // some models error if you provide it (rather than ignoring it)
-                { temperature: props.temperature }),
+    // Generate initial content with rate limit retry
+    const { text } = await withRateLimitRetry(async () => {
+        return generateText({
+            model: createModel(props),
+            ...(props.messages
+                ? { messages: props.messages }
+                : { prompt: props.prompt }),
+            system,
+            maxTokens: props.maxTokens || 8192,
+            providerOptions: props.model?.options,
+            ...(props.temperature === undefined
+                ? {}
+                : // some models error if you provide it (rather than ignoring it)
+                    { temperature: props.temperature }),
+        });
     });
     // Extract and validate markdown content
-    let { content, error } = await extractMarkdownContent(text);
+    let { content, error } = extractMarkdownContent(text);
     // Re-prompt if there are validation errors
     if (error) {
         const errorSystem = `${system}\n\nERROR: ${error}\n\nPlease try again and ensure your response contains exactly one markdown document inside \`\`\`md fences.`;
-        const { text: retryText } = await generateText({
-            model: createModel(props),
-            prompt: props.prompt,
-            system: errorSystem,
-            providerOptions: props.model?.options,
-            ...(props.temperature === undefined
-                ? {}
-                : { temperature: props.temperature }),
+        const { text: retryText } = await withRateLimitRetry(async () => {
+            return generateText({
+                model: createModel(props),
+                ...(props.messages
+                    ? { messages: props.messages }
+                    : { prompt: props.prompt }),
+                system: errorSystem,
+                providerOptions: props.model?.options,
+                ...(props.temperature === undefined
+                    ? {}
+                    : { temperature: props.temperature }),
+            });
         });
-        const retryResult = await extractMarkdownContent(retryText);
+        const retryResult = extractMarkdownContent(retryText);
         if (retryResult.error) {
             throw new Error(`Failed to generate valid markdown content: ${retryResult.error}`);
         }
         content = retryResult.content;
     }
-    if (this.phase === "update" && props.path !== this.props.path) {
-        await ignore("ENOENT", () => fs.unlink(this.props.path));
+    // Create result object
+    const result = {
+        ...props,
+        content,
+        messages: [
+            ...(props.messages || [{ role: "user", content: props.prompt }]),
+            { role: "assistant", content },
+        ],
+        createdAt: this.output?.createdAt || Date.now(),
+        updatedAt: Date.now(),
+    };
+    // Write file if path is provided
+    if (props.path) {
+        const filePath = props.path;
+        const fileId = `${id}-file`;
+        result.file = await StaticTextFile(fileId, filePath, content);
     }
-    // Write content to file
-    await fs.writeFile(props.path, content);
-    // Get file stats for timestamps
-    const stats = await fs.stat(props.path);
     // Return the resource
-    return this({
-        ...props,
-        content: content,
-        createdAt: stats.birthtimeMs,
-        updatedAt: stats.mtimeMs,
-    });
+    return this(result);
 });
 /**
  * Extracts markdown content from between ```md fences
@@ -130,20 +168,29 @@ export const Document = Resource("docs::Document", async function (id, props) {
  * @param text The text to extract markdown content from
  * @returns The extracted markdown content or error message
  */
-async function extractMarkdownContent(text) {
-    const mdCodeRegex = /```md\s*([\s\S]*?)```/g;
-    const matches = Array.from(text.matchAll(mdCodeRegex));
-    if (matches.length === 0) {
+function extractMarkdownContent(text) {
+    const lines = text.split("\n");
+    const startIdx = lines.findIndex((line) => line.trim() === "```md");
+    if (startIdx === -1) {
         return {
             content: "",
             error: "No markdown code block found in the response. Please include your markdown content within ```md fences.",
         };
     }
-    if (matches.length > 1) {
+    const rest = lines.slice(startIdx + 1);
+    const endRelativeIdx = rest
+        .map((line) => line.trim() === "```")
+        .lastIndexOf(true);
+    if (endRelativeIdx === -1) {
         return {
             content: "",
-            error: "Multiple markdown code blocks found in the response. Please provide exactly one markdown block within ```md fences.",
+            error: "Markdown block was not closed properly.",
         };
     }
-    return { content: matches[0][1].trim() };
+    const endIdx = startIdx + 1 + endRelativeIdx;
+    const content = lines
+        .slice(startIdx + 1, endIdx)
+        .join("\n")
+        .trim();
+    return { content };
 }

package/lib/ai/html-file.js

@@ -1,8 +1,6 @@
 import { generateText } from "ai";
-import fs from "node:fs/promises";
-import path from "node:path";
+import { StaticHTMLFile } from "../fs/static-html-file";
 import { Resource } from "../resource";
-import { ignore } from "../util/ignore";
 import { createModel } from "./client";
 /**
  * Default system prompt for HTML file generation
@@ -68,18 +66,8 @@ const DEFAULT_HTML_SYSTEM_PROMPT = "You are an HTML code generator. Create HTML
  * });
  */
 export const HTMLFile = Resource("ai::HTMLFile", async function (id, props) {
-    // Ensure directory exists
-    await fs.mkdir(path.dirname(props.path), { recursive: true });
+    // Handle deletion phase
     if (this.phase === "delete") {
-        try {
-            await fs.unlink(props.path);
-        }
-        catch (error) {
-            // Ignore if file doesn't exist
-            if (error.code !== "ENOENT") {
-                throw error;
-            }
-        }
         return this.destroy();
     }
     // Use provided system prompt or default
@@ -114,19 +102,14 @@ export const HTMLFile = Resource("ai::HTMLFile", async function (id, props) {
         }
         code = retryResult.code;
     }
-    if (this.phase === "update" && props.path !== this.props.path) {
-        await ignore("ENOENT", () => fs.unlink(this.props.path));
-    }
-    // Write content to file
-    await fs.writeFile(props.path, code);
-    // Get file stats for timestamps
-    const stats = await fs.stat(props.path);
+    // Use StaticHTMLFile to create/update the file
+    const file = await StaticHTMLFile("file", props.path, code);
     // Return the resource
     return this({
         ...props,
-        content: code,
-        createdAt: stats.birthtimeMs,
-        updatedAt: stats.mtimeMs,
+        content: file.content,
+        createdAt: Date.now(),
+        updatedAt: Date.now(),
     });
 });
 /**

package/lib/ai/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./approve";
 export * from "./ark";
 export * from "./astro-file";
 export * from "./css-file";
@@ -5,6 +6,7 @@ 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";

package/lib/ai/index.js

@@ -1,3 +1,4 @@
+export * from "./approve";
 export * from "./ark";
 export * from "./astro-file";
 export * from "./css-file";
@@ -5,6 +6,7 @@ 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";

package/lib/ai/json-file.js

@@ -1,8 +1,6 @@
 import { generateObject, generateText } from "ai";
-import fs from "node:fs/promises";
-import path from "node:path";
+import { StaticJsonFile } from "../fs/static-json-file";
 import { Resource } from "../resource";
-import { ignore } from "../util/ignore";
 import { ark } from "./ark";
 import { createModel } from "./client";
 /**
@@ -77,23 +75,10 @@ const DEFAULT_JSON_SYSTEM_PROMPT = "You are a JSON generator. Create valid JSON
  * });
  */
 export const JSONFile = Resource("ai::JSONFile", async function (id, props) {
-    // Ensure directory exists
-    await fs.mkdir(path.dirname(props.path), { recursive: true });
+    // Handle deletion phase
     if (this.phase === "delete") {
-        try {
-            await fs.unlink(props.path);
-        }
-        catch (error) {
-            // Ignore if file doesn't exist
-            if (error.code !== "ENOENT") {
-                throw error;
-            }
-        }
         return this.destroy();
     }
-    // Determine if we should use pretty printing
-    const pretty = props.pretty !== false;
-    const indent = props.indent ?? 2;
     let jsonContent;
     let jsonObject;
     // Check if schema is provided
@@ -111,9 +96,9 @@ export const JSONFile = Resource("ai::JSONFile", async function (id, props) {
                 : { temperature: props.temperature }),
         });
         jsonObject = object;
-        jsonContent = pretty
-            ? JSON.stringify(jsonObject, null, indent)
-            : JSON.stringify(jsonObject);
+        // Use StaticJsonFile to create the file
+        const file = await StaticJsonFile("file", props.path, jsonObject);
+        jsonContent = file.content;
     }
     else {
         // Use fence-based extraction
@@ -149,26 +134,20 @@ export const JSONFile = Resource("ai::JSONFile", async function (id, props) {
             }
             content = retryResult.content;
         }
-        // Parse JSON
+        // Parse JSON to get the object representation
         jsonObject = JSON.parse(content);
-        // Format with or without indentation based on pretty option
-        jsonContent = pretty ? JSON.stringify(jsonObject, null, indent) : content;
-    }
-    if (this.phase === "update" && props.path !== this.props.path) {
-        await ignore("ENOENT", () => fs.unlink(this.props.path));
+        // Use StaticJsonFile to create the file
+        const file = await StaticJsonFile("file", props.path, jsonObject);
+        jsonContent = file.content;
     }
-    // Write content to file
-    await fs.writeFile(props.path, jsonContent);
-    // Get file stats for timestamps
-    const stats = await fs.stat(props.path);
     // Return the resource
     return this({
         ...props,
         schema: props.schema,
         content: jsonContent,
         json: jsonObject,
-        createdAt: stats.birthtimeMs,
-        updatedAt: stats.mtimeMs,
+        createdAt: Date.now(),
+        updatedAt: Date.now(),
     });
 });
 /**

package/lib/ai/review.d.ts

@@ -0,0 +1,122 @@
+import { type CoreMessage } from "ai";
+import type { Context } from "../context";
+import { Resource } from "../resource";
+import type { Secret } from "../secret";
+import { type ModelConfig } from "./client";
+/**
+ * Properties for creating or updating a Review
+ */
+export interface ReviewProps {
+    /**
+     * Content to be reviewed
+     * Use alchemy template literals to include file context:
+     * @example
+     * content: await alchemy`
+     *   Review this code:
+     *   ${alchemy.file("src/api.ts")}
+     * `
+     *
+     * Required unless messages are provided
+     */
+    content?: string;
+    /**
+     * Prompt for the review
+     * This should include specific instructions for the review
+     * @example
+     * prompt: "Review this code for security vulnerabilities, performance issues, and best practices."
+     *
+     * Required unless messages are provided
+     */
+    prompt?: string;
+    /**
+     * Message history for the conversation
+     * If provided, this will be used instead of the prompt and content
+     */
+    messages?: CoreMessage[];
+    /**
+     * System prompt for the model
+     * This is used to provide instructions to the model about how to format the response
+     * The default system prompt instructs the model to act as a reviewer
+     */
+    system?: string;
+    /**
+     * AI API key to use for generating content
+     * If not provided, will use OPENAI_API_KEY environment variable
+     */
+    apiKey?: Secret;
+    /**
+     * Model configuration
+     */
+    model?: ModelConfig;
+    /**
+     * Temperature for controlling randomness in generation.
+     * Higher values (e.g., 0.8) make output more random,
+     * lower values (e.g., 0.2) make it more deterministic.
+     * @default 0.7
+     */
+    temperature?: number;
+    /**
+     * Maximum number of tokens to generate.
+     * Higher values allow for longer documents but may increase cost and generation time.
+     * @default 10000
+     */
+    maxTokens?: number;
+}
+/**
+ * Output returned after Review creation/update
+ */
+export interface Review extends ReviewProps, Resource<"ai::Review"> {
+    /**
+     * Content of the review
+     */
+    content: string;
+    /**
+     * Updated message history with the review response appended
+     */
+    messages: CoreMessage[];
+    /**
+     * Time at which the review was created
+     */
+    createdAt: number;
+    /**
+     * Time at which the review was last updated
+     */
+    updatedAt: number;
+}
+/**
+ * Creates or updates a Review resource
+ *
+ * @example
+ * // Create a review of a code file
+ * const codeReview = await Review("api-review", {
+ *   content: await alchemy`
+ *     Review this API implementation:
+ *     ${alchemy.file("src/api.ts")}
+ *   `,
+ *   prompt: "Review this API implementation for security vulnerabilities, performance issues, and best practices. Suggest improvements and alternative approaches."
+ * });
+ *
+ * @example
+ * // Create a review of a document
+ * const docReview = await Review("tutorial-review", {
+ *   content: await alchemy`
+ *     Review this tutorial:
+ *     ${alchemy.file("docs/tutorials/getting-started.md")}
+ *   `,
+ *   prompt: "Review this tutorial for clarity, accuracy, and completeness. Suggest improvements to make it more user-friendly."
+ * });
+ *
+ * @example
+ * // Create a review with message history
+ * const reviewWithHistory = await Review("code-review-iteration-2", {
+ *   content: "Updated code implementation",
+ *   prompt: "Review this updated implementation",
+ *   messages: [
+ *     { role: "user", content: "Can you review my code?" },
+ *     { role: "assistant", content: "I'll review your code. Please share it." },
+ *     { role: "user", content: "Here's my implementation: [code]" },
+ *     { role: "assistant", content: "Here's my review of your code: [previous review]" }
+ *   ]
+ * });
+ */
+export declare const Review: (((this: any, id: string, props?: {}) => never) & (new (_: never) => never)) | ((this: Context<Review>, id: string, props: ReviewProps) => Promise<Review>);

package/lib/ai/review.js

@@ -0,0 +1,101 @@
+import { generateText } from "ai";
+import { Resource } from "../resource";
+import { createModel, withRateLimitRetry } from "./client";
+/**
+ * Default system prompt for review generation
+ */
+const DEFAULT_REVIEW_SYSTEM_PROMPT = `You are an expert code reviewer and technical writer. Your task is to provide a thorough review of the provided content. Your review should include:
+
+1. A high-level summary of the content
+2. Detailed feedback on the content's quality, accuracy, and completeness
+3. Specific suggestions for improvement
+4. Alternative approaches or solutions where applicable
+5. Best practices that should be followed
+6. Potential issues or concerns that should be addressed
+
+Provide your review in a clear, well-structured format.`;
+/**
+ * Creates or updates a Review resource
+ *
+ * @example
+ * // Create a review of a code file
+ * const codeReview = await Review("api-review", {
+ *   content: await alchemy`
+ *     Review this API implementation:
+ *     ${alchemy.file("src/api.ts")}
+ *   `,
+ *   prompt: "Review this API implementation for security vulnerabilities, performance issues, and best practices. Suggest improvements and alternative approaches."
+ * });
+ *
+ * @example
+ * // Create a review of a document
+ * const docReview = await Review("tutorial-review", {
+ *   content: await alchemy`
+ *     Review this tutorial:
+ *     ${alchemy.file("docs/tutorials/getting-started.md")}
+ *   `,
+ *   prompt: "Review this tutorial for clarity, accuracy, and completeness. Suggest improvements to make it more user-friendly."
+ * });
+ *
+ * @example
+ * // Create a review with message history
+ * const reviewWithHistory = await Review("code-review-iteration-2", {
+ *   content: "Updated code implementation",
+ *   prompt: "Review this updated implementation",
+ *   messages: [
+ *     { role: "user", content: "Can you review my code?" },
+ *     { role: "assistant", content: "I'll review your code. Please share it." },
+ *     { role: "user", content: "Here's my implementation: [code]" },
+ *     { role: "assistant", content: "Here's my review of your code: [previous review]" }
+ *   ]
+ * });
+ */
+export const Review = Resource("ai::Review", async function (id, props) {
+    if (this.phase === "delete") {
+        return this.destroy();
+    }
+    // Use provided system prompt or default
+    const system = props.system || DEFAULT_REVIEW_SYSTEM_PROMPT;
+    // Create messages array if not provided
+    const messages = props.messages ||
+        (props.content && props.prompt
+            ? [
+                {
+                    role: "user",
+                    content: `${props.content}\n\n${props.prompt}`,
+                },
+            ]
+            : []);
+    if (messages.length === 0) {
+        throw new Error("Either messages or both content and prompt must be provided");
+    }
+    // Generate review content with rate limit retry
+    const { text } = await withRateLimitRetry(async () => {
+        return generateText({
+            model: createModel(props),
+            messages,
+            system,
+            maxTokens: props.maxTokens || 8192,
+            providerOptions: props.model?.options,
+            ...(props.temperature === undefined
+                ? {}
+                : { temperature: props.temperature }),
+        });
+    });
+    // Create updated message history with the AI's response
+    const updatedMessages = [
+        ...messages,
+        {
+            role: "assistant",
+            content: text,
+        },
+    ];
+    // Return the review with the direct text from the LLM and updated messages
+    return this({
+        ...props,
+        content: text,
+        messages: updatedMessages,
+        createdAt: Date.now(),
+        updatedAt: Date.now(),
+    });
+});

package/lib/ai/typescript-file.d.ts

@@ -1,4 +1,3 @@
-import prettier from "prettier";
 import type { Context } from "../context";
 import { Resource } from "../resource";
 import type { Secret } from "../secret";
@@ -53,7 +52,7 @@ export interface TypeScriptFileProps {
      * Prettier configuration to use for formatting the TypeScript code
      * If not provided, will use the default Prettier configuration
      */
-    prettierConfig?: prettier.Options;
+    prettierConfig?: object;
 }
 /**
  * A TypeScript file that can be created, updated, and deleted