hazza/dspace-angular
1
0
Fork 1
mirror of https://github.com/DSpace/dspace-angular.git synced 2025-10-07 01:54:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'w2p-119915_made-edit-metadata-tab-fields-dynamic_contribute-7.6' into w2p-119915_made-edit-metadata-tab-fields-dynamic_contribute-main

Browse Source 
# Conflicts:
#	src/app/core/shared/context.model.ts
#	src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.ts
#	src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.html
#	src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.ts
#	src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.ts
#	src/app/dso-shared/dso-shared.module.ts
#	src/app/shared/testing/entity-type-data.service.stub.ts
This commit is contained in:
Alexandre Vryghem
2024-10-30 22:50:09 +01:00
parent f2c2fda9f2 77b66a57b8
commit 017e49aca0
21 changed files with 504 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/app/core/shared/context.model.ts
View File

@@ -41,4 +41,10 @@ export enum Context {
Bitstream = 'bitstream',
CoarNotify = 'coarNotify',
/**
* The Edit Metadata field Context values that are used in the Edit Item Metadata tab.
*/
AddMetadata = 'addMetadata',
EditMetadata = 'editMetadata',
}

2
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.html
View File

@@ -2,6 +2,8 @@
<ds-dso-edit-metadata-value-headers role="presentation" [dsoType]="dsoType"></ds-dso-edit-metadata-value-headers>
<ds-dso-edit-metadata-value *ngFor="let mdValue of form.fields[mdField]; let idx = index" role="presentation"
[dso]="dso"
[context]="Context.EditMetadata"
[mdField]="mdField"
[mdValue]="mdValue"
[mdField]="mdField"
[dsoType]="dsoType"

3
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.ts
View File

@@ -18,6 +18,7 @@ import {
Observable,
} from 'rxjs';
import { Context } from '../../../core/shared/context.model';
import { DSpaceObject } from '../../../core/shared/dspace-object.model';
import {
DsoEditMetadataChangeType,
@@ -81,6 +82,8 @@ export class DsoEditMetadataFieldValuesComponent {
*/
public DsoEditMetadataChangeTypeEnum = DsoEditMetadataChangeType;
public readonly Context = Context;
/**
* Drop a value into a new position
* Update the form's value array for the current field to match the dropped position

54
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/abstract-dso-edit-metadata-value-field.component.ts Normal file
View File

@@ -0,0 +1,54 @@
import {
Component,
EventEmitter,
Input,
Output,
} from '@angular/core';
import { Context } from '../../../core/shared/context.model';
import { DSpaceObject } from '../../../core/shared/dspace-object.model';
import { DsoEditMetadataValue } from '../dso-edit-metadata-form';
import { EditMetadataValueFieldType } from './dso-edit-metadata-field-type.enum';
@Component({
selector: 'ds-dso-edit-metadata-entity-field',
template: '',
})
export abstract class AbstractDsoEditMetadataValueFieldComponent {
/**
* The optional context
*/
@Input() context: Context;
/**
* The {@link DSpaceObject}
*/
@Input() dso: DSpaceObject;
/**
* The type of the DSO, used to determines i18n messages
*/
@Input() dsoType: string;
/**
* The type of the field
*/
@Input() type: EditMetadataValueFieldType;
/**
* The metadata field
*/
@Input() mdField: string;
/**
* Editable metadata value to show
*/
@Input() mdValue: DsoEditMetadataValue;
/**
* Emits when the user clicked confirm
*/
@Output() confirm: EventEmitter<boolean> = new EventEmitter();
}

5
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-entity-field/dso-edit-metadata-entity-field.component.html Normal file
View File

@@ -0,0 +1,5 @@
<select class="form-control" [(ngModel)]="mdValue?.newValue.value" (ngModelChange)="confirm.emit(false)">
<option *ngFor="let entity of (entities$ | async)" [value]="entity.label === 'none' ? undefined : entity.label">
{{ entity.label }}
</option>
</select>

0
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-entity-field/dso-edit-metadata-entity-field.component.scss Normal file
View File

36
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-entity-field/dso-edit-metadata-entity-field.component.spec.ts Normal file
View File

@@ -0,0 +1,36 @@
import {
ComponentFixture,
TestBed,
} from '@angular/core/testing';
import { EntityTypeDataService } from '../../../../core/data/entity-type-data.service';
import { EntityTypeDataServiceStub } from '../../../../shared/testing/entity-type-data.service.stub';
import { DsoEditMetadataEntityFieldComponent } from './dso-edit-metadata-entity-field.component';
describe('DsoEditMetadataEntityFieldComponent', () => {
let component: DsoEditMetadataEntityFieldComponent;
let fixture: ComponentFixture<DsoEditMetadataEntityFieldComponent>;
let entityTypeService: EntityTypeDataServiceStub;
beforeEach(async () => {
entityTypeService = new EntityTypeDataServiceStub();
await TestBed.configureTestingModule({
declarations: [
DsoEditMetadataEntityFieldComponent,
],
providers: [
{ provide: EntityTypeDataService, useValue: entityTypeService },
],
}).compileComponents();
fixture = TestBed.createComponent(DsoEditMetadataEntityFieldComponent);
component = fixture.componentInstance;
fixture.detectChanges();
});
it('should create', () => {
expect(component).toBeTruthy();
});
});

42
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-entity-field/dso-edit-metadata-entity-field.component.ts Normal file
View File

@@ -0,0 +1,42 @@
import {
Component,
OnInit,
} from '@angular/core';
import { Observable } from 'rxjs';
import { EntityTypeDataService } from '../../../../core/data/entity-type-data.service';
import { ItemType } from '../../../../core/shared/item-relationships/item-type.model';
import { getFirstSucceededRemoteListPayload } from '../../../../core/shared/operators';
import { AbstractDsoEditMetadataValueFieldComponent } from '../abstract-dso-edit-metadata-value-field.component';
import { EditMetadataValueFieldType } from '../dso-edit-metadata-field-type.enum';
import { editMetadataValueFieldComponent } from '../dso-edit-metadata-value-field-loader/dso-edit-metadata-value-field.decorator';
/**
* The component used to gather input for entity-type metadata fields
*/
@Component({
selector: 'ds-dso-edit-metadata-entity-field',
templateUrl: './dso-edit-metadata-entity-field.component.html',
styleUrls: ['./dso-edit-metadata-entity-field.component.scss'],
})
@editMetadataValueFieldComponent(EditMetadataValueFieldType.ENTITY_TYPE)
export class DsoEditMetadataEntityFieldComponent extends AbstractDsoEditMetadataValueFieldComponent implements OnInit {
/**
* List of all the existing entity types
*/
entities$: Observable<ItemType[]>;
constructor(
protected entityTypeService: EntityTypeDataService,
) {
super();
}
ngOnInit(): void {
this.entities$ = this.entityTypeService.findAll({ elementsPerPage: 100, currentPage: 1 }).pipe(
getFirstSucceededRemoteListPayload(),
);
}
}

7
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-field-type.enum.ts Normal file
View File

@@ -0,0 +1,7 @@
/**
* The edit metadata field tab types
*/
export enum EditMetadataValueFieldType {
PLAIN_TEXT = 'PLAIN_TEXT',
ENTITY_TYPE = 'ENTITY_TYPE',
}

6
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-text-field/dso-edit-metadata-text-field.component.html Normal file
View File

@@ -0,0 +1,6 @@
<textarea [(ngModel)]="mdValue?.newValue.value"
[dsDebounce]="300"
(onDebounce)="confirm.emit(false)"
class="form-control"
rows="5">
</textarea>

0
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-text-field/dso-edit-metadata-text-field.component.scss Normal file
View File

27
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-text-field/dso-edit-metadata-text-field.component.spec.ts Normal file
View File

@@ -0,0 +1,27 @@
import {
ComponentFixture,
TestBed,
} from '@angular/core/testing';
import { DsoEditMetadataTextFieldComponent } from './dso-edit-metadata-text-field.component';
describe('DsoEditMetadataTextFieldComponent', () => {
let component: DsoEditMetadataTextFieldComponent;
let fixture: ComponentFixture<DsoEditMetadataTextFieldComponent>;
beforeEach(async () => {
await TestBed.configureTestingModule({
declarations: [
DsoEditMetadataTextFieldComponent,
],
}).compileComponents();
fixture = TestBed.createComponent(DsoEditMetadataTextFieldComponent);
component = fixture.componentInstance;
fixture.detectChanges();
});
it('should create', () => {
expect(component).toBeTruthy();
});
});

17
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-text-field/dso-edit-metadata-text-field.component.ts Normal file
View File

@@ -0,0 +1,17 @@
import { Component } from '@angular/core';
import { AbstractDsoEditMetadataValueFieldComponent } from '../abstract-dso-edit-metadata-value-field.component';
import { EditMetadataValueFieldType } from '../dso-edit-metadata-field-type.enum';
import { editMetadataValueFieldComponent } from '../dso-edit-metadata-value-field-loader/dso-edit-metadata-value-field.decorator';
/**
* The component used to gather input for plain-text metadata fields
*/
@Component({
selector: 'ds-dso-edit-metadata-text-field',
templateUrl: './dso-edit-metadata-text-field.component.html',
styleUrls: ['./dso-edit-metadata-text-field.component.scss'],
})
@editMetadataValueFieldComponent(EditMetadataValueFieldType.PLAIN_TEXT)
export class DsoEditMetadataTextFieldComponent extends AbstractDsoEditMetadataValueFieldComponent {
}

1
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-value-field-loader/dso-edit-metadata-value-field-loader.component.html Normal file
View File

@@ -0,0 +1 @@
<ng-template dsDsoEditMetadataValueFieldDirective></ng-template>

166
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-value-field-loader/dso-edit-metadata-value-field-loader.component.ts Normal file
View File

@@ -0,0 +1,166 @@
import {
Component,
ComponentRef,
EventEmitter,
Input,
OnChanges,
OnDestroy,
OnInit,
Output,
SimpleChanges,
ViewChild,
ViewContainerRef,
} from '@angular/core';
import { Subscription } from 'rxjs';
import { Context } from '../../../../core/shared/context.model';
import { DSpaceObject } from '../../../../core/shared/dspace-object.model';
import { GenericConstructor } from '../../../../core/shared/generic-constructor';
import {
hasNoValue,
hasValue,
isNotEmpty,
} from '../../../../shared/empty.util';
import { ThemeService } from '../../../../shared/theme-support/theme.service';
import { DsoEditMetadataValue } from '../../dso-edit-metadata-form';
import { EditMetadataValueFieldType } from '../dso-edit-metadata-field-type.enum';
import { getDsoEditMetadataValueFieldComponent } from './dso-edit-metadata-value-field.decorator';
import { DsoEditMetadataValueFieldLoaderDirective } from './dso-edit-metadata-value-field-loader.directive';
@Component({
selector: 'ds-dso-edit-metadata-value-field-loader',
templateUrl: './dso-edit-metadata-value-field-loader.component.html',
})
export class DsoEditMetadataValueFieldLoaderComponent implements OnInit, OnChanges, OnDestroy {
/**
* The optional context
*/
@Input() context: Context;
/**
* The {@link DSpaceObject}
*/
@Input() dso: DSpaceObject;
/**
* The type of the DSO, used to determines i18n messages
*/
@Input() dsoType: string;
/**
* The type of the field
*/
@Input() type: EditMetadataValueFieldType;
/**
* The metadata field
*/
@Input() mdField: string;
/**
* Editable metadata value to show
*/
@Input() mdValue: DsoEditMetadataValue;
/**
* Emits when the user clicked confirm
*/
@Output() confirm: EventEmitter<boolean> = new EventEmitter();
/**
* Directive to determine where the dynamic child component is located
*/
@ViewChild(DsoEditMetadataValueFieldLoaderDirective, { static: true }) componentDirective: DsoEditMetadataValueFieldLoaderDirective;
/**
* The reference to the dynamic component
*/
protected compRef: ComponentRef<Component>;
/**
* Array to track all subscriptions and unsubscribe them onDestroy
*/
protected subs: Subscription[] = [];
protected inAndOutputNames: (keyof this)[] = [
'context',
'dso',
'dsoType',
'type',
'mdField',
'mdValue',
'confirm',
];
constructor(
protected themeService: ThemeService,
) {
}
public getComponent(): GenericConstructor<Component> {
return getDsoEditMetadataValueFieldComponent(this.type, this.context, this.themeService.getThemeName());
}
/**
* Set up the dynamic child component
*/
ngOnInit(): void {
this.instantiateComponent();
}
/**
* Whenever the inputs change, update the inputs of the dynamic component
*/
ngOnChanges(changes: SimpleChanges): void {
if (hasNoValue(this.compRef)) {
// sometimes the component has not been initialized yet, so it first needs to be initialized
// before being called again
this.instantiateComponent(changes);
} else {
// if an input or output has changed
if (this.inAndOutputNames.some((name: any) => hasValue(changes[name]))) {
this.connectInputsAndOutputs();
if (this.compRef?.instance && 'ngOnChanges' in this.compRef.instance) {
(this.compRef.instance as any).ngOnChanges(changes);
}
}
}
}
ngOnDestroy(): void {
this.subs
.filter((subscription: Subscription) => hasValue(subscription))
.forEach((subscription: Subscription) => subscription.unsubscribe());
}
public instantiateComponent(changes?: SimpleChanges): void {
const component: GenericConstructor<Component> = this.getComponent();
const viewContainerRef: ViewContainerRef = this.componentDirective.viewContainerRef;
viewContainerRef.clear();
this.compRef = viewContainerRef.createComponent(
component, {
index: 0,
injector: undefined,
},
);
if (hasValue(changes)) {
this.ngOnChanges(changes);
} else {
this.connectInputsAndOutputs();
}
}
/**
* Connect the in and outputs of this component to the dynamic component,
* to ensure they're in sync
*/
protected connectInputsAndOutputs(): void {
if (isNotEmpty(this.inAndOutputNames) && hasValue(this.compRef) && hasValue(this.compRef.instance)) {
this.inAndOutputNames.filter((name: any) => this[name] !== undefined).forEach((name: any) => {
this.compRef.instance[name] = this[name];
});
}
}
}

17
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-value-field-loader/dso-edit-metadata-value-field-loader.directive.ts Normal file
View File

@@ -0,0 +1,17 @@
import {
Directive,
ViewContainerRef,
} from '@angular/core';
/**
* Directive used as a hook to know where to inject the dynamic loaded component
*/
@Directive({
selector: '[dsDsoEditMetadataValueFieldDirective]',
})
export class DsoEditMetadataValueFieldLoaderDirective {
constructor(
public viewContainerRef: ViewContainerRef,
) {
}
}

63
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-value-field-loader/dso-edit-metadata-value-field.decorator.ts Normal file
View File

@@ -0,0 +1,63 @@
import { Context } from '../../../../core/shared/context.model';
import {
hasNoValue,
hasValue,
} from '../../../../shared/empty.util';
import {
DEFAULT_CONTEXT,
DEFAULT_THEME,
resolveTheme,
} from '../../../../shared/object-collection/shared/listable-object/listable-object.decorator';
import { EditMetadataValueFieldType } from '../dso-edit-metadata-field-type.enum';
export const map = new Map();
export const DEFAULT_EDIT_METADATA_FIELD_TYPE = EditMetadataValueFieldType.PLAIN_TEXT;
/**
* Decorator function to store edit metadata field mapping
*
* @param type The edit metadata field type
* @param context The optional context the component represents
* @param theme The optional theme for the component
*/
export function editMetadataValueFieldComponent(type: EditMetadataValueFieldType, context: Context = DEFAULT_CONTEXT, theme = DEFAULT_THEME) {
return function decorator(component: any) {
if (hasNoValue(map.get(type))) {
map.set(type, new Map());
}
if (hasNoValue(map.get(type).get(context))) {
map.get(type).set(context, new Map());
}
map.get(type).get(context).set(theme, component);
};
}
/**
* Getter to retrieve a matching component by entity type, metadata representation and context
*
* @param type The edit metadata field type
* @param context The context to match
* @param theme the theme to match
*/
export function getDsoEditMetadataValueFieldComponent(type: EditMetadataValueFieldType, context: Context = DEFAULT_CONTEXT, theme = DEFAULT_THEME) {
if (type) {
const mapForEntity = map.get(type);
if (hasValue(mapForEntity)) {
const contextMap = mapForEntity.get(context);
if (hasValue(contextMap)) {
const match = resolveTheme(contextMap, theme);
if (hasValue(match)) {
return match;
}
if (hasValue(contextMap.get(DEFAULT_THEME))) {
return contextMap.get(DEFAULT_THEME);
}
}
if (hasValue(mapForEntity.get(DEFAULT_CONTEXT)) && hasValue(mapForEntity.get(DEFAULT_CONTEXT).get(DEFAULT_THEME))) {
return mapForEntity.get(DEFAULT_CONTEXT).get(DEFAULT_THEME);
}
}
}
return map.get(DEFAULT_EDIT_METADATA_FIELD_TYPE).get(DEFAULT_CONTEXT).get(DEFAULT_THEME);
}

37
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.ts
View File

@@ -50,6 +50,7 @@ import { RelationshipDataService } from '../../../core/data/relationship-data.se
import { MetadataService } from '../../../core/metadata/metadata.service';
import { Collection } from '../../../core/shared/collection.model';
import { ConfidenceType } from '../../../core/shared/confidence-type';
import { Context } from '../../../core/shared/context.model';
import { DSpaceObject } from '../../../core/shared/dspace-object.model';
import { Item } from '../../../core/shared/item.model';
import { ItemMetadataRepresentation } from '../../../core/shared/metadata-representation/item/item-metadata-representation.model';
@@ -88,6 +89,7 @@ import {
DsoEditMetadataChangeType,
DsoEditMetadataValue,
} from '../dso-edit-metadata-form';
import { EditMetadataValueFieldType } from '../dso-edit-metadata-value-field/dso-edit-metadata-field-type.enum';
@Component({
selector: 'ds-dso-edit-metadata-value',
@@ -100,12 +102,20 @@ import {
* Component displaying a single editable row for a metadata value
*/
export class DsoEditMetadataValueComponent implements OnInit, OnChanges {
@Input() context: Context;
/**
* The parent {@link DSpaceObject} to display a metadata form for
* Also used to determine metadata-representations in case of virtual metadata
*/
@Input() dso: DSpaceObject;
/**
* The metadata field that is being edited
*/
@Input() mdField: string;
/**
* Editable metadata value to show
*/
@@ -129,11 +139,6 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges {
*/
@Input() isOnlyValue = false;
/**
* MetadataField to edit
*/
@Input() mdField?: string;
/**
* Emits when the user clicked edit
*/
@@ -186,6 +191,11 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges {
*/
mdRepresentationName$: Observable<string | null>;
/**
* The type of edit field that should be displayed
*/
fieldType: EditMetadataValueFieldType;
/**
* Whether or not the authority field is currently being edited
*/
@@ -233,6 +243,12 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges {
this.initAuthorityProperties();
}
ngOnChanges(changes: SimpleChanges): void {
if (changes.mdField) {
this.fieldType = this.getFieldType();
}
}
/**
* Initialise potential properties of a virtual metadata value
*/
@@ -252,6 +268,17 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges {
);
}
/**
* Retrieves the {@link EditMetadataValueFieldType} to be displayed for the current field while in edit mode.
*/
getFieldType(): EditMetadataValueFieldType {
if (this.mdField === 'dspace.entity.type') {
return EditMetadataValueFieldType.ENTITY_TYPE;
}
return EditMetadataValueFieldType.PLAIN_TEXT;
}
/**
* Initialise potential properties of a authority controlled metadata field
*/

2
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.html
View File

@@ -40,6 +40,8 @@
<div role="table">
<ds-dso-edit-metadata-value-headers role="presentation" [dsoType]="dsoType"></ds-dso-edit-metadata-value-headers>
<ds-dso-edit-metadata-value [dso]="dso"
[context]="Context.AddMetadata"
[mdField]="newMdField"
[mdValue]="form.newValue"
[dsoType]="dsoType"
[saving$]="savingOrLoadingFieldValidation$"

3
src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.ts
View File

@@ -42,6 +42,7 @@ import { ArrayMoveChangeAnalyzer } from '../../core/data/array-move-change-analy
import { RemoteData } from '../../core/data/remote-data';
import { UpdateDataService } from '../../core/data/update-data.service';
import { lazyDataService } from '../../core/lazy-data-service';
import { Context } from '../../core/shared/context.model';
import { DSpaceObject } from '../../core/shared/dspace-object.model';
import { getFirstCompletedRemoteData } from '../../core/shared/operators';
import { ResourceType } from '../../core/shared/resource-type';
@@ -145,6 +146,8 @@ export class DsoEditMetadataComponent implements OnInit, OnDestroy {
*/
dsoUpdateSubscription: Subscription;
public readonly Context = Context;
constructor(protected route: ActivatedRoute,
protected notificationsService: NotificationsService,
protected translateService: TranslateService,

15
src/app/shared/testing/entity-type-data.service.stub.ts
View File

@@ -1,5 +1,20 @@
import { Observable } from 'rxjs';
import { FindListOptions } from '../../core/data/find-list-options.model';
import { PaginatedList } from '../../core/data/paginated-list.model';
import { RemoteData } from '../../core/data/remote-data';
import { ItemType } from '../../core/shared/item-relationships/item-type.model';
import { createSuccessfulRemoteDataObject$ } from '../remote-data.utils';
import { FollowLinkConfig } from '../utils/follow-link-config.model';
import { createPaginatedList } from './utils.test';
/**
* Stub class of {@link EntityTypeDataService}
*/
export class EntityTypeDataServiceStub {
public findAll(_options?: FindListOptions, _useCachedVersionIfAvailable?: boolean, _reRequestOnStale?: boolean, ..._linksToFollow: FollowLinkConfig<ItemType>[]): Observable<RemoteData<PaginatedList<ItemType>>> {
return createSuccessfulRemoteDataObject$(createPaginatedList());
}
}