anyfreebook-cli 0.0.0-stage → 0.1.0

package/src/commands/download.js

@@ -0,0 +1,325 @@
+/**
+ * `anyfreebook download` — search, then write verified public-domain books to disk.
+ *
+ * Only results whose tier is `download` are ever written. `borrow` and
+ * `unverified` results are refused with an explanation, never silently skipped.
+ */
+
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+import {
+  DEFAULT_DOWNLOAD_LIMIT,
+  DEFAULT_OUT_DIR,
+  FORMAT_PREFERENCE,
+  MAX_LIMIT,
+  MAX_QUERY_LENGTH,
+  USER_AGENT,
+  clampInt,
+  validateFormat,
+  validateSource,
+} from '../config.js';
+import { CliError, usageError } from '../errors.js';
+import { fileNameFor, resolveWithin } from '../filename.js';
+import { humanBytes, partialWarning } from '../format.js';
+import { positionalText } from './search.js';
+
+/** Pick the file to download for a result. */
+export function pickFile(files, requestedFormat) {
+  const list = Array.isArray(files) ? files.filter(Boolean) : [];
+  if (!list.length) return null;
+  if (requestedFormat) {
+    return list.find((file) => String(file.format).toLowerCase() === requestedFormat) || null;
+  }
+  for (const format of FORMAT_PREFERENCE) {
+    const match = list.find((file) => String(file.format).toLowerCase() === format);
+    if (match) return match;
+  }
+  return null;
+}
+
+/** Explain, in plain words, why a non-download result cannot be downloaded. */
+export function refusalMessage(result) {
+  const tier = String(result?.tier ?? '').toLowerCase();
+  const title = result?.title || result?.id || 'This title';
+  if (tier === 'borrow') {
+    return (
+      `"${title}" is borrow-only: a real Internet Archive copy exists but it is lending-restricted. ` +
+      'Reading it needs a free Internet Archive account and a loan, so there is no file to download.'
+    );
+  }
+  if (tier === 'unverified') {
+    return (
+      `"${title}" is unverified: no free, legal copy of this exact title could be confirmed, ` +
+      'so there is nothing to download.'
+    );
+  }
+  return `"${title}" has tier "${result?.tier ?? 'unknown'}" — only tier=download results may be downloaded.`;
+}
+
+async function pathExists(target) {
+  try {
+    await fs.access(target);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Download one URL to disk.
+ * Writes to a `.part` file first so an interrupted transfer never leaves a
+ * truncated book behind.
+ */
+export async function downloadFile(url, destination, { timeoutMs, onProgress } = {}) {
+  let response;
+  try {
+    response = await fetch(url, {
+      method: 'GET',
+      headers: { 'user-agent': USER_AGENT, accept: '*/*' },
+      signal: AbortSignal.timeout(timeoutMs),
+      redirect: 'follow',
+    });
+  } catch (err) {
+    const cause = (err && (err.cause || err)) || {};
+    const code = cause.code ? ` (${cause.code})` : '';
+    if (err && (err.name === 'TimeoutError' || err.name === 'AbortError')) {
+      throw new CliError(`Download timed out after ${timeoutMs} ms: ${url}`, { code: 'timeout' });
+    }
+    throw new CliError(`Could not reach the file host${code}: ${url}`, {
+      code: 'network',
+      hint: 'Check your connection and retry. The file host may also be temporarily unavailable.',
+    });
+  }
+
+  if (!response.ok) {
+    throw new CliError(`The file host answered HTTP ${response.status}${response.statusText ? ` ${response.statusText}` : ''}.`, {
+      status: response.status,
+      code: 'download_failed',
+    });
+  }
+
+  const lengthHeader = response.headers && response.headers.get('content-length');
+  const total = lengthHeader ? Number(lengthHeader) : 0;
+  const temporary = `${destination}.part`;
+  const handle = await fs.open(temporary, 'w');
+
+  let received = 0;
+  try {
+    const body = response.body;
+    if (body && typeof body.getReader === 'function') {
+      const reader = body.getReader();
+      for (;;) {
+        const { done, value } = await reader.read();
+        if (done) break;
+        if (value) {
+          await handle.write(value);
+          received += value.byteLength;
+          if (onProgress) onProgress(received, total);
+        }
+      }
+    } else {
+      const buffer = Buffer.from(await response.arrayBuffer());
+      await handle.write(buffer);
+      received = buffer.byteLength;
+      if (onProgress) onProgress(received, total);
+    }
+    await handle.close();
+    await fs.rename(temporary, destination);
+  } catch (err) {
+    await handle.close().catch(() => {});
+    await fs.unlink(temporary).catch(() => {});
+    if (err instanceof CliError) throw err;
+    throw new CliError(`Transfer failed: ${err && err.message ? err.message : String(err)}`, {
+      code: 'download_failed',
+    });
+  }
+
+  return { bytes: received, total };
+}
+
+export async function downloadCommand(opts, ctx) {
+  const query = positionalText(opts._.slice(1));
+  if (!query) {
+    throw usageError(
+      'Missing search query.',
+      'Try: anyfreebook download "pride and prejudice" --format epub',
+    );
+  }
+  if (query.length > MAX_QUERY_LENGTH) {
+    throw usageError(
+      `Query is ${query.length} characters; the API accepts at most ${MAX_QUERY_LENGTH}.`,
+      'Shorten the query.',
+    );
+  }
+
+  const limit = clampInt(opts.limit, DEFAULT_DOWNLOAD_LIMIT, 1, MAX_LIMIT, '--limit');
+  const format = validateFormat(opts.format);
+  const source = validateSource(opts.source);
+  const force = Boolean(opts.force);
+  const dryRun = Boolean(opts.dryRun);
+  const outDir = path.resolve(opts.out || DEFAULT_OUT_DIR);
+
+  const data = await ctx.api.search({ q: query, page: 1, source, limit });
+  const failedSources = Array.isArray(data.failedSources) ? data.failedSources : [];
+  if (data.partial || failedSources.length > 0) {
+    ctx.err.write(`${partialWarning(failedSources, ctx.style)}\n`);
+  }
+
+  const results = Array.isArray(data.results) ? data.results : [];
+  const items = [];
+
+  for (const result of results) {
+    const title = result?.title || result?.id || 'book';
+    if (result?.tier !== 'download') {
+      items.push({ status: 'refused', title, book: result, message: refusalMessage(result) });
+      continue;
+    }
+    const file = pickFile(result.files, format);
+    if (!file) {
+      items.push({
+        status: 'skipped',
+        title,
+        book: result,
+        message: format
+          ? `No ${format} file was offered for "${title}".`
+          : `The API did not return a downloadable file for "${title}".`,
+      });
+      continue;
+    }
+    items.push({ status: 'pending', title, book: result, file });
+  }
+
+  if (!dryRun && items.some((item) => item.status === 'pending')) {
+    await fs.mkdir(outDir, { recursive: true });
+  }
+
+  const summary = { downloaded: 0, skipped: 0, failed: 0, refused: 0, planned: 0 };
+
+  for (const item of items) {
+    if (item.status === 'refused') {
+      summary.refused += 1;
+      continue;
+    }
+    if (item.status === 'skipped') {
+      summary.skipped += 1;
+      continue;
+    }
+
+    const extension = String(item.file.format || 'bin').toLowerCase();
+    const name = fileNameFor(item.title, extension, item.book?.id);
+    const destination = resolveWithin(outDir, name);
+    if (!destination) {
+      item.status = 'failed';
+      item.message = `Refused to write outside ${outDir}.`;
+      summary.failed += 1;
+      continue;
+    }
+
+    if (!dryRun && (await pathExists(destination)) && !force) {
+      item.status = 'skipped';
+      item.message = `${destination} already exists — pass --force to overwrite it.`;
+      summary.skipped += 1;
+      continue;
+    }
+
+    if (dryRun) {
+      item.status = 'planned';
+      item.path = destination;
+      item.message = `would download → ${destination}`;
+      summary.planned += 1;
+      continue;
+    }
+
+    try {
+      const { bytes } = await downloadFile(item.file.url, destination, {
+        timeoutMs: ctx.config.timeoutMs,
+        onProgress: (received, total) => {
+          if (!ctx.err.isTTY) return;
+          const size = total ? `${humanBytes(received)} / ${humanBytes(total)}` : humanBytes(received);
+          const percent = total ? ` (${Math.min(100, Math.round((received / total) * 100))}%)` : '';
+          const line = `  ↓ ${name}  ${size}${percent}`;
+          ctx.err.write(`\r${line.padEnd(72)}`);
+        },
+      });
+      item.status = 'downloaded';
+      item.path = destination;
+      item.bytes = bytes;
+      summary.downloaded += 1;
+      ctx.err.write(
+        `\r${`  ✓ ${name}  ${humanBytes(bytes)}`.padEnd(72)}\n`,
+      );
+    } catch (err) {
+      item.status = 'failed';
+      item.message = err && err.message ? err.message : String(err);
+      summary.failed += 1;
+      ctx.err.write(`\r${`  ✗ ${name} — ${item.message}`.padEnd(72)}\n`);
+    }
+  }
+
+  if (ctx.json) {
+    ctx.out.write(
+      `${JSON.stringify(
+        {
+          query,
+          out: outDir,
+          dryRun,
+          format: format || 'best-available',
+          items: items.map((item) => ({
+            title: item.title,
+            id: item.book?.id ?? null,
+            tier: item.book?.tier ?? null,
+            status: item.status,
+            format: item.file?.format ?? null,
+            url: item.file?.url ?? null,
+            path: item.path ?? null,
+            bytes: item.bytes ?? null,
+            message: item.message ?? null,
+          })),
+          summary,
+        },
+        null,
+        2,
+      )}\n`,
+    );
+    return;
+  }
+
+  const lines = [];
+  if (dryRun) {
+    lines.push(ctx.style.bold(`Dry run — nothing was written. Destination would be ${outDir}`));
+    lines.push('');
+  }
+  if (!items.length) {
+    lines.push(ctx.style.yellow(`No results found for "${query}".`));
+  }
+  for (const item of items) {
+    const mark =
+      item.status === 'downloaded' || item.status === 'planned'
+        ? ctx.style.green('✓')
+        : item.status === 'refused'
+          ? ctx.style.yellow('⊘')
+          : ctx.style.red('✗');
+    const detail =
+      item.status === 'downloaded'
+        ? `${item.path} (${humanBytes(item.bytes)})`
+        : item.message || item.status;
+    lines.push(`${mark} ${item.title} — ${detail}`);
+  }
+  lines.push('');
+  lines.push(
+    ctx.style.bold('Summary:') +
+      ` downloaded ${summary.downloaded} · skipped ${summary.skipped} · failed ${summary.failed} · refused ${summary.refused}` +
+      (dryRun ? ` · would download ${summary.planned}` : ''),
+  );
+  if (summary.refused) {
+    lines.push(
+      ctx.style.dim(
+        'Refused results are not downloadable: tier=borrow needs a free Internet Archive account and a loan, ' +
+          'tier=unverified means no free copy of that exact title could be confirmed.',
+      ),
+    );
+  }
+
+  ctx.out.write(`${lines.join('\n')}\n`);
+}

package/src/commands/health.js

@@ -0,0 +1,24 @@
+/**
+ * `anyfreebook health` — is the API reachable?
+ */
+
+export async function healthCommand(opts, ctx) {
+  const data = await ctx.api.health();
+
+  if (ctx.json) {
+    ctx.out.write(`${JSON.stringify(data, null, 2)}\n`);
+    return;
+  }
+
+  const uptime = Number(data.uptimeSeconds);
+  const lines = [];
+  lines.push(`${ctx.style.bold('Status')}     ${data.status || 'unknown'}`);
+  if (data.apiVersion) lines.push(`${ctx.style.bold('API ver')}    ${data.apiVersion}`);
+  if (Number.isFinite(uptime)) {
+    const minutes = Math.floor(uptime / 60);
+    const seconds = uptime % 60;
+    lines.push(`${ctx.style.bold('Uptime')}     ${uptime}s (${minutes}m ${seconds}s)`);
+  }
+  lines.push(`${ctx.style.bold('Base URL')}   ${ctx.config.base}`);
+  ctx.out.write(`${lines.join('\n')}\n`);
+}

package/src/commands/resolve.js

@@ -0,0 +1,79 @@
+/**
+ * `anyfreebook resolve` — authoritative legal status for one specific title.
+ */
+
+import { usageError } from '../errors.js';
+import { formatTier } from '../format.js';
+import { positionalText } from './search.js';
+
+export async function resolveCommand(opts, ctx) {
+  const title = positionalText(opts._.slice(1));
+  if (!title) {
+    throw usageError(
+      'Missing title.',
+      'Try: anyfreebook resolve "Pride and Prejudice" --author "Jane Austen"',
+    );
+  }
+  const author = typeof opts.author === 'string' ? opts.author.trim() : '';
+
+  const data = await ctx.api.resolve({ title, author: author || undefined });
+
+  if (ctx.json) {
+    ctx.out.write(`${JSON.stringify(data, null, 2)}\n`);
+    return;
+  }
+
+  const files = Array.isArray(data.files) ? data.files : [];
+  const links = Array.isArray(data.links) ? data.links : [];
+  const lines = [];
+
+  lines.push(ctx.style.bold(data.title || title));
+  if (data.author) lines.push(`${ctx.style.bold('Author')}   ${data.author}`);
+  lines.push(`${ctx.style.bold('Tier')}     ${formatTier(data.tier, ctx.style)}`);
+  if (data.tierReason) lines.push(`${ctx.style.bold('Reason')}   ${data.tierReason}`);
+  if (data.license) lines.push(`${ctx.style.bold('License')}  ${data.license}`);
+  if (data.sourceUrl || data.sourceType) {
+    const source = data.sourceType ? ` (${data.sourceType})` : '';
+    lines.push(`${ctx.style.bold('Source')}   ${data.sourceUrl || data.sourceType}${source}`);
+  }
+  lines.push('');
+
+  lines.push(`${ctx.style.bold(`Files (${files.length})`)}`);
+  if (files.length) {
+    for (const file of files) {
+      const label = file.label || String(file.format || 'file').toUpperCase();
+      const size = file.bytes ? ` — ${file.bytes} bytes` : '';
+      lines.push(`  ${label.padEnd(10)} ${file.url}${size}`);
+    }
+  } else {
+    lines.push(ctx.style.dim('  none — this title has no direct file URL.'));
+  }
+  lines.push('');
+
+  lines.push(`${ctx.style.bold(`Links (${links.length})`)}`);
+  if (links.length) {
+    for (const link of links) {
+      const source = link.source ? ` [${link.source}]` : '';
+      lines.push(`  ${link.label || 'Link'}${source} — ${link.url}`);
+    }
+  } else {
+    lines.push(ctx.style.dim('  none'));
+  }
+  lines.push('');
+
+  if (data.tier === 'download') {
+    lines.push(ctx.style.dim(`Next: anyfreebook download "${data.title || title}" --format epub`));
+  } else if (data.tier === 'borrow') {
+    lines.push(
+      ctx.style.dim(
+        'Borrow-only: read it on the source site with a free Internet Archive account and a loan — it cannot be downloaded.',
+      ),
+    );
+  } else {
+    lines.push(
+      ctx.style.dim('Unverified: no confirmed free copy of this exact title, so the CLI will not download it.'),
+    );
+  }
+
+  ctx.out.write(`${lines.join('\n')}\n`);
+}

package/src/commands/search.js

@@ -0,0 +1,128 @@
+/**
+ * `anyfreebook search` — fan out one query across the open-access sources.
+ */
+
+import {
+  DEFAULT_SEARCH_LIMIT,
+  MAX_LIMIT,
+  MAX_QUERY_LENGTH,
+  clampInt,
+  validateFormat,
+  validateSource,
+} from '../config.js';
+import { usageError } from '../errors.js';
+import { formatTier, partialWarning, renderSearchTable, tierLegend } from '../format.js';
+
+/** Join the positional arguments into a single piece of text. */
+export function positionalText(parts) {
+  return parts
+    .map((part) => String(part ?? '').trim())
+    .filter(Boolean)
+    .join(' ')
+    .trim();
+}
+
+/** True when the result carries a file in the requested format. */
+export function hasFormat(result, format) {
+  if (!format) return true;
+  const files = Array.isArray(result?.files) ? result.files : [];
+  return files.some((file) => file && String(file.format).toLowerCase() === format);
+}
+
+export async function searchCommand(opts, ctx) {
+  const query = positionalText(opts._.slice(1));
+  if (!query) {
+    throw usageError('Missing search query.', 'Try: anyfreebook search "pride and prejudice"');
+  }
+  if (query.length > MAX_QUERY_LENGTH) {
+    throw usageError(
+      `Query is ${query.length} characters; the API accepts at most ${MAX_QUERY_LENGTH}.`,
+      'Shorten the query.',
+    );
+  }
+
+  const limit = clampInt(opts.limit, DEFAULT_SEARCH_LIMIT, 1, MAX_LIMIT, '--limit');
+  const page = clampInt(opts.page, 1, 1, 1000, '--page');
+  const source = validateSource(opts.source);
+  const format = validateFormat(opts.format);
+  const freeOnly = Boolean(opts.freeOnly);
+
+  const data = await ctx.api.search({ q: query, page, source, limit });
+  const all = Array.isArray(data.results) ? data.results : [];
+  const results = all.filter(
+    (result) => (!freeOnly || result?.tier === 'download') && hasFormat(result, format),
+  );
+
+  const failedSources = Array.isArray(data.failedSources) ? data.failedSources : [];
+  const partial = Boolean(data.partial) || failedSources.length > 0;
+  if (partial) {
+    // Always surfaced: on stderr in both modes so `--json` stdout stays pure.
+    ctx.err.write(`${partialWarning(failedSources, ctx.style)}\n`);
+  }
+
+  if (ctx.json) {
+    ctx.out.write(
+      `${JSON.stringify({ ...data, results, count: results.length }, null, 2)}\n`,
+    );
+    return;
+  }
+
+  const total = Number.isFinite(Number(data.total)) ? Number(data.total) : all.length;
+  const lines = [];
+  lines.push(`${ctx.style.bold('Query')}   ${query}`);
+  lines.push(
+    `${ctx.style.bold('Page')}    ${page} · limit ${limit} · ${all.length} returned · ${total} total matches`,
+  );
+
+  const sourceCounts = data.sources && typeof data.sources === 'object' ? data.sources : {};
+  const sourceEntries = Object.entries(sourceCounts);
+  if (sourceEntries.length) {
+    const shown = sourceEntries
+      .slice(0, 6)
+      .map(([name, count]) => `${name} ${count}`)
+      .join(' · ');
+    const extra = sourceEntries.length > 6 ? ` · +${sourceEntries.length - 6} more` : '';
+    lines.push(`${ctx.style.bold('Sources')} ${shown}${extra}`);
+  }
+  lines.push('');
+
+  if (!results.length) {
+    if (freeOnly && all.length) {
+      lines.push(
+        ctx.style.yellow(
+          `No results with a verified free download. The search returned ${all.length} result(s), ` +
+            'but none of them had tier=download.',
+        ),
+      );
+    } else if (format && all.length) {
+      lines.push(
+        ctx.style.yellow(
+          `No results with a ${format} file. The search returned ${all.length} result(s), ` +
+            'but none of them offered that format.',
+        ),
+      );
+    } else {
+      lines.push(ctx.style.yellow(`No results found for "${query}".`));
+    }
+  } else {
+    lines.push(renderSearchTable(results, { style: ctx.style, width: ctx.width }));
+    lines.push('');
+    if (results.length < all.length) {
+      const filters = [];
+      if (freeOnly) filters.push('tier=download');
+      if (format) filters.push(`format=${format}`);
+      lines.push(
+        ctx.style.dim(
+          `Showing ${results.length} of ${all.length} results on this page (filtered by ${filters.join(', ')}).`,
+        ),
+      );
+    }
+    if (total > all.length) {
+      lines.push(ctx.style.dim(`More results available — use --page ${page + 1} for the next page.`));
+    }
+    lines.push('');
+    lines.push(ctx.style.dim(tierLegend(ctx.style)));
+  }
+
+  ctx.out.write(`${lines.join('\n')}\n`);
+}

package/src/config.js

@@ -0,0 +1,113 @@
+/**
+ * Configuration, limits and validation helpers.
+ *
+ * Everything here is deliberately dependency-free and side-effect free so the
+ * same values can be reused by the CLI and by the tests.
+ */
+
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { usageError } from './errors.js';
+
+const here = path.dirname(fileURLToPath(import.meta.url));
+
+function readVersion() {
+  try {
+    const raw = readFileSync(path.join(here, '..', 'package.json'), 'utf8');
+    return JSON.parse(raw).version || '0.0.0';
+  } catch {
+    return '0.0.0';
+  }
+}
+
+export const VERSION = readVersion();
+
+export const DEFAULT_API_BASE = 'https://anyfreebook.com/api/v1';
+export const DEFAULT_TIMEOUT_MS = 20000;
+export const DEFAULT_SEARCH_LIMIT = 10;
+export const DEFAULT_DOWNLOAD_LIMIT = 5;
+export const DEFAULT_OUT_DIR = './books';
+export const MAX_LIMIT = 50;
+export const MAX_QUERY_LENGTH = 200;
+
+/** Source identifiers accepted by the `source` query parameter. */
+export const SOURCES = [
+  'all',
+  'gutenberg',
+  'openlibrary',
+  'archive',
+  'googlebooks',
+  'pubmed',
+  'doaj',
+  'librivox',
+];
+
+/** File formats the CLI knows how to download. */
+export const FORMATS = ['epub', 'pdf', 'txt', 'html'];
+
+/** Preference order used when no explicit `--format` is given. */
+export const FORMAT_PREFERENCE = ['epub', 'pdf', 'txt', 'html'];
+
+export const USER_AGENT = `anyfreebook-cli/${VERSION} (+https://anyfreebook.com)`;
+
+/**
+ * Merge CLI flags with environment variables.
+ * Flags win, then env, then the built-in defaults.
+ */
+export function resolveConfig(flags = {}, env = {}) {
+  const base = String(flags.apiBase || env.ANYFREEBOOK_API_BASE || DEFAULT_API_BASE).replace(/\/+$/, '');
+  const apiKey = String(flags.apiKey || env.ANYFREEBOOK_API_KEY || '').trim();
+  const timeoutMs =
+    flags.timeout !== undefined && flags.timeout !== null
+      ? Number(flags.timeout)
+      : env.ANYFREEBOOK_TIMEOUT_MS !== undefined
+        ? Number(env.ANYFREEBOOK_TIMEOUT_MS)
+        : DEFAULT_TIMEOUT_MS;
+
+  return {
+    base: base || DEFAULT_API_BASE,
+    apiKey,
+    timeoutMs: Number.isFinite(timeoutMs) && timeoutMs > 0 ? timeoutMs : DEFAULT_TIMEOUT_MS,
+  };
+}
+
+/** Parse an integer option and clamp it into [min, max]. */
+export function clampInt(value, fallback, min, max, label) {
+  if (value === undefined || value === null || value === '') return fallback;
+  const parsed = Number(value);
+  if (!Number.isFinite(parsed) || !Number.isInteger(parsed)) {
+    throw usageError(`${label} must be a whole number (got "${value}").`);
+  }
+  if (parsed < min || parsed > max) {
+    throw usageError(`${label} must be between ${min} and ${max} (got ${parsed}).`);
+  }
+  return parsed;
+}
+
+/** Validate the `--source` option. */
+export function validateSource(value) {
+  if (value === undefined || value === null || value === '') return 'all';
+  const normalized = String(value).trim().toLowerCase();
+  if (!SOURCES.includes(normalized)) {
+    throw usageError(
+      `Unknown source "${value}".`,
+      `Valid sources: ${SOURCES.join(', ')}.`,
+    );
+  }
+  return normalized;
+}
+
+/** Validate the `--format` option. */
+export function validateFormat(value) {
+  if (value === undefined || value === null || value === '') return null;
+  const normalized = String(value).trim().toLowerCase().replace(/^\./, '');
+  if (!FORMATS.includes(normalized)) {
+    throw usageError(
+      `Unknown format "${value}".`,
+      `Valid formats: ${FORMATS.join(', ')}.`,
+    );
+  }
+  return normalized;
+}