aiwg/dist/src/smiths/context-pipeline/types.d.ts

Deployment tool and support utility for AI context. Copies agents, skills, commands, rules, and behaviors into the paths each AI platform reads (Claude Code, Codex, Copilot, Cursor, Warp, OpenClaw, and 6 more) so one source of truth works across 10 platfo

/**
 * Type definitions for the context-pipeline module.
 *
 * The context-pipeline emits two project-root files at the end of `aiwg use`:
 *
 * - AIWG.md  — CLAUDE.md-shaped framework context for non-Claude providers
 * - AGENTS.md — link-indexed bridge file pointing at AIWG.md and at deployed artifacts
 *
 * Per ADR-1 (.aiwg/architecture/adr-agents-md-aggregation.md). NOT part of agentsmith;
 * agentsmith creates subagent personas, this module assembles cross-platform context.
 */
import type { Platform } from '../../agents/types.js';
/**
 * Artifact types that can appear as link-index sections in AGENTS.md.
 *
 * Order in this list is the order sections appear in AGENTS.md.
 */
export type IndexedArtifactType = 'agents' | 'rules' | 'skills' | 'behaviors';
/**
 * One entry in an AGENTS.md link-index section.
 *
 * Path field MUST originate from the AIWG-owned PROVIDER_PATHS map plus the
 * canonical `~/.agents/skills/` cross-provider user-scope target. The allowlist
 * in `allowlist.ts` enforces this.
 */
export interface IndexEntry {
    /** Artifact id (kebab-case, matches the deployed file's basename) */
    id: string;
    /** One-line description, ≤120 chars after sanitization */
    description: string;
    /** Path relative to the repo root (e.g. `.codex/agents/api-designer.md`) */
    path: string;
    /** Optional tags (sanitized; comma-joined in emission) */
    tags?: string[];
    /** True if this artifact carries `safety-critical: true` per the override-shadow-policy ADR */
    safetyCritical?: boolean;
    /** Non-empty if this artifact has been legitimately shadowed via an `overrides:` declaration */
    shadowedBy?: string;
}
/**
 * One link-index section of AGENTS.md.
 */
export interface AgentsMdSection {
    type: IndexedArtifactType;
    entries: IndexEntry[];
}
/**
 * Options for context-pipeline generation.
 */
export interface ContextPipelineOptions {
    /** Provider this AGENTS.md targets. Determines variant (file name, twin-file emission) */
    provider: Platform;
    /** Repo root path */
    projectPath: string;
    /** Pre-aggregated link-index sections; the caller is responsible for collecting deployed artifacts */
    sections: AgentsMdSection[];
    /** Project-context prose (≤1000 chars). Empty string omits the section. */
    projectContext?: string;
    /** Where to source AIWG.md content from. If omitted, derives from `${projectPath}/CLAUDE.md` template */
    aiwgMdSource?: string;
    /** If true, refuse to overwrite existing AGENTS.md / AIWG.md without --force */
    detectExistingFiles?: boolean;
    /** Force overwrite (with backup-before-overwrite per ADR-1 R1 mitigation) */
    force?: boolean;
    /** Skip emission of either file (corresponds to --no-aiwg-md / --no-agents-md / --no-context-files) */
    skip?: {
        aiwgMd?: boolean;
        agentsMd?: boolean;
    };
    /**
     * Operator-declared overflow priority map per ADR-1 §6 / PUW-029.
     *
     * Keyed by artifact id. Special key `*` is the wildcard default. Values
     * 1 (pinned to AGENTS.md), 2 (medium; default), 3 (low; first to overflow).
     *
     * When omitted, all entries default to priority 2 except safety-critical
     * artifacts which are pinned to priority 1 unconditionally.
     */
    overflowPriorityMap?: Record<string, 1 | 2 | 3>;
}
/**
 * Result of a context-pipeline emission.
 */
export interface ContextPipelineResult {
    /** Path of AIWG.md emission (empty if skipped) */
    aiwgMdPath: string;
    /** Path of normalized .aiwg/AIWG.md emission */
    normalizedAiwgMdPath: string;
    /** Path of AGENTS.md emission (empty if skipped) */
    agentsMdPath: string;
    /** Twin-file emissions (.hermes.md, WARP.md) when applicable */
    twinPaths: string[];
    /** Backup paths created when --force overwrote existing operator content */
    backupPaths: string[];
    /** Total bytes written (used by PUW-029 32KB validator) */
    agentsMdBytes: number;
    /** Warnings emitted during generation (non-fatal) */
    warnings: string[];
}
/**
 * AIWG-wide brand defaults for the Codex `agents/openai.yaml` sidecar (PUW-028).
 *
 * Per ADR-1 signoff (2026-05-05): single brand identity for all skills.
 * Per-category mapping is a follow-up if demand surfaces.
 */
export declare const AIWG_BRAND_DEFAULTS: {
    readonly icon: "aiwg";
    readonly brandColor: "#0B5FFF";
};
//# sourceMappingURL=types.d.ts.map