| _dateFormat |
Type : unknown
|
Default value : signal("dd.MM.yyyy")
|
| _datepickerFormat |
Type : unknown
|
Default value : signal("DD.MM.YYYY")
|
| _dateTimeFormat |
Type : unknown
|
Default value : signal("dd.MM.yyyy HH:mm")
|
| defaultDateFormat |
Type : Signal<string>
|
Default value : _dateFormat.asReadonly()
|
|
Current default shortDate format as a readonly signal (Angular DatePipe format, e.g., "dd.MM.yyyy") |
| defaultDateTimeFormat |
Type : Signal<string>
|
Default value : _dateTimeFormat.asReadonly()
|
|
Current default datetime format as a readonly signal (Angular DatePipe format, e.g., "dd.MM.yyyy HH:mm") |
| ABORTED_REQUEST_NAME |
Type : string
|
Default value : "AbortError"
|
|
PouchDB's name of a request to the server cut off by our timeout (see |
| WRITE_CONFLICT_TEXT |
Type : string
|
Default value : "document update conflict"
|
|
PouchDB's wording of a rejected write, for errors that lost their 409 status. |
| ABORTED_TRANSACTION_REASON |
Type : string
|
Default value : "transaction was aborted"
|
|
PouchDB's reason for a write whose IndexedDB transaction was aborted, whatever the cause. |
| DOC_STORE |
Type : string
|
Default value : "docs"
|
|
The |
| META_RECORD_ID |
Type : string
|
Default value : "meta"
|
| META_STORE |
Type : string
|
Default value : "meta"
|
| SEQ_INDEX |
Type : string
|
Default value : "seq"
|
| actions |
Type : unknown
|
Default value : [...CRUD_ACTIONS, "manage"] as const
|
|
The list of action strings that can be used for permissions |
| ADMIN_APP_ROLE |
Type : string
|
Default value : "admin_app"
|
|
The realm role that grants access to the administration features, as checked by the admin routes' UserRoleGuard configuration. |
| CRUD_ACTIONS |
Type : unknown
|
Default value : ["read", "create", "update", "delete"] as const
|
|
The individual CRUD actions, in the order they are displayed as columns of the permission UIs. |
| DEFAULT_SECTION_KEY |
Type : string
|
Default value : "_default"
|
|
Section keys in DatabaseRules that carry special semantics instead of mapping a user role. The underscore prefix marks them as internal so they cannot collide with a realm role name. |
| PUBLIC_SECTION_KEY |
Type : string
|
Default value : "_public"
|
| RESERVED_ROLE_PREFIX |
Type : string
|
Default value : "_"
|
|
A user role starting with this prefix is reserved and never resolved. |
| RESERVED_RULE_CONFIG_KEYS |
Type : miscellaneous
|
Default value : [
DEFAULT_SECTION_KEY,
PUBLIC_SECTION_KEY,
]
|
|
All section keys that must never be resolved as if they were user role names, even if a realm role with the same name exists. A new key added here does not automatically stop inheriting the "_default" rules; see inheritsDefaultRules. |
| activeLocale |
Type : string
|
Default value : DEFAULT_LANGUAGE
|
| validLocaleIds |
Type : readonly string[]
|
Default value : AVAILABLE_LOCALE_IDS
|
| addDefaultMatchingView |
Type : ConfigMigration
|
Default value : (key, configPart) => {
if (configPart?.["_id"] !== "Config:CONFIG_ENTITY" || !configPart?.["data"]) {
// add only at top-level of config
return configPart;
}
if (!configPart["data"]["view:matching"]) {
configPart["data"]["view:matching"] = { component: "MatchingEntities" };
}
return configPart;
}
|
|
Add default view:matching MatchingEntities config to avoid having to add this fixed view to every deployment's config |
| addDefaultNoteViews |
Type : ConfigMigration
|
Default value : (key, configPart) => {
// add only at top-level of config
if (configPart?.["_id"] === "Config:CONFIG_ENTITY" && configPart?.["data"]) {
addDefaultNoteViewsToConfig(configPart["data"]);
}
return configPart;
}
|
|
Add default Note view configs (list and details) to avoid breaking note views with a default config from AdminModule |
| defaultNoteListView |
Type : object
|
Default value : {
component: "EntityList",
config: {
entityType: "Note",
title: $localize`:title of the note list view:Notes & Reports`,
clickMode: "popup-details",
columns: ["date", "subject", "category", "authors", "relatedEntities"],
filters: [
{ id: "warningLevel" },
{ id: "date", default: 1 },
{ id: "category" },
{ id: "authors" },
],
},
}
|
| addDefaultReportingView |
Type : ConfigMigration
|
Default value : (key, configPart) => {
if (configPart?.["_id"] !== "Config:CONFIG_ENTITY" || !configPart?.["data"]) {
// add only at top-level of config
return configPart;
}
if (!configPart["data"]["view:report"]) {
configPart["data"]["view:report"] = { component: "Reporting" };
}
return configPart;
}
|
|
Add default view:report Reporting config to avoid having to add this fixed view to every deployment's config |
| addDefaultTodoViews |
Type : ConfigMigration
|
Default value : (key, configPart) => {
if (configPart?.["_id"] !== "Config:CONFIG_ENTITY" || !configPart?.["data"]) {
// add only at top-level of config
return configPart;
}
const configData = configPart["data"];
const viewConfigKey = `view:${Todo.route.substring(1) /* remove leading slash */}`;
// List View
if (!configData[viewConfigKey]) {
// add standard list view
configData[viewConfigKey] = JSON.parse(JSON.stringify(defaultTodoListView));
} else {
// add prebuilt filter to existing list view
const existingFilters = configData[viewConfigKey].config.filters || [];
if (!existingFilters.some((f) => f.id === todoDueStatusFilter.id)) {
// reference the prebuilt filter only, its options are provided by the app
existingFilters.push({
id: todoDueStatusFilter.id,
type: todoDueStatusFilter.type,
});
}
configData[viewConfigKey].config.filters = existingFilters;
}
// Details View
if (!configData[viewConfigKey + "/:id"]) {
configData[viewConfigKey + "/:id"] = JSON.parse(
JSON.stringify(defaultTodoDetailsView),
);
}
return configPart;
}
|
|
Add default view:note/:id NoteDetails config to avoid breaking note details with a default config from AdminModule |
| defaultTodoDetailsView |
Type : object
|
Default value : {
component: "EntityDetails",
config: {
entityType: Todo.ENTITY_TYPE,
panels: [
{
title: "Overview",
components: [
{
title: "",
component: "Form",
config: {
fieldGroups: [
{
fields: [
"subject",
"deadline",
"startDate",
"description",
"assignedTo",
"relatedEntities",
"repetitionInterval",
"completed",
],
},
],
},
},
],
},
],
},
}
|
| defaultTodoListView |
Type : object
|
Default value : {
component: "EntityList",
config: {
entityType: "Todo",
columns: [
"deadline",
"subject",
"assignedTo",
"startDate",
"relatedEntities",
"completed",
],
filters: [
{ id: "assignedTo", default: PLACEHOLDERS.CURRENT_USER },
{ id: "todo-due-status", type: "prebuilt" },
],
defaultSort: { active: "deadline", direction: "asc" },
clickMode: "popup-details",
showInactive: true,
},
}
|
| todoDueStatusFilter |
Type : PrebuiltFilterConfig<Todo>
|
Default value : {
id: "todo-due-status",
type: "prebuilt",
label: $localize`Tasks due`,
options: [
{
key: "current",
label: $localize`:Filter-option for todos:Currently Active`,
filter: {
$and: [
TODO_NOT_COMPLETED_FILTER,
{
$or: [
{
startDate: {
$exists: false,
},
},
{
startDate: {
$lte: moment().format("YYYY-MM-DD"),
$gt: "",
},
},
{
deadline: {
$lte: moment().format("YYYY-MM-DD"),
$gt: "",
},
},
],
},
],
} as DataFilter<Todo>,
},
{
key: "overdue",
label: $localize`:Filter-option for todos:Overdue`,
filter: {
$and: [
TODO_NOT_COMPLETED_FILTER,
{ deadline: { $lte: moment().format("YYYY-MM-DD"), $gt: "" } },
],
} as DataFilter<Todo>,
},
{
key: "completed",
label: $localize`:Filter-option for todos:Completed`,
filter: TODO_COMPLETED_FILTER,
},
{
key: "open",
label: $localize`:Filter-option for todos:All Open`,
filter: TODO_NOT_COMPLETED_FILTER,
},
{ key: "any", label: $localize`Any`, filter: {} },
],
singleSelectOnly: true,
default: "current",
}
|
|
Special filter with pre-defined categories of Todo items. |
| API_CLIENT_ID_PREFIX |
Type : miscellaneous
|
Default value : "api-"
|
|
Every API client's client id starts with this (the backend only manages such clients). |
| ATTENDANCE_DOWNLOAD_GROUP |
Type : EntityActionGroup
|
Default value : {
id: "attendance-downloads",
label: $localize`:entity context menu:Download attendance lists`,
icon: "download",
}
|
| ATTENDANCE_STATUS_CONFIG_ID |
Type : string
|
Default value : "attendance-status"
|
|
the id through which the available attendance status types can be loaded from the ConfigService. |
| NullAttendanceStatusType |
Type : AttendanceStatusType
|
Default value : {
id: "",
label: "",
shortName: "",
countAs: AttendanceLogicalStatus.IGNORE,
}
|
|
Null object representing an unknown attendance status. This allows easier handling of attendance status logic because exceptional checks for undefined are not necessary. |
| attendanceComponents |
Type : ComponentTuple[]
|
Default value : [
[
"AttendanceManager",
() =>
import("./add-day-attendance/attendance-manager/attendance-manager.component").then(
(c) => c.AttendanceManagerComponent,
),
],
[
"AddDayAttendance",
() =>
import("./add-day-attendance/roll-call-setup/roll-call-setup.component").then(
(c) => c.RollCallSetupComponent,
),
],
[
"RollCall",
() =>
import("./add-day-attendance/roll-call/roll-call.component").then(
(c) => c.RollCallComponent,
),
],
[
"GroupedChildAttendance",
() =>
import("./analysis/grouped-child-attendance/grouped-child-attendance.component").then(
(c) => c.GroupedChildAttendanceComponent,
),
],
[
"ActivityAttendanceSection",
() =>
import("./analysis/activity-attendance-section/activity-attendance-section.component").then(
(c) => c.ActivityAttendanceSectionComponent,
),
],
[
"AttendanceWeekDashboard",
() =>
import("./attendance-week-dashboard/attendance-week-dashboard.component").then(
(c) => c.AttendanceWeekDashboardComponent,
),
],
[
"EditLegacyAttendance",
() =>
import("./deprecated/edit-legacy-attendance.component").then(
(c) => c.EditLegacyAttendanceComponent,
),
],
[
"EditAttendance",
() =>
import("./edit-attendance/edit-attendance.component").then(
(c) => c.EditAttendanceComponent,
),
],
[
"DisplayAttendance",
() =>
import("./display-attendance/display-attendance.component").then(
(c) => c.DisplayAttendanceComponent,
),
],
[
"AttendanceWeekDashboardSettings",
() =>
import("./attendance-week-dashboard/attendance-week-dashboard-settings.component/attendance-week-dashboard-settings.component").then(
(c) => c.AttendanceWeekDashboardSettingsComponent,
),
],
]
|
| RANGE_END |
Type : string
|
Default value : "ï¿°"
|
|
sorts after every string, so it closes an |
| AUDIT_ID_TRAILING_PARTS |
Type : number
|
Default value : 4
|
|
How many Four, not two: an ISO timestamp carries two colons of its own
( |
| AUDIT_REFERENCE_INDEX_ID |
Type : string
|
Default value : "audit-references"
|
|
design document id, without the |
| AUDIT_REFERENCE_MAP |
Type : unknown
|
Default value : `function (doc) {
if (!doc || !doc.timestamp || doc.operation === "${BASELINE_OPERATION}") {
return;
}
// "Type:id" with no whitespace; the leading letter rules out ISO timestamps
var ID_PATTERN = /^[A-Za-z][A-Za-z0-9_]*:[^\\s]+$/;
// URI schemes that match the pattern but are never entity references.
// Keys are prefixed, as are those of "found" below, so that a lookup can
// never hit an inherited Object.prototype member ("constructor:1" would
// otherwise read as a known scheme and be dropped).
var NON_ENTITY_SCHEMES = {
$http: 1, $https: 1, $ftp: 1, $file: 1, $data: 1,
$blob: 1, $mailto: 1, $tel: 1, $urn: 1, $ws: 1, $wss: 1
};
// guards against one pathological document (a large config, a data URI)
// bloating the index or stalling the indexer
var MAX_REFS = 500;
var MAX_DEPTH = 12;
var MAX_ID_LENGTH = 200;
// keys are prefixed so that no value can collide with an Object.prototype member
var found = {};
var count = 0;
function add(value) {
if (count >= MAX_REFS) {
return;
}
if (typeof value !== "string" || value.length > MAX_ID_LENGTH) {
return;
}
if (!ID_PATTERN.test(value) || value.indexOf("//") >= 0) {
return;
}
var scheme = value.substring(0, value.indexOf(":")).toLowerCase();
if (NON_ENTITY_SCHEMES["$" + scheme]) {
return;
}
if (!found["$" + value]) {
found["$" + value] = true;
count++;
}
}
function walk(value, depth) {
if (count >= MAX_REFS || depth > MAX_DEPTH) {
return;
}
if (typeof value === "string") {
add(value);
} else if (value && typeof value === "object") {
for (var key in value) {
if (Object.prototype.hasOwnProperty.call(value, key)) {
walk(value[key], depth + 1);
}
}
}
}
add(doc.entityId);
walk(doc.diff, 0);
for (var id in found) {
emit([id.substring(1), doc.timestamp]);
}
}`
|
|
Emits "Touches" is both directions: the changed record itself ( BASELINE_OPERATION records are skipped, as they are in the log's other query: a baseline is a snapshot rather than a change, and indexing its full field list would report every record that merely held a reference at that moment as having changed it — for a demo dataset, one child's participation in hundreds of past events. The ids are matched syntactically ( A |
| AUDIT_REFERENCE_VIEW |
Type : unknown
|
Default value : `${AUDIT_REFERENCE_INDEX_ID}/by_reference`
|
|
the query name to pass to |
| AVAILABLE_LOCALE_IDS |
Type : readonly string[]
|
Default value : AVAILABLE_LOCALES.map(
(locale) => locale.id,
)
|
| availableLocales |
Type : miscellaneous
|
Default value : new ConfigurableEnum(LOCALE_ENUM_ID, [
...AVAILABLE_LOCALES,
])
|
|
A readonly array of all locales available |
| LOCALE_ENUM_ID |
Type : string
|
Default value : "locales"
|
| FILTERABLE_OPERATIONS |
Type : ChangeOperation[]
|
Default value : [
"create",
"update",
"delete",
]
|
|
The operations a user can filter the change log by, in the order the filter offers them.
|
| OPERATION_LABELS |
Type : Record<ChangeOperation, string>
|
Default value : {
baseline: $localize`:Change action badge:Initial snapshot`,
create: $localize`:Change action badge:Created`,
update: $localize`:Change action badge:Updated`,
delete: $localize`:Change action badge:Deleted`,
}
|
|
The past-tense wording for each operation, shared by the badge and the filter's options so the two cannot drift apart. |
| withStack |
Type : object
|
Default value : { frames: [{ filename: "app.ts" }] }
|
| canInstallDirectly |
Type : Promise | undefined
|
|
Resolves once/if it is possible to directly install the app |
| deferredInstallPrompt |
Type : BeforeInstallPromptEvent | undefined
|
|
The deferred |
| installPromptListener |
Type : unknown | undefined
|
|
The registered listener, kept so resetPWAInstallListener can remove it again |
| centersUnique |
Type : ConfigurableEnumValue[]
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:center",
).values
|
| centersWithProbability |
Type : unknown
|
Default value : [0, 0, 1, 2].map((i) => centersUnique[i])
|
| changeHistoryComponents |
Type : ComponentTuple[]
|
Default value : [
[
"ChangeHistoryActionBadge",
() =>
import("./change-history-action-badge/change-history-action-badge.component").then(
(c) => c.ChangeHistoryActionBadgeComponent,
),
],
[
"ChangeHistoryChangedFields",
() =>
import("./change-history-changed-fields/change-history-changed-fields.component").then(
(c) => c.ChangeHistoryChangedFieldsComponent,
),
],
[
"DisplayAuditTimestamp",
() =>
import("./display-audit-timestamp/display-audit-timestamp.component").then(
(c) => c.DisplayAuditTimestampComponent,
),
],
[
"DisplayAuditRecord",
() =>
import("./display-audit-record/display-audit-record.component").then(
(c) => c.DisplayAuditRecordComponent,
),
],
[
"DisplayAuditUser",
() =>
import("./display-audit-user/display-audit-user.component").then(
(c) => c.DisplayAuditUserComponent,
),
],
]
|
| changeHistoryRoutes |
Type : Routes
|
Default value : [
{
path: "",
// loaded on demand: this module itself stays eager, because its constructor
// registers the per-record history action for every entity details view,
// but the log is a rarely visited admin screen and need not be bundled with it
loadComponent: () =>
"import(\"./change-history-list/change-history-list.component\").then(\n\
(c) => c.ChangeHistoryListComponent,\n\
)",
canActivate: [EntityPermissionGuard],
data: {
entityType: "AuditRecord",
requiredPermissionOperation: "read",
},
},
]
|
|
Routes of the change log, mounted by the app at Owned by this feature rather than the admin module, so the admin routing does
not have to import from |
| childrenComponents |
Type : ComponentTuple[]
|
Default value : [
[
"DisplayParticipantsCount",
() =>
import("./display-participants-count/display-participants-count.component").then(
(c) => c.DisplayParticipantsCountComponent,
),
],
]
|
| EXPECTED_FAILURES |
Type : unknown
|
Default value : new Set<ErrorClassification>([
"connectivity",
"session-expired",
"not-permitted",
"write-conflict",
])
|
| CLOSE_OTHER_TABS_NOTICE_ID |
Type : string
|
Default value : "reset-close-other-tabs-notice"
|
|
id of the notice on the loading screen, see showCloseOtherTabsNotice |
| LAST_SYNC_KEY_PREFIX |
Type : string
|
Default value : "LAST_SYNC_"
|
|
localStorage key prefix under which |
| RESET_PENDING_KEY |
Type : string
|
Default value : "__RESET_PENDING"
|
|
sessionStorage key used to signal that a reset is pending. Set before a page reload; checked on the next bootstrap in runPendingReset. |
| COLUMN_PART_SEPARATOR |
Type : string
|
Default value : " - "
|
|
Separator between the parts of an inner field exported in several columns, e.g. "2020-01-01 - 2020-12-31". |
| ENTRY_SEPARATOR |
Type : string
|
Default value : "; "
|
|
Separator between the entries of an array field, e.g. "Passport, 12345; ID Card, 678". |
| VALUE_SEPARATOR |
Type : string
|
Default value : ", "
|
|
Separator between the values of one entry, e.g. "Passport, 12345". |
| columnsCache |
Type : unknown
|
Default value : new WeakMap<FormFieldConfig, FormFieldConfig[]>()
|
|
Resolved columns per field config (see DisplaySchemaEmbedArrayComponent.columns) |
| COMPONENT_PERMISSIONS |
Type : Record<string, { configKey: "activityTypes" | "eventTypes"; operation: EntityActionPermission }>
|
Default value : {
AttendanceManager: {
configKey: "activityTypes",
operation: "read",
},
AddDayAttendance: { configKey: "eventTypes", operation: "create" },
RollCall: { configKey: "eventTypes", operation: "create" },
}
|
|
Maps component name to the service signal property and required operation for permission checks. |
| componentRegistry |
Type : unknown
|
Default value : new ComponentRegistry()
|
| CONDITION_LIST_OPERATORS |
Type : []
|
Default value : ["$or", "$and", "$nor"]
|
|
operators combining a list of conditions, each of which is a condition on its own |
| UNRESOLVED |
Type : unknown
|
Default value : Symbol("unresolved")
|
|
marks a value that cannot be resolved, because it references an empty field |
| CONFIG_ENTITY_ROUTE_PREFIX |
Type : string
|
Default value : "c"
|
|
Stable URL prefix used for entity routes loaded from runtime config. |
| CONFIG_JSON_MAX_RELOAD_ATTEMPTS |
Type : number
|
Default value : 1
|
| CONFIG_JSON_RELOAD_ATTEMPTS_KEY |
Type : string
|
Default value : "config_json_reload_attempts"
|
|
sessionStorage key tracking how many times we've auto-reloaded due to a failure loading config.json, so a persistent failure (e.g. offline) doesn't reload-loop and flood error monitoring. |
| CONFIG_SETUP_WIZARD_ID |
Type : unknown
|
Default value : "Config:" + SETUP_WIZARD_CONFIG_KEY
|
| SETUP_WIZARD_CONFIG_KEY |
Type : string
|
Default value : "SetupWizard"
|
|
id of the SetupWizard Config entity, without the entity type prefix |
| SETUP_WIZARD_ROUTE |
Type : string
|
Default value : "/admin/setup-wizard"
|
| configMigrations |
Type : ConfigMigration[]
|
Default value : [
migrateDashboardDefaultEntityType,
]
|
|
All temporary config migrations that fix legacy data formats.
Applied by both ConfigService (Angular app) and the admin CLI ( Once a migration has been applied to all systems through the CLI, remove it from here. |
| migrateDashboardDefaultEntityType |
Type : ConfigMigration
|
Default value : (
key,
configPart,
) => {
if (DASHBOARDS_DEFAULTING_TO_CHILD.includes(configPart?.component)) {
configPart.config ||= {};
configPart.config.entityType ??= "Child";
}
return configPart;
}
|
| CONFLICT_RESOLUTION_STRATEGY |
Type : unknown
|
Default value : new InjectionToken<
ConflictResolutionStrategy[]
>("ConflictResolutionStrategy")
|
|
Use this token to provide (and thereby register) custom implementations of ConflictResolutionStrategy.
|
| conflictResolutionComponents |
Type : ComponentTuple[]
|
Default value : [
[
"ConflictResolution",
() =>
import("./conflict-resolution-list/conflict-resolution-list.component").then(
(c) => c.ConflictResolutionListComponent,
),
],
]
|
| EXPIRED_TOKEN_REASON |
Type : string
|
Default value : "exp not in future"
|
|
CouchDB's |
| NOT_PERMITTED_TEXT |
Type : string
|
Default value : "not permitted"
|
|
Text the permission backend uses when the current user may not access a document or type. |
| ROUTE_PATH_SEGMENT |
Type : unknown
|
Default value : /^(_?[a-z][a-z_-]*|v\d+)$/i
|
|
A path segment naming a route rather than a record: a word (e.g. |
| CONSOLE_METHODS |
Type : Record<LogLevel, "debug" | "info" | "warn" | "error">
|
Default value : {
[LogLevel.DEBUG]: "debug",
[LogLevel.INFO]: "info",
[LogLevel.WARN]: "warn",
[LogLevel.ERROR]: "error",
}
|
| Logging |
Type : miscellaneous
|
Default value : new LoggingService()
|
| SENTRY_LEVELS |
Type : Partial<Record<LogLevel, Sentry.SeverityLevel>>
|
Default value : {
[LogLevel.WARN]: "warning",
[LogLevel.ERROR]: "error",
}
|
|
Only |
| coreComponents |
Type : ComponentTuple[]
|
Default value : [
[
"DisplayConfigurableEnum",
() =>
import("./basic-datatypes/configurable-enum/display-configurable-enum/display-configurable-enum.component").then(
(c) => c.DisplayConfigurableEnumComponent,
),
],
[
"EditConfigurableEnum",
() =>
import("./basic-datatypes/configurable-enum/edit-configurable-enum/edit-configurable-enum.component").then(
(c) => c.EditConfigurableEnumComponent,
),
],
[
"Form",
() =>
import("./entity-details/form/form.component").then(
(c) => c.FormComponent,
),
],
[
"EditEntity",
() =>
import("./basic-datatypes/entity/edit-entity/edit-entity.component").then(
(c) => c.EditEntityComponent,
),
],
[
"DisplayEntity",
() =>
import("./basic-datatypes/entity/display-entity/display-entity.component").then(
(c) => c.DisplayEntityComponent,
),
],
[
"EntityBlock",
() =>
import("./basic-datatypes/entity/entity-block/entity-block.component").then(
(c) => c.EntityBlockComponent,
),
],
[
"EditTextWithAutocomplete",
() =>
import("./common-components/edit-text-with-autocomplete/edit-text-with-autocomplete.component").then(
(c) => c.EditTextWithAutocompleteComponent,
),
],
[
"EditAge",
() =>
import("./basic-datatypes/date-with-age/edit-age/edit-age.component").then(
(c) => c.EditAgeComponent,
),
],
[
"EditText",
() =>
import("./basic-datatypes/string/edit-text/edit-text.component").then(
(c) => c.EditTextComponent,
),
],
[
"EditTranslatableText",
() =>
import("./config/translatable-text-input/translatable-text-input.component").then(
(c) => c.TranslatableTextInputComponent,
),
],
[
"EditBoolean",
() =>
import("./basic-datatypes/boolean/edit-boolean/edit-boolean.component").then(
(c) => c.EditBooleanComponent,
),
],
[
"EditDate",
() =>
import("./basic-datatypes/date/edit-date/edit-date.component").then(
(c) => c.EditDateComponent,
),
],
[
"EditDateRange",
() =>
import("./basic-datatypes/date-range/edit-date-range/edit-date-range.component").then(
(c) => c.EditDateRangeComponent,
),
],
[
"EditMonth",
() =>
import("./basic-datatypes/month/edit-month/edit-month.component").then(
(c) => c.EditMonthComponent,
),
],
[
"EditLongText",
() =>
import("./basic-datatypes/string/edit-long-text/edit-long-text.component").then(
(c) => c.EditLongTextComponent,
),
],
[
"EditPhoto",
() =>
import("../features/file/edit-photo/edit-photo.component").then(
(c) => c.EditPhotoComponent,
),
],
[
"EditNumber",
() =>
import("./basic-datatypes/number/edit-number/edit-number.component").then(
(c) => c.EditNumberComponent,
),
],
[
"DisplayDescriptionOnly",
() =>
import("./common-components/description-only/display-description-only/display-description-only.component").then(
(c) => c.DisplayDescriptionOnlyComponent,
),
],
[
"DisplayCheckmark",
() =>
import("./basic-datatypes/boolean/display-checkmark/display-checkmark.component").then(
(c) => c.DisplayCheckmarkComponent,
),
],
[
"DisplayText",
() =>
import("./basic-datatypes/string/display-text/display-text.component").then(
(c) => c.DisplayTextComponent,
),
],
[
"DisplayTranslatableText",
() =>
import("./config/display-translatable-text/display-translatable-text.component").then(
(c) => c.DisplayTranslatableTextComponent,
),
],
[
"DisplayLongText",
() =>
import("./basic-datatypes/string/display-long-text/display-long-text.component").then(
(c) => c.DisplayLongTextComponent,
),
],
[
"DisplayDate",
() =>
import("./basic-datatypes/date/display-date/display-date.component").then(
(c) => c.DisplayDateComponent,
),
],
[
"DisplayEntityType",
() =>
import("./entity/display-entity-type/display-entity-type.component").then(
(c) => c.DisplayEntityTypeComponent,
),
],
[
"DisplayDateRange",
() =>
import("./basic-datatypes/date-range/display-date-range/display-date-range.component").then(
(c) => c.DisplayDateRangeComponent,
),
],
[
"DisplayMonth",
() =>
import("./basic-datatypes/month/display-month/display-month.component").then(
(c) => c.DisplayMonthComponent,
),
],
[
"ReadonlyFunction",
() =>
import("./common-components/display-readonly-function/readonly-function.component").then(
(c) => c.ReadonlyFunctionComponent,
),
],
[
"DisplayPercentage",
() =>
import("./basic-datatypes/number/display-percentage/display-percentage.component").then(
(c) => c.DisplayPercentageComponent,
),
],
[
"DisplayDynamicPercentage",
() =>
import("./basic-datatypes/number/display-dynamic-percentage/display-calculated-value.component").then(
(c) => c.DisplayCalculatedValueComponent,
),
],
[
"DisplayCalculatedValue",
() =>
import("./basic-datatypes/number/display-dynamic-percentage/display-calculated-value.component").then(
(c) => c.DisplayCalculatedValueComponent,
),
],
[
"DisplayUnit",
() =>
import("./basic-datatypes/number/display-unit/display-unit.component").then(
(c) => c.DisplayUnitComponent,
),
],
[
"DisplayAge",
() =>
import("./basic-datatypes/date-with-age/display-age/display-age.component").then(
(c) => c.DisplayAgeComponent,
),
],
[
"UserSecurity",
() =>
import("./user/entity-user/entity-user.component").then(
(c) => c.EntityUserComponent,
),
],
[
"Dashboard",
() =>
import("./dashboard/dashboard/dashboard.component").then(
(c) => c.DashboardComponent,
),
],
[
"EntityList",
() =>
import("./entity-list/entity-list/entity-list.component").then(
(c) => c.EntityListComponent,
),
],
[
"EntityDetails",
() =>
import("./entity-details/entity-details/entity-details.component").then(
(c) => c.EntityDetailsComponent,
),
],
[
"RelatedEntities",
() =>
import("./entity-details/related-entities/related-entities.component").then(
(c) => c.RelatedEntitiesComponent,
),
],
[
"DisplayRelatedEmbeddedField",
() =>
import("./entity-details/related-entities/display-related-embedded-field/display-related-embedded-field.component").then(
(c) => c.DisplayRelatedEmbeddedFieldComponent,
),
],
[
"EmbeddedArrayData",
() =>
import("./entity-details/embedded-array-data/embedded-array-data.component").then(
(c) => c.EmbeddedArrayDataComponent,
),
],
[
"RelatedTimePeriodEntities",
() =>
import("./entity-details/related-time-period-entities/related-time-period-entities.component").then(
(c) => c.RelatedTimePeriodEntitiesComponent,
),
],
[
"RelatedEntitiesWithSummary",
() =>
import("./entity-details/related-entities-with-summary/related-entities-with-summary.component").then(
(c) => c.RelatedEntitiesWithSummaryComponent,
),
],
[
"EditEntityType",
() =>
import("./entity/edit-entity-type/edit-entity-type.component").then(
(c) => c.EditEntityTypeComponent,
),
],
[
"EditUrl",
() =>
import("./basic-datatypes/string/edit-url/edit-url.component").then(
(c) => c.EditUrlComponent,
),
],
[
"DisplayUrl",
() =>
import("./basic-datatypes/string/display-url/display-url.component").then(
(c) => c.DisplayUrlComponent,
),
],
[
"EditEmail",
() =>
import("./basic-datatypes/string/edit-email/edit-email.component").then(
(c) => c.EditEmailComponent,
),
],
[
"DisplayEmail",
() =>
import("./basic-datatypes/string/display-email/display-email.component").then(
(c) => c.DisplayEmailComponent,
),
],
[
"EditAvailableLocales",
() =>
import("./language/edit-available-locales/edit-available-locales.component").then(
(c) => c.EditAvailableLocalesComponent,
),
],
[
"EditDateFormat",
() =>
import("./basic-datatypes/date/edit-date-format/edit-date-format.component").then(
(c) => c.EditDateFormatComponent,
),
],
[
"EditColor",
() =>
import("./common-components/color-input/color-input.component").then(
(c) => c.ColorInputComponent,
),
],
[
"EditJson",
() =>
import("./admin/json-editor/edit-json/edit-json.component").then(
(c) => c.EditJsonComponent,
),
],
[
"FreeTextFilter",
() =>
import("./common-components/entities-table/free-text-filter/free-text-filter.component").then(
(c) => c.FreeTextFilterComponent,
),
],
[
"EditSchemaEmbedArray",
() =>
import("./basic-datatypes/schema-embed/edit-schema-embed-array/edit-schema-embed-array.component").then(
(c) => c.EditSchemaEmbedArrayComponent,
),
],
[
"DisplaySchemaEmbedArray",
() =>
import("./basic-datatypes/schema-embed/display-schema-embed-array/display-schema-embed-array.component").then(
(c) => c.DisplaySchemaEmbedArrayComponent,
),
],
]
|
| CRUD_ACTION_COLUMNS |
Type : CrudActionColumn[]
|
Default value : CRUD_ACTIONS.map(
(action) => ({
action,
label: CRUD_ACTION_LABELS[action],
}),
)
|
|
the actions with their labels, in display order |
| CRUD_ACTION_LABELS |
Type : Record<CrudAction, string>
|
Default value : {
read: $localize`:Permission column header:Read`,
create: $localize`:Permission column header:Create`,
update: $localize`:Permission column header:Update`,
delete: $localize`:Permission column header:Delete`,
}
|
|
User-facing name of each action, so that the role administration and the per-feature dialog label their columns identically. |
| MANAGE_ALL_LABEL |
Type : unknown
|
Default value : $localize`:Permission column header:Manage (all)`
|
|
the CASL "manage" action, which covers every other action |
| CURRENT_RECORD_PLACEHOLDER_PREFIX |
Type : string
|
Default value : "$current_record."
|
|
Prefix of a placeholder in a condition value that stands for the value of a field
of the record currently being edited, e.g. |
| EMPTY_FILTER_OPTION_KEY |
Type : string
|
Default value : "__empty__"
|
| CURRENTLY_ACTIVE_COLOR |
Type : string
|
Default value : "#90ee9040"
|
|
highlight color for the entry that covers the current date |
| currentlyActiveIndicator |
Type : FormFieldConfig
|
Default value : {
id: "currentlyActive",
label: $localize`:Label for the currently active status|e.g. Currently active:Currently`,
viewComponent: "ReadonlyFunction",
hideFromTable: true,
description: $localize`:Tooltip for the status of currently active or not:Only added to linked record if active. Change the start or end date to modify this status.`,
additional: (csr: ChildSchoolRelation) =>
csr.isActiveAt(new Date())
? $localize`:Indication for the currently active status of an entry:active`
: $localize`:Indication for the currently inactive status of an entry:not active`,
}
|
| DEFAULT_BULK_WRITE_LIMITS |
Type : BulkWriteLimits
|
Default value : {
maxBytes: 4 * 1024 * 1024,
maxDocuments: 500,
}
|
| UTF8_ENCODER |
Type : unknown
|
Default value : new TextEncoder()
|
|
Shared encoder for jsonByteLength (creating one per document is wasteful). |
| DEFAULT_COMBINATOR |
Type : Combinator
|
Default value : "all"
|
|
Combinator of a condition that does not exist yet. "all" is the safe default: in permissions "any" would widen access when a second row is added, where "all" narrows it. |
| isPlainObject |
Type : unknown
|
Default value : (value: any): boolean =>
!!value && typeof value === "object" && !Array.isArray(value)
|
| DEFAULT_LANGUAGE |
Type : miscellaneous
|
Default value : "en-US"
|
| LANGUAGE_LOCAL_STORAGE_KEY |
Type : string
|
Default value : "locale"
|
| LANGUAGE_OWNER_LOCAL_STORAGE_KEY |
Type : string
|
Default value : "localeOwner"
|
|
Id of the account whose own language setting put the current locale in place. Absent if the locale was picked on this device or is the system default. |
| DEFAULT_ROLE |
Type : ReservedRoleInfo
|
Default value : {
key: DEFAULT_SECTION_KEY,
label: $localize`:Reserved role name of the "_default" role:Default`,
appliesTo: $localize`applies to any logged-in user, in addition to their roles`,
description: $localize`Base permissions that apply to every logged-in user, combined with their other roles`,
icon: "lock",
}
|
|
The "_default" role, whose permissions every logged-in user has in addition to the permissions of their own roles. |
| PUBLIC_ROLE |
Type : ReservedRoleInfo
|
Default value : {
key: PUBLIC_SECTION_KEY,
label: $localize`:Reserved role name of the "_public" role:Public`,
appliesTo: $localize`applies to visitors who are not logged in`,
description: $localize`Permissions that apply before login (e.g. public registration forms)`,
icon: "globe",
}
|
|
The "_public" role, whose permissions apply to visitors before login. |
| defaultAttendanceStatusTypes |
Type : unknown
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:attendance-status",
).values as AttendanceStatusType[]
|
| defaultInteractionTypes |
Type : unknown
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:" + INTERACTION_TYPE_CONFIG_ID,
).values as InteractionType[]
|
| defaultValueCompleteValidator |
Type : ValidatorFn
|
Default value : (
control: AbstractControl,
): ValidationErrors | null => {
const val: DefaultValueConfig = control.value;
if (!val) {
return { incompleteDefaultValue: true };
}
if (val.mode && !val.config) {
return { incompleteDefaultValue: true };
}
if (
val.config &&
typeof val.config === "object" &&
"value" in val.config &&
(val.config as { value: unknown }).value == null
) {
return { incompleteDefaultValue: true };
}
return null;
}
|
| OkButton |
Type : ConfirmationDialogButton[]
|
Default value : [
{
text: $localize`:Confirmation dialog OK:OK`,
click() {
// Intentionally blank
// To react to emissions from this button, use the `MatDialogRef.beforeClosed()` hook
},
dialogResult: true,
},
]
|
| YesNoButtons |
Type : ConfirmationDialogButton[]
|
Default value : [
{
text: $localize`:Confirmation dialog Yes:Yes`,
click() {
// Intentionally blank
// To react to emissions from this button, use the `MatDialogRef.beforeClosed()` hook
},
dialogResult: true,
},
{
text: $localize`:Confirmation dialog No:No`,
click() {
// Intentionally blank
// To react to emissions from this button, use the `MatDialogRef.beforeClosed()` hook
},
dialogResult: false,
},
]
|
| YesNoCancelButtons |
Type : ConfirmationDialogButton[]
|
Default value : [
{
text: $localize`:Confirmation dialog Yes:Yes`,
click() {
// Intentionally blank
// To react to emissions from this button, use the `MatDialogRef.beforeClosed()` hook
},
dialogResult: true,
},
{
text: $localize`:Confirmation dialog No:No`,
click() {
// Intentionally blank
// To react to emissions from this button, use the `MatDialogRef.beforeClosed()` hook
},
dialogResult: false,
},
{
text: $localize`:Confirmation dialog Cancel:Cancel`,
click() {
// Intentionally blank
// To react to emissions from this button, use the `MatDialogRef.beforeClosed()` hook
},
dialogResult: undefined,
},
]
|
| DYNAMIC_VALIDATORS |
Type : unknown
|
Default value : [
/** type: number */
"min",
/** type: number */
"max",
/** type: string/date */
"minDate",
/** type: string/date */
"maxDate",
/** type: number */
"minAge",
/** type: number */
"maxAge",
/** type: boolean */
"required",
/** type: boolean; validate field value is unique among entities of same type */
"uniqueId",
/** type: boolean */
"readonlyAfterSet",
/** type: string or regex */
"pattern",
/** type: WithinParentConfig; warns (without blocking saving) when a date range goes beyond the one of a linked parent */
"withinParent",
/**
* type: DataFilter; for fields referencing another entity type:
* a Mango/MongoDB style query condition that the referenced records have to match
* to be offered for selection in this field.
*
* Condition values can refer to fields of the record being edited
* through a placeholder like `"$current_record.location"`, including its unsaved changes.
* If such a referenced field is empty, the rows of the condition referencing it are not applied
* (with the "any" combinator, `$or`, the whole condition then is not applied).
* The same applies if there is no single record, like in bulk edit.
*
* A placeholder can also refer to a field of a record that the edited record links to (one level only),
* like `"$current_record.parentAction.locations"`: the values of all records linked in `parentAction`.
* For example `{ "_id": { "$in": ["$current_record.parentAction.locations"] } }` only offers the locations of the parent.
* A linked record that cannot be loaded (e.g. without read permission) counts as not linked.
*
* Only applies to a field referencing a single record type and edited with the entity dropdown
* (or an edit component using it), not if a form layout sets another `editComponent`.
* A `schema-embed` field (e.g. `attendance`) takes it in the config of its embedded
* entity field (e.g. `additional.participant.validators.selectionCondition`).
*
* Records that do not match can still be shown by the user on request,
* and already selected records are kept even if they do not match (anymore).
* A selected record that does not match is only a warning: users can still save after confirming it
* (not checked for an embedded field like the participants of `attendance`).
* The warning only appears when the user changed this field or a field the condition refers to
* (e.g. a new `location` that existing links do not match), not on every save of a record linked before.
* Selected records that do not match are still marked with a warning icon at the field.
*/
"selectionCondition",
] as const
|
|
The keys of the validators of the core module in a FormValidatorConfig,
to type configs written in code. Each is implemented by a registered |
| WARNING_ONLY_KEY |
Type : string
|
Default value : "_warningOnly"
|
|
key of the setting in a FormValidatorConfig listing the validators that are only a warning |
| viewConfigs |
Type : ViewConfig[]
|
Default value : [
// List View
{
_id: "view:" + PublicFormConfig.route,
component: "EntityList",
config: {
entityType: PublicFormConfig.ENTITY_TYPE,
columns: ["title", "description", "entity"],
filters: [{ id: "entity" }],
} as EntityListConfig,
},
// Details View
{
_id: "view:" + PublicFormConfig.route + "/:id",
component: "EntityDetails",
config: {
entityType: PublicFormConfig.ENTITY_TYPE,
panels: [
{
title: $localize`:PublicFormConfig admin form panel:General Setting`,
components: [
{
component: "Form",
config: {
fieldGroups: [
{
fields: [
{
id: "public_form_format_warning",
viewComponent: "PublicFormFormatWarning",
},
"route",
"title",
"description",
],
},
{
fields: [
{
id: "permissions_remark",
viewComponent: "DisplayDescriptionOnly",
label: $localize`:PublicFormConfig admin form:If you want external people filling this form without logging in, the _Permission System_ also has to allow **"public"** users to create new records of this type.<br>
If you are seeing problems submitting the form, please contact your **technical support team**.`,
},
"entity",
{
id: "public_form_permission_warning",
viewComponent: "PublicFormPermissionWarning",
},
"logo",
"showSubmitAnotherButton",
],
},
],
},
},
],
},
{
title: $localize`:PublicFormConfig admin form panel:Configure Fields`,
components: [
{
component: "Form",
config: {
fieldGroups: [
{
fields: ["columns"],
},
],
},
},
],
},
{
title: $localize`:PublicFormConfig admin form panel:Configure Pre-filled Values`,
components: [
{
component: "Form",
config: {
fieldGroups: [
{
fields: [
{
id: "prefilled_description",
viewComponent: "DisplayDescriptionOnly",
label: $localize`:PublicFormConfig admin form:You can configure some fields to be always be set to a certain value when this form is submitted. For example, make a "status" field always be set to "new" so that you can easily filter the new records submitted by external users; or make a "signed up on" date field to always show the current date. If you add the same field(s) in the "Configure Fields" section to show to the user, this pre-filled value can be changed by the person filling the form.`,
},
"prefilled",
{
id: "linked_entities_description",
viewComponent: "DisplayDescriptionOnly",
label: $localize`:PublicFormConfig admin form:**Collect replies of this form linked to individual records**<br> <br>You can use forms with a special "magic link" to collect responses from participants that are already registered in your system. By sending out an individual link to each person, the form response(s) from that person can be linked into their profile. For example, you can collect feedback or an evaluation survey and relate each submission to the specific participant or organisation that gave it.<br>The system supports linking to multiple entity types. For example, you can encode IDs of a person and activity in the magic link to collect feedback for that specific context. To set this up, select multiple fields below. Currently, such multi-ID URLs need to be generated outside of this system, however.`,
},
"linkedEntities",
],
},
],
},
},
],
},
],
} as EntityDetailsConfig,
},
]
|
| viewConfigs |
Type : ViewConfig[]
|
Default value : [
// List View
{
_id: "view:" + TemplateExport.route,
component: "EntityList",
config: {
entityType: TemplateExport.ENTITY_TYPE,
columns: ["title", "description", "applicableForEntityTypes"],
filters: [{ id: "applicableForEntityTypes" }],
} as EntityListConfig,
},
// Details View
{
_id: "view:" + TemplateExport.route + "/:id",
component: "EntityDetails",
config: {
entityType: TemplateExport.ENTITY_TYPE,
panels: [
{
components: [
{
component: "Form",
config: {
fieldGroups: [
{
fields: [
"title",
"description",
"applicableForEntityTypes",
"arrayReport",
],
},
{
fields: [
{
id: "template_explanation",
viewComponent: "DisplayDescriptionOnly",
label: $localize`:TemplateExport:Upload a specially prepared template file here.
The file can contain placeholders that will be replaced with actual data when a file is generated for a selected record.
For example {d.name} will be replaced with the value in the "name" field of the given record.
See the documentation of the [carbone system](https://carbone.io/documentation.html#substitutions) for more information.
The placeholder keys must match the field "Field ID" of the record data structure in Aam Digital.
You can find this in the Admin UI form builder (Edit Data Structure -> Details View) and edit a specific field to view its details.
In addition to the selected record, you can also use fields of the currently logged-in user's own record by prefixing them with "c.user." (e.g. {c.user.name}). This works both in the template file and in the file name pattern.
Template files can be in most office document formats (odt, docx, ods, xlsx, odp, pptx) or PDF.`,
},
"templateFile",
"targetFileName",
],
},
],
},
},
],
},
],
} as EntityDetailsConfig,
},
]
|
| EMBEDDED_FIELD_ID_SEPARATOR |
Type : string
|
Default value : "."
|
|
Separator used to build an id referencing a property nested inside an embedded field, e.g. "childrenAttendance.participant" references the "participant" property of the entries of the embedded field "childrenAttendance". |
| EMPTY |
Type : ConfigurableEnumValue
|
Default value : {
id: "",
label: "",
}
|
| emptyModel |
Type : unknown
|
Default value : (): MatrixModel => ({ rows: [], unsupportedRules: [] })
|
|
fresh empty matrix model; a factory (not a shared const) so callers can never alias a mutable object |
| ENTITY_CONFIG_PREFIX |
Type : string
|
Default value : "entity:"
|
| NAVIGATION_MENU_CONFIG_ID |
Type : string
|
Default value : "navigationMenu"
|
| ENTITY_NOT_FOUND_PLACEHOLDER |
Type : miscellaneous
|
Default value : "<not_found>"
|
|
Placeholder exported for a referenced entity that does not exist (or cannot be read). |
| EXPORT_BATCH_SIZE |
Type : number
|
Default value : 20
|
|
Maximum number of rows (and of values within one row) that are resolved in parallel during an export.
Resolving referenced entities can require a database request per value; running
them all at once exhausts the browser's resources on large lists
( |
| entityAbilityFactory |
Type : unknown
|
Default value : () => {
let ability = new EntityAbility();
ability.update([{ subject: "all", action: "manage" }]);
return ability;
}
|
| entityFormStorybookDefaultParameters |
Type : object
|
Default value : {
controls: {
exclude: ["_columns", "_cols", "enumValueToString"],
},
}
|
| environment |
Type : object
|
Default value : {
production: true,
appVersion: "0.0.0", // replaced automatically during docker build
repositoryId: "Aam-Digital/ndb-core",
remoteLoggingDsn: undefined as string | undefined,
remoteLoggingEnvironment: undefined as string | undefined,
demo_mode: true,
session_type: SessionType.mock,
webmaster_email: undefined,
userAdminApi: undefined,
realm: undefined,
clientId: undefined,
DB_PROXY_PREFIX: "/db",
API_PROXY_PREFIX: "/api",
notificationsConfig: undefined,
SaaS: false,
userSupportEnabled: false,
use_indexeddb_adapter: true,
translationsCdnUrl: "https://aam-digital.github.io/ndb-core/locale",
default_data_source: undefined as string | undefined,
session_type_choice: true,
multiLingualConfigEnabled: false,
}
|
|
see environment.ts for explanations |
| environment |
Type : object
|
Default value : {
production: false,
appVersion: "0.0.0", // replaced automatically during docker build
repositoryId: "Aam-Digital/ndb-core",
/**
* The DSN of the remote monitoring (Sentry) project to report warnings and errors to.
* Not set by default, so remote logging is off: deployments set it in their `config.json`.
*/
remoteLoggingDsn: undefined as string | undefined,
/**
* The `environment` that remote monitoring files this deployment's events under.
* Defaults to "production" for production builds - set it in the `config.json`
* of test, demo or preview deployments, so that their events can be told apart.
*/
remoteLoggingEnvironment: undefined as string | undefined,
demo_mode: true,
session_type: SessionType.mock,
/** Contact email for the webmaster/operator of this instance, used e.g. as Nominatim usage-policy email. Set via config.json on production. */
webmaster_email: undefined,
/** Keycloak API for user management */
userAdminApi: undefined, // loaded from `assets/keycloak.json` during bootstrap
/** Keycloak realm for user management */
realm: undefined, // loaded from `assets/keycloak.json` during bootstrap
/** Keycloak client id of the app (used e.g. for the "back to application" link in action emails) */
clientId: undefined, // loaded from `assets/keycloak.json` during bootstrap
/** Path for the reverse proxy that forwards to the database - configured in `default.conf` */
DB_PROXY_PREFIX: "/db",
/** Path for the reverse proxy that forwards to backend services APIs - configured in `default.conf` */
API_PROXY_PREFIX: "/api",
/** see FirebaseConfiguration and assets/firebase-config.json */
notificationsConfig: undefined,
/** Whether the system is hosted Software-as-a-Service, therefore enabling subscription-related UI */
SaaS: true,
/** Has the system a subscription with access to personal user support? */
userSupportEnabled: false,
/**
* Use the newer "indexeddb" PouchDB adapter (and Keycloak-UUID-based local database names)
* instead of the legacy "idb" adapter.
* When true (default), existing local databases on the old adapter are migrated
* (see IndexeddbMigrationService).
* Set to false via config.json to opt out and keep using the legacy adapter.
*/
use_indexeddb_adapter: true,
/** CDN URL for loading translation files at runtime. Empty string disables CDN loading. */
translationsCdnUrl: "https://aam-digital.github.io/ndb-core/locale",
/**
* Default data source used for all lists of entities,
* unless a list config overrides it.
* see src/app/core/common-components/entities-table/README.md
*/
default_data_source: undefined as string | undefined,
/**
* Whether the system is multi-language: admins can configure texts in several
* languages, and users can switch the app's language (in their profile and on public
* forms). Off in prod and enabled per system.
*
* If off, the translation editing UI is hidden (texts already stored per language are
* still resolved), and everyone uses the default language from the site settings:
* a user's own language and one picked on the device are ignored.
*
* If on, the translation editing UI is still hidden while only the default language
* is enabled in the site settings (see `SiteSettingsService.translationsEnabled`).
*/
multiLingualConfigEnabled: true,
/**
* Whether users are allowed to choose between synced and online-only mode on the login page.
* When false, the toggle is hidden and the session_type configured here is enforced.
* Defaults to true (users can choose).
*/
session_type_choice: true,
}
|
|
Central environment that allows to configure differences between a "dev" and a "prod" build.
For deployments, the The file contents for the current environment will overwrite these during build.
The build system defaults to the dev environment which uses |
| ERROR_CLASSIFICATIONS |
Type : unknown
|
Default value : [
"connectivity",
"session-expired",
"not-permitted",
"local-storage",
"server-error",
"write-conflict",
] as const
|
|
What kind of failure an error is, declared by its TypedError class (see
classifyError); what remote monitoring does with each is |
| faker |
Type : unknown
|
Default value : new CustomFaker({ locale: [en_IN, en], seed: 1 })
|
|
(Extended) faker module |
| fileComponents |
Type : ComponentTuple[]
|
Default value : [
[
"EditFile",
() =>
import("./edit-file/edit-file.component").then(
(c) => c.EditFileComponent,
),
],
[
"ViewFile",
() =>
import("./view-file/view-file.component").then(
(c) => c.ViewFileComponent,
),
],
]
|
| FULL_LOAD_PAGE_SIZE |
Type : number
|
Default value : 500
|
|
Number of documents fetched per request when paging through a complete result set (see EntityMapperService.findAllType). |
| genders |
Type : ConfigurableEnumValue[]
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:genders",
).values
|
| GERMAN_ADDRESS_FORMAT_COUNTRY |
Type : string
|
Default value : "de"
|
|
Country whose addresses are written as "Street 12, 12345 City", the format GeoService.reformatDisplayName produces. |
| HIDDEN_FIELDS |
Type : unknown
|
Default value : new Set([
"_id",
"_rev",
"_revisions",
"created",
"updated",
])
|
|
Doc fields that are internal/metadata and never shown as user-facing field changes. |
| iconRetinaUrl |
Type : string
|
Default value : "assets/marker-icon-2x.png"
|
| iconUrl |
Type : string
|
Default value : "assets/marker-icon.png"
|
| shadowUrl |
Type : string
|
Default value : "assets/marker-shadow.png"
|
| IMPORT_ACTIONS_GROUP |
Type : EntityActionGroup
|
Default value : {
id: "import-related",
label: $localize`:entity context menu:Import related`,
icon: "file-import",
}
|
| importComponents |
Type : ComponentTuple[]
|
Default value : [
[
"Import",
() => import("./import/import.component").then((c) => c.ImportComponent),
],
[
"DateImportConfig",
() =>
import("../basic-datatypes/date/date-import-config/date-import-config.component").then(
(c) => c.DateImportConfigComponent,
),
],
[
"DateImportDialog",
() =>
import("../basic-datatypes/date/date-import-config/date-import-dialog.component").then(
(c) => c.DateImportDialogComponent,
),
],
[
"DiscreteImportConfig",
() =>
import("../basic-datatypes/discrete/discrete-import-config/discrete-import-config.component").then(
(c) => c.DiscreteImportConfigComponent,
),
],
[
"DiscreteImportDialog",
() =>
import("../basic-datatypes/discrete/discrete-import-config/discrete-import-dialog.component").then(
(c) => c.DiscreteImportDialogComponent,
),
],
[
"EntityImportConfig",
() =>
import("../basic-datatypes/entity/entity-import-config/entity-import-config.component").then(
(c) => c.EntityImportConfigComponent,
),
],
]
|
| IMPORT_SAMPLE_ADDITIONAL_ACTIONS |
Type : AdditionalImportAction[]
|
Default value : [
/*{
type: "School",
id: IMPORT_SAMPLE_LINKABLE_DATA.find((e) => e.getType() === "School").getId(
true,
),
},
{
type: "RecurringActivity",
id: IMPORT_SAMPLE_LINKABLE_DATA.find(
(e) => e.getType() === "RecurringActivity",
).getId(),
},*/
]
|
| IMPORT_SAMPLE_COLUMN_MAPPING |
Type : ColumnMapping[]
|
Default value : Object.keys(
IMPORT_SAMPLE_RAW_DATA[0],
).map((k) => ({
column: k,
}))
|
| IMPORT_SAMPLE_LINKABLE_DATA |
Type : Entity[]
|
Default value : [
Object.assign(createEntityOfType("School"), { name: "Sample School" }),
Object.assign(createEntityOfType("School"), { name: "ABCD School" }),
Object.assign(createEntityOfType("RecurringActivity"), {
title: "Activity X",
}),
Object.assign(createEntityOfType("RecurringActivity"), {
title: "Activity Y",
}),
]
|
| IMPORT_SAMPLE_PREVIOUS_IMPORTS |
Type : ImportMetadata[]
|
Default value : [
ImportMetadata.create({
created: { by: TEST_USER, at: new Date("2022-12-27") },
createdEntities: ["1", "2", "3"],
config: {
entityType: "Child",
columnMapping: IMPORT_SAMPLE_COLUMN_MAPPING,
},
}),
ImportMetadata.create({
created: { by: TEST_USER, at: new Date("2023-01-04") },
createdEntities: ["1", "3"],
config: { entityType: "School", columnMapping: [] },
}),
]
|
| INDEX_ID_PREFIX |
Type : string
|
Default value : "importantNotesDashboard"
|
| VIEW_NAME |
Type : string
|
Default value : "importantNotes"
|
| WARNING_LEVEL_ENUM_ID |
Type : string
|
Default value : "warning-levels"
|
| INDEX_ID_PREFIX |
Type : string
|
Default value : "birthdayDashboard"
|
| VIEW_NAME |
Type : string
|
Default value : "birthday"
|
| INTERACTION_TYPE_CONFIG_ID |
Type : string
|
Default value : "interaction-type"
|
|
ID of the Note category ConfigurableEnumValue in the config database. |
| ROLES_ADMIN_ROUTE |
Type : string
|
Default value : "/admin/user-roles"
|
|
Base route of the role management admin UI, to link to a role's details from elsewhere. Mirrors the "user-roles" paths registered in admin.routing.ts. |
| INVALID_LOCALE_REPORTED_KEY |
Type : string
|
Default value : "invalid_locale_reported"
|
|
sessionStorage key marking that an invalid locale was already reported in this browser session |
| LOGIN_RETRY_DELAYS_MS |
Type : []
|
Default value : [1_000, 3_000]
|
|
Backoff schedule for explicit user-initiated login retries. |
| RESPONSE_BODY_EXCERPT_LENGTH |
Type : number
|
Default value : 300
|
|
Length of the excerpt kept from a response body that is not OAuth error JSON. |
| RESPONSE_BODY_READ_TIMEOUT_MS |
Type : number
|
Default value : 2_000
|
|
Upper bound for reading an error response body, so logging never stalls a login. |
| TOKEN_MIN_VALIDITY_SECONDS |
Type : number
|
Default value : 30
|
|
Minimum remaining lifetime (in seconds) requested when refreshing the
token in the background. Matches keycloak-js's |
| LABEL_LANGUAGES |
Type : unknown
|
Default value : ["en", "de", "fr"] as const
|
|
languages the app has translations for (see the labels below) |
| LEGACY_NOTE_ATTENDANCE_FIELD |
Type : { field: string; definition: EntitySchemaField }
|
Default value : {
field: "childrenAttendance",
definition: {
dataType: "event-attendance-map",
additional: {
participant: {
dataType: "entity",
additional: ["Child"],
},
},
anonymize: "retain",
},
}
|
|
Snapshot of the deprecated Unlike the link fields above this one was never shown in a view and never had a label:
it was edited through the Systems that still rely on it have the definition written into their own |
| LEGACY_NOTE_FIELDS |
Type : LegacyNoteField[]
|
Default value : [
{
field: "children",
entityType: "Child",
definition: {
dataType: "entity",
isArray: true,
additional: "Child",
entityReferenceRole: "composite",
editComponent: "EditLegacyAttendance",
anonymize: "retain",
},
labels: { en: "Participants", de: "Teilnehmer:innen", fr: "Participants" },
},
{
field: "schools",
entityType: "School",
definition: {
dataType: "entity",
isArray: true,
additional: "School",
entityReferenceRole: "composite",
anonymize: "retain",
},
labels: { en: "Groups", de: "Gruppen", fr: "Groupes" },
},
]
|
|
Snapshot of the
(This module must stay free of runtime imports, as it is shared with the CLI -
see |
| languages |
Type : []
|
Default value : [
// multiple entries for the same value increase its probability
"Hindi",
"Hindi",
"Hindi",
"Urdu",
"Bengali",
"Bengali",
"",
]
|
| LG |
Type : string
|
Default value : "992px"
|
| MD |
Type : string
|
Default value : "768px"
|
| MOBILE_THRESHOLD |
Type : ScreenSize
|
Default value : ScreenSize.sm
|
|
The screen size where anything smaller and this size itself is considered mobile while anything strictly larger is considered desktop. |
| SM |
Type : string
|
Default value : "576px"
|
| XL |
Type : string
|
Default value : "1200px"
|
| XXL |
Type : string
|
Default value : "1400px"
|
| linkedRecordsSources |
Type : unknown
|
Default value : new WeakMap<
AbstractControl,
LinkedRecordsSource
>()
|
| LOCAL_DB_REVS_LIMIT |
Type : number
|
Default value : 100
|
|
How many revisions of a document's history a local database keeps
(PouchDB's The |
| SECOND_QUERY_BOOKMARK |
Type : string
|
Default value : "q2:"
|
|
Marks a bookmark of the second query (see PouchDatabase.find). |
| LOCATION_TOKEN |
Type : unknown
|
Default value : new InjectionToken<Location>(
"Window location object",
)
|
| NAVIGATOR_TOKEN |
Type : unknown
|
Default value : new InjectionToken<Navigator>(
"Window navigator object",
)
|
| WINDOW_TOKEN |
Type : unknown
|
Default value : new InjectionToken<Window>("Window object")
|
|
Use this instead of directly referencing the window object for better testability |
| locationComponents |
Type : ComponentTuple[]
|
Default value : [
[
"EditLocation",
() =>
import("./edit-location/edit-location.component").then(
(c) => c.EditLocationComponent,
),
],
[
"ViewLocation",
() =>
import("./view-location/view-location.component").then(
(c) => c.ViewLocationComponent,
),
],
[
"DisplayDistance",
() =>
import("./view-distance/view-distance.component").then(
(c) => c.ViewDistanceComponent,
),
],
[
"LocationImportConfig",
() =>
import("./location-import-config/location-import-config.component").then(
(c) => c.LocationImportConfigComponent,
),
],
]
|
| LOOKUP_WARNING_THRESHOLD |
Type : number
|
Default value : 50
|
| MAP_CONFIG_KEY |
Type : string
|
Default value : "appConfig:map"
|
| MATCH_ACTION |
Type : string
|
Default value : "match"
|
| MATCH_SUBJECT |
Type : string
|
Default value : "PermissionConditionCheck"
|
| matchingEntitiesComponents |
Type : ComponentTuple[]
|
Default value : [
[
"MatchingEntities",
() =>
import("./matching-entities/matching-entities.component").then(
(c) => c.MatchingEntitiesComponent,
),
],
[
"AdminMatchingEntities",
() =>
import("./admin-matching-entities/admin-matching-entities.component").then(
(c) => c.AdminMatchingEntitiesComponent,
),
],
]
|
| materials |
Type : ConfigurableEnumValue[]
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:materials",
).values
|
| mathLevels |
Type : ConfigurableEnumConfig<SkillLevel>
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:math-levels",
).values
|
| readingLevels |
Type : ConfigurableEnumConfig<SkillLevel>
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:reading-levels",
).values
|
| MATRIX_ACTIONS |
Type : EntityActionPermission[]
|
Default value : [
"read",
"create",
"update",
"delete",
"manage",
]
|
| MAX_CALCULATIONS_PER_RECORD |
Type : number
|
Default value : 1000
|
|
Safety limit for the calculation of the affected entities, in case their values do not settle (e.g. in a loop): how often the same record is calculated again, regardless of how many records are reached in total. |
| MAX_HIERARCHY_LEVELS |
Type : number
|
Default value : 10
|
|
Number of levels above the changed entity that are included in one update dialog. |
| MAX_ENTITIES_TO_REVIEW |
Type : number
|
Default value : 100
|
|
Above this number of affected records, the dialog to review them can take long to show, so the user is asked first |
| MAX_INCIDENT_EVENTS |
Type : number
|
Default value : 1
|
|
The connectivity issue only once per page load: when the connection drops,
every pending request fails at the same moment.
The same for a broken local database: once the device's IndexedDB is broken
(the |
| MAX_REPEATED_SENTRY_EVENTS |
Type : number
|
Default value : 5
|
|
How often an issue is reported per page load, against error loops (e.g. an error on every change detection) flooding monitoring and the quota. |
| reportedErrors |
Type : unknown
|
Default value : new WeakSet<object>()
|
|
Error objects (and their causes) already part of an event of this page load. |
| sentryEventCounts |
Type : unknown
|
Default value : new Map<string, number>()
|
| MAX_RESPONSE_BODY_LENGTH |
Type : number
|
Default value : 500
|
| MIN_INDEXEDDB_ADAPTER_VERSION |
Type : unknown
|
Default value : 10 ** 13
|
|
The IndexedDB version of DBs of the "indexeddb" adapter (the "idb" adapter uses 5) |
| mockSkillApi |
Type : object
|
Default value : {
getExternalProfiles: (): Observable<ExternalProfileResponseDto> =>
of({
pagination: {
currentPage: 1,
pageSize: 5,
totalPages: 2,
totalElements: 6,
},
results: faker.helpers.multiple(
() => createSkillApiDummyData(faker.string.numeric()),
{ count: { min: 0, max: 5 } },
),
}).pipe(delay(faker.number.int({ min: 500, max: 1500 }))),
generateDefaultSearchParams: () => ({
fullName: "John Doe",
}),
getExternalProfileById: (id: string) =>
of(createSkillApiDummyData(id)).pipe(
delay(faker.number.int({ min: 500, max: 1500 })),
),
async isSkillApiEnabled() {
return false;
},
}
|
| MY_FORMATS |
Type : object
|
Default value : {
parse: {
dateInput: "YYYY-MM",
},
display: {
dateInput: "YYYY-MM",
monthYearLabel: "YYYY MMM",
dateA11yLabel: "LL",
monthYearA11yLabel: "YYYY MMMM",
},
}
|
| NETWORK_ERROR_FINGERPRINT |
Type : string
|
Default value : "network-error"
|
|
The fingerprint of the one issue collecting all connectivity failures. |
| NETWORK_FAILURE |
Type : string
|
Default value : "network failure"
|
|
Stands in for a connectivity failure, which every browser words differently. |
| nextLockDescriptionId |
Type : number
|
Default value : 0
|
| noSpecialUrlChars |
Type : ValidatorFn
|
Default value : (control: AbstractControl) => {
const value: string = control.value;
if (value && !/^[a-zA-Z\d\-_]+$/.test(value)) {
return {
pattern: {
errorMessage: $localize`The link ID may only contain lowercase letters, digits, hyphens and underscores`,
},
};
}
return null;
}
|
| NOT_ARCHIVED_FILTER |
Type : object
|
Default value : {
$or: [{ inactive: { $ne: true } }, { inactive: { $exists: false } }],
}
|
|
Select records that are not archived. The |
| NOTES_BY_AUTHORS_VIEW |
Type : object
|
Default value : {
map: `(doc) => {
if (!doc._id.startsWith("${Note.ENTITY_TYPE}")) return;
if (!Array.isArray(doc.authors)) return;
doc.authors.forEach(val => emit(val));
}`,
}
|
|
Index view of notes by their Currently not registered in the |
| notesComponents |
Type : ComponentTuple[]
|
Default value : [
[
"NotesDashboard",
() =>
import("./dashboard-widgets/notes-dashboard/notes-dashboard.component").then(
(c) => c.NotesDashboardComponent,
),
],
[
"NotesRelatedToEntity",
() =>
import("./notes-related-to-entity/notes-related-to-entity.component").then(
(c) => c.NotesRelatedToEntityComponent,
),
],
[
"ImportantNotesDashboard",
() =>
import("./dashboard-widgets/important-notes-dashboard/important-notes-dashboard.component").then(
(c) => c.ImportantNotesDashboardComponent,
),
],
[
"NoteDetails",
() =>
import("./note-details/note-details.component").then(
(c) => c.NoteDetailsComponent,
),
],
[
"ImportantNotesDashboardSettings",
() =>
import("./dashboard-widgets/important-notes-dashboard-settings.component/important-notes-dashboard-settings.component").then(
(c) => c.ImportantNotesDashboardSettingsComponent,
),
],
[
"NotesDashboardSettings",
() =>
import("./dashboard-widgets/notes-dashboard-settings.component/notes-dashboard-settings.component").then(
(c) => c.NotesDashboardSettingsComponent,
),
],
]
|
| OPERATION_META |
Type : Record<ChangeOperation, OperationMeta>
|
Default value : {
baseline: {
icon: "clock-rotate-left",
label: OPERATION_LABELS.baseline,
background: "#ECEFF1",
color: "#4a525c",
tooltip: BASELINE_NOTE,
},
create: {
icon: "circle-plus",
label: OPERATION_LABELS.create,
background: "#E6F4EA",
color: "#1E6C33",
},
update: {
icon: "pen-to-square",
label: OPERATION_LABELS.update,
background: "#CCEFFF",
color: "#1565C0",
},
delete: {
icon: "trash",
label: OPERATION_LABELS.delete,
background: "#FBE2DE",
color: "#B23A2C",
},
}
|
|
Display metadata per operation. The labels are past tense while the keys are the backend's own operation names, so the wording stays a label rather than a second vocabulary the rest of the feature has to map back and forth. Orange is reserved for app chrome, so even |
| PRE_LOGIN_UNAVAILABLE_STATUSES |
Type : unknown
|
Default value : new Set([401, 403, 404])
|
|
Statuses with which pre-login access to the site settings is unavailable by design. |
| PREFIX_VIEW_CONFIG |
Type : string
|
Default value : "view:"
|
|
The prefix which is used to find the ViewConfig's in the config file |
| PUBLIC_FORM_LINKS_GROUP |
Type : EntityActionGroup
|
Default value : {
id: "public-form-links",
label: $localize`:entity context menu:Copy Custom Form link`,
icon: "link",
}
|
| PUBLIC_FORM_ROUTE |
Type : string
|
Default value : "public-form"
|
|
Top-level route segment under which public (anonymous) forms are served. Kept in a module without imports of its own, because the app bootstrap needs this value (see bootstrap-environment.ts) and must not load the public form components and their dependencies while doing so. |
| publicFormRoutes |
Type : Routes
|
Default value : [
{
path: "form/:id",
component: PublicFormComponent,
},
{ path: "submission-success", component: SubmissionSuccessComponent },
]
|
| ratingAnswers |
Type : ConfigurableEnumValue[]
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:rating-answer",
).values
|
| RECALCULATION_DELAY_MS |
Type : number
|
Default value : 300
|
|
How long to wait for further changes of the user before the entities above are updated |
| RELATED_ENTITIES_DEFAULT_CONFIGS |
Type : Record<string, { entityType: string; columns?: FormFieldConfig[] }>
|
Default value : {
NotesRelatedToEntity: {
entityType: "Note",
columns: [
{ id: "date", visibleFrom: "xs" },
{ id: "subject", visibleFrom: "xs" },
{ id: "text", visibleFrom: "md" },
{ id: "authors", visibleFrom: "md" },
{ id: "warningLevel", visibleFrom: "md" },
],
},
TodosRelatedToEntity: {
entityType: "Todo",
columns: [
{ id: "deadline" },
{ id: "subject" },
{ id: "startDate" },
{ id: "assignedTo" },
{ id: "description", visibleFrom: "xl" },
{ id: "repetitionInterval", visibleFrom: "xl" },
{ id: "relatedEntities", hideFromTable: true },
{ id: "completed", hideFromForm: true },
],
},
}
|
| RELATED_ENTITY_OVERRIDES |
Type : Record<string, Partial<RelatedEntitiesComponentConfig>>
|
Default value : {
EducationalMaterial: {
component: "RelatedEntitiesWithSummary",
},
}
|
| reportAdminViewConfigs |
Type : ViewConfig[]
|
Default value : [
{
_id: "view:" + ReportEntity.route,
component: "EntityList",
config: {
entityType: ReportEntity.ENTITY_TYPE,
columns: ["title", "mode", "description"],
} as EntityListConfig,
},
// Details / edit view
{
_id: "view:" + ReportEntity.route + "/:id",
component: "EntityDetails",
config: {
entityType: ReportEntity.ENTITY_TYPE,
panels: [
{
components: [
{
component: "Form",
config: {
fieldGroups: [
{
fields: [
{
id: "report_explanation",
viewComponent: "DisplayDescriptionOnly",
label: $localize`:ReportConfig:Configure a report that users can run to generate aggregated statistics or data exports.
See [Analyzing data through advanced reports](https://chatwoot.help/hc/aam-digital/articles/1782889956-analyzing-data-through-advanced-reports) for how to set up and use reports.`,
},
"title",
"mode",
"description",
"transformations",
],
},
{ fields: ["reportDefinition"] },
],
},
},
],
},
],
} as EntityDetailsConfig,
},
]
|
|
Admin list + details views to manage ReportEntity configs, registered the same way as other "Templates and Forms" entities (e.g. EmailTemplate). |
| REPORTED_ERROR_PROPERTIES |
Type : []
|
Default value : [
"entityId",
"status",
"reason",
"name",
"action",
"entityType",
]
|
| REPORTING_POLICY |
Type : Partial<Record<ErrorClassification, { drop?: boolean; adjust?: void }>>
|
Default value : {
// into the shared `network-error` issue at level warning (see `groupSentryEvent`),
// once per page load (see `reportOnce`); while offline it is expected
connectivity: { drop: () => !navigator.onLine },
// the user is told; the code waiting for the data is not at fault
"session-expired": { drop: () => true },
// a caught one is logged at debug (see `isExpectedFailure`): this one was not
// handled or is wrapped in a named error, usually a permission-configuration
// state (e.g. a public form failing on every submission because the public role
// may not create the record)
"not-permitted": { adjust: (event) => (event.level = "warning") },
// normal for an offline-first app: the user is told by the form and it is
// counted in usage analytics instead
"write-conflict": { drop: () => true },
// one incident per page load (see `report-once.ts`)
"local-storage": {
adjust: (event) => (event.tags = { ...event.tags, incident: "local-db" }),
},
}
|
|
What is done with an event by the classification of the failure it reports
(see |
| ReportEntity |
Type : unknown
|
Default value : ReportConfig as EntityConstructor<ReportEntity>
|
|
This allows the |
| reportingComponents |
Type : ComponentTuple[]
|
Default value : [
[
"Reporting",
() =>
import("./reporting/reporting.component").then(
(c) => c.ReportingComponent,
),
],
[
"EditReportMode",
() =>
import("./edit-report-mode/edit-report-mode.component").then(
(c) => c.EditReportModeComponent,
),
],
[
"EditReportPeriodToggle",
() =>
import("./edit-report-period-toggle/edit-report-period-toggle.component").then(
(c) => c.EditReportPeriodToggleComponent,
),
],
[
"EditSqlQuery",
() =>
import("./edit-sql-query/sql-code-editor.component").then(
(c) => c.SqlCodeEditorComponent,
),
],
[
"EditReportDefinition",
() =>
import("./edit-report-definition/edit-report-definition.component").then(
(c) => c.EditReportDefinitionComponent,
),
],
]
|
| ROLE_MANAGEMENT_ROLES |
Type : []
|
Default value : ["account_manager", ADMIN_APP_ROLE]
|
| SINGLE_SIGN_ON_SCOPE |
Type : string
|
Default value : "third_party_authentication"
|
|
The client scope that allows an external system to sign in as any user of the system. |
| SETTING_PREFIX |
Type : string
|
Default value : "_"
|
|
keys of a |
| SORT_BY_PARAM |
Type : string
|
Default value : "_sortBy"
|
|
URL query params of the sort (with the "_" prefix of view state other than filters, see |
| SORT_ORDER_PARAM |
Type : string
|
Default value : "_sortOrder"
|
| STALE_THRESHOLD_SECONDS |
Type : number
|
Default value : 60
|
|
A shown calculation older than this (seconds) is treated as stale/outdated. |
| STORED_BY_ID_DATATYPES |
Type : []
|
Default value : ["configurable-enum", "entity"]
|
|
datatypes whose value is stored as the referenced id alone |
| STRING_FILTER_DEBOUNCE_MS |
Type : number
|
Default value : 400
|
|
Delay (ms) before a changed search text is applied, so that typing does not trigger a filter update (and, for server-side data sources, a DB request) on every single keystroke. |
| TEST_USER |
Type : string
|
Default value : "demo"
|
| THRESHOLD_URGENT |
Type : number
|
Default value : 0.6
|
|
Thresholds for attendance percentage coloring. |
| THRESHOLD_WARNING |
Type : number
|
Default value : 0.8
|
| TODO_COMPLETED_FILTER |
Type : unknown
|
Default value : {
$and: [{ completed: { $exists: true } }, { completed: { $ne: null } }],
} as DataFilter<Todo>
|
|
Select Todo records that have been completed. |
| TYPED_HTTP_ERRORS |
Type : Record<HttpErrorClassification, { type: TypedError; message: string }>
|
Default value : {
connectivity: { type: ConnectivityError, message: "Failed to fetch from" },
"server-error": { type: ServerError, message: "Server error response from" },
"not-permitted": {
type: NotPermittedError,
message: "Request not permitted by",
},
"session-expired": {
type: SessionExpiredError,
message: "Session expired for request to",
},
"write-conflict": {
type: WriteConflictError,
message: "Write conflict response from",
},
}
|
|
The typed error of each classification, and its message. Static, as the
message of a classified error is its issue title and grouping key: the url
(with ids and query parameters, which may hold personal data) goes into the
error's |
| typedHttpErrorInterceptor |
Type : miscellaneous
|
Default value : (request, next) =>
isBackendRequest(request.url)
? next(request).pipe(
catchError((err) =>
from(withReadableBody(err)).pipe(
switchMap((failure) =>
throwError(() => toTypedHttpError(failure, request)),
),
),
),
)
: next(request)
|
|
Where failed responses of our own backend (the database and API proxies)
enter the app through Other failures (e.g. a 400 or 404 the caller handles) stay an |
| UNDO_DURATION_MS |
Type : number
|
Default value : 8000
|
|
how long the "Undo" action stays available after a permissions change |
| UNIQUE_PROPERTY_ERROR_KEY |
Type : miscellaneous
|
Default value : "uniqueProperty"
|
| UNMATCHABLE_DATATYPES |
Type : unknown
|
Default value : new Set([
"location",
"time-interval",
"event-attendance-map",
"attendance",
"schema-embed",
])
|
|
Datatypes whose value normalizeValue cannot reduce to a comparable string, so that selecting such a field could only ever produce zero matches. |
| USAGE_ANALYTICS_CONFIG_ID |
Type : string
|
Default value : "appConfig:usage-analytics"
|
| viewConfigs |
Type : ViewConfig[]
|
Default value : [
{
_id: "view:" + EmailTemplate.route,
component: "EntityList",
config: {
entityType: EmailTemplate.ENTITY_TYPE,
columns: ["subject", "body", "availableForEntityTypes", "category"],
} as EntityListConfig,
},
// Details View
{
_id: "view:" + EmailTemplate.route + "/:id",
component: "EntityDetails",
config: {
entityType: EmailTemplate.ENTITY_TYPE,
panels: [
{
components: [
{
component: "Form",
config: {
fieldGroups: [
{
fields: ["subject", "body"],
},
{
fields: ["availableForEntityTypes", "category"],
},
],
},
},
],
},
],
} as EntityDetailsConfig,
},
]
|
| warningLevels |
Type : Ordering.EnumValue[]
|
Default value : demoEnums.find(
(e) => e._id === "ConfigurableEnum:warning-levels",
).values
|