boom-format 0.9.0

package/dist/index.js

@@ -0,0 +1,82 @@
+import {
+  BOOM_DICTIONARY_V1,
+  BoomError,
+  BoomHeaders,
+  ByteReader,
+  ByteWriter,
+  DEFAULT_THRESHOLDS,
+  MAGIC,
+  StreamDecoder,
+  VERSION,
+  analyzeDictionary,
+  autoInit,
+  boomFetch,
+  compare,
+  createBoomAxios,
+  createBoomGraphQL,
+  createThresholdHeaders,
+  decode,
+  decodeFromLengthPrefixed,
+  decodeSmallest,
+  encode,
+  encodeSmallest,
+  encodeWithLength,
+  estimateSize,
+  fromJSON,
+  fromJSONDirect,
+  getBoomData,
+  getBoomMode,
+  getThresholdConfig,
+  index_default,
+  parseText,
+  parseThresholdHeaders,
+  processBoomScripts,
+  selectFormat,
+  setBoomMode,
+  setThresholdConfig,
+  stringify,
+  toJSON,
+  zigzagDecode,
+  zigzagEncode
+} from "./chunk-5PQH6SJJ.js";
+export {
+  BOOM_DICTIONARY_V1,
+  VERSION as BOOM_VERSION,
+  BoomError,
+  BoomHeaders,
+  ByteReader,
+  ByteWriter,
+  DEFAULT_THRESHOLDS,
+  MAGIC,
+  StreamDecoder,
+  analyzeDictionary,
+  autoInit,
+  boomFetch,
+  compare,
+  createBoomAxios,
+  createBoomGraphQL,
+  createThresholdHeaders,
+  decode,
+  decodeFromLengthPrefixed,
+  decodeSmallest,
+  index_default as default,
+  encode,
+  encodeSmallest,
+  encodeWithLength,
+  estimateSize,
+  fromJSON,
+  fromJSONDirect,
+  getBoomData,
+  getBoomMode,
+  getThresholdConfig,
+  parseText,
+  parseThresholdHeaders,
+  processBoomScripts,
+  selectFormat,
+  setBoomMode,
+  setThresholdConfig,
+  stringify,
+  toJSON,
+  zigzagDecode,
+  zigzagEncode
+};

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "boom-format",
+  "version": "0.9.0",
+  "description": "Binary Object Optimised Markup - A compact binary serialisation format with readable debug mode",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "boom": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./dist/index.js",
+      "deno": "./dist/index.js",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./production": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/boom.min.js",
+      "require": "./dist/boom.min.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "samples",
+    "README.md",
+    "SPECIFICATION.md",
+    "deno.json"
+  ],
+  "scripts": {
+    "generate:dictionary": "node scripts/generate-dictionary.js",
+    "build": "npm run generate:dictionary && tsup src/index.ts src/cli.ts --format cjs,esm,iife --dts --clean --global-name Boom",
+    "build:prod": "npm run build && npm run minify && npm run obfuscate",
+    "build:browser": "tsup src/index.ts --format iife --global-name Boom --outDir docs --no-dts",
+    "minify": "terser dist/index.js -c -m --module -o dist/boom.min.js && terser dist/index.cjs -c -m -o dist/boom.min.cjs",
+    "obfuscate": "javascript-obfuscator dist/boom.min.js --output dist/boom.obf.js --compact true --control-flow-flattening true --dead-code-injection false --string-array true --string-array-encoding base64 --string-array-threshold 0.75",
+    "test": "node --test test/*.test.js",
+    "test:coverage": "node --test --experimental-test-coverage test/*.test.js",
+    "test:bun": "bun test test/bun.test.ts",
+    "test:deno": "deno test --allow-read test/deno-local.test.ts",
+    "benchmark": "node benchmark/bench.js",
+    "benchmark:bun": "bun run benchmark/bench-bun.ts",
+    "benchmark:deno": "deno run --allow-read benchmark/bench-deno.ts",
+    "benchmark:all": "npm run benchmark && echo '---' && npm run benchmark:bun && echo '---' && npm run benchmark:deno",
+    "benchmark:compare": "node benchmark/format-comparison.js",
+    "generate:og": "node docs/scripts/generate-og-images.js",
+    "update:year": "node docs/scripts/update-copyright-year.js",
+    "build:docs": "node docs/scripts/build-pages.js",
+    "minify:docs": "node docs/scripts/minify-docs.js",
+    "build:docs:prod": "npm run build:docs && npm run minify:docs",
+    "prepublishOnly": "npm run build:prod && npm test"
+  },
+  "keywords": [
+    "binary",
+    "serialization",
+    "json",
+    "compact",
+    "format",
+    "parser",
+    "encoder",
+    "msgpack",
+    "cbor",
+    "boom",
+    "llm",
+    "token-efficient",
+    "ai",
+    "toon",
+    "yaml-alternative"
+  ],
+  "author": "Tom Taylor",
+  "license": "SEE LICENSE IN LICENSE",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/t0mtaylor/boom-format.git"
+  },
+  "homepage": "https://github.com/t0mtaylor/boom-format#readme",
+  "bugs": {
+    "url": "https://github.com/t0mtaylor/boom-format/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "csso": "^5.0.5",
+    "html-minifier-terser": "^7.2.0",
+    "javascript-obfuscator": "^4.1.0",
+    "puppeteer": "^24.34.0",
+    "terser": "^5.31.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  }
+}

package/samples/README.md

@@ -0,0 +1,114 @@
+# BOOM Sample Files
+
+This directory contains sample files in JSON, BOOM binary, and BOOM text formats to help you understand the format.
+
+## Files
+
+### users.json / users.boom / users.boom.txt
+A typical API response with an array of user objects. Demonstrates string interning with repeated keys.
+
+| Format | Size | Savings |
+|--------|------|---------|
+| JSON | 540 B | - |
+| BOOM binary | 256 B | **52.6%** |
+| BOOM text | 331 B | **38.7%** |
+
+### api-response.json / api-response.boom / api-response.boom.txt
+An LLM API response structure with nested objects. Shows dictionary efficiency with common API keys.
+
+| Format | Size | Savings |
+|--------|------|---------|
+| JSON | 381 B | - |
+| BOOM binary | 252 B | **33.9%** |
+| BOOM text | 278 B | **27.0%** |
+
+### config.json / config.boom / config.boom.txt
+Application configuration with nested settings. Good for human editing in `.boom.txt` format.
+
+| Format | Size | Savings |
+|--------|------|---------|
+| JSON | 361 B | - |
+| BOOM binary | 202 B | **44.0%** |
+| BOOM text | 244 B | **32.4%** |
+
+## Using These Files
+
+### View BOOM Text Format
+```bash
+cat users.boom.txt
+```
+
+Output:
+```boom
+{
+  users: [
+    { id: 1 name: "Alice Johnson" email: "alice@example.com" role: "admin" active: true score: 95.5 }
+    { id: 2 name: "Bob Smith" email: "bob@example.com" role: "user" active: true score: 88 }
+    { id: 3 name: "Charlie Brown" email: "charlie@example.com" role: "user" active: false score: 72.5 }
+  ]
+  total: 3
+  page: 1
+  pageSize: 10
+}
+```
+
+### Convert Between Formats
+```bash
+# JSON to BOOM binary
+npx boom encode users.json
+
+# JSON to BOOM text
+npx boom encode users.json --text
+
+# BOOM binary to JSON
+npx boom decode users.boom
+
+# BOOM text to JSON
+npx boom decode users.boom.txt
+
+# Show file info
+npx boom info users.boom
+```
+
+### Programmatic Usage
+```javascript
+import { encode, decode, stringify, parseText } from 'boom-format';
+import fs from 'fs';
+
+// Read and decode BOOM binary
+const boomData = fs.readFileSync('users.boom');
+const users = decode(new Uint8Array(boomData));
+
+// Read and parse BOOM text
+const textData = fs.readFileSync('users.boom.txt', 'utf-8');
+const usersFromText = parseText(textData);
+
+// Encode to BOOM binary
+const encoded = encode(users);
+fs.writeFileSync('output.boom', encoded);
+
+// Convert to BOOM text
+const text = stringify(users);
+fs.writeFileSync('output.boom.txt', text);
+```
+
+## File Extensions
+
+| Extension | Format | MIME Type |
+|-----------|--------|-----------|
+| `.boom` | BOOM Binary | `application/x-boom` |
+| `.boom.txt` | BOOM Text | `application/x-boom-text` |
+| `.json` | JSON | `application/json` |
+
+## BOOM Binary Header
+
+The `.boom` files start with a 6-byte header:
+- Bytes 0-3: Magic `BOOM` (0x42, 0x4F, 0x4F, 0x4D)
+- Byte 4: Version (0x01)
+- Byte 5: Flags
+
+You can verify a BOOM file with:
+```bash
+xxd -l 6 users.boom
+# 00000000: 424f 4f4d 0101                           BOOM..
+```

package/samples/api-response.boom.txt

@@ -0,0 +1 @@
+{ status: "success" data: { id: "msg_abc123" role: "assistant" content: "Hello! How can I help you today?" model: "gpt-4" created_at: "2024-01-15T10:30:00Z" usage: { prompt_tokens: 12 completion_tokens: 8 total_tokens: 20 } } meta: { request_id: "req_xyz789" latency_ms: 245 } }

package/samples/api-response.json

@@ -0,0 +1,19 @@
+{
+  "status": "success",
+  "data": {
+    "id": "msg_abc123",
+    "role": "assistant",
+    "content": "Hello! How can I help you today?",
+    "model": "gpt-4",
+    "created_at": "2024-01-15T10:30:00Z",
+    "usage": {
+      "prompt_tokens": 12,
+      "completion_tokens": 8,
+      "total_tokens": 20
+    }
+  },
+  "meta": {
+    "request_id": "req_xyz789",
+    "latency_ms": 245
+  }
+}

package/samples/config.boom.txt

@@ -0,0 +1 @@
+{ app: { name: "My Application" version: "1.0.0" debug: false } database: { host: "localhost" port: 5432 name: "myapp_db" pool: { min: 2 max: 10 } } features: { darkMode: true notifications: true analytics: false } limits: [100 500 1000 5000] }

package/samples/config.json

@@ -0,0 +1,22 @@
+{
+  "app": {
+    "name": "My Application",
+    "version": "1.0.0",
+    "debug": false
+  },
+  "database": {
+    "host": "localhost",
+    "port": 5432,
+    "name": "myapp_db",
+    "pool": {
+      "min": 2,
+      "max": 10
+    }
+  },
+  "features": {
+    "darkMode": true,
+    "notifications": true,
+    "analytics": false
+  },
+  "limits": [100, 500, 1000, 5000]
+}

package/samples/users.boom.txt

@@ -0,0 +1 @@
+{ users: [ { id: 1 name: "Alice Johnson" email: "alice@example.com" role: "admin" active: true score: 95.5 } { id: 2 name: "Bob Smith" email: "bob@example.com" role: "user" active: true score: 88 } { id: 3 name: "Charlie Brown" email: "charlie@example.com" role: "user" active: false score: 72.5 } ] total: 3 page: 1 pageSize: 10 }

package/samples/users.json

@@ -0,0 +1,31 @@
+{
+  "users": [
+    {
+      "id": 1,
+      "name": "Alice Johnson",
+      "email": "alice@example.com",
+      "role": "admin",
+      "active": true,
+      "score": 95.5
+    },
+    {
+      "id": 2,
+      "name": "Bob Smith",
+      "email": "bob@example.com",
+      "role": "user",
+      "active": true,
+      "score": 88.0
+    },
+    {
+      "id": 3,
+      "name": "Charlie Brown",
+      "email": "charlie@example.com",
+      "role": "user",
+      "active": false,
+      "score": 72.5
+    }
+  ],
+  "total": 3,
+  "page": 1,
+  "pageSize": 10
+}