@crouter/api 0.3.387 → 0.3.388

package/dist/core/user-settings.d.ts

@@ -0,0 +1,377 @@
+import type { ScopeConfig } from '../types.js';
+/**
+ * Which settings destination owns a preference row. Every settings-surface row
+ * must name one, so a new preference cannot be added without deciding where a
+ * human finds it.
+ */
+export type UserSettingGroup = 'display' | 'panes' | 'providers' | 'updates';
+export interface UserSettingDefinition<Key extends string = string> {
+    key: Key;
+    label: string;
+    description: string;
+    valueConstraint: string;
+    applies: string;
+    group: UserSettingGroup;
+    order: number;
+    format: (config: ScopeConfig) => string;
+    cycle: (config: ScopeConfig, delta: number) => void;
+    /** Mutate `config` from a CLI string, returning a user-facing validation error on failure. */
+    setFromString: (config: ScopeConfig, raw: string) => string | null;
+}
+/**
+ * Exhaustive settings-surface coverage for ScopeConfig. Primitive preferences
+ * are required by the type to define a Settings row; structured registries must
+ * name the specialized surface that owns them. Adding a config field therefore
+ * fails typecheck until its user-facing settings coverage is decided. The
+ * auto_update nested record is exhaustive for the same reason.
+ */
+export declare const CONFIG_SETTINGS_COVERAGE: {
+    schema_version: {
+        surface: "specialized";
+        owner: string;
+    };
+    marketplaces: {
+        surface: "specialized";
+        owner: string;
+    };
+    plugins: {
+        surface: "specialized";
+        owner: string;
+    };
+    auto_update: {
+        surface: "settings";
+        settings: {
+            crtr: {
+                key: "auto_update.crtr";
+                label: string;
+                description: string;
+                valueConstraint: string;
+                applies: string;
+                group: "updates";
+                order: number;
+                format: (config: ScopeConfig) => "notify" | "apply" | "off";
+                cycle: (config: ScopeConfig, delta: number) => void;
+                setFromString: (config: ScopeConfig, raw: string) => "auto_update.crtr must be notify, apply, or false" | null;
+            };
+            content: {
+                key: "auto_update.content";
+                label: string;
+                description: string;
+                valueConstraint: string;
+                applies: string;
+                group: "updates";
+                order: number;
+                format: (config: ScopeConfig) => "notify" | "apply" | "off";
+                cycle: (config: ScopeConfig, delta: number) => void;
+                setFromString: (config: ScopeConfig, raw: string) => "auto_update.content must be notify, apply, or false" | null;
+            };
+            interval_hours: {
+                key: "auto_update.interval_hours";
+                label: string;
+                description: string;
+                valueConstraint: string;
+                applies: string;
+                group: "updates";
+                order: number;
+                format: (config: ScopeConfig) => string;
+                cycle: (config: ScopeConfig, delta: number) => void;
+                setFromString: (config: ScopeConfig, raw: string) => string | null;
+            };
+        };
+    };
+    max_panes_per_window: {
+        surface: "settings";
+        setting: {
+            key: "max_panes_per_window";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "panes";
+            order: number;
+            format: (config: ScopeConfig) => string;
+            cycle: (config: ScopeConfig, delta: number) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    auto_open_child_viewers: {
+        surface: "settings";
+        setting: {
+            key: "auto_open_child_viewers";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "panes";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off";
+            cycle: (config: ScopeConfig) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    brokerThresholds: {
+        surface: "specialized";
+        owner: string;
+    };
+    lifecycle: {
+        surface: "specialized";
+        owner: string;
+    };
+    completion_bell: {
+        surface: "settings";
+        setting: {
+            key: "completion_bell";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off";
+            cycle: (config: ScopeConfig) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    working_gerunds: {
+        surface: "specialized";
+        owner: string;
+    };
+    whip_mode: {
+        surface: "settings";
+        setting: {
+            key: "whip_mode";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off";
+            cycle: (config: ScopeConfig) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    page_surface: {
+        surface: "settings";
+        setting: {
+            key: "page_surface";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off";
+            cycle: (config: ScopeConfig) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    whip_messages: {
+        surface: "specialized";
+        owner: string;
+    };
+    whip_message_mode: {
+        surface: "settings";
+        setting: {
+            key: "whip_message_mode";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "random" | "go faster";
+            cycle: (config: ScopeConfig, delta: number) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    mouse_mode_default: {
+        surface: "settings";
+        setting: {
+            key: "mouse_mode_default";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off" | "follow tmux";
+            cycle: (config: ScopeConfig, delta: number) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    live_cycles: {
+        surface: "settings";
+        setting: {
+            key: "live_cycles";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => string;
+            cycle: (config: ScopeConfig, delta: number) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    condensed_history: {
+        surface: "settings";
+        setting: {
+            key: "condensed_history";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "user" | "none" | "agent" | "both";
+            cycle: (config: ScopeConfig, delta: number) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    bash_tool_purpose: {
+        surface: "settings";
+        setting: {
+            key: "bash_tool_purpose";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off";
+            cycle: (config: ScopeConfig) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    fold_finished_tools: {
+        surface: "settings";
+        setting: {
+            key: "fold_finished_tools";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off";
+            cycle: (config: ScopeConfig) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    summarize_tool_calls: {
+        surface: "settings";
+        setting: {
+            key: "summarize_tool_calls";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off";
+            cycle: (config: ScopeConfig) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    detailed_tool_recaps: {
+        surface: "settings";
+        setting: {
+            key: "detailed_tool_recaps";
+            label: string;
+            description: string;
+            valueConstraint: string;
+            applies: string;
+            group: "display";
+            order: number;
+            format: (config: ScopeConfig) => "on" | "off";
+            cycle: (config: ScopeConfig) => void;
+            setFromString: (config: ScopeConfig, raw: string) => string | null;
+        };
+    };
+    keybindings: {
+        surface: "specialized";
+        owner: string;
+    };
+    tmux_passthrough: {
+        surface: "specialized";
+        owner: string;
+    };
+    providerOptions: {
+        surface: "settings";
+        settings: {
+            'openai-codex.fastMode': {
+                key: "providerOptions.openai-codex.fastMode";
+                label: string;
+                description: string;
+                valueConstraint: string;
+                applies: string;
+                group: "providers";
+                order: number;
+                format: (config: ScopeConfig) => "on" | "off";
+                cycle: (config: ScopeConfig) => void;
+                setFromString: (config: ScopeConfig, raw: string) => string | null;
+            };
+        };
+    };
+    modelLadders: {
+        surface: "specialized";
+        owner: string;
+    };
+    modelRoutes: {
+        surface: "specialized";
+        owner: string;
+    };
+    modelRouting: {
+        surface: "specialized";
+        owner: string;
+    };
+    kinds: {
+        surface: "specialized";
+        owner: string;
+    };
+    page_components: {
+        surface: "specialized";
+        owner: string;
+    };
+    remoteCanvas: {
+        surface: "specialized";
+        owner: string;
+    };
+    api: {
+        surface: "specialized";
+        owner: string;
+    };
+    paths: {
+        surface: "specialized";
+        owner: string;
+    };
+    store: {
+        surface: "specialized";
+        owner: string;
+    };
+    runtime: {
+        surface: "specialized";
+        owner: string;
+    };
+    spawnEnv: {
+        surface: "specialized";
+        owner: string;
+    };
+    bin: {
+        surface: "specialized";
+        owner: string;
+    };
+    humanActions: {
+        surface: "specialized";
+        owner: string;
+    };
+};
+/** The exhaustive top-level key list used by config persistence and help. */
+export declare const SCOPE_CONFIG_KEYS: (keyof ScopeConfig)[];
+/** The single row registry shared by `sys settings` and `sys config set`. */
+export declare const USER_SETTINGS: readonly UserSettingDefinition[];
+export declare function findUserSetting(key: string): UserSettingDefinition | undefined;
+/** The rows one settings destination owns, in registry order. */
+export declare function userSettingsInGroup(group: UserSettingGroup): readonly UserSettingDefinition[];