sdocs-dev 1.1.1 → 1.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Josh Summers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/bin/sdocs-dev.js

@@ -14,8 +14,51 @@ const path = require('path');
 const zlib = require('zlib');
 const { execSync } = require('child_process');
 const SDocYaml = require('../public/sdocs-yaml.js');
+const SDocStyles = require('../public/sdocs-styles.js');
+
+const https = require('https');
+const os    = require('os');
 
 const DEFAULT_URL = 'https://sdocs.dev';
+const VERSION = require('../package.json').version;
+
+// ── Update check (cached, every 3 days) ──────────────────
+
+const UPDATE_CACHE = path.join(os.homedir(), '.config', 'sdocs-dev', 'update-check.json');
+const THREE_DAYS = 3 * 86400000;
+
+function checkForUpdate() {
+  if (!process.stdout.isTTY || process.env.NO_UPDATE_NOTIFIER || process.env.CI) return;
+
+  // Skip if checked recently
+  try {
+    if (Date.now() - fs.statSync(UPDATE_CACHE).mtimeMs < THREE_DAYS) return;
+  } catch (_) {}
+
+  console.log('Checking for updates...');
+  https.get('https://registry.npmjs.org/-/package/sdocs-dev/dist-tags', { timeout: 3000 }, res => {
+    let data = '';
+    res.on('data', chunk => { data += chunk; });
+    res.on('end', () => {
+      try {
+        const latest = JSON.parse(data).latest;
+        // Update cache timestamp
+        fs.mkdirSync(path.dirname(UPDATE_CACHE), { recursive: true });
+        fs.writeFileSync(UPDATE_CACHE, JSON.stringify({ latest }));
+
+        const a = latest.split('.').map(Number);
+        const b = VERSION.split('.').map(Number);
+        let newer = false;
+        for (let i = 0; i < 3; i++) { if (a[i] > b[i]) { newer = true; break; } if (a[i] < b[i]) break; }
+        if (newer) {
+          console.log(`Update available: ${VERSION} \u2192 ${latest} \u2014 run \`npm i -g sdocs-dev\` to update`);
+        } else {
+          console.log(`Up to date (v${VERSION})`);
+        }
+      } catch (_) {}
+    });
+  }).on('error', () => {}).on('timeout', function () { this.destroy(); });
+}
 
 // ── Help ───────────────────────────────────────────────────
 const HELP = `
@@ -46,6 +89,8 @@ MODE FLAGS
 
 OPTIONS
   --section <heading>   Scroll to heading section on load
+  --light               Open in light theme
+  --dark                Open in dark theme
   --url <base>          Custom base URL (default: https://sdocs.dev)
   --mode <m>            Alias for --read / --write / --style / --raw
 
@@ -84,7 +129,7 @@ GENERAL
   baseFontSize  number   Base font size in px. All rem/em values scale from this.
                          Default: 16
   background    string   Page background color (hex).
-                         Default: "#ffffff" (light) / "#1c1a17" (dark)
+                         Default: "#ffffff" (light) / "#2c2a26" (dark)
   color         string   Master body text color (hex). Cascades to headings,
                          paragraphs, and lists unless those are overridden.
                          Default: "#1c1917"
@@ -135,6 +180,7 @@ BLOCKQUOTE
   blockquote:
     borderColor  string  Left border accent color. Default: "#2563eb"
     borderWidth  number  Left border thickness (px). Default: 3
+    background   string  Quote background color. Default: "#f7f5f2"
     color        string  Quote text color. Default: "#6b6560"
 
 COLOR CASCADE
@@ -158,7 +204,7 @@ THEME COLORS
       h1: { color: "#c0392b" }
       link: { color: "#2563eb" }
     dark:
-      background: "#1c1a17"
+      background: "#2c2a26"
       color: "#e7e5e2"
       h1: { color: "#ef6f5e" }
       link: { color: "#60a5fa" }
@@ -190,7 +236,7 @@ EXAMPLE — editorial article with colored heading tiers
       h2: { color: "#8e44ad" }
       h3: { color: "#16a085" }
       link: { color: "#e67e22", decoration: "underline" }
-      blockquote: { borderColor: "#c0392b", borderWidth: 4, color: "#7f8c8d" }
+      blockquote: { borderColor: "#c0392b", background: "#faf0eb", color: "#7f8c8d" }
     dark:
       background: "#1a1520"
       color: "#e7e5e2"
@@ -199,25 +245,41 @@ EXAMPLE — editorial article with colored heading tiers
       h2: { color: "#c490e4" }
       h3: { color: "#5ed4b8" }
       link: { color: "#f0a860", decoration: "underline" }
-      blockquote: { borderColor: "#ef6f5e", borderWidth: 4, color: "#9e9590" }
+      blockquote: { borderColor: "#ef6f5e", background: "#221a28", color: "#9e9590" }
   ---
 `;
 
-// ── Compression (deflate-raw + base64url) ─────────────────
+// ── Compression (brotli + base64url) ─────────────────
 
-function compressToBase64Url(text) {
-  const deflated = zlib.deflateRawSync(Buffer.from(text, 'utf-8'));
-  return deflated.toString('base64')
+function toBase64Url(buf) {
+  return Buffer.from(buf).toString('base64')
     .replace(/\+/g, '-')
     .replace(/\//g, '_')
     .replace(/=+$/, '');
 }
 
-function decompressFromBase64Url(b64url) {
+function fromBase64Url(b64url) {
   let b64 = b64url.replace(/-/g, '+').replace(/_/g, '/');
   const pad = (4 - b64.length % 4) % 4;
   b64 += '='.repeat(pad);
-  return zlib.inflateRawSync(Buffer.from(b64, 'base64')).toString('utf-8');
+  return Buffer.from(b64, 'base64');
+}
+
+function compressToBase64Url(text) {
+  const compressed = zlib.brotliCompressSync(Buffer.from(text, 'utf-8'), {
+    params: { [zlib.constants.BROTLI_PARAM_QUALITY]: 11 }
+  });
+  return toBase64Url(compressed);
+}
+
+function decompressFromBase64Url(b64url) {
+  const buf = fromBase64Url(b64url);
+  // Try brotli first, fall back to deflate for old URLs
+  try {
+    return zlib.brotliDecompressSync(buf).toString('utf-8');
+  } catch (_) {
+    return zlib.inflateRawSync(buf).toString('utf-8');
+  }
 }
 
 // ── Slugify ───────────────────────────────────────────────
@@ -237,6 +299,7 @@ function parseArgs(argv) {
   let url = null;
   let subcommand = null;
   let section = null;
+  let theme = null;
   let resetFlag = false;
 
   for (let i = 0; i < args.length; i++) {
@@ -251,6 +314,8 @@ function parseArgs(argv) {
     if (arg === '--style') { mode = 'style'; continue; }
     if (arg === '--raw')   { mode = 'raw';   continue; }
     if (arg === '--read')  { mode = 'read';  continue; }
+    if (arg === '--light') { theme = 'light'; continue; }
+    if (arg === '--dark')  { theme = 'dark';  continue; }
 
     // Long-form --mode
     if (arg === '--mode' || arg === '-m') {
@@ -280,7 +345,7 @@ function parseArgs(argv) {
     if (!file) { file = arg; continue; }
   }
 
-  return { file, mode, url, subcommand, section, resetFlag };
+  return { file, mode, url, subcommand, section, theme, resetFlag };
 }
 
 // ── Build URL ─────────────────────────────────────────────
@@ -290,6 +355,17 @@ function buildUrl(content, opts) {
   const params = new URLSearchParams();
 
   if (content) {
+    // Strip default style values to produce shorter URLs
+    const parsed = SDocYaml.parseFrontMatter(content);
+    if (parsed.meta && parsed.meta.styles) {
+      const stripped = SDocStyles.stripStyleDefaults(parsed.meta.styles);
+      if (Object.keys(stripped).length > 0) {
+        parsed.meta.styles = stripped;
+      } else {
+        delete parsed.meta.styles;
+      }
+      content = SDocYaml.serializeFrontMatter(parsed.meta) + '\n' + parsed.body;
+    }
     params.set('md', compressToBase64Url(content));
   } else if (opts.defaultStyles) {
     const stylesJson = JSON.stringify(opts.defaultStyles);
@@ -299,6 +375,8 @@ function buildUrl(content, opts) {
   const mode = opts.mode || (content ? 'read' : 'style');
   if (mode && mode !== 'read') params.set('mode', mode);
 
+  if (opts.theme) params.set('theme', opts.theme);
+
   if (opts.section) {
     params.set('sec', slugify(opts.section));
   }
@@ -457,6 +535,7 @@ if (require.main === module) {
     const url = buildUrl(content, {
       url: opts.url,
       mode: opts.mode,
+      theme: opts.theme,
       defaultStyles: !content ? defaults : null,
       section: opts.section,
     });
@@ -473,12 +552,14 @@ if (require.main === module) {
       } catch (_) {
         process.stdout.write(url + '\n');
       }
-      process.exit(0);
+      checkForUpdate();
+      return;
     }
 
     // Default: open browser
     openBrowser(url);
     console.log(`SDocs → ${url.length > 80 ? url.slice(0, 77) + '...' : url}`);
+    checkForUpdate();
   })().catch(e => {
     console.error('sdoc:', e.message);
     process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sdocs-dev",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Open, share, and style markdown files from the terminal",
   "main": "server.js",
   "bin": {
@@ -32,6 +32,9 @@
   },
   "homepage": "https://sdocs.dev",
   "dependencies": {
+    "brotli": "^1.3.3",
+    "brotli-dec-wasm": "^2.3.2",
+    "brotli-wasm": "^3.0.1",
     "marked": "^11.0.0"
   },
   "devDependencies": {