alchemy 0.3.0 → 0.3.1

package/src/ai/document.ts

@@ -1,11 +1,9 @@
-import { generateText } from "ai";
-import fs from "node:fs/promises";
-import path from "node:path";
+import { generateText, type CoreMessage } from "ai";
 import type { Context } from "../context";
+import { StaticTextFile } from "../fs/static-text-file";
 import { Resource } from "../resource";
 import type { Secret } from "../secret";
-import { ignore } from "../util/ignore";
-import { type ModelConfig, createModel } from "./client";
+import { createModel, withRateLimitRetry, type ModelConfig } from "./client";
 
 /**
  * Properties for creating or updating a Document
@@ -17,9 +15,10 @@ export interface DocumentProps {
   title: string;
 
   /**
-   * Path to the markdown document
+   * Optional path to the markdown document
+   * If provided, document will be written to this path
    */
-  path: string;
+  path?: string;
 
   /**
    * Base URL for the OpenAI API
@@ -36,7 +35,19 @@ export interface DocumentProps {
    *   ${alchemy.file("src/api.ts")}
    * `
    */
-  prompt: string;
+  prompt?: string;
+
+  /**
+   * Message history for conversation-based generation
+   * If provided, this will be used instead of the prompt
+   * @example
+   * messages: [
+   *   { role: "user", content: "Generate API documentation for this file" },
+   *   { role: "assistant", content: "I'll create detailed API docs. What file should I document?" },
+   *   { role: "user", content: "Please document src/api.ts" }
+   * ]
+   */
+  messages?: CoreMessage[];
 
   /**
    * System prompt for the model
@@ -64,6 +75,13 @@ export interface DocumentProps {
    * @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;
 }
 
 /**
@@ -75,6 +93,11 @@ export interface Document extends DocumentProps, Resource<"docs::Document"> {
    */
   content: string;
 
+  /**
+   * Updated message history with the document response appended
+   */
+  messages: CoreMessage[];
+
   /**
    * Time at which the document was created
    */
@@ -84,6 +107,11 @@ export interface Document extends DocumentProps, Resource<"docs::Document"> {
    * Time at which the document was last updated
    */
   updatedAt: number;
+
+  /**
+   * File resource if path was provided
+   */
+  file?: StaticTextFile;
 }
 
 /**
@@ -97,7 +125,22 @@ const DEFAULT_MD_SYSTEM_PROMPT =
  * 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",
@@ -113,6 +156,23 @@ const DEFAULT_MD_SYSTEM_PROMPT =
  * });
  *
  * @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",
@@ -149,84 +209,93 @@ export const Document = Resource(
   async function (
     this: Context<Document>,
     id: string,
-    props: DocumentProps,
+    props: DocumentProps
   ): Promise<Document> {
-    // 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: any) {
-        // 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}`,
+          `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: Partial<Document> = {
+      ...props,
+      content,
+      messages: [
+        ...(props.messages || [{ role: "user", content: props.prompt! }]),
+        { role: "assistant", content },
+      ],
+      createdAt: this.output?.createdAt || Date.now(),
+      updatedAt: Date.now(),
+    };
 
-    // Write content to file
-    await fs.writeFile(props.path, content);
+    // Write file if path is provided
+    if (props.path) {
+      const filePath = props.path;
+      const fileId = `${id}-file`;
 
-    // Get file stats for timestamps
-    const stats = await fs.stat(props.path);
+      result.file = await StaticTextFile(fileId, filePath, content);
+    }
 
     // Return the resource
-    return this({
-      ...props,
-      content: content,
-      createdAt: stats.birthtimeMs,
-      updatedAt: stats.mtimeMs,
-    });
-  },
+    return this(result as Document);
+  }
 );
 
 /**
@@ -236,13 +305,14 @@ export const Document = Resource(
  * @param text The text to extract markdown content from
  * @returns The extracted markdown content or error message
  */
-async function extractMarkdownContent(
-  text: string,
-): Promise<{ content: string; error?: string }> {
-  const mdCodeRegex = /```md\s*([\s\S]*?)```/g;
-  const matches = Array.from(text.matchAll(mdCodeRegex));
+function extractMarkdownContent(text: string): {
+  content: string;
+  error?: string;
+} {
+  const lines = text.split("\n");
+  const startIdx = lines.findIndex((line) => line.trim() === "```md");
 
-  if (matches.length === 0) {
+  if (startIdx === -1) {
     return {
       content: "",
       error:
@@ -250,13 +320,24 @@ async function extractMarkdownContent(
     };
   }
 
-  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/src/ai/html-file.ts

@@ -1,10 +1,8 @@
 import { generateText } from "ai";
-import fs from "node:fs/promises";
-import path from "node:path";
 import type { Context } from "../context";
+import { StaticHTMLFile } from "../fs/static-html-file";
 import { Resource } from "../resource";
 import type { Secret } from "../secret";
-import { ignore } from "../util/ignore";
 import { type ModelConfig, createModel } from "./client";
 
 /**
@@ -151,20 +149,10 @@ export const HTMLFile = Resource(
   async function (
     this: Context<HTMLFile>,
     id: string,
-    props: HTMLFileProps,
+    props: HTMLFileProps
   ): Promise<HTMLFile> {
-    // 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: any) {
-        // Ignore if file doesn't exist
-        if (error.code !== "ENOENT") {
-          throw error;
-        }
-      }
       return this.destroy();
     }
 
@@ -203,31 +191,24 @@ export const HTMLFile = Resource(
 
       if (retryResult.error) {
         throw new Error(
-          `Failed to generate valid HTML code: ${retryResult.error}`,
+          `Failed to generate valid HTML code: ${retryResult.error}`
         );
       }
 
       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(),
     });
-  },
+  }
 );
 
 /**
@@ -238,7 +219,7 @@ export const HTMLFile = Resource(
  * @returns The extracted HTML code or error message
  */
 async function extractHTMLCode(
-  text: string,
+  text: string
 ): Promise<{ code: string; error?: string }> {
   const htmlCodeRegex = /```html\s*([\s\S]*?)```/g;
   const matches = Array.from(text.matchAll(htmlCodeRegex));

package/src/ai/index.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/src/ai/json-file.ts

@@ -1,11 +1,9 @@
 import { generateObject, generateText } from "ai";
 import type { JsonSchema, Type, type } from "arktype";
-import fs from "node:fs/promises";
-import path from "node:path";
 import type { Context } from "../context";
+import { StaticJsonFile } from "../fs/static-json-file";
 import { Resource } from "../resource";
 import type { Secret } from "../secret";
-import { ignore } from "../util/ignore";
 import { ark } from "./ark";
 import { type ModelConfig, createModel } from "./client";
 
@@ -193,25 +191,11 @@ export const JSONFile = Resource("ai::JSONFile", async function <
 >(this: Context<JSONFile<T extends Type<any, any> ? type.infer<T> : any>>, id: string, props: JSONFileProps<T>): Promise<
   JSONFile<T extends Type<any, any> ? type.infer<T> : any>
 > {
-  // 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: any) {
-      // 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: string;
   let jsonObject: any;
 
@@ -232,9 +216,10 @@ export const JSONFile = Resource("ai::JSONFile", async function <
     });
 
     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
     // Use provided system prompt or default
@@ -277,31 +262,22 @@ export const JSONFile = Resource("ai::JSONFile", async function <
       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;
+    // Use StaticJsonFile to create the file
+    const file = await StaticJsonFile("file", props.path, jsonObject);
+    jsonContent = file.content;
   }
 
-  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, 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(),
   });
 });
 
@@ -313,7 +289,7 @@ export const JSONFile = Resource("ai::JSONFile", async function <
  * @returns The extracted JSON or error message
  */
 async function extractJSONContent(
-  text: string,
+  text: string
 ): Promise<{ content: string; error?: string }> {
   const jsonCodeRegex = /```json\s*([\s\S]*?)```/g;
   const matches = Array.from(text.matchAll(jsonCodeRegex));