Skip to content

Commit 5b6fa80

Browse files
[DURACOM-426] refactor
1 parent e9f3df5 commit 5b6fa80

File tree

6 files changed

+30
-44
lines changed

6 files changed

+30
-44
lines changed

config/config.example.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -630,11 +630,10 @@ accessibility:
630630
# The duration in days after which the accessibility settings cookie expires
631631
cookieExpirationDuration: 7
632632

633-
# CRIS Layout
634-
# Configuration for custom CRIS layout
635-
crisLayout:
633+
# Configuration for custom layout
634+
layout:
636635
# Configuration of icons and styles to be used for each authority controlled link
637-
crisRef:
636+
authorityRef:
638637
- entityType: DEFAULT
639638
entityStyle:
640639
default:
@@ -658,8 +657,6 @@ crisLayout:
658657
default:
659658
icon: fas fa-project-diagram
660659
style: text-success
661-
crisRefStyleMetadata:
662-
default: cris.entity.style
663660

664661
# When the search results are retrieved, for each item type the metadata with a valid authority value are inspected.
665662
# Referenced items will be fetched with a find all by id strategy to avoid individual rest requests

src/app/shared/entity-icon/entity-icon.directive.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import {
55
OnInit,
66
} from '@angular/core';
77
import {
8-
CrisRefConfig,
9-
CrisRefEntityStyleConfig,
8+
AuthorityRefConfig,
9+
AuthorityRefEntityStyleConfig,
1010
} from '@dspace/config/layout-config.interfaces';
1111
import {
1212
isEmpty,
@@ -46,9 +46,9 @@ export class EntityIconDirective implements OnInit {
4646
@Input() iconPosition = 'after';
4747

4848
/**
49-
* A configuration representing crisRef values
49+
* A configuration representing authorityRef values
5050
*/
51-
confValue = environment.crisLayout.crisRef;
51+
confValue = environment.layout.authorityRef;
5252

5353
/**
5454
* Initialize instance variables
@@ -62,23 +62,23 @@ export class EntityIconDirective implements OnInit {
6262
* Adding icon to element oninit
6363
*/
6464
ngOnInit() {
65-
const crisRefConfig: CrisRefConfig = this.getCrisRefConfigByType(this.entityType);
65+
const crisRefConfig: AuthorityRefConfig = this.getCrisRefConfigByType(this.entityType);
6666
if (isNotEmpty(crisRefConfig)) {
67-
const crisStyle: CrisRefEntityStyleConfig = this.getCrisRefEntityStyleConfig(crisRefConfig, this.entityStyle);
67+
const crisStyle: AuthorityRefEntityStyleConfig = this.getCrisRefEntityStyleConfig(crisRefConfig, this.entityStyle);
6868
if (isNotEmpty(crisStyle)) {
6969
this.addIcon(crisStyle);
7070
}
7171
}
7272
}
7373

7474
/**
75-
* Return the CrisRefConfig by the given type
75+
* Return the AuthorityRefConfig by the given type
7676
*
7777
* @param type
7878
* @private
7979
*/
80-
private getCrisRefConfigByType(type: string): CrisRefConfig {
81-
let filteredConf: CrisRefConfig = this.confValue.find((config) => config.entityType.toUpperCase() === type.toUpperCase());
80+
private getCrisRefConfigByType(type: string): AuthorityRefConfig {
81+
let filteredConf: AuthorityRefConfig = this.confValue.find((config) => config.entityType.toUpperCase() === type.toUpperCase());
8282
if (isEmpty(filteredConf) && this.fallbackOnDefault) {
8383
filteredConf = this.confValue.find((config) => config.entityType.toUpperCase() === 'DEFAULT');
8484
}
@@ -87,14 +87,14 @@ export class EntityIconDirective implements OnInit {
8787
}
8888

8989
/**
90-
* Return the CrisRefEntityStyleConfig by the given style
90+
* Return the AuthorityRefEntityStyleConfig by the given style
9191
*
9292
* @param crisConfig
9393
* @param styles
9494
* @private
9595
*/
96-
private getCrisRefEntityStyleConfig(crisConfig: CrisRefConfig, styles: string|string[]): CrisRefEntityStyleConfig {
97-
let filteredConf: CrisRefEntityStyleConfig;
96+
private getCrisRefEntityStyleConfig(crisConfig: AuthorityRefConfig, styles: string|string[]): AuthorityRefEntityStyleConfig {
97+
let filteredConf: AuthorityRefEntityStyleConfig;
9898
if (Array.isArray(styles)) {
9999
styles.forEach((style) => {
100100
if (Object.keys(crisConfig.entityStyle).includes(style)) {
@@ -118,8 +118,8 @@ export class EntityIconDirective implements OnInit {
118118
* @param crisStyle
119119
* @private
120120
*/
121-
private addIcon(crisStyle: CrisRefEntityStyleConfig): void {
122-
const iconElement = `<i class="${crisStyle.icon} ${crisStyle.style}"></i>`;
121+
private addIcon(entityStyle: AuthorityRefEntityStyleConfig): void {
122+
const iconElement = `<i class="${entityStyle.icon} ${entityStyle.style}"></i>`;
123123
if (this.iconPosition === 'after') {
124124
this.elem.nativeElement.insertAdjacentHTML('afterend', '&nbsp;' + iconElement);
125125
} else {

src/config/app-config.interface.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import { IdentifierSubtypesConfig } from './identifier-subtypes-config.interface
2323
import { InfoConfig } from './info-config.interface';
2424
import { ItemConfig } from './item-config.interface';
2525
import { LangConfig } from './lang-config.interface';
26-
import { CrisLayoutConfig } from './layout-config.interfaces';
26+
import { LayoutConfig } from './layout-config.interfaces';
2727
import { LiveRegionConfig } from './live-region.config';
2828
import { MarkdownConfig } from './markdown-config.interface';
2929
import { MatomoConfig } from './matomo-config.interface';
@@ -74,7 +74,7 @@ interface AppConfig extends Config {
7474
matomo?: MatomoConfig;
7575
geospatialMapViewer: GeospatialMapConfig;
7676
accessibility: AccessibilitySettingsConfig;
77-
crisLayout: CrisLayoutConfig;
77+
layout: LayoutConfig;
7878
metadataLinkViewPopoverData: MetadataLinkViewPopoverDataConfig;
7979
identifierSubtypes: IdentifierSubtypesConfig[];
8080
searchResult: SearchResultConfig;

src/config/default-app-config.ts

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { LayoutConfig } from '@dspace/config/layout-config.interfaces';
12
import { SearchResultConfig } from '@dspace/config/search-result-config.interface';
23

34
import { AccessibilitySettingsConfig } from './accessibility-settings.config';
@@ -23,7 +24,6 @@ import {
2324
import { InfoConfig } from './info-config.interface';
2425
import { ItemConfig } from './item-config.interface';
2526
import { LangConfig } from './lang-config.interface';
26-
import { CrisLayoutConfig } from './layout-config.interfaces';
2727
import { LiveRegionConfig } from './live-region.config';
2828
import { MarkdownConfig } from './markdown-config.interface';
2929
import { MatomoConfig } from './matomo-config.interface';
@@ -678,8 +678,8 @@ export class DefaultAppConfig implements AppConfig {
678678
cookieExpirationDuration: 7,
679679
};
680680

681-
crisLayout: CrisLayoutConfig = {
682-
crisRef: [
681+
layout: LayoutConfig = {
682+
authorityRef: [
683683
{
684684
entityType: 'DEFAULT',
685685
entityStyle: {
@@ -717,9 +717,6 @@ export class DefaultAppConfig implements AppConfig {
717717
},
718718
},
719719
],
720-
crisRefStyleMetadata: {
721-
default: 'cris.entity.style',
722-
},
723720
};
724721

725722
searchResult: SearchResultConfig = {
Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
11
import { Config } from './config.interface';
22

3-
export interface CrisRefEntityStyleConfig extends Config {
3+
export interface AuthorityRefEntityStyleConfig extends Config {
44
icon: string;
55
style: string;
66
}
77

8-
export interface CrisRefConfig extends Config {
8+
export interface AuthorityRefConfig extends Config {
99
entityType: string;
1010
entityStyle: {
11-
default: CrisRefEntityStyleConfig;
12-
[entity: string]: CrisRefEntityStyleConfig;
11+
default: AuthorityRefEntityStyleConfig;
12+
[entity: string]: AuthorityRefEntityStyleConfig;
1313
};
1414
}
1515

16-
export interface CrisRefStyleMetadata extends Config {
17-
[metadata: string]: string;
18-
default: string;
19-
}
2016

21-
export interface CrisLayoutConfig extends Config {
22-
crisRef: CrisRefConfig[];
23-
crisRefStyleMetadata: CrisRefStyleMetadata;
17+
export interface LayoutConfig extends Config {
18+
authorityRef: AuthorityRefConfig[];
2419
}

src/environments/environment.test.ts

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -477,8 +477,8 @@ export const environment: BuildConfig = {
477477
cookieExpirationDuration: 7,
478478
},
479479

480-
crisLayout: {
481-
crisRef: [
480+
layout: {
481+
authorityRef: [
482482
{
483483
entityType: 'DEFAULT',
484484
entityStyle: {
@@ -515,9 +515,6 @@ export const environment: BuildConfig = {
515515
},
516516
},
517517
],
518-
crisRefStyleMetadata: {
519-
default: 'cris.entity.style',
520-
},
521518
},
522519

523520
searchResult: {

0 commit comments

Comments
 (0)