linkbreakers-cli 0.0.0-stage → 1.159.0

package/README.md

@@ -1,3 +1,24 @@
-# Temporary Holding Version
+# linkbreakers-cli
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Official command line interface for the [Linkbreakers](https://linkbreakers.com) API, packaged for npm.
+
+```bash
+npm install -g linkbreakers-cli
+linkbreakers version
+```
+
+On install, this package downloads the prebuilt `linkbreakers` binary for your platform (macOS, Linux and Windows on x64 or arm64) from [GitHub Releases](https://github.com/linkbreakers-com/linkbreakers-cli/releases) and verifies its SHA-256 against the release `checksums.txt`. If the download is skipped (for example with `--ignore-scripts`), it happens on first run instead.
+
+Looking for the TypeScript SDK? That is the [`linkbreakers`](https://www.npmjs.com/package/linkbreakers) package.
+
+## Quick start
+
+```bash
+export LINKBREAKERS_TOKEN=...   # workspace API token from the dashboard
+linkbreakers links create --destination https://example.com --wait-for-qrcode
+linkbreakers raw GET "/v1/visitors?pageSize=50"
+```
+
+Update with `npm install -g linkbreakers-cli@latest`.
+
+Full docs: https://linkbreakers.com/cli and https://github.com/linkbreakers-com/linkbreakers-cli

package/bin/linkbreakers.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+'use strict';
+
+const { spawnSync } = require('node:child_process');
+const { ensureBinary } = require('../lib/install');
+
+ensureBinary()
+  .then((bin) => {
+    const result = spawnSync(bin, process.argv.slice(2), { stdio: 'inherit', windowsHide: true });
+    if (result.error) throw result.error;
+    if (result.signal) process.kill(process.pid, result.signal);
+    process.exit(result.status ?? 1);
+  })
+  .catch((err) => {
+    console.error(`linkbreakers: ${err.message}`);
+    process.exit(1);
+  });

package/lib/install.js

@@ -0,0 +1,129 @@
+'use strict';
+
+const crypto = require('node:crypto');
+const fs = require('node:fs');
+const path = require('node:path');
+const zlib = require('node:zlib');
+
+const REPO = 'linkbreakers-com/linkbreakers-cli';
+const VENDOR_DIR = path.join(__dirname, '..', 'vendor');
+
+function target(platform = process.platform, arch = process.arch) {
+  const os = { darwin: 'darwin', linux: 'linux', win32: 'windows' }[platform];
+  const cpu = { x64: 'amd64', arm64: 'arm64' }[arch];
+  if (!os || !cpu) {
+    throw new Error(`unsupported platform ${platform}/${arch}; download a binary from https://github.com/${REPO}/releases`);
+  }
+  return { os, cpu, ext: os === 'windows' ? 'zip' : 'tar.gz', exe: os === 'windows' ? 'linkbreakers.exe' : 'linkbreakers' };
+}
+
+function binaryPath() {
+  return path.join(VENDOR_DIR, target().exe);
+}
+
+function packageVersion() {
+  return require('../package.json').version;
+}
+
+async function download(url) {
+  const res = await fetch(url, { headers: { 'User-Agent': 'linkbreakers-cli-npm' } });
+  if (!res.ok) throw new Error(`GET ${url} failed: ${res.status} ${res.statusText}`);
+  if (new URL(res.url).protocol !== 'https:') throw new Error(`refusing non-HTTPS download from ${res.url}`);
+  return Buffer.from(await res.arrayBuffer());
+}
+
+function expectedChecksum(checksums, archiveName) {
+  for (const line of checksums.split('\n')) {
+    const [sum, name] = line.trim().split(/\s+/);
+    if (name === archiveName) return sum;
+  }
+  throw new Error(`${archiveName} is missing from checksums.txt`);
+}
+
+function extractFromTarGz(archive, fileName) {
+  const tar = zlib.gunzipSync(archive);
+  let offset = 0;
+  while (offset + 512 <= tar.length) {
+    const header = tar.subarray(offset, offset + 512);
+    if (header.every((b) => b === 0)) break;
+    const name = header.toString('utf8', 0, 100).replace(/\0.*$/s, '');
+    const prefix = header.toString('utf8', 345, 500).replace(/\0.*$/s, '');
+    const size = parseInt(header.toString('utf8', 124, 136).replace(/\0.*$/s, '').trim() || '0', 8);
+    const type = String.fromCharCode(header[156]);
+    const fullName = prefix ? `${prefix}/${name}` : name;
+    offset += 512;
+    if ((type === '0' || type === '\0') && path.posix.basename(fullName) === fileName) {
+      return tar.subarray(offset, offset + size);
+    }
+    offset += Math.ceil(size / 512) * 512;
+  }
+  throw new Error(`${fileName} not found in archive`);
+}
+
+function extractFromZip(archive, fileName) {
+  const eocd = archive.lastIndexOf(Buffer.from([0x50, 0x4b, 0x05, 0x06]));
+  if (eocd < 0) throw new Error('invalid zip archive');
+  const entries = archive.readUInt16LE(eocd + 10);
+  let offset = archive.readUInt32LE(eocd + 16);
+  for (let i = 0; i < entries; i++) {
+    if (archive.readUInt32LE(offset) !== 0x02014b50) throw new Error('invalid zip central directory');
+    const method = archive.readUInt16LE(offset + 10);
+    const compressedSize = archive.readUInt32LE(offset + 20);
+    const nameLength = archive.readUInt16LE(offset + 28);
+    const extraLength = archive.readUInt16LE(offset + 30);
+    const commentLength = archive.readUInt16LE(offset + 32);
+    const localOffset = archive.readUInt32LE(offset + 42);
+    const name = archive.toString('utf8', offset + 46, offset + 46 + nameLength);
+    offset += 46 + nameLength + extraLength + commentLength;
+    if (path.posix.basename(name) !== fileName) continue;
+
+    const dataStart = localOffset + 30 + archive.readUInt16LE(localOffset + 26) + archive.readUInt16LE(localOffset + 28);
+    const data = archive.subarray(dataStart, dataStart + compressedSize);
+    if (method === 0) return data;
+    if (method === 8) return zlib.inflateRawSync(data);
+    throw new Error(`unsupported zip compression method ${method}`);
+  }
+  throw new Error(`${fileName} not found in archive`);
+}
+
+async function install() {
+  const version = packageVersion();
+  if (!version || version === '0.0.0') {
+    throw new Error('this package has no release version; install linkbreakers-cli from npm');
+  }
+  const t = target();
+  const archiveName = `linkbreakers-cli_${version}_${t.os}_${t.cpu}.${t.ext}`;
+  const base = `https://github.com/${REPO}/releases/download/v${version}`;
+
+  const [archive, checksums] = await Promise.all([
+    download(`${base}/${archiveName}`),
+    download(`${base}/checksums.txt`).then((b) => b.toString('utf8')),
+  ]);
+
+  const actual = crypto.createHash('sha256').update(archive).digest('hex');
+  const expected = expectedChecksum(checksums, archiveName);
+  if (actual !== expected) {
+    throw new Error(`checksum mismatch for ${archiveName}: expected ${expected}, got ${actual}`);
+  }
+
+  const binary = t.ext === 'zip' ? extractFromZip(archive, t.exe) : extractFromTarGz(archive, t.exe);
+  fs.mkdirSync(VENDOR_DIR, { recursive: true });
+  const dest = path.join(VENDOR_DIR, t.exe);
+  const tmp = `${dest}.${process.pid}.tmp`;
+  try {
+    fs.writeFileSync(tmp, binary, { mode: 0o755 });
+    fs.renameSync(tmp, dest);
+  } catch (err) {
+    fs.rmSync(tmp, { force: true });
+    throw err;
+  }
+  return dest;
+}
+
+async function ensureBinary() {
+  const bin = binaryPath();
+  if (fs.existsSync(bin)) return bin;
+  return install();
+}
+
+module.exports = { ensureBinary, install, target, expectedChecksum, extractFromTarGz, extractFromZip };

package/lib/postinstall.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const { install } = require('./install');
+
+install().catch((err) => {
+  console.warn(`linkbreakers-cli: could not download the linkbreakers binary during install (${err.message}).`);
+  console.warn('linkbreakers-cli: it will be downloaded on first run instead.');
+});

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "linkbreakers-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.159.0",
+  "description": "Official CLI for the Linkbreakers API. Installs the prebuilt linkbreakers binary for your platform.",
+  "keywords": [
+    "linkbreakers",
+    "cli",
+    "qr-code",
+    "lead-capture",
+    "links"
+  ],
+  "homepage": "https://linkbreakers.com/cli",
+  "bugs": "https://github.com/linkbreakers-com/linkbreakers-cli/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/linkbreakers-com/linkbreakers-cli.git",
+    "directory": "npm"
+  },
+  "license": "MIT",
+  "author": "Linkbreakers <support@linkbreakers.com>",
+  "bin": {
+    "linkbreakers": "bin/linkbreakers.js"
+  },
+  "files": [
+    "bin/",
+    "lib/install.js",
+    "lib/postinstall.js",
+    "README.md"
+  ],
+  "scripts": {
+    "postinstall": "node lib/postinstall.js",
+    "test": "node --test lib/install.test.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ]
+}