engine

type ApplyOptions struct {
	// DryRun reports what apply would change without writing anything
	DryRun bool
}

type ApplyResult struct {
	// CreatedControls are the controls created, in order
	CreatedControls []Change `json:"createdControls,omitempty"`
	// UpdatedControls are the controls updated, in order, with the fields that differ
	UpdatedControls []Change `json:"updatedControls,omitempty"`
	// UnchangedControls counts controls that already match Openlane
	UnchangedControls int `json:"unchangedControls"`
	// CreatedMappings are the mappings created, in order, with the targets added
	CreatedMappings []Change `json:"createdMappings,omitempty"`
	// UpdatedMappings are the mappings courier already owned and extended
	UpdatedMappings []Change `json:"updatedMappings,omitempty"`
	// CreatedPolicies are the policies created, in order
	CreatedPolicies []Change `json:"createdPolicies,omitempty"`
	// UpdatedPolicies are the policies updated, in order, with the fields that differ
	UpdatedPolicies []Change `json:"updatedPolicies,omitempty"`
	// UnchangedPolicies counts policies that already match Openlane
	UnchangedPolicies int `json:"unchangedPolicies"`
	// Warnings are non-fatal issues such as mapped control refCodes that
	// could not be resolved and were skipped
	Warnings []string `json:"warnings,omitempty"`
	// Errors are per-record failures, the run continues past them so one
	// rejected record does not abort the batch
	Errors []string `json:"errors,omitempty"`
}

type Change struct {
	// Ref is the control refCode or the policy name
	Ref string `json:"ref"`
	// Detail is the managed fields that differ, or the mapping targets added,
	// empty when the record is created outright
	Detail []string `json:"detail,omitempty"`
}

type Client struct {
	// contains filtered or unexported fields
}

type Config struct {
	// Host is the base URL of the Openlane API
	Host string
	// Token is the API token used for authentication
	Token string
	// OrganizationID optionally scopes requests to a specific organization
	OrganizationID string
}

type FormatResult struct {
	// Changed are the relative paths whose content differs from canonical form
	Changed []string
}

type Kind string

type Option func(*Client)

type PullResult struct {
	// TotalControls is the number of organization controls exported
	TotalControls int `json:"totalControls"`
	// TotalPolicies is the number of internal policies exported
	TotalPolicies int `json:"totalPolicies"`
	// Written are the relative paths created or updated
	Written []string `json:"written,omitempty"`
	// Removed are the relative paths of stale documents deleted
	Removed []string `json:"removed,omitempty"`
	// Warnings are records the export could not represent, such as a
	// subcontrol whose parent control is not itself exported
	Warnings []string `json:"warnings,omitempty"`
}

type RemoteControl struct {
	// ID is the Openlane ULID of the control
	ID string `json:"id"`
	// RefCode is the unique reference code of the control
	RefCode string `json:"refCode"`
	// Title is the human readable title of the control
	Title string `json:"title"`
	// Description describes what the control is supposed to accomplish
	Description string `json:"description"`
	// Category is the category of the control
	Category string `json:"category"`
	// Subcategory is the subcategory of the control
	Subcategory string `json:"subcategory"`
	// ReferenceFramework is the framework short name when the control derives from a standard
	ReferenceFramework string `json:"referenceFramework"`
	// Tags associated with the control
	Tags []string `json:"tags"`
}

type RemoteMapping struct {
	// ID is the Openlane ULID of the mapped control record
	ID string `json:"id"`
	// Source is how the mapping was created, courier owns the imported ones
	Source string `json:"source"`
	// From are the controls and subcontrols on the from side of the mapping
	From []RemoteRef `json:"from"`
	// To are the controls and subcontrols on the to side of the mapping
	To []RemoteRef `json:"to"`
}

type RemotePolicy struct {
	// ID is the Openlane ULID of the policy
	ID string `json:"id"`
	// Name is the unique name of the policy
	Name string `json:"name"`
	// KindName is the policy kind, e.g. Security, Operational
	KindName *string `json:"internalPolicyKindName"`
	// Status is the document status, e.g. PUBLISHED, DRAFT
	Status string `json:"status"`
	// Revision is the document revision, e.g. v1.0.0
	Revision string `json:"revision"`
	// Details is the stored policy body
	Details *string `json:"details"`
	// Tags associated with the policy
	Tags []string `json:"tags"`
	// Controls are the controls linked to the policy
	Controls []RemoteRef `json:"controls"`
}

type RemoteRef struct {
	// ID is the Openlane ULID of the referenced record
	ID string `json:"id"`
	// RefCode is the reference code of the referenced record
	RefCode string `json:"refCode"`
	// Framework is the short name of the framework the record derives from,
	// empty for organization custom controls
	Framework string `json:"framework"`
	// Subcontrol reports whether the reference is a subcontrol rather than a
	// control, the two live in separate edge sets on a mapping
	Subcontrol bool `json:"subcontrol,omitempty"`
}

type RemoteState struct {
	// Controls are the organization-owned controls not derived from a framework
	Controls []RemoteControl
	// Subcontrols are the organization-owned subcontrols of those controls
	Subcontrols []RemoteSubcontrol
	// Mappings are the organization-owned mapped-control records
	Mappings []RemoteMapping
	// Policies are the organization-owned internal policies
	Policies []RemotePolicy
}

type RemoteSubcontrol struct {
	// RemoteControl holds the fields a subcontrol shares with a control
	RemoteControl
	// ControlID is the Openlane ULID of the parent control
	ControlID string `json:"controlID"`
}

type Settings struct {
	// Host is the base URL of the Openlane API
	Host string `koanf:"host"`
	// Token is the API token used for authentication
	Token string `koanf:"token" sensitive:"true"`
	// OrganizationID optionally scopes requests to a specific organization, only needed for multi-organization tokens
	OrganizationID string `koanf:"organization-id"`
	// Dir is the directory holding the exported files
	Dir string `koanf:"dir"`
}

type Store struct {
	// Dir is the directory the files were loaded from
	Dir string
	// Controls is the parsed control inventory
	Controls []*controlfile.Control
	// Policies is the parsed policy manifest
	Policies []*controlfile.Policy
	// PolicyMarkdown holds the raw markdown document per manifest entry
	PolicyMarkdown map[string][]byte
}