constructs

type Construct struct {
}

type ConstructIface interface {
	IConstructIface
	OnPrepare()
	OnSynthesize(session ISynthesisSessionIface)
	OnValidate() []string
	ToString() string
}

type ConstructMetadata struct {
}

type ConstructMetadataIface interface {
}

type ConstructOptions struct {
	// A factory for attaching `Node`s to the construct.
	NodeFactory INodeFactoryIface `json:"nodeFactory"`
}

type ConstructOptionsIface interface {
	GetNodeFactory() INodeFactoryIface
}

type ConstructOrder string

type Dependency struct {
	// Source the dependency.
	Source IConstructIface `json:"source"`
	// Target of the dependency.
	Target IConstructIface `json:"target"`
}

type DependencyIface interface {
	GetSource() IConstructIface
	GetTarget() IConstructIface
}

type IAspect struct{}

type IAspectIface interface {
	// All aspects can visit an IConstruct.
	Visit(node IConstructIface)
}

type IConstruct struct{}

type IConstructIface interface {
}

type INodeFactory struct{}

type INodeFactoryIface interface {
	// Returns a new `Node` associated with `host`.
	CreateNode(host ConstructIface, scope IConstructIface, id string) NodeIface
}

type ISynthesisSession struct{}

type ISynthesisSessionIface interface {
	// The output directory for this synthesis session.
	GetOutdir() string
}

type IValidation struct{}

type IValidationIface interface {
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if there the construct is valid.
	Validate() []string
}

type MetadataEntry struct {
	// The data.
	Data interface{} `json:"data"`
	// The metadata entry type.
	Type string `json:"type"`
	// Stack trace.
	//
	// Can be omitted by setting the context key
	// `ConstructMetadata.DISABLE_STACK_TRACE_IN_METADATA` to 1.
	Trace []string `json:"trace"`
}

type MetadataEntryIface interface {
	GetData() interface{}
	GetType() string
	GetTrace() []string
}

type Node struct {
	// Returns an opaque tree-unique address for this construct.
	//
	// Addresses are 42 characters hexadecimal strings. They begin with "c8"
	// followed by 40 lowercase hexadecimal characters (0-9a-f).
	//
	// Addresses are calculated using a SHA-1 of the components of the construct
	// path.
	//
	// To enable refactorings of construct trees, constructs with the ID `Default`
	// will be excluded from the calculation. In those cases constructs in the
	// same tree may have the same addreess.
	//
	// TODO: EXAMPLE
	//
	Addr string `json:"addr"`
	// All direct children of this construct.
	Children []IConstructIface `json:"children"`
	// Return all dependencies registered on this node or any of its children.
	Dependencies []DependencyIface `json:"dependencies"`
	// The id of this construct within the current scope.
	//
	// This is a a scope-unique id. To obtain an app-unique id for this construct, use `uniqueId`.
	Id string `json:"id"`
	// Returns true if this construct or the scopes in which it is defined are locked.
	Locked bool `json:"locked"`
	// An immutable array of metadata objects associated with this construct.
	//
	// This can be used, for example, to implement support for deprecation notices, source mapping, etc.
	Metadata []MetadataEntryIface `json:"metadata"`
	// The full, absolute path of this construct in the tree.
	//
	// Components are separated by '/'.
	Path string `json:"path"`
	// Returns the root of the construct tree.
	//
	// Returns: The root of the construct tree.
	Root IConstructIface `json:"root"`
	// All parent scopes of this construct.
	//
	// Returns: a list of parent scopes. The last element in the list will always
	// be the current construct and the first element will be the root of the
	// tree.
	Scopes []IConstructIface `json:"scopes"`
	// A tree-global unique alphanumeric identifier for this construct.
	//
	// Includes
	// all components of the tree.
	// Deprecated: please avoid using this property and use `uid` instead. This
	// algorithm uses MD5, which is not FIPS-complient and also excludes the
	// identity of the root construct from the calculation.
	UniqueId string `json:"uniqueId"`
	// Returns the scope in which this construct is defined.
	//
	// The value is `undefined` at the root of the construct scope tree.
	Scope IConstructIface `json:"scope"`
	// Returns the child construct that has the id `Default` or `Resource"`.
	//
	// This is usually the construct that provides the bulk of the underlying functionality.
	// Useful for modifications of the underlying construct that are not available at the higher levels.
	// Override the defaultChild property.
	//
	// This should only be used in the cases where the correct
	// default child is not named 'Resource' or 'Default' as it
	// should be.
	//
	// If you set this to undefined, the default behavior of finding
	// the child named 'Resource' or 'Default' will be used.
	//
	// Returns: a construct or undefined if there is no default child
	DefaultChild IConstructIface `json:"defaultChild"`
}

type NodeIface interface {
	GetAddr() string
	GetChildren() []IConstructIface
	GetDependencies() []DependencyIface
	GetId() string
	GetLocked() bool
	GetMetadata() []MetadataEntryIface
	GetPath() string
	GetRoot() IConstructIface
	GetScopes() []IConstructIface
	GetUniqueId() string
	GetScope() IConstructIface
	GetDefaultChild() IConstructIface
	SetDefaultChild(val IConstructIface)
	AddDependency(dependencies IConstructIface)
	AddError(message string)
	AddInfo(message string)
	AddMetadata(type_ string, data interface{}, fromFunction interface{})
	AddValidation(validation IValidationIface)
	AddWarning(message string)
	ApplyAspect(aspect IAspectIface)
	FindAll(order ConstructOrder) []IConstructIface
	FindChild(id string) IConstructIface
	Prepare()
	SetContext(key string, value interface{})
	Synthesize(options SynthesisOptionsIface)
	TryFindChild(id string) IConstructIface
	TryGetContext(key string) interface{}
	TryRemoveChild(childName string) bool
	Validate() []ValidationErrorIface
}

type SynthesisOptions struct {
	// The output directory into which to synthesize the cloud assembly.
	Outdir string `json:"outdir"`
	// Additional context passed into the synthesis session object when `construct.synth` is called.
	SessionContext map[string]interface{} `json:"sessionContext"`
	// Whether synthesis should skip the validation phase.
	SkipValidation bool `json:"skipValidation"`
}

type SynthesisOptionsIface interface {
	GetOutdir() string
	GetSessionContext() map[string]interface{}
	GetSkipValidation() bool
}

type ValidationError struct {
	// The error message.
	Message string `json:"message"`
	// The construct which emitted the error.
	Source ConstructIface `json:"source"`
}

type ValidationErrorIface interface {
	GetMessage() string
	GetSource() ConstructIface
}