@protobase/schema
Resources, fields, views and access rules: what a Protobase config declares, and the models the server, the client and
the admin app read from it. A config builds them with resource and f (Data config),
view and l (UI config), and defineRoles and rule
(Access). It runs anywhere, the browser included, and imports no other
@protobase package.
Interfaces
Section titled “Interfaces”Type Aliases
Section titled “Type Aliases”- Access
- AccessAction
- AccessContext
- AccessFn
- AccessResult
- AccessSource
- AccessUser
- ActionInputKind
- ActionInputModel
- ActionModel
- ActionRun
- AnyField
- AppAddress
- AssistantAction
- AssistantActionRequest
- AssistantCardPart
- AssistantDiff
- AssistantEvent
- AssistantMessage
- AssistantMessageRequest
- AssistantPart
- AssistantState
- AssistantStep
- AssistantStepState
- AssistantTablePart
- AssistantTextPart
- AssistantTone
- AssistantWidgetPart
- BadgeShape
- BottomBarItemModel
- BottomBarModel
- BottomBarNames
- BottomBarSource
- CalendarView
- Capability
- CapabilityAction
- CapabilityLimit
- CapabilityScope
- CardFavoriteModel
- CardPhotosModel
- ChartGranularity
- ChartInput
- ChartModel
- ChartRange
- CheckedFilter
- CheckResult
- CommentsSectionModel
- CompareOp
- ComponentRef
- Constraint
- CreatedOptions
- CreateModel
- CustomSectionModel
- DatePreset
- DeletedOptions
- DurationLiteral
- DurationUnit
- EvaluateOptions
- EventActor
- EventContext
- EventHelpers
- EventMatch
- EventModel
- EventOperation
- EventSpec
- ExportModel
- FieldAccess
- FieldFormat
- FieldMeta
- FieldModel
- FieldPath
- FieldRefs
- FieldRefValue
- FieldRule
- FieldsInput
- FieldType
- FieldTypeDef
- FieldViewModel
- FieldViews
- FieldWidgetModel
- FileFieldModel
- FileOptions
- FileProcessor
- FileProcessorInput
- FilterError
- FilterErrorCode
- FilterExpr
- FilterLayout
- FilterLimits
- FilterOf
- FilterParse
- FilterValue
- FilterWidgetModel
- FormAddress
- FormInput
- FormModel
- GalleryModel
- Grant
- GroupChartInput
- GroupChartModel
- GroupItemModel
- GroupModel
- HeldCapability
- HelpWhen
- HistorySectionModel
- ImageFormat
- ImageVariant
- ImageVariantOptions
- InferRecord
- Issue
- JsonValue
- KeyOf
- KeyRefs
- KeyType
- KeyValue
- LayoutItemModel
- ListColumn
- ListDisplayModel
- ListModel
- ListQuery
- Literal
- MapSectionModel
- MapView
- NamedListModel
- NavModel
- NavRecentModel
- NowValue
- OrderByCheck
- OrderByItem
- OrderByParse
- PeriodChartInput
- PeriodChartModel
- RecordKey
- RecordMode
- RecordOf
- RecordWhen
- Ref
- Refs
- RelatedColumnModel
- RelatedModel
- ResolvedAccess
- ResolveOptions
- ResourceModel
- RoleEntry
- RoleLimit
- Roles
- RolesOptions
- RowFilterOperation
- Rule
- SaveFeedback
- SaveSearchModel
- SearchesOfModel
- SearchMatch
- SearchRef
- SearchRefs
- SearchResultModel
- SectionModel
- SectionPresentation
- ShowWhen
- SignInAddress
- SignInPromptModel
- SignInStep
- SignInViewModel
- SortSpec
- Span
- StatusTone
- UndeletedOptions
- UpdatedOptions
- UserMenuItemModel
- UserMenuModel
- UserMenuSource
- Validator
- ViewModel
- ViewProps
Variables
Section titled “Variables”- addressWords
- anonymousRole
- f
- formRoute
- imageFormats
- l
- maxBottomBarItems
- signInParams
- signInRoute
- signInSteps
- where
Functions
Section titled “Functions”- accessWarnings
- appPath
- bottomBar
- bottomBarErrors
- checkFilter
- checkOrderBy
- checkRecord
- createWhere
- defineRoles
- enumLabel
- evaluateFilter
- fieldRef
- fieldsUsedBy
- fitsKeyType
- formPath
- isRecordCondition
- keyTypes
- parseFilter
- parseOrderBy
- pickView
- printFilter
- printOrderBy
- readAppPath
- readFormAddress
- readSignInAddress
- resolveAccess
- resource
- restrictModel
- rule
- signInPath
- userMenu
- view