@xingular/harness 2.0.0 → 2.0.1-unstable

package/dist/sdk/agents/profiles.d.ts

@@ -0,0 +1,93 @@
+import { type Effort } from "../core/effort.js";
+import { type PlanResearchContext } from "./planResearch.js";
+export declare const PROFILE_NAME: RegExp;
+/** Names a profile cannot take: `main` is how rosters show the agent a person talks to. */
+export declare const RESERVED_PROFILE_NAMES: readonly string[];
+export declare const PROFILE_COLORS: readonly ["blue", "green", "yellow", "red", "magenta", "cyan", "orange", "purple"];
+export type ProfileColor = (typeof PROFILE_COLORS)[number];
+export type ProfileSource = 'builtin' | 'global' | 'project' | 'variant' | 'plugin';
+/** Where a person's own profile file lives. */
+export type ProfileScope = 'global' | 'project';
+/** Which variant a profile's subagent runs: a scope's head or version, none, or the parent's (null). */
+export type ProfileVariant = {
+    scope: string;
+    version: string | null;
+} | 'none' | null;
+export interface AgentProfile {
+    name: string;
+    description: string;
+    color: ProfileColor;
+    /** The role instructions: the file's body. */
+    instructions: string;
+    /** Tool allowlist; null keeps every tool the parent has. */
+    tools: string[] | null;
+    /** Plugin ids whose contributions the subagent keeps; null keeps all. Required plugins always stay. */
+    plugins: string[] | null;
+    variant: ProfileVariant;
+    model: string | null;
+    effort: Effort | null;
+    source: ProfileSource;
+    /** The file it was read from; null for built-ins. */
+    path: string | null;
+}
+export interface ProfileProblem {
+    name: string;
+    source: ProfileSource;
+    path: string;
+    error: string;
+}
+export interface ProfileListing {
+    profiles: AgentProfile[];
+    problems: ProfileProblem[];
+}
+/** The built-in profile definitions, before a source is attached. */
+export type ProfileDefinition = Omit<AgentProfile, 'source' | 'path'>;
+/** Nearest folder above `cwd` that holds `.git`, or `cwd` itself. */
+export declare function projectRoot(cwd: string): string;
+export declare function profileDirs(root: string, cwd?: string | null): {
+    global: string;
+    project: string | null;
+};
+export declare function parseVariant(value: unknown): ProfileVariant;
+export declare function formatVariant(variant: ProfileVariant): string | null;
+/** Reads one profile file. Throws an `invalid_request` error that names what is wrong. */
+export declare function parseProfile(text: string, name: string, source: ProfileSource, path: string | null): AgentProfile;
+/** The file text for a profile, as `createProfile` writes it. */
+export declare function profileText(profile: ProfileDefinition): string;
+/**
+ * A profile a package brings. It is named by its frontmatter, since such packages are often written
+ * for other agent harnesses whose files are not named after their agents. What only those
+ * harnesses understand is dropped: their tool names are translated, a model without a provider
+ * (`inherit`, `sonnet`) is left to the parent, and a package never pins a variant or plugins. A
+ * tool list of which nothing translates keeps the subagent read-only rather than widening it.
+ */
+export declare function parsePackageProfile(text: string, path: string): AgentProfile;
+/**
+ * Every profile a session in `cwd` can use. An unreadable file is reported in `problems`; it hides
+ * nothing, so a broken project file leaves the global or built-in profile of that name in force.
+ * `packageProfiles` are the profile files of the session's switched-on packages.
+ */
+export declare function listProfiles(root: string, cwd?: string | null, variantDir?: string | null, packageProfiles?: readonly string[]): ProfileListing;
+export declare function resolveProfile(root: string, cwd: string | null | undefined, name: string, variantDir?: string | null, packageProfiles?: readonly string[]): AgentProfile | null;
+/** Writes a new profile file from the template, or a copy of `from`. Refuses to overwrite one. */
+export declare function createProfile(root: string, cwd: string | null | undefined, input: {
+    name: string;
+    scope: ProfileScope;
+    from?: string | null;
+}): AgentProfile;
+/** Deletes a person's own profile file. Built-ins and variant subagents cannot be removed here. */
+export declare function removeProfile(root: string, cwd: string | null | undefined, input: {
+    name: string;
+    scope: ProfileScope;
+}): void;
+/** Where the profile list sits among the prompt sections: the slot a variant's subagents used. */
+export declare const PROFILE_SECTION_ORDER = 64;
+/** The prompt section that lists the profiles a run can start subagents from. */
+export declare function profileSection(root: string, cwd: string | null | undefined, variantDir?: string | null, planResearchOnly?: boolean, researchContext?: PlanResearchContext, packageProfiles?: readonly string[]): {
+    id: string;
+    title: string;
+    body: string;
+    budget: number;
+    order: number;
+    dynamic: true;
+};

package/dist/sdk/agents/profiles.js

@@ -0,0 +1,289 @@
+// Agent profiles (PROP-0029): named bundles a subagent starts from, with its instructions, colour,
+// tools, plugins, variant, model and effort. They come from four places, later ones winning:
+// built-ins in code, `<data root>/agents/*.md`, `<project>/.xingular/agents/*.md`; a variant's own
+// c5 subagents, then the profiles of switched-on packages, fill in names nobody else took.
+// Profiles only narrow what the parent has.
+import { existsSync, mkdirSync, readdirSync, readFileSync, rmSync, statSync } from 'node:fs';
+import { basename, dirname, join } from 'node:path';
+import { EFFORTS } from "../core/effort.js";
+import { invalid, notFound } from "../core/errors.js";
+import { parse, serialize } from "../core/frontmatter.js";
+import { atomicWrite } from "../core/fs.js";
+import { subagentOf } from "../variant/materialise.js";
+import { BUILTIN_PROFILES } from "./builtin.js";
+import { planResearchEligibility, planResearchProfile } from "./planResearch.js";
+export const PROFILE_NAME = /^[a-z0-9][a-z0-9_-]*$/;
+/** Names a profile cannot take: `main` is how rosters show the agent a person talks to. */
+export const RESERVED_PROFILE_NAMES = ['main'];
+const reservedRefusal = (name) => `${name} is reserved for the main agent; choose another profile name.`;
+export const PROFILE_COLORS = ['blue', 'green', 'yellow', 'red', 'magenta', 'cyan', 'orange', 'purple'];
+/** Nearest folder above `cwd` that holds `.git`, or `cwd` itself. */
+export function projectRoot(cwd) {
+    let dir = cwd;
+    for (;;) {
+        if (existsSync(join(dir, '.git')))
+            return dir;
+        const parent = dirname(dir);
+        if (parent === dir)
+            return cwd;
+        dir = parent;
+    }
+}
+export function profileDirs(root, cwd) {
+    return { global: join(root, 'agents'), project: cwd ? join(projectRoot(cwd), '.xingular', 'agents') : null };
+}
+function stringList(value, field) {
+    if (value === undefined || value === null)
+        return null;
+    const list = typeof value === 'string' ? value.split(/[\s,]+/u) : value;
+    if (!Array.isArray(list) || list.some(item => typeof item !== 'string'))
+        throw invalid(`${field} must be a list of names.`);
+    return [...new Set(list.map(item => item.trim()).filter(Boolean))];
+}
+function optionalText(value, field) {
+    if (value === undefined || value === null || value === '')
+        return null;
+    if (typeof value !== 'string')
+        throw invalid(`${field} must be text.`);
+    return value.trim() || null;
+}
+export function parseVariant(value) {
+    const text = optionalText(value, 'variant');
+    if (!text)
+        return null;
+    if (text === 'none')
+        return 'none';
+    const [scope, version, ...rest] = text.split('@');
+    if (!scope || rest.length || (version !== undefined && !version))
+        throw invalid('variant must be <scope>, <scope>@<version> or none.');
+    return { scope, version: version ?? null };
+}
+export function formatVariant(variant) {
+    if (!variant)
+        return null;
+    if (variant === 'none')
+        return 'none';
+    return variant.version ? `${variant.scope}@${variant.version}` : variant.scope;
+}
+/** Reads one profile file. Throws an `invalid_request` error that names what is wrong. */
+export function parseProfile(text, name, source, path) {
+    if (!PROFILE_NAME.test(name))
+        throw invalid('A profile name uses lowercase letters, digits, - and _, and starts with a letter or digit.');
+    if (RESERVED_PROFILE_NAMES.includes(name))
+        throw invalid(reservedRefusal(name));
+    const parsed = parse(text);
+    if (!parsed)
+        throw invalid('The profile needs a frontmatter block between --- lines.');
+    const front = parsed.front;
+    if (front.name !== undefined && front.name !== name)
+        throw invalid(`The file is named ${name} but its frontmatter says ${String(front.name)}.`);
+    const description = optionalText(front.description, 'description');
+    if (!description)
+        throw invalid('The profile needs a description.');
+    const color = optionalText(front.color, 'color') ?? 'blue';
+    if (!PROFILE_COLORS.includes(color))
+        throw invalid(`color must be one of ${PROFILE_COLORS.join(', ')}.`);
+    const effort = optionalText(front.effort, 'effort');
+    if (effort && !EFFORTS.includes(effort))
+        throw invalid(`effort must be one of ${EFFORTS.join(', ')}.`);
+    return {
+        name, description, color: color, instructions: parsed.body.trim(),
+        tools: stringList(front.tools, 'tools'), plugins: stringList(front.plugins, 'plugins'),
+        variant: parseVariant(front.variant), model: optionalText(front.model, 'model'), effort: effort,
+        source, path
+    };
+}
+/** The file text for a profile, as `createProfile` writes it. */
+export function profileText(profile) {
+    const front = { name: profile.name, description: profile.description, color: profile.color };
+    if (profile.tools)
+        front.tools = profile.tools;
+    if (profile.plugins)
+        front.plugins = profile.plugins;
+    const variant = formatVariant(profile.variant);
+    if (variant)
+        front.variant = variant;
+    if (profile.model)
+        front.model = profile.model;
+    if (profile.effort)
+        front.effort = profile.effort;
+    return serialize(front, profile.instructions);
+}
+function readFolder(dir, source, into, problems) {
+    if (!dir || !existsSync(dir))
+        return;
+    for (const file of readdirSync(dir).filter(entry => entry.endsWith('.md')).sort()) {
+        const path = join(dir, file);
+        const name = file.slice(0, -3);
+        try {
+            if (!statSync(path).isFile())
+                continue;
+            into.set(name, parseProfile(readFileSync(path, 'utf8'), name, source, path));
+        }
+        catch (error) {
+            problems.push({ name, source, path, error: error instanceof Error ? error.message : String(error) });
+        }
+    }
+}
+function variantDefinitions(variantDir) {
+    const folder = variantDir ? join(variantDir, 'sub_agents') : null;
+    if (!folder || !existsSync(folder))
+        return [];
+    return readdirSync(folder).sort().flatMap(name => {
+        const definition = RESERVED_PROFILE_NAMES.includes(name) ? null : subagentOf(variantDir, name);
+        if (!definition)
+            return [];
+        return [{
+                name, description: definition.description || name, color: 'blue', instructions: definition.instructions || definition.description,
+                tools: null, plugins: null, variant: null, model: null, effort: null,
+                source: 'variant', path: join(folder, name, 'AGENT.md')
+            }];
+    });
+}
+// Tool names that agent plugins written for other harnesses use, as this harness names them.
+const FOREIGN_TOOLS = {
+    Read: 'read', Grep: 'grep', Glob: 'find', LS: 'ls', Edit: 'edit', MultiEdit: 'edit', Write: 'write', Bash: 'bash',
+    WebSearch: 'web_search', WebFetch: 'web_fetch', TodoWrite: 'todo_write'
+};
+const READ_ONLY_TOOLS = ['read', 'grep', 'find', 'ls'];
+/**
+ * A profile a package brings. It is named by its frontmatter, since such packages are often written
+ * for other agent harnesses whose files are not named after their agents. What only those
+ * harnesses understand is dropped: their tool names are translated, a model without a provider
+ * (`inherit`, `sonnet`) is left to the parent, and a package never pins a variant or plugins. A
+ * tool list of which nothing translates keeps the subagent read-only rather than widening it.
+ */
+export function parsePackageProfile(text, path) {
+    const parsed = parse(text);
+    if (!parsed)
+        throw invalid('The profile needs a frontmatter block between --- lines.');
+    const front = parsed.front;
+    const name = optionalText(front.name, 'name');
+    if (!name || !PROFILE_NAME.test(name))
+        throw invalid('A profile name uses lowercase letters, digits, - and _, and starts with a letter or digit.');
+    if (RESERVED_PROFILE_NAMES.includes(name))
+        throw invalid(reservedRefusal(name));
+    const description = optionalText(front.description, 'description');
+    if (!description)
+        throw invalid('The profile needs a description.');
+    const declared = stringList(front.tools, 'tools');
+    const tools = declared ? [...new Set(declared.flatMap((tool) => FOREIGN_TOOLS[tool] ?? (/^[a-z][a-z0-9_]*$/.test(tool) ? [tool] : [])))] : null;
+    const color = typeof front.color === 'string' && PROFILE_COLORS.includes(front.color) ? front.color : 'blue';
+    const model = typeof front.model === 'string' && front.model.includes('/') ? front.model : null;
+    const effort = typeof front.effort === 'string' && EFFORTS.includes(front.effort) ? front.effort : null;
+    return {
+        name, description, color, instructions: parsed.body.trim(),
+        tools: tools && !tools.length ? READ_ONLY_TOOLS : tools, plugins: null, variant: null, model, effort,
+        source: 'plugin', path
+    };
+}
+/**
+ * Every profile a session in `cwd` can use. An unreadable file is reported in `problems`; it hides
+ * nothing, so a broken project file leaves the global or built-in profile of that name in force.
+ * `packageProfiles` are the profile files of the session's switched-on packages.
+ */
+export function listProfiles(root, cwd, variantDir, packageProfiles = []) {
+    const profiles = new Map();
+    const problems = [];
+    for (const definition of BUILTIN_PROFILES)
+        profiles.set(definition.name, { ...definition, source: 'builtin', path: null });
+    const dirs = profileDirs(root, cwd);
+    readFolder(dirs.global, 'global', profiles, problems);
+    readFolder(dirs.project, 'project', profiles, problems);
+    for (const definition of variantDefinitions(variantDir))
+        if (!profiles.has(definition.name))
+            profiles.set(definition.name, definition);
+    // A package cannot replace a profile a person, the harness or the variant already has.
+    for (const path of packageProfiles) {
+        try {
+            const profile = parsePackageProfile(readFileSync(path, 'utf8'), path);
+            if (!profiles.has(profile.name))
+                profiles.set(profile.name, profile);
+            else
+                problems.push({ name: profile.name, source: 'plugin', path, error: `A ${profiles.get(profile.name).source} profile already has this name, so the package's is not used.` });
+        }
+        catch (error) {
+            problems.push({ name: basename(path, '.md'), source: 'plugin', path, error: error instanceof Error ? error.message : String(error) });
+        }
+    }
+    return { profiles: [...profiles.values()].sort((left, right) => left.name.localeCompare(right.name)), problems };
+}
+export function resolveProfile(root, cwd, name, variantDir, packageProfiles = []) {
+    if (!PROFILE_NAME.test(name))
+        return null;
+    return listProfiles(root, cwd, variantDir, packageProfiles).profiles.find(profile => profile.name === name) ?? null;
+}
+function scopeDir(root, cwd, scope) {
+    const dirs = profileDirs(root, cwd);
+    if (scope === 'global')
+        return dirs.global;
+    if (!dirs.project)
+        throw invalid('A project profile needs a working folder.');
+    return dirs.project;
+}
+const TEMPLATE = {
+    description: 'What this agent is for, in one line.',
+    color: 'blue',
+    instructions: 'Describe how this agent should work: what to do with a brief, what to avoid, and what to report back.',
+    tools: null, plugins: null, variant: null, model: null, effort: null
+};
+/** Writes a new profile file from the template, or a copy of `from`. Refuses to overwrite one. */
+export function createProfile(root, cwd, input) {
+    const name = typeof input.name === 'string' ? input.name.trim() : '';
+    if (!PROFILE_NAME.test(name))
+        throw invalid('A profile name uses lowercase letters, digits, - and _, and starts with a letter or digit.');
+    if (RESERVED_PROFILE_NAMES.includes(name))
+        throw invalid(reservedRefusal(name));
+    if (input.scope !== 'global' && input.scope !== 'project')
+        throw invalid('scope must be global or project.');
+    const dir = scopeDir(root, cwd, input.scope);
+    const path = join(dir, `${name}.md`);
+    if (existsSync(path))
+        throw invalid(`There is already a ${input.scope} profile named ${name}.`);
+    let source = { ...TEMPLATE, name };
+    if (input.from) {
+        const original = resolveProfile(root, cwd, input.from);
+        if (!original)
+            throw notFound(`The profile ${input.from}`);
+        source = { ...original, name };
+    }
+    mkdirSync(dir, { recursive: true });
+    const text = profileText(source);
+    atomicWrite(path, text);
+    return parseProfile(text, name, input.scope, path);
+}
+/** Deletes a person's own profile file. Built-ins and variant subagents cannot be removed here. */
+export function removeProfile(root, cwd, input) {
+    if (!PROFILE_NAME.test(input.name))
+        throw invalid('That is not a profile name.');
+    if (input.scope !== 'global' && input.scope !== 'project')
+        throw invalid('scope must be global or project.');
+    const path = join(scopeDir(root, cwd, input.scope), `${input.name}.md`);
+    if (!existsSync(path))
+        throw notFound(`The ${input.scope} profile ${input.name}`);
+    rmSync(path);
+}
+/** Where the profile list sits among the prompt sections: the slot a variant's subagents used. */
+export const PROFILE_SECTION_ORDER = 64;
+/** The prompt section that lists the profiles a run can start subagents from. */
+export function profileSection(root, cwd, variantDir, planResearchOnly = false, researchContext, packageProfiles = []) {
+    const { profiles } = listProfiles(root, cwd, variantDir, packageProfiles);
+    const listed = planResearchOnly
+        ? profiles.filter(profile => researchContext
+            ? planResearchEligibility(profile, researchContext).eligible
+            : planResearchProfile(profile))
+        : profiles;
+    return {
+        id: 'subagents',
+        title: 'Subagents',
+        body: [
+            planResearchOnly
+                ? 'Plan mode may start only a named profile listed here, for read-only research. Do not omit agent or use a profile not listed. Omit the optional tools field to inherit the safe available intersection; specify it only to narrow further.'
+                : 'Delegate when it meaningfully reduces work: choose a substantial, bounded task that can proceed independently, such as unfamiliar cross-file research likely to take several searches or a self-contained implementation. Do a known-file lookup, one or two simple tool calls, a tiny edit or tightly coupled work yourself. Prefer a named profile: explorer for repository research, researcher for public-source research, and worker for a defined change it can own end to end; omit agent only when no profile fits. Each child starts without this conversation, so give it the goal, relevant context or paths, non-goals, expected result and acceptance or verification; use its own todo list for multi-step work. Prefer context-heavy research with concise evidence-backed findings. Parallelize only independent tasks and never assign overlapping edits. Return without waiting only when useful independent work remains; otherwise wait. You own integration, verification and the user-facing report. A profile can only narrow your tools.',
+            ...(listed.length ? listed.map((profile) => `- ${profile.name} — ${profile.description}`) : ['- No eligible read-only research profiles are configured.'])
+        ].join('\n'),
+        budget: 6_000,
+        order: PROFILE_SECTION_ORDER,
+        dynamic: true
+    };
+}

package/dist/sdk/annotations/bridge.d.ts

@@ -0,0 +1,44 @@
+import { type PageOperation } from "./pageScript.js";
+export interface BridgeWindow {
+    id: string;
+    url: string;
+    title: string;
+    lastSeen: number;
+}
+export interface BridgeInfo {
+    port: number;
+    token: string;
+    scriptUrl: string;
+    /** What to put in the app while developing it. */
+    snippet: string;
+}
+/** The script a window loads: the page helper plus a loop that pulls operations from the bridge. */
+export declare function bridgeScript(base: string, token: string): string;
+export declare class NotesBridge {
+    private readonly options;
+    private server;
+    private starting;
+    private info;
+    private readonly windows;
+    private nextWindow;
+    private nextCall;
+    constructor(options: {
+        stateDir: string;
+        port?: number;
+    });
+    private settingsFile;
+    /** Starts the bridge (once) on the port and token kept from last time, so the app's snippet stays valid. */
+    start(): Promise<BridgeInfo>;
+    /** What a window loads, once the bridge is listening. */
+    current(): BridgeInfo | null;
+    private listen;
+    list(): BridgeWindow[];
+    /** Sends one helper operation to a window and waits for its JSON reply. */
+    call(windowId: string, operation: PageOperation): Promise<unknown>;
+    private flush;
+    private sweep;
+    private json;
+    private body;
+    private handle;
+    close(): Promise<void>;
+}