Versions in this module Expand all Collapse all v1 v1.0.0 Jul 10, 2022 Changes in this version + const EmailPlaceholderAppUrl + const EmailPlaceholderToken + type AdminAuthEvent struct + Admin *models.Admin + HttpContext echo.Context + Token string + type AdminCreateEvent struct + Admin *models.Admin + HttpContext echo.Context + type AdminDeleteEvent struct + Admin *models.Admin + HttpContext echo.Context + type AdminUpdateEvent struct + Admin *models.Admin + HttpContext echo.Context + type AdminViewEvent struct + Admin *models.Admin + HttpContext echo.Context + type AdminsListEvent struct + Admins []*models.Admin + HttpContext echo.Context + Result *search.Result + type App interface + Bootstrap func() error + Cache func() *store.Store[any] + DB func() *dbx.DB + Dao func() *daos.Dao + DataDir func() string + EncryptionEnv func() string + IsDebug func() bool + LogsDB func() *dbx.DB + LogsDao func() *daos.Dao + NewFilesystem func() (*filesystem.System, error) + NewMailClient func() mailer.Mailer + OnAdminAfterCreateRequest func() *hook.Hook[*AdminCreateEvent] + OnAdminAfterDeleteRequest func() *hook.Hook[*AdminDeleteEvent] + OnAdminAfterUpdateRequest func() *hook.Hook[*AdminUpdateEvent] + OnAdminAuthRequest func() *hook.Hook[*AdminAuthEvent] + OnAdminBeforeCreateRequest func() *hook.Hook[*AdminCreateEvent] + OnAdminBeforeDeleteRequest func() *hook.Hook[*AdminDeleteEvent] + OnAdminBeforeUpdateRequest func() *hook.Hook[*AdminUpdateEvent] + OnAdminViewRequest func() *hook.Hook[*AdminViewEvent] + OnAdminsListRequest func() *hook.Hook[*AdminsListEvent] + OnBeforeServe func() *hook.Hook[*ServeEvent] + OnCollectionAfterCreateRequest func() *hook.Hook[*CollectionCreateEvent] + OnCollectionAfterDeleteRequest func() *hook.Hook[*CollectionDeleteEvent] + OnCollectionAfterUpdateRequest func() *hook.Hook[*CollectionUpdateEvent] + OnCollectionBeforeCreateRequest func() *hook.Hook[*CollectionCreateEvent] + OnCollectionBeforeDeleteRequest func() *hook.Hook[*CollectionDeleteEvent] + OnCollectionBeforeUpdateRequest func() *hook.Hook[*CollectionUpdateEvent] + OnCollectionViewRequest func() *hook.Hook[*CollectionViewEvent] + OnCollectionsListRequest func() *hook.Hook[*CollectionsListEvent] + OnFileDownloadRequest func() *hook.Hook[*FileDownloadEvent] + OnMailerAfterAdminResetPasswordSend func() *hook.Hook[*MailerAdminEvent] + OnMailerAfterUserChangeEmailSend func() *hook.Hook[*MailerUserEvent] + OnMailerAfterUserResetPasswordSend func() *hook.Hook[*MailerUserEvent] + OnMailerAfterUserVerificationSend func() *hook.Hook[*MailerUserEvent] + OnMailerBeforeAdminResetPasswordSend func() *hook.Hook[*MailerAdminEvent] + OnMailerBeforeUserChangeEmailSend func() *hook.Hook[*MailerUserEvent] + OnMailerBeforeUserResetPasswordSend func() *hook.Hook[*MailerUserEvent] + OnMailerBeforeUserVerificationSend func() *hook.Hook[*MailerUserEvent] + OnModelAfterCreate func() *hook.Hook[*ModelEvent] + OnModelAfterDelete func() *hook.Hook[*ModelEvent] + OnModelAfterUpdate func() *hook.Hook[*ModelEvent] + OnModelBeforeCreate func() *hook.Hook[*ModelEvent] + OnModelBeforeDelete func() *hook.Hook[*ModelEvent] + OnModelBeforeUpdate func() *hook.Hook[*ModelEvent] + OnRealtimeAfterSubscribeRequest func() *hook.Hook[*RealtimeSubscribeEvent] + OnRealtimeBeforeSubscribeRequest func() *hook.Hook[*RealtimeSubscribeEvent] + OnRealtimeConnectRequest func() *hook.Hook[*RealtimeConnectEvent] + OnRecordAfterCreateRequest func() *hook.Hook[*RecordCreateEvent] + OnRecordAfterDeleteRequest func() *hook.Hook[*RecordDeleteEvent] + OnRecordAfterUpdateRequest func() *hook.Hook[*RecordUpdateEvent] + OnRecordBeforeCreateRequest func() *hook.Hook[*RecordCreateEvent] + OnRecordBeforeDeleteRequest func() *hook.Hook[*RecordDeleteEvent] + OnRecordBeforeUpdateRequest func() *hook.Hook[*RecordUpdateEvent] + OnRecordViewRequest func() *hook.Hook[*RecordViewEvent] + OnRecordsListRequest func() *hook.Hook[*RecordsListEvent] + OnSettingsAfterUpdateRequest func() *hook.Hook[*SettingsUpdateEvent] + OnSettingsBeforeUpdateRequest func() *hook.Hook[*SettingsUpdateEvent] + OnSettingsListRequest func() *hook.Hook[*SettingsListEvent] + OnUserAfterCreateRequest func() *hook.Hook[*UserCreateEvent] + OnUserAfterDeleteRequest func() *hook.Hook[*UserDeleteEvent] + OnUserAfterOauth2Register func() *hook.Hook[*UserOauth2RegisterEvent] + OnUserAfterUpdateRequest func() *hook.Hook[*UserUpdateEvent] + OnUserAuthRequest func() *hook.Hook[*UserAuthEvent] + OnUserBeforeCreateRequest func() *hook.Hook[*UserCreateEvent] + OnUserBeforeDeleteRequest func() *hook.Hook[*UserDeleteEvent] + OnUserBeforeOauth2Register func() *hook.Hook[*UserOauth2RegisterEvent] + OnUserBeforeUpdateRequest func() *hook.Hook[*UserUpdateEvent] + OnUserViewRequest func() *hook.Hook[*UserViewEvent] + OnUsersListRequest func() *hook.Hook[*UsersListEvent] + RefreshSettings func() error + ResetBootstrapState func() error + Settings func() *Settings + SubscriptionsBroker func() *subscriptions.Broker + type AuthProviderConfig struct + AllowRegistrations bool + AuthUrl string + ClientId string + ClientSecret string + Enabled bool + TokenUrl string + UserApiUrl string + func (c AuthProviderConfig) SetupProvider(provider auth.Provider) error + func (c AuthProviderConfig) Validate() error + type BaseApp struct + func NewBaseApp(dataDir string, encryptionEnv string, isDebug bool) *BaseApp + func (app *BaseApp) Bootstrap() error + func (app *BaseApp) Cache() *store.Store[any] + func (app *BaseApp) DB() *dbx.DB + func (app *BaseApp) Dao() *daos.Dao + func (app *BaseApp) DataDir() string + func (app *BaseApp) EncryptionEnv() string + func (app *BaseApp) IsDebug() bool + func (app *BaseApp) LogsDB() *dbx.DB + func (app *BaseApp) LogsDao() *daos.Dao + func (app *BaseApp) NewFilesystem() (*filesystem.System, error) + func (app *BaseApp) NewMailClient() mailer.Mailer + func (app *BaseApp) OnAdminAfterCreateRequest() *hook.Hook[*AdminCreateEvent] + func (app *BaseApp) OnAdminAfterDeleteRequest() *hook.Hook[*AdminDeleteEvent] + func (app *BaseApp) OnAdminAfterUpdateRequest() *hook.Hook[*AdminUpdateEvent] + func (app *BaseApp) OnAdminAuthRequest() *hook.Hook[*AdminAuthEvent] + func (app *BaseApp) OnAdminBeforeCreateRequest() *hook.Hook[*AdminCreateEvent] + func (app *BaseApp) OnAdminBeforeDeleteRequest() *hook.Hook[*AdminDeleteEvent] + func (app *BaseApp) OnAdminBeforeUpdateRequest() *hook.Hook[*AdminUpdateEvent] + func (app *BaseApp) OnAdminViewRequest() *hook.Hook[*AdminViewEvent] + func (app *BaseApp) OnAdminsListRequest() *hook.Hook[*AdminsListEvent] + func (app *BaseApp) OnBeforeServe() *hook.Hook[*ServeEvent] + func (app *BaseApp) OnCollectionAfterCreateRequest() *hook.Hook[*CollectionCreateEvent] + func (app *BaseApp) OnCollectionAfterDeleteRequest() *hook.Hook[*CollectionDeleteEvent] + func (app *BaseApp) OnCollectionAfterUpdateRequest() *hook.Hook[*CollectionUpdateEvent] + func (app *BaseApp) OnCollectionBeforeCreateRequest() *hook.Hook[*CollectionCreateEvent] + func (app *BaseApp) OnCollectionBeforeDeleteRequest() *hook.Hook[*CollectionDeleteEvent] + func (app *BaseApp) OnCollectionBeforeUpdateRequest() *hook.Hook[*CollectionUpdateEvent] + func (app *BaseApp) OnCollectionViewRequest() *hook.Hook[*CollectionViewEvent] + func (app *BaseApp) OnCollectionsListRequest() *hook.Hook[*CollectionsListEvent] + func (app *BaseApp) OnFileDownloadRequest() *hook.Hook[*FileDownloadEvent] + func (app *BaseApp) OnMailerAfterAdminResetPasswordSend() *hook.Hook[*MailerAdminEvent] + func (app *BaseApp) OnMailerAfterUserChangeEmailSend() *hook.Hook[*MailerUserEvent] + func (app *BaseApp) OnMailerAfterUserResetPasswordSend() *hook.Hook[*MailerUserEvent] + func (app *BaseApp) OnMailerAfterUserVerificationSend() *hook.Hook[*MailerUserEvent] + func (app *BaseApp) OnMailerBeforeAdminResetPasswordSend() *hook.Hook[*MailerAdminEvent] + func (app *BaseApp) OnMailerBeforeUserChangeEmailSend() *hook.Hook[*MailerUserEvent] + func (app *BaseApp) OnMailerBeforeUserResetPasswordSend() *hook.Hook[*MailerUserEvent] + func (app *BaseApp) OnMailerBeforeUserVerificationSend() *hook.Hook[*MailerUserEvent] + func (app *BaseApp) OnModelAfterCreate() *hook.Hook[*ModelEvent] + func (app *BaseApp) OnModelAfterDelete() *hook.Hook[*ModelEvent] + func (app *BaseApp) OnModelAfterUpdate() *hook.Hook[*ModelEvent] + func (app *BaseApp) OnModelBeforeCreate() *hook.Hook[*ModelEvent] + func (app *BaseApp) OnModelBeforeDelete() *hook.Hook[*ModelEvent] + func (app *BaseApp) OnModelBeforeUpdate() *hook.Hook[*ModelEvent] + func (app *BaseApp) OnRealtimeAfterSubscribeRequest() *hook.Hook[*RealtimeSubscribeEvent] + func (app *BaseApp) OnRealtimeBeforeSubscribeRequest() *hook.Hook[*RealtimeSubscribeEvent] + func (app *BaseApp) OnRealtimeConnectRequest() *hook.Hook[*RealtimeConnectEvent] + func (app *BaseApp) OnRecordAfterCreateRequest() *hook.Hook[*RecordCreateEvent] + func (app *BaseApp) OnRecordAfterDeleteRequest() *hook.Hook[*RecordDeleteEvent] + func (app *BaseApp) OnRecordAfterUpdateRequest() *hook.Hook[*RecordUpdateEvent] + func (app *BaseApp) OnRecordBeforeCreateRequest() *hook.Hook[*RecordCreateEvent] + func (app *BaseApp) OnRecordBeforeDeleteRequest() *hook.Hook[*RecordDeleteEvent] + func (app *BaseApp) OnRecordBeforeUpdateRequest() *hook.Hook[*RecordUpdateEvent] + func (app *BaseApp) OnRecordViewRequest() *hook.Hook[*RecordViewEvent] + func (app *BaseApp) OnRecordsListRequest() *hook.Hook[*RecordsListEvent] + func (app *BaseApp) OnSettingsAfterUpdateRequest() *hook.Hook[*SettingsUpdateEvent] + func (app *BaseApp) OnSettingsBeforeUpdateRequest() *hook.Hook[*SettingsUpdateEvent] + func (app *BaseApp) OnSettingsListRequest() *hook.Hook[*SettingsListEvent] + func (app *BaseApp) OnUserAfterCreateRequest() *hook.Hook[*UserCreateEvent] + func (app *BaseApp) OnUserAfterDeleteRequest() *hook.Hook[*UserDeleteEvent] + func (app *BaseApp) OnUserAfterOauth2Register() *hook.Hook[*UserOauth2RegisterEvent] + func (app *BaseApp) OnUserAfterUpdateRequest() *hook.Hook[*UserUpdateEvent] + func (app *BaseApp) OnUserAuthRequest() *hook.Hook[*UserAuthEvent] + func (app *BaseApp) OnUserBeforeCreateRequest() *hook.Hook[*UserCreateEvent] + func (app *BaseApp) OnUserBeforeDeleteRequest() *hook.Hook[*UserDeleteEvent] + func (app *BaseApp) OnUserBeforeOauth2Register() *hook.Hook[*UserOauth2RegisterEvent] + func (app *BaseApp) OnUserBeforeUpdateRequest() *hook.Hook[*UserUpdateEvent] + func (app *BaseApp) OnUserViewRequest() *hook.Hook[*UserViewEvent] + func (app *BaseApp) OnUsersListRequest() *hook.Hook[*UsersListEvent] + func (app *BaseApp) RefreshSettings() error + func (app *BaseApp) ResetBootstrapState() error + func (app *BaseApp) Settings() *Settings + func (app *BaseApp) SubscriptionsBroker() *subscriptions.Broker + type CollectionCreateEvent struct + Collection *models.Collection + HttpContext echo.Context + type CollectionDeleteEvent struct + Collection *models.Collection + HttpContext echo.Context + type CollectionUpdateEvent struct + Collection *models.Collection + HttpContext echo.Context + type CollectionViewEvent struct + Collection *models.Collection + HttpContext echo.Context + type CollectionsListEvent struct + Collections []*models.Collection + HttpContext echo.Context + Result *search.Result + type EmailAuthConfig struct + Enabled bool + ExceptDomains []string + MinPasswordLength int + OnlyDomains []string + func (c EmailAuthConfig) Validate() error + type FileDownloadEvent struct + Collection *models.Collection + FileField *schema.SchemaField + HttpContext echo.Context + Record *models.Record + ServedName string + ServedPath string + type LogsConfig struct + MaxDays int + func (c LogsConfig) Validate() error + type MailerAdminEvent struct + Admin *models.Admin + MailClient mailer.Mailer + Meta map[string]any + type MailerUserEvent struct + MailClient mailer.Mailer + Meta map[string]any + User *models.User + type MetaConfig struct + AppName string + AppUrl string + SenderAddress string + SenderName string + UserConfirmEmailChangeUrl string + UserResetPasswordUrl string + UserVerificationUrl string + func (c MetaConfig) Validate() error + type ModelEvent struct + Dao *daos.Dao + Model models.Model + type RealtimeConnectEvent struct + Client subscriptions.Client + HttpContext echo.Context + type RealtimeSubscribeEvent struct + Client subscriptions.Client + HttpContext echo.Context + Subscriptions []string + type RecordCreateEvent struct + HttpContext echo.Context + Record *models.Record + type RecordDeleteEvent struct + HttpContext echo.Context + Record *models.Record + type RecordUpdateEvent struct + HttpContext echo.Context + Record *models.Record + type RecordViewEvent struct + HttpContext echo.Context + Record *models.Record + type RecordsListEvent struct + Collection *models.Collection + HttpContext echo.Context + Records []*models.Record + Result *search.Result + type S3Config struct + AccessKey string + Bucket string + Enabled bool + Endpoint string + Region string + Secret string + func (c S3Config) Validate() error + type ServeEvent struct + App App + Router *echo.Echo + type Settings struct + AdminAuthToken TokenConfig + AdminPasswordResetToken TokenConfig + EmailAuth EmailAuthConfig + FacebookAuth AuthProviderConfig + GithubAuth AuthProviderConfig + GitlabAuth AuthProviderConfig + GoogleAuth AuthProviderConfig + Logs LogsConfig + Meta MetaConfig + S3 S3Config + Smtp SmtpConfig + UserAuthToken TokenConfig + UserEmailChangeToken TokenConfig + UserPasswordResetToken TokenConfig + UserVerificationToken TokenConfig + func NewSettings() *Settings + func (s *Settings) Clone() (*Settings, error) + func (s *Settings) Merge(other *Settings) error + func (s *Settings) NamedAuthProviderConfigs() map[string]AuthProviderConfig + func (s *Settings) RedactClone() (*Settings, error) + func (s *Settings) Validate() error + type SettingsListEvent struct + HttpContext echo.Context + RedactedSettings *Settings + type SettingsUpdateEvent struct + HttpContext echo.Context + NewSettings *Settings + OldSettings *Settings + type SmtpConfig struct + Enabled bool + Host string + Password string + Port int + Tls bool + Username string + func (c SmtpConfig) Validate() error + type TokenConfig struct + Duration int64 + Secret string + func (c TokenConfig) Validate() error + type UserAuthEvent struct + HttpContext echo.Context + Meta any + Token string + User *models.User + type UserCreateEvent struct + HttpContext echo.Context + User *models.User + type UserDeleteEvent struct + HttpContext echo.Context + User *models.User + type UserOauth2RegisterEvent struct + AuthData *auth.AuthUser + HttpContext echo.Context + User *models.User + type UserUpdateEvent struct + HttpContext echo.Context + User *models.User + type UserViewEvent struct + HttpContext echo.Context + User *models.User + type UsersListEvent struct + HttpContext echo.Context + Result *search.Result + Users []*models.User
Go to main page