schema

type EntityModelSchema struct {
	// Root is the root node of the schema tree.
	// Root node is a dummy node, it's not a real field in the model. Actual doc parsing starts from the children of root node.
	Root TreeNode

	// Nodes is a map used to quickly access the [TreeNode] by path.
	Nodes map[string]*TreeNode
}

type EntityModelSchemaCache interface {
	GetSchema(schemaName string) (*EntityModelSchema, error)
	SetSchema(schemaName string, schema *EntityModelSchema)
}

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

type SchemaFieldProps struct {
	// Type holds the struct field type or the underlying type in case of pointer.
	Type reflect.Kind
	// IsPointer is used to identify pointer type of fields.
	IsPointer bool
	// Transformers are the transformations that needs to be applied on the field while building the bson doc.
	Transformers []transformer.Transformer
	// Options are the schema options for the field.
	Options fieldopt.SchemaFieldOptions
}

type TreeNode struct {
	// Path is used to identify the ancestor chain. Used for debugging purposes.
	Path string
	// BSONKey is the translated bson key.
	BSONKey string
	// Key is the struct field name. Used for debugging purposes.
	Key string
	// Props contains the field properties.
	Props SchemaFieldProps
	// Children contains the child nodes.
	// Array is used instead of map to preserve the order of fields. Fields in bson doc should always match with the schema tree order.
	Children []TreeNode
}