@officecli/officecli 1.0.102 → 1.0.122

package/README.md

@@ -1,3 +1,35 @@
-# @officecli/officecli
+# officecli
 
-Placeholder package. Work in progress.
+CLI for reading and writing Office documents (`.docx`, `.xlsx`, `.pptx`) via a
+document DOM API.
+
+```bash
+npm install -g @officecli/officecli
+# or run without installing:
+npx @officecli/officecli --help
+```
+
+On install, the native binary for your platform (macOS / Linux / Windows,
+x64 / arm64) is downloaded from the official release mirror
+(`d.officecli.ai`, with GitHub Releases as a fallback) and verified against
+its published `SHA256SUMS`. macOS builds are Developer ID signed and notarized.
+
+## Usage
+
+```bash
+officecli create report.docx
+officecli add report.docx /body --type paragraph --prop text="Hello"
+officecli get report.docx '/body/p[1]'
+officecli --help
+```
+
+## Notes
+
+- Supported platforms: macOS (arm64/x64), Linux glibc & musl/Alpine
+  (arm64/x64), Windows (arm64/x64).
+- Set `OFFICECLI_SKIP_BINARY_DOWNLOAD=1` to skip the download during
+  `npm install` (the binary is then fetched on first run).
+- Source, issues and full docs:
+  <https://github.com/iOfficeAI/OfficeCLI>
+
+Licensed under Apache-2.0.

package/install.js

@@ -0,0 +1,21 @@
+'use strict';
+
+// postinstall entry point. Downloads the platform binary up-front so the first
+// `officecli` call is instant. A failure here is non-fatal: the bin shim
+// (bin/officecli.js) lazily downloads on first run, so an offline/proxied
+// install still leaves a working command once connectivity returns. Set
+// OFFICECLI_SKIP_BINARY_DOWNLOAD=1 to skip the download entirely.
+
+if (process.env.OFFICECLI_SKIP_BINARY_DOWNLOAD) {
+  process.stderr.write('[officecli] OFFICECLI_SKIP_BINARY_DOWNLOAD set, skipping binary download.\n');
+  process.exit(0);
+}
+
+require('./lib/install-binary')
+  .ensureBinary()
+  .catch(function (err) {
+    process.stderr.write('[officecli] postinstall could not fetch the binary: ' + err.message + '\n');
+    process.stderr.write('[officecli] it will be downloaded on first run instead.\n');
+    // Exit 0 so `npm install` succeeds; the shim retries lazily.
+    process.exit(0);
+  });

package/lib/install-binary.js

@@ -0,0 +1,247 @@
+'use strict';
+
+// Shared installer logic for the @officecli/officecli (and @aionui/officecli)
+// npm packages. The package itself ships no native code: on install it fetches
+// the platform binary from the SAME release mirror install.sh uses
+// (d.officecli.ai primary, GitHub releases fallback), pinned to the IMMUTABLE
+// versioned path so a freshly-published release never collides with a CDN-cached
+// `latest`. Asset names and the mirror/fallback order mirror install.sh exactly.
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const https = require('https');
+const crypto = require('crypto');
+const { execSync } = require('child_process');
+
+const REPO = 'iOfficeAI/OfficeCLI';
+const MIRROR_BASE = 'https://d.officecli.ai';
+const GITHUB_BASE = 'https://github.com/' + REPO;
+
+// The package version is set to the release version at publish time, so the
+// tag we download from is derived directly from it (immutable, never stale).
+const VERSION = require('../package.json').version;
+const TAG = 'v' + VERSION;
+
+const PKG_ROOT = path.join(__dirname, '..');
+const BIN_DIR = path.join(PKG_ROOT, 'bin');
+
+function log(msg) {
+  // postinstall output goes to stderr so it never pollutes a command's stdout.
+  process.stderr.write('[officecli] ' + msg + '\n');
+}
+
+// musl detection, mirroring install.sh's gnu-vs-musl branch. process.report
+// exposes glibcVersionRuntime on a glibc system; its absence (plus the Alpine
+// marker / `ldd` text) means musl.
+function isMusl() {
+  if (process.platform !== 'linux') return false;
+  try {
+    const report = process.report && process.report.getReport();
+    const header = report && report.header;
+    if (header && header.glibcVersionRuntime) return false;
+    if (header && header.glibcVersionRuntime === undefined) {
+      // No glibc runtime reported — treat as musl, but confirm below.
+    }
+  } catch (_) { /* fall through to filesystem/ldd probes */ }
+  try {
+    if (fs.existsSync('/etc/alpine-release')) return true;
+  } catch (_) { /* ignore */ }
+  try {
+    const out = execSync('ldd --version 2>&1 || true', { encoding: 'utf8' });
+    if (/musl/i.test(out)) return true;
+  } catch (_) { /* ignore */ }
+  // Default to glibc when nothing positively indicates musl.
+  return false;
+}
+
+function detectAsset() {
+  const platform = process.platform;
+  const arch = process.arch;
+  if (platform === 'darwin') {
+    if (arch === 'arm64') return 'officecli-mac-arm64';
+    if (arch === 'x64') return 'officecli-mac-x64';
+  } else if (platform === 'linux') {
+    const musl = isMusl();
+    if (arch === 'x64') return musl ? 'officecli-linux-alpine-x64' : 'officecli-linux-x64';
+    if (arch === 'arm64') return musl ? 'officecli-linux-alpine-arm64' : 'officecli-linux-arm64';
+  } else if (platform === 'win32') {
+    if (arch === 'x64') return 'officecli-win-x64.exe';
+    if (arch === 'arm64') return 'officecli-win-arm64.exe';
+  }
+  throw new Error(
+    'Unsupported platform: ' + platform + ' ' + arch +
+    '. Download manually from ' + GITHUB_BASE + '/releases'
+  );
+}
+
+function binaryName() {
+  return process.platform === 'win32' ? 'officecli.exe' : 'officecli';
+}
+
+function binaryPath() {
+  return path.join(BIN_DIR, binaryName());
+}
+
+function assetUrls(asset) {
+  // Mirror first (issues surface fast), GitHub fallback — same order as
+  // install.sh. Both use the immutable /releases/download/<tag>/ path.
+  return [
+    MIRROR_BASE + '/releases/download/' + TAG + '/' + asset,
+    GITHUB_BASE + '/releases/download/' + TAG + '/' + asset
+  ];
+}
+
+function sumsUrls() {
+  return [
+    MIRROR_BASE + '/releases/download/' + TAG + '/SHA256SUMS',
+    GITHUB_BASE + '/releases/download/' + TAG + '/SHA256SUMS'
+  ];
+}
+
+function httpGet(url, onResponse, onError, redirects) {
+  redirects = redirects || 0;
+  if (redirects > 10) {
+    onError(new Error('Too many redirects for ' + url));
+    return;
+  }
+  const req = https.get(
+    url,
+    { headers: { 'User-Agent': 'officecli-npm-installer' } },
+    function (res) {
+      const code = res.statusCode;
+      if (code >= 300 && code < 400 && res.headers.location) {
+        res.resume();
+        const next = new URL(res.headers.location, url).toString();
+        httpGet(next, onResponse, onError, redirects + 1);
+        return;
+      }
+      if (code !== 200) {
+        res.resume();
+        onError(new Error('HTTP ' + code + ' for ' + url));
+        return;
+      }
+      onResponse(res);
+    }
+  );
+  req.on('error', onError);
+  req.setTimeout(300000, function () {
+    req.destroy(new Error('Timeout downloading ' + url));
+  });
+}
+
+function fetchToFile(url, dest) {
+  return new Promise(function (resolve, reject) {
+    httpGet(
+      url,
+      function (res) {
+        const tmp = dest + '.download';
+        const out = fs.createWriteStream(tmp);
+        res.pipe(out);
+        out.on('error', reject);
+        out.on('finish', function () {
+          out.close(function () {
+            try {
+              fs.renameSync(tmp, dest);
+              resolve();
+            } catch (e) {
+              reject(e);
+            }
+          });
+        });
+      },
+      reject
+    );
+  });
+}
+
+function fetchBuffer(url) {
+  return new Promise(function (resolve, reject) {
+    httpGet(
+      url,
+      function (res) {
+        const chunks = [];
+        res.on('data', function (c) { chunks.push(c); });
+        res.on('end', function () { resolve(Buffer.concat(chunks)); });
+        res.on('error', reject);
+      },
+      reject
+    );
+  });
+}
+
+async function verifyChecksum(asset, file) {
+  let sums = null;
+  for (const url of sumsUrls()) {
+    try {
+      sums = (await fetchBuffer(url)).toString('utf8');
+      break;
+    } catch (_) { /* try next source */ }
+  }
+  if (!sums) {
+    log('  SHA256SUMS not available, skipping checksum verification.');
+    return;
+  }
+  // SHA256SUMS rows are "<hex>  <name>" (sha256sum text mode). Match the
+  // filename column EXACTLY (a leading '*' marks binary mode), never a
+  // substring — same rule as install.sh / the C# self-updater.
+  let expected = null;
+  for (const line of sums.split('\n')) {
+    const parts = line.trim().split(/\s+/);
+    if (parts.length >= 2) {
+      const name = parts[1].replace(/^\*/, '');
+      if (name === asset) { expected = parts[0]; break; }
+    }
+  }
+  if (!expected) {
+    log('  ' + asset + ' not listed in SHA256SUMS, skipping verification.');
+    return;
+  }
+  const actual = crypto.createHash('sha256').update(fs.readFileSync(file)).digest('hex');
+  if (actual.toLowerCase() !== expected.toLowerCase()) {
+    throw new Error('Checksum mismatch for ' + asset + ' (expected ' + expected + ', got ' + actual + ')');
+  }
+  log('  checksum verified.');
+}
+
+// Download the platform binary into bin/ if it is not already present.
+// Idempotent: a non-empty binary is treated as already installed (the package
+// version pins the release, so existence is sufficient).
+async function ensureBinary() {
+  const dest = binaryPath();
+  if (fs.existsSync(dest) && fs.statSync(dest).size > 0) {
+    return dest;
+  }
+  fs.mkdirSync(BIN_DIR, { recursive: true });
+  const asset = detectAsset();
+  let lastErr = null;
+  for (const url of assetUrls(asset)) {
+    try {
+      log('Downloading ' + asset + ' (' + TAG + ') from ' + url + ' ...');
+      await fetchToFile(url, dest);
+      await verifyChecksum(asset, dest);
+      if (process.platform !== 'win32') {
+        fs.chmodSync(dest, 0o755);
+      }
+      log('OfficeCLI ' + VERSION + ' installed.');
+      return dest;
+    } catch (e) {
+      lastErr = e;
+      try { fs.rmSync(dest, { force: true }); } catch (_) { /* ignore */ }
+      log('  failed: ' + e.message);
+    }
+  }
+  throw new Error(
+    'Could not download OfficeCLI binary (' + asset + ' @ ' + TAG + '). ' +
+    'Last error: ' + (lastErr && lastErr.message) +
+    '. Install manually from ' + GITHUB_BASE + '/releases'
+  );
+}
+
+module.exports = {
+  ensureBinary: ensureBinary,
+  binaryPath: binaryPath,
+  detectAsset: detectAsset,
+  VERSION: VERSION,
+  TAG: TAG
+};

package/package.json

@@ -1,7 +1,50 @@
 {
   "name": "@officecli/officecli",
-  "version": "1.0.102",
-  "description": "OfficeCli — placeholder, work in progress.",
+  "version": "1.0.122",
+  "description": "OfficeCli — CLI for reading and writing Office documents (.docx, .xlsx, .pptx) via a document DOM API. The native binary is fetched on install for your platform.",
   "license": "Apache-2.0",
-  "author": "goworm"
+  "author": "goworm",
+  "homepage": "https://github.com/iOfficeAI/OfficeCLI",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iOfficeAI/OfficeCLI.git"
+  },
+  "bugs": {
+    "url": "https://github.com/iOfficeAI/OfficeCLI/issues"
+  },
+  "keywords": [
+    "office",
+    "docx",
+    "xlsx",
+    "pptx",
+    "word",
+    "excel",
+    "powerpoint",
+    "ooxml",
+    "cli"
+  ],
+  "bin": {
+    "officecli": "bin/officecli.js"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
+  },
+  "files": [
+    "bin/officecli.js",
+    "lib/install-binary.js",
+    "install.js",
+    "README.md"
+  ],
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "engines": {
+    "node": ">=14"
+  }
 }