Index

Modules: snorlogue, snorlogue/backend/backendController, snorlogue/backend/formParseService, snorlogue/constants, snorlogue/filePathType, snorlogue/frontend/controllerUtils, snorlogue/frontend/fieldUtils/fieldTypes, snorlogue/frontend/formCreateService, snorlogue/frontend/frontendController, snorlogue/frontend/modelAnalysisService, snorlogue/frontend/nimjaTemplateNames, snorlogue/frontend/pageContexts, snorlogue/genericRepository, snorlogue/macroUtils, snorlogue/modelRoutes, snorlogue/repository/sqliteRepository, snorlogue/urlUtils.

API symbols

`$`:

• filePathType: proc `$`(x: FilePath): string

ABOUT_PAGE:

• nimjaTemplateNames: const ABOUT_PAGE

ActionProc:

• constants: type ActionProc

add:

• filePathType: proc add(x: var FilePath; s: FilePath)
• filePathType: proc add(x: var FilePath; s: string)

addAdminRoutes:

• modelRoutes: proc addAdminRoutes(app: var Prologue; middlewares: seq[HandlerAsync] = @[]; urlPrefix: static string = "admin")

addCrudRoutes:

• modelRoutes: proc addCrudRoutes[T: Model](app: Prologue; modelType: typedesc[T]; middlewares: seq[HandlerAsync] = @[]; urlPrefix: static string = "admin"; sortFields: seq[string] = @["id"]; sortDirection: SortDirection = SortDirection.ASC; beforeCreateAction: ActionProc[T] = nil; afterCreateAction: ActionProc[T] = nil; beforeDeleteAction: ActionProc[T] = nil; beforeUpdateAction: ActionProc[T] = nil; afterUpdateAction: ActionProc[T] = nil)

ASC:

• constants: SortDirection.ASC

BACKEND:

• urlUtils: Page.BACKEND

BOOL:

• fieldTypes: FormFieldKind.BOOL

checkForModelFields:

• modelAnalysisService: proc checkForModelFields[T: Model](modelType: typedesc[T])

CONFIG:

• urlUtils: Page.CONFIG

ConfigurationContext:

• pageContexts: object ConfigurationContext

count:

• sqliteRepository: proc count[T: Model](modelType: typedesc[T]): int64

create:

• sqliteRepository: proc create[T: Model](newModel: var T; beforeCreateAction: ActionProc[T]; afterCreateAction: ActionProc[T])

CREATE:

• urlUtils: Page.CREATE

createAboutApplicationFrontendController:

• frontendController: proc createAboutApplicationFrontendController(urlPrefix: static string): HandlerAsync

createBackendController:

• backendController: proc createBackendController[T: Model](model: typedesc[T]; urlPrefix: static string; beforeCreateAction: ActionProc[T]; afterCreateAction: ActionProc[T]; beforeUpdateAction: ActionProc[T]; afterUpdateAction: ActionProc[T]; beforeDeleteAction: ActionProc[T]): HandlerAsync

createConfirmDeleteController:

• frontendController: proc createConfirmDeleteController[T: Model](modelType: typedesc[T]; urlPrefix: static string): HandlerAsync

createCreateFormController:

• frontendController: proc createCreateFormController[T: Model](modelType: typedesc[T]; urlPrefix: static string): HandlerAsync

createDetailController:

• frontendController: proc createDetailController[T: Model](modelType: typedesc[T]; urlPrefix: static string): HandlerAsync

createListController:

• frontendController: proc createListController[T: Model](modelType: typedesc[T]; urlPrefix: static string; sortFields: seq[string]; sortDirection: SortDirection): HandlerAsync

createOverviewController:

• frontendController: proc createOverviewController(registeredModels: seq[ModelMetaData]; urlPrefix: static string): HandlerAsync

createSqlController:

• frontendController: proc createSqlController(urlPrefix: static string): HandlerAsync

createSqlFrontendController:

• frontendController: proc createSqlFrontendController(urlPrefix: static string): HandlerAsync

DATE:

• fieldTypes: FormFieldKind.DATE

DATETIME_LOCAL_FORMAT:

• constants: const DATETIME_LOCAL_FORMAT

dbType:

• filePathType: proc dbType(T: typedesc[FilePath]): string

dbValue:

• filePathType: proc dbValue(val: FilePath): DbValue

DEFAULT_MEDIA_ROOT:

• constants: let DEFAULT_MEDIA_ROOT

DEFAULT_PAGE_SIZE:

• constants: const DEFAULT_PAGE_SIZE

delete:

• sqliteRepository: proc delete[T: Model](modelType: typedesc[T]; id: int64; beforeDeleteAction: ActionProc[T])

DELETE:

• urlUtils: Page.DELETE

DESC:

• constants: SortDirection.DESC

DETAIL:

• urlUtils: Page.DETAIL

executeQuery:

• sqliteRepository: proc executeQuery(query: string): Option[QueryResult]

extractFields:

• formCreateService: proc extractFields[T: Model](model: T): seq[FormField]

extractMetaData:

• modelAnalysisService: proc extractMetaData[T: Model](urlPrefix: static string; modelType: typedesc[T]): ModelMetaData

FILE:

• fieldTypes: FormFieldKind.FILE

FilePath:

• filePathType: type FilePath

FLOAT:

• fieldTypes: FormFieldKind.FLOAT

FormField:

• fieldTypes: object FormField

FormFieldKind:

• fieldTypes: enum FormFieldKind

generateUrlStub:

• urlUtils: proc generateUrlStub(urlPrefix: static string; action: Page; modelName: string): string
• urlUtils: proc generateUrlStub[T: Model](urlPrefix: static string; action: Page; model: typedesc[T]): string

getField:

• macroUtils: macro getField[T: object | ref object](obj: T; fieldName: static string): untyped
• macroUtils: macro getField[T: object | ref object](someType: typedesc[T]; fieldName: static string): untyped

getForeignKeyFields:

• modelAnalysisService: proc getForeignKeyFields[T: Model](modelType: typedesc[T]): seq[string]

getPageSize:

• controllerUtils: proc getPageSize(ctx: Context): int

hasField:

• macroUtils: proc hasField[T: object | ref object](obj: T; fieldName: static string): bool
• macroUtils: proc hasField[T: object | ref object](t: typedesc[T]; fieldName: static string): bool

hasFileField:

• pageContexts: proc hasFileField(fields: seq[FormField]): bool

ID_PARAM:

• constants: const ID_PARAM

ID_PATTERN:

• constants: const ID_PATTERN

initAboutApplicationContext:

• pageContexts: proc initAboutApplicationContext(urlPrefix: static string; settings: Settings; routes: Table[string, seq[string]]): ConfigurationContext

initCreateContext:

• pageContexts: proc initCreateContext[T: Model](model: T; urlPrefix: static string; settings: Settings): ModelCreateContext[T]

initDeleteContext:

• pageContexts: proc initDeleteContext[T: Model](model: T; urlPrefix: static string; settings: Settings): ModelDeleteContext[T]

initDetailContext:

• pageContexts: proc initDetailContext[T: Model](model: T; urlPrefix: static string; settings: Settings): ModelDetailContext[T]

initListContext:

• pageContexts: proc initListContext[T](models: seq[T]; urlPrefix: static string; settings: Settings; totalModelCount: int64; pageIndex: int; pageSize: int): ModelListContext[ T]

initOverviewContext:

• pageContexts: proc initOverviewContext(metaDataEntries: seq[ModelMetaData]; urlPrefix: static string; settings: Settings): OverviewContext

initSqlContext:

• pageContexts: proc initSqlContext(urlPrefix: static string; settings: Settings; query: string; rows: Option[seq[Row]]; columnNames: Option[seq[string]]; errorMsg: Option[string]): SqlContext

INT:

• fieldTypes: FormFieldKind.INT

IntOption:

• fieldTypes: object IntOption

INTSELECT:

• fieldTypes: FormFieldKind.INTSELECT

list:

• sqliteRepository: proc list[T: Model](pageIndex: int; pageSize: int; sortFields: seq[string]; sortDirection: SortDirection): seq[T]

LIST:

• urlUtils: Page.LIST

listAll:

• sqliteRepository: proc listAll[T: Model](modelType: typedesc[T]): seq[T]

MEDIA_ROOT_SETTING:

• constants: const MEDIA_ROOT_SETTING

ModelCreateContext:

• pageContexts: object ModelCreateContext

MODEL_CREATE_PAGE:

• nimjaTemplateNames: const MODEL_CREATE_PAGE

ModelDeleteContext:

• pageContexts: object ModelDeleteContext

MODEL_DELETE_PAGE:

• nimjaTemplateNames: const MODEL_DELETE_PAGE

ModelDetailContext:

• pageContexts: object ModelDetailContext

MODEL_DETAIL_PAGE:

• nimjaTemplateNames: const MODEL_DETAIL_PAGE

ModelListContext:

• pageContexts: object ModelListContext

MODEL_LIST_PAGE:

• nimjaTemplateNames: const MODEL_LIST_PAGE

ModelMetaData:

• modelAnalysisService: object ModelMetaData

OVERVIEW:

• urlUtils: Page.OVERVIEW

OverviewContext:

• pageContexts: object OverviewContext

OVERVIEW_PAGE:

• nimjaTemplateNames: const OVERVIEW_PAGE

PACKAGE_PATH:

• constants: const PACKAGE_PATH

Page:

• urlUtils: enum Page

PageContext:

• pageContexts: object PageContext

PAGE_PARAM:

• constants: const PAGE_PARAM

PAGE_PATTERN:

• constants: const PAGE_PATTERN

parseFormData:

• formParseService: proc parseFormData[T: Model](ctx: Context; model: typedesc[T]; skipIdField: static bool = false): T

QueryResult:

• sqliteRepository: type QueryResult

read:

• sqliteRepository: proc read[T: Model](id: int64): T

REGISTERED_MODELS:

• pageContexts: var REGISTERED_MODELS

renderNimjaPage:

• controllerUtils: proc renderNimjaPage[T: PageContext](pageName: static string; context: T): string

setField:

• macroUtils: template setField[T: object | ref object](obj: var T; fieldName: static string; value: untyped)

SortDirection:

• constants: enum SortDirection

SQL:

• urlUtils: Page.SQL

SqlContext:

• pageContexts: object SqlContext

SQL_PAGE:

• nimjaTemplateNames: const SQL_PAGE

STRING:

• fieldTypes: FormFieldKind.STRING

stringifyRoutingTree:

• frontendController: proc stringifyRoutingTree(router: Router): Table[string, seq[string]]

StringOption:

• fieldTypes: object StringOption

STRSELECT:

• fieldTypes: FormFieldKind.STRSELECT

subdir:

• filePathType: template subdir(directory: string)

to:

• filePathType: proc to(dbVal: DbValue; T: typedesc[FilePath]): T:type

toForeignKeyField:

• formCreateService: proc toForeignKeyField[T: Model](value: int64; fieldName: static string; foreignKeyModelType: typedesc[T]): FormField
• formCreateService: proc toForeignKeyField[T: Model](value: Option[int64]; fieldName: static string; foreignKeyModelType: typedesc[T]): FormField

toFormField:

• formCreateService: proc toFormField(value: Option[bool]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[DateTime]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[FilePath]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[float32]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[float64]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[int32]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[int64]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[int]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[Natural]; fieldName: string): FormField
• formCreateService: proc toFormField(value: Option[string]; fieldName: string): FormField
• formCreateService: proc toFormField[T: enum or range](value: Option[T]; fieldName: string): FormField
• formCreateService: proc toFormField[T](value: T; fieldName: string): FormField

toModelValue:

• formParseService: proc toModelValue(formValue: string; T: typedesc[bool]): T:type
• formParseService: proc toModelValue(formValue: string; T: typedesc[DateTime]): T:type
• formParseService: proc toModelValue[T](formValue: string; O: typedesc[Option[T]]): O:type
• formParseService: proc toModelValue(formValue: string; T: typedesc[SomeFloat]): T:type
• formParseService: proc toModelValue(formValue: string; T: typedesc[SomeInteger]): T:type
• formParseService: proc toModelValue(formValue: string; T: typedesc[string]): T:type
• formParseService: proc toModelValue[T: enum](formValue: string; O: typedesc[T]): T

update:

• sqliteRepository: proc update[T: Model](updateModel: var T; beforeUpdateAction: ActionProc[T]; afterUpdateAction: ActionProc[T])

validateModel:

• modelAnalysisService: proc validateModel[T: Model](model: typedesc[T])