| addAlphaToHexColor | |||||||||
addAlphaToHexColor(color: unknown, opacity: unknown)
|
|||||||||
|
Parameters :
|
| addAndRemoveValues | ||||||||||||||||||||
addAndRemoveValues(existingValues: any, valuesToAdd: any, valuesToRemove)
|
||||||||||||||||||||
|
Add the given values to the existing values (skipping duplicates) and remove the values to remove.
Parameters :
Returns :
any
the combined values or the unchanged existingValues if nothing was added or removed |
| addMissingValues | ||||||||||||
addMissingValues(existingValues: any, valuesToAdd: any)
|
||||||||||||
|
Append the given values to the existing values, skipping any duplicates.
Parameters :
Returns :
any
the combined values or the unchanged existingValues if all values are already included |
| addDefaultNoteViewsToConfig | ||||||
addDefaultNoteViewsToConfig(configData: Record)
|
||||||
|
Parameters :
|
| getDefaultNoteDetailsConfig |
getDefaultNoteDetailsConfig()
|
|
Default configuration for Note Details.
Returns :
NoteDetailsConfig
|
| additions | ||||||
additions(snapshot: Record)
|
||||||
|
every (non-hidden) field of a snapshot rendered as an addition
Parameters :
Returns :
FieldChange[]
|
| applyDelta | |||||||||
applyDelta(state: Record, delta)
|
|||||||||
|
apply a jsondiffpatch delta to a deep clone of the current state
Parameters :
Returns :
Record<string, unknown>
|
| buildChangeEvents | ||||
buildChangeEvents(rawDocs)
|
||||
|
Build the displayable change history for one entity from its raw audit docs. A jsondiffpatch update-delta only encodes what changed (e.g. items added to
an array by index), not the full prior value — so per-field before/after
cannot be read from a single delta. Instead the full document state is
replayed: starting from the
Parameters :
Returns :
ChangeEvent[]
events newest-first |
| byChronology | |||||||||
byChronology(a: RawAuditDoc, b: RawAuditDoc)
|
|||||||||
|
chronological: by server timestamp, then by revision generation
Parameters :
Returns :
number
|
| changedFieldsOf | ||||||
changedFieldsOf(doc: AuditDelta)
|
||||||
|
The names of the fields one audit record changed, read directly from its raw
This is what the system-wide change log needs: a top-level jsondiffpatch delta is already keyed by field name, so the names (unlike the before/after values, see buildChangeEvents) need no prior state. That makes a row renderable from its own audit doc alone, so the log can page over records of many different entities without loading a history per entity. A
Parameters :
Returns :
string[]
|
| fieldChanges | |||||||||
fieldChanges(prev: Record, next: Record)
|
|||||||||
|
the (non-hidden) fields whose full value differs between two states
Parameters :
Returns :
FieldChange[]
|
| isHidden | ||||||
isHidden(field: string)
|
||||||
|
Parameters :
Returns :
boolean
|
| revGeneration | ||||||
revGeneration(rev?: string)
|
||||||
|
Parameters :
Returns :
number
|
| snapshotOf | ||||||
snapshotOf(doc: AuditDelta)
|
||||||
|
the full document snapshot carried by a baseline (raw doc) or create (
Parameters :
Returns :
Record<string, unknown>
|
| removeLegacyNoteFieldsFromSchema |
removeLegacyNoteFieldsFromSchema()
|
|
Remove the legacy fields again, restoring the schema as defined in code. |
| 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
|
| mapInBatches | ||||||||||||||||
mapInBatches<T, R>(items, batchSize: number, fn)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
|
Apply an async function to all items, but only run Unlike a plain
Parameters :
Returns :
Promise<R[]>
|
| 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<T>(service, factory)
|
|||||||||
Type parameters :
|
|||||||||
|
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<OBJECT>(attribute, order)
|
|||||||||
Type parameters :
|
|||||||||
|
Parameters :
Returns :
number
|
| addToLinkIndex | ||||||||||||
addToLinkIndex(index: LinkIndex, id: string, record: ChangedRecord)
|
||||||||||||
|
Parameters :
Returns :
void
|
| getChangedFields |
getChangedFields(after: Entity, before: Entity)
|
|
The ids of the fields whose value differs between the state of a record after and before a change.
Returns :
string[]
|
| isFieldChanged |
isFieldChanged(after: Entity, before: Entity, fieldId: string)
|
|
Whether the value of a field differs between the state of a record after and before a change.
Returns :
boolean
|
| isLinkedTo |
isLinkedTo(record, referenceField: string, id: string)
|
|
Whether the record links to the given id in the given field (also if the link is stored without the type prefix of the id).
Returns :
boolean
|
| addTooltip | ||||||
addTooltip(profile: ExternalProfile)
|
||||||
|
Parameters :
Returns :
ExternalProfile & { _tooltip?: string }
|
| ageRangeValidator | |||||||||
ageRangeValidator(end, ageRange: AgeRange)
|
|||||||||
|
Creates the validator for one end of the configured age range. The error also carries the other end, if configured, to word it as a range ("between ... and ...").
Parameters :
Returns :
ValidatorFn
|
| descriptionForAgeValidator | |||||||||
descriptionForAgeValidator(validator, validationValue: any)
|
|||||||||
|
Parameters :
Returns :
string
|
| allOfSelectors | ||||
allOfSelectors(...selectors: undefined)
|
||||
|
Combine Mango selectors so that a document has to match all of them,
leaving out empty ones (and the
Parameters :
Returns :
PouchDB.Find.Selector
|
| sortedQueries | ||||||||||||||||
sortedQueries(prefix: string, query, sort)
|
||||||||||||||||
|
The two queries that together return an entity type's documents sorted by a property, in the order in which to page through them. A Mango index only contains the documents that have every indexed field
(and cannot be told to treat a missing one like
Parameters :
Returns :
unknown
|
| typeSelector | ||||||||
typeSelector(prefix: string)
|
||||||||
|
Selector matching all documents of one entity type.
Parameters :
Returns :
PouchDB.Find.Selector
|
| applyConfigMigrations | ||||||
applyConfigMigrations<E>(doc: E)
|
||||||
Type parameters :
|
||||||
|
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 the defaults that feature modules register in the DefaultConfigMigrationRegistryService before calling this, so the migrations above can see those default-added view configs too.
Parameters :
Returns :
E
|
| applyDocumentLanguage | ||||||
applyDocumentLanguage(locale: string)
|
||||||
|
Must run before Angular bootstraps: the CDK's
Parameters :
Returns :
void
|
| 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>
|
| registerLocaleDataFor | ||||||
registerLocaleDataFor(locale: string)
|
||||||
|
Needed for locale-aware components & pipes (date formats, first day of week, numbers). Imports are listed explicitly so only the locales we offer end up in the bundle.
Parameters :
Returns :
Promise<void>
|
| 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.onOnlineOnlyChanged() 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<T extends Entity>(selectedRecords, records, range, shouldCheck: boolean)
|
|||||||||||||||
Type parameters :
|
|||||||||||||||
|
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
|
| toggleRecordSelection | ||||||||||||
toggleRecordSelection<T extends Entity>(selectedRecords, record: T, checked: boolean)
|
||||||||||||
Type parameters :
|
||||||||||||
|
Adds or removes a single record from the selected records collection.
Parameters :
Returns :
T[]
|
| updateSelectionFromMouseDown | ||||||
updateSelectionFromMouseDown<T extends Entity>(input: MouseSelectionInput)
|
||||||
Type parameters :
|
||||||
|
Computes the next selection state for a row
Parameters :
Returns :
MouseSelectionUpdate<T>
|
| applySchemaEmbedArrayEntryChange | ||||||||||||
applySchemaEmbedArrayEntryChange(entries, change: SchemaEmbedArrayEntryChange)
|
||||||||||||
|
Apply the change of a single entry to the latest list of entries, keeping all other entries as they are now.
Parameters :
Returns :
Record[]
the changed list of entries
Throws :
|
| findCurrentIndex | ||||||||||||
findCurrentIndex(entries, index: number, original)
|
||||||||||||
|
Find the position of the opened entry within the latest entries, which may have moved if other entries were added or removed in the meantime.
Parameters :
Returns :
number
|
| isStoredEntry | ||||||||||||
isStoredEntry(entry: Record, savedEntries)
|
||||||||||||
|
Whether the entry is stored in its record, as opposed to only added in a form that is not saved yet.
Parameters :
Returns :
boolean
|
| markStoredEntry | ||||||
markStoredEntry(entry: Record)
|
||||||
|
Remember that the entry stems from an entry stored in its record, see isStoredEntry.
Parameters :
|
| 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
|
| applyStoredRevisions | ||||||
applyStoredRevisions(entities, results)
|
||||||
|
Copy the revisions the database assigned back onto the saved entities. Matched by id rather than by position, so that a result missing from the response cannot shift revisions onto other entities.
Parameters :
|
| storedRecordsOf | ||||||
storedRecordsOf(records, error)
|
||||||
|
The records that were stored although the save as a whole was rejected. A rejected save reports what became of the records (see
Parameters :
Returns :
Entity[]
|
| 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<T extends Entity>(entities, next: UpdatedEntity, addIfMissing: boolean)
|
||||||||||||||||||||
Type parameters :
|
||||||||||||||||||||
|
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 |
| asActionEntry | ||||||
asActionEntry(action: EntityAction)
|
||||||
|
Parameters :
Returns :
EntityActionsMenuEntry
|
| groupEntityActions | ||||
groupEntityActions(actions)
|
||||
|
Collapse actions sharing a group into one submenu entry. A group of one stays a plain item, as a submenu of one only adds a click.
Parameters :
Returns :
EntityActionsMenuEntry[]
|
| asArray | ||||
asArray<T>(x)
|
||||
Type parameters :
|
||||
|
Convert wrap a value in an array if it is not already an array.
Parameters :
Returns :
T[]
|
| asEntries | ||||
asEntries(value)
|
||||
|
Parameters :
Returns :
Record[]
|
| formatEntry | ||||||||||||
formatEntry(entry: Record, innerFields, context?: ExportContext)
|
||||||||||||
|
The values of all inner fields of one entry, leaving out empty ones.
Parameters :
Returns :
Promise<string>
|
| getInnerExportFields | |||||||||
getInnerExportFields(innerSchema: EntitySchema, entitySchemaService: EntitySchemaService)
|
|||||||||
|
The inner fields with a formatter each, using the readable export column of their datatype (e.g. the name rather than the id of a referenced entity).
Parameters :
Returns :
InnerExportField[]
|
| getSchemaEmbedExportColumns | ||||||||||||||||||||
getSchemaEmbedExportColumns(schemaField: EntitySchemaField, innerSchema: EntitySchema, holdsArray: boolean, entitySchemaService: EntitySchemaService)
|
||||||||||||||||||||
|
Export columns of a
Parameters :
Returns :
ExportColumnMapping[]
|
| mapEntries | ||||||
mapEntries(value, format)
|
||||||
|
Format all entries, in batches as they may load referenced entities.
Parameters :
Returns :
Promise<string[]>
|
| asSingle | ||||
asSingle(entity)
|
||||
|
Parameters :
Returns :
Entity | undefined
|
| authorFilterOptions | ||||
authorFilterOptions(authors)
|
||||
|
One filter option per record a login account can belong to. Matched on every shape the author can be recorded in: the backend writes what the access token carried, which is the record's id where the account names one and the plain username otherwise. The username is the record id without its type prefix, which is how an account without an explicit id is linked to its record in the first place (see KeycloakAuthService).
Parameters :
Returns :
FilterSelectionOption[]
|
| entityTypeFilterOptions | ||||
entityTypeFilterOptions(types)
|
||||
|
One filter option per entity type, each selecting that type's records by a prefix range on the raw stored id. It is legal in a selector even though AuditRecord declares no property of that name - see the class.
Parameters :
Returns :
FilterSelectionOption[]
|
| operationFilterOptions |
operationFilterOptions()
|
|
One filter option per operation the log lets the user narrow to.
Returns :
FilterSelectionOption[]
|
| baseLanguage | ||||||
baseLanguage(locale: string)
|
||||||
|
Reduce a locale id to its language subtag, e.g.
Parameters :
Returns :
string
|
| isNonEmptyString | ||||
isNonEmptyString(value)
|
||||
|
Parameters :
Returns :
string
|
| isTranslatableText | ||||||
isTranslatableText(value, validLocaleIds)
|
||||||
|
Whether a value is a translation map: every key a known locale id or the base
language of one (
Parameters :
Returns :
Record<string | string>
|
| mergeTranslatableValues | |||||||||||||||||||||
mergeTranslatableValues<T extends Record
|
|||||||||||||||||||||
Type parameters :
|
|||||||||||||||||||||
|
Merge an edited, locale-resolved config object back onto its raw counterpart. Admin UIs edit the resolved view and write the whole object back, which without this would replace a translation map with just the editing admin's language. For each key whose raw value is a translation map (all of them, unless
Parameters :
Returns :
T
|
| pickForLocale | |||||||||
pickForLocale(map: Record, locale: string)
|
|||||||||
|
Pick the best non-empty text for
Parameters :
Returns :
string | undefined
|
| resolveTranslatableConfig | |||||||||||||||
resolveTranslatableConfig<T>(config: T, activeLocale: string, defaultLocale: string, validLocaleIds)
|
|||||||||||||||
Type parameters :
|
|||||||||||||||
|
Deep-clone a config tree, replacing every translation map with its resolved string for the active locale and leaving everything else untouched. Returns a new structure; the input is not mutated (the raw config must stay intact as the persisted source of truth).
Parameters :
Returns :
T
|
| resolveTranslatableText | |||||||||||||||
resolveTranslatableText(value, activeLocale: string, defaultLocale: string, validLocaleIds)
|
|||||||||||||||
|
Resolve a translatable value to a single string for the active locale.
Parameters :
Returns :
string | undefined
|
| bootstrap |
bootstrap()
|
| buildAuditReferenceIndex |
buildAuditReferenceIndex()
|
|
A fresh copy of the design document to create in the audit database. Built per call rather than shared: |
| buildConditions | |||||||||
buildConditions(combinator: Combinator, rows)
|
|||||||||
|
Assemble the stored condition for a combinator. Incomplete rows are left out. "all" merges the rows into one object when no field repeats and uses an explicit
Parameters :
Returns :
any
|
| normalizeConditions | ||||||
normalizeConditions(stored: any)
|
||||||
|
The same condition in the shape the editor would store it.
Parameters :
Returns :
any
|
| parseConditions | ||||||
parseConditions(stored: any)
|
||||||
|
Split a stored condition into the combinator it implies and its rows. An The result never shares objects with
Parameters :
Returns :
ParsedConditions
|
| buildEnumValueFilter |
buildEnumValueFilter<T extends Entity>(name: string, enumValueId: string)
|
Type parameters :
|
|
Match records holding the given enum value, whether stored as a single value
or inside an array (multi-select / Always both variants are matched, independent of the field's current
Returns :
DataFilter<T>
|
| 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 Internal fields are excluded, except the record's internal id
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
|
| buildPermissionConditionValidator | |||||||||||||||||||||||||
buildPermissionConditionValidator(rules, fieldId: string, toDbFormat, formatValue?)
|
|||||||||||||||||||||||||
|
Create a form validator that checks a single field's value against the
permission rule The rules are evaluated in the given priority order (as returned by
Returns
Parameters :
Returns :
ValidatorFn | null
|
| createFieldDecision | |||||||||
createFieldDecision(rule: RuleWithConditions, fieldId: string)
|
|||||||||
|
Parameters :
Returns :
FieldDecision
|
| describeConditionFragment | |||||||||||||||
describeConditionFragment(fragment: any, formatValue)
|
|||||||||||||||
|
Human-readable summary of a single permission condition fragment
(the value of one key in a CASL rule's
Parameters :
Returns :
string
|
| describeSingleOperator | ||||||
describeSingleOperator(fragment, formatValue)
|
||||||
|
Human-readable display of a fragment holding exactly one operator we have
wording for, or
Parameters :
Returns :
string | undefined
|
| buildReadonlyValidator | ||||||
buildReadonlyValidator(entity: Entity)
|
||||||
|
Validator to ensure a field becomes readonly after it has been saved once.
Parameters :
Returns :
{ fn: ValidatorFn }
|
| calculateDateRange | ||||||
calculateDateRange(dateRangeOption: DateRangeOption)
|
||||||
|
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
|
| causeChain | ||||
causeChain(error)
|
||||
|
The error and the
Parameters :
Returns :
unknown[]
|
| classifyError | ||||
classifyError(error)
|
||||
|
What kind of failure the given error is, judged by this one error (not its
Parameters :
Returns :
ErrorClassification | undefined
|
| classifyErrorChain | ||||||||||||
classifyErrorChain(error, classify)
|
||||||||||||
|
The classification of the first error in the
Parameters :
Returns :
ErrorClassification | undefined
|
| isConnectivityError | ||||
isConnectivityError(err)
|
||||
|
A request that never reached our backend or Keycloak: a
Parameters :
Returns :
boolean
|
| isNotPermittedError | ||||
isNotPermittedError(err)
|
||||
|
The permission rules exclude the record or type for the current user:
a
Parameters :
Returns :
boolean
|
| changesValue | ||||||
changesValue(update: AffectedEntity)
|
||||||
|
Whether the update changes the value of the record (not only listed to note that there is no value in common).
Parameters :
Returns :
boolean
|
| classifyException | ||||
classifyException(exception)
|
||||
|
The classification of an exception as Sentry serialized it, without the error object.
Parameters :
Returns :
ErrorClassification | undefined
|
| errorsOfExceptions | ||||||
errorsOfExceptions(values, original)
|
||||||
|
The error objects of the event's exceptions (innermost first, like
Parameters :
Returns :
[] | undefined
|
| fingerprintKey | ||||
fingerprintKey(value)
|
||||
|
Reduce a message to a grouping key: normalized, and without the casing and punctuation that libraries are inconsistent about ("Unauthorized"/"unauthorized").
Parameters :
Returns :
string
|
| groupAsNetworkError | ||||||||||||
groupAsNetworkError(event, thrown, failedRequest)
|
||||||||||||
|
Collect every "could not reach the server" into one issue, at level warning: it usually is one device's connection, and an outage shows as this issue rising. The browser-specific wording is replaced by a stable title and kept as a tag.
Parameters :
Returns :
Sentry.ErrorEvent
|
| groupByCause | ||||||||||||
groupByCause(event, hint, classification?: ErrorClassification)
|
||||||||||||
|
Parameters :
Returns :
Sentry.ErrorEvent
|
| groupByRootCause | ||||||||||||||||||
groupByRootCause(event, values, chainClassifications, reportedError, rootIndex: number)
|
||||||||||||||||||
|
Group one failure into one issue. A wrapped error chain is grouped by its root cause alone (with the component's
message as the
Parameters :
Returns :
Sentry.ErrorEvent
|
| groupByStatusAndEndpoint | ||||
groupByStatusAndEndpoint(event)
|
||||
|
A server fault (whoever logged it) gets an issue per status and endpoint: grouped by the
root cause alone, a new failing endpoint would otherwise not open an issue
of its own. The endpoint is the masked
Parameters :
|
| groupingValue | ||||||
groupingValue(exception, classification)
|
||||||
|
Parameters :
Returns :
string
|
| groupSentryEvent | ||||||||||||||||
groupSentryEvent(event, hint, classification?: ErrorClassification)
|
||||||||||||||||
|
Set a grouping fingerprint (and a matching title) where Sentry's default grouping by stack trace would split one problem into many issues. Summarized in the logging README ("How events are grouped and filtered"); the rules are documented on the functions below.
Parameters :
Returns :
Sentry.ErrorEvent
|
| isUnhandled | ||||
isUnhandled(event)
|
||||
|
Whether nothing caught the reported error: it reached Angular's
Parameters :
Returns :
boolean
|
| normalizeErrorValue | ||||
normalizeErrorValue(value)
|
||||
|
Mask ids, urls and numbers, staying human-readable for titles.
Parameters :
Returns :
string
|
| reportNormalized | ||||||
reportNormalized(event, exception)
|
||||||
|
Report an exception under its normalized message, which is its grouping key here, keeping the original as extra data (an id per row, or a quoted HTML error page, would otherwise be the issue title).
Parameters :
|
| rewrappedNamedError | ||||||
rewrappedNamedError(values, original)
|
||||||
|
One of our errors that a framework wrapped without adding anything but its
stack, e.g. Angular re-throwing an error raised in a
Parameters :
Returns :
Sentry.Exception | undefined
|
| rootCauseIndex | ||||
rootCauseIndex(errors)
|
||||
|
The index of the root cause: the innermost of our typed errors, as the foreign
error a boundary converted into it (its
Parameters :
Returns :
number
|
| truncateTag | ||||||
truncateTag(value: string)
|
||||||
|
Sentry rejects tag values longer than 200 characters.
Parameters :
Returns :
string
|
| classifyHttpError | ||||||
classifyHttpError(error: HttpErrorResponse)
|
||||||
|
Parameters :
Returns :
HttpErrorClassification | undefined
|
| isBackendRequest | ||||||
isBackendRequest(url: string)
|
||||||
|
Parameters :
Returns :
boolean
|
| toTypedHttpError | |||||||||
toTypedHttpError(error, request: Pick)
|
|||||||||
|
The typed error of a failed response of our backend (see typedHttpErrorInterceptor).
Parameters :
Returns :
unknown
|
| withReadableBody | ||||
withReadableBody(error)
|
||||
|
The failed response with its body parsed, if it is a
Parameters :
Returns :
Promise<unknown>
|
| classifyPouchDbError | ||||
classifyPouchDbError(error)
|
||||
|
The classification of a raw error of PouchDB or IndexedDB by its name and
wording (not by its status, see
Parameters :
Returns :
ErrorClassification | undefined
|
| isDocumentWriteError | ||||
isDocumentWriteError(error)
|
||||
|
Whether the local database could not store a document itself (e.g. one nested too deeply for IndexedDB), as opposed to a classified failure such as a broken local database ("Failed to execute 'transaction' on 'IDBDatabase': The database connection is closing").
Parameters :
Returns :
boolean
|
| classifyReportedError | ||||
classifyReportedError(error)
|
||||
|
The classification of an error that remote monitoring reports: by its type (see classifyError), else as one of the few foreign errors that reach it without passing a boundary that would have converted them (see classifyUncaughtError).
Parameters :
Returns :
ErrorClassification | undefined
|
| classifyUncaughtError | ||||
classifyUncaughtError(error)
|
||||
|
ONLY for foreign error objects that reach us uncaught (Angular's
Never for our own errors, and never for a string: a logged message is not
classified by its wording (e.g. "Failed to fetch roles" is no failed
Parameters :
Returns :
ErrorClassification | undefined
|
| isExpectedFailure | ||||
isExpectedFailure(error)
|
||||
|
A failure of the user's environment rather than a bug: offline, expired session,
missing permission, edit conflict. Judged by the first error along the
Parameters :
Returns :
boolean
|
| classifyResponseStatus | ||||||
classifyResponseStatus(status, reasons)
|
||||||
|
The classification of a failed response of our backend (the database or the API), by its status and the texts the backend gave as reason.
Parameters :
Returns :
Exclude | undefined
|
| errorText | ||||
errorText(error)
|
||||
|
The text of an error to match wordings against:
Parameters :
Returns :
string
|
| isFailedFetch | ||||
isFailedFetch(error)
|
||||
|
Whether the error is the browser's failure of a
Parameters :
Returns :
boolean
|
| normalizeRequestPath | ||||||
normalizeRequestPath(url: string)
|
||||||
|
The path of a request as a grouping key: without host, query and fragment
(which may hold personal data), and with every segment that is not a route
name masked (document ids, uuids, numbers),
e.g. "/db/app/Child%3A1?rev=1-a" → "/db/app/
Parameters :
Returns :
string
|
| textOf | ||||
textOf(value)
|
||||
|
The value if it is a string (e.g. a property of an error that may be anything), else "".
Parameters :
Returns :
string
|
| classifySentryEvent | ||||||
classifySentryEvent(event, hint)
|
||||||
|
The classification of the failure an event reports: of its error chain if the
error object is known, else by the reported exceptions. Foreign errors that
reached the logging unconverted are recognized as well (see
Parameters :
Returns :
ErrorClassification | undefined
|
| enrichSentryEvent | ||||||
enrichSentryEvent(event, hint)
|
||||||
|
Report properties of the error as extra data (e.g. a DatabaseException's status and reason). The cause chain is searched outermost first, as a wrapper naming the failed operation usually has none of these itself.
Parameters :
|
| isUnhandledErrorInPageScript | ||||
isUnhandledErrorInPageScript(event)
|
||||
|
An unhandled error raised only by code inlined into the HTML page itself, not by any of our
script files: e.g. a script injected by an in-app browser (seen from the iOS Google app).
Our own code is always loaded from
Parameters :
Returns :
boolean
|
| processSentryEvent | ||||||
processSentryEvent(event, hint)
|
||||||
|
Sentry
Parameters :
Returns :
Sentry.ErrorEvent | null
|
| 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 :
|
| clearLastSyncMarkers |
clearLastSyncMarkers()
|
|
Remove the "last sync" marker of every database, so that no previous sync is assumed to have happened on this device. This accesses the real localStorage directly rather than the injectable LOCAL_STORAGE_TOKEN, because it also runs before Angular exists. Callers that need this mockable should wrap it in an instance method first. |
| runPendingReset |
runPendingReset()
|
|
Run pending reset cleanup before Angular bootstraps. Called from main.ts so that IndexedDB databases are deleted while no PouchDB connections are open (eliminating race conditions).
Returns :
Promise<void>
|
| showCloseOtherTabsNotice |
showCloseOtherTabsNotice()
|
|
Ask the user on the static loading screen ( The text is English only, like the rest of the loading screen: translations are not loaded yet at this point of the bootstrap. Angular replaces the loading screen (incl. this notice) once the app starts. |
| 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 :
|
| collectQueryStrings | ||||
collectQueryStrings(node)
|
||||
|
Recursively collect every
Parameters :
Returns :
string[]
|
| isHierarchicalReport | ||||
isHierarchicalReport(report)
|
||||
|
Whether a report's results should be rendered as a hierarchical group/count
table ( Derived from the config structure:
a report is hierarchical when its
Parameters :
Returns :
boolean
|
| reportUsesDateRange | ||||
reportUsesDateRange(report)
|
||||
|
Whether running this report offers a date-range (start & end date) input, derived from the date placeholders used in its queries so it stays in sync with the actual report definition:
Parameters :
Returns :
boolean
|
| combineFilterConditions | ||||
combineFilterConditions<T>(...conditions: undefined)
|
||||
Type parameters :
|
||||
|
Combine the given conditions so that all of them have to be met. Conditions without any content are left out, because an empty object as an
Parameters :
Returns :
DataFilter<T>
|
| createEmptyValueFilter | ||||||||||||||||
createEmptyValueFilter<T extends Entity>(fieldName: string, includeNestedId: unknown, includeEmptyArray: unknown)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
|
Parameters :
Returns :
DataFilter<T>
|
| getCurrentRecordPlaceholderFields | ||||
getCurrentRecordPlaceholderFields(condition)
|
||||
|
The ids of the fields of the current record that the
Parameters :
Returns :
string[]
|
| getCurrentRecordReferences | ||||
getCurrentRecordReferences(condition)
|
||||
|
what the
Parameters :
Returns :
CurrentRecordReference[]
|
| isCurrentRecordPlaceholder | ||||
isCurrentRecordPlaceholder(value)
|
||||
|
Parameters :
Returns :
string
|
| parseCurrentRecordPlaceholder | ||||||
parseCurrentRecordPlaceholder(placeholder: string)
|
||||||
|
what a
Parameters :
Returns :
CurrentRecordReference
|
| placeholderFieldId | ||||||
placeholderFieldId(placeholder: string)
|
||||||
|
What a
Parameters :
Returns :
string
|
| comparableValue | |||||||||
comparableValue(value, shouldNormalize: boolean)
|
|||||||||
|
A multi-lingual text is a per-language map, which no two maps compare equal as. Compare the text of the active language instead, i.e. what the admin actually sees. Anything that is not such a map is returned unchanged.
Parameters :
Returns :
unknown
|
| 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 |
| compareDates |
compareDates(a: Date, b: string)
|
|
Compare dates at day precision
Returns :
"1" | unknown | "0"
|
| extendedCompare | |||||||||
extendedCompare<T>(a: T, b: T)
|
|||||||||
Type parameters :
|
|||||||||
|
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<OBJECT, PROPERTY extends keyof OBJECT>(obj: OBJECT, key: PROPERTY, sortValueFns?: SortValueFns)
|
||||||||||||
Type parameters :
|
||||||||||||
|
Parameters :
Returns :
number | string | Symbol
|
| tableSort | ||||||||||||||||||||
tableSort<OBJECT extends Entity, PROPERTY extends keyof OBJECT>(data, __namedParameters: {direction: "asc" | "desc" | string, active: PROPERTY | string, sortValueFns: SortValueFns<OBJECT>})
|
||||||||||||||||||||
Type parameters :
|
||||||||||||||||||||
|
Custom sort implementation for a MatTableDataSource
Parameters :
Returns :
OBJECT[]
the sorted records |
| computeDbNames | ||||||
computeDbNames(session: SessionInfo)
|
||||||
|
Compute new-format database names (using Keycloak UUID + dash separator). Used after migration to the "indexeddb" adapter.
Parameters :
Returns :
{ app: string; notifications: string }
|
| 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 :
{ app: string; notifications: string }
|
| configureActiveLocale | |||||||||
configureActiveLocale(locale: string, locales)
|
|||||||||
|
Called once during app startup by
Parameters :
Returns :
void
|
| getActiveLocale |
getActiveLocale()
|
|
The id of the active locale, e.g. to store a text edited in the active language.
Returns :
string
|
| isLocaleTranslationMap | ||||
isLocaleTranslationMap(value)
|
||||
|
Whether the value is a per-language map of one of the available locales.
Parameters :
Returns :
Record<string | string>
|
| mergeLocaleTranslations | ||||||||||||
mergeLocaleTranslations<T extends Record
|
||||||||||||
Type parameters :
|
||||||||||||
|
mergeTranslatableValues for the active locale.
Parameters :
Returns :
T
|
| resolveLocaleConfig | ||||||
resolveLocaleConfig<T>(value: T)
|
||||||
Type parameters :
|
||||||
|
Deep-resolve, returning a new structure so the input stays raw.
Parameters :
Returns :
T
|
| resolveLocaleText | ||||
resolveLocaleText(value)
|
||||
|
A configured text in the active language. Values that are not translation maps are returned unchanged.
Parameters :
Returns :
string | undefined
|
| resolveLocaleText | ||||||
resolveLocaleText<T>(value: T)
|
||||||
Type parameters :
|
||||||
|
Parameters :
Returns :
T
|
| resolveLocaleText | ||||
resolveLocaleText(value)
|
||||
|
Parameters :
Returns :
unknown
|
| convertToCouchRegex | ||||||||
convertToCouchRegex(node: any)
|
||||||||
|
Recursively converts any $regex value in an object to a CouchDB inline (?i) pattern.
Parameters :
Returns :
any
The transformed query object. |
| isOperatorObject | ||||
isOperatorObject(condition)
|
||||
|
Parameters :
Returns :
object
|
| toDbDateBound | ||||||||||||
toDbDateBound(operator: string, value, dataType)
|
||||||||||||
|
Date filters compare with a day ("YYYY-MM-DD"), which records in memory match at day precision. For a field stored in another format, rewrite the day into that format, keeping this meaning: a "date" is a UTC timestamp, so the day becomes its first or last moment in local time; a "month" is "YYYY-MM" and counts as its first day.
Parameters :
Returns :
unknown
|
| 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
|
| 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
|
| createCurrentRecordState | |||||||||
createCurrentRecordState<T extends Entity>(entity: T, form: FormGroup)
|
|||||||||
Type parameters :
|
|||||||||
|
Copy of the record with the current, possibly unsaved values of its form applied (including disabled and hidden fields).
Parameters :
Returns :
T
|
| currentRecordSignal | ||||
currentRecordSignal<T extends Entity = Entity>(follow)
|
||||
Type parameters :
|
||||
|
The current state of the record a field belongs to (see CurrentRecordContext),
followed only while
Parameters :
Returns :
Signal<T | undefined>
|
| getCurrentRecordOfControl | |||||||||
getCurrentRecordOfControl<T extends Entity>(control: AbstractControl, record)
|
|||||||||
Type parameters :
|
|||||||||
|
The record with the current values of the form the given control belongs to (for validators, which only get their control), or the record itself if the control is not part of a form. Validators build this themselves instead of reading
Parameters :
Returns :
T | undefined
|
| 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
|
| createEmbeddedEntity | ||||||||||||||||
createEmbeddedEntity(schema: EntitySchema, context: EmbeddedEntityContext, entry?: Record)
|
||||||||||||||||
|
Wrap an entry of an embedded field as EmbeddedEntity, to edit it like a record.
Parameters :
Returns :
EmbeddedEntity
|
| getSavedRecord | ||||||
getSavedRecord(entity: Entity)
|
||||||
|
The record that is actually saved for the given entity: the record holding it, if it is an EmbeddedEntity, otherwise the entity itself.
Parameters :
Returns :
Entity
|
| 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 :
Entity & { }
|
| createFakeStorage | ||||||||
createFakeStorage(initial: Record)
|
||||||||
|
An in-memory stand-in for Prefer this over
Parameters :
Returns :
Storage
|
| createSkillApiDummyData | ||||||
createSkillApiDummyData(externalId: string)
|
||||||
|
Parameters :
Returns :
ExternalProfile
|
| CustomYesNoButtons |
CustomYesNoButtons(yesLabel: string, noLabel: string)
|
|
Returns :
ConfirmationDialogButton[]
|
| DatabaseEntity | ||||||||
DatabaseEntity(entityType: string)
|
||||||||
|
Decorator (Annotation also see
Parameters :
|
| databaseError | ||||||||||||
databaseError(error, entityId?: string)
|
||||||||||||
|
Where errors of the (local or remote) PouchDB enter the app: the error to throw
for one. A classified failure is converted into its typed error (see
toTypedDatabaseError), as is a typed error thrown by our own code
underneath (e.g. a
Parameters :
Returns :
Error
|
| toTypedDatabaseError | |||||||||
toTypedDatabaseError(error, entityId?: string)
|
|||||||||
|
The typed error (see DATABASE_ERRORS) for an error of PouchDB or of the
IndexedDB underneath it, keeping the raw error as its
Any other error is returned unchanged (e.g. a
Parameters :
Returns :
unknown
|
| deferred |
deferred<T>()
|
Type parameters :
|
|
A promise that a test settles itself, to control exactly when a mocked async step finishes. |
| describe | ||||
describe(event)
|
||||
|
The event's title, as Sentry would show it.
Parameters :
Returns :
string
|
| isAlreadyReported | ||||||
isAlreadyReported(event, original)
|
||||||
|
Whether the error was already part of an event: e.g. logged by a component
(wrapped in its message) and then re-thrown to Angular's Only an unhandled error is dropped for its root cause alone: two components
logging the same failure are both reported (grouped into one issue, with
their messages as
Parameters :
Returns :
boolean
|
| isExcessiveRepeat | ||||||
isExcessiveRepeat(event, classification)
|
||||||
|
Parameters :
Returns :
boolean
|
| repeatKey | ||||
repeatKey(event)
|
||||
|
The issue an event ends up in, as far as known here: its fingerprint, or for stack-grouped errors the thrown error (without the stack, so that an error loop is capped even where its frames differ).
Parameters :
Returns :
string
|
| repeatLimit | ||||||
repeatLimit(event, classification)
|
||||||
|
What counts as a repeat of the event, and how often that is reported.
Parameters :
Returns :
unknown
|
| reportOnce | ||||||||
reportOnce(event, hint, classification)
|
||||||||
|
The event, or
Parameters :
Returns :
Sentry.ErrorEvent | null
|
| resetReportedEvents |
resetReportedEvents()
|
|
For tests: start a new page load. |
| describeInvalidEntries | ||||||
describeInvalidEntries(control: AbstractControl)
|
||||||
|
The validation errors of the whole property (e.g. "required"), as a message for the user.
Parameters :
Returns :
string
|
| describeResponse | |||||||||
describeResponse(response, method?: string)
|
|||||||||
|
The diagnostic fields of a fetch
Parameters :
Returns :
{ method?: string; status?: number; statusText?: string; responseUrl?: string }
|
| describeSaveFailure | ||||
describeSaveFailure(error)
|
||||
|
A short description of why a save failed, safe to pass on to a log or a message. A rejected save reports what happened to each individual document (see
Parameters :
Returns :
unknown
|
| describeValue | ||||
describeValue(value)
|
||||
|
A readable description of a value for logs, instead of "[Object]"
Parameters :
Returns :
string
|
| displayLabel | ||||
displayLabel(label)
|
||||
|
Parameters :
Returns :
string
|
| dropEmptyFields | ||||
dropEmptyFields(groups)
|
||||
|
Remove empty (null / undefined) entries from the groups' field lists. These are not a valid
Parameters :
Returns :
FieldGroup[]
|
| moveFieldBetweenGroups | |||||||||||||||||||||
moveFieldBetweenGroups(groups, field: ColumnConfig, from: FieldDropTarget, fromIndex: number, to: FieldDropTarget, toIndex: number)
|
|||||||||||||||||||||
|
Move A target of "available" is the toolbar of fields not used in the form: it holds no state of its own (it is derived from the form's groups), so a field moved there is simply removed from the form and a field moved from there is simply added.
Parameters :
Returns :
FieldGroup[]
|
| emailValidatorWithMessage | ||||||
emailValidatorWithMessage(control: AbstractControl)
|
||||||
|
Validator for the value of the field: a valid email address (or no value).
Parameters :
Returns :
ValidationErrors | null
|
| endNotBeforeStart | ||||||
endNotBeforeStart(control: AbstractControl)
|
||||||
|
Validator for the value of the field: the end must not be before the start.
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 :
|
| loggedError | ||||||
loggedError(message, context)
|
||||||
|
The error a log call is about: the message if it is an error, else the first
error among the context (also an error-like object, e.g. an
Parameters :
Returns :
unknown
|
| messageText | ||||||
messageText(message: any)
|
||||||
|
The text of anything that was passed to the logger as its "message".
Parameters :
Returns :
string
|
| toReportedError | ||||||||||||||||
toReportedError(message: any, context, logLevel: LogLevel)
|
||||||||||||||||
|
The Error to report for a log call, or A logged message comes with the logged error as its
Parameters :
Returns :
Error | undefined
|
| enrichGeoLocation | ||||
enrichGeoLocation(location)
|
||||
|
Parameters :
Returns :
GeoLocation | undefined
|
| getCityFromAddress | ||||
getCityFromAddress(address)
|
||||
|
The most specific place name available for an address.
Parameters :
Returns :
string | undefined
|
| ensureValidEntityId | ||||||
ensureValidEntityId(author: string)
|
||||||
|
The given author as an entity id, or undefined when it is not one. An entity id is type-prefixed, which a plain username is not.
Parameters :
Returns :
string | undefined
|
| entityFilterPredicate |
entityFilterPredicate(data: Entity, filter: string)
|
|
Returns :
boolean
|
| entityIdsMatch | ||||||
entityIdsMatch(entityIdA?, entityIdB?)
|
||||||
|
Compares two entity ids where one or both may be missing the Exported for reuse wherever a stored/session entity id needs to be compared against a value coming from an entity picker (which always includes the prefix).
Parameters :
Returns :
boolean
|
| getEntityIdWithoutTypePrefix | ||||||
getEntityIdWithoutTypePrefix(entityId: string)
|
||||||
|
Parameters :
Returns :
string
|
| entityToFieldReferenceLabel |
entityToFieldReferenceLabel(entityLabel: string, fieldLabel: string)
|
|
Returns :
string
|
| fieldReferenceLabel | ||||||
fieldReferenceLabel(fieldLabel: string)
|
||||||
|
Parameters :
Returns :
string
|
| fieldToEntityReferenceLabel |
fieldToEntityReferenceLabel(fieldLabel: string, entityLabel: string)
|
|
Returns :
string
|
| errorMessageOf | ||||
errorMessageOf(err)
|
||||
|
The message for the user of a failed request to the api-client module of the backend.
Parameters :
Returns :
string
|
| logRequestError | |||||||||
logRequestError(message: string, err)
|
|||||||||
|
Log a failed request to the api-client module of the backend. Expected failures (4xx, e.g. a duplicate client id, or no connection) are only logged as debug, so that they are not reported to the error monitoring; server errors (5xx) are logged as warning.
Parameters :
|
| errorToText | ||||
errorToText(error)
|
||||
|
The whole error serialized, not only its name, message and reason (as
Parameters :
Returns :
string
|
| isKnownMultiTabDatabaseCorruption | ||||
isKnownMultiTabDatabaseCorruption(error)
|
||||
|
Detect IndexedDB/PouchDB corruption symptoms commonly observed when the app is used in multiple tabs with concurrent writes. Only signals specific to this corruption are matched, as it leads to offering
a reset of the local data: a "transaction was aborted" or an
Parameters :
Returns :
boolean
|
| escapeMarkdown | ||||||
escapeMarkdown(text: string)
|
||||||
|
so that markdown shows the text as it is (e.g. a record name in angle brackets, which would be read as HTML)
Parameters :
Returns :
string
|
| getWarnings | ||||||
getWarnings<T extends Entity>(entityForm: EntityForm)
|
||||||
Type parameters :
|
||||||
|
The form's errors as "field label: message" (in markdown), if all of them are warnings (marked with
Parameters :
Returns :
[] | undefined
|
| hasOnlyWarnings | ||||||
hasOnlyWarnings(form: FormGroup)
|
||||||
|
whether all errors of the form are warnings (marked with
Parameters :
Returns :
boolean
|
| escapeRegExp | ||||||
escapeRegExp(text: string)
|
||||||
|
Escape all special regex characters so the given text can be used as a literal search string inside a regular expression.
Parameters :
Returns :
string
|
| eventFor | ||||||||||||
eventFor(error: Error, options)
|
||||||||||||
|
The event Sentry builds for an error: its
Parameters :
Returns :
Sentry.ErrorEvent
|
| processError | |||||||||
processError(error: Error, options?)
|
|||||||||
|
Parameters :
|
| setUpPageLoad |
setUpPageLoad()
|
|
Start each test with a new page load, online. |
| title | ||||
title(event)
|
||||
|
How Sentry titles an event: by its thrown error.
Parameters :
Returns :
string
|
| 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
|
| extractExtra | ||||||
extractExtra(rule: DatabaseRule)
|
||||||
|
properties of a rule beyond subject/action/conditions (e.g. reason), or undefined if none
Parameters :
Returns :
RuleExtraProperties | undefined
|
| fragmentToRule | ||||||
fragmentToRule(fragment: RuleFragment)
|
||||||
|
Parameters :
Returns :
DatabaseRule
|
| groupAllowedActions | ||||||
groupAllowedActions(row: MatrixRow)
|
||||||
|
group a row's allowed actions by identical conditions + extra properties
Parameters :
Returns :
Map<string, ActionGroup>
|
| isSupported | ||||||
isSupported(rule: DatabaseRule)
|
||||||
|
Parameters :
Returns :
boolean
|
| matrixToRules | ||||||
matrixToRules(model: MatrixModel)
|
||||||
|
Parameters :
Returns :
DatabaseRule[]
|
| rulesToMatrix | ||||
rulesToMatrix(rules)
|
||||
|
Convert permission rules into the matrix model. Rules for the same subject are merged, with later rules winning per action.
Parameters :
Returns :
MatrixModel
|
| 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[]
|
| failedHttpResponse | ||||
failedHttpResponse(error)
|
||||
|
The failed response of an Failures of requests to our backend (
Parameters :
Returns :
HttpErrorResponse | undefined
|
| failedResponseError |
failedResponseError(result, method: string, remoteUrl: string, fetchError?)
|
|
The error for a request that got no usable response: a ConnectivityError if it never reached CouchDB (no response, or a gateway status of the proxy in front of it), else a ServerError carrying the status - a server that fails is a fault to fix, not a dropped connection.
Returns :
Promise<ConnectivityError | ServerError>
|
| requestMethod | ||||
requestMethod(opts)
|
||||
|
The HTTP method of a fetch request, defaulting the way
Parameters :
Returns :
string
|
| revisionNumber | ||||
revisionNumber(rev)
|
||||
|
The generation number of a CouchDB revision (the
Parameters :
Returns :
number
|
| fieldOptions | ||||
fieldOptions(fields)
|
||||
|
the options for the given fields that an admin can select (not the internal ones)
Parameters :
Returns :
FormFieldConfig[]
|
| linkedFieldOptions | ||||||||||||
linkedFieldOptions(__namedParameters: {linkId: LinkedTypeFields, link: unknown, fields: unknown})
|
||||||||||||
|
the options for the fields of the records linked in a link field ("link field › field")
Parameters :
Returns :
FormFieldConfig[]
|
| findParentOutside | ||||||
findParentOutside(range, parents)
|
||||||
|
name of the first parent whose range the given range goes beyond
Parameters :
Returns :
string | undefined
|
| getParentIds | ||||||||||||
getParentIds(config: WithinParentConfig, record)
|
||||||||||||
|
The ids of the parent records to compare a record's range with. None for an anonymized record, whose dates are reduced to the year.
Parameters :
Returns :
string[]
|
| loadParentRanges | ||||||||||||
loadParentRanges(entityMapper: EntityMapperService, parentIds, valueField: string)
|
||||||||||||
|
Loads the ranges of the given parent records (except anonymized ones, whose dates are reduced to the year, and the ones that cannot be loaded).
Parameters :
Returns :
Promise<ParentRange[]>
|
| parentRangesResource | ||||||
parentRangesResource(params)
|
||||||
|
Loads the ranges of the parent records that a record links to (see getParentIds and loadParentRanges). Must be called in an injection context (e.g. as a field initializer of a component).
Parameters :
|
| flattenTree | ||||||||||||||||
flattenTree<T>(nodes, adapter: FlatTreeAdapter, level: number)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
|
Flatten a nested tree into rows (pre-order), carrying the depth as
Parameters :
Returns :
FlatTreeRow[]
|
| insertChild | ||||||||||||||||||
insertChild<T>(rows, parentIndex: number, node: T, adapter: FlatTreeAdapter, options?: FlatTreeOptions)
|
||||||||||||||||||
Type parameters :
|
||||||||||||||||||
|
Insert
Parameters :
Returns :
FlatTreeRow[]
|
| maxLevelBelow | ||||||||||||
maxLevelBelow<T>(above, adapter: FlatTreeAdapter, options?: FlatTreeOptions)
|
||||||||||||
Type parameters :
|
||||||||||||
|
The deepest level a row directly below
Parameters :
Returns :
number
|
| moveSubtree | ||||||||||||||||||
moveSubtree<T>(rows, previousIndex: number, currentIndex: number, adapter: FlatTreeAdapter, options?)
|
||||||||||||||||||
Type parameters :
|
||||||||||||||||||
|
Move the subtree rooted at
Parameters :
Returns :
FlatTreeRow[]
|
| normalizeLevels | ||||||||||||
normalizeLevels<T>(rows, adapter: FlatTreeAdapter, options?: FlatTreeOptions)
|
||||||||||||
Type parameters :
|
||||||||||||
|
Clamp levels so the flat list always describes a valid tree: the first row is at level 0, every
other row is at most one level deeper than the row above it — and only deeper if that row can
have children at all — and no row is deeper than
Parameters :
Returns :
FlatTreeRow[]
|
| rebuildTree | |||||||||
rebuildTree<T>(rows, adapter: FlatTreeAdapter)
|
|||||||||
Type parameters :
|
|||||||||
|
Reconstruct the nested tree from flat rows: each row owns the following rows of greater level.
Parameters :
Returns :
T[]
|
| removeSubtree | |||||||||||||||
removeSubtree<T>(rows, index: number, adapter: FlatTreeAdapter, options?: FlatTreeOptions)
|
|||||||||||||||
Type parameters :
|
|||||||||||||||
|
Remove the row at
Parameters :
Returns :
FlatTreeRow[]
|
| subtreeLength | |||||||||
subtreeLength<T>(rows, index: number)
|
|||||||||
Type parameters :
|
|||||||||
|
Number of rows forming the subtree rooted at
Parameters :
Returns :
number
|
| updateRow | ||||||||||||
updateRow<T>(rows, index: number, node: T)
|
||||||||||||
Type parameters :
|
||||||||||||
|
Replace the node of the row at
Parameters :
Returns :
FlatTreeRow[]
|
| format | ||||
format(value)
|
||||
|
Primitives (and arrays of them) already stringify readably, only objects need explicit formatting - otherwise they would render as "[object Object]".
Parameters :
Returns :
unknown
|
| formatProblem | ||||||
formatProblem(problem: ConfigProblem)
|
||||||
|
Parameters :
Returns :
string
|
| fromDateString | ||||||
fromDateString(value: string)
|
||||||
|
a date as "YYYY-MM-DD" (as the panel returns the picked dates), in local time
Parameters :
Returns :
Date
|
| isSameDate | ||||||
isSameDate(a?, b?)
|
||||||
|
Parameters :
Returns :
boolean
|
| startOfDay | ||||||
startOfDay(date: Date)
|
||||||
|
Parameters :
Returns :
Date
|
| generateActivity | ||||||||||||||||||||
generateActivity(__namedParameters: {participants: Entity[], assignedUser: Entity, title: string, entityType: string})
|
||||||||||||||||||||
|
Parameters :
Returns :
ActivityEntity
|
| generateChild | ||||||
generateChild(opts)
|
||||||
|
Parameters :
Returns :
Entity & { name: string }
|
| generateDefaultNotificationConfig |
generateDefaultNotificationConfig(userId: string, userEntity: string)
|
| generateFormFieldStory | ||||||||||||||||||||||||||||||
generateFormFieldStory<T>(editComponent: unknown, defaultValue: unknown, withTooltip: unknown, additionalSchema: object, additionalProviders: [])
|
||||||||||||||||||||||||||||||
Type parameters :
|
||||||||||||||||||||||||||||||
|
Parameters :
|
| 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<Entity & { name: string }>
|
| getCommonValue | ||||||
getCommonValue(values)
|
||||||
|
Get the value that all given values have in common, ignoring empty values (and the order of items in array values, see isSameValue).
Parameters :
Returns :
CommonValue
|
| isSameValue | |||||||||
isSameValue(a, b)
|
|||||||||
|
Whether two field values are the same, ignoring the order of items if both are arrays (e.g. the selected options of a multi-select field), as well as duplicate items.
Parameters :
Returns :
boolean
|
| getConfigsForInheritedMode | ||||
getConfigsForInheritedMode(fieldConfigs)
|
||||
|
Get the default value configs filtered for the given mode, excluding automation rules (with sourceReferenceEntity), which are handled by the AutomatedFieldUpdateConfigService.
Parameters :
|
| getDataSource | |||||||||||||||
getDataSource(registry: DataSourceRegistry, dataSource?: string, loaderMethod?: LoaderMethod, entityType?: EntityConstructor)
|
|||||||||||||||
|
Parameters :
Returns :
DataSourceConstructor
|
| pagesOnServer | ||||||
pagesOnServer(DataSourceClass: DataSourceConstructor)
|
||||||
|
whether the data source is the PaginatedDataSource or one of a feature module built on it
Parameters :
Returns :
boolean
|
| resolveDataSource | ||||||||||||||||||||
resolveDataSource<T extends Entity>(injector: Injector, dataSource?, loaderMethod?: LoaderMethod, entityType?: EntityConstructor)
|
||||||||||||||||||||
Type parameters :
|
||||||||||||||||||||
|
Create the data source for a table.
Parameters :
Returns :
EntitiesTableDataSource<T>
|
| supportsPagination | ||||||
supportsPagination(injector: Injector)
|
||||||
|
Parameters :
Returns :
boolean
|
| getDefaultConfigEntity | ||||||||
getDefaultConfigEntity(configsObject: any)
|
||||||||
|
Parameters :
|
| provideTestingConfigService | ||||||||
provideTestingConfigService(configsObject: any)
|
||||||||
|
Parameters :
|
| getDefaultEnumEntities |
getDefaultEnumEntities()
|
|
Returns :
ConfigurableEnum[]
|
| getDeferredInstallPrompt |
getDeferredInstallPrompt()
|
|
The deferred install prompt, if the browser has offered one already.
Returns :
BeforeInstallPromptEvent | undefined
|
| registerPWAInstallListener |
registerPWAInstallListener()
|
|
Start listening for the browser's Must be called before any async operation during bootstrap, because the browser fires the event early and does not replay it for later listeners.
Returns :
void
|
| resetPWAInstallListener |
resetPWAInstallListener()
|
|
Discard the deferred prompt and the listener's promise, and remove the
Returns :
void
|
| whenCanInstallDirectly |
whenCanInstallDirectly()
|
|
Resolves once/if the app can be installed directly.
Returns :
Promise | undefined
|
| getEmbeddedEntityReferenceFields | |||||||||
getEmbeddedEntityReferenceFields(schemaService: EntitySchemaService, field)
|
|||||||||
|
The inner entity-reference properties of an embedded field
(e.g. the "participant" of an attendance field), resolved through the field's datatype,
so that inner fields only partially overridden in
Parameters :
Returns :
unknown[]
|
| getEmbeddedFieldId | ||||||
getEmbeddedFieldId(ref: EmbeddedFieldRef)
|
||||||
|
The id referencing the given nested property, e.g. "childrenAttendance.participant".
Parameters :
Returns :
string
|
| getEmbeddedFieldLabel | ||||||
getEmbeddedFieldLabel(ref: EmbeddedFieldRef)
|
||||||
|
Compose the display label for a property nested inside an embedded field, e.g. "Children attendance -> Participant".
Parameters :
Returns :
string
|
| getEmbeddedFieldRefs | |||||||||
getEmbeddedFieldRefs(schemaService: EntitySchemaService, entityConstructor: EntityConstructor)
|
|||||||||
|
List all properties nested inside embedded fields of the given entity type (e.g. "childrenAttendance.participant"), for offering them as filter (or other) options in addition to the entity's normal, flat schema fields.
Parameters :
Returns :
EmbeddedFieldRef[]
|
| getEmbeddedSchema | |||||||||
getEmbeddedSchema(schemaService: EntitySchemaService, field)
|
|||||||||
|
Build the map of inner schema fields of an embedded field, the same way the datatype itself (de)serializes them (see SchemaEmbedDatatype.getEffectiveSchema). Returns
Parameters :
Returns :
EntitySchema | undefined
|
| getSchemaEmbedDatatype | |||||||||
getSchemaEmbedDatatype(schemaService: EntitySchemaService, field)
|
|||||||||
|
The datatype of the given field, if it is an embedded schema field
(e.g.
Parameters :
Returns :
SchemaEmbedDatatype | undefined
|
| resolveEmbeddedField | ||||||||||||
resolveEmbeddedField(schemaService: EntitySchemaService, entityConstructor: EntityConstructor, fieldId: string)
|
||||||||||||
|
Resolve a field id that may reference a property nested inside an embedded field (e.g. "childrenAttendance.participant") into its outer/inner schema parts. Returns
Parameters :
Returns :
EmbeddedFieldRef | undefined
|
| 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
|
| getExistingValuesToHighlight | ||||||
getExistingValuesToHighlight<V>(component: EditComponent)
|
||||||
Type parameters :
|
||||||
|
The values that the entity has saved in the field of the edit component,
to highlight the selected values that are added to them (only if They are taken from the entity, because the form control can already hold a new value when the edit component is created (e.g. a suggested value in the "Update related records" dialog).
Parameters :
Returns :
[] | undefined
|
| getFieldId | ||||||
getFieldId(field: ColumnConfig)
|
||||||
|
Parameters :
Returns :
string | undefined
|
| hasDisplayCondition | ||||
hasDisplayCondition(item)
|
||||
|
Parameters :
Returns :
boolean
|
| 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
|
| getInnerEntityReferenceFields | ||||
getInnerEntityReferenceFields(innerSchema)
|
||||
|
From the inner schema of an embedded field, return the entries
whose Returns an empty array when there is no inner schema. This is shared between the in-memory check which fields of a record reference an entity (see EntityRelationsService) and the database query selecting candidate records (see DefaultDatatype.getReferenceSelector), so that the two cannot disagree about which inner properties hold a reference. To resolve the inner schema of a field, use getEmbeddedEntityReferenceFields.
Parameters :
Returns :
unknown[]
|
| getLinkedIds | |||||||||
getLinkedIds(entity, rule: DefaultValueConfigInheritedField)
|
|||||||||
|
The ids of the entities that the entity links to in the reference field of the rule
Parameters :
Returns :
string[]
|
| getNextOccurrence |
getNextOccurrence(date: Date, today: Date)
|
|
Real calendar date of the next occurrence (this year, or next year if it has already
passed) of the given date's month/day, relative to Uses the native
Returns :
Date
|
| parseDateOnly | ||||||
parseDateOnly(value: string)
|
||||||
|
Parse a stored date-of-birth value into a Date at local midnight.
Parameters :
Returns :
Date
|
| toPropertyList | ||||
toPropertyList(properties)
|
||||
|
Parameters :
Returns :
string[]
|
| getPlaceholderLinkedRecordIds | ||||||
getPlaceholderLinkedRecordIds(condition, record)
|
||||||
|
The ids of the records that the given record links to in the fields through which placeholders of the condition
refer to a field of a linked record (e.g. the parent for
Parameters :
Returns :
unknown[]
|
| matchesSelectionCondition | |||||||||
matchesSelectionCondition<E extends Entity>(condition, filterService: FilterService)
|
|||||||||
Type parameters :
|
|||||||||
|
Whether a record matches a resolved
Parameters :
Returns :
boolean
|
| registerLinkedRecordsSource | |||||||||
registerLinkedRecordsSource(control: AbstractControl, source: LinkedRecordsSource)
|
|||||||||
|
Share the records a dropdown has loaded with the validators of its form control.
Parameters :
Returns :
void
a function to call when the dropdown is not bound to the control anymore |
| resolveSelectionCondition | ||||||||||||||||||||||||
resolveSelectionCondition<E extends Entity>(condition, entityTypes, record, placeholderService: DynamicPlaceholderValueService, linkedRecords?)
|
||||||||||||||||||||||||
Type parameters :
|
||||||||||||||||||||||||
|
The
Parameters :
Returns :
DataFilter | undefined
|
| 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 :
|
| getReportDefinitionEntryError | |||||||||||||||
getReportDefinitionEntryError(entry: ReportDefinitionDto, hasItems: unknown)
|
|||||||||||||||
|
Why a report-definition entry cannot be calculated, or
Parameters :
Returns :
string | undefined
|
| hasInvalidReportDefinitionEntry | ||||
hasInvalidReportDefinitionEntry(entries)
|
||||
|
Whether any entry of the definition, at any nesting level, cannot be calculated.
Parameters :
Returns :
boolean
|
| isGroupDto | ||||||
isGroupDto(dto: ReportDefinitionDto)
|
||||||
|
A persisted entry is a group when it carries
Parameters :
Returns :
boolean
|
| isGroupNode | ||||||
isGroupNode(node: ReportDefinitionUiNode)
|
||||||
|
A node is a group when it carries an
Parameters :
Returns :
boolean
|
| newGroupNode |
newGroupNode()
|
|
A new, empty group node.
Returns :
ReportDefinitionUiNode
|
| newQueryNode |
newQueryNode()
|
|
A new, empty query node.
Returns :
ReportDefinitionUiNode
|
| toReportDefinition | ||||
toReportDefinition(nodes)
|
||||
|
Convert UI nodes back to plain report-definition DTOs (dropping the transient ids).
Parameters :
Returns :
ReportDefinitionDto[]
|
| toUiNodes | ||||
toUiNodes(dtos)
|
||||
|
Convert persisted report-definition DTOs into UI nodes with transient ids.
Parameters :
Returns :
ReportDefinitionUiNode[]
|
| getReservedRole | ||||||
getReservedRole(roleName: string)
|
||||||
|
details of the given reserved role, or undefined if it is an ordinary role
Parameters :
Returns :
ReservedRoleInfo | undefined
|
| roleDisplayName | ||||||
roleDisplayName(roleName: string)
|
||||||
|
the reserved role's readable name, or the plain role name for ordinary roles
Parameters :
Returns :
string
|
| getRowKey | ||||||
getRowKey(row: AffectedEntity)
|
||||||
|
Parameters :
Returns :
string
|
| getSchemaEmbedArrayColumns | ||||||||||||||||
getSchemaEmbedArrayColumns(fieldConfig, entitySchemaService: EntitySchemaService, columns?)
|
||||||||||||||||
|
Resolve the inner fields of a
Parameters :
Returns :
FormFieldConfig[]
the columns, or none if the field is not of a schema-embed datatype |
| getScopeDocumentation | ||||
getScopeDocumentation(scopes)
|
||||
|
Parameters :
Returns :
string[]
|
| getScopeLabel |
getScopeLabel(scope: string, description?: string)
|
|
Returns :
string
|
| getVisibleColumnIds | |||||||||
getVisibleColumnIds(columns, screenSize: ScreenSize)
|
|||||||||
|
Ids of the table columns to be displayed on the given screen size,
leaving out columns with
Parameters :
Returns :
string[]
|
| injectCurrentScreenSize |
injectCurrentScreenSize()
|
|
The current screen size as a signal, updated whenever the screen width crosses a breakpoint. Must be called in an injection context (e.g. a field initializer of a component).
Returns :
Signal<ScreenSize>
|
| getWarningLevelColor | ||||||
getWarningLevelColor(warningLevel: WarningLevel)
|
||||||
|
Parameters :
|
| grantedByAdvancedRuleTooltip |
grantedByAdvancedRuleTooltip()
|
|
Explains a checkbox that is ticked but disabled because a rule this UI cannot express (wildcard subject, grouped subjects, conditions, an inverted rule or a rule managed by the server) decides the access.
Returns :
string
|
| grantedByDefaultRoleTooltip |
grantedByDefaultRoleTooltip()
|
|
Explains a checkbox that is ticked but disabled because the shared default role already grants the action to every logged-in user.
Returns :
string
|
| groupByReferencedId | ||||||||||||
groupByReferencedId<T extends Entity>(entities, ids: Set, referencedIdsOf)
|
||||||||||||
Type parameters :
|
||||||||||||
|
Group the entities by which of the given ids they reference. An entity referencing several of the ids is listed for each of them.
Parameters :
Returns :
Map<string, T[]>
|
| referencedIdsIn | ||||||
referencedIdsIn(value, innerKeys)
|
||||||
|
The ids a field value references: the plain id(s), or for embedded objects the ids
in their inner reference properties (all their values, if
Parameters :
Returns :
unknown[]
|
| hasOrdinalValue | ||||||
hasOrdinalValue(value: any)
|
||||||
|
Parameters :
Returns :
HasOrdinal
|
| imposeTotalOrdering | ||||||||
imposeTotalOrdering<T extends ConfigurableEnumValue>(values: Array)
|
||||||||
Type parameters :
|
||||||||
|
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>>
|
| hasOutdatedSequenceCounter | ||||
hasOutdatedSequenceCounter(db)
|
||||
|
Whether the local database's stored sequence counter is behind the sequence
numbers of its documents, so that every write fails (see above).
Only reads the database;
Parameters :
Returns :
Promise<boolean>
|
| isAbortedTransaction | ||||
isAbortedTransaction(error)
|
||||
|
Whether PouchDB rejected the call because its IndexedDB transaction was aborted.
Parameters :
Returns :
boolean
|
| openExistingDatabase | ||||||
openExistingDatabase(name: string)
|
||||||
|
Open the IndexedDB at its current version, without creating it if it does not exist (as the version change of a new database is aborted). The connection closes itself if PouchDB opens the database at a new version (as it does on every reopen), so that it never blocks the adapter.
Parameters :
Returns :
Promise<IDBDatabase>
|
| request | ||||||
request<T>(idbRequest: IDBRequest)
|
||||||
Type parameters :
|
||||||
|
Parameters :
Returns :
Promise<T>
|
| hasPushApis |
hasPushApis()
|
|
Quick check of the browser APIs, so the SDK (which checks support in detail) is not downloaded without them.
Returns :
boolean
|
| 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
|
| hasText | ||||
hasText(value)
|
||||
|
whether a plain or multi-lingual text has any non-blank text in some language
Parameters :
Returns :
boolean
|
| indexOfGroupWithFewestColumns | ||||
indexOfGroupWithFewestColumns(groups)
|
||||
|
The column group shown on small screens: the one with the fewest columns (the first of them if several have the same number).
Parameters :
Returns :
number
|
| inheritsDefaultRules | ||||||
inheritsDefaultRules(roleName: string)
|
||||||
|
Whether users of the given role also receive the shared "_default" rules. False for "_default", which cannot inherit from itself, and for "_public", which applies to visitors who are not logged in and never get the "_default" rules (see AbilityService.getRulesForUser). The excluded keys are listed explicitly instead of taken from RESERVED_RULE_CONFIG_KEYS, because a future reserved role that applies to logged-in users would inherit the "_default" rules as usual.
Parameters :
Returns :
boolean
|
| isReservedRuleConfigKey | ||||||
isReservedRuleConfigKey(key: string)
|
||||||
|
Whether a key in DatabaseRules carries special semantics instead of naming a user role, so it must neither be resolved as a role nor rewritten by a per-role UI. Covers the reserved underscore prefix as well as the explicitly listed RESERVED_RULE_CONFIG_KEYS.
Parameters :
Returns :
boolean
|
| ruleAppliesToSubject | |||||||||
ruleAppliesToSubject(subject, entityType: string)
|
|||||||||
|
Whether the rule applies to the given entity type, ignoring conditions and
inversion.
Parameters :
Returns :
boolean
|
| ruleCoversAction | ||||||||||||
ruleCoversAction(rule: DatabaseRule, entityType: string, action: EntityActionPermission)
|
||||||||||||
|
Whether the rule grants the given action for the entity type, ignoring conditions
and inversion.
Parameters :
Returns :
boolean
|
| isCollectingFromLinkedRecords | ||||
isCollectingFromLinkedRecords(field)
|
||||
|
Whether the field collects the values of all related records that link to this record (e.g. a school's field collecting the cities of all its children), adding to the existing values instead of replacing them.
Parameters :
Returns :
boolean
|
| isInheritingFromParent | ||||
isInheritingFromParent(field)
|
||||
|
Whether the field inherits the value of the parent records this record links to in one of its fields (unlike automation rules with a sourceReferenceEntity, which update the value from the side of the related records).
Parameters :
Returns :
boolean
|
| isEmptyValue | ||||
isEmptyValue(value)
|
||||
|
Whether the value is empty, i.e. not set or an empty text or list.
Parameters :
Returns :
boolean
|
| isExpectedLocationFailure | ||||
isExpectedLocationFailure(error)
|
||||
|
Failures caused by the device rather than a defect: a denied or blocked location
permission, no position available or a timeout. The user is told in any case.
(A failed address lookup does not get here:
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
|
| isMatchableField | ||||||
isMatchableField(field: EntitySchemaField)
|
||||||
|
Whether duplicates can be detected by comparing this field at all. Array values and objects without a plain
Parameters :
Returns :
boolean
|
| normalizeValue | ||||
normalizeValue(value)
|
||||
|
The comparable form of a field value, or "" where it cannot be compared.
Parameters :
Returns :
string
|
| isOfferedInLocale | |||||||||
isOfferedInLocale(config: Pick, locale: string)
|
|||||||||
|
Whether a base config is offered in the given locale. Matches the base language too, so a config listing
Parameters :
Returns :
boolean
|
| isOutsideRange | ||||||
isOutsideRange(range, outer)
|
||||||
|
Whether the range goes beyond the outer range (compared by day). A missing date leaves the range open on that side (e.g. no end date = ongoing), so it goes beyond an outer range that has a date on that side. An empty range or outer range never counts as outside.
Parameters :
Returns :
boolean
|
| isRemoteOnlyDatabase | ||||||
isRemoteOnlyDatabase(dbName: string)
|
||||||
|
Whether the given database name belongs to an entity type that declares Entity.DATABASE_REMOTE_ONLY. This reads the module-level registry rather than an injected one, so that DatabaseResolverService can decide how to create a database without taking a dependency on the entity layer's DI graph.
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
|
| keycloakFailureContext | ||||||
keycloakFailureContext(err: any)
|
||||||
|
What a failed Keycloak operation can say about itself beyond its message.
The status alone does not say why Keycloak refused (e.g. a 400 from the token
endpoint can be an expired, reused or mismatched code), so the response body
is read as well: the OAuth Passed as log context rather than interpolated into the message, so that all
occurrences stay one issue in remote monitoring (see
Parameters :
Returns :
Promise<Record<string, unknown>>
|
| keycloakOperation | ||||
keycloakOperation<T>(operation)
|
||||
Type parameters :
|
||||
|
Run a keycloak-js network operation, bounded by KEYCLOAK_OPERATION_TIMEOUT_MS, and convert its failure where it enters the app (see toTypedKeycloakError).
Parameters :
Returns :
Observable<T>
|
| readResponseBody | ||||||
readResponseBody(response: Response)
|
||||||
|
Best-effort read of a failed response's body for diagnostics. Never throws: a body that cannot be read only means less detail in the report.
Parameters :
Returns :
Promise<Record<string, unknown>>
|
| toTypedKeycloakError | ||||||
toTypedKeycloakError(err: any)
|
||||||
|
The error of a failed keycloak-js operation: a ConnectivityError (with
the original as
Parameters :
Returns :
unknown
|
| isRtlLocale | ||||||
isRtlLocale(locale: string)
|
||||||
|
Matches on the language subtag, so regional variants like
Parameters :
Returns :
boolean
|
| isValidLocale | ||||
isValidLocale(value)
|
||||
|
Whether the given value can be used as a locale to look up translations. Non-string values (e.g. a whole dropdown option object) are silently stringified by localStorage and would end up being requested from the translations CDN, so they have to be rejected before they are stored or used.
Parameters :
Returns :
string
|
| isSingleOptionList | ||||
isSingleOptionList(value)
|
||||
|
a list with exactly one option, which can be applied as plain value
Parameters :
Returns :
[unknown]
|
| isUnresolvableReferenceError | ||||||
isUnresolvableReferenceError(err: any)
|
||||||
|
Whether the error means the referenced entity cannot be resolved at all (rather than a failure that may succeed on another attempt). "No permission" includes the server's
Parameters :
Returns :
boolean
|
| loadReadableEntityName | ||||||||||||||||||||
loadReadableEntityName(entityMapper: EntityMapperService, entityType, entityId: string, cache?: Map)
|
||||||||||||||||||||
|
Load a referenced entity and return its human-readable name for exports. Only a reference that really cannot be resolved (deleted, no permission, unknown type) results in ENTITY_NOT_FOUND_PLACEHOLDER. Any other failure (connection problem, expired session, server error) is NOT disguised as "not found" - it is rethrown, so that the export fails visibly instead of silently containing wrong data for an entity that does exist.
Parameters :
Returns :
Promise<string>
|
| safeExtractType | ||||||
safeExtractType(entityId: string)
|
||||||
|
Parameters :
Returns :
string | undefined
|
| isUnset | ||||
isUnset(value)
|
||||
|
whether a validator's form control value means it is not set
Parameters :
Returns :
boolean
|
| isValidRegex | ||||||
isValidRegex(pattern: string)
|
||||||
|
Parameters :
Returns :
boolean
|
| validRegexValidator | ||||||
validRegexValidator(control: AbstractControl)
|
||||||
|
Marks the control as invalid if its value cannot be compiled as a regular expression.
Parameters :
Returns :
ValidationErrors | null
|
| jsonByteLength | ||||||
jsonByteLength(object: any)
|
||||||
|
The size a document adds to a request body: UTF-8 bytes, not characters. The server limits a request by its bytes, and a single character of a name written in a non-latin script takes several of them - so measuring the string length would under-count exactly the data most likely to be imported in bulk.
Parameters :
Returns :
number
|
| splitIntoRequests | |||||||||
splitIntoRequests(objects, limits: BulkWriteLimits)
|
|||||||||
|
Group the documents into batches that each stay within one request's budget. A single document larger than the budget gets a request of its own: it cannot be split, and the limits it is measured against are not the only ones it may pass, so it is left to the server to accept or reject it.
Parameters :
Returns :
[][]
|
| writeInBatchedRequests | ||||||||||||||||||||
writeInBatchedRequests(objects, writeRequest, limits: BulkWriteLimits, dbName: string)
|
||||||||||||||||||||
|
Write the given documents through The requests are sent one after the other: the chunks of one call belong to a single user action, so sending them in parallel would only have them compete for connections while the server holds all of their bodies in memory at once. The result reports what became of the documents the way
Parameters :
Returns :
Promise<any[]>
|
| lastSyncedBatchContext | ||||
lastSyncedBatchContext(docIds)
|
||||
|
What of the last synced batch can be reported when a sync fails right after it: how much was in flight and which record types, but never the document ids themselves - those identify records and have no place in remote monitoring (see #4174), while as part of a message they would also open a separate issue per batch.
Parameters :
Returns :
Record<string, unknown>
|
| latestLinkedRecords | ||||
latestLinkedRecords(records)
|
||||
|
The given records in their latest version: they are replaced while they change in the database (e.g. a parent record that an automated update changes after a record linking to it is saved), and left out once deleted. Must be called in an injection context (e.g. as a field initializer of a component).
Parameters :
Returns :
Signal<Entity[]>
|
| loadLinkedRecord | ||||||||||||
loadLinkedRecord<E extends Entity>(entityMapper: EntityMapperService, entityType: string, id: string)
|
||||||||||||
Type parameters :
|
||||||||||||
|
Load a record that a link field refers to,
Parameters :
Returns :
Promise<E | undefined>
|
| loadLinkedRecords | ||||||||||||||||||||
loadLinkedRecords(entityMapper: EntityMapperService, ids, getLoaded)
|
||||||||||||||||||||
|
Load the records with the given ids (the value of a link field), whatever their record types. Records that cannot be loaded (see loadLinkedRecord) and values that are not an id are left out.
Parameters :
Returns :
Promise<Entity[]>
|
| legacyDbConfig | |||||||||
legacyDbConfig(session: SessionInfo, migrationPending: boolean)
|
|||||||||
|
Parameters :
Returns :
DbConfig
|
| migratedFlagKey | ||||||
migratedFlagKey(session: SessionInfo)
|
||||||
|
Parameters :
Returns :
string
|
| newDbConfig | ||||||
newDbConfig(session: SessionInfo)
|
||||||
|
Parameters :
Returns :
DbConfig
|
| linkInLegacyField |
linkInLegacyField(newNote: Note, field: string, ids)
|
| linkLegacyNoteFields |
linkLegacyNoteFields(newNote: Note, entity: Entity)
|
|
Link a new note's source entity in the legacy Note fields, if the system still has them configured. This only applies to a ChildSchoolRelation, whose child and school used to be linked
in |
| markAsSecondQuery | ||||||
markAsSecondQuery(res: FindPage)
|
||||||
|
Parameters :
Returns :
FindPage
|
| mergeEmbeddedSchema | |||||||||
mergeEmbeddedSchema(baseSchema, additional)
|
|||||||||
|
Build the inner schema of an embedded field from the embedded type's own schema
and the field's An entry in
Parameters :
Returns :
EntitySchema
|
| migrateIsoDatesToInferredDateOnly | ||||||
migrateIsoDatesToInferredDateOnly(value: string)
|
||||||
|
Parameters :
Returns :
string
|
| migratePublicFormConfig | ||||||
migratePublicFormConfig(formConfig: PublicFormConfig)
|
||||||
|
Parameters :
Returns :
PublicFormConfig
|
| mockConfirmationDialog | ||||||||||
mockConfirmationDialog(confirmed: unknown)
|
||||||||||
|
A ConfirmationDialogService whose prompts all resolve the same way.
Parameters :
Returns :
ConfirmationDialogMock
|
| mockMatDialog | ||||||||
mockMatDialog(result)
|
||||||||
|
A MatDialog whose The dialog is never actually rendered, so this is about what the component does with the
result - assert on
Parameters :
Returns :
MatDialogMock
|
| mockMatDialogRef | ||||||||
mockMatDialogRef(result)
|
||||||||
|
A MatDialogRef, for the component inside a dialog rather than the one opening it.
Parameters :
Returns :
MatDialogRefMock
|
| negate | ||||||
negate(positive: any)
|
||||||
|
Wrap a positive fragment so it matches everything except itself.
Parameters :
Returns :
any
|
| splitNegation | ||||||
splitNegation(fragment: any)
|
||||||
|
Split a stored condition fragment into its negation flag and the positive fragment inside it, so the value editor only ever deals with the positive form regardless of whether the condition is negated.
Parameters :
Returns :
{ negated: boolean; positive: any }
|
| withSameNegation |
withSameNegation(previous: any, positive: any)
|
|
Build the replacement for The editor rebuilds a row's fragment from its value on every edit, so without this the negation of an existing condition would be dropped as soon as its value changed.
Returns :
any
|
| 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, destroyRef: DestroyRef)
|
|||||||||
|
Parameters :
|
| random |
random(min: number, max: number)
|
| retryOnServerError | ||||||
retryOnServerError<T>(maxRetries: number)
|
||||||
Type parameters :
|
||||||
|
Retry an 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>
|
| referenceIdCondition | |||||||||
referenceIdCondition(path: string, referencedIds)
|
|||||||||
|
The Mango condition matching the given document path against any of the reference ids.
It covers both shapes the value may have been stored in, the id itself or an array
containing it, because
Parameters :
Returns :
DataFilter<any>
|
| resizeImage | ||||||||||||
resizeImage(file: File, maxSize: number)
|
||||||||||||
|
Parameters :
Returns :
Promise<HTMLCanvasElement>
|
| resolveCondition | |||||||||
resolveCondition(condition, getValue: FieldValueGetter)
|
|||||||||
|
the rows of a condition that can be applied, with their placeholders resolved
Parameters :
|
| resolveConditionList | ||||||||||||
resolveConditionList(operator: string, conditions, getValue: FieldValueGetter)
|
||||||||||||
|
The conditions of a list operator (
Parameters :
|
| resolveList | |||||||||
resolveList(list, getValue: FieldValueGetter)
|
|||||||||
|
a placeholder inside a list is replaced by all values of a multi-value field
Parameters :
Returns :
unknown
|
| resolveObject | |||||||||
resolveObject(value, getValue: FieldValueGetter)
|
|||||||||
|
Parameters :
Returns :
unknown
|
| resolveValue | |||||||||
resolveValue(value, getValue: FieldValueGetter)
|
|||||||||
|
the value with its placeholders resolved (
Parameters :
Returns :
unknown
|
| resolveTranslatableLabels | ||||||
resolveTranslatableLabels(field: FormFieldConfig)
|
||||||
|
Config loaded through ConfigService is already resolved, but the runtime schema can hold a translation map while an admin has configured translations that are not saved to the config document yet. Exported for the few components that display a field config without extending it from a schema first (see addSchemaToFormField).
Parameters :
|
| resourceWithRetention | ||||||
resourceWithRetention<T, R>(options: ResourceOptions)
|
||||||
Type parameters :
|
||||||
|
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>
|
| restrictToNotArchived | ||||||
restrictToNotArchived<T extends Entity>(filter?: DataFilter)
|
||||||
Type parameters :
|
||||||
|
Restrict the given filter to records that are not archived.
Parameters :
Returns :
DataFilter<T>
|
| reuseFirstAsync | ||||
reuseFirstAsync<T>(fn)
|
||||
Type parameters :
|
||||
|
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>
|
| sameOptions | ||||||
sameOptions(a, b)
|
||||||
|
Parameters :
Returns :
boolean
|
| setupCustomFormControlEditComponent | |||||||||||||||||||||||||
setupCustomFormControlEditComponent<T>(component: CustomFormControlDirective, propertyName: string, schema: any, fixture?: ComponentFixture)
|
|||||||||||||||||||||||||
Type parameters :
|
|||||||||||||||||||||||||
|
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
|
| statusClass | ||||||
statusClass(statusId: string)
|
||||||
|
CSS class of a calendar day on which the highlighted participant had this attendance status
Parameters :
Returns :
string
|
| supportsPagination | ||||||
supportsPagination(loaderMethod?: LoaderMethod)
|
||||||
|
Whether this loader can serve one page at a time. The others load everything they have in a single call, so a list using them has to page in memory. A plain function so the data-source resolver can ask without injecting the service.
Parameters :
Returns :
boolean
|
| testDatatype | ||||||||||||||||||
testDatatype<D extends DefaultDatatype>(dataType, objectValue: unknown, databaseValue: unknown, additionalSchemaFieldConfig?: any, additionalProviders?)
|
||||||||||||||||||
Type parameters :
|
||||||||||||||||||
|
Parameters :
|
| testEntitySubclass | ||||||||||||||||||||||||||||||
testEntitySubclass(entityType: string, entityClass: EntityConstructor, expectedDatabaseFormat: any, skipTestbedConfiguration: unknown, additionalProviders)
|
||||||||||||||||||||||||||||||
|
Shared entity subclass test cases for model classes extending Entity.
Parameters :
|
| toExportValue | ||||||
toExportValue(value: any)
|
||||||
|
Convert a value to a CSV/XLSX-friendly primitive, applying the same readable transformations as the UI (dates as YYYY-MM-DD, enum labels, location strings).
Parameters :
Returns :
any
|
| toFormFieldConfig | ||||||
toFormFieldConfig(column: ColumnConfig)
|
||||||
|
Parameters :
Returns :
FormFieldConfig
|
| TranslatableMatPaginator |
TranslatableMatPaginator()
|
| waitForChangeTo | ||||||||
waitForChangeTo<State>(state: State)
|
||||||||
Type parameters :
|
||||||||
|
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>
|
| waitUntilActive | ||||||
waitUntilActive(registration: ServiceWorkerRegistration)
|
||||||
|
Parameters :
|
| withEvaluableConditions | ||||||
withEvaluableConditions(rule: RawRuleFrom)
|
||||||
|
Drop rules whose conditions the matcher cannot compile, e.g. Validating by compiling with the very matcher that later evaluates the rule keeps the two from drifting apart as the operator set changes. A granting rule is removed, which preserves the deny-by-default outcome such a config already had while the logical operators were unregistered. An inverted rule is kept without its conditions instead, since removing it would lift a restriction.
Parameters :
Returns :
RawRuleFrom[]
|
| withExtension |
withExtension(filename: string, extension: string)
|
|
Returns :
string
|
| withinParentValidator | |||||||||||||||
withinParentValidator(config: WithinParentConfig, fieldId: string, record, entityMapper: EntityMapperService)
|
|||||||||||||||
|
Validator for a date range that should lie within the range of the parent record(s) it links to.
Its error is only a warning (see
Parameters :
Returns :
AsyncPromiseValidatorFn
|