Documentation
¶
Index ¶
- Constants
- Variables
- func Get() map[string]Store
- func Init(confFile string)
- func JWTExtraProps() []string
- func JWTTTL() (time.Duration, error)
- func OnUpdate(fn func(map[string]Store))
- func ReloadConfig(conf map[string]Store)
- type Access
- type Action
- type DataSource
- type Filter
- type HTTPHook
- type Hooks
- type Label
- type MigrationTask
- type Prop
- type State
- type Store
- type Task
- type Value
- type Widget
Constants ¶
View Source
const ( ObjDirectory = "directory" ObjProcess = "process" ObjMap = "map" ObjWorkspace = "workspace" ObjCampaign = "campaign" ObjNotification = "notification" ObjSingle = "single" ObjFile = "file" ObjProxy = "proxy" SinglesBucket = "_singles" DeletedBucket = "_deleted" TempFileStoreBucket = "_tmpFiles" ApiKeysBucket = "apikeys" Deleted = "_deleted" DefaultDirectory = "_default" DefaultProcess = "_defaultProcess" DefaultCampaign = "_defaultCampaign" DefaultNotification = "_defaultNotifications" DefaultSingle = "_defaultSingle" ObjClientSettings = "_clientSettings" ObjServerSettings = "_serverSettings" ObjCommonSettings = "_commonSettings" ObjSysLog = "syslog" ObjSystemHealth = "systemHealth" PropInt = "int" PropFloat = "float" PropBool = "bool" PropString = "string" PropDate = "date" PropRef = "ref" PropRefList = "refList" PropVirtual = "virtual" PropVirtualClient = "virtual/client" PropPassword = "password" PropObject = "object" PropObjectList = "objectList" PropVirtualRefList = "virtualRefList" PropComments = "comments" PropAny = "any" PropAction = "action" PropWidget = "widget" PropFile = "file" PropFileList = "fileList" TemplatePdf = "pdf" TemplateRtf = "rtf" TemplateHtml = "html" TemplateTxt = "txt" CreateAccess = "c" ReadAccess = "r" UpdateAccess = "u" DeleteAccess = "d" AllUsersGuid = "11111111-1111-1111-1111-111111111111" RootGuid = "00000000-0000-0000-0000-000000000000" UsersBucket = "users" ArchiveState = "_archive" )
Variables ¶
View Source
var ( PropDisplay = []string{ "autocomplete", "textInput", "numberInput", "floatInput", "textArea", "searchBox", "select", "datePicker", "timePicker", "dateTimePicker", "colorPicker", "filePicker", "commentsEditor", "masked", "checkbox", "checkList", "password", "headerInput", "text", "code", "codeEditor", "link", "dataTable", "html", "react", "none", "", } ObjectDisplay = []string{ "none", "table", "grid", "list", "html", "single", "", } ActionType = []string{ "script", "form", "", } DB = bdb.DB{} )
View Source
var ( // ErrInvalidTTLFormat represents ttl format error ErrInvalidTTLFormat = errors.New("invalid ttl in config") )
Functions ¶
func JWTExtraProps ¶ added in v0.0.59
func JWTExtraProps() []string
JWTExtraProps returns jwtExtraProps section from commonConfig
func ReloadConfig ¶
Types ¶
type Access ¶
type Access struct {
Condition interface{} `json:"condition"`
Permissions string `json:"permissions"` // Права на доступ ГРУППА|ВЛАДЕЛЕЦ (crud|rud в любом сочетании), если для группы стоит знак "-", то прав на стору нет вообще. Перед каждой буквой тоже может стоять "-".
Role string `json:"role"` // Роль, для которой определяется доступ
}
Access definition
type Action ¶
type Action struct {
ClassName string `json:"className,omitempty"` // CSS class
ClientPostScript string `json:"clientPostScript,omitempty"` // JavaScript scenario that will run in browser after server response
ClientPreScript string `json:"clientPreScript,omitempty"` // JavaScript scenario that will run in browser before request to server
ConcurentCallsLimit int `json:"concurentCallsLimit,omitempty"` // Max concurrent calls of action
Disabled interface{} `json:"disabled,omitempty"` // Disabled conditions, JavaScript expression
DisableItemReadyCheck bool `json:"disableItemReadyCheck"` // Enables action on modified item
DynamicLabel bool `json:"dynamicLabel,omitempty"` // If true, action lable renders on every item or user change
Hidden interface{} `json:"hidden,omitempty"` // Hidden conditions, JavaScript expression
HideInHeader bool `json:"hideInHeader"` // Hides action in item header
Icon string `json:"icon" ws:"yes"` // Icon for label
ID string `json:"_id"`
Label string `json:"label" ws:"yes"` // Text for label, HandleBars template
Multi bool `json:"multi"` // Enables action for multiple items !!!NOT IMPLEMENTED!!!
Script string `json:"script,omitempty"` // Action JavaScript scenario
ShowInList bool `json:"showInList"` // Show action in items in list view
Type string `json:"type,omitempty"`
//Access
Access []Access `json:"access,omitempty"` // Action access rules.
GroupAccess string `json:"groupAccess"` // Calculated access, not used in config
OwnerAccess string `json:"ownerAccess"` // Calculated access, not used in config
//Actions with type=form
CancelLabel string `json:"cancelLabel,omitempty"` // Text in form cancel button, HandleBars template
FormLabel string `json:"formLabel,omitempty" ws:"yes"` // Text form header, HandleBars template
OkLabel string `json:"okLabel,omitempty"` // Text in form submit button, HandleBars template
Props map[string]Prop `json:"props" ws:"yes"` // Form properties
}
Action – struct for JavaScript scenarios that can be performed by users
type DataSource ¶ added in v0.0.77
type DataSource struct {
Type string `json:"type,omitempty"` // Type of custom data source. Only "file" is supported now
File string `json:"file,omitempty"` // JS module to require for Type == "file"
}
DataSource is a description of custom data source for store
type Filter ¶
type Filter struct {
Display string `json:"display" ws:"yes"` // textInput, searchBox, select, masked
FilterBy string `json:"filterBy,omitempty"` // display:searchBox Имя сторы для поля типа ref
FormOrder int `json:"formOrder,omitempty"` // Порядок отображения на форме
Label string `json:"label,omitempty" ws:"yes"` // Вариации названий в браузере
Mask string `json:"mask,omitempty" ws:"yes"` // display:masked Применимо только для строк
Multi bool `json:"multi" ws:"yes"` // display:searchBox Возможность выбора нескольких элементов
Options []Value `json:"options,omitempty"` // display:select Перечень для селектов и прочего // TODO: валидация
Placeholder string `json:"placeholder,omitempty" ws:"yes"` // Применимо для display:textInput
Query interface{} `json:"query,omitempty"` // Запрос для монги
SearchBy []string `json:"searchBy,omitempty"` // display:searchBox Поля для поиска для элемента searchBox // TODO: сделать валидацию
Store string `json:"store,omitempty"` // display:searchBox Имя сторы
Style bdb.M `json:"style,omitempty" ws:"yes"` // CSS
Type string `json:"type,omitempty" ws:"yes"` // Тип поля фильтра
}
Filter definition
type HTTPHook ¶ added in v0.0.61
type HTTPHook struct {
ConcurentCallsLimit int `json:"concurentCallsLimit,omitempty"` // Max concurrent calls of http hook
Method string `json:"method"` // HTTP method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS)
Script string `json:"script"` // Javascript code of hook
URI string `json:"uri"` // URI, по которому будет доступен хук. Например, если uri=users, то хук будет http://server-address/hooks/users
}
HTTPHook definition
type Hooks ¶
type Hooks struct {
WillCreate string `json:"willCreate,omitempty"` // Вызывается перед сохранением нового объекта/сторы
DidCreate string `json:"didCreate,omitempty"` // Вызывается после сохранения нового объекта/сторы
WillSave string `json:"willSave,omitempty"` // Вызывается перед сохранением существующего объекта/сторы
DidSave string `json:"didSave,omitempty"` // Вызывается после сохранения существующего объекта/сторы
WillRemove string `json:"willRemove,omitempty"` // Вызывается перед удалением объекта/сторы
DidRemove string `json:"didRemove,omitempty"` // Вызывается после удаления объекта/сторы
DidRead string `json:"didRead,omitempty"` // Вызывается при запрашивании конкретного объекта из сторы. Для сторы не применимо
DidStart string `json:"didStart,omitempty"` // Вызывается после старта хранилища
Migration []*MigrationTask `json:"migration,omitempty"` // Скрипты миграции
}
Hooks contains JavaScript hooks
type Label ¶
type Label struct {
Text string `json:"text,omitempty" ws:"yes"` // Текст лейблы
Icon string `json:"icon,omitempty" ws:"yes"` // Иконка слева от текста (только CSS класс)
ShowInList int `json:"showInList,omitempty" ws:"yes"` // Порядок отображения в списке. Если 0, не отображать
HideInForm bool `json:"hideInForm,omitempty" ws:"yes"` // Не показывать на основой форме
Color string `json:"color,omitempty" ws:"yes"` // Цвет рамочки на форме и цвет текста в списке
TextColor string `json:"textColor,omitempty" ws:"yes"` // Цвет текста в чипсе
Hidden string `json:"hidden,omitempty"` // Hidden conditions, JavaScript expression
Display string `json:"display,omitempty" ws:"yes"` // Type of label, can be "text" (default), "chip" or "react"
LoadComponent string `json:"loadComponent,omitempty" ws:"yes"` // React component, only for display === "react"
Style map[string]interface{} `json:"style,omitempty"` // extra style for label
NoSanitize bool `json:"noSanitize,omitempty"` // for safe html in template
}
Label definition
type MigrationTask ¶ added in v0.0.74
MigrationTask describes scheme migration scripts
type Prop ¶
type Prop struct {
Accept string `json:"accept,omitempty" ws:"yes"` // Применимо только для файлов
Access []Access `json:"access,omitempty"` // Разрешения для работы с полем
Actions interface{} `json:"actions,omitempty" ws:"yes"` // Action identifier or array of identifiers
AddLabel string `json:"addLabel,omitempty" ws:"yes"` // Применимо только для ObjectList
ClassName string `json:"сlassName,omitempty"` // CSS класс для контейнера на форме
Configurable bool `json:"configurable,omitempty"` // Только для объекта _default. Если true, то админ может переопределить настроки поля
Default interface{} `json:"default,omitempty" ws:"yes"` // Значение по умолчанию
DisableCustomInput bool `json:"disableCustomInput,omitempty" ws:"yes"` // Запрет ручного ввода данных для некоторых типов отображения
Disabled interface{} `json:"disabled,omitempty" ws:"yes"` // Disabled conditions, JavaScript expression
DisableOrder bool `json:"disableOrder,omitempty" ws:"yes"` // Запрет сортировки по полю
DisableRefSync bool `json:"disableRefSync,omitempty"` // Флаг, запрещающий обновление соответствующего ref поля в противоположной сторе
Display string `json:"display" ws:"yes"` // text, textArea, datePicker, timePicker, dateTimePicker, masked, none
DisplayWidth int `json:"displayWidth,omitempty" ws:"yes"` // Ширина инпута в процентах для вложенных объектов с шагом в 5
ExtraQuery interface{} `json:"extraQuery,omitempty"` // Доп Запрос для монги
ForeignKey string `json:"foreignKey,omitempty"` // Имя пропы в референсной сторе для поля типа virtualRefList
Format string `json:"format,omitempty" ws:"yes"` // Формат отображения. Только для типа date
FormGroup string `json:"formGroup,omitempty" ws:"yes"` // Определяет группу на форме, в которой будет отрисовано поле
FormOrder int `json:"formOrder" ws:"yes"` // Определяет порядок отрисовки на форме. Если поле в группе, определяет порядок отрисовки именно в этой группе.
FormTab string `json:"formTab,omitempty" ws:"yes"` // Определяет страницу на форме, в которой будет отрисовано поле
GroupAccess string `json:"groupAccess"` // Разрешения для работы с полем в виде вычисленной для конкретного юзера строки (crud)
Hidden interface{} `json:"hidden,omitempty" ws:"yes"` // Hidden conditions, JavaScript expression
HTML string `json:"html,omitempty" ws:"yes"` // Html for display=html
HTMLFile string `json:"htmlFile,omitempty" ws:"yes"` // Файл с шаблоном Html for display=html
Label string `json:"label,omitempty" ws:"yes"` // Вариации названий в браузере
LabelClassName string `json:"labelClassName,omitempty"` // CSS класс для лейбла
Load string `json:"load,omitempty"` // Функция на JS, применима к типу virtual
LoadComponent string `json:"loadComponent,omitempty"` // Функция на JS для display==='react'
Mask interface{} `json:"mask,omitempty" ws:"yes"` // Применимо только для строк
Max interface{} `json:"max,omitempty"` // Применимо только для числовых типов
MaxLength int `json:"maxLength,omitempty" ws:"yes"` // Применимо только для строк
Min interface{} `json:"min,omitempty"` // Применимо только для числовых типов
MinLength int `json:"minLength,omitempty" ws:"yes"` // Применимо только для строк
Name string `json:"name"` // Название проперти
NoSanitize bool `json:"noSanitize,omitempty"` // Флаг указывающий на то, что html безопасный в пропе.
NoAutoTrim bool `json:"noAutoTrim"` // Только для type:string, не удалять автоматически пробелоподобные символы с начала и в конце строки
OppositeProp string `json:"oppositeProp,omitempty"` // Для type = ref, соответствующая поле в противоположной сторе
Options []interface{} `json:"options,omitempty"` // Перечень для селектов и прочего // TODO: валидация
OwnerAccess string `json:"ownerAccess"` // Разрешения для работы с полем в виде вычисленной для конкретного владельца строки (crud)
Pattern interface{} `json:"pattern,omitempty" ws:"yes"` // Применимо только для строк
PatternError string `json:"patternError,omitempty" ws:"yes"` // Применимо только для строк. Ошибка которая отобразится, если введенное значение не соответствует паттерну
Placeholder string `json:"placeholder,omitempty" ws:"yes"` // Применимо для строк и числовых типов
PopulateIn interface{} `json:"populateIn,omitempty"` // Куда складывать популизованные данные. Если значения нет, то популяция не требуется
Props map[string]Prop `json:"props,omitempty" ws:"yes"` // Перечень свойств вложенного объекта
Query interface{} `json:"query,omitempty"` // Запрос для монги
ReadOnly bool `json:"readOnly,omitempty"` // Поле только для чтения
Required interface{} `json:"required,omitempty" ws:"yes"` // Поле является обязательным
SearchBy []string `json:"searchBy,omitempty"` // Поля для поиска для элемента searchBox // TODO: сделать валидацию
SelectedTemplate string `json:"selectedTemplate,omitempty"` // Шаблон выбранного элемента для searchBox
Sortable bool `json:"sortable,omitempty" ws:"yes"` // Применимо только для ObjectList, перетаскивание
SortBy string `json:"sortBy,omitempty"` // Поля для сортировки, если пропа virtual // TODO: сделать валидацию
Store string `json:"store,omitempty"` // Имя сторы для поля типа ref
Style bdb.M `json:"style,omitempty" ws:"yes"` // Внезапно: пока не определим нужный набор свойств отображения, прокину как я CSS
TableColumns []interface{} `json:"tableColumns,omitempty" ws:"yes"` // Применимо только для VirtualRefList
TableLink bool `json:"tableLink,omitempty" ws:"yes"` // Флаг обозначающий, что эта пропертя в таблице будет ссылкой
Tooltip string `json:"tooltip,omitempty" ws:"yes"` // Тултип в формате markdown
Type string `json:"type"` // Допустимые варианты: int, float, bool, string, date, ref, virtual
Utc bool `json:"utc,omitempty" ws:"yes"` // Работа с датами в utc - игнорирует локальное время. Только для типа date
WidgetID string `json:"widgetId,omitempty" ws:"yes"` // Widget identifier
Widgets interface{} `json:"widgets,omitempty" ws:"yes"` // Widget identifier or array of identifiers
}
Prop definition
type State ¶
type State struct {
Label string `json:"label" ws:"yes"` // Будут ещё поля?
}
State definition
type Store ¶
type Store struct {
Access []Access `json:"access,omitempty"` // Разрешения для работы с объектом. Если не заполнено, то доступ разрешён всем
Actions []Action `json:"actions,omitempty"` // Перечень действий над объектом
BaseStore string `json:"baseStore,omitempty"` // Только для Type == 'proxy'. Содержит стору на которую производится проксирование.
Config map[string]Store `json:"config,omitempty"` // Конфиг, переопределяющий некоторые параметры. Только для type:workspace
DataSource *DataSource `json:"dataSource,omitempty"` // Custom data source description for store
DisableAutoSelect bool `json:"disableAutoSelect,omitempty" ws:"yes"` // Только для display:listView
DisablePartialLoad bool `json:"disablePartialLoad,omitempty" ws:"yes"` // TODO: Если true, то выдавать при запросе всех объектов, все поля сразу.
Display string `json:"display" ws:"yes"` // Вид отображения
Entries map[string]interface{} `json:"entries,omitempty"` // Значения для type == 'map'
Filters map[string]Filter `json:"filters" ws:"yes"` // Перечень фильтров сторы
FormGroups []string `json:"formGroups,omitempty" ws:"yes"` // Порядок групп свойств на форме по-умолчанию
FormTabs []interface{} `json:"formTabs" ws:"yes"` // Описание и порядок страниц на форме
FullWidth bool `json:"fullWidth,omitempty" ws:"yes"` // Параметр отображения контента во всю ширину, когда не используется боковая панель.
GroupAccess string `json:"groupAccess"` // Разрешения для работы с объектом в виде вычисленной для конкретного юзера строки (crud)
HasVirtualProps bool `json:"hasVirtualProps,omitempty"` // Флаг указывающий наличие виртуальных полей в сторе
HeaderProperty string `json:"headerProperty,omitempty"` // property для отображения заголовка выбранного элемента
HeaderTemplate string `json:"headerTemplate,omitempty"` // Шаблон {{}} для отображения заголовка выбранного элемента
HideHeader bool `json:"hideHeader,omitempty"` // Флаг указывающий на запрет отображения заголовка сторы. Только для display:react и display:html
HTML string `json:"html" ws:"yes"` // Шаблон для display:html
HTTPApi bool `json:"httpApi,omitempty"` // Флаг формирования HTTP REST API для сторы
HTTPHooks []HTTPHook `json:"httpHooks,omitempty"` // Http хуки (HTTP API).
I18n map[string]interface{} `json:"i18n" ws:"yes"` // Вариации названий в браузере
Icon string `json:"icon,omitempty"` // Иконка для отображения в меню и в центре уведомлений
Indexes []interface{} `json:"indexes,omitempty"` // MongoDB indexes
Label string `json:"label,omitempty"` // Заголовок сторы
Labels []Label `json:"labels,omitempty"` // Лейблы
ListViewOnly bool `json:"listViewOnly,omitempty" ws:"yes"` // Параметр, определяющий отображение сторы.
LoadComponent string `json:"loadComponent,omitempty"` // Код компонента React для загрузки. Только для display:react.
Logging bool `json:"logging,omitempty"` // Флаг указывающий на необходимость ведения журнала действий
ObjectLifeCycle Hooks `json:"objectLifeCycle,omitempty"` // Хуки на события жизненного цикла объекта
OrderBy string `json:"orderBy,omitempty" ws:"yes"` // Сортировка данных по умолчанию.
OwnerAccess string `json:"ownerAccess"` // Разрешения для работы с объектом в виде вычисленной для конкретного владельца строки (crud)
PrepareItemsScript string `json:"prepareItemsScript,omitempty"` // Скрипт для подготовки данных до передачи в рендер свойства html
Props map[string]Prop `json:"props" ws:"yes"` // Перечень свойств объекта
ShowFilters bool `json:"showFilters,omitempty"` // Открывать фильтры сторы по-умолчанию
States map[string]State `json:"states,omitempty"` // Только для типа "process". Список возможных состояний
Store string `json:"store"` // Имя сторы для хранения. Берётся из ключа мапы
StoreActions []Action `json:"storeActions,omitempty"` // Перечень действий при поступлении внешних событий
StoreLifeCycle Hooks `json:"storeLifeCycle,omitempty"` // Хуки на события жизненного цикла сторы
TableColumns []interface{} `json:"tableColumns,omitempty" ws:"yes"` // Только для display:dataTable
Tasks []*Task `json:"tasks,omitempty"` // Периодические задачи для сторы
Template string `json:"template,omitempty"` // Шаблон для передачи в свойство html
TemplateFile string `json:"templateFile,omitempty"` // Фвйл с шаблоном для передачи в свойство html
Type string `json:"type"` // Допустимые пока варианты: directory (простые справочники), process (справочники с состояниями и действиями над объектами), workspace (воркспейсы), inConfigSet (набор каких-то значений)
Version int `json:"version"` // Версия схемы для проведения миграций
Widgets []Widget `json:"widgets,omitempty"` // Виджеты, используются для display:dashboard и property.type:widget
}
Store definition
func (*Store) LoadDefaultIntoProp ¶
type Task ¶
type Task struct {
AllowConcurrent bool `json:"allowConcurrent,omitempty"`
Schedule string `json:"schedule"`
Script string `json:"script"`
}
Task definition
type Value ¶
type Value struct {
Value interface{} `json:"value"` // Значение, которое будет присвоено полю
Label string `json:"label"` // Лейбла, которая отображается в браузере, или будет переведена для отображения
}
Value definition
type Widget ¶
type Widget struct {
ID string `json:"_id"`
Type string `json:"type,omitempty"`
Label string `json:"label" ws:"yes"` // Лейбла в браузере
Load string `json:"load" ws:"yes"` // Серверный скрипт подготовки данных
Render string `json:"render,omitempty"` // Скрипт на JS для отрисовки
DidLoadData string `json:"didLoadData,omitempty"` // Скрипт, выполняемый в браузере после загрузки данных
Access []Access `json:"access,omitempty"` // Разрешения для работы с виджетом. Если не заполнено, то доступ разрешён всем
GroupAccess string `json:"groupAccess"` // Разрешения для работы с виджетом в виде вычисленной для конкретного юзера строки (crud)
OwnerAccess string `json:"ownerAccess"` // Разрешения для работы с виджетом в виде вычисленной для конкретного владельца строки (crud)
ClassName string `json:"className,omitempty"` // CSS class, который требуется навесить на кнопку
Style bdb.M `json:"style,omitempty" ws:"yes"` // Дополнительные CSS виджета
Columns []interface{} `json:"columns,omitempty"` // Columns description for widget
}
Widget definition
Source Files
Click to show internal directories.
Click to hide internal directories.