alchemy 0.2.5 → 0.3.0

package/src/internal/providers.ts

@@ -0,0 +1,209 @@
+import alchemy from "alchemy";
+import { Data, Document } from "alchemy/ai";
+import { Folder } from "alchemy/fs";
+import { type } from "arktype";
+import fs from "fs/promises";
+import path from "path";
+
+export interface DocsProps {
+  /**
+   * The output directory for the docs.
+   */
+  outDir: string | Folder;
+  /**
+   * Whether to filter the docs.
+   * If true, include all docs.
+   * If false, include none.
+   * If a number, include that many providers.
+   *
+   * @default true (all docs)
+   */
+  filter?: boolean | number;
+}
+
+export type AlchemyProviderDocs = {
+  dir: string;
+  provider: string;
+  documents: Document[];
+}[];
+
+export async function AlchemyProviderDocs({
+  outDir,
+  filter,
+}: DocsProps): Promise<AlchemyProviderDocs> {
+  outDir = typeof outDir === "string" ? outDir : outDir.path;
+  const providersDir = (await Folder(path.join(outDir, "providers"))).path;
+
+  const exclude = ["util", "test", "vitepress", "vite", "shadcn", "internal"];
+
+  // Get all folders in the alchemy/src directory
+  let providers = (
+    await fs.readdir(path.resolve("..", "alchemy", "src"), {
+      withFileTypes: true,
+    })
+  )
+    .filter((dirent) => dirent.isDirectory() && !exclude.includes(dirent.name))
+    .map((dirent) => path.join(dirent.parentPath, dirent.name));
+
+  // For each provider, list all files
+  if (filter === false) {
+    return [];
+  } else if (typeof filter === "number") {
+    providers = providers.slice(0, filter);
+  }
+
+  return await Promise.all(
+    providers.map(async (provider) => {
+      const providerName = path.basename(provider);
+      const files = (
+        await fs.readdir(path.resolve(provider), {
+          withFileTypes: true,
+        })
+      )
+        .filter((dirent) => dirent.isFile())
+        .map((dirent) =>
+          path.relative(process.cwd(), path.resolve(provider, dirent.name)),
+        )
+        .filter((file) => file.endsWith(".ts") && !file.endsWith("index.ts"));
+
+      const {
+        object: { groups },
+      } = await Data(`docs/${providerName}`, {
+        model: {
+          id: "gpt-4o",
+          provider: "openai",
+          // options: {
+          //   reasoningEffort: "high",
+          // },
+        },
+        temperature: 0.1,
+        schema: type({
+          groups: type({
+            title: type("string").describe(
+              "The title of the group, should be the Resource Name exactly as it's defined in code (const ResourceName translates to 'Resource Name') without spaces, e.g. Bucket or Static Site.",
+            ),
+            filename: type("string").describe(
+              "The filename of the Resource's Document, e.g. bucket.md or static-site.md",
+            ),
+            category: type("'Resource'|'Client'|'Utility'|'Types'").describe(
+              "The classification of the Resource's Document, one of: Resource, Client, Utility, or Types.",
+            ),
+          }).array(),
+        }),
+        system: await alchemy`
+          You are a technical writer tasked with identifying the distinct documents that need to be written for a document group (folder) in a documentation site.
+          You will be provided with a list of documents and instructions on how to classify them.
+          Each document has a title, file name, and category.
+        `,
+        prompt: await alchemy`
+          Identify and classify the documents that need to be written for the '${provider}' Service's Alchemy Resources.
+          For background knowledge on Alchemy, see ${alchemy.file("../README.md")}.
+          For background knowledge on the structure of an Alchemy Resource, see ${alchemy.file("../.cursorrules")}.
+
+          The ${provider} Service has the following resources:
+          ${alchemy.files(files)}
+
+          A file is considered a "Resource" if it contains a const <ResourceName> = Resource(...) call or if it is a function that calls a Resource function, e.g. const TypeScriptFile = () => File(...).
+          A file is considered a "Client" if it exposes a wrapper around creating a SDK client or fetch.
+          A file is considered a "Utility" if it contains utility functions that are not resources or clients.
+          A file is considered a "Types" if it contains just type definitions and maybe helpers around working with those types.
+
+          The title should be simply the name of the resource's const in code (with spaces added in between each word), e.g. "Bucket" or "Function", except with spaces, e.g. "Static Site" for "const StaticSite". Maintain all other casing.
+
+          // "Resource Name"
+          const ResourceName = Resource(...)
+        `,
+      });
+
+      // console.log(groups);
+
+      const providerDocsDir = (
+        await Folder(path.join(providersDir, providerName))
+      ).path;
+
+      const documents = await Promise.all(
+        groups
+          .filter((g) => g.category === "Resource")
+          .map(async (g) =>
+            Document(`docs/${providerName}/${g.title}`, {
+              title: g.title,
+              path: path.join(
+                providerDocsDir,
+                `${g.filename.replace(".ts", "").replace(".md", "")}.md`,
+              ),
+              prompt: await alchemy`
+                You are a technical writer writing API documentation for an Alchemy IaC Resource.
+                See ${alchemy.file("../README.md")} to understand the overview of Alchemy.
+                See ${alchemy.file("../.cursorrules")} to better understand the structure and convention of an Alchemy Resource.
+
+                Relevant files for the ${providerName} Service:
+                ${alchemy.files(files)}
+                
+                Write concise documentation for the "${g.title}" Resource.
+
+                > [!CAUTION]
+                > Avoid the temptation to over explain or over describe. Focus on concise, simple, high value snippets. One heading and 0-1 descriptions per snippet.
+                
+                > [!TIP]
+                > Make sure the examples follow a natural progression from the minimal example to logical next steps of how the Resource might be used.
+
+                Each document must follow the following format:
+                
+                # ${g.title}
+
+                (simple description with an external link to the provider's website)
+                e.g.
+                The Efs component lets you add [Amazon Elastic File System (EFS)](https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html) to your app.
+
+                # Minimal Example
+
+                \`\`\`ts
+                import { ${g.title.replaceAll(" ", "")} } from "alchemy/${providerName}";
+
+                (example)
+                \`\`\`
+
+
+                # Create the ${g.title}
+
+                \`\`\`ts
+                import { ${g.title.replaceAll(" ", "")} } from "alchemy/${providerName}";
+
+                (example)
+                \`\`\`
+
+                ${
+                  providerName === "cloudflare"
+                    ? await alchemy`# Bind to a Worker
+                (if it is a Cloudflare Resource)
+
+                \`\`\`ts
+                import { Worker, ${g.title.replaceAll(" ", "")} } from "alchemy/${providerName}";
+
+                const myResource = await ${g.title.replaceAll(" ", "")}("my-resource", {
+                  // ...
+                });
+
+                await Worker("my-worker", {
+                  name: "my-worker",
+                  script: "console.log('Hello, world!')",
+                  bindings: {
+                    myResource,
+                  },
+                });
+                \`\`\``
+                    : ""
+                }
+              `,
+            }),
+          ),
+      );
+
+      return {
+        dir: providerDocsDir,
+        provider: providerName,
+        documents,
+      } as const;
+    }),
+  );
+}

package/src/resource.ts

@@ -112,7 +112,16 @@ export function Resource<
     if (scope.resources.has(resourceID)) {
       // TODO(sam): do we want to throw?
       // it's kind of awesome that you can re-create a resource and call apply
-      // console.warn(`Resource ${id} already exists in the stack: ${stack.id}`);
+      const otherResource = scope.resources.get(resourceID);
+      if (otherResource?.Kind !== type) {
+        scope.fail();
+        throw new Error(
+          `Resource ${resourceID} already exists in the stack and is of a different type: '${otherResource?.Kind}' !== '${type}'`,
+        );
+      }
+      // console.warn(
+      //   `Resource ${resourceID} already exists in the stack: ${scope.chain.join("/")}`,
+      // );
     }
 
     // get a sequence number (unique within the scope) for the resource

package/src/scope.ts

@@ -1,11 +1,8 @@
 import { AsyncLocalStorage } from "node:async_hooks";
 import { destroy } from "./destroy";
+import { FileSystemStateStore } from "./fs/file-system-state-store";
 import type { PendingResource, ResourceID } from "./resource";
-import {
-  FileSystemStateStore,
-  type StateStore,
-  type StateStoreType,
-} from "./state";
+import type { StateStore, StateStoreType } from "./state";
 
 const scopeStorage = new AsyncLocalStorage<Scope>();
 
@@ -53,7 +50,9 @@ export class Scope {
       throw new Error("Scope name is required when creating a child scope");
     }
     this.password = options.password;
-    this.state = new (options.stateStore ?? FileSystemStateStore)(this);
+    this.state = options.stateStore
+      ? options.stateStore(this)
+      : new FileSystemStateStore(this);
   }
 
   public async delete(resourceID: ResourceID) {

package/src/state.ts

@@ -1,9 +1,5 @@
-import fs from "node:fs";
-import path from "node:path";
 import type { Resource, ResourceProps } from "./resource";
 import type { Scope } from "./scope";
-import { ignore } from "./util/ignore";
-import { deserialize, serialize } from "./util/serde";
 
 export interface State<
   Kind extends string = string,
@@ -28,7 +24,7 @@ export interface State<
   output: Out;
 }
 
-export type StateStoreType = new (scope: Scope) => StateStore;
+export type StateStoreType = (scope: Scope) => StateStore;
 
 export interface StateStore {
   /** Initialize the state container if one is required */
@@ -45,109 +41,3 @@ export interface StateStore {
   set(key: string, value: State): Promise<void>;
   delete(key: string): Promise<void>;
 }
-
-const stateRootDir = path.join(process.cwd(), ".alchemy");
-
-export class FileSystemStateStore implements StateStore {
-  public readonly dir: string;
-  constructor(public readonly scope: Scope) {
-    this.dir = path.join(stateRootDir, ...scope.chain);
-  }
-
-  async init(): Promise<void> {
-    await fs.promises.mkdir(stateRootDir, { recursive: true });
-    await fs.promises.mkdir(this.dir, { recursive: true });
-  }
-
-  async deinit(): Promise<void> {
-    await ignore("ENOENT", () => fs.promises.rmdir(this.dir));
-  }
-
-  async count(): Promise<number> {
-    return Object.keys(await this.list()).length;
-  }
-
-  async list(): Promise<string[]> {
-    try {
-      const files = await fs.promises.readdir(this.dir, {
-        withFileTypes: true,
-      });
-      return files
-        .filter((dirent) => dirent.isFile() && dirent.name.endsWith(".json"))
-        .map((dirent) => dirent.name.replace(/\.json$/, ""))
-        .map((key) => key.replaceAll(":", "/"));
-    } catch (error: any) {
-      if (error.code === "ENOENT") {
-        return [];
-      }
-      throw error;
-    }
-  }
-
-  async get(key: string): Promise<State | undefined> {
-    try {
-      const content = await fs.promises.readFile(
-        await this.getPath(key),
-        "utf8",
-      );
-      const state = (await deserialize(
-        this.scope,
-        JSON.parse(content),
-      )) as State;
-      if (state.output === undefined) {
-        state.output = {} as any;
-      }
-      state.output.Scope = this.scope;
-      return state;
-    } catch (error: any) {
-      if (error.code === "ENOENT") {
-        return undefined;
-      }
-      throw error;
-    }
-  }
-
-  async set(key: string, value: State): Promise<void> {
-    return fs.promises.writeFile(
-      await this.getPath(key),
-      JSON.stringify(await serialize(this.scope, value), null, 2),
-    );
-  }
-
-  async delete(key: string): Promise<void> {
-    return fs.promises.unlink(await this.getPath(key));
-  }
-
-  async all(): Promise<Record<string, State>> {
-    return this.getBatch(await this.list());
-  }
-
-  async getBatch(ids: string[]): Promise<Record<string, State>> {
-    return Object.fromEntries(
-      (
-        await Promise.all(
-          Array.from(ids).flatMap(async (id) => {
-            const s = await this.get(id);
-            if (s === undefined) {
-              return [] as const;
-            }
-            return [[id, s]] as const;
-          }),
-        )
-      ).flat(),
-    );
-  }
-
-  private async getPath(key: string): Promise<string> {
-    if (key.includes(":")) {
-      throw new Error(`ID cannot include colons: ${key}`);
-    }
-    if (key.includes("/")) {
-      key = key.replaceAll("/", ":");
-    }
-    const file = path.join(this.dir, `${key}.json`);
-    const dir = path.dirname(file);
-    await fs.promises.mkdir(dir, { recursive: true });
-    return file;
-  }
-}

package/src/test/bun.ts

@@ -1,10 +1,12 @@
 /// <reference types="bun" />
 
-import { afterAll, it } from "bun:test";
+import { afterAll, beforeAll, it } from "bun:test";
 import path from "node:path";
 import { alchemy } from "../alchemy";
+import { R2RestStateStore } from "../cloudflare";
 import { destroy } from "../destroy";
 import type { Scope } from "../scope";
+import type { StateStoreType } from "../state";
 
 /**
  * Extend the Alchemy interface to include test functionality
@@ -41,12 +43,17 @@ export interface TestOptions {
    * @default "test-password".
    */
   password?: string;
-}
 
-/**
- * Global test scope for all tests
- */
-const globalTestScope = alchemy.scope("test");
+  /**
+   * Override the default state store for the test.
+   */
+  stateStore?: StateStoreType;
+
+  /**
+   * Prefix to use for the scope to isolate tests and environments.
+   */
+  prefix?: string;
+}
 
 /**
  * Test function type definition with overloads
@@ -80,6 +87,10 @@ type test = {
    */
   skipIf(condition: boolean): test;
 
+  beforeAll(fn: (scope: Scope) => Promise<void>): void;
+
+  afterAll(fn: (scope: Scope) => Promise<void>): void;
+
   /**
    * Current test scope
    */
@@ -110,6 +121,20 @@ type test = {
  * ```
  */
 export function test(meta: ImportMeta, defaultOptions?: TestOptions): test {
+  defaultOptions = defaultOptions ?? {};
+  if (
+    defaultOptions.stateStore === undefined &&
+    // process.env.CI &&
+    process.env.ALCHEMY_STATE_STORE === "cloudflare"
+  ) {
+    defaultOptions.stateStore = (scope) =>
+      new R2RestStateStore(scope, {
+        apiKey: process.env.CLOUDFLARE_API_KEY,
+        email: process.env.CLOUDFLARE_EMAIL,
+        bucketName: process.env.CLOUDFLARE_BUCKET_NAME!,
+      });
+  }
+
   // Add skipIf functionality
   test.skipIf = (condition: boolean) => {
     if (condition) {
@@ -120,13 +145,35 @@ export function test(meta: ImportMeta, defaultOptions?: TestOptions): test {
   };
 
   // Create local test scope based on filename
-  const localTestScope = alchemy.scope(path.basename(meta.filename), {
-    parent: globalTestScope,
-  });
+  const localTestScope = alchemy.scope(
+    `${defaultOptions.prefix ? `${defaultOptions.prefix}-` : ""}${path.basename(meta.filename)}`,
+    {
+      // parent: globalTestScope,
+      stateStore: defaultOptions?.stateStore,
+    },
+  );
   test.scope = localTestScope;
 
+  test.beforeAll = (fn: (scope: Scope) => Promise<void>) => {
+    return beforeAll(async () => {
+      test.scope.enter();
+      await fn(test.scope);
+    });
+  };
+
+  test.afterAll = (fn: (scope: Scope) => Promise<void>) => {
+    return afterAll(async () => {
+      test.scope.enter();
+      await fn(test.scope);
+    });
+  };
+
   // Clean up test scope after all tests complete
-  afterAll(() => alchemy.destroy(test.scope));
+  afterAll(async () => {
+    if (defaultOptions?.destroy !== false) {
+      await alchemy.destroy(test.scope);
+    }
+  });
 
   return test as any;
 
@@ -173,6 +220,9 @@ export function test(meta: ImportMeta, defaultOptions?: TestOptions): test {
           scope.enter();
           try {
             await fn(scope);
+          } catch (err) {
+            console.error(err);
+            throw err;
           } finally {
             if (options.destroy !== false) {
               await destroy(scope);