@stacksjs/buddy 0.70.163 → 0.70.165

package/README.md

@@ -344,7 +344,7 @@ For help, discussion about best practices, or any other conversation that would
 
 For casual chit-chat with others using this package:
 
-[Join the Stacks Discord Server](https://discord.gg/stacksjs)
+[Join the Stacks Discord Server](https://stacksjs.com/discord)
 
 ## Postcardware
 

package/dist/cli.js

@@ -38,6 +38,7 @@ async function main() {
     await applyBuddyConfig(buddy);
   } catch {}
   if (needsFullSetup) {
+    p.ensureRuntimeDirectories();
     const { loadCommands, getCommandsToLoad, markLoaded } = await import("./lazy-commands.js"), { setup } = await import("./commands/setup.js");
     setup(buddy);
     markLoaded(buddy, "setup");

package/dist/commands/ai-context.js

@@ -18,7 +18,7 @@ ${JSON.stringify(result.metrics, null, 2)}
   return { output, outputPath };
 }
 export function aiContext(buddy) {
-  buddy.command("ai:context", "Generate compact deterministic project context for coding models").option("-J, --json", "Emit the versioned machine-readable context contract", { default: !1 }).option("-o, --output [path]", "Write output to a file instead of stdout").option("--max-chars [characters]", "Maximum characters in the prompt context payload", { default: 4000 }).option("--model [model]", "Model family used for the heuristic token estimate", { default: "gpt-4o" }).example("buddy ai:context").example("buddy ai:context --json").example("buddy ai:context --json --output .stacks/ai-context.json").action((options) => {
+  buddy.command("ai:context", "Generate compact deterministic project context for coding models").option("-J, --json", "Emit the versioned machine-readable context contract", { default: !1 }).option("-o, --output [path]", "Write output to a file instead of stdout").option("--max-chars [characters]", "Maximum characters in the prompt context payload", { default: 4000 }).option("--model [model]", "Model family used for the heuristic token estimate", { default: "gpt-4o" }).example("buddy ai:context").example("buddy ai:context --json").example("buddy ai:context --json --output storage/framework/runtime/ai-context.json").action((options) => {
     const generated = generateAiContextOutput(options);
     if (generated.outputPath)
       console.log(`Wrote AI project context to ${generated.outputPath}`);

package/dist/commands/create.js

@@ -38,8 +38,8 @@ export function create(buddy) {
       log.error(result.error);
       process.exit(ExitCode.FatalError);
     }
-    await ensureEnv(path, options);
     ensureExecutableScripts(path);
+    await ensureEnv(path, options);
     await install(path, options);
     if (options.minimal)
       await stripFeatures(path);

package/dist/commands/deploy.d.ts

@@ -18,11 +18,21 @@ import type { CLI } from '@stacksjs/types';
  * ciphertext it never had a chance to decrypt (no DOTENV_PRIVATE_KEY_* in
  * that 2-key set).
  *
+ * Keys namespaced to another tenant on this box (`cloud.tenants` in
+ * `config/cloud.ts`) are dropped here, before anything is shipped. Those
+ * projects deploy from their own repositories with their own env files and
+ * never need the owner's copy — and because ts-cloud treats `site.env` as the
+ * complete `.env`, leaving them in writes one tenant's secrets into an
+ * unrelated site's `.env` on disk.
+ *
  * Returns `{}` (not an error) when the file doesn't exist or fails to
  * parse — an app with no `.env.production` yet shouldn't block deploying
  * with whatever `site.env` overrides it does have.
+ *
+ * @param environment - Which `.env.<environment>` to read.
+ * @param tsCloudConfig - The deploy target's ts-cloud config, read for `project.slug`.
  */
-export declare function resolveDeployEnvValues(environment: 'production' | 'staging' | 'development'): Promise<Record<string, string>>;
+export declare function resolveDeployEnvValues(environment: 'production' | 'staging' | 'development', tsCloudConfig?: { project?: { slug?: string } }): Promise<Record<string, string>>;
 /**
  * Merge the deploy-target's resolved env values underneath each site's own
  * explicit `env` overrides, stripping a general `PORT` when the site

package/dist/commands/deploy.js

@@ -1,6 +1,6 @@
 import { existsSync, mkdirSync, readFileSync, readdirSync, statSync, writeFileSync } from "node:fs";
 import { homedir } from "node:os";
-import { join } from "node:path";
+import { join, relative } from "node:path";
 import process from "node:process";
 import { runAction } from "@stacksjs/actions";
 import { italic, onUnknownSubcommand, outro, prompts, runCommand } from "@stacksjs/cli";
@@ -432,7 +432,15 @@ async function waitForRemoteReady(ip) {
   });
   log.success("Server is ready (bun installed)");
 }
-export async function resolveDeployEnvValues(environment) {
+async function resolveDeclaredTenants() {
+  try {
+    const { config } = await import("@stacksjs/config"), tenants = config.cloud?.tenants;
+    return Array.isArray(tenants) ? tenants.filter((slug) => typeof slug === "string") : [];
+  } catch {
+    return [];
+  }
+}
+export async function resolveDeployEnvValues(environment, tsCloudConfig) {
   const fileName = environment === "production" ? ".env.production" : environment === "staging" ? ".env.staging" : existsSync(p.projectPath(".env.development")) ? ".env.development" : ".env", filePath = p.projectPath(fileName);
   if (!existsSync(filePath))
     return {};
@@ -448,7 +456,13 @@ export async function resolveDeployEnvValues(environment) {
         continue;
       values[key] = String(value);
     }
-    return values;
+    const { foreignTenantKeys, partitionTenantEnv } = await import("@stacksjs/env"), partition = partitionTenantEnv(values, {
+      self: tsCloudConfig?.project?.slug,
+      tenants: await resolveDeclaredTenants()
+    });
+    for (const { tenant, keys } of foreignTenantKeys(partition))
+      log.warn(`[deploy] Skipping ${keys.length} '${tenant}' key(s) in ${fileName} \u2014 they belong to that tenant's own ` + `repository, and shipping them writes its secrets into this project's site .env files. Remove them with: buddy env:check --file ${fileName}. Keys: ${keys.join(", ")}`);
+    return partition.own;
   } catch (error) {
     log.debug(`[deploy] Failed to resolve ${fileName} for site env merging:`, error);
     return {};
@@ -715,7 +729,11 @@ async function runHetznerDeploy(args) {
     ".cache",
     "bin",
     "dist",
+    relative(p.projectPath(), p.stxPath()).replace(/\/$/, ""),
     ".stx",
+    relative(p.projectPath(), p.cloudStatePath()).replace(/\/$/, ""),
+    ".ts-cloud",
+    relative(p.projectPath(), p.frameworkRuntimePath()).replace(/\/$/, ""),
     "tmp",
     "temp",
     ".DS_Store",
@@ -754,7 +772,7 @@ async function runHetznerDeploy(args) {
   }
   if (docker)
     await buildContainerImageWithPantry({ slug, sites, verbose });
-  const resolvedDeployEnv = await resolveDeployEnvValues(environment), sitesWithResolvedEnv = mergeSiteDeployEnv(sites, resolvedDeployEnv);
+  const resolvedDeployEnv = await resolveDeployEnvValues(environment, tsCloudConfig), sitesWithResolvedEnv = mergeSiteDeployEnv(sites, resolvedDeployEnv);
   for (const [envKey, envValue] of Object.entries(resolvedDeployEnv))
     if (process.env[envKey] === void 0)
       process.env[envKey] = envValue;

package/dist/commands/dev.js

@@ -4,10 +4,10 @@ import readline from "node:readline";
 import process from "node:process";
 import { bold, cyan, dim, green, intro, log, onUnknownSubcommand, outro, prompts, runCommand, yellow } from "@stacksjs/cli";
 import { homedir } from "node:os";
-import { dirname, join } from "node:path";
+import { dirname, join, relative } from "node:path";
 import { fileURLToPath } from "node:url";
 import { Action } from "@stacksjs/enums";
-import { libsPath, projectPath } from "@stacksjs/path";
+import { libsPath, projectPath, stxPath } from "@stacksjs/path";
 import { ExitCode } from "@stacksjs/types";
 import { version } from "../../package.json";
 const DEV_BOOT_STARTING_LINE_COUNT = 3;
@@ -215,17 +215,32 @@ export function dev(buddy) {
   onUnknownSubcommand(buddy, "dev");
 }
 export async function startDevelopmentServer(_options, _startTime) {
-  const options = _options, startedAt = _startTime, appUrl = process.env.APP_URL ?? "stacks.localhost", nativeMode = options.native === !0, proxyManagedExternally = process.env.STACKS_PROXY_MANAGED === "1", frontendPort = Number(process.env.PORT) || 3000, apiPort = Number(process.env.PORT_API) || 3008, docsPort = Number(process.env.PORT_DOCS) || 3006, dashboardPort = Number(process.env.PORT_ADMIN) || 3002, includeDashboard = process.env.STACKS_DEV_DASHBOARD === "1", domain = resolvePrettyDevDomain(appUrl, nativeMode), appLooksCustom = domain !== null, localhostOnly = process.env.STACKS_DEV_LOCALHOST === "1", prettyUrlsRequested = appLooksCustom && !localhostOnly, systemAuthorized = !prettyUrlsRequested || proxyManagedExternally ? !0 : await canStartPrettyDevProxy(), usePrettyUrls = shouldUsePrettyDevUrls({
+  const options = _options, startedAt = _startTime, appUrl = process.env.APP_URL ?? "stacks.localhost", nativeMode = options.native === !0, proxyManagedExternally = process.env.STACKS_PROXY_MANAGED === "1", preferredFrontendPort = Number(process.env.PORT) || 3000, preferredApiPort = Number(process.env.PORT_API) || 3008, preferredDocsPort = Number(process.env.PORT_DOCS) || 3006, preferredDashboardPort = Number(process.env.PORT_ADMIN) || 3002;
+  if (process.env.STACKS_DEV_NO_KILL !== "1")
+    await cleanupStaleDevProcesses([
+      preferredFrontendPort,
+      preferredApiPort,
+      preferredDocsPort,
+      preferredDashboardPort
+    ]);
+  const portShifts = [], claimPort = async (label, preferred) => {
+    if (proxyManagedExternally)
+      return preferred;
+    const port = await findAvailablePort(preferred);
+    if (port !== preferred)
+      portShifts.push(`${label} :${preferred} \u2192 :${port}`);
+    return port;
+  }, frontendPort = await claimPort("Frontend", preferredFrontendPort), apiPort = await claimPort("API", preferredApiPort), docsPort = await claimPort("Docs", preferredDocsPort), dashboardPort = await claimPort("Dashboard", preferredDashboardPort);
+  process.env.PORT = String(frontendPort);
+  process.env.PORT_API = String(apiPort);
+  process.env.PORT_DOCS = String(docsPort);
+  process.env.PORT_ADMIN = String(dashboardPort);
+  const includeDashboard = process.env.STACKS_DEV_DASHBOARD === "1", domain = resolvePrettyDevDomain(appUrl, nativeMode), appLooksCustom = domain !== null, localhostOnly = process.env.STACKS_DEV_LOCALHOST === "1", prettyUrlsRequested = appLooksCustom && !localhostOnly, systemAuthorized = !prettyUrlsRequested || proxyManagedExternally ? !0 : await canStartPrettyDevProxy(), usePrettyUrls = shouldUsePrettyDevUrls({
     domain,
     localhostOnly,
     proxyManagedExternally,
     systemAuthorized
-  }), prettySetupRequired = prettyUrlsRequested && !usePrettyUrls, hasCustomDomain = usePrettyUrls && !proxyManagedExternally, displayedDomain = usePrettyUrls ? domain : null, dashboardDomain = displayedDomain ? `dashboard.${displayedDomain}` : null, frontendUrl = displayedDomain ? `https://${displayedDomain}` : `http://localhost:${frontendPort}`, apiUrl = displayedDomain ? `https://${displayedDomain}/api` : `http://localhost:${apiPort}`, docsUrl = displayedDomain ? `https://${displayedDomain}/docs` : `http://localhost:${docsPort}`, dashboardUrl = dashboardDomain ? `https://${dashboardDomain}` : `http://localhost:${dashboardPort}`, managedPorts = [
-    frontendPort,
-    apiPort,
-    docsPort,
-    ...includeDashboard ? [dashboardPort] : []
-  ];
+  }), prettySetupRequired = prettyUrlsRequested && !usePrettyUrls, hasCustomDomain = usePrettyUrls && !proxyManagedExternally, displayedDomain = usePrettyUrls ? domain : null, dashboardDomain = displayedDomain ? `dashboard.${displayedDomain}` : null, frontendUrl = displayedDomain ? `https://${displayedDomain}` : `http://localhost:${frontendPort}`, apiUrl = displayedDomain ? `https://${displayedDomain}/api` : `http://localhost:${apiPort}`, docsUrl = displayedDomain ? `https://${displayedDomain}/docs` : `http://localhost:${docsPort}`, dashboardUrl = dashboardDomain ? `https://${dashboardDomain}` : `http://localhost:${dashboardPort}`;
   process.env.STACKS_PROXY_MANAGED = "1";
   process.env.STACKS_DEV_QUIET = "1";
   console.log();
@@ -234,10 +249,12 @@ export async function startDevelopmentServer(_options, _startTime) {
     console.log(`  ${dim("    ")}${dim("Run `./buddy setup:ssl` once, then restart `./buddy dev`.")}`);
     console.log();
   }
+  if (portShifts.length > 0) {
+    console.log(`  ${yellow("\u26A0")}  ${yellow("Ports in use by another process")} ${dim(`- ${portShifts.join(", ")}`)}`);
+    console.log();
+  }
   console.log(`  ${bold(cyan("stacks"))} ${dim(`v${version}`)}  ${dim("starting\u2026")}`);
   console.log();
-  if (process.env.STACKS_DEV_NO_KILL !== "1")
-    await cleanupStaleDevProcesses(managedPorts);
   const rpxTlsPreflight = hasCustomDomain && domain ? prepareRpxTlsForDev({ domain, includeDashboard, options }) : Promise.resolve();
   if (localhostOnly && domain && !proxyManagedExternally)
     removeStalePublicDomainOverrides(domain, includeDashboard, options.verbose ?? !1).catch(() => {});
@@ -432,16 +449,16 @@ function printDevReadyBanner(input) {
   console.log();
 }
 function printDevEngineNotes() {
-  const routesFile = join(projectPath(), ".stx/routes.ts"), crosswindConfig = join(projectPath(), "config/crosswind.ts");
+  const routesFile = stxPath("routes.ts"), routesLabel = relative(projectPath(), routesFile), crosswindConfig = join(projectPath(), "config/crosswind.ts");
   if (existsSync(crosswindConfig) || existsSync(join(projectPath(), "crosswind.config.ts")))
     console.log(`  ${green("[Crosswind]")} ${dim("CSS engine loaded")}`);
   if (existsSync(routesFile))
     try {
       const routeCount = (readFileSync(routesFile, "utf8").match(/pattern:/g) ?? []).length;
       if (routeCount > 0)
-        console.log(`  ${green("[stx]")} ${dim(`Generated ${routeCount} routes \u2192 .stx/routes.ts`)}`);
+        console.log(`  ${green("[stx]")} ${dim(`Generated ${routeCount} routes \u2192 ${routesLabel}`)}`);
     } catch {
-      console.log(`  ${green("[stx]")} ${dim("Routes manifest \u2192 .stx/routes.ts")}`);
+      console.log(`  ${green("[stx]")} ${dim(`Routes manifest \u2192 ${routesLabel}`)}`);
     }
 }
 async function launchNativeAppWindow(url, options) {
@@ -617,6 +634,37 @@ async function probeDevServerHttp(port) {
       return !0;
   return !1;
 }
+async function findAvailablePort(preferred, attempts = 20) {
+  for (let port = preferred;port < preferred + attempts; port++)
+    if (await portIsFree(port))
+      return port;
+  return preferred;
+}
+async function portIsFree(port) {
+  for (const host of ["127.0.0.1", "::1"])
+    if (await someoneIsListening(port, host))
+      return !1;
+  let server;
+  try {
+    server = Bun.serve({ port, hostname: "0.0.0.0", reusePort: !1, fetch: () => new Response });
+  } catch {
+    return !1;
+  }
+  server.stop(!0);
+  return !0;
+}
+async function someoneIsListening(port, host) {
+  const { connect } = await import("node:net");
+  return new Promise((resolve) => {
+    const socket = connect({ port, host }), finish = (listening) => {
+      socket.destroy();
+      resolve(listening);
+    };
+    socket.setTimeout(300, () => finish(!1));
+    socket.once("connect", () => finish(!0));
+    socket.once("error", () => finish(!1));
+  });
+}
 async function waitForPort(port, timeoutMs) {
   const deadline = Date.now() + timeoutMs;
   while (Date.now() < deadline) {

package/dist/commands/docs/buddy-commands.d.ts

@@ -0,0 +1,8 @@
+import type { BuddyCommandInventoryEntry } from '../list';
+export declare function renderBuddyCommandReference(inventory: BuddyInventory): string;
+export declare function loadBuddyInventory(): BuddyInventory;
+export declare function run(): Promise<void>;
+declare interface BuddyInventory {
+  commands: BuddyCommandInventoryEntry[]
+  total: number
+}

package/dist/commands/docs/buddy-commands.js

@@ -0,0 +1,116 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, resolve } from "node:path";
+const root = resolve(import.meta.dir, "../../../../../../.."), outputPath = resolve(root, "docs/guide/buddy/commands.md"), cliPath = resolve(root, "storage/framework/core/buddy/src/cli.ts");
+function markdown(value) {
+  return String(value).replaceAll("\\", "\\\\").replaceAll("|", "\\|").replaceAll(`
+`, "<br>");
+}
+function code(value) {
+  return `\`${String(value).replaceAll("`", "\\`")}\``;
+}
+function optionFlags(option) {
+  return option.flags.map((flag) => code(`${flag.length === 1 ? "-" : "--"}${flag}`)).join(", ");
+}
+function optionKind(option) {
+  return [
+    option.boolean ? "boolean" : "value",
+    option.required ? "required" : "optional",
+    ...option.negated ? ["negated"] : []
+  ].join(", ");
+}
+function argumentSyntax(argument) {
+  const value = `${argument.name}${argument.variadic ? "..." : ""}`;
+  return code(argument.required ? `<${value}>` : `[${value}]`);
+}
+function commandSection(command) {
+  const lines = [
+    `### ${code(command.name)}`,
+    "",
+    command.description || "No description provided.",
+    "",
+    `- Usage: ${code(command.usage)}`,
+    `- Namespace: ${command.namespace ? code(command.namespace) : "none"}`,
+    `- Aliases: ${command.aliases.length ? command.aliases.map(code).join(", ") : "none"}`,
+    `- Arguments: ${command.arguments.length ? command.arguments.map(argumentSyntax).join(", ") : "none"}`
+  ];
+  if (command.options.length)
+    lines.push("", "| Option | Description | Contract | Default |", "| --- | --- | --- | --- |", ...command.options.map((option) => `| ${optionFlags(option)} | ${markdown(option.description || "\u2014")} | ${optionKind(option)} | ${option.default === void 0 ? "\u2014" : code(JSON.stringify(option.default))} |`));
+  if (command.examples.length)
+    lines.push("", "Examples:", "", "```bash", ...command.examples, "```");
+  return lines.join(`
+`);
+}
+export function renderBuddyCommandReference(inventory) {
+  const commands = [...inventory.commands].sort((a, b) => a.name.localeCompare(b.name));
+  if (inventory.total !== commands.length)
+    throw Error(`Buddy inventory total ${inventory.total} does not match ${commands.length} commands`);
+  if (new Set(commands.map((command) => command.name)).size !== commands.length)
+    throw Error("Buddy inventory contains duplicate canonical command names");
+  const groups = new Map;
+  for (const command of commands) {
+    const group = command.namespace || (command.name.includes(":") ? command.name.split(":")[0] : "general"), entries = groups.get(group) || [];
+    entries.push(command);
+    groups.set(group, entries);
+  }
+  const groupSummary = [...groups.entries()].sort(([a], [b]) => a.localeCompare(b)).map(([group, entries]) => `| ${code(group)} | ${entries.length} |`);
+  return `${[
+    "---",
+    "title: Buddy Command Reference",
+    "description: Generated reference for every Buddy command, argument, option, alias, default, and example.",
+    "---",
+    "<!-- Generated by storage/framework/core/buddy/src/commands/docs/buddy-commands.ts. Do not edit by hand. -->",
+    "",
+    "# Buddy Command Reference",
+    "",
+    `This reference is generated from Buddy's runtime command registry and currently contains **${commands.length} commands**. Run \`bun run docs:buddy\` after changing the registry; CI rejects stale output.`,
+    "",
+    "## Command groups",
+    "",
+    "| Group | Commands |",
+    "| --- | ---: |",
+    ...groupSummary,
+    "",
+    "## Commands",
+    "",
+    ...commands.flatMap((command) => [commandSection(command), ""])
+  ].join(`
+`).split(`
+`).map((line) => line.trimEnd()).join(`
+`).trimEnd()}
+`;
+}
+export function loadBuddyInventory() {
+  const result = Bun.spawnSync([process.execPath, cliPath, "list", "--json"], {
+    cwd: root,
+    env: { ...process.env, NO_COLOR: "1" },
+    stdout: "pipe",
+    stderr: "pipe"
+  });
+  if (result.exitCode !== 0)
+    throw Error(`Buddy command inventory failed (${result.exitCode}): ${result.stderr.toString().trim()}`);
+  const inventory = JSON.parse(result.stdout.toString());
+  if (!Array.isArray(inventory.commands) || !Number.isInteger(inventory.total))
+    throw Error("Buddy command inventory returned an invalid payload");
+  return inventory;
+}
+export async function run() {
+  const mode = process.argv.includes("--write") ? "write" : process.argv.includes("--check") ? "check" : null;
+  if (!mode) {
+    console.error("usage: bun storage/framework/core/buddy/src/commands/docs/buddy-commands.ts --write | --check");
+    process.exit(2);
+  }
+  const expected = renderBuddyCommandReference(loadBuddyInventory());
+  if (mode === "write") {
+    mkdirSync(dirname(outputPath), { recursive: !0 });
+    writeFileSync(outputPath, expected);
+    console.log(`Wrote ${outputPath}`);
+  } else {
+    if (!existsSync(outputPath))
+      throw Error("Buddy command reference is missing; run bun run docs:buddy");
+    if (readFileSync(outputPath, "utf8") !== expected)
+      throw Error("Buddy command reference is stale; run bun run docs:buddy");
+    console.log("Buddy command reference matches the runtime registry");
+  }
+}
+if (import.meta.main)
+  await run();

package/dist/commands/docs/buddy-commands.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/docs/buddy-commands.test.js

@@ -0,0 +1,38 @@
+import { describe, expect, it } from "bun:test";
+import { renderBuddyCommandReference } from "./buddy-commands";
+const command = {
+  name: "deploy",
+  description: "Deploy the application",
+  aliases: ["ship"],
+  usage: "$ buddy deploy [environment]",
+  arguments: [{ name: "environment", required: !1, variadic: !1 }],
+  options: [{
+    name: "region",
+    flags: ["r", "region"],
+    description: "Cloud region",
+    required: !0,
+    boolean: !1,
+    negated: !1,
+    default: "us-east-1"
+  }],
+  examples: ["buddy deploy production"]
+};
+describe("Buddy command reference", () => {
+  it("renders every command contract field", () => {
+    const result = renderBuddyCommandReference({ commands: [command], total: 1 });
+    expect(result).toContain("**1 commands**");
+    expect(result).toContain("### `deploy`");
+    expect(result).toContain("Aliases: `ship`");
+    expect(result).toContain("Arguments: `[environment]`");
+    expect(result).toContain('| `-r`, `--region` | Cloud region | value, required | `"us-east-1"` |');
+    expect(result).toContain("buddy deploy production");
+  });
+  it("sorts commands and rejects incomplete inventories", () => {
+    const about = { ...command, name: "about" }, result = renderBuddyCommandReference({ commands: [command, about], total: 2 });
+    expect(result.indexOf("### `about`")).toBeLessThan(result.indexOf("### `deploy`"));
+    expect(() => renderBuddyCommandReference({ commands: [command], total: 2 })).toThrow("does not match");
+  });
+  it("rejects duplicate canonical names", () => {
+    expect(() => renderBuddyCommandReference({ commands: [command, command], total: 2 })).toThrow("duplicate");
+  });
+});

package/dist/commands/docs/generated-artifacts.d.ts

@@ -0,0 +1,3 @@
+import { type OpenApiDocument } from '../../../../api/src/generate-types';
+export declare function validateOpenApi(document: OpenApiDocument): string[];
+export declare function run(): Promise<void>;

package/dist/commands/docs/generated-artifacts.js

@@ -0,0 +1,69 @@
+import { readFileSync, writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { generateOpenApi } from "../../../../api/src/generate-openapi";
+import { renderOpenApiTypes } from "../../../../api/src/generate-types";
+const root = resolve(import.meta.dir, "../../../../../../.."), openApiPath = resolve(root, "storage/framework/api/openapi.json"), apiTypesPath = resolve(root, "storage/framework/api/api-types.ts");
+export function validateOpenApi(document) {
+  const errors = [], paths = Object.entries(document.paths || {});
+  if (paths.length < 10)
+    errors.push("OpenAPI document has fewer than 10 registered paths");
+  const operationIds = new Set;
+  for (const [route, item] of paths)
+    for (const [method, operation] of Object.entries(item)) {
+      if (!operation.operationId)
+        errors.push(`${method.toUpperCase()} ${route}: operationId is missing`);
+      else if (operationIds.has(operation.operationId))
+        errors.push(`${method.toUpperCase()} ${route}: duplicate operationId ${operation.operationId}`);
+      else
+        operationIds.add(operation.operationId);
+      for (const parameter of operation.parameters || [])
+        if (parameter.in === "path" && !parameter.required)
+          errors.push(`${method.toUpperCase()} ${route}: path parameter ${parameter.name} must be required`);
+    }
+  return errors;
+}
+async function expectedArtifacts() {
+  const document = await generateOpenApi({ write: !1 }), errors = validateOpenApi(document);
+  if (errors.length)
+    throw Error(errors.join(`
+`));
+  return {
+    openApi: JSON.stringify(document, null, 2),
+    apiTypes: renderOpenApiTypes(document)
+  };
+}
+async function write() {
+  const expected = await expectedArtifacts();
+  writeFileSync(openApiPath, expected.openApi);
+  writeFileSync(apiTypesPath, expected.apiTypes);
+  console.log("Generated OpenAPI and API type artifacts");
+}
+async function check() {
+  const expected = await expectedArtifacts(), errors = [];
+  if (readFileSync(openApiPath, "utf8") !== expected.openApi)
+    errors.push("storage/framework/api/openapi.json is stale");
+  if (readFileSync(apiTypesPath, "utf8") !== expected.apiTypes)
+    errors.push("storage/framework/api/api-types.ts is stale");
+  if (errors.length)
+    throw Error(`${errors.join(`
+`)}
+Run bun run docs:artifacts and review the generated diff.`);
+  console.log(`Generated API artifacts are current (${Object.keys(JSON.parse(expected.openApi).paths).length} paths)`);
+}
+export async function run() {
+  try {
+    if (process.argv.includes("--write"))
+      await write();
+    else if (process.argv.includes("--check"))
+      await check();
+    else {
+      console.error("usage: bun storage/framework/core/buddy/src/commands/docs/generated-artifacts.ts --write | --check");
+      process.exit(2);
+    }
+  } catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exit(1);
+  }
+}
+if (import.meta.main)
+  await run();

package/dist/commands/docs/generated-artifacts.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/docs/generated-artifacts.test.js

@@ -0,0 +1,19 @@
+import { describe, expect, it } from "bun:test";
+import { validateOpenApi } from "./generated-artifacts";
+describe("generated API artifact validation", () => {
+  it("rejects empty, duplicate, and optional path evidence", () => {
+    expect(validateOpenApi({ paths: {} })).toContain("OpenAPI document has fewer than 10 registered paths");
+    const paths = {};
+    for (let index = 0;index < 10; index++)
+      paths[`/items/${index}/{id}`] = {
+        get: {
+          operationId: index < 2 ? "duplicate" : `get_${index}`,
+          parameters: [{ name: "id", in: "path", required: index !== 2, schema: { type: "string" } }],
+          responses: {}
+        }
+      };
+    const errors = validateOpenApi({ paths });
+    expect(errors).toContain("GET /items/1/{id}: duplicate operationId duplicate");
+    expect(errors).toContain("GET /items/2/{id}: path parameter id must be required");
+  });
+});

package/dist/commands/docs/links.d.ts

@@ -0,0 +1,18 @@
+/** True for links this checker deliberately does not resolve on disk. */
+export declare function isSkippableLink(target: string): boolean;
+/** Extract inline-link targets with 1-based line numbers, skipping code. */
+export declare function extractLinks(content: string): Array<{ target: string, line: number }>;
+/**
+ * On-disk paths a link could legitimately resolve to. Absolute (`/x`) links are
+ * rooted at `docsRoot`; relative links at the file's directory. Extensionless
+ * links also try `.md` and `index.md` (VitePress clean URLs), and `.html` links
+ * try their `.md` source.
+ */
+export declare function resolveCandidates(target: string, fileDir: string, docsRoot: string): string[];
+export declare function checkDocsLinks(docsRoot?: unknown): BrokenDocLink[];
+export declare function run(): Promise<void>;
+export declare interface BrokenDocLink {
+  file: string
+  line: number
+  target: string
+}

package/dist/commands/docs/links.js

@@ -0,0 +1,83 @@
+import { existsSync, readdirSync, readFileSync, statSync } from "node:fs";
+import { dirname, join, relative, resolve } from "node:path";
+const root = resolve(import.meta.dir, "../../../../../../.."), docsDir = resolve(root, "docs"), INLINE_LINK = /\[[^\]]*\]\(([^)]+)\)/g;
+export function isSkippableLink(target) {
+  return target === "" || target.startsWith("#") || /^[a-z][\w+.-]*:/i.test(target) || target.startsWith("//") || target.startsWith("{{") || target.includes("<");
+}
+export function extractLinks(content) {
+  const out = [], lines = content.replace(/<!--[\s\S]*?-->/g, (match) => match.replace(/[^\n]/g, " ")).split(`
+`);
+  let inFence = !1;
+  for (let index = 0;index < lines.length; index++) {
+    const raw = lines[index];
+    if (/^\s*(```|~~~)/.test(raw)) {
+      inFence = !inFence;
+      continue;
+    }
+    if (inFence)
+      continue;
+    const line = raw.replace(/`[^`]*`/g, "");
+    for (const match of line.matchAll(INLINE_LINK)) {
+      let target = match[1].trim();
+      const space = target.search(/\s/);
+      if (space !== -1)
+        target = target.slice(0, space);
+      out.push({ target, line: index + 1 });
+    }
+  }
+  return out;
+}
+export function resolveCandidates(target, fileDir, docsRoot) {
+  const clean = target.split("#")[0].split("?")[0];
+  if (!clean)
+    return [];
+  const base = clean.startsWith("/") ? join(docsRoot, clean.slice(1)) : resolve(fileDir, clean), candidates = [base];
+  if (!/\.\w+$/.test(clean))
+    candidates.push(`${base}.md`, join(base, "index.md"));
+  else if (clean.endsWith(".html"))
+    candidates.push(base.replace(/\.html$/, ".md"), join(base.replace(/\.html$/, ""), "index.md"));
+  return candidates;
+}
+function walkMarkdown(dir) {
+  const files = [];
+  for (const entry of readdirSync(dir, { withFileTypes: !0 })) {
+    const full = join(dir, entry.name);
+    if (entry.isDirectory()) {
+      if (entry.name === "node_modules" || entry.name.startsWith("."))
+        continue;
+      files.push(...walkMarkdown(full));
+    } else if (entry.name.endsWith(".md"))
+      files.push(full);
+  }
+  return files;
+}
+export function checkDocsLinks(docsRoot = docsDir) {
+  const broken = [];
+  for (const file of walkMarkdown(docsRoot)) {
+    const content = readFileSync(file, "utf8");
+    for (const { target, line } of extractLinks(content)) {
+      if (isSkippableLink(target))
+        continue;
+      const candidates = resolveCandidates(target, dirname(file), docsRoot);
+      if (candidates.length === 0)
+        continue;
+      if (!candidates.some((candidate) => existsSync(candidate) && statSync(candidate).isFile()))
+        broken.push({ file: relative(docsRoot, file), line, target });
+    }
+  }
+  return broken;
+}
+export async function run() {
+  const broken = checkDocsLinks();
+  if (broken.length === 0)
+    console.log("\u2713 All internal documentation links resolve.");
+  else {
+    console.error(`\u2717 ${broken.length} broken internal documentation link(s):`);
+    for (const link of broken)
+      console.error(`  ${link.file}:${link.line} -> ${link.target}`);
+    if (process.argv.includes("--check"))
+      process.exit(1);
+  }
+}
+if (import.meta.main)
+  await run();

package/dist/commands/docs/links.test.d.ts

@@ -0,0 +1 @@
+export {};