@codepress/design-kit 0.0.0-stage → 0.1.1

package/src/kit.d.ts

@@ -0,0 +1,81 @@
+/** Types for `@codepress/design-kit/kit`, the kit tool's functions. */
+
+/** One row of `index.json` (stories) or `routes.json` (pages). */
+export interface KitRow {
+  id: string;
+  kind?: "story" | "route";
+  title?: string;
+  component?: string;
+  file: string;
+  width?: number;
+  height?: number;
+  bytes?: number;
+  slots?: string[];
+  source_file?: string;
+  body_class?: string;
+  html_attrs?: Record<string, string>;
+  body_attrs?: Record<string, string>;
+}
+
+export interface KitManifest {
+  kit_version?: number;
+  sha?: string;
+  built_at?: string;
+  [key: string]: unknown;
+}
+
+/** A loaded kit: its folder, manifest and rows, sorted and by id. */
+export interface Kit {
+  dir: string;
+  manifest: KitManifest | null;
+  rows: KitRow[];
+  byId: Map<string, KitRow>;
+}
+
+export function loadKit(dir: string): Kit;
+
+/** Rows whose id, title, component or source file holds every word. */
+export function find(kit: Kit, query: string): KitRow[];
+
+/** Up to five candidates, closest first. */
+export function nearMatches(wanted: string, candidates: string[]): string[];
+
+/** A markup outline of at most `limit` bytes. */
+export function outline(
+  html: string,
+  limit?: number,
+): { lines: string[]; truncated: boolean };
+
+/**
+ * One self-contained page. Throws an Error whose message starts with
+ * `unknown ` (and names near matches) for an unknown frame, slot or snippet,
+ * and with `too large: ` when snippets grow the page past `maxBytes`.
+ */
+export function compose(
+  kit: Kit,
+  options: {
+    frame: string;
+    slots?: { name: string; content: string }[];
+    theme?: "light" | "dark";
+    showNew?: boolean;
+    /** Bytes of markup the page may grow to through snippets. */
+    maxBytes?: number;
+  },
+): string;
+
+/** The default `maxBytes` of `compose`: 32 MB. */
+export const COMPOSE_MAX_BYTES: number;
+
+export function sanitizeMarkup(html: string): string;
+export function sanitizeCss(css: string): string;
+
+/** Runs one command line; returns the exit code. */
+export function run(
+  argv: string[],
+  io?: { out(text: string): void; err(text: string): void },
+  env?: Record<string, string | undefined>,
+  defaultDir?: string,
+): number;
+
+/** Whether this file is the script node was started with. */
+export function isMain(moduleUrl?: string, script?: string): boolean;