qtex 1.1.2 → 1.1.4

package/README.md

@@ -1,18 +1,26 @@
-# ⚡ qtex
+# ⚡ qtex — Cloud LaTeX Compiler
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/srsergiolazaro/qtex/main/docs/assets/banner.jpeg" alt="qtex Banner" width="500">
+  <img src="https://raw.githubusercontent.com/srsergiolazaro/qtex/main/docs/assets/banner.jpeg" alt="qtex - Cloud LaTeX Compiler" width="500">
 </p>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/qtex"><img src="https://img.shields.io/npm/v/qtex?style=flat-square&logo=npm&color=cb3837" alt="NPM Version"></a>
-  <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Fair_Source-blue.svg?style=flat-square" alt="License"></a>
-  <a href="https://latex.taptapp.xyz"><img src="https://img.shields.io/badge/Engine-Tectonic-8b5cf6?style=flat-square&logo=rust" alt="Engine"></a>
-  <a href="#"><img src="https://img.shields.io/badge/Latency-<1s-22c55e?style=flat-square" alt="Latency"></a>
+  <a href="https://www.npmjs.com/package/qtex"><img src="https://img.shields.io/npm/v/qtex?style=flat-square&logo=npm&color=cb3837" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/qtex"><img src="https://img.shields.io/npm/dm/qtex?style=flat-square&color=blue" alt="npm downloads"></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Fair_Source-blue?style=flat-square" alt="License"></a>
+  <a href="https://latex.taptapp.xyz"><img src="https://img.shields.io/badge/engine-Tectonic-8b5cf6?style=flat-square&logo=rust" alt="Tectonic Engine"></a>
 </p>
 
 <p align="center">
-  <strong>Cloud LaTeX compiler. Sub-second builds. Zero setup.</strong>
+  <strong>Compile LaTeX documents in the cloud. Sub-second builds. Zero configuration.</strong><br>
+  No TeXLive. No MikTeX. No 5GB downloads. Just fast PDF generation.
+</p>
+
+<p align="center">
+  <a href="#install">Install</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#features">Features</a> •
+  <a href="https://srsergiolazaro.github.io/qtex/">Website</a>
 </p>
 
 ---
@@ -21,70 +29,86 @@
 
 **macOS / Linux**
 ```bash
-curl -fsSL https://raw.githubusercontent.com/srsergiolazaro/qtex/main/install.sh | bash
+curl -fsSL https://srsergiolazaro.github.io/qtex/install.sh | bash
 ```
 
 **Windows (PowerShell)**
 ```powershell
-irm https://raw.githubusercontent.com/srsergiolazaro/qtex/main/install.ps1 | iex
+irm https://srsergiolazaro.github.io/qtex/install.ps1 | iex
 ```
 
-**Or use directly without installing:**
+**Or use directly with npx (zero install):**
 ```bash
 npx qtex ./my-project
 ```
 
----
-
-## Features
-
-| Feature | Description |
-|---------|-------------|
-| ⚡ **Fast** | Rust-based Tectonic engine. Compile in milliseconds. |
-| 📦 **Zero Config** | No TeXLive, no MikTeX. No 5GB downloads. |
-| 👀 **Watch Mode** | Auto-recompile on save. Supports `.tex`, `.bib`, `.sty`, images. |
-| 🔍 **Validation** | Pre-flight syntax checks before compilation. |
-| 📂 **Multi-file** | Recursive asset discovery with nested folders. |
-| 🔒 **Private** | Stateless & ephemeral. Files never stored. |
+**Or install globally via npm:**
+```bash
+npm install -g qtex
+```
 
 ---
 
 ## Usage
 
 ```bash
-# Compile a project
-qtex ./my-project
+# Compile a LaTeX project
+qtex ./my-thesis
 
-# Watch mode (live recompilation)
-qtex ./my-project --watch
+# Live watch mode — auto-recompile on save
+qtex ./my-thesis --watch
 
 # Custom output filename
-qtex ./my-project --output thesis.pdf
+qtex ./my-thesis --output final.pdf
 
-# Help
+# Show all options
 qtex --help
 ```
 
 ---
 
+## Features
+
+| | Feature | Description |
+|-|---------|-------------|
+| ⚡ | **Blazing Fast** | Rust-based Tectonic engine compiles in milliseconds |
+| 📦 | **Zero Config** | No TeXLive, no MikTeX, no local dependencies |
+| 👀 | **Watch Mode** | Auto-recompile on `.tex`, `.bib`, `.sty`, and image changes |
+| 🔍 | **Validation** | Pre-flight syntax checks before compilation |
+| 📂 | **Multi-file** | Recursive asset discovery with nested folders |
+| 🔒 | **Private** | Stateless & ephemeral — your files are never stored |
+
+---
+
 ## How it Works
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/srsergiolazaro/qtex/main/docs/assets/flow.png" alt="qtex Workflow" width="600">
+  <img src="https://raw.githubusercontent.com/srsergiolazaro/qtex/main/docs/assets/flow.png" alt="qtex workflow diagram" width="600">
 </p>
 
-1. **Scan** — Discover all TeX assets and dependencies
-2. **Validate** — Pre-flight syntax check
-3. **Compile** — Cloud processing via Tectonic
-4. **Sync** — Download PDF locally
+1. **Scan** — Discover all `.tex` files and dependencies
+2. **Validate** — Pre-flight syntax check via API
+3. **Compile** — Cloud processing with Tectonic engine
+4. **Download** — Get your PDF instantly
+
+---
+
+## Why qtex?
+
+| Traditional LaTeX | qtex |
+|-------------------|------|
+| 5GB+ TeXLive install | **Zero install** |
+| Minutes to compile | **Milliseconds** |
+| Complex setup | **One command** |
+| Local resources | **Cloud-powered** |
 
 ---
 
-## Infrastructure
+## API & Infrastructure
 
 - **Endpoint**: `https://latex.taptapp.xyz`
-- **Engine**: Tectonic (Rust / XeTeX)
-- **Privacy**: Stateless processing. Data never stored.
+- **Engine**: [Tectonic](https://tectonic-typesetting.github.io/) (Rust/XeTeX)
+- **Privacy**: Stateless processing — data is never stored
 
 ---
 
@@ -92,8 +116,8 @@ qtex --help
 
 **Fair Source License**
 
-- ✅ Free for individuals and teams up to 3 users
-- 📧 Contact for enterprise/commercial use
+✅ Free for individuals and teams ≤3 users  
+📧 Contact for enterprise licensing
 
 See [LICENSE](./LICENSE) for details.
 

package/index.js

@@ -60,20 +60,24 @@ ${colors.bold}OPTIONS:${colors.reset}
         autoUpdate(packageJson.version);
 
         if (values.watch) {
+            const { TachyonWS } = await import('./src/ws-client.js');
+            const wsClient = new TachyonWS(directory, values);
+            await wsClient.connect();
+
             const server = startServer();
             const viewUrl = `http://localhost:${server.port}/view`;
             ui.info(`Watching for changes in: ${colors.bold}${directory}${colors.reset}`);
             ui.info(`View PDF at: ${colors.blue}${colors.underline}${viewUrl}${colors.reset}`);
 
-            await compile(directory, values);
+            // Initial compile over WS
+            await wsClient.sendProject();
 
             // Auto-open browser
             const openCmd = process.platform === 'darwin' ? 'open' : process.platform === 'win32' ? 'start' : 'xdg-open';
             exec(`${openCmd} "${viewUrl}"`);
 
-            let isCompiling = false;
             watch(directory, { recursive: true }, async (event, filename) => {
-                if (filename && !filename.startsWith('.') && !isCompiling) {
+                if (filename && !filename.startsWith('.') && !wsClient.isCompiling) {
                     const ext = extname(filename).toLowerCase();
                     const outputFileName = values.output || 'output.pdf';
 
@@ -82,10 +86,7 @@ ${colors.bold}OPTIONS:${colors.reset}
                     const isOutputFile = basename(filename) === basename(outputFileName);
 
                     if (watchExts.includes(ext) && !isOutputFile) {
-                        isCompiling = true;
-                        console.log(`\n${colors.blue}🔄 Change detected in ${filename}, recompiling...${colors.reset}`);
-                        await compile(directory, values);
-                        isCompiling = false;
+                        await wsClient.sendProject();
                     }
                 }
             });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qtex",
-  "version": "1.1.2",
-  "description": "Vortex CLI: Ultra-fast cloud-based LaTeX compilation. Compile LaTeX documents in milliseconds using a high-performance Rust-powered engine without local TeX installation.",
+  "version": "1.1.4",
+  "description": "Ultra-fast cloud LaTeX compiler. Compile .tex documents in milliseconds without installing TeXLive or MikTeX. Zero config, sub-second builds, live watch mode.",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -12,13 +12,21 @@
     "latex",
     "tex",
     "compiler",
-    "tectonic",
-    "rust",
+    "pdf",
+    "latex-compiler",
     "cloud-latex",
-    "pdf-generator",
-    "vortex",
+    "tectonic",
+    "xelatex",
+    "pdflatex",
+    "academic",
+    "thesis",
+    "paper",
+    "document",
+    "typesetting",
+    "markdown-to-pdf",
     "cli",
-    "typesetting"
+    "fast",
+    "rust"
   ],
   "author": "Sergio Lázaro (srsergio)",
   "repository": {
@@ -28,7 +36,7 @@
   "bugs": {
     "url": "https://github.com/srsergiolazaro/qtex/issues"
   },
-  "homepage": "https://github.com/srsergiolazaro/qtex#readme",
+  "homepage": "https://srsergiolazaro.github.io/qtex/",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",
   "bin": {
@@ -42,5 +50,8 @@
   ],
   "directories": {
     "example": "example"
+  },
+  "engines": {
+    "node": ">=18"
   }
-}
+}

package/src/ws-client.js

@@ -0,0 +1,136 @@
+import { resolve, extname, join, basename } from 'node:path';
+import { colors, ui, Spinner } from './ui.js';
+import { notifyClients } from './server.js';
+import { readFile, writeFile } from 'node:fs/promises';
+
+const WS_URL = 'wss://latex.taptapp.xyz/ws'; // Production URL
+
+export class TachyonWS {
+    constructor(directory, options) {
+        this.directory = directory;
+        this.options = options;
+        this.socket = null;
+        this.isConnected = false;
+        this.spinner = new Spinner('');
+        this.isCompiling = false;
+    }
+
+    async connect() {
+        return new Promise((res, rej) => {
+            ui.info(`${colors.cyan}Connecting to Tachyon-Tex Live Engine...${colors.reset}`);
+            this.socket = new WebSocket(this.options.serverUrl || WS_URL);
+
+            this.socket.onopen = () => {
+                this.isConnected = true;
+                ui.info(`${colors.green}✅ Connected to Live Engine${colors.reset}`);
+                res();
+            };
+
+            this.socket.onmessage = async (event) => {
+                const data = JSON.parse(event.data);
+
+                if (data.type === 'compile_success') {
+                    if (this.spinner.timer) {
+                        this.spinner.succeed(`${colors.green}PDF updated in ${colors.bold}${data.compile_time_ms}ms${colors.reset}`);
+                    }
+
+                    const outputFileName = this.options.output || 'output.pdf';
+                    const outputPath = resolve(process.cwd(), outputFileName);
+
+                    // Decode base64 PDF
+                    const buffer = Buffer.from(data.pdf, 'base64');
+                    await writeFile(outputPath, buffer);
+
+                    // Notify local preview clients
+                    notifyClients(outputPath);
+                    this.isCompiling = false;
+                } else if (data.type === 'compile_error') {
+                    if (this.spinner.timer) {
+                        this.spinner.fail('Compilation failed');
+                    }
+                    console.log(`\n${colors.yellow}--- LaTeX Error ---${colors.reset}`);
+                    console.log(`${colors.red}${data.error}${colors.reset}`);
+                    console.log(`${colors.yellow}-------------------\n${colors.reset}`);
+                    this.isCompiling = false;
+                }
+            };
+
+            this.socket.onerror = (err) => {
+                ui.error(`WebSocket Error: ${err.message}`);
+                rej(err);
+            };
+
+            this.socket.onclose = () => {
+                this.isConnected = false;
+                ui.warn('WebSocket connection closed. Retrying in 2s...');
+                setTimeout(() => this.connect(), 2000);
+            };
+        });
+    }
+
+    async sendProject() {
+        if (!this.isConnected || this.isCompiling) return;
+
+        this.isCompiling = true;
+        this.spinner = new Spinner(`${colors.blue}Syncing project...`).start();
+
+        try {
+            const project = await this.buildProjectPayload();
+            this.socket.send(JSON.stringify(project));
+        } catch (e) {
+            this.spinner.fail(`Failed to sync: ${e.message}`);
+            this.isCompiling = false;
+        }
+    }
+
+    async buildProjectPayload() {
+        const absoluteDir = resolve(this.directory);
+        const files = await this.getProjectFiles(absoluteDir);
+        const payload = {
+            main: "main.tex", // Heuristic could be improved
+            files: {}
+        };
+
+        for (const fileObj of files) {
+            const ext = extname(fileObj.path).toLowerCase();
+            const textExts = ['.tex', '.sty', '.cls', '.bib', '.txt'];
+            const base = basename(fileObj.path);
+
+            if (textExts.includes(ext)) {
+                payload.files[fileObj.relative] = await readFile(fileObj.path, 'utf8');
+                if (base === 'main.tex') payload.main = fileObj.relative;
+            } else {
+                // Binary (images)
+                const buffer = await readFile(fileObj.path);
+                payload.files[fileObj.relative] = buffer.toString('base64');
+            }
+        }
+
+        return payload;
+    }
+
+    async getProjectFiles(dir, baseDir = dir) {
+        const { readdir } = await import('node:fs/promises');
+        const entries = await readdir(dir, { withFileTypes: true });
+        const files = [];
+
+        for (const entry of entries) {
+            const res = join(dir, entry.name);
+            if (entry.isDirectory()) {
+                if (entry.name !== 'node_modules' && !entry.name.startsWith('.')) {
+                    files.push(...(await this.getProjectFiles(res, baseDir)));
+                }
+            } else {
+                const ext = extname(entry.name).toLowerCase();
+                const allowed = ['.tex', '.bib', '.sty', '.cls', '.pdf', '.png', '.jpg', '.jpeg'];
+                if (allowed.includes(ext)) {
+                    files.push({
+                        path: res,
+                        relative: join(dir.replace(baseDir, ''), entry.name).replace(/^[\\\/]/, '').replace(/\\/g, '/')
+                    });
+                }
+            }
+        }
+        return files;
+    }
+}