@sinch/cli 0.4.17 → 0.5.0

package/README.md

@@ -14,15 +14,26 @@ The Sinch CLI is your unified developer tool for managing all Sinch products. Cu
 ```bash
 # Install
 npm install -g @sinch/cli
-
-# Dev channel (bleeding edge - latest from main branch)
-npm install -g @sinch/cli@dev
 ```
 
 **Installation Channels:**
 
-- **`@latest`** (default) - Production-ready stable releases
-- **`@dev`** - Cutting-edge builds from main branch (auto-published on every commit)
+- **`@latest`** (default) - Production-ready stable releases published to npmjs
+- **`@dev`** - Cutting-edge builds auto-published to the [GitLab project registry](https://gitlab.com/sinch/sinch-projects/voice/functions/sinch-cli/-/packages) on every push
+
+**How it works — per-architecture packages:**
+
+`@sinch/cli` is a thin launcher. The actual binary ships in a platform-specific package that npm selects automatically at install time:
+
+| Package                   | Platform                        |
+| ------------------------- | ------------------------------- |
+| `@sinch/cli-linux-x64`    | Linux x64                       |
+| `@sinch/cli-linux-arm64`  | Linux ARM64                     |
+| `@sinch/cli-darwin-x64`   | macOS Intel                     |
+| `@sinch/cli-darwin-arm64` | macOS Apple Silicon             |
+| `@sinch/cli-win32-x64`    | Windows x64 / ARM64 (emulation) |
+
+This is the same model used by esbuild and Biome. No install scripts run — `npm install --ignore-scripts` works fine. Do **not** use `--omit=optional`; the platform binary is an optional dependency and the CLI will print an actionable error if it is missing.
 
 ## Prerequisites
 
@@ -216,9 +227,26 @@ DEBUG=3 sinch functions dev       # Full debug with headers
 ### Common Issues
 
 - **Command not found**: Reinstall globally with `npm install -g @sinch/cli`
+- **"platform package not installed" error**: Your package manager skipped optional dependencies. Reinstall without `--omit=optional`: `npm install -g @sinch/cli`
 - **Authentication failed**: Check your Sinch API credentials with `sinch auth status`
 - **Deployment failed**: Verify your function configuration and project access
 
+## Development
+
+See [docs/DEVELOPMENT.md](./docs/DEVELOPMENT.md) for the full contributor guide.
+
+**Quick start:**
+
+```bash
+npm install
+npm run build
+npm run setup   # copies binary to ~/.sinch/bin/ and installs completions
+```
+
+**Escape hatch — force a specific binary:**
+
+`SINCH_CLI_BINARY=/path/to/binary sinch <cmd>` bypasses platform-package resolution and runs the given binary directly. Useful when testing a locally built binary or a downloaded release without installing the npm package.
+
 ## Support
 
 - **Documentation**: [Full CLI Documentation](./docs/README.md)

package/bin/platform-resolver.js

@@ -1,61 +1,88 @@
 const fs = require('fs');
 const path = require('path');
 
-const PLATFORM_BINARIES = {
-  'darwin-arm64': { artifactName: 'sinch-darwin-arm64' },
-  'darwin-x64': { artifactName: 'sinch-darwin-x64' },
-  'linux-arm64': { artifactName: 'sinch-linux-arm64' },
-  'linux-x64': { artifactName: 'sinch-linux-x64' },
-  'win32-arm64': { artifactName: 'sinch-windows-x64.exe' },
-  'win32-x64': { artifactName: 'sinch-windows-x64.exe' },
+// win32-arm64 deliberately maps to the x64 package: Bun cannot target
+// windows-arm64, and the x64 exe runs under Windows ARM emulation.
+const PLATFORM_PACKAGES = {
+  'darwin-arm64': { packageName: '@sinch/cli-darwin-arm64', binaryName: 'sinch' },
+  'darwin-x64': { packageName: '@sinch/cli-darwin-x64', binaryName: 'sinch' },
+  'linux-arm64': { packageName: '@sinch/cli-linux-arm64', binaryName: 'sinch' },
+  'linux-x64': { packageName: '@sinch/cli-linux-x64', binaryName: 'sinch' },
+  'win32-arm64': { packageName: '@sinch/cli-win32-x64', binaryName: 'sinch.exe' },
+  'win32-x64': { packageName: '@sinch/cli-win32-x64', binaryName: 'sinch.exe' },
 };
 
 function getPlatformKey(platform = process.platform, arch = process.arch) {
   return `${platform}-${arch}`;
 }
 
-function getPlatformBinaryInfo(platform = process.platform, arch = process.arch) {
-  return PLATFORM_BINARIES[getPlatformKey(platform, arch)] ?? null;
+function getPlatformPackageInfo(platform = process.platform, arch = process.arch) {
+  return PLATFORM_PACKAGES[getPlatformKey(platform, arch)] ?? null;
 }
 
-function buildMissingBinaryMessage(platform, arch, binaryPath) {
-  const binaryHint = binaryPath
-    ? `Expected binary at ${binaryPath}.`
-    : 'No binary mapping is defined for this platform.';
-
-  return [
-    `Sinch CLI does not have an installed binary for ${platform}-${arch}.`,
-    binaryHint,
-    'Common causes: unsupported platform, install scripts were disabled, or the binary download failed.',
-    'Try reinstalling with: npm install -g @sinch/cli',
-  ].join(' ');
+function buildMissingBinaryMessage(platform, arch, packageName) {
+  if (!packageName) {
+    return (
+      `Sinch CLI: no prebuilt binary exists for ${platform}-${arch}. ` +
+      'Supported platforms: linux-x64, linux-arm64, darwin-x64, darwin-arm64, win32-x64, win32-arm64.'
+    );
+  }
+  return (
+    `Sinch CLI: the platform package ${packageName} for ${platform}-${arch} is not installed. ` +
+    'Common causes: npm ran with --omit=optional, or the package manager skipped optional dependencies. ' +
+    'Fix: reinstall with optional dependencies enabled: npm install -g @sinch/cli'
+  );
+}
+
+function findPackageJson(packageName, basedir) {
+  let dir = basedir;
+  for (;;) {
+    // path.join handles the '@scope/name' forward slash correctly on all platforms
+    const candidate = path.join(dir, 'node_modules', packageName, 'package.json');
+    if (fs.existsSync(candidate)) return candidate;
+    const parent = path.dirname(dir);
+    if (parent === dir) return null;
+    dir = parent;
+  }
 }
 
 function resolveInstalledBinaryPath(
-  packageRoot = path.join(__dirname, '..'),
+  basedir = __dirname,
   platform = process.platform,
   arch = process.arch
 ) {
-  const binaryInfo = getPlatformBinaryInfo(platform, arch);
-  if (!binaryInfo) {
+  // Developer/test escape hatch. Validate the override is a real file so a
+  // typo'd path fails here with a clear message instead of an opaque spawn ENOENT.
+  if (process.env.SINCH_CLI_BINARY) {
+    const overridePath = process.env.SINCH_CLI_BINARY;
+    if (!fs.statSync(overridePath, { throwIfNoEntry: false })?.isFile()) {
+      throw new Error(`SINCH_CLI_BINARY is set to ${overridePath} but no file exists there.`);
+    }
+    return { binaryPath: overridePath, packageName: null };
+  }
+
+  const info = getPlatformPackageInfo(platform, arch);
+  if (!info) {
     throw new Error(buildMissingBinaryMessage(platform, arch, null));
   }
 
-  const binaryPath = path.join(packageRoot, 'dist', binaryInfo.artifactName);
-  if (!fs.existsSync(binaryPath)) {
-    throw new Error(buildMissingBinaryMessage(platform, arch, binaryPath));
+  const packageJsonPath = findPackageJson(info.packageName, basedir);
+  if (!packageJsonPath) {
+    throw new Error(buildMissingBinaryMessage(platform, arch, info.packageName));
+  }
+
+  const binaryPath = path.join(path.dirname(packageJsonPath), 'bin', info.binaryName);
+  if (!fs.statSync(binaryPath, { throwIfNoEntry: false })?.isFile()) {
+    throw new Error(buildMissingBinaryMessage(platform, arch, info.packageName));
   }
 
-  return {
-    binaryPath,
-    artifactName: binaryInfo.artifactName,
-  };
+  return { binaryPath, packageName: info.packageName };
 }
 
 module.exports = {
-  PLATFORM_BINARIES,
+  PLATFORM_PACKAGES,
   getPlatformKey,
-  getPlatformBinaryInfo,
+  getPlatformPackageInfo,
   buildMissingBinaryMessage,
   resolveInstalledBinaryPath,
 };

package/bin/sinch

@@ -18,7 +18,7 @@ function main(argv = process.argv.slice(2)) {
   });
 
   child.on('error', (error) => {
-    console.error(`Failed to launch ${resolved.artifactName}: ${error.message}`);
+    console.error(`Failed to launch ${resolved.binaryPath}: ${error.message}`);
     process.exit(1);
   });
 

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "@sinch/cli",
-  "version": "0.4.17",
+  "version": "0.5.0",
   "description": "Official Sinch CLI - Manage all Sinch products from your terminal",
   "main": "bin/sinch",
   "bin": {
     "sinch": "bin/sinch"
   },
   "files": [
-    "bin/",
-    "scripts/postinstall.js",
+    "bin/sinch",
+    "bin/platform-resolver.js",
     "README.md",
     "LICENSE"
   ],
-  "scripts": {
-    "postinstall": "node scripts/postinstall.js"
+  "optionalDependencies": {
+    "@sinch/cli-linux-x64": "0.5.0",
+    "@sinch/cli-linux-arm64": "0.5.0",
+    "@sinch/cli-darwin-x64": "0.5.0",
+    "@sinch/cli-darwin-arm64": "0.5.0",
+    "@sinch/cli-win32-x64": "0.5.0"
   },
   "author": "Sinch <support@sinch.com> (https://www.sinch.com)",
   "license": "MIT",

package/scripts/postinstall.js

@@ -1,341 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * postinstall.js — runs on `npm install -g @sinch/cli`
- *
- * 1. Downloads the platform binary from Cloudflare R2
- * 2. Writes ~/.sinch/completions.json (command tree for PowerShell)
- * 3. Installs shell completion into the user's profile (PowerShell, zsh, or bash)
- *
- * Keep COMPLETION_COMMANDS in sync with src/index.ts.
- */
-
-const fs = require('fs');
-const path = require('path');
-const os = require('os');
-const https = require('https');
-const { spawn, spawnSync } = require('child_process');
-const { getPlatformBinaryInfo } = require('../bin/platform-resolver');
-
-const SINCH_DIR = path.join(os.homedir(), '.sinch');
-const R2_PUBLIC_URL = 'https://pub-8e148a1cd144409aa2c332e3d724f317.r2.dev';
-
-const COMPLETION_COMMANDS = {
-  functions: ['init', 'list', 'deploy', 'download', 'dev', 'status', 'logs', 'delete', 'docs'],
-  templates: ['list', 'show', 'node', 'csharp', 'python'],
-  voice: ['applications', 'callouts', 'calls', 'conferences'],
-  secrets: ['list', 'add', 'get', 'delete', 'clear'],
-  auth: ['login', 'status', 'logout'],
-  sip: ['trunks', 'endpoints', 'acls', 'countries', 'credential-lists', 'calls'],
-  numbers: ['active', 'available', 'regions'],
-  fax: ['send', 'list', 'get', 'cancel', 'auth-status', 'status'],
-  conversation: ['send', 'messages', 'contacts', 'conversations', 'apps', 'webhooks'],
-  skills: ['install', 'list', 'uninstall', 'update'],
-  porting: ['check', 'config', 'orders', 'documents', 'activation'],
-  config: ['--set', '--get', '--list'],
-  completion: ['--shell', '--install'],
-};
-
-const SENTINEL_START = '# ── Sinch CLI completion ──';
-const SENTINEL_END = '# ── End Sinch CLI completion ──';
-
-function getVersion() {
-  try {
-    const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8'));
-    return pkg.version || '0.0.0';
-  } catch {
-    return '0.0.0';
-  }
-}
-
-function writeCompletionsJson(version) {
-  const filePath = path.join(SINCH_DIR, 'completions.json');
-  fs.writeFileSync(filePath, JSON.stringify({ version, commands: COMPLETION_COMMANDS }, null, 2));
-}
-
-function getPowerShellCompletionScript() {
-  return `${SENTINEL_START}
-# PowerShell completion for Sinch CLI
-# Reads command tree from ~/.sinch/completions.json (auto-updated by CLI)
-
-Register-ArgumentCompleter -Native -CommandName sinch -ScriptBlock {
-    param($wordToComplete, $commandAst, $cursorPosition)
-
-    try {
-        $jsonPath = Join-Path $env:USERPROFILE '.sinch' 'completions.json'
-        if (-not (Test-Path $jsonPath)) { return }
-
-        $data = Get-Content $jsonPath -Raw | ConvertFrom-Json
-        $line = $commandAst.CommandElements
-        $command = if ($line.Count -gt 1) { $line[1].Value } else { "" }
-
-        if ($line.Count -eq 2) {
-            $mainCommands = @($data.commands.PSObject.Properties.Name) + @('--version', '--help')
-            $mainCommands | Where-Object { $_ -like "$wordToComplete*" } | ForEach-Object {
-                [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
-            }
-        }
-        elseif ($line.Count -eq 3 -and $data.commands.$command) {
-            @($data.commands.$command) | Where-Object { $_ -like "$wordToComplete*" } | ForEach-Object {
-                [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
-            }
-        }
-    }
-    catch {
-        # Silently fail — prevents PowerShell startup errors
-    }
-}
-${SENTINEL_END}`;
-}
-
-// Twin of generateBashCompletionFile in src/index.ts — keep in sync.
-function generateBashCompletionFile() {
-  const mainCmds = Object.keys(COMPLETION_COMMANDS).join(' ') + ' --version --help';
-  const cases = Object.entries(COMPLETION_COMMANDS)
-    .map(
-      ([cmd, subs]) =>
-        `            ${cmd}) COMPREPLY=( $(compgen -W "${subs.join(' ')}" -- "$cur") ) ;;`
-    )
-    .join('\n');
-
-  return `# Bash/Zsh completion for Sinch CLI (auto-generated — do not edit)
-_sinch_completion() {
-    local cur prev
-    COMPREPLY=()
-    cur="\${COMP_WORDS[COMP_CWORD]}"
-    prev="\${COMP_WORDS[COMP_CWORD-1]}"
-
-    case "\${COMP_CWORD}" in
-        1)
-            COMPREPLY=( $(compgen -W "${mainCmds}" -- "$cur") )
-            ;;
-        2)
-            case "\${prev}" in
-${cases}
-            esac
-            ;;
-    esac
-}
-
-complete -F _sinch_completion sinch
-`;
-}
-
-function shellEscapePath(p) {
-  return "'" + p.replace(/'/g, "'\\''") + "'";
-}
-
-function stripManagedBlocks(content) {
-  let nextContent = content;
-  let startIndex = nextContent.indexOf(SENTINEL_START);
-
-  while (startIndex !== -1) {
-    const lineStart = nextContent.lastIndexOf('\n', startIndex - 1) + 1;
-    const endIndex = nextContent.indexOf(SENTINEL_END, startIndex);
-    let removalEnd = endIndex === -1 ? nextContent.length : endIndex + SENTINEL_END.length;
-
-    if (nextContent.slice(removalEnd, removalEnd + 2) === '\r\n') {
-      removalEnd += 2;
-    } else if (nextContent[removalEnd] === '\n') {
-      removalEnd += 1;
-    }
-
-    nextContent = nextContent.slice(0, lineStart) + nextContent.slice(removalEnd);
-    startIndex = nextContent.indexOf(SENTINEL_START);
-  }
-
-  return nextContent.replace(/\n{3,}/g, '\n\n').trimEnd();
-}
-
-function upsertBlock(content, block) {
-  const normalizedBlock = block.trim();
-  const strippedContent = stripManagedBlocks(content);
-
-  if (!strippedContent) {
-    return normalizedBlock + '\n';
-  }
-
-  return `${strippedContent}\n\n${normalizedBlock}\n`;
-}
-
-function tryShell(cmd) {
-  return new Promise((resolve) => {
-    const ps = spawn(cmd, ['-NoProfile', '-Command', '$PROFILE'], {
-      stdio: ['ignore', 'pipe', 'pipe'],
-    });
-    let out = '';
-    ps.stdout.on('data', (d) => (out += d.toString()));
-    ps.on('close', (code) => resolve(code === 0 ? out.trim() : null));
-    ps.on('error', () => resolve(null));
-  });
-}
-
-async function installPowerShellCompletion() {
-  const completionFile = path.join(SINCH_DIR, 'sinch-completion.ps1');
-  fs.writeFileSync(completionFile, getPowerShellCompletionScript());
-
-  const profilePath = (await tryShell('pwsh')) ?? (await tryShell('powershell'));
-  if (!profilePath) return;
-
-  const resolved = path.resolve(profilePath);
-  if (!resolved.startsWith(os.homedir())) return;
-
-  fs.mkdirSync(path.dirname(resolved), { recursive: true });
-
-  let content = '';
-  try {
-    content = fs.readFileSync(resolved, 'utf8');
-  } catch {}
-
-  const sourceLine = `. ${shellEscapePath(completionFile.replace(/\\/g, '\\\\'))}`;
-  const block = `${SENTINEL_START}\n${sourceLine}\n${SENTINEL_END}`;
-  fs.writeFileSync(resolved, upsertBlock(content, block));
-}
-
-function installBashZshCompletion() {
-  const completionFile = path.join(SINCH_DIR, 'sinch-completion.bash');
-  fs.writeFileSync(completionFile, generateBashCompletionFile());
-
-  const sourceLine = `source ${shellEscapePath(completionFile)}`;
-  const block = `${SENTINEL_START}\n${sourceLine}\n${SENTINEL_END}`;
-
-  const home = os.homedir();
-  const zshrc = path.join(home, '.zshrc');
-  const bashrc = path.join(home, '.bashrc');
-
-  const rcFiles = [];
-  if (process.platform === 'darwin') {
-    rcFiles.push(zshrc);
-    if (fs.existsSync(bashrc)) rcFiles.push(bashrc);
-  } else {
-    if (fs.existsSync(bashrc)) rcFiles.push(bashrc);
-    if (fs.existsSync(zshrc)) rcFiles.push(zshrc);
-    if (rcFiles.length === 0) rcFiles.push(bashrc);
-  }
-
-  for (const rcFile of rcFiles) {
-    let content = '';
-    try {
-      content = fs.readFileSync(rcFile, 'utf8');
-    } catch {}
-    fs.writeFileSync(rcFile, upsertBlock(content, block));
-  }
-}
-
-function downloadFile(url, dest) {
-  return new Promise((resolve, reject) => {
-    const get = (requestUrl) => {
-      https
-        .get(requestUrl, (response) => {
-          if (
-            response.statusCode >= 300 &&
-            response.statusCode < 400 &&
-            response.headers.location
-          ) {
-            get(response.headers.location);
-            return;
-          }
-
-          if (response.statusCode !== 200) {
-            reject(new Error(`Download failed: ${response.statusCode} from ${requestUrl}`));
-            return;
-          }
-
-          const file = fs.createWriteStream(dest);
-          response.pipe(file);
-          file.on('finish', () => {
-            file.close();
-            resolve();
-          });
-          file.on('error', reject);
-        })
-        .on('error', reject);
-    };
-
-    get(url);
-  });
-}
-
-async function downloadBinary(version) {
-  const binaryInfo = getPlatformBinaryInfo();
-  if (!binaryInfo) {
-    return;
-  }
-
-  const pkgRoot = path.join(__dirname, '..');
-  const distDir = path.join(pkgRoot, 'dist');
-  const dest = path.join(distDir, binaryInfo.artifactName);
-  if (fs.existsSync(dest)) {
-    return;
-  }
-
-  fs.mkdirSync(distDir, { recursive: true });
-  const url = `${R2_PUBLIC_URL}/v${version}/${binaryInfo.artifactName}`;
-
-  try {
-    await downloadFile(url, dest);
-    if (!dest.endsWith('.exe')) {
-      fs.chmodSync(dest, 0o755);
-    }
-  } catch (error) {
-    try {
-      fs.rmSync(dest, { force: true });
-    } catch {}
-    console.error(`Failed to download Sinch CLI binary: ${error.message}`);
-    console.error(`Source: ${url}`);
-  }
-}
-
-// Detect-only — never install. We deliberately do NOT shell out to apt/dnf/etc
-// here: needs sudo, distro-specific, and may trigger corporate EDR. The user
-// gets a one-shot hint at install time; from there it's their call.
-function warnIfLinuxKeychainMissing() {
-  if (process.platform !== 'linux') return;
-  try {
-    const probe = spawnSync('secret-tool', ['--version'], { stdio: 'ignore' });
-    if (probe.status === 0) return;
-  } catch {
-    // ENOENT → fall through to warning
-  }
-  process.stderr.write(
-    '\n  ⚠️  libsecret-tools is not installed. Sinch CLI needs `secret-tool` to store\n' +
-      '     credentials securely in the OS keyring on Linux. Without it, secrets will\n' +
-      '     be written to plaintext config (~/.sinch/profiles/<active>.json).\n\n' +
-      '     Debian/Ubuntu:  sudo apt install libsecret-tools gnome-keyring dbus-x11\n' +
-      '     Fedora/RHEL:    sudo dnf install libsecret gnome-keyring dbus-tools\n' +
-      '     Arch:           sudo pacman -S libsecret gnome-keyring dbus\n\n'
-  );
-}
-
-async function main() {
-  if (process.env.npm_config_global !== 'true' && !process.env.SINCH_FORCE_POSTINSTALL) {
-    return;
-  }
-
-  try {
-    fs.mkdirSync(SINCH_DIR, { recursive: true });
-
-    const version = getVersion();
-    await downloadBinary(version);
-    writeCompletionsJson(version);
-
-    if (process.platform === 'win32') {
-      await installPowerShellCompletion();
-    } else {
-      installBashZshCompletion();
-    }
-
-    warnIfLinuxKeychainMissing();
-  } catch {}
-}
-
-if (require.main === module) {
-  main();
-}
-
-module.exports = {
-  stripManagedBlocks,
-  upsertBlock,
-  installBashZshCompletion,
-  generateBashCompletionFile,
-};