@mrclrchtr/supi-settings 4.6.0 → 4.8.0

package/README.md

@@ -24,15 +24,15 @@ pi install ./packages/supi-settings
 
 After install, pi gets one new slash command:
 
-- **`/supi-settings`** — open a searchable settings overlay for registered SuPi extension settings
+- **`/supi-settings`** — open a searchable settings screen for registered SuPi extension settings
 
-The overlay groups settings by extension, shows current values with source badges like `(project)`, `(global)`, and `(default)`, and lets you switch between **project** and **global** scopes with `Tab`. Row actions can explicitly set a scoped value or delete it with **Inherit** / **Reset to default**.
+The screen matches Pi's `/settings` layout and groups settings by extension. It shows current values with source badges like `(project)`, `(global)`, and `(default)`. Use `Tab` to switch between **project** and **global** scopes. Row actions can set a scoped value or delete it with **Inherit** / **Reset to default**.
 
 ## How it works
 
 `supi-settings` is the command package for the shared settings registry in `@mrclrchtr/supi-core`.
 
-Other SuPi extensions register their settings during extension startup. This package renders those registered sections and persists changes back to the appropriate SuPi config scope.
+Other SuPi extensions register asynchronous Settings Modules during extension startup. This package reads their source-aware snapshots, routes `set` and `unset` actions, and shows module-reported failures or reload notices. Fixed SuPi config sections use the shared config adapter; dynamic modules can own other stores without exposing them to this UI.
 
 If no installed SuPi extension has registered settings, `/supi-settings` reports that there are no settings to edit.
 
@@ -46,14 +46,16 @@ Depending on which SuPi packages are installed, the overlay may include settings
 - `supi-cache` — prompt-cache monitoring and history collection
 - `supi-debug` — debug event capture and retention
 - `supi-insights` — report-generation options
+- `supi-skills` — skill load and model-invocation controls
 
 ## Package surfaces
 
 - `@mrclrchtr/supi-settings/extension` — pi extension entrypoint, registers `/supi-settings`
-- `@mrclrchtr/supi-settings/api` — public package surface for future settings helpers
+- `@mrclrchtr/supi-settings/api` — settings UI and submenu helpers
 
 ## Source layout
 
 - `src/extension.ts` — pi extension entrypoint
-- `src/api.ts` — package API surface
-- shared implementation lives in `@mrclrchtr/supi-core/settings` and `@mrclrchtr/supi-core/settings-ui`
+- `src/api.ts` — reusable settings UI surface
+- `src/ui/` — settings screen, scoped list, action menu, and submenus
+- `@mrclrchtr/supi-core/settings` owns the registry, schema, scope resolution, and persistence

package/node_modules/@mrclrchtr/supi-core/README.md

@@ -37,28 +37,13 @@ Config file locations:
 
 ### Settings helpers
 
-- `registerDeclarativeSettings(pi, options)` — contribute a config-backed declarative settings section with source-aware scoped persistence
-- `registerSettingsCommand(pi)` — register `/supi-settings` (used by `@mrclrchtr/supi-settings`)
-- `openSettingsOverlay(pi, ctx)` — open the shared settings UI directly
-- `createInputSubmenu()` — helper for simple text-entry submenus
-- `createModelPickerSubmenu()` — helper for scoped model selection submenus, with optional host-owned choices and `disabled` control
-
-The built-in settings UI supports:
-
-- project/global scope toggle
-- source badges for project, global, and default values
-- Inherit/Reset actions that delete scoped config keys
-- grouped extension sections
-- searchable setting lists
+- `registerSettings(pi, module)` — register one canonical asynchronous settings module
+- `defineConfigSettings(options)` — adapt a fixed SuPi config section to that module interface
+- settings registry helpers and types for the `@mrclrchtr/supi-settings` configuration surface
 
 ### Context helpers
 
 - `wrapExtensionContext()` — wrap injected text in SuPi's `<extension-context>` tag
-- `findLastUserMessageIndex()`
-- `getContextToken()`
-- `getPromptContent()`
-- `pruneAndReorderContextMessages()`
-- `restorePromptContent()`
 
 ### Shared registries
 
@@ -84,25 +69,33 @@ The built-in settings UI supports:
 
 ```ts
 import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
-import { loadSupiConfig, registerDeclarativeSettings, wrapExtensionContext } from "@mrclrchtr/supi-core/api";
+import {
+  defineConfigSettings,
+  loadSupiConfig,
+  registerSettings,
+  wrapExtensionContext,
+} from "@mrclrchtr/supi-core/api";
 
 export default function myExtension(pi: ExtensionAPI) {
   const defaults = { enabled: true };
   const config = loadSupiConfig("my-extension", process.cwd(), defaults);
 
-  registerDeclarativeSettings(pi, {
-    id: "my-extension",
-    label: "My Extension",
-    section: "my-extension",
-    defaults,
-    fields: [
-      {
-        kind: "boolean" as const,
-        key: "enabled",
-        label: "Enabled",
-      },
-    ],
-  });
+  registerSettings(
+    pi,
+    defineConfigSettings({
+      id: "my-extension",
+      label: "My Extension",
+      section: "my-extension",
+      defaults,
+      fields: [
+        {
+          kind: "boolean" as const,
+          key: "enabled",
+          label: "Enabled",
+        },
+      ],
+    }),
+  );
 
   const message = wrapExtensionContext("my-extension", "hello", {
     enabled: config.enabled,
@@ -115,6 +108,5 @@ export default function myExtension(pi: ExtensionAPI) {
 
 - `src/api.ts` — exported library surface
 - `src/config.ts` — shared config loading and writing
-- `src/config-settings.ts` — config-backed settings registration helper
-- `src/settings-ui.ts` — shared settings overlay
+- `src/settings/` — settings registry, schema, scope resolution, and persistence
 - `src/report.ts` — shared text/report rendering helpers

package/node_modules/@mrclrchtr/supi-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mrclrchtr/supi-core",
-  "version": "4.6.0",
+  "version": "4.8.0",
   "description": "Shared settings, configuration, reporting, and session infrastructure",
   "license": "MIT",
   "repository": {
@@ -60,16 +60,13 @@
     "./model-selection": "./src/model-selection.ts",
     "./package.json": "./package.json",
     "./path": "./src/path.ts",
-    "./report": "./src/report.ts",
-    "./progress-widget": "./src/progress-widget.ts",
     "./project": "./src/project.ts",
+    "./prompt-surface": "./src/prompt-surface.ts",
+    "./report": "./src/report.ts",
     "./session": "./src/session.ts",
     "./settings": "./src/settings.ts",
-    "./settings-ui": "./src/settings-ui.ts",
     "./spinner-frames": "./src/spinner-frames.ts",
     "./status-spinner": "./src/status-spinner.ts",
-    "./terminal": "./src/terminal.ts",
-    "./tool-framework": "./src/tool-framework.ts",
-    "./prompt-surface": "./src/prompt-surface.ts"
+    "./terminal": "./src/terminal.ts"
   }
 }

package/node_modules/@mrclrchtr/supi-core/src/api.ts

@@ -1,6 +1,6 @@
 // supi-core — shared infrastructure for SuPi extensions.
-// Provides XML context tag wrapping, unified config system, context-message utilities,
-// settings registry for supi-wide TUI settings, and a shared tool-spec/registration framework.
+// Provides XML context tag wrapping, unified config, prompt-surface resolution,
+// and shared settings, reporting, and session utilities.
 //
 // Convenience barrel — re-exports all domain entry points.
 // For lighter imports, use one of the domain subpaths directly
@@ -25,18 +25,16 @@ export * from "./path.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./project.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
+export * from "./prompt-surface.ts";
+// biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./report.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./session.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./settings.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
-export * from "./settings-ui.ts";
-// biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./spinner-frames.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./status-spinner.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./terminal.ts";
-// biome-ignore lint/performance/noReExportAll: intentional convenience barrel
-export * from "./tool-framework.ts";

package/node_modules/@mrclrchtr/supi-core/src/config/config.ts

@@ -199,23 +199,3 @@ function extractSection(
   }
   return null;
 }
-
-/**
- * Shorthand for {@link loadSupiConfig} that infers the return type from defaults.
- *
- * Reduces boilerplate when a package only needs the merged runtime config.
- *
- * @example
- * ```ts
- * const config = loadSectionConfig("my-ext", cwd, { enabled: true, timeout: 30 });
- * // config is typed as { enabled: boolean; timeout: number }
- * ```
- */
-export function loadSectionConfig<T extends Record<string, unknown>>(
-  section: string,
-  cwd: string,
-  defaults: T,
-  options?: SupiConfigOptions,
-): T {
-  return loadSupiConfig(section, cwd, defaults, options);
-}

package/node_modules/@mrclrchtr/supi-core/src/config/prompt-surface.ts

@@ -8,11 +8,17 @@ import {
   type ExtensionContext,
   hasTrustRequiringProjectResources,
 } from "@earendil-works/pi-coding-agent";
-import type { SuiPiToolPromptSurface } from "../tool-framework.ts";
 import { loadSupiConfigSectionForScope, type SupiConfigOptions } from "./config.ts";
 
 // ── Public types ───────────────────────────────────────────────────────────
 
+/** Model-facing text that PI adds to one registered tool's prompt surface. */
+export interface SuiPiToolPromptSurface {
+  description: string;
+  promptSnippet: string;
+  promptGuidelines: string[];
+}
+
 export type ToolPromptSurfaceDiagnosticCode =
   | "invalidPromptSurfaceConfig"
   | "invalidPromptSurfaceField"

package/node_modules/@mrclrchtr/supi-core/src/config.ts

@@ -1,7 +1,6 @@
 // supi-core config domain — config loading.
 export type { SupiConfigLocation, SupiConfigOptions } from "./config/config.ts";
 export {
-  loadSectionConfig,
   loadSupiConfig,
   loadSupiConfigForScope,
   loadSupiConfigSectionForScope,

package/node_modules/@mrclrchtr/supi-core/src/context.ts

@@ -1,12 +1,4 @@
-// supi-core context domain — context messages, providers, and XML tags.
-export type { ContextMessageLike } from "./context/context-messages.ts";
-export {
-  findLastUserMessageIndex,
-  getContextToken,
-  getPromptContent,
-  pruneAndReorderContextMessages,
-  restorePromptContent,
-} from "./context/context-messages.ts";
+// supi-core context domain — context providers and XML tags.
 export type { ContextProvider } from "./context/context-provider-registry.ts";
 export {
   clearRegisteredContextProviders,

package/node_modules/@mrclrchtr/supi-core/src/index.ts

@@ -1,6 +1,6 @@
 // supi-core — shared infrastructure for SuPi extensions.
-// Provides XML context tag wrapping, unified config system, context-message utilities,
-// settings registry for supi-wide TUI settings, and a shared tool-spec/registration framework.
+// Provides XML context tag wrapping, unified config, prompt-surface resolution,
+// and shared settings, reporting, and session utilities.
 //
 // Convenience barrel — re-exports all domain entry points.
 // For lighter imports, use one of the domain subpaths directly
@@ -21,16 +21,14 @@ export * from "./path.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./project.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
+export * from "./prompt-surface.ts";
+// biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./report.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./session.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./settings.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
-export * from "./settings-ui.ts";
-// biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./status-spinner.ts";
 // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
 export * from "./terminal.ts";
-// biome-ignore lint/performance/noReExportAll: intentional convenience barrel
-export * from "./tool-framework.ts";

package/node_modules/@mrclrchtr/supi-core/src/settings/settings-registry.ts

@@ -1,35 +1,53 @@
-// Event-backed settings contribution types for SuPi extensions.
-//
-// Extensions contribute declarative settings sections through PI's shared
-// event bus. The public helper is registerDeclarativeSettings(pi, ...); this module
-// owns the internal collector protocol used by /supi-settings.
+// Event-backed settings module registration and collection.
 
-import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
-import type { ScopedFieldValue, SettingsFieldAction } from "./settings-schema.ts";
+import type { ExtensionAPI, ExtensionContext } from "@earendil-works/pi-coding-agent";
+import type { ScopedFieldValue, SettingsAction } from "./settings-schema.ts";
 
 export const SUPI_SETTINGS_COLLECT_EVENT = "supi:settings:collect";
 
 export type SettingsScope = "project" | "global";
 
-export interface SettingsSection {
-  /** Stable contribution identifier — e.g. "lsp", "claude-md". */
+/** Scope and PI runtime state supplied for each settings read. */
+export interface SettingsContext {
+  scope: SettingsScope;
+  cwd: string;
+  ctx?: ExtensionContext;
+}
+
+/** A resolved, source-aware settings view. */
+export interface SettingsSnapshot {
+  rows: ScopedFieldValue[];
+}
+
+/** One user action routed to its owning settings module. */
+export interface SettingsActionRequest extends SettingsContext {
+  fieldKey: string;
+  action: SettingsAction;
+}
+
+/** Optional user-facing result from a successful settings action. */
+export interface SettingsApplyResult {
+  notice?: {
+    message: string;
+    level: "info" | "warning" | "error";
+  };
+}
+
+/**
+ * Canonical settings interface consumed by `/supi-settings`.
+ *
+ * Reads are always asynchronous. Apply resolves only after durable writes and
+ * module-owned refresh work complete. Implementations throw on failed writes.
+ */
+export interface SettingsModule {
   id: string;
-  /** Human-readable label shown in the UI. */
   label: string;
-  /** Load current ScopedFieldValue[] for the given scope. */
-  loadValues: (scope: SettingsScope, cwd: string, ctx?: ExtensionContext) => ScopedFieldValue[];
-  /** Handle a user action on a field in the selected scope. */
-  handleAction: (
-    scope: SettingsScope,
-    cwd: string,
-    fieldKey: string,
-    action: SettingsFieldAction,
-    ctx?: ExtensionContext,
-  ) => void;
+  read(context: SettingsContext): Promise<SettingsSnapshot>;
+  apply(request: SettingsActionRequest): Promise<SettingsApplyResult>;
 }
 
 export interface SettingsContributionCollector {
-  add(section: SettingsSection): void;
+  add(module: SettingsModule): void;
 }
 
 export interface SettingsCollectionDiagnostic {
@@ -38,7 +56,7 @@ export interface SettingsCollectionDiagnostic {
 }
 
 export interface SettingsCollectionResult {
-  sections: SettingsSection[];
+  modules: SettingsModule[];
   diagnostics: SettingsCollectionDiagnostic[];
 }
 
@@ -56,21 +74,29 @@ export function isSettingsContributionCollector(
 export function createSettingsContributionCollector(): SettingsContributionCollector & {
   result(): SettingsCollectionResult;
 } {
-  const sections = new Map<string, SettingsSection>();
+  const modules = new Map<string, SettingsModule>();
   const diagnostics: SettingsCollectionDiagnostic[] = [];
 
   return {
-    add(section: SettingsSection): void {
-      if (sections.has(section.id)) {
+    add(module: SettingsModule): void {
+      if (modules.has(module.id)) {
         diagnostics.push({
           kind: "warning",
-          message: `Duplicate SuPi settings contribution "${section.id}"; using the last contribution.`,
+          message: `Duplicate SuPi settings contribution "${module.id}"; using the last contribution.`,
         });
       }
-      sections.set(section.id, section);
+      modules.set(module.id, module);
     },
     result(): SettingsCollectionResult {
-      return { sections: Array.from(sections.values()), diagnostics: [...diagnostics] };
+      return { modules: Array.from(modules.values()), diagnostics: [...diagnostics] };
     },
   };
 }
+
+/** Register one settings module during extension factory setup. */
+export function registerSettings(pi: ExtensionAPI, module: SettingsModule): void {
+  const dispose = pi.events.on(SUPI_SETTINGS_COLLECT_EVENT, (collector) => {
+    if (isSettingsContributionCollector(collector)) collector.add(module);
+  });
+  pi.on("session_shutdown", () => dispose());
+}