From 16f8197a2df8eaea1abcfed8fa32440d0cd947d3 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Sat, 21 Nov 2026 12:45:17 +0000 Subject: [PATCH] Update configuration roadmap for ConfigKit v1.4.0 --- docs/roadmap/next-release-considerations.md | 50 ++++++++++++--------- 1 file changed, 30 insertions(+), 20 deletions(-) diff --git a/docs/roadmap/next-release-considerations.md b/docs/roadmap/next-release-considerations.md index e3b6bf3..b918162 100644 --- a/docs/roadmap/next-release-considerations.md +++ b/docs/roadmap/next-release-considerations.md @@ -87,20 +87,21 @@ join the original load; they do not disappear. The change removes context-transf and duplicate-loading machinery, not application-specific execution requests, profile selection, required-resource checks, or diagnostics policy. -### Narrow ConfigKit Addition And Library-Owned Wiring +### ConfigKit v1.4.0 And Library-Owned Wiring -Adopt the proposed lookup and focused inspection capabilities in ConfigKit's -[typed value and inspection roadmap](../../../ConfigKit/docs/roadmap/result-value.md). -That roadmap records agreed scope, not implemented APIs. Confirm availability -before implementation; do not assume the current dependency supplies them. -The lookup is: +Adopt [ConfigKit v1.4.0](../../../ConfigKit/docs/releases/v1.4.0.md) as a +prerequisite for the configuration handoff. It releases the typed lookup and +focused inspection APIs required here. PromptKit currently selects v1.3.0; +make the dependency upgrade separately reviewable before the configuration +refactor. The Go consumer minimum remains 1.27.0. + +The released lookup is: ```go func (r *Result[T]) Value(path Path) (any, bool) ``` -This is a proposed upstream API, not an implemented dependency assumed by this -roadmap. It selects an existing typed value from `Result.Config` by configuration +It selects an existing typed value from `Result.Config` by configuration path (YAML/schema names). It performs no serialization, conversion, decoding, defaulting, validation, or additional load. It is trusted execution access, including resolved secrets; existing inspection remains redacted. @@ -151,6 +152,7 @@ type Configuration interface { Metadata() configkit.Metadata SourceContext(string) (configkit.ResourceContext, bool) InspectSubtree(configkit.Path) (configkit.Inspection, bool) + Diagnostics() []configkit.Diagnostic } ``` @@ -159,8 +161,10 @@ resources using native metadata and source contexts. Effective field origins are authoritative; do not recover a missing effective location from historical evidence. A serialized section loaded again is not an equivalent handoff. Retain the inspection view selected at `/promptkit` for configuration reporting. -This interface sketch is not final; planning must also specify how existing load -diagnostics are retained and forwarded. +Load diagnostics come from the original result's `Diagnostics()` method; the +inspection view does not supply that method. Retain and forward those records +through PromptKit's configuration inspection facade. Concrete PromptKit API names +remain implementation-planning work. Register desired bundled resources as ordinary underlays before composition; engine construction must not inject another configuration layer into an already @@ -252,7 +256,7 @@ inspection; execution objects need not carry them. ### Focused Configuration Inspection **Accepted:** preserve resource listing and inspection, and provide configuration -reporting through ConfigKit's proposed non-generic `Inspection` view: +reporting through ConfigKit v1.4.0's non-generic `Inspection` view: ```go inspection, ok := result.InspectSubtree(configkit.Keys("promptkit")) @@ -314,12 +318,18 @@ adding a second load. ### Validate The Pattern Against PromptKit -First confirm the final upstream lookup and inspection contracts and availability. -The ConfigKit agent exercised representative one-library and two-library -prototypes using existing public callbacks plus a limited top-level lookup shim. -Those passed checks for defaults, normalization, validation, identities, sensitive inspection, -trusted secret access, and mounted resource lookup. They were not a production -`Value` implementation or a real PromptKit integration. +ConfigKit's released APIs and maintained +[one-library](../../../ConfigKit/examples/consumers/result_component.go) and +[two-library](../../../ConfigKit/examples/consumers/result_composition.go) examples +provide the integration starting point. They demonstrate typed registration, +whole-result handoff, owned settings capture, native inspection, and effective +source context without another load. + +The release review passed PromptKit's full test suite against the published +v1.4.0 module using a temporary dependency file and Go 1.27.4. ConfigKit's focused +lookup, inspection, comparison, history, and component-example checks also passed. +This establishes compatibility with PromptKit's existing implementation; the new +PromptKit handoff remains to be implemented and verified. Prepare an actual PromptKit prototype demonstrating the typed registration helper, one application-owned load, and whole-result engine construction. Also exercise @@ -345,8 +355,8 @@ the standalone convenience path through the same rules. Focus on these checks: no mutation-detection subsystem or ConfigKit deep-copy guarantee is required. 4. **Inspection facade and diagnostics.** Retain the native focused view and specify public signatures for its operations and load-diagnostic forwarding. Obtain - diagnostics from the original result through PromptKit's consumer-owned - interface, or use an upstream view method if supplied. Expose focused enumeration + diagnostics from the original result's `Diagnostics()` method through + PromptKit's consumer-owned interface. Expose focused enumeration alongside native metadata and query operations. A PromptKit overview explanation selects `/promptkit`; the native empty path selects the whole application. @@ -365,7 +375,7 @@ Specify the concrete registration, settings, and constructor shapes, source-help adaptations, and migration examples after these checks. Identify any remaining concrete gap rather than infer a need for a larger upstream framework. Keep the repair-default and handoff changes separately reviewable; the repair work need not -wait for the proposed upstream lookup. Neither needs a new execution subsystem or +wait for the configuration refactor. Neither needs a new execution subsystem or compatibility resolver. ### Focused Validation