Index

src/app/core/import/additional-actions/additional-import-action.ts

AdditionalImportAction

Definition of an additional generic import action, e.g. linking imported records to an existing group entity.

AdditonalDirectLinkAction | AdditionalIndirectLinkAction

src/app/features/location/geo-location.ts

AddressWithCityFields
Partial<Record<typeof CITY_FIELDS['number'], string>>

src/app/features/public-form/public-form-linking.service.ts

ApplyPrefillFn

Callback type for applying prefill values to form fields

function

src/app/dynamic-components.ts

AsyncComponent
function
ComponentTuple
[string, AsyncComponent]

src/app/core/common-components/entity-form/dynamic-form-validators/validator-types.ts

AsyncPromiseValidatorFn
function

src/app/features/change-history/change-history-normalize.ts

AuditDelta

The part of an audit record that says which fields a single write touched. Narrower than RawAuditDoc so that an already-loaded AuditRecord can be passed just as well as a raw document.

Pick<RawAuditDoc | "operation" | "diff">

src/app/features/api-client/api-client.service.ts

BackendFeatureFlags

Feature flags from the backend's /actuator/features endpoint; sub-features are nested under their parent feature (e.g. admin.api-client).

Record<string & { enabled: boolean }> & literal type

src/app/features/change-history/change-history.types.ts

ChangeOperation
typeof CHANGE_OPERATIONS['number']

src/app/features/inherited-field/automated-field-update/change-set.ts

ChangeSetState

The state of the records: as saved before the change, or with the change and the suggested values

"before" | "after"

src/app/core/common-components/entity-form/FormConfig.ts

ColumnConfig

Type for the definition of a single column in the EntitySubrecord

string | FormFieldConfig

src/app/core/common-components/conditions-editor/conditions-combinator.ts

Combinator

How the rows of a condition combine: any one row ("or") or every row ("and") has to match.

"any" | "all"

src/app/core/basic-datatypes/configurable-enum/configurable-enum-ordering.ts

Config
Array<T & HasOrdinal>
EnumValue
T & HasOrdinal

src/app/core/config/config-migration.ts

ConfigMigration

A ConfigMigration is checked during a full JSON.parse using a reviver function. If the migration does not apply to the given configPart, make sure to return it unchanged. Multiple migrations are chained and can transform the same config part one after the other.

function

src/app/core/basic-datatypes/configurable-enum/configurable-enum.types.ts

ConfigurableEnumConfig

Interface specifying overall object representing an enum with all its options as stored in the config database

Array<T>

src/app/utils/test-utils/dialog-mocks.ts

ConfirmationDialogMock

Every prompt is optional except getConfirmation, so a spec that only needs that one can still keep a hand-built { getConfirmation: vi.fn() } - which matters because a bare vi.fn() resolves undefined ("the user cancelled"), while mockConfirmationDialog confirms by default. Those are different test setups, not two spellings of one.

literal type & Partial<Record<keyof Pick<ConfirmationDialogService, "getConfirmationWithKeyword" | "getDiscardConfirmation" | "showProgressDialog">, Mock>>
MatDialogMock
{ open: Mock }
MatDialogRefMock
{ close: Mock; afterClosed: Mock; updateSize: Mock; updatePosition: Mock }

src/app/core/database/pouchdb/pouch-database.ts

ConflictOutcome

What happened to a document whose update was rejected as a conflict (see PouchDatabase.resolveConflict).

"merged" | "overwritten" | "unresolved"

src/app/core/permissions/permission-types.ts

CrudAction
typeof CRUD_ACTIONS['number']
DatabaseRule

The format that the JSON defined rules need to have. In the JSON object the Entities can be specified by using their ENTITY_TYPE string representation.

RawRuleOf<MongoAbility<unknown>>
EntityActionPermission

The type which defines which actions can be used for permissions. The type allows all strings defined in the actions array. E.g. "read" or "manage"

typeof actions['number']
EntitySubject

The type which defines which subjects can be used for permissions. This matches any entity classes, entity objects and the wildcard string "all" E.g. Child, new Note() or all

EntityConstructor | Entity | string

src/app/core/dashboard/dashboard-widget/dashboard-widget.component.ts

DashboardTheme
"general" | "child" | "attendance" | "note" | "class" | "school"

src/app/core/filter/filters/filters.ts

DataFilter

This filter can be used to filter an array of entities. It has to follow the MongoDB Query Syntax ://www.mongodb.com/docs/manual/reference/operator/query/{@link https}.

The filter is parsed using ucast ://github.com/stalniy/ucast/tree/master/packages/mongo2jshttps

MongoQuery<T> | literal type

src/app/core/common-components/entities-table/data-source/data-source-registry.ts

DataSourceConstructor

A concrete data source class, created in an injection context by resolveDataSource.

unknown

src/app/core/basic-datatypes/date/date-range-filter/date-range-filter-panel/date-range-utils.ts

DateRangeOption

a predefined range offered next to the calendar of the DateRangeFilterPanelComponent

DateRangeFilterConfigOption | FixedDateRangeOption

src/app/core/default-values/default-value-service/default-value.service.ts

DefaultValueHint
FullDefaultValueHint | EmptyDefaultValueHint
NoCommonValueReason

Why linked records provide no value to inherit:

  • "conflict": they have different values
  • "unavailable": some of them could not be loaded (e.g. no permission to read them)
"conflict" | "unavailable"

src/app/core/default-values/default-value-config.ts

DefaultValueMode
"static" | "dynamic" | "inherited-field"

src/app/core/database/pouchdb/synced-pouch-database.ts

DeniedDoc

The part of the error in a PouchDB "denied" event that is logged.

{ id?: string; name?: string }
SyncResult
PouchDB.Replication.SyncResultComplete<any>

src/app/core/common-components/entity-form/dynamic-form-validators/form-validator-config.ts

DynamicValidator

Available validators that can be used to display errors to the user when a form is invalid

typeof DYNAMIC_VALIDATORS['number']
FormValidatorConfig

the validators config. This is an object where the key must be one of the DynamicValidators. The value to that key is specific to that validator. For example, the max validator requires a number while the pattern validator requires a string or regex. Compliant examples:

{
  min: 5,
  pattern: "[a-z]*",
}

The pattern validator alternatively supports an object form to display a custom error message when validation fails:

{
  pattern: { pattern: "[0-9]{10}", message: "Enter a 10-digit phone number" },
}

Non-compliant examples:

{
  min: "abc",
  rabbit: true
}
unknown & literal type

src/app/core/admin/admin-menu/menu-item-for-admin-ui.ts

EditableMenuItem

A menu item as edited in the Admin UI, where the label may be multi-lingual. The displayed MenuItem keeps label: string, because the navigation only receives config that ConfigService already resolved.

Omit<MenuItem & "label" | "subMenu"> & literal type

src/app/core/permissions/ability/entity-ability.ts

EntityAbilityTuple

The action and subject types this ability checks permissions for.

[EntityActionPermission, Subject]

src/app/core/entity-details/entity-actions-menu/entity-actions-menu.service.ts

EntityActionsFactory
function

src/app/core/entity-details/entity-actions-menu/entity-actions-grouping.ts

EntityActionsMenuEntry
literal type | literal type
GroupEntry
Extract<EntityActionsMenuEntry | { kind: group }>

src/app/core/entity/model/entity.ts

EntityConstructor

This represents a static class of type . It can be used for passing a class from which new objects should be created. It can also be used to check the ENTITY_TYPE of a class For example usage check the EntityMapperService.

unknown & unknown

src/app/core/common-components/entity-form/entity-form.ts

EntityFormGroup
TypedFormGroup<Partial<T>>
TypedFormGroup

These are utility types that allow to define the type of FormGroup the way it is returned by EntityFormService.create

FormGroup<ɵElement<T['K'] | >>

src/app/core/basic-datatypes/entity/entity-reference-role.ts

EntityReferenceRole

Specifies the role of an entity reference, seen from the entity containing the field, where "aggregate" = "has a" relationship where both entities have meaning independent of each other; "composite" = "part of" relationship where the entity containing this field should not exist without the referenced entity, so that deleting or anonymizing the referenced entity cascades to the entity containing this field.

Default is treated as "aggregate".

(role names following the UML association types)

"aggregate" | "composite"

src/app/core/entity/schema/entity-schema.ts

EntitySchema

Complete schema of an Entity containing multiple EntitySchemaFields.

This is generated from all @DatabaseField() of a class and then defines the transformation for that whole entity type.

Map<string | EntitySchemaField>
SchemaEmbeddedType

Constructor type for classes that have a static schema (via @DatabaseField() annotations) but don't necessarily extend Entity. This is used for embedded/nested schema objects like AttendanceItem or UpdateMetadata.

unknown & literal type

src/app/core/logging/error-classification.ts

ErrorClassification
typeof ERROR_CLASSIFICATIONS['number']

src/app/features/notification/notification.service.ts

FeatureFlags

Feature flags from the /actuator/features endpoint. Sub-features are nested under their parent feature (e.g. notification.email).

Record<string & FeatureFlag> & literal type

src/app/core/admin/admin-entity-details/admin-entity-form/admin-entity-form.component.ts

FieldDragDropEvent

A field dragged between the form's field groups and the toolbar of unused fields.

CdkDragDrop<FieldDropTarget | FieldDropTarget | ColumnConfig>
FieldDropTarget

Identifies one of the drop lists a field can be dragged between: the index of a field group in the form, or the toolbar of fields not used in the form.

number | "available"

src/app/core/default-values/x-dynamic-placeholder/dynamic-placeholder-value.service.ts

FieldValueGetter

returns the value that a placeholder refers to, in database format

function

src/app/core/export/download-service/download.service.ts

FileDownloadFormat
"csv" | "json" | "xlsx"

src/app/core/entity-list/EntityListConfig.ts

FilterConfig
BasicFilterConfig | BooleanFilterConfig | PrebuiltFilterConfig<T> | ConfigurableEnumFilterConfig<T>

src/app/core/database/pouchdb/find-queries.ts

FindPage

One page of results of a Mango query, with the bookmark to continue after it.

{ docs: any[]; bookmark?: string }

src/app/features/notification/firebase-messaging.service.ts

FirebaseSdk
Pick<typeof AppSdk & initializeApp> & Pick<typeof MessagingSdk & "isSupported" | "getMessaging" | "getToken" | "deleteToken" | "onMessage">

src/app/core/logging/logging-test-utils.ts

Frame

Fixtures for the specs of the remote monitoring (Sentry) processing.

{ function?: string; filename?: string }

src/app/core/database/database.ts

GetAllOptions

Basic database read options supported by Database.

also see https://pouchdb.com/api.html#fetch_document

PouchDB.Core.AllDocsWithKeyOptions | PouchDB.Core.AllDocsWithKeysOptions | PouchDB.Core.AllDocsWithinRangeOptions | PouchDB.Core.AllDocsOptions
GetOptions

Basic database read options supported by Database.

also see https://pouchdb.com/api.html#fetch_document

PouchDB.Core.GetOptions
QueryOptions

Basic query options supported by Database.

also see https://pouchdb.com/guides/queries.html

PouchDB.Query.Options<any | any>

src/app/core/admin/admin-role-permissions/permission-matrix/permission-matrix.component.ts

GrantedBy

Where an action is granted from, if not by an own rule of its row: the row's own "manage", the "all record types" row of this same role, or the shared "_default" role that applies to every logged-in user.

"manage" | "wildcard" | "default"

src/app/utils/typed-http-error.interceptor.ts

HttpErrorClassification
Exclude<ErrorClassification | local-storage>

src/app/core/import/import.service.ts

ImportFailureStage

The step of an import that failed although records had already been saved.

"records": the write of the imported records itself stopped partway. "links": all records were written and one of the additional link actions failed.

"records" | "links"

src/app/core/entity/entity-mapper/entity-relations.service.ts

IndexedProperty

the property of an entity that a reference index can be created for

Parameters

src/app/utils/media/screen-size-observer.service.ts

IsDesktop

A type that is used to document the return type of the platform observable. A variable that has this type shall only have two values that are encoded in a boolean way:

  • true: the variable represents that the width of something is considered 'desktop width'
  • false: the variable represents that the width of something is considered 'mobile width'
boolean

src/app/child-dev-project/notes/deprecated/legacy-note-fields.ts

LabelLanguage
typeof LABEL_LANGUAGES['number']

src/app/core/common-components/entities-table/data-source/entities-table-data-source.ts

LoadErrorCause

Why loading the records of a list failed, as named to the user.

"connection" | "sessionExpired" | "notPermitted"

src/app/features/location/map/map-properties-popup/map-properties-popup.component.ts

LocationProperties

A map of entity types and the (selected) location properties of this type

{ }

src/app/core/common-components/entities-table/entities-table-selection.ts

ModelSignal
ReadSignal<T> & literal type
ReadSignal
function

src/app/features/notification/model/notification-config.ts

NotificationChannel

Defines allowed notification channels.

Note: "push" is handled via individual device registrations and not part of this config currently.

unknown
NotificationType

Base type of notification rule.

unknown

src/app/features/location/geo.service.ts

OpenStreetMapsSearchResult
GeoResult & literal type

src/app/features/attendance/add-day-attendance/roll-call/roll-call-tab/roll-call-tab.component.ts

PositionState

These position states are used internally as animation states for the tab body. Setting the position state to left, right, or center will transition the tab body from its current position to its respective state. If there is no current position (void, in the case of a new tab body), then there will be no transition animation to its state.

In the case of a new tab body that should immediately be centered with an animating transition, then left-origin-center or right-origin-center can be used, which will use left or right as its pseudo-prior state.

"left" | "center" | "right"

src/app/core/config/multi-lingual-config.ts

RawConfig

Config as it is stored, before it is resolved to the active language: every display text may also be a per-language map. Matched by property name only, so a title holding e.g. a field id is widened too.

Use for config read in order to save it back, so that code treating such a text as a plain string is flagged.

unknown
RawText
unknown
TranslatableText

A config text that may be a plain string or a per-locale translation map.

string | Record<string | string>
TranslatableTextProperty

Names of the config properties that hold a user-facing text.

"label" | "labelShort" | "labelPlural" | "description" | "title" | "header"

src/app/core/database/pouchdb/database-exception.ts

RawDatabaseError
{ status?: unknown; name?: unknown; message?: unknown; reason?: unknown; error?: unknown }

src/app/core/common-components/entities-table/entities-table-sort.store.ts

ReadSignal
function

src/app/features/reporting/report-config.ts

ReportEntity

Union type to enable type safety for report configs. Use this instead of the {@class ReportConfig}

AggregationReport | ExportingReport | SqlReport

src/app/core/admin/admin-role-permissions/permission-matrix.ts

RuleConditions

CASL mongo-query conditions restricting a permission, as stored on a rule

DatabaseRule
RuleExtraProperties

Properties of a rule beyond subject/action/conditions (e.g. reason) that the matrix does not model directly but preserves verbatim.

Record<string | unknown>

src/app/core/basic-datatypes/schema-embed/schema-embed-array-entry-dialog/schema-embed-array-entry-dialog.component.ts

SchemaEmbedArrayApplyChange

Apply the change of a single entry of a schema-embed-array field to its latest entries (see applySchemaEmbedArrayEntryChange), e.g. by saving the entity or by setting the value of the field's form control.

Throw an error to keep the popup open (its message is displayed to the user).

function

src/app/core/basic-datatypes/schema-embed/schema-embed-array-entry-change.ts

SchemaEmbedArrayEntryChange

A change of a single entry of a schema-embed-array field, as made in its popup.

It only describes the edited entry (not the whole list of entries), so that it can be applied to the latest entries when saving, which may have been updated since the popup opened (e.g. by a sync).

literal type | literal type

src/app/core/user/user-admin-service/user-account-action-guard.service.ts

SelfAccountAction
"delete" | "deactivate"

src/app/core/admin/setup-wizard/setup-wizard.service.ts

SetupWizardState

"unavailable" means this system has no wizard configured, as opposed to "error" where we simply could not load it.

"loading" | "loaded" | "unavailable" | "error"

src/app/child-dev-project/children/demo-data-generators/aser/skill-levels.ts

SkillLevel
Ordering.EnumValue & literal type

src/app/core/common-components/entities-table/table-sort/table-sort.ts

SortValueFns

Map of column id to a function that derives the value used for sorting that column. Each function receives the raw column value and the full record, and returns a comparable value or undefined to fall back to default sorting in tableSort.

Record<string | number | string | undefined>

src/app/features/reporting/sql-report/sqs-schema.ts

SqlOptions
{ table_name: { operation: prefix; field: string; separator: string } }
SqlTables
{ }
SqlType
"TEXT" | "INTEGER" | "REAL"

src/app/features/inherited-field/automated-field-update/affected-entities-calculation.ts

Suggestion

The suggested update of an affected entity, before it is known on which path(s) and level the entity is reached

Omit<AffectedEntity | "level" | "via" | "sourceFieldId">

src/app/core/common-components/parsed-file-input/parsed-file-input.component.ts

SupportedFileType

File extensions accepted by the parsed-file input component.

"csv" | "json" | "xlsx"

src/app/core/database/multi-tab-detection.service.ts

TabChannelMessage
{ type: "hello" | "ping" | "goodbye" | "reload"; tabId: string }

src/app/utils/test-utils/vitest-proxy-zone-compat.ts

TestFunction
function

src/app/features/reporting/edit-report-period-toggle/edit-report-period-toggle.component.ts

Transformations
{ }

src/app/core/common-components/entity-form/dynamic-form-validators/dynamic-validators.service.ts

ValidatorOptions
FormControlOptions & literal type

results matching ""

    No results matching ""