create-principles-disciple 1.82.0 → 1.83.0

package/console/dist/server/config/pd-config-store.d.ts

@@ -0,0 +1,135 @@
+/**
+ * PD Config Store — PRI-309
+ *
+ * I/O boundary for reading and writing `.pd/config.yaml`.
+ * Uses core validation and effective config computation.
+ * Safe partial writes: validate before write, preserve unrelated sections,
+ * reject malformed existing file.
+ *
+ * ERR entries:
+ * - ERR-001/ERR-005: No `as` bypasses on untrusted parsed YAML
+ * - ERR-002: Graceful degradation includes reason
+ * - ERR-009/ERR-010: Required fields fail loud
+ * - ERR-013: Object.hasOwn() for untrusted keys
+ * - ERR-045: ANY-segment redaction for sensitive keys
+ */
+import type { EffectivePdConfig, RedactedPdConfigSummary, InternalAgentName } from '@principles/core/runtime-v2';
+export interface ConfigLoadResultOk {
+    ok: true;
+    effective: EffectivePdConfig;
+    source: 'defaults' | 'user_config';
+    configPath: string;
+    warnings: string[];
+}
+export interface ConfigLoadResultErr {
+    ok: false;
+    source: 'malformed';
+    configPath: string;
+    errors: {
+        path: string;
+        reason: string;
+        nextAction: string;
+    }[];
+    defaults: EffectivePdConfig;
+    warnings: string[];
+}
+export type ConfigLoadResult = ConfigLoadResultOk | ConfigLoadResultErr;
+export interface AgentBindingUpdate {
+    runtimeProfile: string;
+    enabled: boolean;
+}
+export interface AgentBindingUpdateResultOk {
+    ok: true;
+    agent: InternalAgentName;
+    runtimeProfile: string;
+    enabled: boolean;
+}
+export interface AgentBindingUpdateResultErr {
+    ok: false;
+    statusCode: number;
+    error: string;
+    message: string;
+}
+export type AgentBindingUpdateResult = AgentBindingUpdateResultOk | AgentBindingUpdateResultErr;
+export interface ReadinessError {
+    ok: false;
+    statusCode: number;
+    error: string;
+    message: string;
+}
+export interface ReadinessResult {
+    ok: true;
+    agent: InternalAgentName;
+    readiness: 'ready' | 'not_ready' | 'needs_setup' | 'disabled' | 'unknown';
+    profileId: string;
+    profileLabel: string;
+    reason?: string;
+    nextAction?: string;
+}
+export declare function validateBindingPayload(payload: unknown): {
+    ok: true;
+    value: AgentBindingUpdate;
+} | {
+    ok: false;
+    error: string;
+    message: string;
+};
+export declare function getPdConfigPath(workspaceDir: string): string;
+export declare function loadPdConfig(workspaceDir: string): ConfigLoadResult;
+export declare function getConfigSummary(workspaceDir: string): {
+    summary: RedactedPdConfigSummary;
+    errors?: {
+        path: string;
+        reason: string;
+        nextAction: string;
+    }[];
+};
+export declare function getConfigCatalog(workspaceDir: string): {
+    profiles: RedactedPdConfigSummary['runtimeProfiles'];
+    errors?: {
+        path: string;
+        reason: string;
+        nextAction: string;
+    }[];
+};
+export declare function updateAgentBinding(workspaceDir: string, agentName: string, payload: unknown): AgentBindingUpdateResult;
+export interface DefaultRuntimeUpdateResultOk {
+    ok: true;
+    defaultRuntime: string;
+}
+export interface DefaultRuntimeUpdateResultErr {
+    ok: false;
+    statusCode: number;
+    error: string;
+    message: string;
+}
+export type DefaultRuntimeUpdateResult = DefaultRuntimeUpdateResultOk | DefaultRuntimeUpdateResultErr;
+export declare function updateDefaultRuntime(workspaceDir: string, payload: unknown): DefaultRuntimeUpdateResult;
+/** Valid values for principles.outputLanguage in config.yaml */
+export declare const VALID_OUTPUT_LANGUAGES: readonly ["zh-CN", "en"];
+export type OutputLanguage = typeof VALID_OUTPUT_LANGUAGES[number];
+export interface OutputLanguageResultOk {
+    ok: true;
+    outputLanguage: OutputLanguage;
+    source: 'user_config' | 'default';
+}
+export interface OutputLanguageResultErr {
+    ok: false;
+    error: string;
+    statusCode: number;
+    message: string;
+    nextAction: string;
+}
+export type OutputLanguageResult = OutputLanguageResultOk | OutputLanguageResultErr;
+/**
+ * Read principles.outputLanguage from config.yaml.
+ * Returns default ('zh-CN') when not set.
+ * Fail loud if set to an invalid value (ERR-009).
+ */
+export declare function getPrinciplesOutputLanguage(workspaceDir: string): OutputLanguageResult;
+/**
+ * Update principles.outputLanguage in config.yaml.
+ * Safe partial write: preserves unknown sections, validates before write.
+ */
+export declare function updatePrinciplesOutputLanguage(workspaceDir: string, payload: unknown): OutputLanguageResult;
+export declare function checkReadiness(workspaceDir: string, agentName: string, getEnvVar?: (name: string) => string | undefined): ReadinessResult | ReadinessError;