rest

type API interface {
	// Получение информации о методе
	Info() *Info

	// Вызывается перед обращением к базе, используется, например, для добавления дополнительных параметров или проверок
	// Если возвращает code != 0 или result != nil, то они и будут результатом
	// Если code<0, то result содержит готовый ответ в []byte, отсылаем как есть с кодом -code
	Before(proc *ProcOptions) (result any, code int, err error)

	// Вызывается после обращения к базе, используется, например, для обогащения результата
	// Если возвращает code != 0 или result != nil, то они и будут результатом
	// Если code<0, то result содержит готовый ответ в []byte, отсылаем как есть с кодом -code
	After(proc *ProcOptions) (result any, code int, err error)
}

type ByRow struct {
	Begin []byte // Пишется один раз в начале
	End   []byte // Пишется один раз в конце

	Data []RowData

	RowNum  int  // Количество выданных строк (увеличивается в конце обработки строки)
	IsFinal bool // Финал, Tuner еще раз вызывается после завершения выборки, в первом параметре опять последнее значение
	// contains filtered or unexported fields
}

type ByRowTuner func(br *ByRow, row any) (err error)

type Enumerator func(path string, info *Info) (err error)

type ExecResult struct {
	AffectedRows uint64          `json:"affectedRows" comment:"Количеcтво затронутых записей"`
	Rows         []ExecResultRow `json:"rows,omitempty" comment:"Созданные записи" ref:"execResultRow"`
	Notice       string          `json:"notice,omitempty" comment:"Сообщения"`
}

type ExecResultRow struct {
	ID      uint64 `json:"id,omitempty" comment:"ID созданной записи"`
	GUID    string `json:"guid,omitempty" comment:"GUID созданной записи"`
	Message string `json:"message,omitempty" comment:"Сообщения"`
	// contains filtered or unexported fields
}

type ExternalDocs struct {
	Description string
	URL         string
}

type FieldDef struct {
	JSONname string
	DBname   string
	Type     reflect.Kind
}

type FindModule func(path string) (module *Module, basePath string, extraPath []string, found bool)

type FuncAfter func(proc *ProcOptions) (result any, code int, err error)

type FuncBefore func(proc *ProcOptions) (result any, code int, err error)

type FuncInit func(info *Info) (err error)

type FuncResultTuner func(proc *ProcOptions, result0 any, code0 int, err0 error) (result any, code int, err error)

type Info struct {
	Path        string     // Относительный (от базового) путь в URL
	Name        string     // Имя, желательно  чтобы по правилам имен переменных
	Summary     string     // Краткое описание
	Description string     // Описание, по умолчанию сформированное из Summary и query параметров
	Tags        []string   // Имена тегов для группировки
	Flags       path.Flags // Флаги
	Methods     *path.Set  // Цепочки обработки
	Config      any        // Кастомные параметры в конфиг файле
	DBtype      string     // Тип базы. Если пусто, то по умолчанию из конфига
	QueryPrefix string     // Префикс имени запроса в базу
	Init        FuncInit   // User defined Init
	Before      FuncBefore // User defined Before query
	After       FuncAfter  // User defined After query

	ResultTuner FuncResultTuner // The last step result tuner
	// contains filtered or unexported fields
}

type Module struct {
	RawURL      string
	RelativeURL string        // URL без учета базовой части
	Handler     API           // Интерфейс метода
	Info        *Info         // Информация о методе
	LogFacility *log.Facility // Log facility
}

type ProcOptions struct {
	LogFacility      *log.Facility       // Предпочтительная facility для логирования
	H                *stdhttp.HTTP       // HTTP листенер
	LogSrc           string              // Строка с ID запроса для MessageWithSource
	Info             *Info               // Информация о методе
	ID               uint64              // ID запроса
	Prefix           string              // Префикс пути запроса (при работе через прокси)
	Path             string              // Путь запроса
	Tail             []string            // Остаток пути
	R                *http.Request       // Запрос
	W                http.ResponseWriter // Интерфейс для ответа
	Chain            *path.Chain         // Обрабатываемая цепочка
	ChainLocal       path.Chain          // Копия Chain для возможности ее модификации для работы с динамическими объектами. Рекомендуется использовать её, а не Chain.Parent
	Scope            string              // Обрабатываемый Scope
	RawBody          []byte              // Тело запроса. В R.Body уже nil!
	PathParams       any                 // Path параметры
	QueryParams      any                 // Query параметры
	QueryParamsFound misc.BoolMap        // Query параметры, присутствующие в запросе в явном виде
	RequestParams    any                 // Request параметры
	DBqueryName      string              // Имя запроса к базе данных
	DBqueryVars      []any               // Переменные для формирования запроса
	ResultAsRows     bool                // Возвращать для GET не готовый результат, а *sqlx.Rows, чтобы производить разбор самостоятельно. Актуально для больших результатов.
	DBqueryResult    any                 // Результат выполненения запроса (указатель на слайс) при ResultAsRows==false
	DBqueryRows      *sqlx.Rows          // Результат при ResultAsRows==true
	Fields           []misc.InterfaceMap // Поля (имя из sql запроса) для insert или update. Для select - список полей для выборки из базы, если нужны не все из объекта
	ExcludedFields   misc.StringMap      // Поля ([name]db_name), которые надо исключить из запроса
	Notices          *misc.Messages      // Предупреждения и замечания обработчика
	ExecResult       *ExecResult         // Результат выполнения Exec
	ExtraHeaders     misc.StringMap      // Дополнительные возвращаемые HTTP заголовки

	Extra  any // Произвольные данные от вызывающего
	Custom any // Произвольные пользовательские данные
	// contains filtered or unexported fields
}

type RowData struct {
	Prefix    []byte // Дополнительный блок цикла, который может возвращаться из ByRowTuner и пишется перед основными данными
	Suffix    []byte // Дополнительный блок цикла, который может возвращаться из ByRowTuner и пишется после основных данных
	Delimiter []byte // Разделитель строк
	Data      any    // Основные данные цикла
}

type Tag struct {
	Name         string
	Aliases      []string
	Description  string
	ExternalDocs ExternalDocs
}

type Tags []*Tag