@flyingrobots/bijou 0.9.0 → 1.0.0

package/dist/ports/io.d.ts

@@ -1,21 +1,85 @@
+/** Disposable handle returned by raw-input or resize listeners. */
 export interface RawInputHandle {
+    /** Remove the listener and release resources. */
     dispose(): void;
 }
+/** Disposable handle returned by interval timers. */
 export interface TimerHandle {
+    /** Cancel the timer. */
     dispose(): void;
 }
-export interface IOPort {
+/**
+ * Minimal output-only port.
+ *
+ * Sufficient for components that only need to write to stdout
+ * (e.g. animated spinners, progress bars).
+ */
+export interface WritePort {
+    /** Write a string to the output stream (typically stdout). */
     write(data: string): void;
+}
+/**
+ * Output + line-oriented input port.
+ *
+ * Extends {@link WritePort} with `question()` for form fallback modes
+ * that collect input via readline.
+ */
+export interface QueryPort extends WritePort {
+    /** Prompt the user for a single line of text input. */
     question(prompt: string): Promise<string>;
+}
+/**
+ * Full interactive terminal port.
+ *
+ * Extends {@link QueryPort} with raw keyboard input and timers
+ * for interactive form components and animated output.
+ */
+export interface InteractivePort extends QueryPort {
+    /**
+     * Enter raw-input mode, invoking {@link onKey} for each keypress.
+     * @returns A handle whose `dispose()` restores normal input mode.
+     */
     rawInput(onKey: (key: string) => void): RawInputHandle;
-    onResize(callback: (cols: number, rows: number) => void): RawInputHandle;
+    /**
+     * Start a repeating timer.
+     * @returns A handle whose `dispose()` cancels the timer.
+     */
     setInterval(callback: () => void, ms: number): TimerHandle;
+}
+/**
+ * Filesystem access port for asset and theme loading.
+ *
+ * Used at initialization time by logo loaders and DTCG theme importers,
+ * not during interactive component rendering.
+ */
+export interface FilePort {
+    /** Read an entire file as a UTF-8 string. */
     readFile(path: string): string;
     /**
      * List directory contents. Directory names MUST include a trailing `/`
      * suffix (e.g. `"src/"`) so consumers can distinguish them from files.
      */
     readDir(path: string): string[];
+    /** Join path segments using the platform separator. */
     joinPath(...segments: string[]): string;
 }
+/**
+ * Abstract I/O port for terminal interaction and filesystem access.
+ *
+ * This is the full union of all I/O sub-ports plus `onResize()`.
+ * Most consumers should depend on the narrowest sub-port they need:
+ * {@link WritePort}, {@link QueryPort}, {@link InteractivePort}, or {@link FilePort}.
+ *
+ * @see {@link WritePort} — output only
+ * @see {@link QueryPort} — output + line input
+ * @see {@link InteractivePort} — output + line input + raw keys + timers
+ * @see {@link FilePort} — filesystem access
+ */
+export interface IOPort extends InteractivePort, FilePort {
+    /**
+     * Register a callback invoked when the terminal is resized.
+     * @returns A handle whose `dispose()` removes the listener.
+     */
+    onResize(callback: (cols: number, rows: number) => void): RawInputHandle;
+}
 //# sourceMappingURL=io.d.ts.map

package/dist/ports/io.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"io.d.ts","sourceRoot":"","sources":["../../src/ports/io.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,cAAc,CAAC;IACvD,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,cAAc,CAAC;IACzE,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3D,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;CACzC"}
+{"version":3,"file":"io.d.ts","sourceRoot":"","sources":["../../src/ports/io.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,MAAM,WAAW,cAAc;IAC7B,iDAAiD;IACjD,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,qDAAqD;AACrD,MAAM,WAAW,WAAW;IAC1B,wBAAwB;IACxB,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,8DAA8D;IAC9D,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,uDAAuD;IACvD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,cAAc,CAAC;IAEvD;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAE/B;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEhC,uDAAuD;IACvD,QAAQ,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;CACzC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,EAAE,QAAQ;IACvD;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,cAAc,CAAC;CAC1E"}

package/dist/ports/runtime.d.ts

@@ -1,8 +1,19 @@
+/**
+ * Abstract runtime environment port.
+ *
+ * Provides access to environment variables and terminal dimensions
+ * without coupling to Node.js `process` globals.
+ */
 export interface RuntimePort {
+    /** Read an environment variable. Returns `undefined` when unset. */
     env(key: string): string | undefined;
+    /** Whether stdout is connected to an interactive terminal. */
     stdoutIsTTY: boolean;
+    /** Whether stdin is connected to an interactive terminal. */
     stdinIsTTY: boolean;
+    /** Current terminal width in columns. */
     columns: number;
+    /** Current terminal height in rows. */
     rows: number;
 }
 //# sourceMappingURL=runtime.d.ts.map

package/dist/ports/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/ports/runtime.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACrC,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/ports/runtime.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,oEAAoE;IACpE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACrC,8DAA8D;IAC9D,WAAW,EAAE,OAAO,CAAC;IACrB,6DAA6D;IAC7D,UAAU,EAAE,OAAO,CAAC;IACpB,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/ports/style.d.ts

@@ -1,8 +1,22 @@
 import type { TokenValue } from '../core/theme/tokens.js';
+/**
+ * Abstract styling port for applying color and text decoration.
+ *
+ * Adapters (e.g. bijou-node/chalk) implement this to translate
+ * design-token values into terminal escape sequences.
+ */
 export interface StylePort {
+    /** Apply a resolved design-token color/modifier to text. */
     styled(token: TokenValue, text: string): string;
+    /** Apply a 24-bit RGB foreground color to text. */
     rgb(r: number, g: number, b: number, text: string): string;
+    /** Apply a hex foreground color (e.g. `"#ff00aa"`) to text. */
     hex(color: string, text: string): string;
+    /** Apply a 24-bit RGB background color to text. */
+    bgRgb(r: number, g: number, b: number, text: string): string;
+    /** Apply a hex background color (e.g. `"#ff00aa"`) to text. */
+    bgHex(color: string, text: string): string;
+    /** Apply bold weight to text. */
     bold(text: string): string;
 }
 //# sourceMappingURL=style.d.ts.map

package/dist/ports/style.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"style.d.ts","sourceRoot":"","sources":["../../src/ports/style.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAChD,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3D,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACzC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B"}
+{"version":3,"file":"style.d.ts","sourceRoot":"","sources":["../../src/ports/style.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,4DAA4D;IAC5D,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAChD,mDAAmD;IACnD,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3D,+DAA+D;IAC/D,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACzC,mDAAmD;IACnD,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7D,+DAA+D;IAC/D,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3C,iCAAiC;IACjC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyingrobots/bijou",
-  "version": "0.9.0",
+  "version": "1.0.0",
   "description": "Themed terminal components for CLIs, loggers, and scripts — graceful degradation included.",
   "type": "module",
   "sideEffects": false,