@rip-lang/db 0.10.0 → 1.0.1

package/PROTOCOL.md

@@ -1,258 +0,0 @@
-# DuckDB UI Binary Protocol Specification
-
-This document describes the binary protocol used by DuckDB's built-in UI to communicate
-with the database server. rip-db implements this protocol, allowing the official DuckDB UI
-to connect transparently.
-
-## Architecture
-
-```
-┌─────────────┐     HTTP POST      ┌─────────────┐      SQL       ┌─────────────┐
-│  DuckDB UI  │ ──────────────────▶│   rip-db    │ ──────────────▶│  DuckDB     │
-│  (Browser)  │◀────────────────── │   Server    │◀────────────── │  Database   │
-└─────────────┘   Binary Response  └─────────────┘    Results     └─────────────┘
-```
-
-## Implemented Endpoints
-
-| Endpoint          | Method | Body           | Response          | Status   |
-|-------------------|--------|----------------|-------------------|----------|
-| `/ddb/run`        | POST   | SQL (text)     | Binary result     | ✅ Done  |
-| `/ddb/interrupt`  | POST   | Empty          | Empty result      | ✅ Done  |
-| `/ddb/tokenize`   | POST   | SQL (text)     | Binary tokens     | ✅ Done  |
-| `/info`           | GET    | -              | Empty + headers   | ✅ Done  |
-
-## Request Headers
-
-All headers are optional unless noted.
-
-| Header                              | Encoding | Purpose                            |
-|-------------------------------------|----------|-----------------------------------|
-| `X-DuckDB-UI-Connection-Name`       | Plain    | Named connection (for persistence) |
-| `X-DuckDB-UI-Database-Name`         | Base64   | Target database                    |
-| `X-DuckDB-UI-Schema-Name`           | Base64   | Target schema                      |
-| `X-DuckDB-UI-Parameter-Count`       | Plain    | Number of prepared stmt params     |
-| `X-DuckDB-UI-Parameter-Value-{n}`   | Base64   | Param value (0-indexed)            |
-| `X-DuckDB-UI-Result-Row-Limit`      | Plain    | Max rows to return                 |
-| `X-DuckDB-UI-Result-Database-Name`  | Base64   | Store results in this database     |
-| `X-DuckDB-UI-Result-Schema-Name`    | Base64   | Store results in this schema       |
-| `X-DuckDB-UI-Result-Table-Name`     | Base64   | Store results in this table        |
-| `X-DuckDB-UI-Result-Table-Row-Limit`| Plain    | Max rows to store in table         |
-| `X-DuckDB-UI-Errors-As-JSON`        | Plain    | Return errors as JSON              |
-| `X-DuckDB-UI-Request-Description`   | Plain    | Human-readable description         |
-
-## Binary Serialization Format
-
-### Primitives
-
-#### varint (Variable-length Integer)
-```
-while (byte & 0x80):
-    result |= (byte & 0x7F) << shift
-    shift += 7
-```
-
-#### uint8
-Single byte, unsigned.
-
-#### uint16 (Field ID)
-2 bytes, little-endian.
-
-#### string
-```
-length: varint
-data:   UTF-8 bytes (length count)
-```
-
-#### data (raw bytes)
-```
-length: varint
-data:   raw bytes (length count)
-```
-
-#### nullable<T>
-```
-present: uint8 (0 = null, non-zero = present)
-value:   T (only if present)
-```
-
-#### list<T>
-```
-count: varint
-items: T[] (count items)
-```
-
-### Object Structure
-
-Objects use field IDs to identify properties:
-```
-field_id: uint16 (little-endian)
-value:    <type depends on field>
-...
-end:      0xFFFF (end marker)
-```
-
-### Response Types
-
-#### SuccessResult
-```
-field_100: boolean (true)
-field_101: ColumnNamesAndTypes
-field_102: list<DataChunk>
-0xFFFF
-```
-
-#### ErrorResult
-```
-field_100: boolean (false)
-field_101: string (error message)
-0xFFFF
-```
-
-#### EmptyResult
-```
-(no fields)
-```
-
-#### TokenizeResult
-```
-field_100: list<varint> (offsets)
-field_101: list<varint> (token types)
-0xFFFF
-```
-
-### ColumnNamesAndTypes
-```
-field_100: list<string> (column names)
-field_101: list<Type> (column types)
-0xFFFF
-```
-
-### Type
-```
-field_100: uint8 (LogicalTypeId)
-field_101: nullable<TypeInfo> (extra info for complex types)
-0xFFFF
-```
-
-### DataChunk
-```
-field_100: varint (row count)
-field_101: list<Vector> (vectors - one per column)
-0xFFFF
-```
-
-### Vector
-
-All vectors start with:
-```
-field_100: uint8 (allValid flag - 0 means some nulls)
-field_101: data (validity bitmap - only if allValid=0)
-```
-
-Then type-specific data:
-
-#### Data Vector (numeric/temporal types)
-```
-field_102: data (raw bytes - type-specific encoding)
-0xFFFF
-```
-
-#### String Vector (CHAR, VARCHAR)
-```
-field_102: list<string> (string values)
-0xFFFF
-```
-
-## LogicalTypeId Constants
-
-```javascript
-const LogicalTypeId = {
-  BOOLEAN:       10,
-  TINYINT:       11,
-  SMALLINT:      12,
-  INTEGER:       13,
-  BIGINT:        14,
-  DATE:          15,
-  TIME:          16,
-  TIMESTAMP_SEC: 17,
-  TIMESTAMP_MS:  18,
-  TIMESTAMP:     19,
-  TIMESTAMP_NS:  20,
-  DECIMAL:       21,
-  FLOAT:         22,
-  DOUBLE:        23,
-  CHAR:          24,
-  VARCHAR:       25,
-  BLOB:          26,
-  INTERVAL:      27,
-  UTINYINT:      28,
-  USMALLINT:     29,
-  UINTEGER:      30,
-  UBIGINT:       31,
-  TIMESTAMP_TZ:  32,
-  TIME_TZ:       34,
-  BIT:           36,
-  BIGNUM:        39,
-  UHUGEINT:      49,
-  HUGEINT:       50,
-  UUID:          54,
-  STRUCT:       100,
-  LIST:         101,
-  MAP:          102,
-  ENUM:         104,
-  UNION:        107,
-  ARRAY:        108,
-};
-```
-
-## Data Type Byte Sizes
-
-| Type          | Bytes | Format                              |
-|---------------|-------|-------------------------------------|
-| BOOLEAN       | 1     | 0 or non-zero                       |
-| TINYINT       | 1     | int8                                |
-| UTINYINT      | 1     | uint8                               |
-| SMALLINT      | 2     | int16 LE                            |
-| USMALLINT     | 2     | uint16 LE                           |
-| INTEGER       | 4     | int32 LE                            |
-| UINTEGER      | 4     | uint32 LE                           |
-| BIGINT        | 8     | int64 LE                            |
-| UBIGINT       | 8     | uint64 LE                           |
-| HUGEINT       | 16    | int128 LE                           |
-| UHUGEINT      | 16    | uint128 LE                          |
-| FLOAT         | 4     | IEEE 754 float32                    |
-| DOUBLE        | 8     | IEEE 754 float64                    |
-| DATE          | 4     | int32 (days since 1970-01-01)       |
-| TIME          | 8     | int64 (microseconds since midnight) |
-| TIMESTAMP     | 8     | int64 (microseconds since epoch)    |
-| TIMESTAMP_MS  | 8     | int64 (milliseconds since epoch)    |
-| TIMESTAMP_SEC | 8     | int64 (seconds since epoch)         |
-| TIMESTAMP_NS  | 8     | int64 (nanoseconds since epoch)     |
-| TIMESTAMP_TZ  | 8     | same as TIMESTAMP                   |
-| TIME_TZ       | 8     | int64 (micros + offset encoded)     |
-| INTERVAL      | 16    | months(4) + days(4) + micros(8)     |
-| UUID          | 16    | 128-bit UUID                        |
-| DECIMAL       | varies| depends on width                    |
-| ENUM          | varies| depends on enum size                |
-
-## Validity Bitmap
-
-When `allValid` is 0, the validity bitmap indicates which values are NULL:
-- Bit order: LSB first within each byte
-- Bit meaning: 1 = valid, 0 = NULL
-- Size: ceil(rowCount / 8) bytes
-
-```javascript
-// Check if row i is valid
-const byteIndex = Math.floor(i / 8);
-const bitIndex = i % 8;
-const isValid = (validity[byteIndex] >> bitIndex) & 1;
-```
-
-## References
-
-- [DuckDB UI GitHub](https://github.com/duckdb/duckdb-ui)
-- [BinaryDeserializer.ts](https://github.com/duckdb/duckdb-ui/blob/main/ts/pkgs/duckdb-ui-client/src/serialization/classes/BinaryDeserializer.ts)
-- [DuckDB BinarySerializer](https://github.com/duckdb/duckdb/blob/main/src/include/duckdb/common/serializer/binary_serializer.hpp)
-- [Vector::Serialize](https://github.com/duckdb/duckdb/blob/main/src/common/types/vector.cpp)

package/db.html

@@ -1,122 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="UTF-8">
-  <title>DuckDB Console</title>
-  <style>
-    * { box-sizing: border-box; }
-    body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; margin: 0; padding: 20px; background: #1a1a2e; color: #eee; }
-    h1 { margin: 0 0 20px; font-size: 24px; color: #fff; }
-    .container { max-width: 1200px; margin: 0 auto; }
-    textarea { width: 100%; height: 120px; padding: 12px; font-family: 'Monaco', 'Menlo', monospace; font-size: 14px; background: #16213e; color: #0f0; border: 1px solid #0f4c75; border-radius: 6px; resize: vertical; }
-    .buttons { margin: 10px 0; }
-    button { padding: 10px 24px; font-size: 14px; background: #0f4c75; color: #fff; border: none; border-radius: 6px; cursor: pointer; margin-right: 10px; }
-    button:hover { background: #1b6ca8; }
-    .info { font-size: 12px; color: #888; margin-bottom: 10px; }
-    .results { margin-top: 20px; }
-    table { width: 100%; border-collapse: collapse; background: #16213e; border-radius: 6px; overflow: hidden; }
-    th { background: #0f4c75; padding: 10px; text-align: left; font-weight: 600; }
-    td { padding: 8px 10px; border-bottom: 1px solid #1b2838; }
-    tr:hover td { background: #1b2838; }
-    .error { color: #ff6b6b; background: #2d1f1f; padding: 12px; border-radius: 6px; }
-    .meta { color: #888; font-size: 12px; margin-top: 10px; }
-    .status { padding: 4px 8px; border-radius: 4px; font-size: 12px; }
-    .status.ok { background: #1d4d1d; color: #4ade80; }
-    .status.err { background: #4d1d1d; color: #ff6b6b; }
-  </style>
-</head>
-<body>
-  <div class="container">
-    <h1>🦆 DuckDB Console</h1>
-    <div class="info">Connected to: <span id="db">loading...</span></div>
-    <textarea id="sql" placeholder="SELECT * FROM users LIMIT 10;">SELECT * FROM users;</textarea>
-    <div class="buttons">
-      <button onclick="run()">▶ Run (Cmd+Enter)</button>
-      <button onclick="tables()">📋 Tables</button>
-      <button onclick="status()">ℹ️ Status</button>
-    </div>
-    <div id="results" class="results"></div>
-  </div>
-  <script>
-    const sqlEl = document.getElementById('sql');
-    const resultsEl = document.getElementById('results');
-
-    // Load status on startup
-    fetch('/status').then(r => r.json()).then(d => {
-      document.getElementById('db').textContent = d.database;
-    });
-
-    // Cmd+Enter to run
-    sqlEl.addEventListener('keydown', e => {
-      if ((e.metaKey || e.ctrlKey) && e.key === 'Enter') {
-        e.preventDefault();
-        run();
-      }
-    });
-
-    function run() {
-      const sql = sqlEl.value.trim();
-      if (!sql) return;
-      fetch('/sql', {
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify({ sql })
-      })
-      .then(r => r.json())
-      .then(renderResult)
-      .catch(e => renderError(e.message));
-    }
-
-    function tables() {
-      sqlEl.value = "SELECT table_name FROM information_schema.tables WHERE table_schema = 'main';";
-      run();
-    }
-
-    function status() {
-      fetch('/status')
-        .then(r => r.json())
-        .then(data => {
-          resultsEl.innerHTML = `
-            <div style="background:#16213e;padding:16px;border-radius:6px;">
-              <div><strong>Database:</strong> ${data.database}</div>
-              <div><strong>Tables:</strong> ${data.tables?.join(', ') || 'none'}</div>
-              <div><strong>Time:</strong> ${data.time}</div>
-            </div>`;
-        })
-        .catch(e => renderError(e.message));
-    }
-
-    function renderResult(data) {
-      if (data.error) {
-        renderError(data.error);
-        return;
-      }
-      if (!data.meta?.length) {
-        resultsEl.innerHTML = `<div class="meta"><span class="status ok">✓ OK</span> Query executed in ${data.time}s</div>`;
-        return;
-      }
-      let html = '<table><tr>';
-      data.meta.forEach(col => {
-        html += `<th>${col.name}<br><span style="font-weight:normal;font-size:11px;color:#888">${col.type}</span></th>`;
-      });
-      html += '</tr>';
-      data.data.forEach(row => {
-        html += '<tr>';
-        row.forEach(val => {
-          html += `<td>${val === null ? '<span style="color:#666">NULL</span>' : val}</td>`;
-        });
-        html += '</tr>';
-      });
-      html += `</table><div class="meta"><span class="status ok">✓ OK</span> ${data.rows} row${data.rows !== 1 ? 's' : ''} in ${data.time}s</div>`;
-      resultsEl.innerHTML = html;
-    }
-
-    function renderError(msg) {
-      resultsEl.innerHTML = `<div class="error"><span class="status err">✗ Error</span> ${msg}</div>`;
-    }
-
-    // Run initial query
-    run();
-  </script>
-</body>
-</html>