Documentation
¶
Overview ¶
Package transformers contains SDK-owned response transformations. Presentation and output formats belong to pkg/custom and its internal rendering helpers.
Index ¶
- func Identity(_ context.Context, value gjson.Result) (gjson.Result, error)
- func ProjectTextStream(value gjson.Result, route Route) (readable.StreamEvent, bool)
- func StreamFailure(value gjson.Result, route Route) string
- func SummarizeResource(ctx context.Context, value gjson.Result, route Route) (gjson.Result, bool, error)
- type OutputKind
- type Route
- type StreamCompletionState
- type Transformer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ProjectTextStream ¶ added in v1.22.0
ProjectTextStream selects text components without modifying the API event. Unknown content stays in Details; a false result preserves the complete event. The caller applies this only to readable output, never explicit data formats.
func StreamFailure ¶ added in v1.22.0
StreamFailure classifies ordinary SSE results before projection or extraction. Messages are fixed API classifications; the caller separately preserves the original event, including error details, for every presentation format.
func SummarizeResource ¶ added in v1.21.0
func SummarizeResource(ctx context.Context, value gjson.Result, route Route) (gjson.Result, bool, error)
SummarizeResource projects known list/get records without modifying API data. A zero summary asks the presenter to show the full value. Omitted reports whether the projection hides fields; presentation owns any explanatory hint.
Types ¶
type OutputKind ¶
type OutputKind string
OutputKind identifies the successful-response boundary being presented.
const ( OutputUnspecified OutputKind = "" OutputResponse OutputKind = "response" OutputPageItem OutputKind = "page_item" OutputStreamEvent OutputKind = "stream_event" )
type Route ¶
type Route struct {
Operation string
OutputKind OutputKind
}
Route identifies an operation independently of its presentation format.
type StreamCompletionState ¶ added in v1.22.0
type StreamCompletionState struct {
// contains filtered or unexported fields
}
StreamCompletionState remembers only observed API progress, not event bodies. It detects clean EOF after an unfinished result even when transport framing reports no error. Empty streams and wholly unfamiliar events remain unchanged.
func (*StreamCompletionState) CompletionError ¶ added in v1.22.0
func (s *StreamCompletionState) CompletionError(route Route) string
type Transformer ¶
Transformer changes one response or iterator value before presentation. Implementations must respect cancellation and must not consume other values.
func Select ¶
func Select(route Route) Transformer
Select is the SDK-owned hook for command-specific default transformations. Only known API fields are summarized; unfamiliar routes preserve their values.
Source Files