API Reference¶

type CapabilityStack struct {
    Metadata          Metadata
    Layers            []Layer
    Categories        []Category
    Capabilities      []Capability
    Foundational      []Capability
    PriorityFramework *PriorityFramework
    MarketIntegration *MarketIntegration
}

// Load from file
cs, err := capstack.LoadFromFile("stack.json")

// Validate
errs := cs.Validate()

// Query capabilities
byStatus := cs.CapabilitiesByStatus(capstack.StatusOperational)
byLayer := cs.CapabilitiesByLayer("application")
byCategory := cs.CapabilitiesByCategory("security")
all := cs.AllCapabilities()

// Sort
cs.SortCapabilities(capstack.SortByImportance)
sorted := cs.SortedCapabilities(capstack.SortByOrder)

type Capability struct {
    ID           string
    Name         string
    Description  string
    LayerID      string
    CategoryID   string
    Status       string
    Priority     string
    Importance   string
    Order        int
    TargetDate   string
    Owner        string
    Tags         []string
    Dependencies []string
    PRISMRef     *PRISMRef
    MarketRef    *MarketRef
}

// Get importance weight (4=critical, 3=high, 2=medium, 1=low)
weight := capstack.ImportanceWeight("critical") // 4

// Calculate dynamic priority (P0-P3)
priority := capstack.CalculatePriority("critical", 1, 3) // "P0"

// Get priority weight
weight := capstack.DynamicPriorityWeight("P0") // 4

import "github.com/grokify/prism-capability/render"

opts := render.DefaultHTMLOptions()
opts.Standalone = true
opts.DarkTheme = false
opts.ShowLegend = true
opts.Overlays = overlays // optional

html, err := render.RenderHTMLString(cs, opts)

opts := render.DefaultD2Options()
opts.Style = render.D2StyleDefault // or D2StyleGrid
opts.Overlays = overlays // optional

d2, err := render.RenderD2String(cs, opts)

opts := render.DefaultSVGOptions()
opts.Layout = render.SVGLayoutStack
opts.Title = "Platform Capability Stack"
opts.TopBandLabel = "Your Applications"
opts.Substrate = "Go · Kubernetes · 15+ providers"

svg, err := render.RenderSVGString(cs, opts)
// Write svg to file or embed in HTML

opts := render.DefaultSVGOptions()
opts.Layout = render.SVGLayoutHub
opts.CenterLabel = "Platform Core"
opts.CenterSubLabel = "Runtime"
opts.Substrate = "Cloud-Native Infrastructure"

svg, err := render.RenderSVGString(cs, opts)

opts := render.DefaultSVGOptions()
opts.Theme = render.SVGTheme{
    Background:  "#0a0e1a",
    Surface:     "#1e293b",
    Text:        "#f1f5f9",
    TextMuted:   "#94a3b8",
    CellText:    "#cbd5e1",
    Accents:     []string{"#06b6d4", "#8b5cf6", "#ec4899"},
    HubGradient: []string{"#06b6d4", "#8b5cf6", "#ec4899"},
}
opts.Layout = render.SVGLayoutStack

svg, err := render.RenderSVGString(cs, opts)

import (
    "os"
    "github.com/grokify/prism-capability/render"
)

opts := render.DefaultSVGOptions()
opts.Layout = render.SVGLayoutStack

f, err := os.Create("stack.svg")
defer f.Close()

err = render.RenderSVG(f, cs, opts)

overlays := render.OverlayProvider{
    "sast": {
        BadgeText:    "M3",
        BadgeColor:   "#22c55e",
        TooltipExtra: "On track for M4",
    },
}

// Check if overlay exists
if overlays.Has("sast") {
    overlay := overlays.Get("sast")
}

errs := cs.Validate()
for _, err := range errs {
    fmt.Printf("%s.%s: %s (got: %s)\n",
        err.Field, err.Value, err.Message)
}

const (
    StatusPlanned    = "planned"
    StatusInProgress = "in-progress"
    StatusImplemented = "implemented"
    StatusOperational = "operational"
    StatusDeprecated  = "deprecated"
)

const (
    ImportanceCritical = "critical"
    ImportanceHigh     = "high"
    ImportanceMedium   = "medium"
    ImportanceLow      = "low"
)

const (
    SortByOrder      = "order"
    SortByName       = "name"
    SortByImportance = "importance"
    SortByPriority   = "priority"
    SortByStatus     = "status"
)