tinky 0.1.0 → 1.0.0

package/README.ja-JP.md

@@ -282,6 +282,8 @@ Tinky は複数のカラー形式をサポートしています：
 
 ## 🔧 API リファレンス
 
+完全な API ドキュメントは [API ドキュメント](./docs/api/globals.md) を参照してください。
+
 ### render(element, options?)
 
 React 要素をターミナルにレンダリングします。

package/README.md

@@ -282,6 +282,8 @@ Tinky supports multiple color formats:
 
 ## 🔧 API Reference
 
+For complete API documentation, see the [API Docs](./docs/api/globals.md).
+
 ### render(element, options?)
 
 Render a React element to the terminal.

package/README.zh-CN.md

@@ -282,6 +282,8 @@ Tinky 支持多种颜色格式：
 
 ## 🔧 API 参考
 
+完整的 API 文档请参阅 [API 文档](./docs/api/globals.md)。
+
 ### render(element, options?)
 
 将 React 元素渲染到终端。

package/lib/components/AccessibilityContext.d.ts

@@ -1,9 +1,30 @@
 /**
- * Context to manage accessibility settings, specifically screen reader support.
+ * Value type for the AccessibilityContext.
  */
-export declare const AccessibilityContext: import("react").Context<{
+export interface AccessibilityContextValue {
     /**
      * Whether the screen reader is enabled.
+     *
+     * @defaultValue false
      */
-    isScreenReaderEnabled: boolean;
-}>;
+    readonly isScreenReaderEnabled: boolean;
+}
+/**
+ * Context to manage accessibility settings, specifically screen reader.
+ *
+ * @example
+ * ```tsx
+ * import { useIsScreenReaderEnabled } from 'tinky';
+ *
+ * const Component = () => {
+ *   const isScreenReaderEnabled = useIsScreenReaderEnabled();
+ *
+ *   if (isScreenReaderEnabled) {
+ *     return <Text>Screen reader friendly output</Text>;
+ *   }
+ *
+ *   return <Text>Regular output</Text>;
+ * };
+ * ```
+ */
+export declare const AccessibilityContext: import("react").Context<AccessibilityContextValue>;

package/lib/components/AccessibilityContext.js

@@ -1,6 +1,21 @@
 import { createContext } from "react";
 /**
- * Context to manage accessibility settings, specifically screen reader support.
+ * Context to manage accessibility settings, specifically screen reader.
+ *
+ * @example
+ * ```tsx
+ * import { useIsScreenReaderEnabled } from 'tinky';
+ *
+ * const Component = () => {
+ *   const isScreenReaderEnabled = useIsScreenReaderEnabled();
+ *
+ *   if (isScreenReaderEnabled) {
+ *     return <Text>Screen reader friendly output</Text>;
+ *   }
+ *
+ *   return <Text>Regular output</Text>;
+ * };
+ * ```
  */
 export const AccessibilityContext = createContext({
     /**

package/lib/components/BackgroundContext.d.ts

@@ -2,9 +2,24 @@ import { type LiteralUnion } from "type-fest";
 import { type ForegroundColorName } from "ansi-styles";
 /**
  * Union type for background colors.
+ *
+ * Accepts any named color from `ansi-styles`, hex colors, RGB colors,
+ * or ANSI 256 color codes.
+ *
+ * @example
+ * ```tsx
+ * backgroundColor="red"                    // Named color
+ * backgroundColor="#ff6600"                // Hex color
+ * backgroundColor="rgb(255, 102, 0)"       // RGB color
+ * backgroundColor="ansi256:208"            // ANSI 256 color
+ * ```
  */
 export type BackgroundColor = LiteralUnion<ForegroundColorName, string>;
 /**
  * Context to pass the background color down the component tree.
+ *
+ * Allows nested components to inherit the background color from parents.
+ *
+ * @defaultValue undefined
  */
 export declare const backgroundContext: import("react").Context<BackgroundColor | undefined>;

package/lib/components/BackgroundContext.js

@@ -1,5 +1,9 @@
 import { createContext } from "react";
 /**
  * Context to pass the background color down the component tree.
+ *
+ * Allows nested components to inherit the background color from parents.
+ *
+ * @defaultValue undefined
  */
 export const backgroundContext = createContext(undefined);

package/lib/components/FocusContext.d.ts

@@ -8,20 +8,29 @@ export interface FocusProps {
     readonly activeId?: string;
     /**
      * Register a new focusable component.
+     *
+     * @param id - Unique identifier for the focusable component.
+     * @param options.autoFocus - Auto-focus the component when registered.
      */
     readonly add: (id: string, options: {
         autoFocus: boolean;
     }) => void;
     /**
      * Unregister a focusable component.
+     *
+     * @param id - Unique identifier of the component to unregister.
      */
     readonly remove: (id: string) => void;
     /**
-     * Mark a component as active.
+     * Mark a component as active (focused).
+     *
+     * @param id - Unique identifier of the component to activate.
      */
     readonly activate: (id: string) => void;
     /**
-     * Mark a component as inactive.
+     * Mark a component as inactive (unfocused).
+     *
+     * @param id - Unique identifier of the component to deactivate.
      */
     readonly deactivate: (id: string) => void;
     /**
@@ -42,6 +51,8 @@ export interface FocusProps {
     readonly focusPrevious: () => void;
     /**
      * Focus a specific component by ID.
+     *
+     * @param id - Unique identifier of the component to focus.
      */
     readonly focus: (id: string) => void;
 }

package/lib/dimension.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Dimensions with width and height.
+ */
+export interface Dimension {
+    /** Width in columns. */
+    width: number;
+    /** Height in rows. */
+    height: number;
+}

package/lib/dimension.js

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

package/lib/dom.d.ts

@@ -4,10 +4,14 @@ import { TaffyNode } from "./taffy-node.js";
 /**
  * Interface representing a node in the Tinky tree.
  */
-interface TinkyNode {
+export interface TinkyNode {
+    /** Parent DOM element in the tree. */
     parentNode: DOMElement | undefined;
+    /** Taffy layout node for computing dimensions. */
     taffyNode?: TaffyNode;
+    /** Whether this node is inside a Static component. */
     internal_static?: boolean;
+    /** Styles applied to this node. */
     style: Styles;
 }
 /**
@@ -26,35 +30,58 @@ export type NodeNames = ElementNames | TextName;
  * Interface representing a DOM element in Tinky.
  */
 export type DOMElement = {
+    /** Name of the element type. */
     nodeName: ElementNames;
+    /** Key-value pairs of element attributes. */
     attributes: Record<string, DOMNodeAttribute>;
+    /** Array of child nodes. */
     childNodes: DOMNode[];
+    /** Function to transform the output of this element. */
     internal_transform?: OutputTransformer;
+    /** Accessibility attributes for screen readers. */
     internal_accessibility?: {
+        /** ARIA role for the element. */
         role?: "button" | "checkbox" | "combobox" | "list" | "listbox" | "listitem" | "menu" | "menuitem" | "option" | "progressbar" | "radio" | "radiogroup" | "tab" | "tablist" | "table" | "textbox" | "timer" | "toolbar";
+        /** ARIA state values for the element. */
         state?: {
+            /** Whether the element is busy. */
             busy?: boolean;
+            /** Whether the element is checked. */
             checked?: boolean;
+            /** Whether the element is disabled. */
             disabled?: boolean;
+            /** Whether the element is expanded. */
             expanded?: boolean;
+            /** Whether the element accepts multiline input. */
             multiline?: boolean;
+            /** Whether multiple items can be selected. */
             multiselectable?: boolean;
+            /** Whether the element is read-only. */
             readonly?: boolean;
+            /** Whether the element is required. */
             required?: boolean;
+            /** Whether the element is selected. */
             selected?: boolean;
         };
     };
+    /** Whether static nodes need to be re-rendered. */
     isStaticDirty?: boolean;
+    /** Reference to the Static component node. */
     staticNode?: DOMElement;
+    /** Callback to compute layout before rendering. */
     onComputeLayout?: () => void;
+    /** Callback to trigger a render. */
     onRender?: () => void;
+    /** Callback to trigger an immediate render. */
     onImmediateRender?: () => void;
 } & TinkyNode;
 /**
  * Interface representing a text node in Tinky.
  */
 export type TextNode = {
+    /** Text node identifier. */
     nodeName: TextName;
+    /** Text content of the node. */
     nodeValue: string;
 } & TinkyNode;
 /**
@@ -127,4 +154,3 @@ export declare const createTextNode: (text: string) => TextNode;
  * @param text - The new text value.
  */
 export declare const setTextNodeValue: (node: TextNode, text: string) => void;
-export {};

package/lib/hooks/use-app.d.ts

@@ -21,6 +21,6 @@
  * render(<Component />);
  * ```
  *
- * @returns The app context containing the exit function.
+ * @returns The app context containing the `exit` function.
  */
 export declare const useApp: () => import("../index.js").AppProps;

package/lib/hooks/use-app.js

@@ -23,6 +23,6 @@ import { AppContext } from "../components/AppContext.js";
  * render(<Component />);
  * ```
  *
- * @returns The app context containing the exit function.
+ * @returns The app context containing the `exit` function.
  */
 export const useApp = () => useContext(AppContext);

package/lib/hooks/use-focus-manager.d.ts

@@ -1,8 +1,8 @@
 import { type FocusProps } from "../components/FocusContext.js";
 /**
- * Output of the useFocusManager hook.
+ * Focus management control methods.
  */
-interface Output {
+export interface FocusManager {
     /**
      * Enable focus management for all components.
      */
@@ -36,5 +36,4 @@ interface Output {
  *
  * @returns Object containing focus management functions.
  */
-export declare const useFocusManager: () => Output;
-export {};
+export declare const useFocusManager: () => FocusManager;

package/lib/hooks/use-focus.d.ts

@@ -1,7 +1,7 @@
 /**
  * Options for the useFocus hook.
  */
-interface Input {
+export interface FocusOptions {
     /**
      * Enable or disable this component's focus, while still maintaining its
      * position in the list of focusable components.
@@ -23,9 +23,9 @@ interface Input {
     id?: string;
 }
 /**
- * Output of the useFocus hook.
+ * Focus state and control methods.
  */
-interface Output {
+export interface FocusState {
     /**
      * Determines whether this component is focused.
      */
@@ -63,5 +63,4 @@ interface Output {
  * @param options - Configuration options.
  * @returns Focus state and control methods.
  */
-export declare const useFocus: ({ isActive, autoFocus, id: customId, }?: Input) => Output;
-export {};
+export declare const useFocus: ({ isActive, autoFocus, id: customId, }?: FocusOptions) => FocusState;

package/lib/hooks/use-input.d.ts

@@ -70,11 +70,11 @@ export interface Key {
 /**
  * Handler function for input events.
  */
-type Handler = (input: string, key: Key) => void;
+export type InputHandler = (input: string, key: Key) => void;
 /**
  * Options for useInput hook.
  */
-interface Options {
+export interface InputOptions {
     /**
      * Enable or disable capturing of user input. Useful when there are
      * multiple `useInput` hooks used at once to avoid handling same input.
@@ -114,5 +114,4 @@ interface Options {
  * @param inputHandler - The function to call when input is received.
  * @param options - Configuration options.
  */
-export declare const useInput: (inputHandler: Handler, options?: Options) => void;
-export {};
+export declare const useInput: (inputHandler: InputHandler, options?: InputOptions) => void;

package/lib/hooks/use-stdout.d.ts

@@ -3,5 +3,21 @@
  * renders your app.
  *
  * @returns The stdout context.
+ * @returns {NodeJS.WriteStream} stdout.stdout - Stdout stream passed to
+ *   `render()` in `options.stdout` or `process.stdout` by default.
+ * @returns {function(data: string): void} stdout.write - Write any string to
+ *   stdout while preserving Tinky's output. Similar to `<Static>`, but only
+ *   works with strings.
  */
-export declare const useStdout: () => import("../index.js").StdoutProps;
+export declare const useStdout: () => {
+    /**
+     * Stdout stream passed to `render()` in `options.stdout` or `process.stdout`
+     * by default.
+     */
+    readonly stdout: NodeJS.WriteStream;
+    /**
+     * Write any string to stdout while preserving Tinky's output. Similar to
+     * `<Static>`, but only works with strings.
+     */
+    readonly write: (data: string) => void;
+};

package/lib/hooks/use-stdout.js

@@ -5,5 +5,10 @@ import { StdoutContext } from "../components/StdoutContext.js";
  * renders your app.
  *
  * @returns The stdout context.
+ * @returns {NodeJS.WriteStream} stdout.stdout - Stdout stream passed to
+ *   `render()` in `options.stdout` or `process.stdout` by default.
+ * @returns {function(data: string): void} stdout.write - Write any string to
+ *   stdout while preserving Tinky's output. Similar to `<Static>`, but only
+ *   works with strings.
  */
 export const useStdout = () => useContext(StdoutContext);

package/lib/index.d.ts

@@ -1,5 +1,4 @@
-export { type RenderOptions, type Instance } from "./render.js";
-export { render } from "./render.js";
+export { render, type RenderOptions, type Instance } from "./render.js";
 export { Box, type BoxProps } from "./components/Box.js";
 export { Text, type TextProps } from "./components/Text.js";
 export { AppContext, type AppProps } from "./components/AppContext.js";
@@ -10,13 +9,18 @@ export { Static, type StaticProps } from "./components/Static.js";
 export { Transform, type TransformProps } from "./components/Transform.js";
 export { Newline, type NewlineProps } from "./components/Newline.js";
 export { Spacer } from "./components/Spacer.js";
-export { useInput, type Key } from "./hooks/use-input.js";
+export { useInput, type InputHandler, type InputOptions, type Key, } from "./hooks/use-input.js";
 export { useApp } from "./hooks/use-app.js";
 export { useStdin } from "./hooks/use-stdin.js";
 export { useStdout } from "./hooks/use-stdout.js";
 export { useStderr } from "./hooks/use-stderr.js";
-export { useFocus } from "./hooks/use-focus.js";
-export { useFocusManager } from "./hooks/use-focus-manager.js";
+export { useFocus, type FocusOptions, type FocusState, } from "./hooks/use-focus.js";
+export { useFocusManager, type FocusManager, } from "./hooks/use-focus-manager.js";
 export { useIsScreenReaderEnabled } from "./hooks/use-is-screen-reader-enabled.js";
 export { measureElement } from "./measure-element.js";
-export { type DOMElement } from "./dom.js";
+export { type Dimension } from "./dimension.js";
+export { type DOMElement, type DOMNode, type DOMNodeAttribute, type ElementNames, type NodeNames, type TextName, type TextNode, type TinkyNode, } from "./dom.js";
+export { type Styles } from "./styles.js";
+export { type OutputTransformer } from "./render-node-to-output.js";
+export { type RenderMetrics } from "./tinky.js";
+export { type TaffyNode } from "./taffy-node.js";

package/lib/index.js

@@ -9,12 +9,12 @@ export { Static } from "./components/Static.js";
 export { Transform } from "./components/Transform.js";
 export { Newline } from "./components/Newline.js";
 export { Spacer } from "./components/Spacer.js";
-export { useInput } from "./hooks/use-input.js";
+export { useInput, } from "./hooks/use-input.js";
 export { useApp } from "./hooks/use-app.js";
 export { useStdin } from "./hooks/use-stdin.js";
 export { useStdout } from "./hooks/use-stdout.js";
 export { useStderr } from "./hooks/use-stderr.js";
-export { useFocus } from "./hooks/use-focus.js";
-export { useFocusManager } from "./hooks/use-focus-manager.js";
+export { useFocus, } from "./hooks/use-focus.js";
+export { useFocusManager, } from "./hooks/use-focus-manager.js";
 export { useIsScreenReaderEnabled } from "./hooks/use-is-screen-reader-enabled.js";
 export { measureElement } from "./measure-element.js";

package/lib/measure-element.d.ts

@@ -1,19 +1,9 @@
 import { type DOMElement } from "./dom.js";
-interface Output {
-    /**
-     * Element width.
-     */
-    width: number;
-    /**
-     * Element height.
-     */
-    height: number;
-}
+import { type Dimension } from "./dimension.js";
 /**
  * Measure the dimensions of a particular `<Box>` element.
  *
  * @param node - The DOM element to measure.
  * @returns The measured dimensions.
  */
-export declare const measureElement: (node: DOMElement) => Output;
-export {};
+export declare const measureElement: (node: DOMElement) => Dimension;

package/lib/measure-text.d.ts

@@ -1,7 +1,4 @@
-interface Output {
-    width: number;
-    height: number;
-}
+import { type Dimension } from "./dimension.js";
 /**
  * Measures the width and height of a text string.
  * Results are cached to improve performance.
@@ -9,5 +6,4 @@ interface Output {
  * @param text - The text string to measure.
  * @returns The width and height of the text.
  */
-export declare const measureText: (text: string) => Output;
-export {};
+export declare const measureText: (text: string) => Dimension;

package/lib/output.d.ts

@@ -1,24 +1,16 @@
 import { type OutputTransformer } from "./render-node-to-output.js";
-/**
- * Options for creating an Output instance.
- */
-interface Options {
-    /**
-     * Width of the output area.
-     */
-    width: number;
-    /**
-     * Height of the output area.
-     */
-    height: number;
-}
+import { type Dimension } from "./dimension.js";
 /**
  * Represents a clipping rectangle.
  */
 interface Clip {
+    /** Left boundary (undefined for no limit). */
     x1: number | undefined;
+    /** Right boundary (undefined for no limit). */
     x2: number | undefined;
+    /** Top boundary (undefined for no limit). */
     y1: number | undefined;
+    /** Bottom boundary (undefined for no limit). */
     y2: number | undefined;
 }
 /**
@@ -36,9 +28,9 @@ export declare class Output {
     /**
      * Creates a new Output instance.
      *
-     * @param options - Configuration options containing width and height.
+     * @param dimension - Dimensions containing width and height.
      */
-    constructor(options: Options);
+    constructor(dimension: Dimension);
     /**
      * Writes text to the output at a specified position.
      *

package/lib/output.js

@@ -17,10 +17,10 @@ export class Output {
     /**
      * Creates a new Output instance.
      *
-     * @param options - Configuration options containing width and height.
+     * @param dimension - Dimensions containing width and height.
      */
-    constructor(options) {
-        const { width, height } = options;
+    constructor(dimension) {
+        const { width, height } = dimension;
         this.width = width;
         this.height = height;
     }

package/lib/parse-keypress.d.ts

@@ -1,13 +1,24 @@
 import { Buffer } from "node:buffer";
 export declare const nonAlphanumericKeys: string[];
+/**
+ * Represents a parsed key press with modifier states.
+ */
 interface ParsedKey {
+    /** Name of the key (e.g., "enter", "escape", "a"). */
     name: string;
+    /** Whether the Ctrl modifier key was pressed. */
     ctrl: boolean;
+    /** Whether the Meta (Option/Command) modifier key was pressed. */
     meta: boolean;
+    /** Whether the Shift modifier key was pressed. */
     shift: boolean;
+    /** Whether the Option modifier key was pressed. */
     option: boolean;
+    /** Full key sequence including escape codes. */
     sequence: string;
+    /** Raw input string before parsing. */
     raw: string | undefined;
+    /** Internal key code for special keys. */
     code?: string;
 }
 /**

package/lib/reconciler.js

@@ -4,7 +4,7 @@ import { DefaultEventPriority, NoEventPriority, } from "react-reconciler/constan
 import { Display } from "taffy-layout";
 import { createContext } from "react";
 import { createTextNode, appendChildNode, insertBeforeNode, removeChildNode, setStyle, setTextNodeValue, createNode, setAttribute, } from "./dom.js";
-import { styles } from "./styles.js";
+import { applyStyles } from "./styles.js";
 // We need to conditionally perform devtools connection to avoid
 // accidentally breaking other third-party code.
 if (process.env["DEV"] === "true") {
@@ -54,10 +54,19 @@ const diff = (before, after) => {
     }
     return isChanged ? changed : undefined;
 };
+/**
+ * Cleans up a Taffy node by freeing its resources.
+ *
+ * @param node - The Taffy node to cleanup.
+ */
 const cleanupTaffyNode = (node) => {
     node?.free();
 };
 let currentUpdatePriority = NoEventPriority;
+/**
+ * Reference to the current root DOM element during rendering.
+ * Used to track static node state across renders.
+ */
 let currentRootNode;
 /**
  * React reconciler implementation for Tinky.
@@ -113,7 +122,7 @@ export const reconciler = createReconciler({
             if (key === "style") {
                 setStyle(node, value);
                 if (node.taffyNode) {
-                    styles(node.taffyNode, value);
+                    applyStyles(node.taffyNode, value);
                 }
                 continue;
             }
@@ -224,7 +233,7 @@ export const reconciler = createReconciler({
             }
         }
         if (style && node.taffyNode) {
-            styles(node.taffyNode, style);
+            applyStyles(node.taffyNode, style);
         }
     },
     commitTextUpdate(node, _oldText, newText) {

package/lib/render.d.ts

@@ -23,7 +23,8 @@ export interface RenderOptions {
      */
     stderr?: NodeJS.WriteStream;
     /**
-     * If true, each update will be rendered as separate output, without replacing.
+     * If true, each update will be rendered as separate output, without
+     * replacing.
      *
      * @defaultValue false
      */
@@ -63,7 +64,8 @@ export interface RenderOptions {
     maxFps?: number;
     /**
      * Enable incremental rendering mode which only updates changed lines instead
-     * of redrawing the entire output. Reduces flickering and improves performance.
+     * of redrawing the entire output. Reduces flickering and improves
+     * performance.
      *
      * @defaultValue false
      */

package/lib/styles.d.ts

@@ -399,4 +399,4 @@ export interface Styles {
      */
     readonly gridTemplateAreas?: GridTemplateArea[];
 }
-export declare const styles: (node: TaffyNode, style?: Styles) => void;
+export declare const applyStyles: (node: TaffyNode, style?: Styles) => void;

package/lib/styles.js

@@ -617,7 +617,7 @@ const applyGridStyles = (taffyStyle, style) => {
         }
     }
 };
-export const styles = (node, style = {}) => {
+export const applyStyles = (node, style = {}) => {
     const taffyStyle = node.tree.getStyle(node.id);
     applyPositionStyles(taffyStyle, style);
     applyMarginStyles(taffyStyle, style);

package/lib/taffy-node.d.ts

@@ -35,5 +35,10 @@ export declare class TaffyNode {
      * Necessary to prevent memory leaks as Taffy nodes aren't GC'd automatically.
      */
     free(): void;
+    /**
+     * Recursively removes a node and all its descendants from the Taffy tree.
+     *
+     * @param id - The ID of the node to remove.
+     */
     private freeRecursive;
 }

package/lib/taffy-node.js

@@ -51,6 +51,11 @@ export class TaffyNode {
         }
         this.tree.remove(this.id);
     }
+    /**
+     * Recursively removes a node and all its descendants from the Taffy tree.
+     *
+     * @param id - The ID of the node to remove.
+     */
     freeRecursive(id) {
         for (const childId of this.tree.children(id)) {
             this.freeRecursive(childId);

package/lib/tinky.d.ts

@@ -68,19 +68,33 @@ export interface Options {
  * lifecycle, and terminal output.
  */
 export declare class Tinky {
+    /** Configuration options for this instance. */
     private readonly options;
+    /** Log update instance for output. */
     private readonly log;
+    /** Throttled log update instance for output. */
     private readonly throttledLog;
+    /** Whether screen reader support is enabled. */
     private readonly isScreenReaderEnabled;
+    /** Whether the app has been unmounted. */
     private isUnmounted;
+    /** Last output string that was rendered. */
     private lastOutput;
+    /** Height of the last output in lines. */
     private lastOutputHeight;
+    /** Width of the terminal at last render. */
     private lastTerminalWidth;
+    /** React reconciler container. */
     private readonly container;
+    /** Root DOM element for the React tree. */
     private readonly rootNode;
+    /** Full static output for debug mode. */
     private fullStaticOutput;
+    /** Promise that resolves when the app exits. */
     private exitPromise?;
+    /** Function to restore console after patching. */
     private restoreConsole?;
+    /** Function to unsubscribe from resize events. */
     private readonly unsubscribeResize?;
     /**
      * Creates an instance of Tinky.
@@ -99,9 +113,13 @@ export declare class Tinky {
      * Clears the screen when width decreases to prevent overlapping re-renders.
      */
     resized: () => void;
+    /** Resolves the exit promise when the app unmounts. */
     resolveExitPromise: () => void;
+    /** Rejects the exit promise with an error. */
     rejectExitPromise: (reason?: Error) => void;
+    /** Unsubscribes from the exit event. */
     unsubscribeExit: () => void;
+    /** Error that occurred during rendering, if any. */
     renderError: Error | null;
     /**
      * Calculates the layout of the UI (TaffyLayout).

package/lib/tinky.js

@@ -23,24 +23,33 @@ const noop = () => {
  * lifecycle, and terminal output.
  */
 export class Tinky {
+    /** Configuration options for this instance. */
     options;
+    /** Log update instance for output. */
     log;
+    /** Throttled log update instance for output. */
     throttledLog;
+    /** Whether screen reader support is enabled. */
     isScreenReaderEnabled;
-    // Ignore last render after unmounting a tree to prevent empty output before
-    // exit
+    /** Whether the app has been unmounted. */
     isUnmounted;
+    /** Last output string that was rendered. */
     lastOutput;
+    /** Height of the last output in lines. */
     lastOutputHeight;
+    /** Width of the terminal at last render. */
     lastTerminalWidth;
+    /** React reconciler container. */
     container;
+    /** Root DOM element for the React tree. */
     rootNode;
-    // This variable is used only in debug mode to store full static output so
-    // that it's rerendered every time, not just new static parts, like in
-    // non-debug mode
+    /** Full static output for debug mode. */
     fullStaticOutput;
+    /** Promise that resolves when the app exits. */
     exitPromise;
+    /** Function to restore console after patching. */
     restoreConsole;
+    /** Function to unsubscribe from resize events. */
     unsubscribeResize;
     /**
      * Creates an instance of Tinky.
@@ -134,10 +143,13 @@ export class Tinky {
         this.onRender();
         this.lastTerminalWidth = currentWidth;
     };
+    /** Resolves the exit promise when the app unmounts. */
     resolveExitPromise = noop;
+    /** Rejects the exit promise with an error. */
     rejectExitPromise = noop;
+    /** Unsubscribes from the exit event. */
     unsubscribeExit = noop;
-    // Track whether an error occurred during rendering
+    /** Error that occurred during rendering, if any. */
     renderError = null;
     /**
      * Calculates the layout of the UI (TaffyLayout).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tinky",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "React for CLIs, re-imagined with the Taffy engine",
   "keywords": [
     "react",
@@ -26,39 +26,53 @@
   },
   "type": "module",
   "main": "./lib/index.js",
+  "files": [
+    "./bin/*",
+    "./lib/*"
+  ],
   "scripts": {
     "test": "bun test",
-    "build": "tsc",
+    "build": "tsc && npm run docs",
     "lint": "tslint -c tslint.json src/**/*.ts",
     "prepublish": "npm run build",
-    "prepare": "husky"
+    "prepare": "husky",
+    "docs": "typedoc --plugin typedoc-plugin-markdown --disableSources --out docs/api && prettier --write docs/api"
   },
   "dependencies": {
     "@alcalzone/ansi-tokenize": "^0.2.3",
+    "ansi-escapes": "^7.2.0",
     "ansi-styles": "^6.2.3",
     "auto-bind": "^5.0.1",
     "chalk": "^5.6.2",
     "cli-boxes": "^4.0.1",
+    "cli-cursor": "^5.0.0",
+    "cli-truncate": "^5.1.1",
     "code-excerpt": "^4.0.0",
     "es-toolkit": "^1.43.0",
     "indent-string": "^5.0.0",
     "is-in-ci": "^2.0.0",
     "patch-console": "^2.0.0",
     "react-reconciler": "^0.33.0",
+    "signal-exit": "^4.1.0",
     "stack-utils": "^2.0.6",
     "taffy-layout": "^0.1.0",
     "tslint": "^5.20.1",
     "type-fest": "^5.4.1",
-    "widest-line": "^5.0.0"
+    "widest-line": "^5.0.0",
+    "wrap-ansi": "^9.0.2"
+  },
+  "peerDependencies": {
+    "@types/react": ">=19.0.0",
+    "react": ">=19.0.0",
+    "react-devtools-core": ">=7.0.0"
   },
-  "files": [
-    "./bin/*",
-    "./lib/*"
-  ],
   "typings": "./lib/index.d.ts",
   "devDependencies": {
     "@commitlint/cli": "^20.3.0",
     "@commitlint/config-conventional": "^20.3.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^13.1.3",
     "@sinonjs/fake-timers": "^15.1.0",
     "@types/bun": "^1.3.6",
     "@types/react-reconciler": "^0.32.3",
@@ -73,7 +87,10 @@
     "jiti": "^2.6.1",
     "lint-staged": "^16.2.7",
     "prettier": "^3.7.4",
+    "semantic-release": "^25.0.2",
     "sinon": "^21.0.1",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript-eslint": "^8.53.0"
   },
   "commitlint": {