@quadnix/octo/types

Index

Functions/Dependency

• IDependency

References

• DiffAction
• ServiceType

Services/State Management

• ExternalResourceStateFile
• ImportStateFile
• ModelStateFile
• ResourceStateFile

Types

• ModelSerializedOutput
• ResourceSerializedOutput

References

DiffAction

Re-exports DiffAction

ServiceType

Re-exports ServiceType

Services/State Management

ExternalResourceStateFile

ExternalResourceStateFile:

resource-state-<resourceId>.json, with each / of the id written as .: what an external resource's action made of it — the inputs it was given, the properties it was asked for, and the response it produced. It exists only between the action succeeding and the commit that folds it into the resource graph, and while it exists it is the truth about that resource.

@group

Services/State Management

inputs

inputs: {}

Type declaration

• [key string]: unknown

properties

properties: {}

Type declaration

• [key string]: unknown

response

response: {}

Type declaration

• [key string]: string

ImportStateFile

ImportStateFile: {}

imports.json: the sealed state of each app this one extends (extends:<index>) and each store it reads (stores:<name>), as the last generate read them, so every later command of the run reads the same.

@group

Services/State Management

---

Type declaration

• [importKey string]: { modelState: ModelStateFile; resourceState: ResourceStateFile }

ModelStateFile

ModelStateFile:

models.json: the model graph as it stands after the last commit.

@group

Services/State Management

data

data: ModelSerializedOutput

userData

userData: ModelStateUserData

ResourceStateFile

ResourceStateFile:

resources-actual.json, the resource graph as it stands after the last commit, and resources-old.json, the resource graph as intent described it on the last commit.

@group

Services/State Management

data

data: ResourceSerializedOutput

userData

userData: ResourceStateUserData

Types

ModelSerializedOutput

ModelSerializedOutput:

The model graph as written to models.json.

• nodeName names the base model an entry extends, and types its model as that base model's schema. A model's own fields beyond it are not typed.
• modules record inputs before references resolve.

@group

Types

anchors

anchors: (AnchorSerializedOutput & { className: string; location: { context: string; type: `${NodeType}` } })[]

dependencies

dependencies: IDependency[]

models

models: {}

Type declaration

• [context string]: { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N } | { className: string; model: BaseModelSchemas[N]; moduleId: string; nodeName: N }

modules

modules: {}

Type declaration

• [moduleId string]: { className: string; inputs: {} }

overlays

overlays: { className: string; context: string; moduleId: string; overlay: { anchors: AnchorSerializedOutput[]; overlayId: string; properties: {} } }[]

ResourceSerializedOutput

ResourceSerializedOutput:

The resource graph as written to resources-actual.json and resources-old.json.

• createdBy is the context of the model or overlay whose action created the resource.
• models record the context of every model and overlay whose action produced the resource.
• copiedResources holds a copy of every resource of another app that this app's resources stand on, such as a store's, and of their parents in turn, as this app last saw them. They rebuild this app's resources, and are never this app's own.

@group

Types

optionalcopiedResources

copiedResources?: ResourceSerializedOutput[resources]

dependencies

dependencies: IDependency[]

resources

resources: {}

Type declaration

• [context string]: { className: string; createdBy?: string; kind: external | terraform; models: string[]; moduleId: string; resource: ResourceSerializedSchema }