npm - alchemy - Versions diffs - 0.2.5 → 0.3.1 - Mend

alchemy 0.2.5 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (197) hide show

package/README.md +3 -3
package/lib/ai/approve.d.ts +99 -0
package/lib/ai/approve.js +76 -0
package/lib/ai/astro-file.d.ts +137 -0
package/lib/ai/astro-file.js +156 -0
package/lib/ai/client.d.ts +7 -8
package/lib/ai/client.js +48 -19
package/lib/ai/css-file.d.ts +131 -0
package/lib/ai/css-file.js +141 -0
package/lib/ai/data.d.ts +51 -6
package/lib/ai/data.js +58 -12
package/lib/ai/document.d.ts +108 -24
package/lib/ai/document.js +166 -52
package/lib/ai/html-file.d.ts +128 -0
package/lib/ai/html-file.js +138 -0
package/lib/ai/index.d.ts +9 -0
package/lib/ai/index.js +9 -0
package/lib/ai/json-file.d.ts +160 -0
package/lib/ai/json-file.js +187 -0
package/lib/ai/review.d.ts +122 -0
package/lib/ai/review.js +101 -0
package/lib/ai/typescript-file.d.ts +139 -0
package/lib/ai/typescript-file.js +145 -0
package/lib/ai/vue-file.d.ts +126 -0
package/lib/ai/vue-file.js +136 -0
package/lib/ai/yaml-file.d.ts +169 -0
package/lib/ai/yaml-file.js +200 -0
package/lib/alchemy.js +17 -2
package/lib/apply.js +1 -1
package/lib/cloudflare/dns.d.ts +88 -0
package/lib/cloudflare/dns.js +192 -0
package/lib/cloudflare/generate-asset-manifest.js +1 -1
package/lib/cloudflare/index.d.ts +2 -1
package/lib/cloudflare/index.js +2 -1
package/lib/cloudflare/r2-rest-state-store.d.ts +125 -0
package/lib/cloudflare/r2-rest-state-store.js +254 -0
package/lib/cloudflare/response.d.ts +12 -0
package/lib/cloudflare/response.js +0 -0
package/lib/cloudflare/static-site-router.js +16 -7
package/lib/cloudflare/static-site.js +3 -0
package/lib/cloudflare/upload-asset-manifest.js +4 -2
package/lib/cloudflare/zone.d.ts +18 -0
package/lib/cloudflare/zone.js +17 -4
package/lib/dns/godaddy.d.ts +7 -0
package/lib/dns/godaddy.js +21 -0
package/lib/dns/import-dns.d.ts +82 -0
package/lib/dns/import-dns.js +114 -0
package/lib/dns/index.d.ts +2 -0
package/lib/dns/index.js +2 -0
package/lib/dns/record.d.ts +88 -0
package/lib/dns/record.js +13 -0
package/lib/fs/copy-file.d.ts +54 -0
package/lib/fs/copy-file.js +63 -0
package/lib/fs/file-system-state-store.d.ts +17 -0
package/lib/fs/file-system-state-store.js +87 -0
package/lib/fs/file.d.ts +13 -0
package/lib/fs/file.js +24 -5
package/lib/fs/folder.d.ts +10 -0
package/lib/fs/folder.js +2 -2
package/lib/fs/index.d.ts +10 -4
package/lib/fs/index.js +10 -4
package/lib/fs/static-astro-file.d.ts +34 -0
package/lib/fs/static-astro-file.js +39 -0
package/lib/fs/static-css-file.d.ts +24 -0
package/lib/fs/static-css-file.js +29 -0
package/lib/fs/static-html-file.d.ts +31 -0
package/lib/fs/static-html-file.js +36 -0
package/lib/fs/{json-file.d.ts → static-json-file.d.ts} +3 -3
package/lib/fs/static-json-file.js +15 -0
package/lib/fs/{text-file.d.ts → static-text-file.d.ts} +2 -2
package/lib/fs/static-text-file.js +8 -0
package/lib/fs/{typescript-file.d.ts → static-typescript-file.d.ts} +3 -3
package/lib/fs/{typescript-file.js → static-typescript-file.js} +3 -2
package/lib/fs/static-vue-file.d.ts +28 -0
package/lib/fs/static-vue-file.js +33 -0
package/lib/fs/static-yaml-file.d.ts +22 -0
package/lib/fs/{yaml-file.js → static-yaml-file.js} +3 -2
package/lib/internal/getting-started.d.ts +21 -0
package/lib/internal/getting-started.js +87 -0
package/lib/internal/index.d.ts +3 -0
package/lib/internal/index.js +3 -0
package/lib/internal/providers.d.ts +27 -0
package/lib/internal/providers.js +172 -0
package/lib/internal/tutorial.d.ts +104 -0
package/lib/internal/tutorial.js +251 -0
package/lib/resource.js +8 -1
package/lib/scope.d.ts +1 -1
package/lib/scope.js +4 -2
package/lib/state.d.ts +1 -16
package/lib/state.js +0 -87
package/lib/test/bun.d.ts +11 -0
package/lib/test/bun.js +36 -8
package/lib/web/astro.d.ts +147 -0
package/lib/web/astro.js +414 -0
package/lib/{shadcn/component.js → web/shadcn-component.js} +2 -9
package/lib/web/shadcn.d.ts +97 -0
package/lib/web/shadcn.js +99 -0
package/lib/web/tailwind.d.ts +64 -0
package/lib/web/tailwind.js +97 -0
package/lib/{vite → web}/vite.d.ts +5 -0
package/lib/{vite → web}/vite.js +44 -44
package/lib/web/vitepress/config.d.ts +10 -0
package/lib/web/vitepress/config.js +31 -0
package/lib/web/vitepress/custom-theme.d.ts +173 -0
package/lib/web/vitepress/custom-theme.js +336 -0
package/lib/{vitepress → web/vitepress}/dependencies.d.ts +2 -2
package/lib/{vitepress → web/vitepress}/dependencies.js +1 -1
package/lib/web/vitepress/home-page.d.ts +246 -0
package/lib/web/vitepress/home-page.js +147 -0
package/lib/{vitepress → web/vitepress}/index.d.ts +2 -0
package/lib/{vitepress → web/vitepress}/index.js +2 -0
package/lib/{vitepress → web/vitepress}/vitepress.d.ts +15 -12
package/lib/{vitepress → web/vitepress}/vitepress.js +26 -44
package/package.json +6 -2
package/src/ai/approve.ts +163 -0
package/src/ai/astro-file.ts +269 -0
package/src/ai/client.ts +60 -21
package/src/ai/css-file.ts +247 -0
package/src/ai/data.ts +81 -19
package/src/ai/document.ts +240 -62
package/src/ai/html-file.ts +244 -0
package/src/ai/index.ts +9 -0
package/src/ai/json-file.ts +325 -0
package/src/ai/review.ts +213 -0
package/src/ai/typescript-file.ts +259 -0
package/src/ai/vue-file.ts +242 -0
package/src/ai/yaml-file.ts +328 -0
package/src/alchemy.ts +18 -7
package/src/apply.ts +8 -9
package/src/cloudflare/dns.ts +344 -0
package/src/cloudflare/generate-asset-manifest.ts +4 -4
package/src/cloudflare/index.ts +2 -1
package/src/cloudflare/r2-rest-state-store.ts +353 -0
package/src/cloudflare/response.ts +9 -0
package/src/cloudflare/static-site-router.ts +18 -8
package/src/cloudflare/static-site.ts +11 -7
package/src/cloudflare/upload-asset-manifest.ts +6 -4
package/src/cloudflare/worker.ts +44 -43
package/src/cloudflare/zone.ts +39 -23
package/src/dns/godaddy.ts +29 -0
package/src/dns/import-dns.ts +213 -0
package/src/dns/index.ts +2 -0
package/src/dns/record.ts +121 -0
package/src/fs/copy-file.ts +115 -0
package/src/fs/file-system-state-store.ts +109 -0
package/src/fs/file.ts +35 -9
package/src/fs/folder.ts +14 -2
package/src/fs/index.ts +10 -4
package/src/fs/static-astro-file.ts +45 -0
package/src/fs/static-css-file.ts +35 -0
package/src/fs/static-html-file.ts +42 -0
package/src/fs/static-json-file.ts +34 -0
package/src/fs/{text-file.ts → static-text-file.ts} +9 -3
package/src/fs/{typescript-file.ts → static-typescript-file.ts} +7 -6
package/src/fs/static-vue-file.ts +39 -0
package/src/fs/static-yaml-file.ts +33 -0
package/src/internal/getting-started.ts +115 -0
package/src/internal/index.ts +3 -0
package/src/internal/providers.ts +241 -0
package/src/internal/tutorial.ts +392 -0
package/src/resource.ts +10 -1
package/src/scope.ts +5 -6
package/src/state.ts +1 -111
package/src/test/bun.ts +60 -10
package/src/web/astro.ts +644 -0
package/src/{shadcn/component.ts → web/shadcn-component.ts} +5 -13
package/src/web/shadcn.ts +219 -0
package/src/web/tailwind.ts +167 -0
package/src/{vite → web}/vite.ts +54 -56
package/src/web/vitepress/config.ts +48 -0
package/src/web/vitepress/custom-theme.ts +514 -0
package/src/{vitepress → web/vitepress}/dependencies.ts +2 -2
package/src/web/vitepress/home-page.ts +375 -0
package/src/{vitepress → web/vitepress}/index.ts +2 -0
package/src/{vitepress → web/vitepress}/vitepress.ts +62 -72
package/lib/cloudflare/state.d.ts +0 -82
package/lib/cloudflare/state.js +0 -108
package/lib/fs/json-file.js +0 -7
package/lib/fs/text-file.js +0 -7
package/lib/fs/yaml-file.d.ts +0 -19
package/lib/internal/docs.d.ts +0 -5
package/lib/internal/docs.js +0 -287
package/lib/shadcn/index.d.ts +0 -1
package/lib/shadcn/index.js +0 -1
package/lib/vite/index.d.ts +0 -1
package/lib/vite/index.js +0 -1
package/lib/vitepress/home-page.d.ts +0 -133
package/lib/vitepress/home-page.js +0 -11
package/src/cloudflare/state.ts +0 -138
package/src/fs/json-file.ts +0 -23
package/src/fs/yaml-file.ts +0 -26
package/src/internal/docs.ts +0 -338
package/src/shadcn/index.ts +0 -1
package/src/vite/index.ts +0 -1
package/src/vitepress/home-page.ts +0 -166
/package/lib/{shadcn/component.d.ts → web/shadcn-component.d.ts} +0 -0
/package/src/{vitepress → web/vitepress}/index.md +0 -0

package/lib/fs/static-astro-file.d.ts ADDED Viewed

@@ -0,0 +1,34 @@
+import { File } from "./file";
+export type StaticAstroFile = File;
+/**
+ * Creates a static Astro component file
+ *
+ * @example
+ * // Create an Astro component file with content
+ * const header = await StaticAstroFile("Header.astro",
+ *   `---
+ *   import Logo from '../components/Logo.astro';
+ *   const navItems = ['Home', 'About', 'Contact'];
+ *   ---
+ *
+ *   <header class="header">
+ *     <Logo />
+ *     <nav>
+ *       <ul>
+ *         {navItems.map(item => (
+ *           <li><a href={`/${item.toLowerCase()}`}>{item}</a></li>
+ *         ))}
+ *       </ul>
+ *     </nav>
+ *   </header>
+ *
+ *   <style>
+ *     .header {
+ *       display: flex;
+ *       justify-content: space-between;
+ *       padding: 1rem;
+ *     }
+ *   </style>`
+ * );
+ */
+export declare function StaticAstroFile(id: string, ...args: [content: string] | [path: string, content: string]): Promise<StaticAstroFile>;

package/lib/fs/static-astro-file.js ADDED Viewed

@@ -0,0 +1,39 @@
+import { File } from "./file";
+/**
+ * Creates a static Astro component file
+ *
+ * @example
+ * // Create an Astro component file with content
+ * const header = await StaticAstroFile("Header.astro",
+ *   `---
+ *   import Logo from '../components/Logo.astro';
+ *   const navItems = ['Home', 'About', 'Contact'];
+ *   ---
+ *
+ *   <header class="header">
+ *     <Logo />
+ *     <nav>
+ *       <ul>
+ *         {navItems.map(item => (
+ *           <li><a href={`/${item.toLowerCase()}`}>{item}</a></li>
+ *         ))}
+ *       </ul>
+ *     </nav>
+ *   </header>
+ *
+ *   <style>
+ *     .header {
+ *       display: flex;
+ *       justify-content: space-between;
+ *       padding: 1rem;
+ *     }
+ *   </style>`
+ * );
+ */
+export function StaticAstroFile(id, ...args) {
+    const [path, content] = args.length === 1 ? [id, args[0]] : args;
+    return File(id, {
+        path,
+        content,
+    });
+}

package/lib/fs/static-css-file.d.ts ADDED Viewed

@@ -0,0 +1,24 @@
+import { File } from "./file";
+export type StaticCSSFile = File;
+/**
+ * Creates a static CSS file
+ *
+ * @example
+ * // Create a CSS file with styles
+ * const styles = await StaticCSSFile("styles.css",
+ *   `.container {
+ *     max-width: 1200px;
+ *     margin: 0 auto;
+ *     padding: 0 1rem;
+ *   }
+ *
+ *   .button {
+ *     background-color: #0062ff;
+ *     color: white;
+ *     border: none;
+ *     padding: 0.5rem 1rem;
+ *     border-radius: 4px;
+ *   }`
+ * );
+ */
+export declare function StaticCSSFile(id: string, ...args: [content: string] | [path: string, content: string]): Promise<StaticCSSFile>;

package/lib/fs/static-css-file.js ADDED Viewed

@@ -0,0 +1,29 @@
+import { File } from "./file";
+/**
+ * Creates a static CSS file
+ *
+ * @example
+ * // Create a CSS file with styles
+ * const styles = await StaticCSSFile("styles.css",
+ *   `.container {
+ *     max-width: 1200px;
+ *     margin: 0 auto;
+ *     padding: 0 1rem;
+ *   }
+ *
+ *   .button {
+ *     background-color: #0062ff;
+ *     color: white;
+ *     border: none;
+ *     padding: 0.5rem 1rem;
+ *     border-radius: 4px;
+ *   }`
+ * );
+ */
+export function StaticCSSFile(id, ...args) {
+    const [path, content] = args.length === 1 ? [id, args[0]] : args;
+    return File(id, {
+        path,
+        content,
+    });
+}

package/lib/fs/static-html-file.d.ts ADDED Viewed

@@ -0,0 +1,31 @@
+import { File } from "./file";
+export type StaticHTMLFile = File;
+/**
+ * Creates a static HTML file
+ *
+ * @example
+ * // Create an HTML file with content
+ * const page = await StaticHTMLFile("index.html",
+ *   `<!DOCTYPE html>
+ *   <html lang="en">
+ *   <head>
+ *     <meta charset="UTF-8">
+ *     <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ *     <title>My Website</title>
+ *     <link rel="stylesheet" href="styles.css">
+ *   </head>
+ *   <body>
+ *     <header>
+ *       <h1>Welcome to My Website</h1>
+ *     </header>
+ *     <main>
+ *       <p>This is the main content of the page.</p>
+ *     </main>
+ *     <footer>
+ *       <p>&copy; 2024 My Company</p>
+ *     </footer>
+ *   </body>
+ *   </html>`
+ * );
+ */
+export declare function StaticHTMLFile(id: string, ...args: [content: string] | [path: string, content: string]): Promise<StaticHTMLFile>;

package/lib/fs/static-html-file.js ADDED Viewed

@@ -0,0 +1,36 @@
+import { File } from "./file";
+/**
+ * Creates a static HTML file
+ *
+ * @example
+ * // Create an HTML file with content
+ * const page = await StaticHTMLFile("index.html",
+ *   `<!DOCTYPE html>
+ *   <html lang="en">
+ *   <head>
+ *     <meta charset="UTF-8">
+ *     <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ *     <title>My Website</title>
+ *     <link rel="stylesheet" href="styles.css">
+ *   </head>
+ *   <body>
+ *     <header>
+ *       <h1>Welcome to My Website</h1>
+ *     </header>
+ *     <main>
+ *       <p>This is the main content of the page.</p>
+ *     </main>
+ *     <footer>
+ *       <p>&copy; 2024 My Company</p>
+ *     </footer>
+ *   </body>
+ *   </html>`
+ * );
+ */
+export function StaticHTMLFile(id, ...args) {
+    const [path, content] = args.length === 1 ? [id, args[0]] : args;
+    return File(id, {
+        path,
+        content,
+    });
+}

package/lib/fs/{json-file.d.ts → static-json-file.d.ts} RENAMED Viewed

@@ -4,7 +4,7 @@ import { File } from "./file";
  *
  * @example
  * // Create a JSON configuration file
- * const config = await JsonFile("config.json", {
+ * const config = await StaticJsonFile("config.json", {
  *   api: {
  *     endpoint: "https://api.example.com",
  *     version: "v1"
@@ -12,5 +12,5 @@ import { File } from "./file";
  *   features: ["auth", "logging"]
  * });
  */
-export type JsonFile = File;
-export declare function JsonFile(id: string, content: any): Promise<JsonFile>;
+export type StaticJsonFile = File;
+export declare function StaticJsonFile(id: string, ...args: [content: any] | [path: string, content: any]): Promise<StaticJsonFile>;

package/lib/fs/static-json-file.js ADDED Viewed

@@ -0,0 +1,15 @@
+import { File } from "./file";
+export async function StaticJsonFile(id, ...args) {
+    const [path, content] = args.length === 1 ? [id, args[0]] : args;
+    const prettier = await import("prettier");
+    return File(id, {
+        path,
+        content: await prettier.format(JSON.stringify(content), {
+            parser: "json",
+            editor: {
+                tabWidth: 2,
+                indentWidth: 2,
+            },
+        }),
+    });
+}

package/lib/fs/{text-file.d.ts → static-text-file.d.ts} RENAMED Viewed

@@ -8,5 +8,5 @@ import { File } from "./file";
  *   "# Project Name\n\nProject description goes here."
  * );
  */
-export type TextFile = File;
-export declare function TextFile(id: string, content: string): Promise<TextFile>;
+export type StaticTextFile = File;
+export declare function StaticTextFile(id: string, ...args: [content: string] | [path: string, content: string]): Promise<StaticTextFile>;

package/lib/fs/static-text-file.js ADDED Viewed

@@ -0,0 +1,8 @@
+import { File } from "./file";
+export function StaticTextFile(id, ...args) {
+    const [path, content] = args.length === 1 ? [id, args[0]] : args;
+    return File(id, {
+        path,
+        content,
+    });
+}

package/lib/fs/{typescript-file.d.ts → static-typescript-file.d.ts} RENAMED Viewed

@@ -4,7 +4,7 @@ import { File } from "./file";
  *
  * @example
  * // Create a TypeScript file
- * const component = await TypeScriptFile("Component.ts", `
+ * const component = await StaticTypeScriptFile("Component.ts", `
  *   interface Props {
  *     name: string;
  *     age: number;
@@ -15,5 +15,5 @@ import { File } from "./file";
  *   }
  * `);
  */
-export type TypeScriptFile = File;
-export declare function TypeScriptFile(id: string, content: string): Promise<TypeScriptFile>;
+export type StaticTypeScriptFile = File;
+export declare function StaticTypeScriptFile(id: string, ...args: [content: string] | [path: string, content: string]): Promise<StaticTypeScriptFile>;

package/lib/fs/{typescript-file.js → static-typescript-file.js} RENAMED Viewed

@@ -1,8 +1,9 @@
 import { File } from "./file";
-export async function TypeScriptFile(id, content) {
+export async function StaticTypeScriptFile(id, ...args) {
+    const [path, content] = args.length === 1 ? [id, args[0]] : args;
     const prettier = await import("prettier");
     return File(id, {
-        path: id,
+        path,
         content: await prettier.format(content, {
             parser: "typescript",
             editor: {

package/lib/fs/static-vue-file.d.ts ADDED Viewed

@@ -0,0 +1,28 @@
+import { File } from "./file";
+export type StaticVueFile = File;
+/**
+ * Creates a static Vue component file
+ *
+ * @example
+ * // Create a Vue component file with content
+ * const button = await StaticVueFile("Button.vue",
+ *   `<template>
+ *     <button class="btn">{{ text }}</button>
+ *   </template>
+ *
+ *   <script>
+ *   export default {
+ *     props: {
+ *       text: String
+ *     }
+ *   }
+ *   </script>
+ *
+ *   <style>
+ *   .btn {
+ *     padding: 0.5rem 1rem;
+ *   }
+ *   </style>`
+ * );
+ */
+export declare function StaticVueFile(id: string, ...args: [content: string] | [path: string, content: string]): Promise<StaticVueFile>;

package/lib/fs/static-vue-file.js ADDED Viewed

@@ -0,0 +1,33 @@
+import { File } from "./file";
+/**
+ * Creates a static Vue component file
+ *
+ * @example
+ * // Create a Vue component file with content
+ * const button = await StaticVueFile("Button.vue",
+ *   `<template>
+ *     <button class="btn">{{ text }}</button>
+ *   </template>
+ *
+ *   <script>
+ *   export default {
+ *     props: {
+ *       text: String
+ *     }
+ *   }
+ *   </script>
+ *
+ *   <style>
+ *   .btn {
+ *     padding: 0.5rem 1rem;
+ *   }
+ *   </style>`
+ * );
+ */
+export function StaticVueFile(id, ...args) {
+    const [path, content] = args.length === 1 ? [id, args[0]] : args;
+    return File(id, {
+        path,
+        content,
+    });
+}

package/lib/fs/static-yaml-file.d.ts ADDED Viewed

@@ -0,0 +1,22 @@
+import { File } from "./file";
+/**
+ * Creates a YAML file with formatted content
+ *
+ * @example
+ * // Create a YAML configuration file
+ * const config = await StaticYamlFile("config.yaml", {
+ *   server: {
+ *     host: "localhost",
+ *     port: 3000
+ *   },
+ *   database: {
+ *     url: "postgresql://localhost:5432/db",
+ *     pool: {
+ *       min: 1,
+ *       max: 10
+ *     }
+ *   }
+ * });
+ */
+export type StaticYamlFile = File;
+export declare function StaticYamlFile(id: string, ...args: [content: any] | [path: string, content: any]): Promise<StaticYamlFile>;

package/lib/fs/{yaml-file.js → static-yaml-file.js} RENAMED Viewed

@@ -1,8 +1,9 @@
 import { File } from "./file";
-export async function YamlFile(id, content) {
+export async function StaticYamlFile(id, ...args) {
+    const [path, content] = args.length === 1 ? [id, args[0]] : args;
     const yaml = await import("yaml");
     return File(id, {
-        path: id,
+        path,
         content: yaml.stringify(content),
     });
 }

package/lib/internal/getting-started.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+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 ADDED Viewed

@@ -0,0 +1,87 @@
+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 ADDED Viewed

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

package/lib/internal/index.js ADDED Viewed

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

package/lib/internal/providers.d.ts ADDED Viewed

@@ -0,0 +1,27 @@
+import { Document } from "../ai";
+import { Folder } from "../fs";
+export interface DocsProps {
+    /**
+     * The output directory for the docs.
+     */
+    outDir: string | Folder;
+    /**
+     * The source directory for the docs.
+     */
+    srcDir: string;
+    /**
+     * 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 declare function AlchemyProviderDocs({ srcDir, outDir, filter, }: DocsProps): Promise<AlchemyProviderDocs>;