-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add data dictionary tooltip support #4131 (#320)
- Loading branch information
1 parent
4f084ba
commit 849e5cf
Showing
12 changed files
with
451 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| import { | ||
| Attribute, | ||
| Class, | ||
| DataDictionary, | ||
| DataDictionaryAnnotation, | ||
| } from "../../../common/entities"; | ||
| import { CategoryGroupConfig, SiteConfig } from "../../../config/entities"; | ||
|
|
||
| /** | ||
| * Annotate each entity column configuration with data dictionary values. Specifically, | ||
| * look up label and description for each column key. | ||
| * @param siteConfig - Site configuration to annotate. | ||
| * @param annotationsByKey - Data dictionary annotations keyed by key. | ||
| */ | ||
| export function annotateColumnConfig( | ||
| siteConfig: SiteConfig, | ||
| annotationsByKey: Record<string, DataDictionaryAnnotation> | ||
| ): void { | ||
| // Annotate every column in every entity. | ||
| siteConfig.entities.forEach((entity) => { | ||
| entity.list.columns.forEach((columnConfig) => { | ||
| // Find the annotation for the column key. | ||
| const annotation = annotationsByKey[columnConfig.id]; | ||
| if (!annotation) { | ||
| return; | ||
| } | ||
|
|
||
| if (!columnConfig.meta) { | ||
| columnConfig.meta = {}; | ||
| } | ||
| columnConfig.meta.annotation = annotation; | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Annotate filter and colummn configuration with data dictionary values. Note this | ||
| * functionality mutates the site config. A possible future improvement would be to | ||
| * create either a specific "raw" or "annotated" type to indicate clearly the point | ||
| * at which the config has been annotated. | ||
| * @param siteConfig - The site configuration to annotate. | ||
| */ | ||
| export function annotateSiteConfig(siteConfig: SiteConfig): void { | ||
| // Build and map data dictionary annotations by key. | ||
| const { dataDictionary } = siteConfig; | ||
| if (!dataDictionary) { | ||
| return; | ||
| } | ||
| const annotationsByKey = keyAnnotationsByKey(dataDictionary); | ||
|
|
||
| // Annotate elements of site config. | ||
| annotateEntityConfig(siteConfig, annotationsByKey); | ||
| annotateDefaultCategoryConfig(siteConfig, annotationsByKey); | ||
| annotateEntityCategoryConfig(siteConfig, annotationsByKey); | ||
| annotateColumnConfig(siteConfig, annotationsByKey); | ||
| } | ||
|
|
||
| /** | ||
| * Annotate entity configuration with data dictionary values. Specifically, look | ||
| * up label and description for each entity key. | ||
| * @param siteConfig - The site configuration to annotate. | ||
| * @param annotationsByKey - Data dictionary annotations keyed by key. | ||
| */ | ||
| export function annotateEntityConfig( | ||
| siteConfig: SiteConfig, | ||
| annotationsByKey: Record<string, DataDictionaryAnnotation> | ||
| ): void { | ||
| // Annotate every entity. | ||
| siteConfig.entities.forEach((entityConfig) => { | ||
| // Check entity for a data dictionary key. | ||
| const { key } = entityConfig; | ||
| if (!key) { | ||
| return; | ||
| } | ||
|
|
||
| // Find corresponding annotation for the key and set on entity config. | ||
| entityConfig.annotation = annotationsByKey[key]; | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Annotate top-level (app-wide) category config with data dictionary values. | ||
| * Specifically, look up label and description for each filter key. | ||
| * @param siteConfig - Site configuration to annotate. | ||
| * @param annotationsByKey - Data dictionary annotations keyed by key. | ||
| */ | ||
| export function annotateDefaultCategoryConfig( | ||
| siteConfig: SiteConfig, | ||
| annotationsByKey: Record<string, DataDictionaryAnnotation> | ||
| ): void { | ||
| const { categoryGroupConfig } = siteConfig; | ||
| if (categoryGroupConfig) { | ||
| annotateCategoryGroupConfig(categoryGroupConfig, annotationsByKey); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Annotate entity-specific category config with data dictionary values. Specifically, | ||
| * look up label and description for each category key. | ||
| * @param siteConfig - Site configuration to annotate. | ||
| * @param annotationsByKey - Data dictionary annotations keyed by key. | ||
| */ | ||
| export function annotateEntityCategoryConfig( | ||
| siteConfig: SiteConfig, | ||
| annotationsByKey: Record<string, DataDictionaryAnnotation> | ||
| ): void { | ||
| // Annotate every category in every entity. | ||
| siteConfig.entities.forEach((entityConfig) => { | ||
| const { categoryGroupConfig } = entityConfig; | ||
| if (categoryGroupConfig) { | ||
| annotateCategoryGroupConfig(categoryGroupConfig, annotationsByKey); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Annonate category group configuration with data dictionary values. | ||
| * @param categoryGroupConfig - Category group to annotate. | ||
| * @param annotationsByKey - Data dictionary annotations keyed by key. | ||
| */ | ||
| function annotateCategoryGroupConfig( | ||
| categoryGroupConfig: CategoryGroupConfig, | ||
| annotationsByKey: Record<string, DataDictionaryAnnotation> | ||
| ): void { | ||
| categoryGroupConfig.categoryGroups.forEach((categoryGroup) => { | ||
| categoryGroup.categoryConfigs.forEach((categorConfig) => { | ||
| categorConfig.annotation = annotationsByKey[categorConfig.key]; | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Transform a data dictionary into a key-annotation map. Build annotations for both | ||
| * classes and attributes and add to map. | ||
| * @param dataDictionary - Data dictionary to transform into a key-annotation map. | ||
| * @returns Key-annotation map. | ||
| */ | ||
| function keyAnnotationsByKey( | ||
| dataDictionary: DataDictionary | ||
| ): Record<string, DataDictionaryAnnotation> { | ||
| return dataDictionary.classes.reduce( | ||
| (acc: Record<string, DataDictionaryAnnotation>, cls: Class) => { | ||
| // Add class to map. | ||
| acc[cls.key] = { | ||
| description: cls.description, | ||
| label: cls.label, | ||
| }; | ||
|
|
||
| // Add each class attribute to the map. | ||
| cls.attributes.forEach((attribute: Attribute) => { | ||
| acc[attribute.key] = { | ||
| description: attribute.description, | ||
| label: attribute.label, | ||
| }; | ||
| }); | ||
| return acc; | ||
| }, | ||
| {} as Record<string, DataDictionaryAnnotation> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.