yaakdoc 0.1.0 → 0.2.0

package/dist/version-Bwv0ibuY.d.ts

@@ -0,0 +1,133 @@
+import { ResolvedConfig, YaakdocConfig } from "@yaakdoc/config";
+import { ThemeDefinition } from "@yaakdoc/react/theme";
+import { PreparedDocument, YaakDocument } from "@yaakdoc/core";
+import { Assets, PageData, SiteData } from "@yaakdoc/react";
+//#region src/node/theme.d.ts
+type ResolvedTheme = {
+  name: string;
+  definition: ThemeDefinition;
+  /** Directory of the theme manifest. */
+  root: string;
+  manifest: string;
+  /** Absolute paths. */
+  entry: string;
+  client: string | null;
+  styles: string[];
+  /** Validated theme options. */
+  options: Record<string, unknown>;
+  /** Package name, when the theme comes from npm. */
+  packageName: string | null;
+  /** Files (importers) used as fallbacks when a theme dependency is not installed locally. */
+  fallbackImporters: string[];
+  highlight: {
+    light: string;
+    dark: string;
+  };
+};
+declare class ThemeError extends Error {
+  name: string;
+}
+/** Candidate package names for a theme spec: `kiseki` → `@yaakdoc/theme-kiseki`, `yaakdoc-theme-kiseki`. */
+declare function themePackageCandidates(spec: string): string[];
+/** Loads and validates a theme from a short name, package name or local path. */
+declare function resolveTheme(spec: string, options: {
+  root: string;
+  themeOptions: Record<string, unknown>;
+}): Promise<ResolvedTheme>;
+/**
+ * Validates the options of an already loaded theme definition. `resolveTheme` loads the definition
+ * from a manifest; bundled engines (the Yaak plugin) pass a definition they import themselves.
+ */
+declare function themeFromDefinition(definition: ThemeDefinition, options: {
+  /** Path of the theme manifest; `entry`, `client` and `styles` are resolved against it. */
+  manifest: string;
+  packageName?: string | null;
+  themeOptions: Record<string, unknown>;
+  fallbackImporters?: string[];
+}): ResolvedTheme;
+//#endregion
+//#region src/node/context.d.ts
+type YaakdocOptions = {
+  /** Project directory (default: `process.cwd()`). */
+  cwd?: string;
+  /** Explicit config file. */
+  configFile?: string;
+  /** Config overrides (e.g. from CLI flags). Takes precedence over the config file. */
+  overrides?: YaakdocConfig;
+  /** The Yaak export itself, instead of reading it from `export` or auto-detecting it. */
+  exportData?: unknown;
+  /** Replaces theme loading, e.g. for an engine that bundles its theme (the Yaak plugin). */
+  resolveTheme?: (spec: string, options: {
+    root: string;
+    themeOptions: Record<string, unknown>;
+  }) => ResolvedTheme | Promise<ResolvedTheme>;
+};
+type Route = {
+  /** URL path including the base, e.g. `/docs/products/`. */
+  path: string;
+  /** Output file relative to outDir, e.g. `products/index.html`. */
+  file: string;
+  page: PageData;
+};
+type Context = {
+  cwd: string;
+  root: string;
+  configFile: string | null;
+  config: ResolvedConfig;
+  /** Path of the export, or null when it was passed as `exportData`. */
+  exportPath: string | null;
+  source: YaakDocument;
+  theme: ResolvedTheme;
+  document: PreparedDocument;
+  site: SiteData;
+  routes: Route[];
+  notFound: Route;
+  /** Markdown/text outputs keyed by URL path (e.g. `/products.md`, `/llms.txt`). */
+  textFiles: Map<string, string>;
+  /** Local branding assets keyed by URL path → absolute file path. */
+  assets: Map<string, string>;
+  /** Files that trigger a full rebuild of the context when changed. */
+  watchFiles: string[];
+};
+/** Loads config, export and theme, and prepares everything needed to render the site. */
+declare function resolveContext(options?: YaakdocOptions): Promise<Context>;
+/**
+ * Maps a local asset (logo, favicon) to a public URL under `<base>_yaakdoc/`, registering it in
+ * `assets` so it's copied into the site. URLs and site-root paths that don't exist on disk (e.g.
+ * `/logo.svg` served from `public/`) are kept as is.
+ */
+declare function publicAsset(path: string | undefined, base: string, assets: Map<string, string>): string | null;
+/** Finds the route for a URL path (ignoring query/hash; `/x` matches `/x/`). */
+declare function matchRoute(context: Context, pathname: string): Route | null;
+//#endregion
+//#region src/node/site.d.ts
+/** What the SSR entry exports, in dev and in builds. */
+type RenderEntry = {
+  render: (input: {
+    document: Context["document"];
+    site: Context["site"];
+    page: Route["page"];
+    assets: Assets;
+  }) => Promise<string>;
+};
+/** Prefixes the client asset paths (relative to the output directory) with the site's base. */
+declare function withBase(assets: Assets, base: string): Assets;
+/** Refuses to empty the project directory (or a parent of it). */
+declare function assertSafeOutDir(outDir: string, root: string): void;
+/** Empties (or creates) the output directory, after checking that it's safe to. */
+declare function emptyOutDir(outDir: string, root: string): Promise<void>;
+/**
+ * Writes the site into `context.config.outDir`, next to the client assets that are already there:
+ * every route prerendered with `render`, the Markdown twins and llms.txt, branding assets and the
+ * sitemap. Returns the written files, relative to the output directory.
+ */
+declare function writeSite(context: Context, { render, assets }: {
+  render: RenderEntry["render"];
+  assets: Assets;
+}): Promise<string[]>;
+//#endregion
+//#region src/node/version.d.ts
+/** The yaakdoc version: inlined by the build, read from package.json when running from source. */
+declare const VERSION: string;
+//#endregion
+export { themePackageCandidates as _, withBase as a, Route as c, publicAsset as d, resolveContext as f, themeFromDefinition as g, resolveTheme as h, emptyOutDir as i, YaakdocOptions as l, ThemeError as m, RenderEntry as n, writeSite as o, ResolvedTheme as p, assertSafeOutDir as r, Context as s, VERSION as t, matchRoute as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yaakdoc",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Static, themable, and LLM-friendly API documentation generated from Yaak exports.",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,6 +14,11 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./static": {
+      "@yaakdoc/source": "./src/static.ts",
+      "types": "./dist/static.d.ts",
+      "default": "./dist/static.js"
+    },
     "./config.schema.json": "./config.schema.json",
     "./package.json": "./package.json"
   },
@@ -55,12 +60,12 @@
   "dependencies": {
     "@clack/prompts": "^1.8.1",
     "@shikijs/rehype": "^4.5.0",
-    "@yaakdoc/config": "^0.1.0",
-    "@yaakdoc/core": "^0.1.0",
-    "@yaakdoc/markdown": "^0.1.0",
-    "@yaakdoc/react": "^0.1.0",
-    "@yaakdoc/snippets": "^0.1.0",
-    "@yaakdoc/theme-kiseki": "^0.1.0",
+    "@yaakdoc/config": "^0.2.0",
+    "@yaakdoc/core": "^0.2.0",
+    "@yaakdoc/markdown": "^0.2.0",
+    "@yaakdoc/react": "^0.2.0",
+    "@yaakdoc/snippets": "^0.2.0",
+    "@yaakdoc/theme-kiseki": "^0.2.0",
     "citty": "^0.2.2",
     "consola": "^3.4.2",
     "jiti": "^2.7.0",