crud

type Base struct {
	ID        uuid.UUID  `gorm:"type:uuid;primaryKey;default:gen_random_uuid()" json:"id" required:"false" readOnly:"true"`
	TenantID  uuid.UUID  `gorm:"type:uuid;not null" json:"-"`
	CreatedAt time.Time  `json:"createdAt" required:"false" readOnly:"true"`
	UpdatedAt time.Time  `json:"updatedAt" required:"false" readOnly:"true"`
	DeletedAt *time.Time `gorm:"index" json:"-"`
}

type Entity interface {
	TableName() string
	// contains filtered or unexported methods
}

type Field struct {
	// Name is the JSON name, which is the only name a caller ever uses.
	Name string `json:"name"`
	// Column is the database column, and the only string this package ever
	// interpolates into SQL. It comes from the struct, never from a request.
	Column string    `json:"-"`
	Type   FieldType `json:"type"`
	// Elem is what a TypeList holds, and empty for everything else.
	Elem FieldType `json:"elem,omitempty"`
	// Widget overrides the control a screen would pick from Type: `ui:"widget:select"`.
	Widget string `json:"widget,omitempty"`
	// Enum is the closed set of values, from `enum:"open,done"`.
	Enum []string `json:"enum,omitempty"`
	// Required comes from `validate:"required"`.
	Required bool `json:"required,omitempty"`
	// ReadOnly marks the fields Base contributes: a caller may read them and
	// may not write them, so they are skipped by the PATCH merge.
	ReadOnly bool `json:"readOnly,omitempty"`
	// HideList keeps a field off the list screen, from `ui:"hide:list"`.
	HideList bool `json:"hideList,omitempty"`
	// Default is the value the entity declares for a field a caller may leave
	// out, from `default:"open"` — the same tag huma reads, so the form and the
	// API document agree about what happens when nothing is sent. A form
	// preselects it, and a select that has one needs no "Choose a …" placeholder
	// because there is no unchosen state to name.
	Default string `json:"default,omitempty"`
	// Doc is what the field is for, from `doc:"Lifecycle state"` — again huma's
	// own tag, so the sentence in the OpenAPI document is the sentence under the
	// control. It is a description and not a label: the entities here write
	// "Short summary of the task", which reads under an input and not on it.
	Doc string `json:"doc,omitempty"`

	// Index locates the field in the struct. It is exported for one caller,
	// kit/rest's PATCH merge, which decodes a body into the field this names;
	// json:"-" because a screen has no use for it and a caller none at all.
	Index []int `json:"-"`
}

type FieldType string

type Query struct {
	Limit, Offset int
	Sort          string
	Filter        map[string]any
}

type Schema struct {
	Module string  `json:"module"`
	Entity string  `json:"entity"`
	Path   string  `json:"path"`
	Fields []Field `json:"fields"`
}

type Validator interface {
	Validate(ctx context.Context) error
}