| addAlphaToHexColor | |||||||||
addAlphaToHexColor(color: unknown, opacity: unknown)
|
|||||||||
|
Parameters :
|
| addPropertySchema | ||||||||||||
addPropertySchema(target: unknown, propertyName: string, propertySchema: EntitySchemaField)
|
||||||||||||
|
Parameters :
|
| DatabaseField | ||||||||||
DatabaseField(propertySchema: EntitySchemaField)
|
||||||||||
|
Decorator (Annotation also see
Parameters :
|
| getEntitySchema | ||||||
getEntitySchema(ctor: unknown)
|
||||||
|
Returns the schema map of this entity (not the superclass). Creates and assigns a new one if it doesn't exist yet.
Parameters :
Returns :
EntitySchema
|
| addToGroup | ||||||||||||
addToGroup(allGroups: unknown, currentValue: unknown, currentElement: unknown)
|
||||||||||||
|
Parameters :
|
| calculateAge | ||||||
calculateAge(dateOfBirth: Date)
|
||||||
|
Parameters :
Returns :
number
|
| compareEnums | |||||||||
compareEnums(a: ConfigurableEnumValue, b: ConfigurableEnumValue)
|
|||||||||
|
Parameters :
Returns :
boolean
|
| dateToString | ||||||
dateToString(value: Date)
|
||||||
|
Parameters :
|
| equals | |||||||||
equals(a: unknown, b: unknown)
|
|||||||||
|
Comparing two values for equality that might be different than just object equality
Parameters :
Returns :
boolean
|
| getParentUrl | ||||||
getParentUrl(router: Router)
|
||||||
|
Parameters :
Returns :
string
|
| getUrlWithoutParams | ||||||
getUrlWithoutParams(router: Router)
|
||||||
|
Parameters :
Returns :
string
|
| isValidDate | ||||||
isValidDate(date: any)
|
||||||
|
Parameters :
Returns :
boolean
|
| readFile | ||||||
readFile(file: Blob)
|
||||||
|
Parameters :
Returns :
Promise<string>
|
| readFileAsArrayBuffer | ||||||
readFileAsArrayBuffer(file: Blob)
|
||||||
|
Read the contents of a Blob into an
Parameters :
Returns :
Promise<ArrayBuffer>
|
| serviceProvider | |||||||||
serviceProvider(service, factory)
|
|||||||||
|
This is a simple shorthand function to create factories for services. The use case is, when multiple services extend the same class and one of these services will be provided.
Parameters :
Returns :
FactoryProvider
|
| sortByAttribute | |||||||||
sortByAttribute(attribute, order)
|
|||||||||
|
Parameters :
Returns :
number
|
| addTooltip | ||||||
addTooltip(profile: ExternalProfile)
|
||||||
|
Parameters :
Returns :
unknown
|
| applyConfigMigrations | ||||||
applyConfigMigrations(doc: E)
|
||||||
|
Apply all config migrations to a plain JSON document. Returns the migrated document as a plain object (no Angular entity re-hydration). Used by the admin CLI; ConfigService wraps this and also applies defaultConfigs.
Parameters :
Returns :
E
|
| rewriteNavMenuLinks |
rewriteNavMenuLinks(items, oldLink: string, newLink: string)
|
|
Returns :
any[]
|
| applyOnlineOnlyPreference |
applyOnlineOnlyPreference()
|
|
If the user previously opted into online-only mode, override session_type early so that database instances are created with the correct type from the start. This MUST run before Angular bootstraps, because DatabaseFactoryService reads environment.session_type the first time a database is lazily accessed (during Angular DI startup, before LoginComponent even exists). If we waited until LoginComponent ran, the wrong DB class would already have been instantiated. The flow is:
See also: LoginComponent.applyOnlineOnlyMode() and ONLINE_ONLY_KEY. |
| applyPublicFormSession |
applyPublicFormSession()
|
|
Force online-only mode when bootstrapping a public-form route, so the database factory creates a RemotePouchDatabase from the first lazy access rather than a SyncedPouchDatabase that would never be initialized. |
| initConfigJsonToEnvironment |
initConfigJsonToEnvironment()
|
|
Load basic config values from assets/keycloak.json into environment |
| initEnvironmentConfig |
initEnvironmentConfig()
|
|
Overwrite environment settings with the settings from the |
| initFirebaseConfigToEnvironment |
initFirebaseConfigToEnvironment()
|
|
Load Push Notifications config for Firebase. Please add assets/firebase-config.json with your own Firebase config |
| initKeycloakConfigToEnvironment |
initKeycloakConfigToEnvironment()
|
|
Load Keycloak server URL from assets/keycloak.json into environment |
| isPublicFormRoute |
isPublicFormRoute()
|
|
Returns :
boolean
|
| applyRangeSelection | |||||||||||||||
applyRangeSelection(selectedRecords, selectedRows, range, shouldCheck: boolean)
|
|||||||||||||||
|
Applies a contiguous shift-selection update over a row index range.
Parameters :
Returns :
T[]
|
| isCheckboxTarget | ||||
isCheckboxTarget(target)
|
||||
|
Detects whether the click originated from a checkbox input.
Parameters :
Returns :
boolean
|
| isClickableTarget | ||||
isClickableTarget(target)
|
||||
|
Detects whether the click target is inside an element marked as
Parameters :
Returns :
boolean
|
| shouldSkipRowInteraction | |||||||||
shouldSkipRowInteraction(target, row: TableRow)
|
|||||||||
|
Determines whether row-click handling should be skipped for this interaction.
Parameters :
Returns :
boolean
|
| toggleRecordSelection | ||||||||||||
toggleRecordSelection(selectedRecords, record: T, checked: boolean)
|
||||||||||||
|
Adds or removes a single record from the selected records collection.
Parameters :
Returns :
T[]
|
| updateSelectionFromMouseDown | ||||||
updateSelectionFromMouseDown(input: MouseSelectionInput)
|
||||||
|
Computes the next selection state for a row
Parameters :
Returns :
MouseSelectionUpdate<T>
|
| applySortingRules | ||||||
applySortingRules(columns, getDatatypeOrDefault)
|
||||||
|
Applies sorting rules to columns: disables sorting for entity references, untyped columns, and arrays (unless the datatype provides custom sort logic).
Parameters :
Returns :
FormFieldConfig[]
|
| inferDefaultSort | ||||||||
inferDefaultSort(colsToDisplay, columns, getDatatypeOrDefault)
|
||||||||
|
Infers a stable default sort from visible sortable columns. Date-like columns default to descending order.
Parameters :
Returns :
Sort | undefined
|
| resolveAgeSourceField | ||||||
resolveAgeSourceField(column: FormFieldConfig)
|
||||||
|
Resolve the source field for virtual These columns display an age from another field, e.g.
Parameters :
Returns :
string | undefined
|
| applyTextToCreatedEntity |
applyTextToCreatedEntity(entity: Entity, input: string)
|
|
Update the given entity by applying the text entered by a user to the most likely appropriate entity field, inferred from the toString representation. |
| applyUpdate | ||||||||||||||||||||
applyUpdate(entities, next: UpdatedEntity, addIfMissing: boolean)
|
||||||||||||||||||||
|
Updates a list of entities given an updated version of the entity. This updated version can either be a new entity (that should be inserted into the list), or an existing entity that should be updated or deleted. The given array will not be mutated but will be returned when the given new entity or type is illegal
Parameters :
Returns :
T[]
An array of the given entities with the update applied |
| asArray | ||||
asArray(x)
|
||||
|
Convert wrap a value in an array if it is not already an array.
Parameters :
Returns :
T[]
|
| bootstrap |
bootstrap()
|
| buildEntityBasePaths | ||||||
buildEntityBasePaths(data: Record)
|
||||||
|
Parameters :
Returns :
Set<string>
|
| migrateNavMenuItem | |||||||||
migrateNavMenuItem(item: any, data: Record)
|
|||||||||
|
Parameters :
Returns :
any
|
| migrateNavMenuItems | |||||||||
migrateNavMenuItems(items, data: Record)
|
|||||||||
|
Parameters :
Returns :
any[]
|
| migrateShortcutItem | |||||||||
migrateShortcutItem(item: any, entityBasePaths: Set)
|
|||||||||
|
Parameters :
Returns :
any
|
| buildExportColumnResolvers | ||||||||||||||||||||
buildExportColumnResolvers(schema: Map, entitySchemaService: EntitySchemaService, useFieldIdAsFallbackLabel: unknown)
|
||||||||||||||||||||
|
Build export column resolvers for all fields in a schema. Iterates the schema, looks up each field's datatype, and collects
the columns the datatype contributes via
Parameters :
Returns :
ExportColumnResolver[]
|
| buildMatchingSideConfig | ||||||||||||||||
buildMatchingSideConfig(side: MatchingSideConfig, columns, sideIndex: number)
|
||||||||||||||||
|
Create a MatchingSideConfig object and fill it with columns from comparison array if necessary
Parameters :
Returns :
MatchingSideConfig
|
| buildReadonlyValidator | ||||||
buildReadonlyValidator(entity: Entity)
|
||||||
|
Validator to ensure a field becomes readonly after it has been saved once.
Parameters :
Returns :
literal type
|
| calculateDateRange | ||||||
calculateDateRange(dateRangeOption: DateRangeFilterConfigOption)
|
||||||
|
Parameters :
Returns :
DateRange<Date>
|
| callbackIndex | ||||
callbackIndex(args)
|
||||
|
Parameters :
Returns :
number | null
|
| enableVitestProxyZoneCompat |
enableVitestProxyZoneCompat()
|
|
Returns :
void
|
| isFunction | ||||
isFunction(value)
|
||||
|
Wraps Vitest lifecycle and test callbacks in Angular's ProxyZone when it is available. Angular test utilities such as
Parameters :
Returns :
TestFunction
|
| patchCallable | |||||||||
patchCallable(target: Record, key: string)
|
|||||||||
|
Parameters :
Returns :
void
|
| wrapWithProxyZone | ||||||
wrapWithProxyZone(fn: TestFunction)
|
||||||
|
Parameters :
Returns :
TestFunction
|
| cleanUpTemporarySchemaFields |
cleanUpTemporarySchemaFields()
|
|
Helper function to remove custom schema fields from Entity that have been created using getDefaultInheritedForm(). |
| getDefaultInheritedForm | ||||||
getDefaultInheritedForm(additionalSchemaConfig)
|
||||||
|
Helper function to add some custom schema fields to Entity for testing. Use in combination with a call to cleanUpTemporarySchemaFields() in afterEach.
Parameters :
Returns :
EntityForm<any>
|
| testDefaultValueCase | ||||||||||||
testDefaultValueCase(service: DefaultValueService, fieldSchema: EntitySchemaField, expected: any)
|
||||||||||||
|
Parameters :
|
| closeOnlySubmenu | |||||||||
closeOnlySubmenu(menu: MatMenuTrigger, event: MouseEvent)
|
|||||||||
|
Close the mat-menu of the given menu trigger and stop propagation of the event to avoid closing parent menus as well.
Parameters :
|
| compareDates |
compareDates(a: Date, b: string)
|
|
Compare dates at day precision
Returns :
"1" | unknown | "0"
|
| extendedCompare | |||||||||
extendedCompare(a: T, b: T)
|
|||||||||
|
Handles special cases like ConfigurableEnum objects and Dates. Used for filter evaluation and conditional color matching. This utility is kept separate to avoid circular dependencies between Entity and FilterService.
Parameters :
Returns :
"1" | unknown | "0"
-1 if a < b, 0 if a === b, 1 if a > b |
| compareValues | |||||||||
compareValues(a: unknown, b: unknown)
|
|||||||||
|
Parameters :
|
| getComparableValue | ||||||||||||
getComparableValue(obj: OBJECT, key: PROPERTY, sortValueFns?: SortValueFns)
|
||||||||||||
|
Parameters :
Returns :
number | string | Symbol
|
| tableSort | ||||||||||||||||||||
tableSort(data, __namedParameters: {direction: "asc" | "desc" | string, active: PROPERTY | string, sortValueFns: SortValueFns<OBJECT>})
|
||||||||||||||||||||
|
Custom sort implementation for a MatTableDataSource<TableRow
Parameters :
Returns :
TableRow[]
the sorted table rows |
| computeDbNames | ||||||
computeDbNames(session: SessionInfo)
|
||||||
|
Compute new-format database names (using Keycloak UUID + dash separator). Used after migration to the "indexeddb" adapter.
Parameters :
Returns :
literal type
|
| computeLegacyDbNames | ||||||
computeLegacyDbNames(session: SessionInfo)
|
||||||
|
Compute legacy-format database names (username for app, underscore for notifications). Used with the old "idb" adapter before migration.
Parameters :
Returns :
literal type
|
| convertToMomentFormat | ||||||
convertToMomentFormat(angularFormat: string)
|
||||||
|
Converts an Angular DatePipe format string to the equivalent Moment.js format string. Angular uses lowercase tokens (dd, yyyy), Moment.js uses uppercase (DD, YYYY). Exported for testing only.
Parameters :
Returns :
string
|
| setGlobalDateFormat | ||||||||
setGlobalDateFormat(format: string)
|
||||||||
|
Set the global date format at runtime based on configuration. This is called by SiteSettingsService during initialization.
Parameters :
Returns :
void
|
| createAgeComparisonValidator | ||||||||||||||||||
createAgeComparisonValidator(ageParamValue, comparator, errorKey: string, paramName, rangeConfig?)
|
||||||||||||||||||
|
Creates an age range validator (min or max age).
Parameters :
Returns :
ValidatorFn
|
| descriptionForAgeValidator | |||||||||
descriptionForAgeValidator(validator, validationValue: any)
|
|||||||||
|
Parameters :
Returns :
string
|
| maxAgeValidator | ||||||
maxAgeValidator(maxAgeValue, minAgeValue?)
|
||||||
|
Validator for maximum age.
Parameters :
Returns :
ValidatorFn
|
| minAgeValidator | ||||||
minAgeValidator(minAgeValue, maxAgeValue?)
|
||||||
|
Validator for minimum age.
Parameters :
Returns :
ValidatorFn
|
| createColoredDivIcon | ||||||||
createColoredDivIcon(color: string)
|
||||||||
|
Creates a custom colored marker icon using Leaflet's DivIcon. This approach ensures accurate color representation for all colors, overcoming the limitations of the hue-rotate filter which cannot properly handle achromatic colors or accurately represent all RGB values.
Parameters :
Returns :
L.DivIcon
Leaflet DivIcon with the specified color |
| getKmDistance | |||||||||
getKmDistance(x: Coordinates, y: Coordinates)
|
|||||||||
|
Calculate distance between two points Source ://henry-rossiter.medium.com/calculating-distance-between-geographic-coordinates-with-javascript-5f3097b61898https
Parameters :
|
| getLocationProperties | ||||||
getLocationProperties(entity: EntityConstructor)
|
||||||
|
Get all properties of an entity that represent a geographic location
Parameters :
|
| getMinDistanceKm | ||||||||||||
getMinDistanceKm(entity: Entity, coordinatesProperties, compareCoordinates)
|
||||||||||||
|
Calculate the minimum distance (km) between an entity's location fields and a list of comparison coordinates. Returns null if no distance can be computed.
Parameters :
Returns :
number | null
|
| createDateComparisonValidator | |||||||||||||||
createDateComparisonValidator(dateParamValue, comparator, errorKey: string, paramName)
|
|||||||||||||||
|
Creates a date range validator (min or max).
Parameters :
Returns :
ValidatorFn
|
| descriptionForDateValidator | |||||||||
descriptionForDateValidator(validator, validationValue: any)
|
|||||||||
|
Parameters :
Returns :
string
|
| formatDateAsDayMonthYear | ||||||
formatDateAsDayMonthYear(value: Date)
|
||||||
|
Parameters :
Returns :
string
|
| maxDateValidator | ||||
maxDateValidator(maxDateValue)
|
||||
|
Validator for maximum date.
Parameters :
Returns :
ValidatorFn
|
| minDateValidator | ||||
minDateValidator(minDateValue)
|
||||
|
Validator for minimum date.
Parameters :
Returns :
ValidatorFn
|
| normalizeDateOnly | ||||||
normalizeDateOnly(value: Date)
|
||||||
|
Normalizes a date to just the date portion (no time).
Parameters :
Returns :
Date
|
| parseToDate | ||||
parseToDate(value)
|
||||
|
Parses a value to a Date object. Handles Date objects, date strings (YYYY-MM-DD), timestamps, and special value "$now".
Parameters :
Returns :
Date | undefined
|
| createEmptyValueFilter | ||||||||||||||||
createEmptyValueFilter(fieldName: string, includeNestedId: unknown, includeEmptyArray: unknown)
|
||||||||||||||||
|
Parameters :
Returns :
DataFilter<T>
|
| createEntityMapperSpyObj |
createEntityMapperSpyObj()
|
| mockEntityMapperProvider | |||||||||
mockEntityMapperProvider(withData, customDatabaseResolverService)
|
|||||||||
|
Parameters :
Returns :
Provider[]
|
| createEntityOfType |
createEntityOfType(type: string, id: string)
|
|
"Simulate" a custom entity type that saves all fields without transformations through a mocked EntitySchema. This is a utility function to help demo data creation because the dynamically migrated config is not ready at the time of demo data generation yet.
Returns :
unknown
|
| createSkillApiDummyData | ||||||
createSkillApiDummyData(externalId: string)
|
||||||
|
Parameters :
Returns :
ExternalProfile
|
| CustomYesNoButtons |
CustomYesNoButtons(yesLabel: string, noLabel: string)
|
|
Returns :
ConfirmationDialogButton[]
|
| DatabaseEntity | ||||||||
DatabaseEntity(entityType: string)
|
||||||||
|
Decorator (Annotation also see
Parameters :
|
| emailValidatorWithMessage | ||||||
emailValidatorWithMessage(control: AbstractControl)
|
||||||
|
Parameters :
Returns :
ValidationErrors | null
|
| enhanceSentryBreadcrumb | |||||||||
enhanceSentryBreadcrumb(breadcrumb, hint: SentryBreadcrumbHint)
|
|||||||||
|
Add more human-readable descriptions to Sentry breadcrumbs for debugging. see https://docs.sentry.io/platforms/javascript/enriching-events/breadcrumbs/
Parameters :
|
| enrichSentryEvent | ||||||
enrichSentryEvent(event, hint)
|
||||||
|
Sentry
Parameters :
Returns :
Sentry.ErrorEvent | null
|
| enrichGeoLocation | ||||
enrichGeoLocation(location)
|
||||
|
Parameters :
Returns :
GeoLocation | undefined
|
| entityFilterPredicate |
entityFilterPredicate(data: Entity, filter: string)
|
|
Returns :
boolean
|
| errorToText | ||||
errorToText(error)
|
||||
|
Parameters :
Returns :
string
|
| isKnownMultiTabDatabaseCorruption | ||||
isKnownMultiTabDatabaseCorruption(error)
|
||||
|
Detect IndexedDB/PouchDB corruption symptoms commonly observed when the app is used in multiple tabs with concurrent writes. We intentionally match on
Parameters :
Returns :
boolean
|
| expectArrayWithExactContents | ||||||
expectArrayWithExactContents(actual, expected)
|
||||||
|
Assert that two arrays contain the same items, regardless of order, while
still supporting asymmetric matchers such as
Parameters :
Returns :
void
|
| matches | ||||||
matches(actual, expected)
|
||||||
|
Parameters :
Returns :
boolean
|
| extractGroupId | ||||||
extractGroupId(group: any)
|
||||||
|
Extract a group ID from a group value (string, object, etc.)
Parameters :
Returns :
string
|
| extractHumanReadableLabel | ||||
extractHumanReadableLabel(value)
|
||||
|
Get a human-readable string from the given value as a label.
Parameters :
Returns :
string | undefined
|
| extractNumericParts | ||||||
extractNumericParts(version: string)
|
||||||
|
Parameters :
Returns :
number[]
|
| isVersionNewer |
isVersionNewer(leftVersion: string, rightVersion: string)
|
|
Returns true when The comparison is based on numeric segments to avoid lexicographic issues, e.g. 9.0.0 < 10.0.0.
Returns :
boolean
|
| extractParticipantIds | ||||
extractParticipantIds(value)
|
||||
|
Normalize participant sources into plain participant IDs. Supports both configured participants field shapes used in attendance:
Parameters :
Returns :
string[]
|
| fetchTranslations | ||||||
fetchTranslations(locale: string)
|
||||||
|
Parameters :
Returns :
Promise<Record | undefined>
|
| initLanguage | ||||||||
initLanguage(locale?: string)
|
||||||||
|
Load translation files and apply them to angular localize system.
Parameters :
Returns :
Promise<void>
|
| fieldsIncludingId | ||||||||||||||||
fieldsIncludingId(entity: Entity, refId: string, relevantFields)
|
||||||||||||||||
|
Return the fields of entity that contain the given refId. If there is no such referenced ID, the array will be empty.
Parameters :
Returns :
FormFieldConfig[]
|
| getInnerEntityReferenceFields | ||||||
getInnerEntityReferenceFields(field?: EntitySchemaField)
|
||||||
|
From a field's Returns an empty array when the field has no embedded schema.
Parameters :
Returns :
unknown[]
|
| itemReferencesId | ||||||||||||
itemReferencesId(item: any, refId: string, field?: EntitySchemaField)
|
||||||||||||
|
Check whether a single value (a plain ID string or an embedded object) references the given entity ID. When a
Parameters :
Returns :
boolean
|
| generateActivity | ||||||||||||||||||||
generateActivity(__namedParameters: {participants: Entity[], assignedUser: Entity, title: string, entityType: string})
|
||||||||||||||||||||
|
Parameters :
Returns :
ActivityEntity
|
| generateChild | ||||||
generateChild(opts)
|
||||||
|
Parameters :
Returns :
unknown
|
| generateDefaultNotificationConfig |
generateDefaultNotificationConfig(userId: string, userEntity: string)
|
| generateFormFieldStory | ||||||||||||||||||||||||||||||
generateFormFieldStory(editComponent: unknown, defaultValue: unknown, withTooltip: unknown, additionalSchema: object, additionalProviders: [])
|
||||||||||||||||||||||||||||||
|
Parameters :
Returns :
literal type
|
| generateGroupNote | ||||
generateGroupNote(params)
|
||||
|
Parameters :
|
| generateNote | ||||
generateNote(params)
|
||||
|
Parameters :
Returns :
Note
|
| generateNotes | ||||
generateNotes(params)
|
||||
|
Parameters :
Returns :
Note[]
|
| removeFollowUpMarkerForOldNotes | ||||||
removeFollowUpMarkerForOldNotes(note: Note)
|
||||||
|
Set all older notes to be "resolved" in order to keep the list of notes needing follow-up limited in the demo.
Parameters :
|
| generateIdFromLabel | ||||||||
generateIdFromLabel(label: string)
|
||||||||
|
Create a simplified id string from the given text. This generates a camelCase string, removing special characters.
Parameters :
Returns :
string | undefined
|
| generateLabelFromInterval | ||||||
generateLabelFromInterval(interval: TimeInterval)
|
||||||
|
Parameters :
|
| generateTodo |
generateTodo(__namedParameters: {entity: Entity, assignedTo: Entity[], isDue: boolean})
|
|
Returns :
Todo
|
| generateTodos | ||||
generateTodos(params)
|
||||
|
Parameters :
Returns :
Todo[]
|
| generateUsers |
generateUsers()
|
|
Returns :
Array<unknown>
|
| getConfigsForInheritedMode | ||||
getConfigsForInheritedMode(fieldConfigs)
|
||||
|
Get the default value configs filtered for the given mode.
Parameters :
|
| getDefaultConfigEntity | ||||||||
getDefaultConfigEntity(configsObject: any)
|
||||||||
|
Parameters :
|
| provideTestingConfigService | ||||||||
provideTestingConfigService(configsObject: any)
|
||||||||
|
Parameters :
|
| getDefaultEnumEntities |
getDefaultEnumEntities()
|
|
Returns :
ConfigurableEnum[]
|
| getDefaultNoteDetailsConfig |
getDefaultNoteDetailsConfig()
|
|
Default configuration for Note Details.
Returns :
NoteDetailsConfig
|
| getEntityRuntimeDetailsRoutePath | ||||||
getEntityRuntimeDetailsRoutePath(entityType: EntityConstructor)
|
||||||
|
Parameters :
Returns :
string
|
| getEntityRuntimeRoute | ||||||
getEntityRuntimeRoute(entityType: EntityConstructor)
|
||||||
|
Parameters :
Returns :
string
|
| getEntityRuntimePath | ||||||
getEntityRuntimePath(path: string)
|
||||||
|
Build the canonical runtime path for config-driven entity routes.
Parameters :
Returns :
string
|
| getRuntimePathFromViewConfig | ||||||
getRuntimePathFromViewConfig(view: ViewConfig)
|
||||||
|
Resolve the effective route path for a view config at runtime.
Entity views are always placed under
Parameters :
Returns :
string
|
| getViewPathFromConfigId | ||||||
getViewPathFromConfigId(viewConfigId: string)
|
||||||
|
Convert a
Parameters :
Returns :
string
|
| isEntityViewConfig | ||||||
isEntityViewConfig(view: ViewConfig)
|
||||||
|
Heuristic to identify config views that represent entity navigation. Includes views with an explicit entityType config and detail views (path ending with /:id).
Parameters :
Returns :
boolean
|
| normalizeRoutePath | ||||||
normalizeRoutePath(path: string)
|
||||||
|
Normalize a route path for internal comparisons. Removes a single leading slash and keeps nested segments unchanged.
Parameters :
Returns :
string
|
| getGroupingInformationString | ||||
getGroupingInformationString(groupedBy)
|
||||
|
Parameters :
Returns :
string
|
| getValueDescription |
getValueDescription(value: any, property: string)
|
|
Returns :
string
|
| getInheritanceSourceReferenceFields | ||||||
getInheritanceSourceReferenceFields(entityCtor?: EntityConstructor)
|
||||||
|
Shared helper for import warnings related to inherited fields. It centralizes detection of source-reference fields used by inherited-field defaults so mapping dialogs and import summary can show consistent hints without duplicating schema-scanning logic.
Parameters :
Returns :
Set<string>
|
| hasMappedInheritedSourceField | |||||||||
hasMappedInheritedSourceField(entityCtor: EntityConstructor, columnMappings)
|
|||||||||
|
Parameters :
Returns :
boolean
|
| isInheritanceSourceReferenceField | |||||||||
isInheritanceSourceReferenceField(entityCtor: EntityConstructor, propertyName?: string)
|
|||||||||
|
Parameters :
Returns :
boolean
|
| getReadableValue | ||||||||
getReadableValue(value: any)
|
||||||||
|
An enhanced sortingDataAccessor function that can be set for a MatTableDataSource in order to support sorting by ConfigurableEnum columns and other Entity specific values.
Parameters :
Returns :
any
|
| isConfigurableEnum | ||||||
isConfigurableEnum(value: any)
|
||||||
|
Parameters :
Returns :
ConfigurableEnumValue
|
| isGeoLocation | ||||||
isGeoLocation(value: any)
|
||||||
|
Parameters :
Returns :
GeoLocation
|
| transformToReadableFormat | ||||||
transformToReadableFormat(obj: any)
|
||||||
|
Transform a whole object into a readable format.
This also transforms date objects to
Parameters :
|
| getWarningLevelColor | ||||||
getWarningLevelColor(warningLevel: WarningLevel)
|
||||||
|
Parameters :
|
| hasNoLinkAndNoSubItems | ||||||
hasNoLinkAndNoSubItems(item: MenuItemForAdminUi)
|
||||||
|
True when an item has no destination link and also no nested sub-items.
Parameters :
Returns :
boolean
|
| isManualItemWithoutLink | ||||
isManualItemWithoutLink(item)
|
||||
|
True when an item is in manual mode (no entity type) and no link has been set.
Parameters :
Returns :
boolean
|
| hasOrdinalValue | ||||||
hasOrdinalValue(value: any)
|
||||||
|
Parameters :
Returns :
HasOrdinal
|
| imposeTotalOrdering | ||||||||
imposeTotalOrdering(values: Array)
|
||||||||
|
Extends an array of configurable enum values with an ordinal value so that the ordinal value of each enum value matches the position of the element in the array. Note that this should be used 'early' in the pipeline, i.e. when the
Parameters :
Returns :
Array<EnumValue<T>>
|
| hasRemoteSession | ||||||
hasRemoteSession(sessionType: SessionType)
|
||||||
|
Check whether the given session type has a remote server connection. This is true for both "synced" (local+remote) and "online" (remote-only) modes.
Parameters :
Returns :
boolean
|
| isConnectivityError | ||||||
isConnectivityError(err: any)
|
||||||
|
Check whether an error represents a transient network/connectivity failure. Matches common browser fetch errors, timeout errors, and HTTP 5xx gateway errors. Callers can layer additional domain-specific checks on top.
Parameters :
Returns :
boolean
|
| isDuplicate | ||||||||||||
isDuplicate(currentValue, existingValues, shouldNormalize: boolean)
|
||||||||||||
|
Parameters :
Returns :
boolean
|
| normalizeValue | ||||
normalizeValue(value)
|
||||
|
Parameters :
Returns :
unknown
|
| uniquePropertyValidator | ||||||||
uniquePropertyValidator(config: UniquePropertyValidatorConfig)
|
||||||||
|
Generic validator to ensure a property value is unique within a collection. Can be configured to validate different properties (id, label, etc.) with optional normalization.
Parameters :
Returns :
AsyncPromiseValidatorFn
An async validator function |
| isHierarchicalReport | ||||
isHierarchicalReport(report)
|
||||
|
Whether a report's results should be rendered as a hierarchical group/count
table ( Derived purely from the canonical config structure (no version flag):
a report is hierarchical when its
Parameters :
Returns :
boolean
|
| isRetryableNetworkError | ||||||
isRetryableNetworkError(err: any)
|
||||||
|
Check whether an error is a retryable network/connectivity error, including keycloak-specific transient failures.
Parameters :
Returns :
boolean
|
| migrateIsoDatesToInferredDateOnly | ||||||
migrateIsoDatesToInferredDateOnly(value: string)
|
||||||
|
Parameters :
Returns :
string
|
| migratePublicFormConfig | ||||||
migratePublicFormConfig(formConfig: PublicFormConfig)
|
||||||
|
Parameters :
Returns :
PublicFormConfig
|
| normalizeCellValue | ||||
normalizeCellValue(value)
|
||||
|
Unwraps exceljs's rich cell value shapes (e.g. hyperlinks expose
Parameters :
Returns :
unknown
|
| normalizeEntityAdditional | ||||
normalizeEntityAdditional(additional)
|
||||
|
Normalizes the
Parameters :
Returns :
EntityAdditional | undefined
|
| normalizeValue | ||||||||
normalizeValue(val: any)
|
||||||||
|
Normalizes a value for comparison, converting it to a standardized string format. Ensures both numbers and strings are treated consistently.
Parameters :
Returns :
string
The normalized value as a string. |
| normalizeQueryKey | ||||||
normalizeQueryKey(query: string)
|
||||||
|
Normalize a query key used in export column configs. Strips a leading dot if present so callers can compare logical field keys.
Parameters :
Returns :
string
|
| parseJwt | ||||||||
parseJwt(token: unknown)
|
||||||||
|
Parses and returns the payload of a JWT into a JSON object. For me info see ://jwt.iohttps.
Parameters :
Returns :
ParsedJWT
|
| patternWithMessage | ||||||||||||
patternWithMessage(pattern, message: string)
|
||||||||||||
|
creates a pattern validator that also carries a predefined message
Parameters :
Returns :
ValidatorFn
|
| PerformanceAnalysisLogging |
PerformanceAnalysisLogging(target: Object, propertyKey: string, descriptor: TypedPropertyDescriptor)
|
|
Extend any class method to measure the duration it takes to finish and log it to the console. |
| preloadDynamicComponents | ||||||
preloadDynamicComponents(registry: ComponentRegistry)
|
||||||
|
Parameters :
|
| random |
random(min: number, max: number)
|
| retryOnServerError | ||||||
retryOnServerError(maxRetries: number)
|
||||||
|
Retry a request on server error (status code 5xx).
Use this in Retries are done with exponential backoff delays that are randomized (in case there are many parallel requests to be spread out).
Parameters :
Returns :
MonoTypeOperatorFunction<T>
|
| resizeImage | ||||||||||||
resizeImage(file: File, maxSize: number)
|
||||||||||||
|
Parameters :
Returns :
Promise<HTMLCanvasElement>
|
| resourceWithRetention | ||||||
resourceWithRetention(options: ResourceOptions)
|
||||||
|
Creates a resource that retains its previous value when reloading. This function is similar to resource except while reloading. When
Parameters :
Returns :
ResourceRef<T | undefined>
|
| reuseFirstAsync | ||||
reuseFirstAsync(fn)
|
||||
|
Wraps a function to ensure only one async operation runs at a time. If called while the first async operation is still pending, returns the same promise. Once the operation completes (success or failure), subsequent calls will start a new operation.
Parameters :
Returns :
Promise<T>
|
| setupCustomFormControlEditComponent | |||||||||||||||||||||||||
setupCustomFormControlEditComponent(component: CustomFormControlDirective, propertyName: string, schema: any, fixture?: ComponentFixture)
|
|||||||||||||||||||||||||
|
Helper function for modern Angular components that extend CustomFormControlDirective. Pass the
Parameters :
Returns :
UntypedFormGroup
|
| sortExportOnlyLast | |||||||||
sortExportOnlyLast(a: AdditionalImportAction, b: AdditionalImportAction)
|
|||||||||
|
Parameters :
|
| splitArrayValue | |||||||||||||||
splitArrayValue(val: any, separator: string)
|
|||||||||||||||
|
Split a raw value into an array of individual values. Supports JSON arrays and separator-delimited strings.
Parameters :
Returns :
string[]
Array of individual string values |
| statsToEntityWithRecentNoteInfo | ||||||||||||
statsToEntityWithRecentNoteInfo(stat, queryRange: number)
|
||||||||||||
|
Map a result entry from getDaysSinceLastNoteOfEachEntity to the EntityWithRecentNoteInfo interface
Parameters :
Returns :
EntityWithRecentNoteInfo
|
| testDatatype | ||||||||||||||||||
testDatatype(dataType, objectValue: unknown, databaseValue: unknown, additionalSchemaFieldConfig?: any, additionalProviders?)
|
||||||||||||||||||
|
Parameters :
|
| testEntitySubclass | ||||||||||||||||||||
testEntitySubclass(entityType: string, entityClass: EntityConstructor, expectedDatabaseFormat: any, skipTestbedConfiguration: unknown)
|
||||||||||||||||||||
|
Shared entity subclass test cases for model classes extending Entity.
Parameters :
|
| toFormFieldConfig | ||||||
toFormFieldConfig(column: ColumnConfig)
|
||||||
|
Parameters :
Returns :
FormFieldConfig
|
| TranslatableMatPaginator |
TranslatableMatPaginator()
|
| waitForChangeTo | ||||||||
waitForChangeTo(state: State)
|
||||||||
|
Waits until the state of a source observable is equal to the given
state, then emit that state. All other states are discarded.
Parameters :
Returns :
MonoTypeOperatorFunction<State>
|