Files
jackwener__opencli/clis/ones/my-tasks.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

149 lines
4.6 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import { cli, Strategy } from '@jackwener/opencli/registry';
import { CliError } from '@jackwener/opencli/errors';
import type { IPage } from '@jackwener/opencli/types';
import { gotoOnesHome, onesFetchInPage, resolveOnesUserUuid } from './common.js';
import { enrichPeekEntriesWithDetails } from './enrich-tasks.js';
import { resolveTaskListLabels } from './resolve-labels.js';
import {
defaultPeekBody,
flattenPeekGroups,
mapTaskEntry,
parsePeekLimit,
} from './task-helpers.js';
/** 文档示例里「负责人」常用 field004;与顶层 assign 在不同部署上二选一有效 */
function queryAssign(userUuid: string): Record<string, unknown> {
return { must: [{ equal: { assign: userUuid } }] };
}
function queryAssignField004(userUuid: string): Record<string, unknown> {
return { must: [{ in: { 'field_values.field004': [userUuid] } }] };
}
function queryOwner(userUuid: string): Record<string, unknown> {
return { must: [{ equal: { owner: userUuid } }] };
}
function dedupeByUuid(entries: Record<string, unknown>[]): Record<string, unknown>[] {
const seen = new Set<string>();
const out: Record<string, unknown>[] = [];
for (const e of entries) {
const id = String(e.uuid ?? '');
if (!id || seen.has(id)) continue;
seen.add(id);
out.push(e);
}
return out;
}
async function peekTasks(
page: IPage,
team: string,
query: Record<string, unknown>,
cap: number,
): Promise<Record<string, unknown>[]> {
const path = `team/${team}/filters/peek`;
const body = defaultPeekBody(query);
const parsed = (await onesFetchInPage(page, path, {
method: 'POST',
body: JSON.stringify(body),
skipGoto: true,
})) as Record<string, unknown>;
return flattenPeekGroups(parsed, cap);
}
cli({
site: 'ones',
name: 'my-tasks',
description:
'ONES — my work items (filters/peek + strict must query). Default: assignee=me. Use --mode if your site uses field004 for assignee.',
domain: 'ones.cn',
strategy: Strategy.COOKIE,
browser: true,
navigateBefore: false,
args: [
{
name: 'team',
type: 'str',
required: false,
positional: true,
help: 'Team UUID from URL …/team/<uuid>/…, or set ONES_TEAM_UUID',
},
{
name: 'limit',
type: 'int',
default: 100,
help: 'Max rows (default 100, max 500)',
},
{
name: 'mode',
type: 'str',
default: 'assign',
choices: ['assign', 'field004', 'owner', 'both'],
help:
'assign=负责人(顶层 assign);field004=负责人(筛选器示例里的 field004);owner=创建者;both=负责人∪创建者(两次 peek 去重)',
},
],
columns: ['title', 'status', 'project', 'uuid', 'updated', '工时'],
func: async (page, kwargs) => {
const team =
(kwargs.team as string | undefined)?.trim() ||
process.env.ONES_TEAM_UUID?.trim() ||
process.env.ONES_TEAM_ID?.trim();
if (!team) {
throw new CliError(
'CONFIG',
'team UUID required',
'Pass team from URL …/team/<team>/… or set ONES_TEAM_UUID.',
);
}
const limit = parsePeekLimit(kwargs.limit, 100);
const mode = String(kwargs.mode ?? 'assign');
await gotoOnesHome(page);
const userUuid = await resolveOnesUserUuid(page, { skipGoto: true });
let entries: Record<string, unknown>[] = [];
if (mode === 'both') {
const cap = Math.min(500, limit * 2);
const asAssign = await peekTasks(page, team, queryAssign(userUuid), cap);
const asOwner = await peekTasks(page, team, queryOwner(userUuid), cap);
entries = dedupeByUuid([...asAssign, ...asOwner]).slice(0, limit);
} else {
const queryByMode = (): Record<string, unknown> => {
switch (mode) {
case 'field004':
return queryAssignField004(userUuid);
case 'owner':
return queryOwner(userUuid);
case 'assign':
default:
return queryAssign(userUuid);
}
};
const primary = queryByMode();
try {
entries = await peekTasks(page, team, primary, limit);
} catch (e) {
const msg = e instanceof Error ? e.message : '';
const canFallback =
mode === 'assign' &&
(msg.includes('ServerError') || msg.includes('801') || msg.includes('Params is invalid'));
if (canFallback) {
entries = await peekTasks(page, team, queryAssignField004(userUuid), limit);
} else {
throw e;
}
}
}
const enriched = await enrichPeekEntriesWithDetails(page, team, entries, true);
const labels = await resolveTaskListLabels(page, team, enriched, true);
return enriched.map((e) => mapTaskEntry(e, labels));
},
});