src/app/core/config/config.service.ts
Access dynamic app configuration retrieved from the database that defines how the interface and data models should look.
Properties |
Methods |
|
constructor(entityMapper: EntityMapperService)
|
||||||
Defined in src/app/core/config/config.service.ts:29
|
||||||
Parameters :
|
Public applyMigrations | ||||||
applyMigrations(doc: E)
|
||||||
Defined in src/app/core/config/config.service.ts:79
|
||||||
Type parameters :
|
||||||
Parameters :
Returns :
E
|
Public exportConfig |
exportConfig()
|
Defined in src/app/core/config/config.service.ts:54
|
Returns :
string
|
Public getAllConfigs | ||||||||
getAllConfigs(prefix: string)
|
||||||||
Defined in src/app/core/config/config.service.ts:68
|
||||||||
Type parameters :
|
||||||||
Return all config items of the given "type" (determined by the given prefix of their id).
Parameters :
Returns :
T[]
|
Public getConfig | ||||||
getConfig(id: string)
|
||||||
Defined in src/app/core/config/config.service.ts:58
|
||||||
Type parameters :
|
||||||
Parameters :
Returns :
T | undefined
|
Public hasConfig |
hasConfig()
|
Defined in src/app/core/config/config.service.ts:46
|
Returns :
boolean
|
Public saveConfig | ||||||
saveConfig(config: any)
|
||||||
Defined in src/app/core/config/config.service.ts:50
|
||||||
Parameters :
Returns :
Promise<void>
|
Async loadOnce |
loadOnce()
|
Inherited from
LatestEntityLoader
|
Defined in
LatestEntityLoader:40
|
Do an initial load of the entity to be available through the
Returns :
Promise<T | undefined>
|
Async startLoading |
startLoading()
|
Inherited from
LatestEntityLoader
|
Defined in
LatestEntityLoader:27
|
Initialize the loader to make the entity available and emit continuous updates
through the
Returns :
unknown
|
configUpdates |
Default value : this.entityUpdated.pipe(shareReplay(1))
|
Defined in src/app/core/config/config.service.ts:29
|
entityUpdated |
Default value : new Subject<T>()
|
Inherited from
LatestEntityLoader
|
Defined in
LatestEntityLoader:15
|
subscribe to this and execute any actions required when the entity changes |
import { Injectable } from "@angular/core";
import { EntityMapperService } from "../entity/entity-mapper/entity-mapper.service";
import { Config } from "./config";
import { LatestEntityLoader } from "../entity/latest-entity-loader";
import { shareReplay } from "rxjs/operators";
import {
EntitySchemaField,
PLACEHOLDERS,
} from "../entity/schema/entity-schema-field";
import { DefaultValueConfig } from "../default-values/default-value-config";
import { EntityDatatype } from "../basic-datatypes/entity/entity.datatype";
import { LoaderMethod } from "../entity/entity-special-loader/entity-special-loader.service";
import { Logging } from "../logging/logging.service";
import { PanelComponent } from "../entity-details/EntityDetailsConfig";
import { ConfigMigration } from "./config-migration";
import { addDefaultNoteDetailsConfig } from "../../child-dev-project/notes/add-default-note-views";
/**
* Access dynamic app configuration retrieved from the database
* that defines how the interface and data models should look.
*/
@Injectable({ providedIn: "root" })
export class ConfigService extends LatestEntityLoader<Config> {
/**
* Subscribe to receive the current config and get notified whenever the config is updated.
*/
private currentConfig: Config;
configUpdates = this.entityUpdated.pipe(shareReplay(1));
constructor(entityMapper: EntityMapperService) {
super(Config, Config.CONFIG_KEY, entityMapper);
super.startLoading();
this.entityUpdated.subscribe(async (config) => {
this.currentConfig = this.applyMigrations(config);
this.logConfigRev();
});
}
private logConfigRev() {
Logging.addContext("Aam Digital config", {
"config _rev": this.currentConfig._rev,
});
}
public hasConfig() {
return this.currentConfig !== undefined;
}
public saveConfig(config: any): Promise<void> {
return this.entityMapper.save(new Config(Config.CONFIG_KEY, config), true);
}
public exportConfig(): string {
return JSON.stringify(this.currentConfig.data);
}
public getConfig<T>(id: string): T | undefined {
return this.currentConfig.data[id];
}
/**
* Return all config items of the given "type"
* (determined by the given prefix of their id).
*
* @param prefix The prefix of config items to return (e.g. "view:" or "entity:")
*/
public getAllConfigs<T>(prefix: string): T[] {
const matchingConfigs = [];
for (const id of Object.keys(this.currentConfig.data)) {
if (id.startsWith(prefix)) {
this.currentConfig.data[id]._id = id;
matchingConfigs.push(this.currentConfig.data[id]);
}
}
return matchingConfigs;
}
public applyMigrations<E>(doc: E): E {
const migrations: ConfigMigration[] = [
migrateEntityDetailsInputEntityType,
migrateEntityArrayDatatype,
migrateEntitySchemaDefaultValue,
migrateChildrenListConfig,
migrateHistoricalDataComponent,
migratePhotoDatatype,
migratePercentageDatatype,
migrateEntityBlock,
migrateGroupByConfig,
migrateDefaultValue,
migrateUserEntityAndPanels,
];
// default migrations that are not only temporary but will remain in the codebase
const defaultConfigs: ConfigMigration[] = [addDefaultNoteDetailsConfig];
const newDoc = JSON.parse(JSON.stringify(doc), (_that, rawValue) => {
let docPart = rawValue;
for (const migration of migrations.concat(defaultConfigs)) {
docPart = migration(_that, docPart);
}
return docPart;
});
return Object.assign(new (doc.constructor as new () => E)(), newDoc);
}
}
const migrateFormFieldConfigView2ViewComponent: ConfigMigration = (
key,
configPart,
) => {
if (
!(key === "columns" || key === "fields" || key === "cols") &&
key !== null
) {
return configPart;
}
if (Array.isArray(configPart)) {
return configPart.map((c) =>
migrateFormFieldConfigView2ViewComponent(null, c),
);
}
if (configPart?.view) {
configPart.viewComponent = configPart.view;
delete configPart.view;
}
if (configPart?.edit) {
configPart.editComponent = configPart.edit;
delete configPart.edit;
}
return configPart;
};
/**
* Config properties specifying an entityType should be named "entityType" rather than "entity"
* to avoid confusion with a specific instance of an entity being passed in components.
* @param key
* @param configPart
*/
const migrateEntityDetailsInputEntityType: ConfigMigration = (
key,
configPart,
) => {
if (key !== "config") {
return configPart;
}
if (configPart["entity"]) {
configPart["entityType"] = configPart["entity"];
delete configPart["entity"];
}
return configPart;
};
/**
* Replace custom "entity-array" dataType with dataType="array", innerDatatype="entity"
* @param key
* @param configPart
*/
const migrateEntityArrayDatatype: ConfigMigration = (key, configPart) => {
if (configPart === "DisplayEntityArray") {
return "DisplayEntity";
}
if (!configPart?.hasOwnProperty("dataType")) {
return configPart;
}
const config: EntitySchemaField = configPart;
if (config.dataType === "entity-array") {
config.dataType = EntityDatatype.dataType;
config.isArray = true;
}
if (config.dataType === "array") {
config.dataType = config["innerDataType"];
delete config["innerDataType"];
config.isArray = true;
}
if (config.dataType === "configurable-enum" && config["innerDataType"]) {
config.additional = config["innerDataType"];
delete config["innerDataType"];
}
return configPart;
};
/** Migrate the "file" datatype to use the new "photo" datatype and remove editComponent if no longer needed */
const migratePhotoDatatype: ConfigMigration = (key, configPart) => {
if (
configPart?.dataType === "file" &&
configPart?.editComponent === "EditPhoto"
) {
configPart.dataType = "photo";
delete configPart.editComponent;
}
return configPart;
};
/** Migrate the number datatype to use the new "percentage" datatype */
const migratePercentageDatatype: ConfigMigration = (key, configPart) => {
if (
configPart?.dataType === "number" &&
configPart?.viewComponent === "DisplayPercentage"
) {
configPart.dataType = "percentage";
delete configPart.viewComponent;
delete configPart.editComponent;
}
return configPart;
};
const migrateEntitySchemaDefaultValue: ConfigMigration = (
key: string,
configPart: any,
): any => {
if (key !== "defaultValue") {
return configPart;
}
if (typeof configPart == "object") {
return configPart;
}
let placeholderValue: string | undefined = Object.values(PLACEHOLDERS).find(
(value) => value === configPart,
);
if (placeholderValue) {
return {
mode: "dynamic",
value: placeholderValue,
} as DefaultValueConfig;
}
return {
mode: "static",
value: configPart,
} as DefaultValueConfig;
};
const migrateChildrenListConfig: ConfigMigration = (key, configPart) => {
if (
typeof configPart !== "object" ||
configPart?.["component"] !== "ChildrenList"
) {
return configPart;
}
configPart["component"] = "EntityList";
configPart["config"] = configPart["config"] ?? {};
configPart["config"]["entityType"] = "Child";
configPart["config"]["loaderMethod"] = "ChildrenService";
return configPart;
};
const migrateHistoricalDataComponent: ConfigMigration = (key, configPart) => {
if (
typeof configPart !== "object" ||
configPart?.["component"] !== "HistoricalDataComponent"
) {
return configPart;
}
configPart["component"] = "RelatedEntities";
configPart["config"] = configPart["config"] ?? {};
if (Array.isArray(configPart["config"])) {
configPart["config"] = { columns: configPart["config"] };
}
configPart["config"]["entityType"] = "HistoricalEntityData";
configPart["config"]["loaderMethod"] = LoaderMethod.HistoricalDataService;
return configPart;
};
/**
* ChildBlockComponent was removed and entity types can instead define a configurable tooltip setting.
*/
const migrateEntityBlock: ConfigMigration = (key, configPart) => {
if (configPart?.["blockComponent"] === "ChildBlock") {
delete configPart["blockComponent"];
configPart["toBlockDetailsAttributes"] = {
title: "name",
photo: "photo",
fields: ["phone", "schoolId", "schoolClass"],
};
return configPart;
}
if (key === "viewComponent" && configPart === "ChildBlock") {
return "EntityBlock";
}
return configPart;
};
const migrateGroupByConfig: ConfigMigration = (key, configPart) => {
// Check if we are working with the EntityCountDashboard component and within the 'config' object
if (
configPart?.component === "EntityCountDashboard" &&
typeof configPart?.config?.groupBy === "string"
) {
configPart.config.groupBy = [configPart.config.groupBy]; // Wrap groupBy as an array
return configPart;
}
// Return the unchanged part if no modification is needed
return configPart;
};
/**
* The DefaultValueConfig `mode` "inherited" has been renamed to "inherited-from-referenced-entity"
* and structure moved into a "config" subproperty.
*/
const migrateDefaultValue: ConfigMigration = (key, configPart) => {
if (key !== "defaultValue") {
return configPart;
}
if (configPart?.mode === "inherited") {
configPart.mode = "inherited-from-referenced-entity";
}
if (!configPart.config) {
configPart.config = {};
if (configPart.value) {
configPart.config.value = configPart.value;
delete configPart.value;
}
if (configPart.localAttribute) {
configPart.config.localAttribute = configPart.localAttribute;
delete configPart.localAttribute;
}
if (configPart.field) {
configPart.config.field = configPart.field;
delete configPart.field;
}
}
return configPart;
};
/**
* Migration to enable user account features by setting the `enableUserAccounts` flag
* and remove the UserSecurity panel from view:user/:id.
*/
const migrateUserEntityAndPanels: ConfigMigration = (key, configPart) => {
if (key === "entity:User") {
configPart.enableUserAccounts = true;
}
if (key === "view:user/:id") {
configPart.config.panels = (configPart.config.panels || []).filter(
(panel) =>
!panel.components?.some(
(c: PanelComponent) => c.component === "UserSecurity",
),
);
}
return configPart;
};