yam-flow 2.3.2 → 2.5.0

package/dist/lib/external-updates.d.ts

@@ -0,0 +1,103 @@
+export declare const EXTERNAL_UPDATE_COMPONENTS: readonly ["yam", "scrapling", "insane-search"];
+export type ExternalUpdateComponent = typeof EXTERNAL_UPDATE_COMPONENTS[number];
+type JsonRecord = Record<string, any>;
+export interface ExternalCommandResult {
+    ok: boolean;
+    status: number | null;
+    stdout: string;
+    stderr: string;
+}
+export interface ExternalCommandOptions {
+    cwd?: string;
+    env?: NodeJS.ProcessEnv;
+    timeout?: number;
+}
+export interface ExternalUpdatePaths {
+    stateDir: string;
+    receiptDir: string;
+    lockFile: string;
+    scraplingRoot: string;
+    scraplingBin: string;
+}
+export interface ExternalUpdateDependencies {
+    run?: (command: string, args: string[], options?: ExternalCommandOptions) => Promise<ExternalCommandResult> | ExternalCommandResult;
+    fetchJson?: (url: string) => Promise<any>;
+    now?: () => Date;
+    homeDir?: string;
+    env?: NodeJS.ProcessEnv;
+    paths?: Partial<ExternalUpdatePaths>;
+    removeCandidate?: (candidate: string, root: string) => Promise<void>;
+}
+export interface ExternalComponentCheck {
+    component: ExternalUpdateComponent;
+    installed_version: string;
+    latest_version: string;
+    update_available: boolean;
+    status: 'up_to_date' | 'update_available' | 'not_installed' | 'check_failed';
+    source: string;
+    source_revision?: {
+        local: string;
+        remote: string;
+        drift: boolean;
+        note: string;
+    };
+    executable?: string;
+    error?: string;
+}
+export interface ExternalComponentReceipt {
+    schema: 'yam.external-update-receipt.v1';
+    generated_at: string;
+    component: ExternalUpdateComponent;
+    outcome: 'up_to_date' | 'updated' | 'failed' | 'manual_plugin_update_required';
+    previous_version: string;
+    requested_version: string;
+    installed_version: string;
+    source: string;
+    source_revision: JsonRecord | null;
+    checks: Array<{
+        id: string;
+        status: 'passed' | 'failed' | 'skipped';
+        note: string;
+    }>;
+    rollback_hint: {
+        automatic: boolean;
+        previous_target: string;
+        guidance: string;
+    };
+    side_effects: string[];
+    error: string;
+    truth_status: 'verified' | 'partial' | 'blocked';
+    persistence?: 'written' | 'failed';
+    receipt_path?: string;
+    receipt_error?: string;
+}
+export declare function checkExternalUpdates(currentYamVersion: string, dependencies?: ExternalUpdateDependencies): Promise<{
+    schema: string;
+    generated_at: string;
+    mutation_authorized: boolean;
+    components: [ExternalComponentCheck, ExternalComponentCheck, ExternalComponentCheck];
+    update_available: boolean;
+    success: boolean;
+    truth_status: string;
+    next_action: string;
+}>;
+export declare function applyExternalUpdates(currentYamVersion: string, selection: {
+    component?: ExternalUpdateComponent;
+    all?: boolean;
+}, dependencies?: ExternalUpdateDependencies): Promise<{
+    schema: string;
+    generated_at: string;
+    mutation_authorized: boolean;
+    requested_components: ("yam" | "scrapling" | "insane-search")[];
+    applied_components: ("yam" | "scrapling" | "insane-search")[];
+    receipts: ExternalComponentReceipt[];
+    stopped_early: boolean;
+    lock: {
+        path: string;
+        released: boolean;
+    };
+    success: boolean;
+    truth_status: string;
+    next_action: string;
+}>;
+export {};