archsketch

type Business struct {
	Processes []BusinessProcess `json:"processes"`
	Roles     []BusinessRole    `json:"roles"`
	Products  []Product         `json:"products"`
	// ProductsWithheld counts the products a read withheld from its reader; it is set
	// by [Business.Redacted], never stored.
	ProductsWithheld int `json:"productsWithheld,omitempty"`
	// Omitted counts, per kind, what the bounds left out.
	Omitted BusinessOmitted `json:"omitted,omitzero"`
}

type BusinessOmitted struct {
	Roles          int `json:"roles,omitempty"`
	RoleUses       int `json:"roleUses,omitempty"`
	Products       int `json:"products,omitempty"`
	ProductActions int `json:"productActions,omitempty"`
}

type BusinessProcess struct {
	ProcessID string `json:"processId"`
	Name      string `json:"name,omitempty"`
	// GroupTasks are the user tasks offered to candidate groups the model names,
	// PersonTasks those assigned to one person by name, RuntimeTasks those whose
	// assignee or candidate groups the model computes per instance, and OpenTasks
	// those that name nobody.
	GroupTasks   int `json:"groupTasks,omitempty"`
	PersonTasks  int `json:"personTasks,omitempty"`
	RuntimeTasks int `json:"runtimeTasks,omitempty"`
	OpenTasks    int `json:"openTasks,omitempty"`
}

type BusinessRole struct {
	Name string `json:"name"`
	Kind string `json:"kind"`
	// UsedBy are the user tasks offered to a candidate group, or for a lane the
	// processes that have it.
	UsedBy []Use `json:"usedBy"`
}

type Capability struct {
	Key   string `json:"key"`
	Name  string `json:"name"`
	State string `json:"state,omitempty"`
	// ConfirmedAt is when the record was last confirmed, in Unix seconds; zero when it
	// never was.
	ConfirmedAt int64         `json:"confirmedAt,omitempty"`
	Owner       *Owner        `json:"owner,omitempty"`
	KPIs        []KPI         `json:"kpis,omitempty"`
	SLAs        []SLA         `json:"slas,omitempty"`
	RealizedBy  []Realization `json:"realizedBy"`
}

type Coupling struct {
	// Names are the messages and signals the release throws, and the signals it
	// catches; the messages it receives are its entry points.
	Names []NameUse `json:"names"`
	// Peers are the processes of other applications that throw a name the release
	// receives, or receive a name it throws.
	Peers []Peer `json:"peers"`
	// Feed is the event feed the installation pushes.
	Feed EventFeed `json:"feed"`
	// PeersWithheld counts the peers a read withheld from its reader; it is set by
	// [Coupling.Redacted], never stored.
	PeersWithheld int `json:"peersWithheld,omitempty"`
	// Omitted counts, per kind, what the bounds left out.
	Omitted CouplingOmitted `json:"omitted,omitzero"`
}

type CouplingOmitted struct {
	Names       int `json:"names,omitempty"`
	Peers       int `json:"peers,omitempty"`
	FeedTargets int `json:"feedTargets,omitempty"`
}

type Data struct {
	Objects  []DataObject          `json:"objects"`
	Stores   []DataStore           `json:"stores"`
	Classes  []DataClass           `json:"classes"`
	Personal []PersonalDeclaration `json:"personal"`
	// Omitted counts, per kind, what the bounds left out.
	Omitted DataOmitted `json:"omitted,omitzero"`
}

type DataClass struct {
	Name string `json:"name"`
	// Modeled is set when the application's information model defines the class; a
	// class that is not modeled is only a name the process model declares.
	Modeled bool `json:"modeled,omitempty"`
}

type DataObject struct {
	ProcessID string `json:"processId"`
	Name      string `json:"name"`
	// Class is the type the model declares for it (the itemDefinition's structure),
	// empty when it declares none.
	Class        string `json:"class,omitempty"`
	Collection   bool   `json:"collection,omitempty"`
	InitialState string `json:"initialState,omitempty"`
	// ReadBy are the elements whose data input associations read it.
	ReadBy []string `json:"readBy"`
	// WrittenBy are the elements whose data output associations write it.
	WrittenBy []DataWrite `json:"writtenBy"`
}

type DataOmitted struct {
	Objects           int `json:"objects,omitempty"`
	Stores            int `json:"stores,omitempty"`
	Classes           int `json:"classes,omitempty"`
	PersonalVariables int `json:"personalVariables,omitempty"`
}

type DataStore struct {
	Name string `json:"name"`
	// Class is the class the application's information model keeps in the store,
	// empty when no model names one.
	Class  string `json:"class,omitempty"`
	UsedBy []Use  `json:"usedBy"`
}

type DataWrite struct {
	ElementID string   `json:"elementId"`
	State     string   `json:"state,omitempty"`
	Members   []string `json:"members,omitempty"`
}

type Dependency struct {
	Kind string `json:"kind"`
	// Name is the worker name, the FEEL expression of a runtime worker, the job type,
	// the called process id, or the decision id.
	Name string `json:"name"`
	// WorkerType is a worker's Worker Type ("rest", "mail", …) as the model's task
	// type states it.
	WorkerType string `json:"workerType,omitempty"`
	// TargetApplicationID and TargetApplication name the application that held the
	// called process on the recording installation when the snapshot was taken. Empty
	// when nothing there held it — which says the call had no target there, not that
	// it has none anywhere.
	TargetApplicationID string `json:"targetApplicationId,omitempty"`
	TargetApplication   string `json:"targetApplication,omitempty"`
	// TargetWithheld is set by a read for a reader who may not see the called
	// application: the call stays, the application's name does not (ADR-0495 §5).
	TargetWithheld bool  `json:"targetWithheld,omitempty"`
	UsedBy         []Use `json:"usedBy"`
}

type Endpoint struct {
	Scheme string `json:"scheme,omitempty"`
	Host   string `json:"host,omitempty"`
	// Port is the port the configured value named. Empty when it named none, which
	// means the scheme's or the Worker Type's default — the snapshot does not guess
	// which.
	Port string `json:"port,omitempty"`
	// Unparseable is set when the configured value could not be read as an address.
	// The value itself is not kept: what cannot be parsed cannot be cleaned either.
	Unparseable bool `json:"unparseable,omitempty"`
	// Withheld is set on a read for a reader who may not see it. Never stored.
	Withheld bool `json:"withheld,omitempty"`
}

type EntryPoint struct {
	Kind string `json:"kind"`
	Name string `json:"name"`
	// Starts is set when at least one element receiving this message starts an
	// instance; otherwise every receipt continues one that is already running.
	Starts bool  `json:"starts,omitempty"`
	UsedBy []Use `json:"usedBy"`
}

type EventFeed struct {
	Subscriptions int          `json:"subscriptions"`
	Targets       []FeedTarget `json:"targets"`
}

type FeedTarget struct {
	Worker       string    `json:"worker,omitempty"`
	ConfiguredID string    `json:"configuredId,omitempty"`
	Endpoint     *Endpoint `json:"endpoint,omitempty"`
	// Withheld is set by a read for a reader who may not see the Worker.
	Withheld bool `json:"withheld,omitempty"`
}

type InboundSite struct {
	MessageName string `json:"messageName"`
	// Worker and WorkerType name the configured Worker the subscription reads
	// through; empty when the Worker had been deleted since, which leaves the
	// subscription with nowhere to read from.
	Worker     string `json:"worker,omitempty"`
	WorkerType string `json:"workerType,omitempty"`
	// ConfiguredID is that Worker's id, kept so a read can ask who may see the
	// subscription's subject and endpoint: both are the Worker's configuration.
	ConfiguredID string `json:"configuredId,omitempty"`
	// Subject is what the subscription watches, in the terms of the Worker's kind: a
	// clio subject (Recursive when it takes the subtree too), a Jira query, a
	// spreadsheet, a folder, a channel or a mail folder.
	Subject   string    `json:"subject,omitempty"`
	Recursive bool      `json:"recursive,omitempty"`
	Endpoint  *Endpoint `json:"endpoint,omitempty"`
	// Withheld is set on a read by somebody who may not see the Worker's
	// configuration: the subscription is still there, its subject and endpoint are not.
	Withheld bool `json:"withheld,omitempty"`
}

type JobTypeSite struct {
	JobType string `json:"jobType"`
	Observers
}

type KPI struct {
	Name      string `json:"name"`
	Metric    string `json:"metric,omitempty"`
	Goal      string `json:"goal,omitempty"`
	Direction string `json:"direction,omitempty"`
}

type Layer string

type Meta struct {
	ApplicationID string
	Application   string
	ReleaseID     string
	Version       int32
}

type NameUse struct {
	Kind      string `json:"kind"`
	Name      string `json:"name"`
	Direction string `json:"direction"`
	UsedBy    []Use  `json:"usedBy"`
}

type Observers struct {
	ObservedBy        []string `json:"observedBy,omitempty"`
	Observed          int      `json:"observed"`
	ObserversWithheld bool     `json:"observersWithheld,omitempty"`
}

type Owner struct {
	Name string `json:"name,omitempty"`
	Role string `json:"role,omitempty"`
	// Withheld is set by a read for a reader outside Atlas (see [Snapshot.Minimal]):
	// an owner is recorded, and the person is not what such a reader is shown.
	Withheld bool `json:"withheld,omitempty"`
}

type Peer struct {
	Kind      string `json:"kind"`
	Name      string `json:"name"`
	Direction string `json:"direction"`
	// ApplicationID and Application name the peer's application; both are empty for a
	// process filed in no application.
	ApplicationID string `json:"applicationId,omitempty"`
	Application   string `json:"application,omitempty"`
	ProcessID     string `json:"processId,omitempty"`
	ElementID     string `json:"elementId,omitempty"`
	// System is set for one of Atlas's own processes (ADR-0435).
	System bool `json:"system,omitempty"`
	// Withheld is set by a read for a reader who may not see the peer's application:
	// the name and direction stay, the application and process do not.
	Withheld bool `json:"withheld,omitempty"`
}

type PersonalDeclaration struct {
	ProcessID string   `json:"processId"`
	Variables []string `json:"variables"`
	Subject   string   `json:"subject"`
	// HandedTo are the workers, runtime workers and job types the process hands work
	// to. Each can read every variable visible at its task in plaintext — a worker
	// process leasing a job is given them all deciphered, and a Worker Atlas runs
	// resolves its task over them — so each can receive these values, whether or not
	// its task names one.
	HandedTo []PersonalRecipient `json:"handedTo"`
}

type PersonalRecipient struct {
	Kind       string `json:"kind"`
	Name       string `json:"name"`
	WorkerType string `json:"workerType,omitempty"`
}

type Physical struct {
	// Node and Environment are the recording installation's operator-given name and
	// environment (ADR-0189 §6). Empty where nobody named them.
	Node        string `json:"node,omitempty"`
	Environment string `json:"environment,omitempty"`
	// ExternalURL is the origin the installation was configured to be reached under.
	// Nil when none was configured: the listen address is not the reachable address,
	// so it is not offered in its place.
	ExternalURL *Endpoint `json:"externalUrl,omitempty"`
	// PublicStartLinks counts the public start links each process had here. The links
	// themselves are their own authorization and are never recorded.
	PublicStartLinks []StartLinks  `json:"publicStartLinks"`
	Workers          []WorkerSite  `json:"workers"`
	JobTypes         []JobTypeSite `json:"jobTypes"`
	// Inbound are the inbound subscriptions that turned an external system's events
	// into a message the release receives (format version 4, ADR-0495 slice B). A
	// disabled subscription feeds nothing and is not recorded.
	Inbound []InboundSite `json:"inbound,omitempty"`
}

type Process struct {
	ProcessID string `json:"processId"`
	Name      string `json:"name,omitempty"`
	Version   int32  `json:"version"`
	// Unread is set when the definition was recorded as a member but its compiled
	// form was not there to read. Its entry points and dependencies are then missing
	// from the snapshot, and the snapshot says so rather than drawing a process that
	// offers and needs nothing.
	Unread bool `json:"unread,omitempty"`
}

type Product struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	CatalogID   string `json:"catalogId"`
	CatalogName string `json:"catalogName,omitempty"`
	State       string `json:"state,omitempty"`
	// Bindings are the operations a release process carries out for it.
	Bindings []ProductBinding `json:"bindings"`
	// Actions are the commands a lifecycle product declares, with what each publishes.
	Actions []ProductAction `json:"actions,omitempty"`
}

type ProductAction struct {
	Key      string           `json:"key"`
	Message  string           `json:"message"`
	Effect   string           `json:"effect,omitempty"`
	Triggers []string         `json:"triggers,omitempty"`
	Outcomes []ProductOutcome `json:"outcomes,omitempty"`
}

type ProductBinding struct {
	Op        string `json:"op"`
	ProcessID string `json:"processId"`
	Message   string `json:"message,omitempty"`
}

type ProductOutcome struct {
	Outcome   string `json:"outcome"`
	EventType string `json:"eventType"`
}

type Realization struct {
	Kind      string `json:"kind"`
	ProcessID string `json:"processId,omitempty"`
	Worker    string `json:"worker,omitempty"`
}

type SLA struct {
	Name      string `json:"name"`
	Metric    string `json:"metric,omitempty"`
	Threshold string `json:"threshold,omitempty"`
	Window    string `json:"window,omitempty"`
	Scope     string `json:"scope,omitempty"`
}

type Selection uint8

type Snapshot struct {
	FormatVersion  int `json:"formatVersion"`
	MappingVersion int `json:"mappingVersion"`
	// TakenAt is when the snapshot was taken, by the server's clock, in Unix seconds.
	TakenAt int64 `json:"takenAt"`
	// Processes are the release's process members, as they were deployed.
	Processes []Process `json:"processes"`
	// EntryPoints are where the environment reaches into the application.
	EntryPoints []EntryPoint `json:"entryPoints"`
	// Dependencies are what the application reaches out to.
	Dependencies []Dependency `json:"dependencies"`
	// Physical is the recording installation's half, absent on a snapshot taken
	// before format version 2.
	Physical *Physical `json:"physical,omitempty"`
	// Data is the data layer, absent on a snapshot taken before format version 5.
	Data *Data `json:"data,omitempty"`
	// Business and Strategy are the business and strategy layers, absent on a
	// snapshot taken before format version 6.
	Business *Business `json:"business,omitempty"`
	Strategy *Strategy `json:"strategy,omitempty"`
	// Coupling is how the release meets other applications through names, and the
	// event feed; part of the application layer, absent before format version 7.
	Coupling *Coupling `json:"coupling,omitempty"`
	// contains filtered or unexported fields
}

type Stage struct {
	Key          string   `json:"key"`
	Name         string   `json:"name"`
	Capabilities []string `json:"capabilities"`
}

type StartLinks struct {
	ProcessID string `json:"processId"`
	Links     int    `json:"links"`
}

type Strategy struct {
	Capabilities []Capability  `json:"capabilities"`
	ValueStreams []ValueStream `json:"valueStreams"`
	// Omitted counts, per kind, what the bounds left out.
	Omitted StrategyOmitted `json:"omitted,omitzero"`
}

type StrategyOmitted struct {
	Capabilities int `json:"capabilities,omitempty"`
	ValueStreams int `json:"valueStreams,omitempty"`
	Measures     int `json:"measures,omitempty"`
	Stages       int `json:"stages,omitempty"`
}

type Use struct {
	ProcessID string `json:"processId"`
	ElementID string `json:"elementId,omitempty"`
}

type ValueStream struct {
	Key    string  `json:"key"`
	Name   string  `json:"name"`
	Owner  *Owner  `json:"owner,omitempty"`
	Stages []Stage `json:"stages"`
}

type WorkerIdentity struct {
	Mode        string `json:"mode"`
	Enforcement string `json:"enforcement,omitempty"`
}

type WorkerSite struct {
	Name       string `json:"name"`
	WorkerType string `json:"workerType,omitempty"`
	Placement  string `json:"placement"`
	// ConfiguredID is the configured worker the installation held under this name, and
	// empty when it held none — the case of a worker that keeps its own configuration
	// (ADR-0168). Kept so a read can ask who may see its endpoint.
	ConfiguredID    string    `json:"configuredId,omitempty"`
	Endpoint        *Endpoint `json:"endpoint,omitempty"`
	MailboxEndpoint *Endpoint `json:"mailboxEndpoint,omitempty"`
	// EndpointReported is set when Endpoint is not the installation's configuration
	// but what the worker instances serving the name reported (format version 3).
	// It is then information about those instances, and a read treats it as such.
	EndpointReported bool `json:"endpointReported,omitempty"`
	// EndpointsDiffer is set when the instances serving the name reported different
	// endpoints. None of them is recorded then: picking one would draw a single
	// system where the installation reaches several.
	EndpointsDiffer bool `json:"endpointsDiffer,omitempty"`
	// The rest of the configured Worker, from format version 4 (ADR-0495 slice B),
	// none of it a secret: the mail transport, the malware scanner a mail Worker hands
	// messages to, the model an agent Worker asks (ADR-0255), the identity its actions
	// run as, and whether a credential is configured — never which one.
	Provider        string          `json:"provider,omitempty"`
	ScannerEndpoint *Endpoint       `json:"scannerEndpoint,omitempty"`
	Model           string          `json:"model,omitempty"`
	Identity        *WorkerIdentity `json:"identity,omitempty"`
	Credential      bool            `json:"credential,omitempty"`
	// DetailWithheld is set on a read by somebody who may not see the Worker's
	// configuration and the snapshot held some of it.
	DetailWithheld bool `json:"detailWithheld,omitempty"`
	Observers
}