alchemy 0.2.5 → 0.3.1

package/src/ai/yaml-file.ts

@@ -0,0 +1,328 @@
+import { generateObject, generateText } from "ai";
+import type { JsonSchema, Type, type } from "arktype";
+import type { Context } from "../context";
+import { StaticYamlFile } from "../fs/static-yaml-file";
+import { Resource } from "../resource";
+import type { Secret } from "../secret";
+import { ark } from "./ark";
+import { type ModelConfig, createModel } from "./client";
+
+/**
+ * Properties for creating or updating a YAMLFile
+ */
+export interface YAMLFileProps<
+  T extends Type<any, any> | undefined = undefined,
+> {
+  /**
+   * Path to the YAML file
+   */
+  path: string;
+
+  /**
+   * Optional ArkType schema to validate and structure the generated YAML
+   * When provided, the resource will use generateObject with schema validation
+   * When not provided, it will extract YAML from between ```yaml fences
+   */
+  schema?: T;
+
+  /**
+   * 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 a YAML configuration for:
+   *   ${alchemy.file("src/serverless.js")}
+   * `
+   */
+  prompt: string;
+
+  /**
+   * System prompt for the model
+   * This is used to provide instructions to the model about how to format the response
+   * @default Depends on whether schema is provided
+   */
+  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;
+}
+
+/**
+ * A YAML file that can be created, updated, and deleted
+ */
+export interface YAMLFile<T = any>
+  extends Omit<YAMLFileProps, "schema">,
+    Resource<"ai::YAMLFile"> {
+  /**
+   * Content of the YAML file as a string
+   */
+  content: string;
+
+  /**
+   * Parsed YAML object
+   */
+  yaml: T;
+
+  /**
+   * Schema used to validate the YAML (if provided)
+   */
+  schema?: JsonSchema;
+
+  /**
+   * Time at which the file was created
+   */
+  createdAt: number;
+
+  /**
+   * Time at which the file was last updated
+   */
+  updatedAt: number;
+}
+
+/**
+ * Default system prompt for YAML file generation without schema
+ */
+const DEFAULT_YAML_SYSTEM_PROMPT =
+  "You are a YAML generator. Create valid YAML based on the user's requirements. Your response MUST include only YAML inside ```yaml fences. Do not include any other text, explanations, or multiple code blocks. Use standard YAML syntax with proper indentation. Use quotes around strings that contain special characters when necessary.";
+
+/**
+ * Resource for generating YAML files using AI models.
+ * Can operate in two modes:
+ * 1. With schema: Uses generateObject with type validation, then converts to YAML
+ * 2. Without schema: Extracts YAML from between ```yaml fences
+ *
+ * @example
+ * // Generate a serverless configuration file
+ * const serverlessConfig = await YAMLFile("serverless-config", {
+ *   path: "./serverless.yml",
+ *   prompt: await alchemy`
+ *     Generate a serverless.yml configuration for an AWS Lambda API with:
+ *     - A service name "user-api"
+ *     - Node.js 16.x runtime
+ *     - Three functions: createUser, getUser, and listUsers
+ *     - API Gateway endpoints for each function
+ *     - DynamoDB table for users
+ *     - IAM permissions for DynamoDB access
+ *   `,
+ *   model: {
+ *     id: "gpt-4o",
+ *     provider: "openai"
+ *   }
+ * });
+ *
+ * @example
+ * // Generate YAML with schema validation
+ * import { type } from "arktype";
+ *
+ * const k8sConfigSchema = type({
+ *   apiVersion: "string",
+ *   kind: "string",
+ *   metadata: {
+ *     name: "string",
+ *     namespace: "string?",
+ *     labels: "Record<string, string>?"
+ *   },
+ *   spec: {
+ *     replicas: "number",
+ *     selector: {
+ *       matchLabels: "Record<string, string>"
+ *     },
+ *     template: {
+ *       metadata: {
+ *         labels: "Record<string, string>"
+ *       },
+ *       spec: {
+ *         containers: [{
+ *           name: "string",
+ *           image: "string",
+ *           ports: [{
+ *             containerPort: "number"
+ *           }]
+ *         }]
+ *       }
+ *     }
+ *   }
+ * });
+ *
+ * const deployment = await YAMLFile("k8s-deployment", {
+ *   path: "./kubernetes/deployment.yaml",
+ *   schema: k8sConfigSchema,
+ *   prompt: "Generate a Kubernetes deployment for a web application named 'frontend' with 3 replicas using the nginx:latest image and exposing port 80",
+ *   temperature: 0.2
+ * });
+ *
+ * @example
+ * // Generate GitHub Actions workflow with custom system prompt
+ * const workflow = await YAMLFile("github-workflow", {
+ *   path: "./.github/workflows/ci.yml",
+ *   prompt: await alchemy`
+ *     Create a GitHub Actions workflow for a Node.js project that:
+ *     - Runs on push to main and pull requests
+ *     - Sets up Node.js 18
+ *     - Installs dependencies with npm
+ *     - Runs linting and tests
+ *     - Builds the project
+ *     - Deploys to GitHub Pages on success (main branch only)
+ *   `,
+ *   system: "You are a DevOps expert specializing in GitHub Actions workflows. Create a single YAML file inside ```yaml fences with no additional text. Follow GitHub Actions best practices and use proper YAML syntax.",
+ *   model: {
+ *     id: "claude-3-opus-20240229",
+ *     provider: "anthropic"
+ *   }
+ * });
+ */
+export const YAMLFile = Resource("ai::YAMLFile", async function <
+  const T extends Type<any, any> | undefined = undefined,
+>(this: Context<YAMLFile<T extends Type<any, any> ? type.infer<T> : any>>, id: string, props: YAMLFileProps<T>): Promise<
+  YAMLFile<T extends Type<any, any> ? type.infer<T> : any>
+> {
+  // Handle deletion phase
+  if (this.phase === "delete") {
+    return this.destroy();
+  }
+
+  let yamlContent: string;
+  let yamlObject: any;
+
+  // Check if schema is provided
+  if (props.schema) {
+    // Use schema-based generation
+    const { object } = await generateObject({
+      model: createModel(props),
+      schema: ark.schema<type.infer<typeof props.schema>>(props.schema),
+      providerOptions: props.model?.options,
+      system:
+        props.system ||
+        "Generate a valid object based on the provided requirements.",
+      prompt: props.prompt,
+      ...(props.temperature === undefined
+        ? {}
+        : { temperature: props.temperature }),
+    });
+
+    yamlObject = object;
+
+    // Let StaticYamlFile handle the YAML conversion
+    const file = await StaticYamlFile("file", props.path, yamlObject);
+    yamlContent = file.content;
+  } else {
+    // Use fence-based extraction
+    // Use provided system prompt or default
+    const system = props.system || DEFAULT_YAML_SYSTEM_PROMPT;
+
+    // Generate initial content
+    const { text } = await generateText({
+      model: createModel(props),
+      prompt: props.prompt,
+      system,
+      providerOptions: props.model?.options,
+      ...(props.temperature === undefined
+        ? {}
+        : { temperature: props.temperature }),
+    });
+
+    // Extract and validate YAML content
+    let { content, error } = await extractYAMLContent(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 YAML block inside \`\`\`yaml 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 extractYAMLContent(retryText);
+
+      if (retryResult.error) {
+        throw new Error(`Failed to generate valid YAML: ${retryResult.error}`);
+      }
+
+      content = retryResult.content;
+    }
+
+    yamlContent = content;
+
+    // Create the file with the string content
+    const file = await StaticYamlFile("file", props.path, yamlContent);
+
+    // We need to parse the YAML to get the object representation
+    const yaml = await import("yaml");
+    yamlObject = yaml.parse(yamlContent);
+  }
+
+  // Return the resource
+  return this({
+    ...props,
+    schema: props.schema,
+    content: yamlContent,
+    yaml: yamlObject,
+    createdAt: Date.now(),
+    updatedAt: Date.now(),
+  });
+});
+
+/**
+ * Extracts YAML content from between ```yaml fences
+ * Validates that exactly one YAML code block exists
+ *
+ * @param text The text to extract YAML from
+ * @returns The extracted YAML or error message
+ */
+async function extractYAMLContent(
+  text: string
+): Promise<{ content: string; error?: string }> {
+  // Check for yaml or yml fence blocks
+  const yamlCodeRegex = /```(yaml|yml)\s*([\s\S]*?)```/g;
+  const matches = Array.from(text.matchAll(yamlCodeRegex));
+
+  if (matches.length === 0) {
+    return {
+      content: "",
+      error:
+        "No YAML code block found in the response. Please include your YAML within ```yaml fences.",
+    };
+  }
+
+  if (matches.length > 1) {
+    return {
+      content: "",
+      error:
+        "Multiple YAML code blocks found in the response. Please provide exactly one YAML block within ```yaml fences.",
+    };
+  }
+
+  const content = matches[0][2].trim();
+
+  // We don't validate YAML parsing here because js-yaml might not be available
+  // Validation will happen at usage time if needed
+  return { content };
+}

package/src/alchemy.ts

@@ -111,6 +111,16 @@ function _alchemy(
         values.map(async function resolve(value): Promise<string> {
           if (typeof value === "string") {
             return indent + value;
+          } else if (value === null) {
+            return "null";
+          } else if (value === undefined) {
+            return "undefined";
+          } else if (
+            typeof value === "number" ||
+            typeof value === "boolean" ||
+            typeof value === "bigint"
+          ) {
+            return value.toString();
           } else if (value instanceof Promise) {
             return resolve(await value);
           } else if (isFileRef(value)) {
@@ -128,14 +138,15 @@ function _alchemy(
           } else if (Array.isArray(value)) {
             return (
               await Promise.all(
-                value.map(async (value, i) => `${i}. ${await resolve(value)}`),
+                value.map(async (value, i) => `${i}. ${await resolve(value)}`)
               )
             ).join("\n");
           } else {
             // TODO: support other types
-            throw new Error(`Unsupported value type: ${JSON.stringify(value)}`);
+            console.log(value);
+            throw new Error(`Unsupported value type: ${value}`);
           }
-        }),
+        })
       );
 
       // Construct the string template by joining template parts with interpolated values
@@ -144,12 +155,12 @@ function _alchemy(
           part
             .split("\n")
             .map((line) =>
-              line.startsWith(indent) ? line.slice(indent.length) : line,
+              line.startsWith(indent) ? line.slice(indent.length) : line
             )
-            .join("\n"),
+            .join("\n")
         )
         .flatMap((part, i) =>
-          i < stringValues.length ? [part, stringValues[i] ?? ""] : [part],
+          i < stringValues.length ? [part, stringValues[i] ?? ""] : [part]
         )
         .join("")
         .split("\n");
@@ -240,7 +251,7 @@ export interface AlchemyOptions {
  */
 function scope(
   id: string | undefined,
-  options?: AlchemyOptions,
+  options?: AlchemyOptions
   // TODO: maybe we want to allow using _ = await alchemy.scope(import.meta)
   // | [meta: ImportMeta]
 ): Scope {

package/src/apply.ts

@@ -19,7 +19,7 @@ export interface ApplyOptions {
 export async function apply<Out extends Resource>(
   resource: PendingResource<Out>,
   props: ResourceProps | undefined,
-  options?: ApplyOptions,
+  options?: ApplyOptions
 ): Promise<Awaited<Out>> {
   const scope = resource.Scope;
   try {
@@ -64,18 +64,18 @@ export async function apply<Out extends Resource>(
                 "@secret": value.unencrypted,
               }
             : value,
-        2,
+        2
       );
       const newProps = JSON.stringify(
         await serialize(scope, props, {
           encrypt: false,
         }),
         null,
-        2,
+        2
       );
       if (oldProps === newProps && alwaysUpdate !== true) {
         if (!quiet) {
-          console.log(`Skip:    "${resource.FQN}" (no changes)`);
+          // console.log(`Skip:    "${resource.FQN}" (no changes)`);
         }
         return state.output as Awaited<Out>;
       }
@@ -88,7 +88,7 @@ export async function apply<Out extends Resource>(
 
     if (!quiet) {
       console.log(
-        `${phase === "create" ? "Create" : "Update"}:  "${resource.FQN}"`,
+        `${phase === "create" ? "Create" : "Update"}:  "${resource.FQN}"`
       );
     }
 
@@ -108,7 +108,7 @@ export async function apply<Out extends Resource>(
       replace: () => {
         if (isReplaced) {
           console.warn(
-            `Resource ${resource.Kind} ${resource.FQN} is already marked as REPLACE`,
+            `Resource ${resource.Kind} ${resource.FQN} is already marked as REPLACE`
           );
           return;
         }
@@ -117,12 +117,11 @@ export async function apply<Out extends Resource>(
     });
 
     const output = await alchemy.run(resource.ID, async () =>
-      provider.handler.bind(ctx)(resource.ID, props),
+      provider.handler.bind(ctx)(resource.ID, props)
     );
-
     if (!quiet) {
       console.log(
-        `${phase === "create" ? "Created" : "Updated"}: "${resource.FQN}"`,
+        `${phase === "create" ? "Created" : "Updated"}: "${resource.FQN}"`
       );
     }