tinky-table 0.1.0

package/lib/utils/border.js

@@ -0,0 +1,190 @@
+"use strict";
+/**
+ * @fileoverview Border character mappings for different table styles.
+ * @module tinky-table/utils/border
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBorderChars = getBorderChars;
+exports.renderSeparator = renderSeparator;
+/**
+ * Border characters for the 'single' style (thin lines).
+ */
+var SINGLE_BORDER = {
+    top: "─",
+    bottom: "─",
+    left: "│",
+    right: "│",
+    topLeft: "┌",
+    topRight: "┐",
+    bottomLeft: "└",
+    bottomRight: "┘",
+    cross: "┼",
+    topCross: "┬",
+    bottomCross: "┴",
+    leftCross: "├",
+    rightCross: "┤",
+    horizontal: "─",
+    vertical: "│",
+};
+/**
+ * Border characters for the 'double' style (double lines).
+ */
+var DOUBLE_BORDER = {
+    top: "═",
+    bottom: "═",
+    left: "║",
+    right: "║",
+    topLeft: "╔",
+    topRight: "╗",
+    bottomLeft: "╚",
+    bottomRight: "╝",
+    cross: "╬",
+    topCross: "╦",
+    bottomCross: "╩",
+    leftCross: "╠",
+    rightCross: "╣",
+    horizontal: "═",
+    vertical: "║",
+};
+/**
+ * Border characters for the 'round' style (rounded corners).
+ */
+var ROUND_BORDER = {
+    top: "─",
+    bottom: "─",
+    left: "│",
+    right: "│",
+    topLeft: "╭",
+    topRight: "╮",
+    bottomLeft: "╰",
+    bottomRight: "╯",
+    cross: "┼",
+    topCross: "┬",
+    bottomCross: "┴",
+    leftCross: "├",
+    rightCross: "┤",
+    horizontal: "─",
+    vertical: "│",
+};
+/**
+ * Border characters for the 'bold' style (thick lines).
+ */
+var BOLD_BORDER = {
+    top: "━",
+    bottom: "━",
+    left: "┃",
+    right: "┃",
+    topLeft: "┏",
+    topRight: "┓",
+    bottomLeft: "┗",
+    bottomRight: "┛",
+    cross: "╋",
+    topCross: "┳",
+    bottomCross: "┻",
+    leftCross: "┣",
+    rightCross: "┫",
+    horizontal: "━",
+    vertical: "┃",
+};
+/**
+ * Border characters for the 'classic' style (ASCII only).
+ */
+var CLASSIC_BORDER = {
+    top: "-",
+    bottom: "-",
+    left: "|",
+    right: "|",
+    topLeft: "+",
+    topRight: "+",
+    bottomLeft: "+",
+    bottomRight: "+",
+    cross: "+",
+    topCross: "+",
+    bottomCross: "+",
+    leftCross: "+",
+    rightCross: "+",
+    horizontal: "-",
+    vertical: "|",
+};
+/**
+ * Empty border (no visible border characters).
+ */
+var NO_BORDER = {
+    top: " ",
+    bottom: " ",
+    left: " ",
+    right: " ",
+    topLeft: " ",
+    topRight: " ",
+    bottomLeft: " ",
+    bottomRight: " ",
+    cross: " ",
+    topCross: " ",
+    bottomCross: " ",
+    leftCross: " ",
+    rightCross: " ",
+    horizontal: " ",
+    vertical: " ",
+};
+/**
+ * Map of border styles to their character sets.
+ */
+var BORDER_STYLES = {
+    single: SINGLE_BORDER,
+    double: DOUBLE_BORDER,
+    round: ROUND_BORDER,
+    bold: BOLD_BORDER,
+    singleDouble: SINGLE_BORDER, // Use single for now
+    doubleSingle: DOUBLE_BORDER, // Use double for now
+    classic: CLASSIC_BORDER,
+    none: NO_BORDER,
+};
+/**
+ * Gets the border characters for a given table border style.
+ *
+ * @param style - The border style name
+ * @returns The corresponding border character set
+ *
+ * @example
+ * ```ts
+ * const chars = getBorderChars('single');
+ * console.log(chars.topLeft); // '┌'
+ * ```
+ */
+function getBorderChars(style) {
+    var _a;
+    return (_a = BORDER_STYLES[style]) !== null && _a !== void 0 ? _a : SINGLE_BORDER;
+}
+/**
+ * Renders a horizontal separator line for the table.
+ *
+ * @param columnWidths - Array of column widths
+ * @param chars - Border character set
+ * @param position - Position of the separator ('top' | 'middle' | 'bottom')
+ * @returns The formatted separator string
+ *
+ * @example
+ * ```ts
+ * const sep = renderSeparator([10, 15, 8], chars, 'top');
+ * // Returns: '┌──────────┬───────────────┬────────┐'
+ * ```
+ */
+function renderSeparator(columnWidths, chars, position) {
+    var leftChar = position === "top"
+        ? chars.topLeft
+        : position === "bottom"
+            ? chars.bottomLeft
+            : chars.leftCross;
+    var rightChar = position === "top"
+        ? chars.topRight
+        : position === "bottom"
+            ? chars.bottomRight
+            : chars.rightCross;
+    var crossChar = position === "top"
+        ? chars.topCross
+        : position === "bottom"
+            ? chars.bottomCross
+            : chars.cross;
+    var segments = columnWidths.map(function (width) { return chars.horizontal.repeat(width); });
+    return leftChar + segments.join(crossChar) + rightChar;
+}

package/lib/utils/column-width.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview Column width utilities for tinky-table.
+ * @module tinky-table/utils/column-width
+ *
+ * Provides utilities for converting column definitions to grid template format.
+ */
+import { type ColumnDef, type RowData } from "../types.js";
+/**
+ * Grid template value type compatible with tinky's gridTemplateColumns.
+ * Uses taffy-layout's TrackSizingFunction format.
+ */
+export type GridTemplateValue = number | {
+    min: number | "auto";
+    max: number | `${number}fr` | "auto";
+};
+/**
+ * Converts column width definitions to grid template format.
+ *
+ * Maps ColumnDef widths to taffy-layout's GridTemplateComponent:
+ * - `number` → fixed size
+ * - `'auto'` → fr(1) (flexible)
+ * - `'${number}%'` → percentage as fr units
+ *
+ * @template T - Row data type
+ * @param columns - Column definitions
+ * @returns Array of values for use with gridTemplateColumns
+ *
+ * @example
+ * ```ts
+ * const template = columnsToGridTemplate([
+ *   { key: 'name', width: 20 },
+ *   { key: 'email', width: 'auto' },
+ *   { key: 'age', width: 10 }
+ * ]);
+ * // Returns: [20, fr(1), 10]
+ * ```
+ */
+export declare function columnsToGridTemplate<T extends RowData>(columns: ColumnDef<T>[]): GridTemplateValue[];

package/lib/utils/column-width.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * @fileoverview Column width utilities for tinky-table.
+ * @module tinky-table/utils/column-width
+ *
+ * Provides utilities for converting column definitions to grid template format.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.columnsToGridTemplate = columnsToGridTemplate;
+/**
+ * Creates a fractional unit value for grid templates.
+ *
+ * @param value - The fr value (e.g., 1 for 1fr)
+ * @returns A TrackSizingFunction object
+ */
+function fr(value) {
+    return { min: "auto", max: "".concat(value, "fr") };
+}
+/**
+ * Converts column width definitions to grid template format.
+ *
+ * Maps ColumnDef widths to taffy-layout's GridTemplateComponent:
+ * - `number` → fixed size
+ * - `'auto'` → fr(1) (flexible)
+ * - `'${number}%'` → percentage as fr units
+ *
+ * @template T - Row data type
+ * @param columns - Column definitions
+ * @returns Array of values for use with gridTemplateColumns
+ *
+ * @example
+ * ```ts
+ * const template = columnsToGridTemplate([
+ *   { key: 'name', width: 20 },
+ *   { key: 'email', width: 'auto' },
+ *   { key: 'age', width: 10 }
+ * ]);
+ * // Returns: [20, fr(1), 10]
+ * ```
+ */
+function columnsToGridTemplate(columns) {
+    return columns.map(function (col) {
+        var _a;
+        var width = (_a = col.width) !== null && _a !== void 0 ? _a : "auto";
+        if (typeof width === "number") {
+            return width;
+        }
+        if (width === "auto") {
+            // Use fr(1) for flexible columns
+            return fr(1);
+        }
+        if (typeof width === "string" && width.endsWith("%")) {
+            // For percentage, use fr with the percentage value as relative weight
+            var percent = parseInt(width, 10);
+            return fr(percent);
+        }
+        return fr(1);
+    });
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "tinky-table",
+  "version": "0.1.0",
+  "description": "A feature-rich, customizable Table component for tinky applications",
+  "keywords": [
+    "tinky",
+    "table",
+    "react",
+    "cli",
+    "terminal",
+    "component",
+    "datagrid",
+    "ui"
+  ],
+  "homepage": "https://github.com/ByteLandTechnology/tinky-table#readme",
+  "bugs": {
+    "url": "https://github.com/ByteLandTechnology/tinky-table/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ByteLandTechnology/tinky-table.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "ByteLandTechnology"
+  },
+  "type": "module",
+  "main": "./lib/index.js",
+  "scripts": {
+    "test": "bun test",
+    "build": "tsc && npm run docs",
+    "lint": "eslint src tests",
+    "prepublish": "npm run build",
+    "prepare": "husky",
+    "docs": "typedoc --plugin typedoc-plugin-markdown --disableSources --out docs/api && prettier --write docs/api"
+  },
+  "files": [
+    "./bin/*",
+    "./lib/*"
+  ],
+  "typings": "./lib/index.d.ts",
+  "peerDependencies": {
+    "tinky": "^1.2.0"
+  },
+  "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/github": "^12.0.0",
+    "@semantic-release/npm": "^13.1.3",
+    "@types/bun": "^1.3.6",
+    "eslint": "^9.39.2",
+    "eslint-plugin-react": "^7.37.5",
+    "husky": "^9.1.7",
+    "jiti": "^2.6.1",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.7.4",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript-eslint": "^8.53.0"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "*.{js,ts,jsx,tsx,json,md,yaml,yml}": "prettier --write"
+  }
+}