tidepool 1.0.6 → 2.1.0

package/dist/screen.js

@@ -2,59 +2,133 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TideScreen = void 0;
 class TideScreen {
-    constructor(width, height, backgroundColor = 'transparent') {
+    constructor(width, height, backgroundColor = "transparent") {
         this.fps = null;
         this.updateFunction = null;
+        this.needsSort = true;
+        this.resizeListener = null;
+        this.didInitialClear = false;
         this.width = width;
         this.height = height;
-        this.screen = Array.from({ length: height }, () => Array(width).fill(' '));
-        this.buffer = Array.from({ length: height }, () => Array(width).fill(' '));
+        this.frontBuffer = this.createBuffer(width, height);
+        this.backBuffer = this.createBuffer(width, height);
         this.components = [];
         this.backgroundColor = backgroundColor;
     }
-    clearScreen() {
-        this.screen = Array.from({ length: this.height }, () => Array(this.width).fill(' '));
+    createBuffer(width, height) {
+        return Array.from({ length: height }, () => Array(width).fill(" "));
     }
-    clearBuffer() {
-        this.buffer = Array.from({ length: this.height }, () => Array(this.width).fill(' '));
+    clearBuffer(buffer, dirtyRows) {
+        for (let i = 0; i < this.height; i++) {
+            for (let j = 0; j < this.width; j++) {
+                buffer[i][j] = " ";
+            }
+            if (dirtyRows) {
+                dirtyRows.add(i);
+            }
+        }
     }
     addComponent(component) {
         this.components.push(component);
+        this.needsSort = true;
+    }
+    invalidateSort() {
+        this.needsSort = true;
     }
     getBackgroundColorCode(color) {
         const colors = {
-            black: '\x1b[40m',
-            red: '\x1b[41m',
-            green: '\x1b[42m',
-            yellow: '\x1b[43m',
-            blue: '\x1b[44m',
-            magenta: '\x1b[45m',
-            cyan: '\x1b[46m',
-            white: '\x1b[47m',
-            transparent: '\x1b[49m',
-            random: '\x1b[48;5;' + Math.floor(Math.random() * 256) + 'm',
+            black: "\x1b[40m",
+            red: "\x1b[41m",
+            green: "\x1b[42m",
+            yellow: "\x1b[43m",
+            blue: "\x1b[44m",
+            magenta: "\x1b[45m",
+            cyan: "\x1b[46m",
+            white: "\x1b[47m",
+            transparent: "\x1b[49m",
+            random: "\x1b[48;5;" + Math.floor(Math.random() * 256) + "m",
         };
-        return colors[color.toLowerCase()] || colors['black'];
+        return colors[color.toLowerCase()] || colors["black"];
     }
     renderBuffer() {
-        this.clearBuffer();
-        this.components.sort((a, b) => b.zIndex - a.zIndex);
-        this.components.forEach(component => component.draw(this.buffer));
+        const dirtyRows = new Set();
+        this.clearBuffer(this.backBuffer, dirtyRows);
+        if (this.needsSort) {
+            this.components.sort((a, b) => b.zIndex - a.zIndex);
+            this.needsSort = false;
+        }
+        const baseContext = {
+            buffer: this.backBuffer,
+            origin: { x: 0, y: 0 },
+            clip: { x: 0, y: 0, width: this.width, height: this.height },
+            screenSize: { width: this.width, height: this.height },
+            dirtyRows,
+        };
+        this.components.forEach((component) => component.draw(baseContext));
+        return dirtyRows;
     }
-    applyBackgroundColor() {
+    applyBackgroundColor(dirtyRows) {
+        if (this.backgroundColor.toLowerCase() === "transparent") {
+            return;
+        }
         const bgColorCode = this.getBackgroundColorCode(this.backgroundColor);
-        const resetCode = '\x1b[0m';
+        const resetCode = "\x1b[0m";
         for (let i = 0; i < this.height; i++) {
             for (let j = 0; j < this.width; j++) {
-                this.buffer[i][j] = `${bgColorCode}${this.buffer[i][j] || ' '}${resetCode}`;
+                this.backBuffer[i][j] = `${bgColorCode}${this.backBuffer[i][j] || " "}${resetCode}`;
+                if (dirtyRows) {
+                    dirtyRows.add(i);
+                }
             }
         }
     }
-    render() {
-        this.applyBackgroundColor();
-        console.clear();
-        const output = this.buffer.map(row => row.join('')).join('\n');
-        console.log(output);
+    resize(width, height) {
+        this.width = width;
+        this.height = height;
+        this.frontBuffer = this.createBuffer(width, height);
+        this.backBuffer = this.createBuffer(width, height);
+    }
+    enableAutoResize(getSize = () => ({
+        width: process.stdout.columns - 1,
+        height: process.stdout.rows - 1,
+    })) {
+        if (this.resizeListener) {
+            return;
+        }
+        this.resizeListener = () => {
+            const size = getSize();
+            this.resize(size.width, size.height);
+        };
+        process.on("SIGWINCH", this.resizeListener);
+    }
+    disableAutoResize() {
+        if (!this.resizeListener) {
+            return;
+        }
+        process.off("SIGWINCH", this.resizeListener);
+        this.resizeListener = null;
+    }
+    render(dirtyRows) {
+        if (!this.didInitialClear) {
+            process.stdout.write("\x1b[2J\x1b[H");
+            this.didInitialClear = true;
+        }
+        this.applyBackgroundColor(dirtyRows);
+        process.stdout.write("\x1b[H");
+        const rowsToRender = dirtyRows && dirtyRows.size > 0
+            ? Array.from(dirtyRows)
+            : dirtyRows
+                ? []
+                : Array.from({ length: this.height }, (_, i) => i);
+        for (const i of rowsToRender) {
+            for (let j = 0; j < this.width; j++) {
+                if (this.backBuffer[i][j] !== this.frontBuffer[i][j]) {
+                    process.stdout.write(`\x1b[${i + 1};${j + 1}H`);
+                    process.stdout.write(this.backBuffer[i][j]);
+                    this.frontBuffer[i][j] = this.backBuffer[i][j];
+                }
+            }
+        }
     }
     setUpdateFunction(fn) {
         this.updateFunction = fn;
@@ -66,10 +140,10 @@ class TideScreen {
         if (this.updateFunction) {
             this.updateFunction();
         }
-        this.renderBuffer();
-        this.render();
+        const dirtyRows = this.renderBuffer();
+        this.render(dirtyRows);
     }
-    renderCycle() {
+    renderCycle(beforeRender, afterRender) {
         if (this.fps === null) {
             throw new Error("FPS must be set before starting the render cycle.");
         }
@@ -78,11 +152,21 @@ class TideScreen {
             if (this.updateFunction) {
                 this.updateFunction();
             }
-            this.renderBuffer();
-            this.render();
+            if (beforeRender) {
+                beforeRender();
+            }
+            const dirtyRows = this.renderBuffer();
+            this.render(dirtyRows);
+            if (afterRender) {
+                afterRender();
+            }
             setTimeout(loop, interval);
         };
         loop();
+        process.on("SIGINT", () => {
+            process.stdout.write("\x1b[?25h");
+            process.exit();
+        });
     }
 }
 exports.TideScreen = TideScreen;

package/dist/util.d.ts

@@ -1,3 +1,6 @@
+import type { Rect } from "./interfaces";
 export declare function getColorCode(color: string): string;
 export declare function wrapText(text: string, maxWidth: number): string[];
+export declare function intersectRect(a: Rect, b: Rect): Rect | null;
+export declare function setCell(buffer: string[][], x: number, y: number, value: string, clip?: Rect, dirtyRows?: Set<number>): void;
 //# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,UAezC;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,YAetD"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEzC,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,UAgBzC;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,YAetD;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAW3D;AAED,wBAAgB,OAAO,CACrB,MAAM,EAAE,MAAM,EAAE,EAAE,EAClB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,IAAI,EACX,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,QAmBxB"}

package/dist/util.js

@@ -2,20 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getColorCode = getColorCode;
 exports.wrapText = wrapText;
+exports.intersectRect = intersectRect;
+exports.setCell = setCell;
 function getColorCode(color) {
     const colors = {
-        reset: '\x1b[0m',
-        black: '\x1b[30m',
-        red: '\x1b[31m',
-        green: '\x1b[32m',
-        yellow: '\x1b[33m',
-        blue: '\x1b[34m',
-        magenta: '\x1b[35m',
-        cyan: '\x1b[36m',
-        white: '\x1b[37m',
-        random: '\x1b[38;5;' + Math.floor(Math.random() * 256) + 'm',
+        reset: "\x1b[0m",
+        black: "\x1b[30m",
+        red: "\x1b[31m",
+        green: "\x1b[32m",
+        yellow: "\x1b[33m",
+        blue: "\x1b[34m",
+        magenta: "\x1b[35m",
+        cyan: "\x1b[36m",
+        white: "\x1b[37m",
+        gray: "\x1b[90m",
+        random: "\x1b[38;5;" + Math.floor(Math.random() * 256) + "m",
     };
-    return colors[color.toLowerCase()] || colors['reset'];
+    return colors[color.toLowerCase()] || colors["reset"];
 }
 function wrapText(text, maxWidth) {
     const lines = [];
@@ -32,3 +35,30 @@ function wrapText(text, maxWidth) {
     lines.push(currentLine.trim());
     return lines;
 }
+function intersectRect(a, b) {
+    const x1 = Math.max(a.x, b.x);
+    const y1 = Math.max(a.y, b.y);
+    const x2 = Math.min(a.x + a.width, b.x + b.width);
+    const y2 = Math.min(a.y + a.height, b.y + b.height);
+    if (x2 <= x1 || y2 <= y1) {
+        return null;
+    }
+    return { x: x1, y: y1, width: x2 - x1, height: y2 - y1 };
+}
+function setCell(buffer, x, y, value, clip, dirtyRows) {
+    if (y < 0 || x < 0 || y >= buffer.length || x >= buffer[0].length) {
+        return;
+    }
+    if (clip) {
+        if (x < clip.x ||
+            y < clip.y ||
+            x >= clip.x + clip.width ||
+            y >= clip.y + clip.height) {
+            return;
+        }
+    }
+    buffer[y][x] = value;
+    if (dirtyRows) {
+        dirtyRows.add(y);
+    }
+}

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "tidepool",
-  "version": "1.0.6",
+  "version": "2.1.0",
   "author": "stuncs69",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/your-username/tidepool.git"
+    "url": "https://github.com/stuncs69/tidepool.git"
   },
   "devDependencies": {
     "@eslint/js": "^9.9.0",
-    "@types/node": "^22.2.0",
+    "@types/node": "^25.0.8",
     "@typescript-eslint/eslint-plugin": "^8.1.0",
     "@typescript-eslint/parser": "^8.1.0",
     "eslint": "^9.9.0",
@@ -20,7 +21,24 @@
   "description": "A CLI rendering engine in TypeScript.",
   "license": "ISC",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint ./src/*"
+    "test": "npm run build && node --test test/*.test.js",
+    "lint": "eslint ./src/*",
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "demo:build": "tsc -p demo/tsconfig.json",
+    "demo": "npm run build && npm run demo:build && node dist-demo/demo/demo.js",
+    "demo:stack": "npm run build && npm run demo:build && node dist-demo/demo/stacking.js",
+    "demo:form": "npm run build && npm run demo:build && node dist-demo/demo/form.js",
+    "demo:chat": "npm run build && npm run demo:build && node dist-demo/demo/chat.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
   }
 }

package/.github/workflows/eslint.yml

@@ -1,50 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# ESLint is a tool for identifying and reporting on patterns
-# found in ECMAScript/JavaScript code.
-# More details at https://github.com/eslint/eslint
-# and https://eslint.org
-
-name: ESLint
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-  schedule:
-    - cron: '21 0 * * 3'
-
-jobs:
-  eslint:
-    name: Run eslint scanning
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      security-events: write
-      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Install ESLint
-        run: |
-          npm install eslint@8.10.0
-          npm install @microsoft/eslint-formatter-sarif@2.1.7
-
-      - name: Run ESLint
-        run: npx eslint .
-          --config .eslintrc.js
-          --ext .js,.jsx,.ts,.tsx
-          --format @microsoft/eslint-formatter-sarif
-          --output-file eslint-results.sarif
-        continue-on-error: true
-
-      - name: Upload analysis results to GitHub
-        uses: github/codeql-action/upload-sarif@v3
-        with:
-          sarif_file: eslint-results.sarif
-          wait-for-processing: true

package/eslint.config.mjs

@@ -1,38 +0,0 @@
-import typescriptEslint from "@typescript-eslint/eslint-plugin";
-import globals from "globals";
-import tsParser from "@typescript-eslint/parser";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-    baseDirectory: __dirname,
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all
-});
-
-export default [
-    ...compat.extends("eslint:recommended", "plugin:@typescript-eslint/recommended"),
-    {
-        plugins: {
-            "@typescript-eslint": typescriptEslint,
-        },
-
-        languageOptions: {
-            globals: {
-                ...globals.node,
-            },
-
-            parser: tsParser,
-            ecmaVersion: 12,
-            sourceType: "module",
-        },
-
-        rules: {
-            "@typescript-eslint/no-unsafe-function-type": "off",
-        },
-    },
-];