alchemy 0.2.5 → 0.3.0

package/lib/ai/data.d.ts

@@ -27,6 +27,13 @@ export interface DataProps<T extends Type<any, any>> {
      * system: "You are a technical writer tasked with describing code"
      */
     system?: string;
+    /**
+     * 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;
     /**
      * Base URL for the OpenAI API
      * @default 'https://api.openai.com/v1'
@@ -69,13 +76,20 @@ export interface Data<T> extends Resource<"ai::Object"> {
  *   price: "number"
  * });
  *
- * const product = await Object("new-product", {
+ * const product = await Data("new-product", {
  *   schema: productSchema,
  *   prompt: "Generate a product description for a new smartphone",
- *   system: "You are a product copywriter specializing in tech products"
+ *   system: "You are a product copywriter specializing in tech products",
+ *   model: {
+ *     id: "gpt-4o",
+ *     provider: "openai",
+ *     options: {
+ *       temperature: 0.7
+ *     }
+ *   }
  * });
  *
- * console.log(product.content); // Typed as per schema
+ * console.log(product.object); // Typed as per schema
  *
  * @example
  * // Generate code documentation with context
@@ -89,13 +103,39 @@ export interface Data<T> extends Resource<"ai::Object"> {
  *   returns: "string"
  * });
  *
- * const docs = await Object("function-docs", {
+ * const docs = await Data("function-docs", {
  *   schema: docSchema,
  *   prompt: await alchemy`
  *     Generate documentation for this function:
  *     ${alchemy.file("src/utils/format.ts")}
  *   `,
- *   system: "You are a technical documentation writer"
+ *   system: "You are a technical documentation writer",
+ *   temperature: 0.2
+ * });
+ *
+ * @example
+ * // Using specific model configuration with advanced options
+ * const analysisSchema = type({
+ *   insights: "string[]",
+ *   recommendations: "string[]",
+ *   risk: "'low'|'medium'|'high'"
+ * });
+ *
+ * const analysis = await Data("code-analysis", {
+ *   schema: analysisSchema,
+ *   prompt: await alchemy`
+ *     Analyze this code for security issues:
+ *     ${alchemy.file("src/auth/login.ts")}
+ *   `,
+ *   system: "You are a security expert specializing in code analysis",
+ *   model: {
+ *     id: "o3-mini",
+ *     provider: "openai",
+ *     options: {
+ *       reasoningEffort: "high"
+ *     }
+ *   },
+ *   temperature: 0.1
  * });
  */
 export declare const Data: (((this: any, id: string, props?: {}) => never) & (new (_: never) => never)) | (<const T extends Type<any, any>>(this: Context<Data<any>>, id: string, props: DataProps<T>) => Promise<Data<type.infer<T>>>);

package/lib/ai/data.js

@@ -1,7 +1,7 @@
 import { generateObject } from "ai";
 import { Resource } from "../resource";
 import { ark } from "./ark";
-import { createClient, getModelId, getModelOptions, } from "./client";
+import { createModel } from "./client";
 /**
  * Resource for generating structured content using the Vercel AI SDK.
  * Supports powerful context handling through the alchemy template literal tag.
@@ -15,13 +15,20 @@ import { createClient, getModelId, getModelOptions, } from "./client";
  *   price: "number"
  * });
  *
- * const product = await Object("new-product", {
+ * const product = await Data("new-product", {
  *   schema: productSchema,
  *   prompt: "Generate a product description for a new smartphone",
- *   system: "You are a product copywriter specializing in tech products"
+ *   system: "You are a product copywriter specializing in tech products",
+ *   model: {
+ *     id: "gpt-4o",
+ *     provider: "openai",
+ *     options: {
+ *       temperature: 0.7
+ *     }
+ *   }
  * });
  *
- * console.log(product.content); // Typed as per schema
+ * console.log(product.object); // Typed as per schema
  *
  * @example
  * // Generate code documentation with context
@@ -35,31 +42,59 @@ import { createClient, getModelId, getModelOptions, } from "./client";
  *   returns: "string"
  * });
  *
- * const docs = await Object("function-docs", {
+ * const docs = await Data("function-docs", {
  *   schema: docSchema,
  *   prompt: await alchemy`
  *     Generate documentation for this function:
  *     ${alchemy.file("src/utils/format.ts")}
  *   `,
- *   system: "You are a technical documentation writer"
+ *   system: "You are a technical documentation writer",
+ *   temperature: 0.2
+ * });
+ *
+ * @example
+ * // Using specific model configuration with advanced options
+ * const analysisSchema = type({
+ *   insights: "string[]",
+ *   recommendations: "string[]",
+ *   risk: "'low'|'medium'|'high'"
+ * });
+ *
+ * const analysis = await Data("code-analysis", {
+ *   schema: analysisSchema,
+ *   prompt: await alchemy`
+ *     Analyze this code for security issues:
+ *     ${alchemy.file("src/auth/login.ts")}
+ *   `,
+ *   system: "You are a security expert specializing in code analysis",
+ *   model: {
+ *     id: "o3-mini",
+ *     provider: "openai",
+ *     options: {
+ *       reasoningEffort: "high"
+ *     }
+ *   },
+ *   temperature: 0.1
  * });
  */
 export const Data = Resource("ai::Object", async function (id, props) {
     if (this.phase === "delete") {
         return this.destroy();
     }
-    // Initialize OpenAI compatible provider using shared client
-    const provider = createClient(props);
     // Generate structured output using generateObject
     const { object } = await generateObject({
-        model: provider(getModelId(props)),
+        model: createModel(props),
         // Convert ArkType schema to Zod schema for generateObject
         // This is needed because generateObject expects a Zod schema
         schema: ark.schema(props.schema),
+        providerOptions: props.model?.options,
         system: props.system ||
             "You are an AI assistant tasked with generating structured content.",
         prompt: props.prompt,
-        ...getModelOptions(props),
+        ...(props.temperature === undefined
+            ? {}
+            : // some models error if you provide it (rather than ignoring it)
+                { temperature: props.temperature }),
     });
     // Return the resource with typed content
     return this({

package/lib/ai/document.d.ts

@@ -29,6 +29,13 @@ export interface DocumentProps {
      * `
      */
     prompt: string;
+    /**
+     * 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 return a single markdown document inside ```md fences
+     * @default "You are a technical documentation writer. Create a single markdown document based on the user's requirements. Your response MUST include only a single markdown document inside ```md fences. Do not include any other text, explanations, or multiple code blocks."
+     */
+    system?: string;
     /**
      * OpenAI API key to use for generating content
      * If not provided, will use OPENAI_API_KEY environment variable
@@ -38,6 +45,13 @@ export interface DocumentProps {
      * 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;
 }
 /**
  * A markdown document that can be created, updated, and deleted
@@ -63,39 +77,49 @@ export interface Document extends DocumentProps, Resource<"docs::Document"> {
  * @example
  * // Create a document using alchemy template literals for context
  * const apiDocs = await Document("api-docs", {
+ *   title: "API Documentation",
  *   path: "./docs/api.md",
  *   prompt: await alchemy`
  *     Generate API documentation based on these source files:
  *     ${alchemy.file("src/api.ts")}
  *     ${alchemy.file("src/types.ts")}
- *   `
- *   // The above will automatically append the file contents as code blocks:
- *   //
- *   // Generate API documentation based on these source files:
- *   // [api.ts](src/api.ts)
- *   // [types.ts](src/types.ts)
- *   //
- *   // // src/api.ts
- *   // ```ts
- *   // ... contents of api.ts ...
- *   // ```
- *   //
- *   // // src/types.ts
- *   // ```ts
- *   // ... contents of types.ts ...
- *   // ```
+ *   `,
+ *   model: {
+ *     id: "gpt-4o",
+ *     provider: "openai"
+ *   }
  * });
  *
  * @example
- * // Use alchemy template literals with file collections
+ * // Use alchemy template literals with file collections and temperature control
  * const modelDocs = await Document("models", {
+ *   title: "Data Models",
  *   path: "./docs/models.md",
  *   prompt: await alchemy`
  *     Write documentation for these data models:
  *     ${alchemy.files("src/models/user.ts", "src/models/post.ts")}
- *   `
- *   // This creates a prompt with all files appended as code blocks,
- *   // automatically handling syntax highlighting based on file extensions
+ *   `,
+ *   temperature: 0.2 // Lower temperature for more deterministic output
+ * });
+ *
+ * @example
+ * // Advanced model configuration with custom provider options and custom system prompt
+ * const techDocs = await Document("tech-specs", {
+ *   title: "Technical Specifications",
+ *   path: "./docs/tech-specs.md",
+ *   prompt: await alchemy`
+ *     Create detailed technical specifications based on these requirements:
+ *     ${alchemy.file("requirements/system.md")}
+ *   `,
+ *   system: "You are an expert technical writer specializing in system specifications. Create a single markdown document inside ```md fences with no additional text.",
+ *   model: {
+ *     id: "o3-mini",
+ *     provider: "openai",
+ *     options: {
+ *       reasoningEffort: "high"
+ *     }
+ *   },
+ *   temperature: 0.1
  * });
  */
 export declare const Document: (((this: any, id: string, props?: {}) => never) & (new (_: never) => never)) | ((this: Context<Document>, id: string, props: DocumentProps) => Promise<Document>);

package/lib/ai/document.js

@@ -2,7 +2,12 @@ import { generateText } from "ai";
 import fs from "node:fs/promises";
 import path from "node:path";
 import { Resource } from "../resource";
-import { createClient, getModelId, getModelOptions, } from "./client";
+import { ignore } from "../util/ignore";
+import { createModel } from "./client";
+/**
+ * Default system prompt for markdown document generation
+ */
+const DEFAULT_MD_SYSTEM_PROMPT = "You are a technical documentation writer. Create a single markdown document based on the user's requirements. Your response MUST include only a single markdown document inside ```md fences. Do not include any other text, explanations, or multiple code blocks.";
 /**
  * Resource for managing AI-generated markdown documents using the Vercel AI SDK.
  * Supports powerful context handling through the alchemy template literal tag.
@@ -10,39 +15,49 @@ import { createClient, getModelId, getModelOptions, } from "./client";
  * @example
  * // Create a document using alchemy template literals for context
  * const apiDocs = await Document("api-docs", {
+ *   title: "API Documentation",
  *   path: "./docs/api.md",
  *   prompt: await alchemy`
  *     Generate API documentation based on these source files:
  *     ${alchemy.file("src/api.ts")}
  *     ${alchemy.file("src/types.ts")}
- *   `
- *   // The above will automatically append the file contents as code blocks:
- *   //
- *   // Generate API documentation based on these source files:
- *   // [api.ts](src/api.ts)
- *   // [types.ts](src/types.ts)
- *   //
- *   // // src/api.ts
- *   // ```ts
- *   // ... contents of api.ts ...
- *   // ```
- *   //
- *   // // src/types.ts
- *   // ```ts
- *   // ... contents of types.ts ...
- *   // ```
+ *   `,
+ *   model: {
+ *     id: "gpt-4o",
+ *     provider: "openai"
+ *   }
  * });
  *
  * @example
- * // Use alchemy template literals with file collections
+ * // Use alchemy template literals with file collections and temperature control
  * const modelDocs = await Document("models", {
+ *   title: "Data Models",
  *   path: "./docs/models.md",
  *   prompt: await alchemy`
  *     Write documentation for these data models:
  *     ${alchemy.files("src/models/user.ts", "src/models/post.ts")}
- *   `
- *   // This creates a prompt with all files appended as code blocks,
- *   // automatically handling syntax highlighting based on file extensions
+ *   `,
+ *   temperature: 0.2 // Lower temperature for more deterministic output
+ * });
+ *
+ * @example
+ * // Advanced model configuration with custom provider options and custom system prompt
+ * const techDocs = await Document("tech-specs", {
+ *   title: "Technical Specifications",
+ *   path: "./docs/tech-specs.md",
+ *   prompt: await alchemy`
+ *     Create detailed technical specifications based on these requirements:
+ *     ${alchemy.file("requirements/system.md")}
+ *   `,
+ *   system: "You are an expert technical writer specializing in system specifications. Create a single markdown document inside ```md fences with no additional text.",
+ *   model: {
+ *     id: "o3-mini",
+ *     provider: "openai",
+ *     options: {
+ *       reasoningEffort: "high"
+ *     }
+ *   },
+ *   temperature: 0.1
  * });
  */
 export const Document = Resource("docs::Document", async function (id, props) {
@@ -60,23 +75,75 @@ export const Document = Resource("docs::Document", async function (id, props) {
         }
         return this.destroy();
     }
-    // Initialize OpenAI compatible provider using shared client
-    const provider = createClient(props);
-    // Generate content
+    // Use provided system prompt or default
+    const system = props.system || DEFAULT_MD_SYSTEM_PROMPT;
+    // Generate initial content
     const { text } = await generateText({
-        model: provider(getModelId(props)),
+        model: createModel(props),
         prompt: props.prompt,
-        ...getModelOptions(props),
+        system,
+        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);
+    // 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 retryResult = await 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));
+    }
     // Write content to file
-    await fs.writeFile(props.path, text);
+    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: text,
+        content: content,
         createdAt: stats.birthtimeMs,
         updatedAt: stats.mtimeMs,
     });
 });
+/**
+ * Extracts markdown content from between ```md fences
+ * Validates that exactly one markdown code block exists
+ *
+ * @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) {
+        return {
+            content: "",
+            error: "No markdown code block found in the response. Please include your markdown content within ```md fences.",
+        };
+    }
+    if (matches.length > 1) {
+        return {
+            content: "",
+            error: "Multiple markdown code blocks found in the response. Please provide exactly one markdown block within ```md fences.",
+        };
+    }
+    return { content: matches[0][1].trim() };
+}

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

@@ -0,0 +1,128 @@
+import type { Context } from "../context";
+import { Resource } from "../resource";
+import type { Secret } from "../secret";
+import { type ModelConfig } from "./client";
+/**
+ * Properties for creating or updating an HTMLFile
+ */
+export interface HTMLFileProps {
+    /**
+     * Path to the HTML file
+     */
+    path: string;
+    /**
+     * Base URL for the OpenAI API
+     * @default 'https://api.openai.com/v1'
+     */
+    baseURL?: string;
+    /**
+     * Prompt for generating content
+     * Use alchemy template literals to include file context:
+     * @example
+     * prompt: await alchemy`
+     *   Generate an HTML page using:
+     *   ${alchemy.file("src/templates/base.html")}
+     * `
+     */
+    prompt: string;
+    /**
+     * 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 return HTML code inside ```html fences
+     * @default "You are an HTML code generator. Create HTML code based on the user's requirements. Your response MUST include only HTML code inside ```html fences. Do not include any other text, explanations, or multiple code blocks."
+     */
+    system?: string;
+    /**
+     * OpenAI 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;
+}
+/**
+ * An HTML file that can be created, updated, and deleted
+ */
+export interface HTMLFile extends HTMLFileProps, Resource<"ai::HTMLFile"> {
+    /**
+     * Content of the HTML file
+     */
+    content: string;
+    /**
+     * Time at which the file was created
+     */
+    createdAt: number;
+    /**
+     * Time at which the file was last updated
+     */
+    updatedAt: number;
+}
+/**
+ * Resource for generating HTML files using AI models.
+ * Extracts HTML code from between ```html fences and validates the response.
+ *
+ * @example
+ * // Create a simple landing page
+ * const landingPage = await HTMLFile("landing-page", {
+ *   path: "./public/index.html",
+ *   prompt: await alchemy`
+ *     Generate a modern landing page for a SaaS product with:
+ *     - Hero section with headline and call-to-action
+ *     - Features section with 3 key features
+ *     - Pricing section with 3 tiers
+ *     - Testimonials section with 2 customer quotes
+ *     - Contact form and footer
+ *   `,
+ *   model: {
+ *     id: "gpt-4o",
+ *     provider: "openai"
+ *   }
+ * });
+ *
+ * @example
+ * // Generate an HTML email template
+ * const emailTemplate = await HTMLFile("welcome-email", {
+ *   path: "./emails/welcome.html",
+ *   prompt: await alchemy`
+ *     Create an HTML email template for welcoming new users to our platform.
+ *     The email should include:
+ *     - Company logo and branding
+ *     - Personalized welcome message (use {{name}} placeholder)
+ *     - Three steps to get started
+ *     - Support contact information
+ *     - Unsubscribe footer
+ *
+ *     Make sure it's responsive and works in all major email clients.
+ *   `,
+ *   temperature: 0.2
+ * });
+ *
+ * @example
+ * // Generate an HTML component with custom system prompt
+ * const navComponent = await HTMLFile("navigation", {
+ *   path: "./components/nav.html",
+ *   prompt: await alchemy`
+ *     Create a responsive navigation component with:
+ *     - Logo in the left corner
+ *     - Navigation links: Home, Products, Services, About, Contact
+ *     - Mobile hamburger menu that expands/collapses
+ *     - Login/signup buttons on the right side
+ *     - Dark/light mode toggle
+ *   `,
+ *   system: "You are an expert HTML/CSS developer specializing in responsive components. Create a single HTML file inside ```html fences with no additional text. Use modern HTML5 semantic elements and inline CSS if needed.",
+ *   model: {
+ *     id: "claude-3-opus-20240229",
+ *     provider: "anthropic"
+ *   }
+ * });
+ */
+export declare const HTMLFile: (((this: any, id: string, props?: {}) => never) & (new (_: never) => never)) | ((this: Context<HTMLFile>, id: string, props: HTMLFileProps) => Promise<HTMLFile>);