veodl 1.12.0 → 2.0.0

package/src/alias.js

@@ -1,258 +0,0 @@
-import path from 'node:path';
-import { chmod, mkdir, readdir, readFile, rm, stat, writeFile } from 'node:fs/promises';
-import { commandOutput } from './output.js';
-import { findOnPath } from './backend.js';
-import { cleanText, readableError } from './utils.js';
-
-export const BUILTIN_ALIASES = ['veo', 'veodl'];
-export const ALIAS_MARKER = 'veo-alias';
-
-export const ALIAS_HELP = `veo alias - manage extra command names for veo
-
-Usage:
-  veo alias                    List command names (same as: veo alias list)
-  veo alias list [--json]      Show veo, veodl plus custom wrappers
-  veo alias add <name> [--force] [--json]
-                               Create <name> as a wrapper that calls veo
-  veo alias remove <name> [--json]   Delete a wrapper (also: veo alias rm)
-  veo alias --help             Show this help
-
-Names use 2-31 lowercase letters, digits or hyphens and start with a letter,
-e.g. veo-dl. The wrapper is created next to the veo command found on PATH and
-simply forwards to veo, so it survives veo updates. Removing veodl only
-removes that shortcut; veo update recreates the shipped names. veo itself can
-never be removed. Use --bin-dir <path> to override the target directory.
-`;
-
-export function validateAliasName(input) {
-  const raw = String(input ?? '').trim();
-  if (!raw) throw new Error('An alias name is required. Use: veo alias add <name>');
-  if (cleanText(raw) !== raw) throw new Error(`Invalid alias name: ${raw}. Use plain text without escapes.`);
-  if (!/^[a-z][a-z0-9-]{1,30}$/.test(raw)) {
-    throw new Error(`Invalid alias name "${raw}". Use 2-31 lowercase letters, digits or hyphens, starting with a letter (e.g. veo-dl).`);
-  }
-  return raw;
-}
-
-export function aliasFiles(binDir, name, platform = process.platform) {
-  if (platform === 'win32') {
-    return [path.join(binDir, name), path.join(binDir, `${name}.cmd`), path.join(binDir, `${name}.ps1`)];
-  }
-  return [path.join(binDir, name)];
-}
-
-function posixWrapper(name) {
-  return `#!/bin/sh\n# ${ALIAS_MARKER}: ${name}\nexec veo "$@"\n`;
-}
-
-function windowsCmdWrapper(name) {
-  return `@echo off\r\nREM ${ALIAS_MARKER}: ${name}\r\nveo %*\r\n`;
-}
-
-function windowsShWrapper(name) {
-  return `#!/bin/sh\n# ${ALIAS_MARKER}: ${name}\nexec veo "$@"\n`;
-}
-
-function windowsPsWrapper(name) {
-  return `# ${ALIAS_MARKER}: ${name}\nveo @args\n`;
-}
-
-async function exists(file, { statImpl = stat } = {}) {
-  try {
-    const info = await statImpl(file);
-    return info.isFile();
-  } catch (error) {
-    if (error?.code === 'ENOENT') return false;
-    throw error;
-  }
-}
-
-async function isManaged(file, { readFileImpl = readFile } = {}) {
-  try {
-    const text = await readFileImpl(file, 'utf8');
-    return text.slice(0, 4096).includes(ALIAS_MARKER);
-  } catch {
-    return false;
-  }
-}
-
-export async function resolveBinDir({ binDir, platform = process.platform, env = process.env, find = findOnPath } = {}) {
-  if (binDir) return path.resolve(binDir);
-  const found = await find(['veo'], { platform, env });
-  if (!found) {
-    throw new Error('Could not locate the veo command on PATH. Install veo globally (npm install -g veodl) or pass --bin-dir <path>.');
-  }
-  return path.dirname(found);
-}
-
-export async function aliasStatus(name, { binDir, platform = process.platform, ...fs } = {}) {
-  const files = aliasFiles(binDir, name, platform);
-  const present = [];
-  let managed = false;
-  for (const file of files) {
-    if (await exists(file, fs)) {
-      present.push(file);
-      if (await isManaged(file, fs)) managed = true;
-    }
-  }
-  return { name, builtin: BUILTIN_ALIASES.includes(name), present: present.length > 0, managed, paths: present };
-}
-
-function baseNameOf(file, platform) {
-  const base = path.basename(file);
-  if (platform === 'win32') {
-    if (base.toLowerCase().endsWith('.cmd')) return base.slice(0, -4);
-    if (base.toLowerCase().endsWith('.ps1')) return base.slice(0, -4);
-  }
-  return base;
-}
-
-export async function listAliases({ binDir, platform = process.platform, builtins = BUILTIN_ALIASES, readdirImpl = readdir, readFileImpl = readFile, statImpl = stat } = {}) {
-  const resolved = await resolveBinDir({ binDir, platform });
-  const entries = [];
-  for (const name of builtins) {
-    entries.push(await aliasStatus(name, { binDir: resolved, platform, readFileImpl, statImpl }));
-  }
-  const known = new Set(entries.map(entry => entry.name));
-  let files = [];
-  try {
-    files = await readdirImpl(resolved, { withFileTypes: true });
-  } catch (error) {
-    throw new Error(`Cannot list the command directory ${resolved}: ${readableError(error)}`);
-  }
-  for (const entry of files) {
-    if (!entry.isFile()) continue;
-    const full = path.join(resolved, entry.name);
-    let text = '';
-    try {
-      text = String(await readFileImpl(full, 'utf8')).slice(0, 4096);
-    } catch {
-      continue;
-    }
-    if (!text.includes(ALIAS_MARKER)) continue;
-    const base = baseNameOf(entry.name, platform);
-    try {
-      validateAliasName(base);
-    } catch {
-      continue;
-    }
-    if (known.has(base)) {
-      const existing = entries.find(item => item.name === base);
-      if (existing) existing.managed = true;
-      continue;
-    }
-    known.add(base);
-    entries.push({ name: base, builtin: false, present: true, managed: true, paths: [full] });
-  }
-  return { binDir: resolved, aliases: entries.sort((a, b) => a.name.localeCompare(b.name)) };
-}
-
-export async function addAlias(name, { binDir, platform = process.platform, force = false, writeFileImpl = writeFile, statImpl = stat, chmodImpl = chmod, mkdirImpl = mkdir } = {}) {
-  const valid = validateAliasName(name);
-  if (valid === 'veo') throw new Error('veo is already the main command.');
-  const resolved = await resolveBinDir({ binDir, platform });
-  await mkdirImpl(resolved, { recursive: true });
-  const files = aliasFiles(resolved, valid, platform);
-  const present = [];
-  for (const file of files) {
-    if (await exists(file, { statImpl })) present.push(file);
-  }
-  if (present.length && !force) {
-    throw new Error(`${valid} already exists (${present.map(file => path.basename(file)).join(', ')}). Use --force to replace it.`);
-  }
-  for (const file of present) await rm(file, { force: true });
-  if (platform === 'win32') {
-    await writeFileImpl(files[0], windowsShWrapper(valid), { mode: 0o755 });
-    await writeFileImpl(files[1], windowsCmdWrapper(valid));
-    await writeFileImpl(files[2], windowsPsWrapper(valid));
-  } else {
-    await writeFileImpl(files[0], posixWrapper(valid), { mode: 0o755 });
-    try {
-      await chmodImpl(files[0], 0o755);
-    } catch {
-      // Non-POSIX filesystems may ignore modes; the shebang still works.
-    }
-  }
-  return { name: valid, binDir: resolved, paths: aliasFiles(resolved, valid, platform) };
-}
-
-export async function removeAlias(name, { binDir, platform = process.platform, statImpl = stat, rmImpl = rm } = {}) {
-  const valid = validateAliasName(name);
-  if (valid === 'veo') throw new Error('Refusing to remove veo itself. Remove veodl or a custom wrapper instead.');
-  const resolved = await resolveBinDir({ binDir, platform });
-  const status = await aliasStatus(valid, { binDir: resolved, platform, statImpl });
-  if (!status.present) throw new Error(`${valid} is not installed in ${resolved}.`);
-  for (const file of status.paths) await rmImpl(file, { force: true });
-  return { name: valid, binDir: resolved, removed: status.paths, builtin: status.builtin };
-}
-
-function parseAliasArgs(args) {
-  let binDir;
-  let force = false;
-  let json = false;
-  const rest = [];
-  for (let index = 0; index < args.length; index++) {
-    const token = args[index];
-    if (token === '--force') force = true;
-    else if (token === '--json') json = true;
-    else if (token === '--bin-dir') {
-      binDir = args[++index];
-      if (!binDir) throw new Error('--bin-dir requires a directory. Run veo alias --help for usage.');
-    } else if (token.startsWith('--bin-dir=')) {
-      binDir = token.slice(10) || undefined;
-      if (!binDir) throw new Error('--bin-dir requires a directory. Run veo alias --help for usage.');
-    } else rest.push(token);
-  }
-  return { binDir, force, json, rest };
-}
-
-export async function aliasMain(args = [], { stdout = process.stdout, stderr = process.stderr, ...options } = {}) {
-  [args, stdout, stderr] = commandOutput(args, stdout, stderr);
-  const { binDir, force, json, rest } = parseAliasArgs(args);
-  const [command, name, ...extra] = rest;
-  if (!command || command === 'list') {
-    if (name || extra.length) throw new Error('Usage: veo alias list [--json] (or veo alias --help)');
-    if (command === 'list' && extra.length) throw new Error('Usage: veo alias list [--json] (or veo alias --help)');
-    const result = await listAliases({ ...options, binDir });
-    if (json) {
-      stdout.write(`${JSON.stringify(result)}\n`);
-      return 0;
-    }
-    stdout.write(`Command directory: ${result.binDir}\n`);
-    for (const entry of result.aliases) {
-      const kind = entry.builtin ? 'shipped' : 'custom';
-      const state = entry.present ? (entry.managed ? 'wrapper -> veo' : 'installed') : 'missing';
-      stdout.write(`  ${entry.name} (${kind}, ${state})\n`);
-    }
-    const missing = result.aliases.filter(entry => !entry.present).map(entry => entry.name);
-    if (missing.length) stdout.write(`Missing: ${missing.join(', ')} (veo update recreates shipped names).\n`);
-    return 0;
-  }
-  if (command === '-h' || command === '--help') {
-    stdout.write(ALIAS_HELP);
-    return 0;
-  }
-  if (command === 'add') {
-    if (!name || extra.length) throw new Error('Usage: veo alias add <name> [--force] (or veo alias --help)');
-    const created = await addAlias(name, { ...options, binDir, force });
-    if (json) {
-      stdout.write(`${JSON.stringify({ status: 'added', ...created })}\n`);
-      return 0;
-    }
-    stdout.write(`Alias installed: ${created.name} -> veo (${created.binDir})\n`);
-    stdout.write(`Run "${created.name} --help" to use it. Remove it with: veo alias remove ${created.name}\n`);
-    return 0;
-  }
-  if (command === 'remove' || command === 'rm' || command === 'uninstall') {
-    if (!name || extra.length) throw new Error('Usage: veo alias remove <name> (or veo alias --help)');
-    const removed = await removeAlias(name, { ...options, binDir });
-    if (json) {
-      stdout.write(`${JSON.stringify({ status: 'removed', ...removed })}\n`);
-      return 0;
-    }
-    stdout.write(`Alias removed: ${removed.name} (${removed.removed.length} file(s) in ${removed.binDir})\n`);
-    if (removed.builtin) stdout.write('Note: veo update recreates the shipped veodl name.\n');
-    return 0;
-  }
-  throw new Error(`Unknown alias command: ${cleanText(command)}. Use: veo alias list | veo alias add <name> | veo alias remove <name>`);
-}

package/src/backend-update.js

@@ -1,191 +0,0 @@
-import { commandOutput } from './output.js';
-import path from 'node:path';
-import { rm } from 'node:fs/promises';
-import {
-  RELEASE, activeOverride, backendCacheDirectory, clearBackendOverride, installBackend,
-  isValidRelease, readBackendOverride, releaseUrl, selectAsset, writeBackendOverride,
-} from './backend.js';
-import { compareVersions } from './version.js';
-import { readableError, cleanText } from './utils.js';
-
-const API_LATEST = 'https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest';
-const CHECKSUMS = 'SHA2-256SUMS';
-
-export const BACKEND_HELP = `veo backend - manage the yt-dlp backend
-
-Usage:
-  veo backend update          Install the newest yt-dlp release
-  veo backend update --check  Only report whether a newer release exists
-  veo backend reset           Forget the installed release and use the pinned one
-  veo backend reset --keep-files
-                              Remove the pointer but keep the downloaded files
-  veo backend --help          Show this help
-
-veo ships a pinned, hash-verified yt-dlp release. \`veo backend update\` is an
-opt-in escape hatch for when a website changed and the pinned release is too old:
-it installs the newest official release after verifying its SHA-256 against that
-release's own SHA2-256SUMS file over HTTPS.
-
-That checksum does not ship with veo, so this weakens the pinned-hash guarantee:
-it then rests on HTTPS and GitHub alone. \`veo backend reset\` returns to the
-release veo was built and tested against. VEO_YT_DLP_PATH always wins over both.
-`;
-
-export async function fetchLatestBackendRelease({ fetchImpl = fetch, timeoutMs = 10_000, signal } = {}) {
-  const response = await fetchImpl(API_LATEST, {
-    signal: signal ? AbortSignal.any([signal, AbortSignal.timeout(timeoutMs)]) : AbortSignal.timeout(timeoutMs),
-    headers: { accept: 'application/vnd.github+json', 'user-agent': 'veo' },
-  });
-  if (!response.ok) {
-    await response.body?.cancel();
-    throw new Error(`Could not query the latest yt-dlp release: HTTP ${response.status}.`);
-  }
-  const data = await response.json();
-  const tag = data?.tag_name;
-  if (!isValidRelease(tag)) throw new Error(`The release host returned an unexpected version: ${cleanText(String(tag))}`);
-  return tag;
-}
-
-/** Parse an official SHA2-256SUMS file into a name -> hash map. */
-export function parseChecksums(text) {
-  const hashes = new Map();
-  for (const line of String(text).split('\n')) {
-    const match = /^([a-f0-9]{64})\s+\*?(.+?)\s*$/i.exec(line.trim());
-    if (match) hashes.set(path.basename(match[2]), match[1].toLowerCase());
-  }
-  if (!hashes.size) throw new Error('The release checksum list could not be parsed.');
-  return hashes;
-}
-
-export async function fetchReleaseChecksum({ release, asset, fetchImpl = fetch, timeoutMs = 15_000, signal }) {
-  if (!isValidRelease(release)) throw new Error(`Invalid yt-dlp release: ${release}`);
-  const response = await fetchImpl(releaseUrl(release, CHECKSUMS), {
-    signal: signal ? AbortSignal.any([signal, AbortSignal.timeout(timeoutMs)]) : AbortSignal.timeout(timeoutMs),
-  });
-  if (!response.ok) {
-    await response.body?.cancel();
-    throw new Error(`Could not download ${CHECKSUMS} for yt-dlp ${release}: HTTP ${response.status}.`);
-  }
-  const hash = parseChecksums(await response.text()).get(asset);
-  if (!hash) throw new Error(`yt-dlp ${release} does not publish a checksum for ${asset}.`);
-  return hash;
-}
-
-export function muslDetected() {
-  return process.platform === 'linux' && !process.report.getReport().header.glibcVersionRuntime;
-}
-
-export async function checkBackend({
-  platform = process.platform,
-  arch = process.arch,
-  musl = muslDetected(),
-  signal,
-  stateFile,
-  fetchImpl = fetch,
-  installed,
-  latest,
-} = {}) {
-  const asset = selectAsset(platform, arch, musl);
-  const active = installed !== undefined ? installed : await activeOverride(asset, { signal, stateFile });
-  return {
-    asset,
-    active,
-    current: active?.release ?? RELEASE,
-    latest: latest ?? await fetchLatestBackendRelease({ fetchImpl, signal }),
-  };
-}
-
-export async function backendUpdateMain(args = [], {
-  stdout = process.stdout,
-  stderr = process.stderr,
-  env = process.env,
-  signal,
-  stateFile,
-  platform = process.platform,
-  arch = process.arch,
-  fetchImpl = fetch,
-  check = checkBackend,
-  install = installBackend,
-  reset = clearBackendOverride,
-  removeFiles = directory => rm(directory, { recursive: true, force: true }),
-} = {}) {
-  [args, stdout, stderr] = commandOutput(args, stdout, stderr);
-  const [command, ...rest] = args;
-  if (command === undefined || command === '-h' || command === '--help' || rest.includes('-h') || rest.includes('--help')) {
-    stdout.write(BACKEND_HELP);
-    return 0;
-  }
-  if (command === 'reset') {
-    const unknown = rest.filter(token => token !== '--keep-files');
-    if (unknown.length) throw new Error(`Unknown option for veo backend reset: ${unknown.join(' ')}. Use: veo backend reset [--keep-files]`);
-    if (platform === 'android') {
-      stdout.write('Android/Termux uses system yt-dlp or VEO_YT_DLP_PATH. There is no managed backend to reset.\n');
-      return 0;
-    }
-    const state = await readBackendOverride(stateFile);
-    if (!await reset(stateFile)) {
-      stdout.write(`No installed backend to remove. veo uses the pinned release ${RELEASE}.\n`);
-      return 0;
-    }
-    if (state?.release && !rest.includes('--keep-files')) await removeFiles(backendCacheDirectory(state.release)).catch(() => {});
-    const removed = state?.release ? ` yt-dlp ${state.release}` : ' the installed backend';
-    stdout.write(`Removed${removed}. veo uses the pinned release ${RELEASE} again.\n`);
-    return 0;
-  }
-  if (command !== 'update') {
-    throw new Error(`Unknown backend command: ${cleanText(command)}. Use: veo backend update [--check] | veo backend reset`);
-  }
-  const checkOnly = rest.includes('--check');
-  const unknown = rest.filter(token => token !== '--check');
-  if (unknown.length) throw new Error(`Unknown option for veo backend update: ${unknown.join(' ')}. Use: veo backend update [--check]`);
-  if (platform === 'android') {
-    stdout.write('Android/Termux uses system yt-dlp or VEO_YT_DLP_PATH, not a pinned release. Update the Termux package with: pkg upgrade python-yt-dlp yt-dlp-ejs\n');
-    return 0;
-  }
-  if (env.VEO_YT_DLP_PATH) stderr.write('veo: VEO_YT_DLP_PATH is set and always takes precedence over the managed backend.\n');
-
-  let info;
-  try {
-    info = await check({ platform, arch, signal, stateFile, fetchImpl });
-  } catch (error) {
-    stderr.write(`veo: ${readableError(error)}\n`);
-    return 1;
-  }
-  const { asset, current, latest } = info;
-  if (!asset) {
-    stderr.write(`veo: no standalone yt-dlp is published for ${platform}/${arch}. Set VEO_YT_DLP_PATH to a trusted executable.\n`);
-    return 1;
-  }
-  if (compareVersions(latest, current) <= 0) {
-    stdout.write(`yt-dlp ${current} is up to date${current === RELEASE ? ' (pinned release, hash verified at build time)' : ' (installed release)'}.\n`);
-    return 0;
-  }
-  if (checkOnly) {
-    stdout.write(`Newer yt-dlp release available: ${latest} (using ${current}). Run: veo backend update\n`);
-    return 0;
-  }
-
-  let sha256;
-  try {
-    sha256 = await fetchReleaseChecksum({ release: latest, asset, fetchImpl, signal });
-  } catch (error) {
-    stderr.write(`veo: ${readableError(error)}\nNothing was installed. The pinned release ${RELEASE} is still in use.\n`);
-    return 1;
-  }
-  stdout.write(`Installing yt-dlp ${latest} for ${platform}/${asset}…\n`);
-  try {
-    await install({ release: latest, asset, sha256, signal, status: message => stdout.write(`${message}\n`) });
-  } catch (error) {
-    stderr.write(`veo: ${readableError(error)}\nThe pinned release ${RELEASE} is still in use.\n`);
-    return 1;
-  }
-  try {
-    await writeBackendOverride({ release: latest, asset, sha256, platform, arch, installed: new Date().toISOString() }, stateFile);
-  } catch (error) {
-    stderr.write(`veo: ${readableError(error)}\nThe download succeeded, but veo could not record it; the pinned release stays in use.\n`);
-    return 1;
-  }
-  stdout.write(`yt-dlp ${latest} installed and will be used for the next download.\n`);
-  stderr.write(`veo: note: yt-dlp ${latest} was verified against the checksum published with that release over HTTPS, not against a hash shipped with veo. Run "veo backend reset" to return to the pinned release.\n`);
-  return 0;
-}