tidepool 1.0.5 → 1.0.6

package/README.md

@@ -1,2 +1,71 @@
 # 🌊 Tidepool
-A TUI library written in TypeScript.
+A TUI library written in TypeScript.
+
+### What tidepool offers 🔥
+- Modular API 🔧
+- Lightweight 🪶
+- Type-safe ⌨️
+- Easy to integrate with other technologies 💡
+
+API Example using readline for movement:
+```ts
+import { TideScreen, Box, Text, Line } from "tidepool";
+import readline from 'readline';
+
+// Create new tidepool screen instance
+const tui = new TideScreen(process.stdout.columns-1, process.stdout.rows-1);
+
+// Create text to be displayed inside of boxes
+const text = new Text(0, 0, "Welcome to tidepool!", 'cyan', 1);
+const text2 = new Text(0, 1, "This is a tidepool example with readline.", 'green', 1);
+
+// search for the middle of the screen and define first box
+const x = Math.floor(process.stdout.columns / 2)
+const y = Math.floor(process.stdout.rows / 2)
+const box = new Box(x, y, 25, 3, 'magenta', 'Tidepool Box', 1);
+
+// Define the box that will be under the other box
+const underBox = new Box(x-5, y-5, 25, 10, 'red', 'Under the other one', 2);
+
+// Define a cosmetic line
+const line = new Line(0, 0, underBox.width-2, 'yellow', 1);
+
+// Add content and components to the screen
+box.addContent(text);
+underBox.addContent(text2);
+underBox.addContent(line);
+
+tui.addComponent(box);
+tui.addComponent(underBox);
+
+// Render first frame
+tui.nextFrame();
+
+readline.emitKeypressEvents(process.stdin);
+process.stdin.setRawMode(true);
+
+// Listen for keypresses
+process.stdin.on('keypress', (str, key) => {
+  if (key.name === 'q' || (key.ctrl && key.name === 'c')) {
+    process.exit();
+  } else {
+    if (key.name === 'up' && box.y > 0) {
+      box.move(0, -1);
+    } else if (key.name === 'down' && box.y + box.height < tui.height) {
+      box.move(0, 1);
+    } else if (key.name === 'left' && box.x > 0) {
+      box.move(-1, 0);
+    } else if (key.name === 'right' && box.x + box.width < tui.width) {
+      box.move(1, 0);
+    }
+
+    // Render new frame after box moved.
+    tui.nextFrame();
+  }
+});
+
+```
+
+## Repository
+[GitHub Repository](https://github.com/stuncs69/tidepool)</br>
+[NPM](https://www.npmjs.com/package/tidepool)

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { Box } from "./objects/box";
+import { Line } from "./objects/line";
 import { Text } from "./objects/text";
 import { TideScreen } from "./screen";
-export { Box, Text, TideScreen };
+export { Box, Text, Line, TideScreen };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}

package/dist/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TideScreen = exports.Text = exports.Box = void 0;
+exports.TideScreen = exports.Line = exports.Text = exports.Box = void 0;
 const box_1 = require("./objects/box");
 Object.defineProperty(exports, "Box", { enumerable: true, get: function () { return box_1.Box; } });
+const line_1 = require("./objects/line");
+Object.defineProperty(exports, "Line", { enumerable: true, get: function () { return line_1.Line; } });
 const text_1 = require("./objects/text");
 Object.defineProperty(exports, "Text", { enumerable: true, get: function () { return text_1.Text; } });
 const screen_1 = require("./screen");

package/dist/objects/line.d.ts

@@ -0,0 +1,11 @@
+import { TideObject } from "../interfaces";
+export declare class Line implements TideObject {
+    relativeX: number;
+    relativeY: number;
+    length: number;
+    color: string;
+    zIndex: number;
+    constructor(x: number, y: number, length: number, color?: string, zIndex?: number);
+    draw(screen: string[][], boxX: number, boxY: number): void;
+}
+//# sourceMappingURL=line.d.ts.map

package/dist/objects/line.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"line.d.ts","sourceRoot":"","sources":["../../src/objects/line.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3C,qBAAa,IAAK,YAAW,UAAU;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;gBAEH,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,SAAU,EAAE,MAAM,SAAI;IAQ7E,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAUtD"}

package/dist/objects/line.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Line = void 0;
+const util_1 = require("../util");
+class Line {
+    constructor(x, y, length, color = 'reset', zIndex = 0) {
+        this.relativeX = x;
+        this.relativeY = y;
+        this.length = length;
+        this.color = color;
+        this.zIndex = zIndex;
+    }
+    draw(screen, boxX, boxY) {
+        const colorCode = (0, util_1.getColorCode)(this.color);
+        for (let i = 0; i < this.length; i++) {
+            const screenX = boxX + this.relativeX + i;
+            const screenY = boxY + this.relativeY;
+            if (screenX < screen[0].length && screenY < screen.length) {
+                screen[screenY][screenX] = `${colorCode}─\x1b[0m`;
+            }
+        }
+    }
+}
+exports.Line = Line;

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "tidepool",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "author": "stuncs69",
   "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/your-username/tidepool.git"
+  },
   "devDependencies": {
     "@eslint/js": "^9.9.0",
     "@types/node": "^22.2.0",