alchemy 0.3.1 → 0.4.1

package/src/web/vitepress/process-front-matter-files.ts

@@ -0,0 +1,98 @@
+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: string,
+  linkPrefix: string
+): Promise<
+  {
+    text: string;
+    link: string;
+    items?: {
+      text: string;
+      link: string;
+      items?: { text: string; link: string }[];
+    }[];
+  }[]
+> {
+  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 }
+    ) as any;
+}

package/src/web/vitepress/vitepress.ts

@@ -117,8 +117,9 @@ export const VitepressProject = Resource(
       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}`);
           }
         }
       } catch (error) {

package/lib/ai/approve.d.ts

@@ -1,99 +0,0 @@
-import type { CoreMessage } from "ai";
-/**
- * Properties for approving or denying content
- */
-export interface ApproveProps {
-    /**
-     * 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 approval decision
-     * This should include specific criteria for approval or denial
-     * @example
-     * prompt: "Approve this code if it follows security best practices and has proper error handling."
-     *
-     * Required unless messages are provided
-     */
-    prompt?: string;
-    /**
-     * System prompt for the model
-     * This is used to provide instructions to the model about how to make the decision
-     */
-    system?: string;
-    /**
-     * Message history for the conversation
-     * If provided, this will be used instead of the prompt and content
-     */
-    messages?: CoreMessage[];
-    /**
-     * 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.2 (lower for more consistent decisions)
-     */
-    temperature?: number;
-}
-/**
- * Result of the approval process
- */
-export interface ApprovalResult {
-    /**
-     * Whether the content was approved
-     */
-    approved: boolean;
-    /**
-     * Explanation for the decision
-     */
-    explanation: string;
-    /**
-     * Suggestions for improvement if denied
-     */
-    suggestions?: string[];
-    /**
-     * Updated message history with the approval response appended
-     */
-    messages: CoreMessage[];
-}
-export type Approve = ApprovalResult;
-/**
- * Approves or denies content based on a prompt or message history
- *
- * @example
- * // Approve or deny a code file
- * const result = await Approve("code-approval", {
- *   content: await alchemy`
- *     Review this API implementation:
- *     ${alchemy.file("src/api.ts")}
- *   `,
- *   prompt: "Approve this code if it follows security best practices and has proper error handling."
- * });
- *
- * if (result.approved) {
- *   console.log("Content approved:", result.explanation);
- * } else {
- *   console.log("Content denied:", result.explanation);
- *   console.log("Suggestions:", result.suggestions);
- * }
- *
- * @example
- * // Approve or deny using message history
- * const result = await Approve("doc-approval-with-history", {
- *   content: "This is the content to review",
- *   prompt: "Approve this documentation if it is clear and accurate",
- *   messages: [
- *     { role: "user", content: "Can you review this documentation?" },
- *     { role: "assistant", content: "Yes, I'd be happy to review it." },
- *     { role: "user", content: "Please check for clarity and accuracy." }
- *   ]
- * });
- */
-export declare function Approve(id: string, props: ApproveProps): Promise<ApprovalResult>;

package/lib/ai/approve.js

@@ -1,76 +0,0 @@
-import { type } from "arktype";
-import { Data } from "./data";
-/**
- * Default system prompt for approval decisions
- */
-const DEFAULT_APPROVE_SYSTEM_PROMPT = `You are an expert content reviewer tasked with approving or denying content based on specific criteria.
-
-Your role is to:
-1. Carefully evaluate the content against the provided criteria
-2. Make a clear decision to approve or deny the content
-3. Provide a detailed explanation for your decision
-4. If denying, offer specific suggestions for improvement
-
-Be objective, thorough, and fair in your assessment.`;
-/**
- * Approves or denies content based on a prompt or message history
- *
- * @example
- * // Approve or deny a code file
- * const result = await Approve("code-approval", {
- *   content: await alchemy`
- *     Review this API implementation:
- *     ${alchemy.file("src/api.ts")}
- *   `,
- *   prompt: "Approve this code if it follows security best practices and has proper error handling."
- * });
- *
- * if (result.approved) {
- *   console.log("Content approved:", result.explanation);
- * } else {
- *   console.log("Content denied:", result.explanation);
- *   console.log("Suggestions:", result.suggestions);
- * }
- *
- * @example
- * // Approve or deny using message history
- * const result = await Approve("doc-approval-with-history", {
- *   content: "This is the content to review",
- *   prompt: "Approve this documentation if it is clear and accurate",
- *   messages: [
- *     { role: "user", content: "Can you review this documentation?" },
- *     { role: "assistant", content: "Yes, I'd be happy to review it." },
- *     { role: "user", content: "Please check for clarity and accuracy." }
- *   ]
- * });
- */
-export async function Approve(id, props) {
-    // 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");
-    }
-    const data = await Data(id, {
-        schema: type({
-            approved: "boolean",
-            explanation: "string",
-            suggestions: "string[]?",
-        }),
-        messages,
-        system: props.system || DEFAULT_APPROVE_SYSTEM_PROMPT,
-        temperature: props.temperature ?? 0.2,
-    });
-    // Return the result with updated messages from Data
-    return {
-        ...data.object,
-        messages: data.messages,
-    };
-}

package/lib/ai/review.d.ts

@@ -1,122 +0,0 @@
-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

@@ -1,101 +0,0 @@
-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/internal/getting-started.d.ts

@@ -1,21 +0,0 @@
-import { Document } from "../ai";
-import type { ModelConfig } from "../ai/client";
-import type { Folder } from "../fs";
-export interface GettingStartedProps {
-    /**
-     * The output directory for the getting started document.
-     */
-    path: string | Folder;
-    /**
-     * The prompt to use for generating the getting started guide.
-     * This should include specific details about the product or framework.
-     */
-    prompt: string;
-    /**
-     * Optional model configuration for generating the getting started guide.
-     * Defaults to Claude 3.5 Sonnet.
-     */
-    model?: ModelConfig;
-}
-export type GettingStarted = Document;
-export declare function GettingStarted({ path: outFile, prompt, model, }: GettingStartedProps): Promise<Document>;

package/lib/internal/getting-started.js

@@ -1,87 +0,0 @@
-import { Document } from "../ai";
-import { alchemy } from "../alchemy";
-export async function GettingStarted({ path: outFile, prompt, model = {
-    id: "claude-3-5-sonnet-latest",
-    provider: "anthropic",
-}, }) {
-    return Document(`docs/getting-started`, {
-        title: "Getting Started Guide",
-        path: typeof outFile === "string" ? outFile : outFile.path,
-        model,
-        prompt: await alchemy `
-      You are a technical writer creating a getting started guide.
-      
-      ${prompt}
-      
-      If you need a template structure to follow, use this format:
-      
-      # Getting Started with [Product/Framework Name]
-      
-      (Brief introduction to the product/framework)
-      
-      ## Installation
-      
-      \`\`\`bash
-      # Installation command
-      \`\`\`
-      
-      ## Creating Your First Project
-      
-      (Step-by-step guide to creating a basic project)
-      
-      \`\`\`ts
-      // Example of a simple project
-      \`\`\`
-      
-      ## Core Concepts
-      
-      ### [Concept 1]
-      
-      (Explanation of the first core concept)
-      
-      \`\`\`ts
-      // Example of using the concept
-      \`\`\`
-      
-      ### [Concept 2]
-      
-      (Explanation of the second core concept)
-      
-      \`\`\`ts
-      // Example of using the concept
-      \`\`\`
-      
-      ## Working with [Feature]
-      
-      (How to use a specific feature)
-      
-      \`\`\`ts
-      // Example of using the feature
-      \`\`\`
-      
-      ## Testing
-      
-      (How to test your project)
-      
-      \`\`\`ts
-      // Example of testing
-      \`\`\`
-      
-      ## Deployment
-      
-      (How to deploy your project)
-      
-      \`\`\`ts
-      // Example of deployment
-      \`\`\`
-      
-      ## Next Steps
-      
-      (Where to go next to learn more)
-      
-      > [!TIP]
-      > Make sure the examples follow a natural progression from minimal examples to more complex use cases.
-      > Keep explanations concise and focused on high-value information.
-    `,
-    });
-}

package/lib/internal/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./getting-started";
-export * from "./providers";
-export * from "./tutorial";

package/lib/internal/index.js

@@ -1,3 +0,0 @@
-export * from "./getting-started";
-export * from "./providers";
-export * from "./tutorial";