@geoqiao/pi-ask 1.1.0

package/src/config/schema.ts

@@ -0,0 +1,287 @@
+import { type Static, Type } from "typebox";
+import { Compile } from "typebox/compile";
+
+const AskAnswerModelPreferenceSchema = Type.Object({
+	id: Type.String(),
+	provider: Type.String(),
+});
+
+const AskNotificationChannelSchema = Type.Union([
+	Type.Literal("bell"),
+	Type.Literal("osc9"),
+	Type.Literal("osc777"),
+	Type.Object({
+		command: Type.String(),
+		type: Type.Literal("command"),
+	}),
+]);
+
+const AskKeyBindingSchema = Type.Union([
+	Type.String(),
+	Type.Array(Type.String()),
+]);
+
+const AskConfigKeymapsV4Schema = Type.Object({
+	global: Type.Object({
+		dismiss: Type.Optional(AskKeyBindingSchema),
+		settings: Type.Optional(AskKeyBindingSchema),
+	}),
+	main: Type.Object({
+		cancel: Type.Optional(AskKeyBindingSchema),
+		confirm: Type.Optional(AskKeyBindingSchema),
+		nextOption: Type.Optional(AskKeyBindingSchema),
+		nextTab: Type.Optional(AskKeyBindingSchema),
+		optionNote: Type.Optional(AskKeyBindingSchema),
+		previousOption: Type.Optional(AskKeyBindingSchema),
+		previousTab: Type.Optional(AskKeyBindingSchema),
+		questionNote: Type.Optional(AskKeyBindingSchema),
+		toggle: Type.Optional(AskKeyBindingSchema),
+	}),
+	editor: Type.Object({
+		close: Type.Optional(AskKeyBindingSchema),
+		nextOptionWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		nextTabWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		previousOptionWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		previousTabWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		submit: Type.Optional(AskKeyBindingSchema),
+	}),
+	noteEditor: Type.Object({
+		close: Type.Optional(AskKeyBindingSchema),
+		nextOptionWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		nextTabWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		previousOptionWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		previousTabWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		save: Type.Optional(AskKeyBindingSchema),
+	}),
+	settingsModal: Type.Object({
+		close: Type.Optional(AskKeyBindingSchema),
+		nextOption: Type.Optional(AskKeyBindingSchema),
+		previousOption: Type.Optional(AskKeyBindingSchema),
+		toggle: Type.Optional(AskKeyBindingSchema),
+	}),
+});
+
+const AskConfigKeymapsSchema = Type.Object({
+	global: Type.Object({
+		dismiss: Type.Optional(AskKeyBindingSchema),
+		settings: Type.Optional(AskKeyBindingSchema),
+	}),
+	main: Type.Object({
+		cancel: Type.Optional(AskKeyBindingSchema),
+		changeQuestionType: Type.Optional(AskKeyBindingSchema),
+		confirm: Type.Optional(AskKeyBindingSchema),
+		nextOption: Type.Optional(AskKeyBindingSchema),
+		nextTab: Type.Optional(AskKeyBindingSchema),
+		optionNote: Type.Optional(AskKeyBindingSchema),
+		previousOption: Type.Optional(AskKeyBindingSchema),
+		previousTab: Type.Optional(AskKeyBindingSchema),
+		questionNote: Type.Optional(AskKeyBindingSchema),
+		toggle: Type.Optional(AskKeyBindingSchema),
+	}),
+	editor: Type.Object({
+		close: Type.Optional(AskKeyBindingSchema),
+		nextOptionWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		nextTabWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		previousOptionWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		previousTabWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		submit: Type.Optional(AskKeyBindingSchema),
+	}),
+	noteEditor: Type.Object({
+		close: Type.Optional(AskKeyBindingSchema),
+		nextOptionWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		nextTabWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		previousOptionWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		previousTabWhenEmpty: Type.Optional(AskKeyBindingSchema),
+		save: Type.Optional(AskKeyBindingSchema),
+	}),
+	settingsModal: Type.Object({
+		close: Type.Optional(AskKeyBindingSchema),
+		nextOption: Type.Optional(AskKeyBindingSchema),
+		previousOption: Type.Optional(AskKeyBindingSchema),
+		toggle: Type.Optional(AskKeyBindingSchema),
+	}),
+});
+
+export const AskConfigFileV5Schema = Type.Object({
+	schemaVersion: Type.Literal(5),
+	answer: Type.Optional(
+		Type.Object({
+			extractionModels: Type.Optional(
+				Type.Array(AskAnswerModelPreferenceSchema)
+			),
+			extractionRetries: Type.Optional(Type.Number()),
+			extractionTimeoutMs: Type.Optional(Type.Number()),
+		})
+	),
+	behaviour: Type.Optional(
+		Type.Object({
+			autoSubmitWhenAnsweredWithoutNotes: Type.Optional(Type.Boolean()),
+			confirmDismissWhenDirty: Type.Optional(Type.Boolean()),
+			doublePressReviewShortcuts: Type.Optional(Type.Boolean()),
+			presentSingleAsMulti: Type.Optional(Type.Boolean()),
+			showFooterHints: Type.Optional(Type.Boolean()),
+		})
+	),
+	keymaps: Type.Optional(AskConfigKeymapsSchema),
+	notifications: Type.Optional(
+		Type.Object({
+			channels: Type.Optional(Type.Array(AskNotificationChannelSchema)),
+			enabled: Type.Optional(Type.Boolean()),
+		})
+	),
+});
+
+export const AskConfigFileV4Schema = Type.Object({
+	schemaVersion: Type.Literal(4),
+	answer: Type.Optional(
+		Type.Object({
+			extractionModels: Type.Optional(
+				Type.Array(AskAnswerModelPreferenceSchema)
+			),
+			extractionRetries: Type.Optional(Type.Number()),
+			extractionTimeoutMs: Type.Optional(Type.Number()),
+		})
+	),
+	behaviour: Type.Optional(
+		Type.Object({
+			autoSubmitWhenAnsweredWithoutNotes: Type.Optional(Type.Boolean()),
+			confirmDismissWhenDirty: Type.Optional(Type.Boolean()),
+			doublePressReviewShortcuts: Type.Optional(Type.Boolean()),
+			showFooterHints: Type.Optional(Type.Boolean()),
+		})
+	),
+	keymaps: Type.Optional(AskConfigKeymapsV4Schema),
+	notifications: Type.Optional(
+		Type.Object({
+			channels: Type.Optional(Type.Array(AskNotificationChannelSchema)),
+			enabled: Type.Optional(Type.Boolean()),
+		})
+	),
+});
+
+export const AskConfigFileV3Schema = Type.Object({
+	schemaVersion: Type.Literal(3),
+	answer: Type.Optional(
+		Type.Object({
+			extractionModels: Type.Optional(
+				Type.Array(AskAnswerModelPreferenceSchema)
+			),
+			extractionRetries: Type.Optional(Type.Number()),
+			extractionTimeoutMs: Type.Optional(Type.Number()),
+		})
+	),
+	behaviour: Type.Optional(
+		Type.Object({
+			autoSubmitWhenAnsweredWithoutNotes: Type.Optional(Type.Boolean()),
+			confirmDismissWhenDirty: Type.Optional(Type.Boolean()),
+			doublePressReviewShortcuts: Type.Optional(Type.Boolean()),
+			showFooterHints: Type.Optional(Type.Boolean()),
+		})
+	),
+	keymaps: Type.Optional(
+		Type.Object({
+			cancel: Type.Optional(Type.String()),
+			confirm: Type.Optional(Type.String()),
+			dismiss: Type.Optional(Type.String()),
+			optionNote: Type.Optional(Type.String()),
+			questionNote: Type.Optional(Type.String()),
+			toggle: Type.Optional(Type.String()),
+		})
+	),
+	notifications: Type.Optional(
+		Type.Object({
+			channels: Type.Optional(Type.Array(AskNotificationChannelSchema)),
+			enabled: Type.Optional(Type.Boolean()),
+		})
+	),
+});
+
+export const AskConfigFileV2Schema = Type.Omit(AskConfigFileV3Schema, [
+	"notifications",
+	"schemaVersion",
+]);
+
+export type AskConfigFileV5 = Static<typeof AskConfigFileV5Schema>;
+export type AskConfigFileV4 = Static<typeof AskConfigFileV4Schema>;
+export type AskConfigFileV3 = Static<typeof AskConfigFileV3Schema>;
+export type AskConfigFileV2 = Static<typeof AskConfigFileV2Schema> & {
+	schemaVersion: 2;
+};
+export type AskConfigFileV1 = Omit<
+	AskConfigFileV2,
+	"answer" | "schemaVersion"
+> & { schemaVersion: 1 };
+
+export interface AskAnswerModelPreference {
+	id: string;
+	provider: string;
+}
+
+export type AskNotificationChannel =
+	| "bell"
+	| "osc9"
+	| "osc777"
+	| { command: string; type: "command" };
+
+export interface AskConfigKeymaps {
+	editor: {
+		close: string[];
+		nextOptionWhenEmpty: string[];
+		nextTabWhenEmpty: string[];
+		previousOptionWhenEmpty: string[];
+		previousTabWhenEmpty: string[];
+		submit: string[];
+	};
+	global: {
+		dismiss: string[];
+		settings: string[];
+	};
+	main: {
+		cancel: string[];
+		changeQuestionType: string[];
+		confirm: string[];
+		nextOption: string[];
+		nextTab: string[];
+		optionNote: string[];
+		previousOption: string[];
+		previousTab: string[];
+		questionNote: string[];
+		toggle: string[];
+	};
+	noteEditor: {
+		close: string[];
+		nextOptionWhenEmpty: string[];
+		nextTabWhenEmpty: string[];
+		previousOptionWhenEmpty: string[];
+		previousTabWhenEmpty: string[];
+		save: string[];
+	};
+	settingsModal: {
+		close: string[];
+		nextOption: string[];
+		previousOption: string[];
+		toggle: string[];
+	};
+}
+
+export interface AskConfig {
+	answer: {
+		extractionModels: AskAnswerModelPreference[];
+		extractionRetries: number;
+		extractionTimeoutMs: number;
+	};
+	behaviour: {
+		autoSubmitWhenAnsweredWithoutNotes: boolean;
+		confirmDismissWhenDirty: boolean;
+		doublePressReviewShortcuts: boolean;
+		presentSingleAsMulti: boolean;
+		showFooterHints: boolean;
+	};
+	keymaps: AskConfigKeymaps;
+	notifications: {
+		channels: AskNotificationChannel[];
+		enabled: boolean;
+	};
+}
+
+export const validateAskConfigFileV5 = Compile(AskConfigFileV5Schema);

package/src/config/store.ts

@@ -0,0 +1,227 @@
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { dirname, join } from "node:path";
+
+import { getAgentDir } from "@earendil-works/pi-coding-agent";
+import {
+	DEFAULT_ASK_CONFIG,
+	normalizeAskConfig,
+	toAskConfigFileV5,
+} from "./defaults.ts";
+import { AskConfigMigrationError, migrateAskConfig } from "./migrate.ts";
+import type { AskConfig } from "./schema.ts";
+
+const INVALID_CONFIG_NOTICE =
+	"Config was invalid or unsupported. Loaded defaults for this session and left the config file unchanged. Edit the config file or run /reload after fixing it.";
+const MIGRATION_FAILED_NOTICE =
+	"Config migration failed. Loaded defaults for this session and left the config file unchanged. Edit the config file or run /reload after fixing it.";
+
+export interface AskConfigNotice {
+	kind: "error" | "warning" | "success";
+	text: string;
+}
+
+interface AskConfigLoadResult {
+	config: AskConfig;
+	notice?: AskConfigNotice;
+}
+
+export class AskConfigStore {
+	private config?: AskConfig;
+	private loadPromise?: Promise<AskConfigLoadResult>;
+	private notice?: AskConfigNotice;
+	private readonly listeners = new Set<(config: AskConfig) => void>();
+	private readonly configPath: string;
+	private readonly legacyConfigPaths: string[];
+
+	constructor(configPath?: string, legacyConfigPaths?: string[]) {
+		this.configPath = configPath ?? getAskConfigPath();
+		this.legacyConfigPaths = (
+			legacyConfigPaths ?? (configPath ? [] : getLegacyAskConfigPaths())
+		).filter((path) => path !== this.configPath);
+	}
+
+	subscribe(onChange: (config: AskConfig) => void): () => void {
+		this.listeners.add(onChange);
+		return () => {
+			this.listeners.delete(onChange);
+		};
+	}
+
+	async ensureLoaded(): Promise<AskConfigLoadResult> {
+		if (this.config) {
+			return { config: this.config, notice: this.notice };
+		}
+		if (!this.loadPromise) {
+			this.loadPromise = this.loadFromDisk();
+		}
+		const result = await this.loadPromise;
+		this.config = result.config;
+		this.notice = result.notice;
+		this.loadPromise = undefined;
+		return result;
+	}
+
+	async getConfig(): Promise<AskConfig> {
+		return (await this.ensureLoaded()).config;
+	}
+
+	async save(config: AskConfig | Partial<AskConfig>): Promise<AskConfig> {
+		const normalized = normalizeAskConfig(config);
+		const content = JSON.stringify(
+			toAskConfigFileV5(normalized),
+			null,
+			2
+		).concat("\n");
+		try {
+			await mkdir(dirname(this.configPath), { recursive: true });
+			await writeFile(this.configPath, content, "utf-8");
+		} catch (error) {
+			throw createConfigSaveError(this.configPath, error);
+		}
+		this.setConfig(normalized);
+		return normalized;
+	}
+
+	setConfig(config: AskConfig): void {
+		this.config = normalizeAskConfig(config);
+		this.notice = undefined;
+		for (const listener of this.listeners) {
+			listener(this.config);
+		}
+	}
+
+	private async loadFromDisk(): Promise<AskConfigLoadResult> {
+		const content = await this.readDiskConfig();
+		if (content === undefined) {
+			return this.loadMissingConfig();
+		}
+
+		const parsed = parseJson(content);
+		if (!parsed.ok) {
+			return this.loadDefaultsWithNotice(INVALID_CONFIG_NOTICE);
+		}
+
+		return this.loadParsedConfig(parsed.value);
+	}
+
+	private async readDiskConfig(): Promise<string | undefined> {
+		for (const path of [this.configPath, ...this.legacyConfigPaths]) {
+			const content = await readConfigFileIfPresent(path);
+			if (content !== undefined) {
+				return content;
+			}
+		}
+	}
+
+	private async loadMissingConfig(): Promise<AskConfigLoadResult> {
+		const config = normalizeAskConfig(DEFAULT_ASK_CONFIG);
+		try {
+			await this.save(config);
+			return { config };
+		} catch (saveError) {
+			return {
+				config,
+				notice: {
+					kind: "warning",
+					text: getErrorMessage(saveError),
+				},
+			};
+		}
+	}
+
+	private loadParsedConfig(parsed: unknown): AskConfigLoadResult {
+		try {
+			const migrated = migrateAskConfig(parsed);
+			return {
+				config: migrated.config,
+				notice: migrated.notice
+					? {
+							kind: "error",
+							text: migrated.notice,
+						}
+					: undefined,
+			};
+		} catch (error) {
+			if (error instanceof AskConfigMigrationError) {
+				return this.loadDefaultsWithNotice(
+					error.reason === "migration_failed"
+						? MIGRATION_FAILED_NOTICE
+						: INVALID_CONFIG_NOTICE
+				);
+			}
+			throw error;
+		}
+	}
+
+	private loadDefaultsWithNotice(text: string): AskConfigLoadResult {
+		return {
+			config: normalizeAskConfig(DEFAULT_ASK_CONFIG),
+			notice: {
+				kind: "error",
+				text,
+			},
+		};
+	}
+}
+
+let askConfigStore: AskConfigStore | undefined;
+
+export function getAskConfigStore(): AskConfigStore {
+	askConfigStore ??= new AskConfigStore();
+	return askConfigStore;
+}
+
+export function resetAskConfigStore(): void {
+	askConfigStore = undefined;
+}
+
+export function getAskConfigPath(): string {
+	return join(getAgentDir(), "extensions", "eko24ive-pi-ask.json");
+}
+
+export function getLegacyAskConfigPaths(): string[] {
+	return [join(getAgentDir(), "eko24ive-pi-ask.json")];
+}
+
+function createConfigSaveError(path: string, error: unknown): Error {
+	const detail = getErrorMessage(error);
+	return new Error(
+		`Unable to save ask config at ${path}. The file may be read-only or managed outside pi-ask; edit it manually and run /reload. ${detail}`
+	);
+}
+
+function parseJson(
+	content: string
+): { ok: true; value: unknown } | { ok: false } {
+	try {
+		return { ok: true, value: JSON.parse(content) };
+	} catch {
+		return { ok: false };
+	}
+}
+
+async function readConfigFileIfPresent(
+	path: string
+): Promise<string | undefined> {
+	try {
+		return await readFile(path, "utf-8");
+	} catch (error) {
+		if (isMissingFileError(error)) {
+			return;
+		}
+		throw error;
+	}
+}
+
+function getErrorMessage(error: unknown): string {
+	return error instanceof Error ? error.message : String(error);
+}
+
+function isMissingFileError(error: unknown): boolean {
+	return (
+		!!error &&
+		typeof error === "object" &&
+		"code" in error &&
+		error.code === "ENOENT"
+	);
+}