Files
jackwener__opencli/clis/pixiv/download.ts
jakevin 4fe9a73ebc refactor: migrate adapter imports to package exports (#795)
* refactor: migrate adapter imports to package exports

Replace all relative imports (../../src/registry.js, ../../browser/cdp.js, etc.)
with package exports (@jackwener/opencli/registry, @jackwener/opencli/errors, etc.)
across all 484 adapter files.

This decouples adapter import resolution from directory structure:
- User CLIs in ~/.opencli/clis/ resolve via node_modules symlink
- Internal adapters resolve via Node.js self-referencing
- No more shim files needed for import resolution

Changes:
- package.json: add sub-path exports for all public modules
- clis/**: replace relative imports with @jackwener/opencli/...
- discovery.ts: simplify ensureUserCliCompatShims to symlink-only
- registry-api.ts: export CommandArgs type
- Remove root-level shim directories (browser/, download/, pipeline/)
- Remove shim entries from tsconfig.json include and package.json files

* test: add regression tests for package exports

Prevents regressions like #788/#791 by:
1. Scanning all adapter files for forbidden relative imports
   (../../src/, ../../browser/, etc.) — fails if any remain
2. Verifying every package.json export maps to an existing source file

18 new test cases.

* fix: use junction on Windows + broaden test patterns

- discovery.ts: use 'junction' symlink type on Windows (no admin required)
- package-exports.test.ts: generalize forbidden patterns to catch any
  depth of ../ traversal (not just ../../ and ../../../)

* fix: update stale vi.mock/importActual paths in adapter tests

Test files still used old relative paths for vi.mock() and
vi.importActual() calls. Updated 5 test files to use package exports.
Also broadened regression test patterns to catch mock/importActual paths.

* fix: use rm instead of unlink for symlink cleanup, add warn on failure

Addresses review feedback from Astro-Han:
- rm() handles both symlinks and stale directories (unlink fails on dirs)
- Log a warning when symlink creation fails instead of silent catch

* docs: update import examples to use package exports

Update all documentation, contributing guides, and skills to use
@jackwener/opencli/registry instead of ../../src/registry.js.

Without this, users following the docs would write adapters with
broken imports since the old shim files are no longer created.
2026-04-05 16:02:17 +08:00

92 lines
3.0 KiB
TypeScript

/**
* Pixiv download — download all images from an illustration.
*
* Pixiv's CDN (i.pximg.net) requires Referer: https://www.pixiv.net/ header.
* Uses the /ajax/illust/{id}/pages API to get original-quality image URLs.
*/
import * as fs from 'node:fs';
import * as path from 'node:path';
import { cli, Strategy } from '@jackwener/opencli/registry';
import { formatCookieHeader, httpDownload } from '@jackwener/opencli/download';
import { formatBytes } from '@jackwener/opencli/download/progress';
import { CommandExecutionError, getErrorMessage } from '@jackwener/opencli/errors';
import { pixivFetch } from './utils.js';
cli({
site: 'pixiv',
name: 'download',
description: 'Download illustration images from Pixiv',
domain: 'www.pixiv.net',
strategy: Strategy.COOKIE,
args: [
{ name: 'illust-id', positional: true, required: true, help: 'Illustration ID' },
{ name: 'output', default: './pixiv-downloads', help: 'Output directory' },
],
columns: ['index', 'type', 'status', 'size'],
func: async (page, kwargs) => {
const illustId = String(kwargs['illust-id'] ?? '');
const output = String(kwargs.output ?? './pixiv-downloads');
if (!/^\d+$/.test(illustId)) {
throw new CommandExecutionError(`Invalid illustration ID: ${illustId}`);
}
// pixivFetch handles navigate + error checking; returns the response body directly
const pages: any[] = await pixivFetch(page, `/ajax/illust/${illustId}/pages`, {
notFoundMsg: `Illustration not found: ${illustId}`,
}) || [];
if (pages.length === 0) {
return [{ index: 0, type: '-', status: 'failed', size: 'No images found' }];
}
// Extract cookies for authenticated downloads
const cookies = formatCookieHeader(await page.getCookies({ domain: 'pixiv.net' }));
// Create output directory
const outputDir = path.join(output, illustId);
fs.mkdirSync(outputDir, { recursive: true });
const results = [];
for (let i = 0; i < pages.length; i++) {
const p = pages[i];
const url = p.urls?.original || p.urls?.regular || '';
if (!url) {
results.push({ index: i + 1, type: 'image', status: 'failed', size: 'No URL' });
continue;
}
try {
const ext = path.extname(new URL(url).pathname) || '.jpg';
const filename = `${illustId}_p${i}${ext}`;
const destPath = path.join(outputDir, filename);
const result = await httpDownload(url, destPath, {
cookies,
headers: { Referer: 'https://www.pixiv.net/' },
timeout: 60000,
});
results.push({
index: i + 1,
type: 'image',
status: result.success ? 'success' : 'failed',
size: result.success ? formatBytes(result.size) : (result.error || 'unknown error'),
});
} catch (err) {
results.push({
index: i + 1,
type: 'image',
status: 'failed',
size: getErrorMessage(err),
});
}
}
return results;
},
});