Files
jackwener__opencli/clis/pixiv/utils.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

63 lines
2.1 KiB
TypeScript

/**
* Pixiv shared helpers: authenticated Ajax fetch with standard error handling.
*
* All Pixiv Ajax APIs return `{ error: false, body: ... }` on success.
* On failure the HTTP status code is used to distinguish auth (401/403),
* not-found (404), and other errors.
*/
import type { IPage } from '@jackwener/opencli/types';
import { AuthRequiredError, CommandExecutionError } from '@jackwener/opencli/errors';
const PIXIV_DOMAIN = 'www.pixiv.net';
/**
* Navigate to Pixiv (to attach cookies) then fetch a Pixiv Ajax API endpoint.
*
* Handles the common navigate → evaluate(fetch) → error-check pattern used
* by every Pixiv TS adapter.
*
* @param page - Browser page instance
* @param path - API path, e.g. '/ajax/illust/12345'
* @param opts - Optional query params
* @returns - The parsed `body` from the JSON response
* @throws AuthRequiredError on 401/403
* @throws CommandExecutionError on 404 or other HTTP errors
*/
export async function pixivFetch(
page: IPage,
path: string,
opts: { params?: Record<string, string | number>; notFoundMsg?: string } = {},
): Promise<any> {
await page.goto(`https://${PIXIV_DOMAIN}`);
const qs = opts.params
? '?' + Object.entries(opts.params).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')
: '';
const url = `https://${PIXIV_DOMAIN}${path}${qs}`;
const data: any = await page.evaluate(`
(async () => {
const res = await fetch(${JSON.stringify(url)}, { credentials: 'include' });
if (!res.ok) return { __httpError: res.status };
return await res.json();
})()
`);
if (data?.__httpError) {
const status = data.__httpError;
if (status === 401 || status === 403) {
throw new AuthRequiredError(PIXIV_DOMAIN, 'Authentication required — please log in to Pixiv in Chrome');
}
if (status === 404) {
throw new CommandExecutionError(opts.notFoundMsg || `Pixiv resource not found (HTTP 404)`);
}
throw new CommandExecutionError(`Pixiv request failed (HTTP ${status})`);
}
return data?.body;
}
/** Maximum number of illust IDs per batch detail request (Pixiv server limit). */
export const BATCH_SIZE = 48;