@tiangong-ai/cli 0.0.38 → 0.0.40

package/dist/research/workspace/setup-declarative.d.ts

@@ -0,0 +1,126 @@
+import { type ApplyResearchSetupOptions, type ResearchSetupAgentRoutePlan, type ResearchSetupPlan, type ResearchSetupPlanInput, type ResearchSetupState } from "./setup.js";
+import type { ResearchMode } from "./types.js";
+type DeclarationRequirement = "required" | "conditional" | "optional";
+type DeclarativeEvidenceProfile = "none" | "brave-baseline" | "brave-context" | "brave-media";
+interface DeclarationSkillChoice {
+    enabled: boolean;
+    licenseId: string;
+}
+interface DeclarationCredentialChoice {
+    requirement: DeclarationRequirement;
+    appliesTo: string[];
+    enabled: boolean;
+    environment: string;
+}
+interface DeclarationSettingChoice {
+    requirement: DeclarationRequirement;
+    appliesTo: string[];
+    enabled: boolean;
+    value: string | null;
+}
+interface ResearchSetupDeclaration {
+    schemaVersion: 2;
+    kind: "tiangong-research-setup";
+    workspace: {
+        name?: string;
+        mode: ResearchMode;
+    };
+    install: {
+        scope: "project" | "global";
+        agents: Array<"codex" | "claude-code">;
+    };
+    selection: {
+        skills: Record<string, DeclarationSkillChoice>;
+    };
+    acceptedLicenseIds: string[];
+    credentials: Record<string, DeclarationCredentialChoice>;
+    settings: Record<string, DeclarationSettingChoice>;
+    agentRoutes: Partial<ResearchSetupAgentRoutePlan> & Pick<ResearchSetupAgentRoutePlan, "producerAgent" | "reviewerAgent">;
+    verification: {
+        live: boolean;
+        allowSyntheticUnstructureUpload: boolean;
+        agentSmoke: boolean;
+    };
+    confirmations: {
+        networkDownloads: boolean;
+        globalMutation: boolean;
+        agentSmokeCost: boolean;
+    };
+    replaceExistingPlan: boolean;
+}
+export interface LoadedResearchSetupDeclaration {
+    workspace: string;
+    configurationPath: string;
+    environmentPath: string | null;
+    configurationSha256: string;
+    planInput: Omit<ResearchSetupPlanInput, "workspace" | "environment">;
+    environment: NodeJS.ProcessEnv;
+    publicSummary: {
+        mode: ResearchMode;
+        evidenceProfile: DeclarativeEvidenceProfile;
+        selectedSkillIds: string[];
+        enabledCredentialIds: string[];
+        declaredCredentialIds: string[];
+        verification: ResearchSetupDeclaration["verification"];
+        environmentFileUsed: boolean;
+    };
+}
+interface DeclarativeSetupApplicationResult {
+    schemaVersion: 1;
+    plan: ResearchSetupPlan;
+    state: ResearchSetupState;
+    report: null | {
+        overallReadiness?: "READY" | "PARTIALLY_READY" | "BLOCKED";
+        [key: string]: unknown;
+    };
+}
+export interface ResearchSetupDeclarationOperations {
+    createPlan(input: ResearchSetupPlanInput): Promise<ResearchSetupPlan>;
+    loadPlan(planPath: string): Promise<ResearchSetupPlan>;
+    applyPlan(planPath: string, options: ApplyResearchSetupOptions): Promise<DeclarativeSetupApplicationResult>;
+}
+export declare function initializeResearchSetupDeclaration(workspace: string): Promise<{
+    schemaVersion: 1;
+    workspace: string;
+    configurationPath: string;
+    environmentExamplePath: string;
+    next: {
+        minimumAction: string;
+        setupCommand: string;
+    };
+}>;
+export declare function discoverResearchSetupDeclaration(workspace: string, options?: {
+    configurationPath?: string;
+    environmentPath?: string;
+}): Promise<{
+    configurationPath: string;
+    environmentPath: string | null;
+} | null>;
+export declare function loadResearchSetupDeclaration(input: {
+    workspace: string;
+    configurationPath?: string;
+    environmentPath?: string;
+    environment?: NodeJS.ProcessEnv;
+}): Promise<LoadedResearchSetupDeclaration>;
+export declare function executeResearchSetupDeclaration(input: {
+    workspace: string;
+    configurationPath?: string;
+    environmentPath?: string;
+    environment?: NodeJS.ProcessEnv;
+    operations?: Partial<ResearchSetupDeclarationOperations>;
+}): Promise<{
+    schemaVersion: 1;
+    mode: "declarative";
+    status: "ready" | "incomplete";
+    exitCode: 0 | 3;
+    reusedPlan: boolean;
+    configuration: {
+        path: string;
+        sha256: string;
+        environmentFileUsed: boolean;
+    };
+    plan: ResearchSetupPlan;
+    state: ResearchSetupState;
+    report: DeclarativeSetupApplicationResult["report"];
+}>;
+export {};