Skip to content

refactor: extract backend category entry wrapper #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ndycode wants to merge 1 commit into from
+246 −1
Closed

refactor: extract backend category entry wrapper #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 187 additions & 0 deletions lib/codex-manager/backend-category-entry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
import type { PluginConfig } from "../types.js";
import type {
BackendCategoryOption,
BackendNumberSettingKey,
BackendNumberSettingOption,
BackendSettingFocusKey,
BackendToggleSettingKey,
BackendToggleSettingOption,
} from "./backend-settings-schema.js";

export async function promptBackendCategorySettingsEntry(params: {
initial: PluginConfig;
category: BackendCategoryOption;
initialFocus: BackendSettingFocusKey;
promptBackendCategorySettingsMenu: (args: {
initial: PluginConfig;
category: BackendCategoryOption;
initialFocus: BackendSettingFocusKey;
ui: ReturnType<typeof import("../ui/runtime.js").getUiRuntimeOptions>;
cloneBackendPluginConfig: (config: PluginConfig) => PluginConfig;
buildBackendSettingsPreview: (
config: PluginConfig,
ui: ReturnType<typeof import("../ui/runtime.js").getUiRuntimeOptions>,
focusKey: BackendSettingFocusKey,
deps: {
highlightPreviewToken: (
text: string,
ui: ReturnType<typeof import("../ui/runtime.js").getUiRuntimeOptions>,
) => string;
},
) => { label: string; hint: string };
highlightPreviewToken: (
text: string,
ui: ReturnType<typeof import("../ui/runtime.js").getUiRuntimeOptions>,
) => string;
resolveFocusedBackendNumberKey: (
focus: BackendSettingFocusKey,
numberOptions: BackendNumberSettingOption[],
) => BackendNumberSettingKey;
clampBackendNumber: (
option: BackendNumberSettingOption,
value: number,
) => number;
formatBackendNumberValue: (
option: BackendNumberSettingOption,
value: number,
) => string;
formatDashboardSettingState: (enabled: boolean) => string;
applyBackendCategoryDefaults: (
config: PluginConfig,
selectedCategory: BackendCategoryOption,
) => PluginConfig;
getBackendCategoryInitialFocus: (
category: BackendCategoryOption,
) => BackendSettingFocusKey;
backendDefaults: PluginConfig;
toggleOptionByKey: ReadonlyMap<
BackendToggleSettingKey,
BackendToggleSettingOption
>;
numberOptionByKey: ReadonlyMap<
BackendNumberSettingKey,
BackendNumberSettingOption
>;
select: <T>(
items: import("../ui/select.js").MenuItem<T>[],
options: {
message: string;
subtitle: string;
help: string;
clearScreen: boolean;
theme: ReturnType<
typeof import("../ui/runtime.js").getUiRuntimeOptions
>["theme"];
selectedEmphasis: "minimal";
initialCursor?: number;
onCursorChange: (event: { cursor: number }) => void;
onInput: (raw: string) => T | undefined;
},
) => Promise<T | null>;
copy: {
previewHeading: string;
backendToggleHeading: string;
backendNumberHeading: string;
backendDecrease: string;
backendIncrease: string;
backendResetCategory: string;
backendBackToCategories: string;
backendCategoryTitle: string;
backendCategoryHelp: string;
};
}) => Promise<{ draft: PluginConfig; focusKey: BackendSettingFocusKey }>;
ui: ReturnType<typeof import("../ui/runtime.js").getUiRuntimeOptions>;
cloneBackendPluginConfig: (config: PluginConfig) => PluginConfig;
buildBackendSettingsPreview: (
config: PluginConfig,
ui: ReturnType<typeof import("../ui/runtime.js").getUiRuntimeOptions>,
focusKey: BackendSettingFocusKey,
deps: {
highlightPreviewToken: (
text: string,
ui: ReturnType<typeof import("../ui/runtime.js").getUiRuntimeOptions>,
) => string;
},
) => { label: string; hint: string };
highlightPreviewToken: (
text: string,
ui: ReturnType<typeof import("../ui/runtime.js").getUiRuntimeOptions>,
) => string;
resolveFocusedBackendNumberKey: (
focus: BackendSettingFocusKey,
numberOptions: BackendNumberSettingOption[],
) => BackendNumberSettingKey;
clampBackendNumber: (
option: BackendNumberSettingOption,
value: number,
) => number;
formatBackendNumberValue: (
option: BackendNumberSettingOption,
value: number,
) => string;
formatDashboardSettingState: (enabled: boolean) => string;
applyBackendCategoryDefaults: (
config: PluginConfig,
selectedCategory: BackendCategoryOption,
) => PluginConfig;
getBackendCategoryInitialFocus: (
category: BackendCategoryOption,
) => BackendSettingFocusKey;
backendDefaults: PluginConfig;
toggleOptionByKey: ReadonlyMap<
BackendToggleSettingKey,
BackendToggleSettingOption
>;
numberOptionByKey: ReadonlyMap<
BackendNumberSettingKey,
BackendNumberSettingOption
>;
select: <T>(
items: import("../ui/select.js").MenuItem<T>[],
options: {
message: string;
subtitle: string;
help: string;
clearScreen: boolean;
theme: ReturnType<
typeof import("../ui/runtime.js").getUiRuntimeOptions
>["theme"];
selectedEmphasis: "minimal";
initialCursor?: number;
onCursorChange: (event: { cursor: number }) => void;
onInput: (raw: string) => T | undefined;
},
) => Promise<T | null>;
copy: {
previewHeading: string;
backendToggleHeading: string;
backendNumberHeading: string;
backendDecrease: string;
backendIncrease: string;
backendResetCategory: string;
backendBackToCategories: string;
backendCategoryTitle: string;
backendCategoryHelp: string;
};
}): Promise<{ draft: PluginConfig; focusKey: BackendSettingFocusKey }> {
return params.promptBackendCategorySettingsMenu({
initial: params.initial,
category: params.category,
initialFocus: params.initialFocus,
ui: params.ui,
cloneBackendPluginConfig: params.cloneBackendPluginConfig,
buildBackendSettingsPreview: params.buildBackendSettingsPreview,
highlightPreviewToken: params.highlightPreviewToken,
resolveFocusedBackendNumberKey: params.resolveFocusedBackendNumberKey,
clampBackendNumber: params.clampBackendNumber,
formatBackendNumberValue: params.formatBackendNumberValue,
formatDashboardSettingState: params.formatDashboardSettingState,
applyBackendCategoryDefaults: params.applyBackendCategoryDefaults,
getBackendCategoryInitialFocus: params.getBackendCategoryInitialFocus,
backendDefaults: params.backendDefaults,
toggleOptionByKey: params.toggleOptionByKey,
numberOptionByKey: params.numberOptionByKey,
select: params.select,
copy: params.copy,
});
}
4 changes: 3 additions & 1 deletion lib/codex-manager/settings-hub.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { UI_COPY } from "../ui/copy.js";
import { getUiRuntimeOptions, setUiRuntimeOptions } from "../ui/runtime.js";
import { select } from "../ui/select.js";
import { sleep } from "../utils.js";
import { promptBackendCategorySettingsEntry } from "./backend-category-entry.js";
import {
applyBackendCategoryDefaults,
getBackendCategory,
Expand Down Expand Up @@ -587,10 +588,11 @@ async function promptBackendCategorySettings(
category: BackendCategoryOption,
initialFocus: BackendSettingFocusKey,
): Promise<{ draft: PluginConfig; focusKey: BackendSettingFocusKey }> {
return promptBackendCategorySettingsMenu({
return promptBackendCategorySettingsEntry({
initial,
category,
initialFocus,
promptBackendCategorySettingsMenu,
ui: getUiRuntimeOptions(),
cloneBackendPluginConfig,
buildBackendSettingsPreview,
Expand Down
56 changes: 56 additions & 0 deletions test/backend-category-entry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import { describe, expect, it, vi } from "vitest";
import { promptBackendCategorySettingsEntry } from "../lib/codex-manager/backend-category-entry.js";

describe("backend category entry", () => {
it("passes category wiring through to the backend category prompt helper", async () => {
const promptBackendCategorySettingsMenu = vi.fn(async () => ({
draft: { fetchTimeoutMs: 1000 },
focusKey: null,
}));

const result = await promptBackendCategorySettingsEntry({
initial: { fetchTimeoutMs: 2000 },
category: {
key: "session-sync",
label: "Session Sync",
description: "desc",
} as never,
initialFocus: null,
promptBackendCategorySettingsMenu,
ui: { theme: {} } as never,
cloneBackendPluginConfig: vi.fn((config) => config),
buildBackendSettingsPreview: vi.fn(() => ({
label: "Preview",
hint: "Hint",
})),
highlightPreviewToken: vi.fn((text) => text),
resolveFocusedBackendNumberKey: vi.fn(() => "fetchTimeoutMs" as never),
clampBackendNumber: vi.fn((_, value) => value),
formatBackendNumberValue: vi.fn((_, value) => String(value)),
formatDashboardSettingState: vi.fn((enabled) => (enabled ? "on" : "off")),
applyBackendCategoryDefaults: vi.fn((config) => config),
getBackendCategoryInitialFocus: vi.fn(() => null),
backendDefaults: { fetchTimeoutMs: 1000 },
toggleOptionByKey: new Map(),
numberOptionByKey: new Map(),
select: vi.fn(),
copy: {
previewHeading: "Preview",
backendToggleHeading: "Toggles",
backendNumberHeading: "Numbers",
backendDecrease: "Decrease",
backendIncrease: "Increase",
backendResetCategory: "Reset",
backendBackToCategories: "Back",
backendCategoryTitle: "Category",
backendCategoryHelp: "Help",
},
});

expect(promptBackendCategorySettingsMenu).toHaveBeenCalled();
expect(result).toEqual({
draft: { fetchTimeoutMs: 1000 },
focusKey: null,
});
});
});