diff --git a/config/config.example.yml b/config/config.example.yml index 6fdfa94add5..0aca292f6fd 100644 --- a/config/config.example.yml +++ b/config/config.example.yml @@ -238,6 +238,12 @@ submission: style: text-muted icon: fa-circle-xmark + # Icons to be displayed next to an authority controlled value, to give indication of the source. + sourceIcons: + # Example of configuration for authority logo based on sources. + # The configured icon will be displayed next to the authority value in submission and on item page or search results. + - source: orcid + - path: assets/images/orcid.logo.icon.svg # Fallback language in which the UI will be rendered if the user's browser language is not an active language fallbackLanguage: en @@ -393,7 +399,8 @@ item: pageSize: 5 # Show the bitstream access status label on the item page showAccessStatuses: false - + # Enable authority based relations in item page + showAuthorithyRelations: false # Community Page Config community: # Default tab to be shown when browsing a Community. Valid values are: comcols, search, or browse_ @@ -641,3 +648,86 @@ geospatialMapViewer: accessibility: # The duration in days after which the accessibility settings cookie expires cookieExpirationDuration: 7 + +# Configuration for custom layout +layout: + # Configuration of icons and styles to be used for each authority controlled link + authorityRef: + - entityType: DEFAULT + entityStyle: + default: + icon: fa fa-user + style: text-info + - entityType: PERSON + entityStyle: + person: + icon: fa fa-user + style: text-success + default: + icon: fa fa-user + style: text-info + - entityType: ORGUNIT + entityStyle: + default: + icon: fa fa-university + style: text-success + - entityType: PROJECT + entityStyle: + default: + icon: fas fa-project-diagram + style: text-success + +# When the search results are retrieved, for each item type the metadata with a valid authority value are inspected. +# Referenced items will be fetched with a find all by id strategy to avoid individual rest requests +# to efficiently display the search results. +followAuthorityMetadata: + - type: Publication + metadata: dc.contributor.author + - type: Product + metadata: dc.contributor.author + +# The maximum number of item to process when following authority metadata values. +followAuthorityMaxItemLimit: 100 + +# The maximum number of metadata values to process for each metadata key +# when following authority metadata values. +followAuthorityMetadataValuesLimit: 5 + +# Configuration for customization of search results +searchResults: + # Metadata fields to be displayed in the search results under the standard ones + additionalMetadataFields: + - dc.contributor.author + - dc.date.issued + - dc.type + # Metadata fields to be displayed in the search results for the author section + authorMetadata: + - dc.contributor.author + - dc.creator + - dc.contributor.* + +# Configuration of metadata to be displayed in the item metadata link view popover +metadataLinkViewPopoverData: + # Metdadata list to be displayed for entities without a specific configuration + fallbackMetdataList: + - dc.description.abstract + - dc.description.note + # Configuration for each entity type + entityDataConfig: + - entityType: Person + # Descriptive metadata (popover body) + metadataList: + - person.affiliation.name + - person.email + # Title metadata (popover header) + titleMetadataList: + - person.givenName + - person.familyName +# Configuration for identifier subtypes, based on metadata like dc.identifier.ror where ror is the subtype. +# This is used to map the layout of the identifier in the popover and the icon displayed next to the metadata value. +identifierSubtypes: + - name: ror + icon: assets/images/ror.logo.icon.svg + iconPosition: IdentifierSubtypesIconPositionEnum.LEFT + link: https://ror.org + diff --git a/src/app/app-routes.ts b/src/app/app-routes.ts index 3ccabfdb212..a769f67ae91 100644 --- a/src/app/app-routes.ts +++ b/src/app/app-routes.ts @@ -28,6 +28,7 @@ import { ACCESS_CONTROL_MODULE_PATH } from './access-control/access-control-rout import { NOTIFICATIONS_MODULE_PATH } from './admin/admin-routing-paths'; import { ADMIN_MODULE_PATH, + EDIT_ITEM_PATH, FORGOT_PASSWORD_PATH, HEALTH_PAGE_PATH, PROFILE_MODULE_PATH, @@ -279,6 +280,11 @@ export const APP_ROUTES: Route[] = [ .then((m) => m.ROUTES), canActivate: [authenticatedGuard], }, + { + path: EDIT_ITEM_PATH, + loadChildren: () => import('./edit-item/edit-item-routes').then((m) => m.ROUTES), + canActivate: [endUserAgreementCurrentUserGuard], + }, { path: 'external-login/:token', loadChildren: () => import('./external-login-page/external-login-routes').then((m) => m.ROUTES), diff --git a/src/app/app.menus.ts b/src/app/app.menus.ts index e230b039719..48610f866a0 100644 --- a/src/app/app.menus.ts +++ b/src/app/app.menus.ts @@ -21,6 +21,7 @@ import { CurationMenuProvider } from './shared/menu/providers/curation.menu'; import { DSpaceObjectEditMenuProvider } from './shared/menu/providers/dso-edit.menu'; import { DsoOptionMenuProvider } from './shared/menu/providers/dso-option.menu'; import { EditMenuProvider } from './shared/menu/providers/edit.menu'; +import { EditItemDetailsMenuProvider } from './shared/menu/providers/edit-item-details.menu'; import { ExportMenuProvider } from './shared/menu/providers/export.menu'; import { HealthMenuProvider } from './shared/menu/providers/health.menu'; import { ImportMenuProvider } from './shared/menu/providers/import.menu'; @@ -104,6 +105,9 @@ export const MENUS = buildMenuStructure({ ClaimMenuProvider.onRoute( MenuRoute.ITEM_PAGE, ), + EditItemDetailsMenuProvider.onRoute( + MenuRoute.ITEM_PAGE, + ), ]), ], }); diff --git a/src/app/browse-by/browse-by-taxonomy/browse-by-taxonomy.component.ts b/src/app/browse-by/browse-by-taxonomy/browse-by-taxonomy.component.ts index 05bd4e07f14..a2339dbacc4 100644 --- a/src/app/browse-by/browse-by-taxonomy/browse-by-taxonomy.component.ts +++ b/src/app/browse-by/browse-by-taxonomy/browse-by-taxonomy.component.ts @@ -128,7 +128,7 @@ export class BrowseByTaxonomyComponent implements OnInit, OnChanges, OnDestroy { this.selectedItems = []; this.facetType = browseDefinition.facetType; this.vocabularyName = browseDefinition.vocabulary; - this.vocabularyOptions = { name: this.vocabularyName, closed: true }; + this.vocabularyOptions = { name: this.vocabularyName, metadata: null, scope: null, closed: true }; this.description = this.translate.instant(`browse.metadata.${this.vocabularyName}.tree.description`); })); this.subs.push(this.scope$.subscribe(() => { diff --git a/src/app/collection-page/collection-form/collection-form.component.ts b/src/app/collection-page/collection-form/collection-form.component.ts index bc049aa6b5b..6bd7e650440 100644 --- a/src/app/collection-page/collection-form/collection-form.component.ts +++ b/src/app/collection-page/collection-form/collection-form.component.ts @@ -10,6 +10,9 @@ import { } from '@angular/core'; import { AuthService } from '@dspace/core/auth/auth.service'; import { ObjectCacheService } from '@dspace/core/cache/object-cache.service'; +import { ConfigObject } from '@dspace/core/config/models/config.model'; +import { SubmissionDefinitionModel } from '@dspace/core/config/models/config-submission-definition.model'; +import { SubmissionDefinitionsConfigDataService } from '@dspace/core/config/submission-definitions-config-data.service'; import { CollectionDataService } from '@dspace/core/data/collection-data.service'; import { EntityTypeDataService } from '@dspace/core/data/entity-type-data.service'; import { RequestService } from '@dspace/core/data/request.service'; @@ -25,6 +28,7 @@ import { } from '@dspace/shared/utils/empty.util'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { + DynamicCheckboxModel, DynamicFormControlModel, DynamicFormOptionConfig, DynamicFormService, @@ -34,7 +38,12 @@ import { TranslateModule, TranslateService, } from '@ngx-translate/core'; -import { Observable } from 'rxjs'; +import { + catchError, + combineLatest, + Observable, + of, +} from 'rxjs'; import { ComColFormComponent } from '../../shared/comcol/comcol-forms/comcol-form/comcol-form.component'; import { ComcolPageLogoComponent } from '../../shared/comcol/comcol-page-logo/comcol-page-logo.component'; @@ -42,8 +51,11 @@ import { FormComponent } from '../../shared/form/form.component'; import { UploaderComponent } from '../../shared/upload/uploader/uploader.component'; import { VarDirective } from '../../shared/utils/var.directive'; import { + collectionFormCorrectionSubmissionDefinitionSelectionConfig, collectionFormEntityTypeSelectionConfig, collectionFormModels, + collectionFormSharedWorkspaceCheckboxConfig, + collectionFormSubmissionDefinitionSelectionConfig, } from './collection-form.models'; /** @@ -79,6 +91,20 @@ export class CollectionFormComponent extends ComColFormComponent imp */ entityTypeSelection: DynamicSelectModel = new DynamicSelectModel(collectionFormEntityTypeSelectionConfig); + /** + * The dynamic form field used for submission definition selection + * @type {DynamicSelectModel} + */ + submissionDefinitionSelection: DynamicSelectModel = new DynamicSelectModel(collectionFormSubmissionDefinitionSelectionConfig); + + /** + * The dynamic form field used for correction submission definition selection + * @type {DynamicSelectModel} + */ + correctionSubmissionDefinitionSelection: DynamicSelectModel = new DynamicSelectModel(collectionFormCorrectionSubmissionDefinitionSelectionConfig); + + sharedWorkspaceChekbox: DynamicCheckboxModel = new DynamicCheckboxModel(collectionFormSharedWorkspaceCheckboxConfig); + /** * The dynamic form fields used for creating/editing a collection * @type {DynamicFormControlModel[]} @@ -94,6 +120,7 @@ export class CollectionFormComponent extends ComColFormComponent imp protected objectCache: ObjectCacheService, protected entityTypeService: EntityTypeDataService, protected chd: ChangeDetectorRef, + protected submissionDefinitionService: SubmissionDefinitionsConfigDataService, protected modalService: NgbModal) { super(formService, translate, notificationsService, authService, requestService, objectCache, modalService); } @@ -117,35 +144,76 @@ export class CollectionFormComponent extends ComColFormComponent imp initializeForm() { let currentRelationshipValue: MetadataValue[]; + let currentDefinitionValue: MetadataValue[]; + let currentCorrectionDefinitionValue: MetadataValue[]; + let currentSharedWorkspaceValue: MetadataValue[]; if (this.dso && this.dso.metadata) { currentRelationshipValue = this.dso.metadata['dspace.entity.type']; + currentDefinitionValue = this.dso.metadata['cris.submission.definition']; + currentCorrectionDefinitionValue = this.dso.metadata['cris.submission.definition-correction']; + currentSharedWorkspaceValue = this.dso.metadata['cris.workspace.shared']; } const entities$: Observable = this.entityTypeService.findAll({ elementsPerPage: 100, currentPage: 1 }).pipe( getFirstSucceededRemoteListPayload(), ); - // retrieve all entity types to populate the dropdowns selection - entities$.subscribe((entityTypes: ItemType[]) => { - - entityTypes = entityTypes.filter((type: ItemType) => type.label !== NONE_ENTITY_TYPE); - entityTypes.forEach((type: ItemType, index: number) => { - this.entityTypeSelection.add({ - disabled: false, - label: type.label, - value: type.label, - } as DynamicFormOptionConfig); - if (currentRelationshipValue && currentRelationshipValue.length > 0 && currentRelationshipValue[0].value === type.label) { - this.entityTypeSelection.select(index); - this.entityTypeSelection.disabled = true; - } - }); + const definitions$: Observable = this.submissionDefinitionService + .findAll({ elementsPerPage: 100, currentPage: 1 }).pipe( + getFirstSucceededRemoteListPayload(), + catchError(() => of([])), + ); + + // retrieve all entity types and submission definitions to populate the dropdowns selection + combineLatest([entities$, definitions$]) + .subscribe(([entityTypes, definitions]: [ItemType[], SubmissionDefinitionModel[]]) => { + + const sortedEntityTypes = entityTypes + .filter((type: ItemType) => type.label !== NONE_ENTITY_TYPE) + .sort((a, b) => a.label.localeCompare(b.label)); + + sortedEntityTypes.forEach((type: ItemType, index: number) => { + this.entityTypeSelection.add({ + disabled: false, + label: type.label, + value: type.label, + } as DynamicFormOptionConfig); + if (currentRelationshipValue && currentRelationshipValue.length > 0 && currentRelationshipValue[0].value === type.label) { + this.entityTypeSelection.select(index); + this.entityTypeSelection.disabled = true; + } + }); - this.formModel = entityTypes.length === 0 ? collectionFormModels : [...collectionFormModels, this.entityTypeSelection]; + definitions.forEach((definition: SubmissionDefinitionModel, index: number) => { + this.submissionDefinitionSelection.add({ + disabled: false, + label: definition.name, + value: definition.name, + } as DynamicFormOptionConfig); + this.correctionSubmissionDefinitionSelection.add({ + disabled: false, + label: definition.name, + value: definition.name, + } as DynamicFormOptionConfig); + if (currentDefinitionValue && currentDefinitionValue.length > 0 && currentDefinitionValue[0].value === definition.name) { + this.submissionDefinitionSelection.select(index); + } + if (currentCorrectionDefinitionValue && currentCorrectionDefinitionValue.length > 0 && currentCorrectionDefinitionValue[0].value === definition.name) { + this.correctionSubmissionDefinitionSelection.select(index); + } + }); - super.ngOnInit(); - this.chd.detectChanges(); - }); + this.formModel = entityTypes.length === 0 ? + [...collectionFormModels, this.submissionDefinitionSelection, this.correctionSubmissionDefinitionSelection, this.sharedWorkspaceChekbox] : + [...collectionFormModels, this.entityTypeSelection, this.submissionDefinitionSelection, this.correctionSubmissionDefinitionSelection, this.sharedWorkspaceChekbox]; + + super.ngOnInit(); + + if (currentSharedWorkspaceValue && currentSharedWorkspaceValue.length > 0) { + this.sharedWorkspaceChekbox.value = currentSharedWorkspaceValue[0].value === 'true'; + } + this.chd.detectChanges(); + }); } } diff --git a/src/app/collection-page/collection-form/collection-form.models.ts b/src/app/collection-page/collection-form/collection-form.models.ts index 90204c246f6..b7eaf36953c 100644 --- a/src/app/collection-page/collection-form/collection-form.models.ts +++ b/src/app/collection-page/collection-form/collection-form.models.ts @@ -1,4 +1,5 @@ import { + DynamicCheckboxModelConfig, DynamicFormControlModel, DynamicInputModel, DynamicSelectModelConfig, @@ -10,6 +11,38 @@ import { environment } from '../../../environments/environment'; export const collectionFormEntityTypeSelectionConfig: DynamicSelectModelConfig = { id: 'entityType', name: 'dspace.entity.type', + required: true, + disabled: false, + validators: { + required: null, + }, + errorMessages: { + required: 'collection.form.errors.entityType.required', + }, +}; + +export const collectionFormSubmissionDefinitionSelectionConfig: DynamicSelectModelConfig = { + id: 'submissionDefinition', + name: 'cris.submission.definition', + required: true, + disabled: false, + validators: { + required: null, + }, + errorMessages: { + required: 'collection.form.errors.submissionDefinition.required', + }, +}; +export const collectionFormCorrectionSubmissionDefinitionSelectionConfig: DynamicSelectModelConfig = { + id: 'correctionSubmissionDefinition', + name: 'cris.submission.definition-correction', + required: false, + disabled: false, +}; + +export const collectionFormSharedWorkspaceCheckboxConfig: DynamicCheckboxModelConfig = { + id: 'sharedWorkspace', + name: 'cris.workspace.shared', disabled: false, }; diff --git a/src/app/core/config/submission-definitions-config-data.service.ts b/src/app/core/config/submission-definitions-config-data.service.ts new file mode 100644 index 00000000000..1748f57cac7 --- /dev/null +++ b/src/app/core/config/submission-definitions-config-data.service.ts @@ -0,0 +1,36 @@ +import { Injectable } from '@angular/core'; +import { FollowLinkConfig } from '@dspace/core/shared/follow-link-config.model'; +import { Observable } from 'rxjs'; +import { + mergeMap, + take, +} from 'rxjs/operators'; + +import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service'; +import { ObjectCacheService } from '../cache/object-cache.service'; +import { FindListOptions } from '../data/find-list-options.model'; +import { PaginatedList } from '../data/paginated-list.model'; +import { RemoteData } from '../data/remote-data'; +import { RequestService } from '../data/request.service'; +import { HALEndpointService } from '../shared/hal-endpoint.service'; +import { ConfigDataService } from './config-data.service'; +import { ConfigObject } from './models/config.model'; + +@Injectable({ providedIn: 'root' }) +export class SubmissionDefinitionsConfigDataService extends ConfigDataService { + constructor( + protected requestService: RequestService, + protected rdbService: RemoteDataBuildService, + protected objectCache: ObjectCacheService, + protected halService: HALEndpointService, + ) { + super('submissiondefinitions', requestService, rdbService, objectCache, halService); + } + + findAll(options: FindListOptions = {}, useCachedVersionIfAvailable = true, reRequestOnStale = true, ...linksToFollow: FollowLinkConfig[]): Observable>> { + return this.getBrowseEndpoint(options).pipe( + take(1), + mergeMap((href: string) => super.findListByHref(href, options, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow)), + ); + } +} diff --git a/src/app/core/data-services-map.ts b/src/app/core/data-services-map.ts index 77f39e080dd..ea7d3b51996 100644 --- a/src/app/core/data-services-map.ts +++ b/src/app/core/data-services-map.ts @@ -58,6 +58,8 @@ import { VERSION } from './shared/version.resource-type'; import { VERSION_HISTORY } from './shared/version-history.resource-type'; import { USAGE_REPORT } from './statistics/models/usage-report.resource-type'; import { CorrectionType } from './submission/models/correctiontype.model'; +import { EditItem } from './submission/models/edititem.model'; +import { METADATA_SECURITY_TYPE } from './submission/models/metadata-security-config.resource-type'; import { SUBMISSION_CC_LICENSE } from './submission/models/submission-cc-licence.resource-type'; import { SUBMISSION_CC_LICENSE_URL } from './submission/models/submission-cc-licence-link.resource-type'; import { @@ -138,4 +140,6 @@ export const LAZY_DATA_SERVICES: LazyDataServicesMap = new Map([ [DUPLICATE.value, () => import('./submission/submission-duplicate-data.service').then(m => m.SubmissionDuplicateDataService)], [CorrectionType.type.value, () => import('./submission/correctiontype-data.service').then(m => m.CorrectionTypeDataService)], [AUDIT.value, () => import('./data/audit-data.service').then(m => m.AuditDataService)], + [EditItem.type.value, () => import('./submission/edititem-data.service').then(m => m.EditItemDataService)], + [METADATA_SECURITY_TYPE.value, () => import('./submission/metadatasecurityconfig-data.service').then(m => m.MetadataSecurityConfigurationService)], ]); diff --git a/src/app/core/data/remote-data.ts b/src/app/core/data/remote-data.ts index 935d2a95d27..5ea4f612308 100644 --- a/src/app/core/data/remote-data.ts +++ b/src/app/core/data/remote-data.ts @@ -12,6 +12,7 @@ import { isSuccessStale, RequestEntryState, } from './request-entry-state.model'; +import { PathableObjectError } from './response-state.model'; /** * A class to represent the state of a remote resource @@ -25,6 +26,7 @@ export class RemoteData { public errorMessage?: string, public payload?: T, public statusCode?: number, + public errors?: PathableObjectError[], ) { } diff --git a/src/app/core/data/response-state.model.ts b/src/app/core/data/response-state.model.ts index 1f7863e9c8a..71b97043801 100644 --- a/src/app/core/data/response-state.model.ts +++ b/src/app/core/data/response-state.model.ts @@ -1,6 +1,14 @@ import { HALLink } from '../shared/hal-link.model'; import { UnCacheableObject } from '../shared/uncacheable-object.model'; +/** + * Interface for rest error associated to a path + */ +export interface PathableObjectError { + message: string; + paths: string[]; +} + /** * The response substate in the NgRx store */ @@ -8,6 +16,7 @@ export class ResponseState { timeCompleted: number; statusCode: number; errorMessage?: string; + errors?: PathableObjectError[]; payloadLink?: HALLink; unCacheableObject?: UnCacheableObject; } diff --git a/src/app/core/json-patch/builder/json-patch-operations-builder.ts b/src/app/core/json-patch/builder/json-patch-operations-builder.ts index d18c3ec5e95..707f8be12c7 100644 --- a/src/app/core/json-patch/builder/json-patch-operations-builder.ts +++ b/src/app/core/json-patch/builder/json-patch-operations-builder.ts @@ -45,13 +45,14 @@ export class JsonPatchOperationsBuilder { * A boolean representing if the value to be added is the first of an array * @param plain * A boolean representing if the value to be added is a plain text value + * @param languages */ - add(path: JsonPatchOperationPathObject, value, first = false, plain = false) { + add(path: JsonPatchOperationPathObject, value, first = false, plain = false, languages: string[] = null) { this.store.dispatch( new NewPatchAddOperationAction( path.rootElement, path.subRootElement, - path.path, this.prepareValue(value, plain, first))); + path.path, this.prepareValue(value, plain, first, languages))); } /** @@ -63,8 +64,9 @@ export class JsonPatchOperationsBuilder { * the value to update the referenced path * @param plain * a boolean representing if the value to be added is a plain text value + * @param language */ - replace(path: JsonPatchOperationPathObject, value, plain = false) { + replace(path: JsonPatchOperationPathObject, value, plain = false, language = null) { if (hasNoValue(value) || (typeof value === 'object' && hasNoValue(value.value))) { this.remove(path); } else { @@ -73,7 +75,7 @@ export class JsonPatchOperationsBuilder { path.rootElement, path.subRootElement, path.path, - this.prepareValue(value, plain, false))); + this.prepareValue(value, plain, false, language))); } } @@ -124,7 +126,7 @@ export class JsonPatchOperationsBuilder { path.path)); } - protected prepareValue(value: any, plain: boolean, first: boolean) { + protected prepareValue(value: any, plain: boolean, first: boolean, languages: string[] = null) { let operationValue: any = null; if (hasValue(value)) { if (plain) { diff --git a/src/app/core/shared/dspace-object.model.ts b/src/app/core/shared/dspace-object.model.ts index e155117d5a6..fa4f4a37115 100644 --- a/src/app/core/shared/dspace-object.model.ts +++ b/src/app/core/shared/dspace-object.model.ts @@ -126,6 +126,20 @@ export class DSpaceObject extends ListableObject implements CacheableObject { return Metadata.all(this.metadata, keyOrKeys, undefined, valueFilter, escapeHTML); } + + /** + * Gets all matching metadata in this DSpaceObject, up to a limit. + * + * @param {string|string[]} keyOrKeys The metadata key(s) in scope. Wildcards are supported; see [[Metadata]]. + * @param {number} limit The maximum number of results to return. + * @param {MetadataValueFilter} valueFilter The value filter to use. If unspecified, no filtering will be done. + * @returns {MetadataValue[]} the matching values or an empty array. + */ + limitedMetadata(keyOrKeys: string | string[], limit: number, valueFilter?: MetadataValueFilter): MetadataValue[] { + return Metadata.all(this.metadata, keyOrKeys, null, valueFilter, false, limit); + } + + /** * Like [[allMetadata]], but only returns string values. * diff --git a/src/app/core/shared/form/models/form-field-metadata-value.model.ts b/src/app/core/shared/form/models/form-field-metadata-value.model.ts index 0362b3dd4e7..725cadb7b47 100644 --- a/src/app/core/shared/form/models/form-field-metadata-value.model.ts +++ b/src/app/core/shared/form/models/form-field-metadata-value.model.ts @@ -10,6 +10,7 @@ import { MetadataValueInterface, VIRTUAL_METADATA_PREFIX, } from '../../metadata.models'; +import { Metadata } from '../../metadata.utils'; import { PLACEHOLDER_PARENT_METADATA } from '../ds-dynamic-form-constants'; export interface OtherInformation { @@ -32,23 +33,28 @@ export class FormFieldMetadataValueObject implements MetadataValueInterface { confidence: ConfidenceType; place: number; label: string; + securityLevel: number; + source: string; otherInformation: OtherInformation; constructor(value: any = null, language: any = null, + securityLevel: any = null, authority: string = null, display: string = null, place: number = 0, confidence: number = null, otherInformation: any = null, - metadata: string = null) { + source: string = null, + metadata: string = null, + ) { this.value = isNotNull(value) ? ((typeof value === 'string') ? value.trim() : value) : null; this.language = language; this.authority = authority; this.display = display || value; - + this.securityLevel = securityLevel; this.confidence = confidence; - if (authority != null && (isEmpty(confidence) || confidence === -1)) { + if (Metadata.hasValidAuthority(authority) && (isEmpty(confidence) || confidence === -1)) { this.confidence = ConfidenceType.CF_ACCEPTED; } else if (isNotEmpty(confidence)) { this.confidence = confidence; @@ -60,7 +66,7 @@ export class FormFieldMetadataValueObject implements MetadataValueInterface { if (isNotEmpty(metadata)) { this.metadata = metadata; } - + this.source = source; this.otherInformation = otherInformation; } @@ -68,7 +74,7 @@ export class FormFieldMetadataValueObject implements MetadataValueInterface { * Returns true if this this object has an authority value */ hasAuthority(): boolean { - return isNotEmpty(this.authority); + return Metadata.hasValidAuthority(this.authority); } /** @@ -99,6 +105,14 @@ export class FormFieldMetadataValueObject implements MetadataValueInterface { return this.hasValue() && this.value === PLACEHOLDER_PARENT_METADATA; } + /** + * Returns true if this object value contains a placeholder + */ + hasSecurityLevel() { + return isNotEmpty(this.securityLevel); + } + + /** * Returns true if this Metadatum's authority key starts with 'virtual::' */ diff --git a/src/app/core/shared/form/models/form-field.model.ts b/src/app/core/shared/form/models/form-field.model.ts index 5359ff5a99b..2d6b6e441f8 100644 --- a/src/app/core/shared/form/models/form-field.model.ts +++ b/src/app/core/shared/form/models/form-field.model.ts @@ -126,6 +126,9 @@ export class FormFieldModel { @autoserialize value: any; + /** + * The visibility object for this field + */ @autoserialize visibility: SectionVisibility; } diff --git a/src/app/core/shared/item.model.ts b/src/app/core/shared/item.model.ts index 06fc0b01e84..33bf918bb49 100644 --- a/src/app/core/shared/item.model.ts +++ b/src/app/core/shared/item.model.ts @@ -99,6 +99,13 @@ export class Item extends DSpaceObject implements ChildHALResource, HandleObject @autoserializeAs(Boolean, 'withdrawn') isWithdrawn: boolean; + /** + * A string representing the entity type of this Item + */ + @autoserializeAs(String, 'entityType') + entityType: string; + + /** * The {@link HALLink}s for this Item */ diff --git a/src/app/core/shared/metadata.models.ts b/src/app/core/shared/metadata.models.ts index 15cfeb285e6..2082c645e33 100644 --- a/src/app/core/shared/metadata.models.ts +++ b/src/app/core/shared/metadata.models.ts @@ -6,6 +6,7 @@ import { } from 'cerialize'; import { v4 as uuidv4 } from 'uuid'; + export const VIRTUAL_METADATA_PREFIX = 'virtual::'; /** A single metadata value and its properties. */ @@ -56,6 +57,9 @@ export class MetadataValue implements MetadataValueInterface { @autoserialize confidence: number; + /** The security level value */ + @autoserialize + securityLevel: number; } /** Constraints for matching metadata values. */ @@ -74,6 +78,10 @@ export interface MetadataValueFilter { /** Whether the value constraint should match as a substring. */ substring?: boolean; + /** + * Whether to negate the filter + */ + negate?: boolean; } export class MetadatumViewModel { @@ -100,6 +108,9 @@ export class MetadatumViewModel { /** The authority confidence value */ confidence: number; + + /** The security level value */ + securityLevel: number; } /** Serializer used for MetadataMaps. diff --git a/src/app/core/shared/metadata.utils.spec.ts b/src/app/core/shared/metadata.utils.spec.ts index f3ca5d82e7d..0333d114cad 100644 --- a/src/app/core/shared/metadata.utils.spec.ts +++ b/src/app/core/shared/metadata.utils.spec.ts @@ -50,11 +50,11 @@ const multiViewModelList = [ { key: 'foo', ...bar, order: 0 }, ]; -const testMethod = (fn, resultKind, mapOrMaps, keyOrKeys, hitHighlights, expected, filter?) => { +const testMethod = (fn, resultKind, mapOrMaps, keyOrKeys, hitHighlights, expected, filter?, limit?: number) => { const keys = keyOrKeys instanceof Array ? keyOrKeys : [keyOrKeys]; describe('and key' + (keys.length === 1 ? (' ' + keys[0]) : ('s ' + JSON.stringify(keys))) + ' with ' + (isUndefined(filter) ? 'no filter' : 'filter ' + JSON.stringify(filter)), () => { - const result = fn(mapOrMaps, keys, hitHighlights, filter); + const result = fn(mapOrMaps, keys, hitHighlights, filter, true, limit); let shouldReturn; if (resultKind === 'boolean') { shouldReturn = expected; @@ -62,7 +62,8 @@ const testMethod = (fn, resultKind, mapOrMaps, keyOrKeys, hitHighlights, expecte shouldReturn = 'undefined'; } else if (expected instanceof Array) { shouldReturn = 'an array with ' + expected.length + ' ' + (expected.length > 1 ? 'ordered ' : '') - + resultKind + (expected.length !== 1 ? 's' : ''); + + resultKind + (expected.length !== 1 ? 's' : '') + + (isUndefined(limit) ? '' : ' (limited to ' + limit + ')'); } else { shouldReturn = 'a ' + resultKind; } @@ -255,4 +256,60 @@ describe('Metadata', () => { }); + describe('all method with limit', () => { + const testAllWithLimit = (mapOrMaps, keyOrKeys, expected, limit) => + testMethod(Metadata.all, 'value', mapOrMaps, keyOrKeys, undefined, expected, undefined, limit); + + describe('with multiMap and limit', () => { + testAllWithLimit(multiMap, 'dc.title', [dcTitle1], 1); + }); + }); + + describe('hasValue method', () => { + const testHasValue = (value, expected) => + testMethod(Metadata.hasValue, 'boolean', value, undefined, undefined, expected); + + describe('with undefined value', () => { + testHasValue(undefined, false); + }); + describe('with null value', () => { + testHasValue(null, false); + }); + describe('with string value', () => { + testHasValue('test', true); + }); + describe('with empty string value', () => { + testHasValue('', false); + }); + describe('with undefined value for a MetadataValue object', () => { + const value: Partial = { + value: undefined, + }; + testHasValue(value, false); + }); + describe('with null value for a MetadataValue object', () => { + const value: Partial = { + value: null, + }; + testHasValue(value, false); + }); + describe('with empty string for a MetadataValue object', () => { + const value: Partial = { + value: '', + }; + testHasValue(value, false); + }); + describe('with value for a MetadataValue object', () => { + const value: Partial = { + value: 'test', + }; + testHasValue(value, true); + }); + describe('with a generic object', () => { + const value: any = { + test: 'test', + }; + testHasValue(value, true); + }); + }); }); diff --git a/src/app/core/shared/metadata.utils.ts b/src/app/core/shared/metadata.utils.ts index b44362a3ff5..b7f1db6476a 100644 --- a/src/app/core/shared/metadata.utils.ts +++ b/src/app/core/shared/metadata.utils.ts @@ -1,11 +1,15 @@ import { + hasValue, + isEmpty, isNotEmpty, isNotUndefined, isUndefined, } from '@dspace/shared/utils/empty.util'; import escape from 'lodash/escape'; import groupBy from 'lodash/groupBy'; +import isObject from 'lodash/isObject'; import sortBy from 'lodash/sortBy'; +import { validate as uuidValidate } from 'uuid'; import { MetadataMapInterface, @@ -14,6 +18,11 @@ import { MetadatumViewModel, } from './metadata.models'; + + +export const AUTHORITY_GENERATE = 'will be generated::'; +export const AUTHORITY_REFERENCE = 'will be referenced::'; +export const PLACEHOLDER_VALUE = '#PLACEHOLDER_PARENT_METADATA_VALUE#'; /** * Utility class for working with DSpace object metadata. * @@ -39,13 +48,13 @@ export class Metadata { * @param escapeHTML Whether the HTML is used inside a `[innerHTML]` attribute * @returns {MetadataValue[]} the matching values or an empty array. */ - public static all(metadata: MetadataMapInterface, keyOrKeys: string | string[], hitHighlights?: MetadataMapInterface, filter?: MetadataValueFilter, escapeHTML?: boolean): MetadataValue[] { + public static all(metadata: MetadataMapInterface, keyOrKeys: string | string[], hitHighlights?: MetadataMapInterface, filter?: MetadataValueFilter, escapeHTML?: boolean, limit?: number): MetadataValue[] { const matches: MetadataValue[] = []; if (isNotEmpty(hitHighlights)) { for (const mdKey of Metadata.resolveKeys(hitHighlights, keyOrKeys)) { if (hitHighlights[mdKey]) { for (const candidate of hitHighlights[mdKey]) { - if (Metadata.valueMatches(candidate as MetadataValue, filter)) { + if (Metadata.valueMatches(candidate as MetadataValue, filter) && (isEmpty(limit) || (hasValue(limit) && matches.length < limit))) { matches.push(candidate as MetadataValue); } } @@ -58,7 +67,7 @@ export class Metadata { for (const mdKey of Metadata.resolveKeys(metadata, keyOrKeys)) { if (metadata[mdKey]) { for (const candidate of metadata[mdKey]) { - if (Metadata.valueMatches(candidate as MetadataValue, filter)) { + if (Metadata.valueMatches(candidate as MetadataValue, filter) && (isEmpty(limit) || (hasValue(limit) && matches.length < limit))) { if (escapeHTML) { matches.push(Object.assign(new MetadataValue(), candidate, { value: escape(candidate.value), @@ -148,6 +157,40 @@ export class Metadata { return isNotUndefined(Metadata.first(metadata, keyOrKeys, hitHighlights, filter)); } + + /** + * Returns true if this Metadatum's authority key contains a reference + */ + public static hasAuthorityReference(authority: string): boolean { + return hasValue(authority) && (typeof authority === 'string' && (authority.startsWith(AUTHORITY_GENERATE) || authority.startsWith(AUTHORITY_REFERENCE))); + } + + /** + * Returns true if this Metadatum's authority key is a valid + */ + public static hasValidAuthority(authority: string): boolean { + return hasValue(authority) && !Metadata.hasAuthorityReference(authority); + } + + /** + * Returns true if this Metadatum's authority key is a valid UUID + */ + public static hasValidItemAuthority(authority: string): boolean { + return hasValue(authority) && uuidValidate(authority); + } + + /** + * Returns true if this Metadatum's value is defined + */ + public static hasValue(value: MetadataValue|string): boolean { + if (isEmpty(value)) { + return false; + } + if (isObject(value) && value.hasOwnProperty('value')) { + return isNotEmpty(value.value); + } + return true; + } /** * Checks if a value matches a filter. * @@ -169,11 +212,14 @@ export class Metadata { fValue = filter.value.toLowerCase(); mValue = mdValue.value.toLowerCase(); } + let result: boolean; + if (filter.substring) { - return mValue.includes(fValue); + result = mValue.includes(fValue); } else { - return mValue === fValue; + result = mValue === fValue; } + return filter.negate ? !result : result; } return true; } diff --git a/src/app/core/submission/edititem-data.service.spec.ts b/src/app/core/submission/edititem-data.service.spec.ts new file mode 100644 index 00000000000..78de27d50aa --- /dev/null +++ b/src/app/core/submission/edititem-data.service.spec.ts @@ -0,0 +1,126 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { TestBed } from '@angular/core/testing'; +import { cold } from 'jasmine-marbles'; +import { of } from 'rxjs'; + +import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service'; +import { ObjectCacheService } from '../cache/object-cache.service'; +import { PaginatedList } from '../data/paginated-list.model'; +import { RequestService } from '../data/request.service'; +import { NotificationsService } from '../notification-system/notifications.service'; +import { HALEndpointService } from '../shared/hal-endpoint.service'; +import { createSuccessfulRemoteDataObject } from '../utilities/remote-data.utils'; +import { EditItemDataService } from './edititem-data.service'; +import { EditItemMode } from './models/edititem-mode.model'; + +describe('EditItemDataService', () => { + + let service: EditItemDataService; + let requestService: RequestService; + + const requestServiceStub = jasmine.createSpyObj('RequestService', [ + 'setStaleByHrefSubstring', + ]); + + const rdbServiceStub = {} as RemoteDataBuildService; + const objectCacheStub = {} as ObjectCacheService; + const halServiceStub = {} as HALEndpointService; + const notificationsServiceStub = {} as NotificationsService; + + const editModes: EditItemMode[] = [ + { uuid: 'mode-1', name: 'quickedit' } as EditItemMode, + { uuid: 'mode-2', name: 'full' } as EditItemMode, + ]; + + const paginatedList = { + page: editModes, + } as PaginatedList; + + const successfulRD = createSuccessfulRemoteDataObject(paginatedList); + + beforeEach(() => { + + TestBed.configureTestingModule({ + providers: [ + EditItemDataService, + { provide: RequestService, useValue: requestServiceStub }, + { provide: RemoteDataBuildService, useValue: rdbServiceStub }, + { provide: ObjectCacheService, useValue: objectCacheStub }, + { provide: HALEndpointService, useValue: halServiceStub }, + { provide: NotificationsService, useValue: notificationsServiceStub }, + ], + }); + + service = TestBed.inject(EditItemDataService); + + spyOn((service as any).searchData, 'searchBy') + .and.returnValue(of(successfulRD)); + }); + + afterEach(() => { + service = null; + }); + + + describe('searchEditModesById', () => { + + it('should call SearchDataImpl.searchBy with correct parameters', () => { + + service.searchEditModesById('test-id').subscribe(); + + expect((service as any).searchData.searchBy) + .toHaveBeenCalled(); + }); + + it('should return edit modes', () => { + + const result = service.searchEditModesById('test-id'); + + const expected = cold('(a|)', { a: successfulRD }); + + expect(result).toBeObservable(expected); + }); + + }); + + describe('checkEditModeByIdAndType', () => { + + it('should return TRUE when edit mode exists', () => { + + const result = service.checkEditModeByIdAndType('test-id', 'mode-1'); + + const expected = cold('(a|)', { a: true }); + + expect(result).toBeObservable(expected); + }); + + it('should return FALSE when edit mode does not exist', () => { + + const result = service.checkEditModeByIdAndType('test-id', 'unknown-mode'); + + const expected = cold('(a|)', { a: false }); + + expect(result).toBeObservable(expected); + }); + + }); + + describe('invalidateItemCache', () => { + + it('should mark requests as stale', () => { + + service.invalidateItemCache('1234'); + + expect(requestServiceStub.setStaleByHrefSubstring) + .toHaveBeenCalledWith('findModesById?uuid=1234'); + }); + + }); + +}); diff --git a/src/app/core/submission/edititem-data.service.ts b/src/app/core/submission/edititem-data.service.ts new file mode 100644 index 00000000000..8f63c6477aa --- /dev/null +++ b/src/app/core/submission/edititem-data.service.ts @@ -0,0 +1,96 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Injectable } from '@angular/core'; +import { Observable } from 'rxjs'; +import { map } from 'rxjs/operators'; + +import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service'; +import { RequestParam } from '../cache/models/request-param.model'; +import { ObjectCacheService } from '../cache/object-cache.service'; +import { DeleteDataImpl } from '../data/base/delete-data'; +import { IdentifiableDataService } from '../data/base/identifiable-data.service'; +import { SearchDataImpl } from '../data/base/search-data'; +import { FindListOptions } from '../data/find-list-options.model'; +import { PaginatedList } from '../data/paginated-list.model'; +import { RemoteData } from '../data/remote-data'; +import { RequestService } from '../data/request.service'; +import { NotificationsService } from '../notification-system/notifications.service'; +import { HALEndpointService } from '../shared/hal-endpoint.service'; +import { + getAllSucceededRemoteDataPayload, + getPaginatedListPayload, +} from '../shared/operators'; +import { EditItem } from './models/edititem.model'; +import { EditItemMode } from './models/edititem-mode.model'; + +/** + * A service that provides methods to make REST requests with edititems endpoint. + */ +@Injectable({ providedIn: 'root' }) +export class EditItemDataService extends IdentifiableDataService { + protected linkPath = 'edititems'; + protected searchById = 'findModesById'; + private searchData: SearchDataImpl; + private deleteData: DeleteDataImpl; + + constructor( + protected requestService: RequestService, + protected rdbService: RemoteDataBuildService, + protected objectCache: ObjectCacheService, + protected halService: HALEndpointService, + protected notificationsService: NotificationsService, + ) { + super('edititems', requestService, rdbService, objectCache, halService); + + this.searchData = new SearchDataImpl(this.linkPath, requestService, rdbService, objectCache, halService, this.responseMsToLive); + this.deleteData = new DeleteDataImpl(this.linkPath, requestService, rdbService, objectCache, halService, notificationsService, this.responseMsToLive, this.constructIdEndpoint); + } + + /** + * Search for editModes from the editItem id + * + * @param id string id of edit item + * @param useCachedVersionIfAvailable If this is true, the request will only be sent if there's + * no valid cached version. Defaults to true + * @param reRequestOnStale Whether or not the request should automatically be re- + * requested after the response becomes stale + * @return Paginated list of edit item modes + */ + searchEditModesById(id: string, useCachedVersionIfAvailable = true, reRequestOnStale = true): Observable>> { + const options = new FindListOptions(); + options.searchParams = [ + new RequestParam('uuid', id, false), + ]; + return this.searchData.searchBy(this.searchById, options, useCachedVersionIfAvailable, reRequestOnStale); + } + + /** + * Check if editMode with id is part of the edit item with id + * + * @param id string id of edit item + * @param editModeId string id of edit item + * @return boolean + */ + checkEditModeByIdAndType(id: string, editModeId: string) { + return this.searchEditModesById(id).pipe( + getAllSucceededRemoteDataPayload(), + getPaginatedListPayload(), + map((editModes: EditItemMode[]) => { + return !!editModes.find(editMode => editMode.uuid === editModeId); + })); + } + + /** + * Invalidate the cache of the editMode + * @param id + */ + invalidateItemCache(id: string) { + this.requestService.setStaleByHrefSubstring('findModesById?uuid=' + id); + } + +} diff --git a/src/app/core/submission/metadatasecurityconfig-data.service.ts b/src/app/core/submission/metadatasecurityconfig-data.service.ts new file mode 100644 index 00000000000..5d73a96077f --- /dev/null +++ b/src/app/core/submission/metadatasecurityconfig-data.service.ts @@ -0,0 +1,37 @@ +import { Injectable } from '@angular/core'; +import { Observable } from 'rxjs'; + +import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service'; +import { ObjectCacheService } from '../cache/object-cache.service'; +import { IdentifiableDataService } from '../data/base/identifiable-data.service'; +import { RemoteData } from '../data/remote-data'; +import { RequestService } from '../data/request.service'; +import { HALEndpointService } from '../shared/hal-endpoint.service'; +import { MetadataSecurityConfiguration } from './models/metadata-security-configuration'; + +/** + * A service that provides methods to make REST requests with securitysettings endpoint. + */ +@Injectable({ + providedIn: 'root', +}) +export class MetadataSecurityConfigurationService extends IdentifiableDataService { + + constructor( + protected requestService: RequestService, + protected rdbService: RemoteDataBuildService, + protected objectCache: ObjectCacheService, + protected halService: HALEndpointService, + ) { + super('securitysettings', requestService, rdbService, objectCache, halService); + } + + /** + * It provides the configuration for metadata security + * @param entityType + */ + findById(entityType: string): Observable> { + return super.findById(entityType); + } +} + diff --git a/src/app/core/submission/models/edititem-mode.model.ts b/src/app/core/submission/models/edititem-mode.model.ts new file mode 100644 index 00000000000..b52d4825acc --- /dev/null +++ b/src/app/core/submission/models/edititem-mode.model.ts @@ -0,0 +1,70 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { + autoserialize, + deserialize, + deserializeAs, +} from 'cerialize'; + +import { typedObject } from '../../cache/builders/build-decorators'; +import { CacheableObject } from '../../cache/cacheable-object.model'; +import { IDToUUIDSerializer } from '../../cache/id-to-uuid-serializer'; +import { HALLink } from '../../shared/hal-link.model'; +import { ResourceType } from '../../shared/resource-type'; +import { excludeFromEquals } from '../../utilities/equals.decorators'; + +/** + * Describes a EditItem mode + */ +@typedObject +export class EditItemMode extends CacheableObject { + + static type = new ResourceType('edititemmode'); + + /** + * The object type + */ + @excludeFromEquals + @autoserialize + type: ResourceType; + + /** + * The universally unique identifier of this WorkspaceItem + * This UUID is generated client-side and isn't used by the backend. + * It is based on the ID, so it will be the same for each refresh. + */ + @deserializeAs(new IDToUUIDSerializer(EditItemMode.type.value), 'name') + uuid: string; + + /** + * Name of the EditItem Mode + */ + @autoserialize + name: string; + + /** + * Label used for i18n + */ + @autoserialize + label: string; + + /** + * Name of the Submission Definition used + * for this EditItem mode + */ + @autoserialize + submissionDefinition: string; + + /** + * The {@link HALLink}s for this EditItemMode + */ + @deserialize + _links: { + self: HALLink; + }; +} diff --git a/src/app/core/submission/models/edititem.model.ts b/src/app/core/submission/models/edititem.model.ts new file mode 100644 index 00000000000..cac079ff3a3 --- /dev/null +++ b/src/app/core/submission/models/edititem.model.ts @@ -0,0 +1,55 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { + deserializeAs, + inheritSerialization, +} from 'cerialize'; +import { Observable } from 'rxjs'; + +import { + inheritLinkAnnotations, + link, + typedObject, +} from '../../cache/builders/build-decorators'; +import { IDToUUIDSerializer } from '../../cache/id-to-uuid-serializer'; +import { PaginatedList } from '../../data/paginated-list.model'; +import { RemoteData } from '../../data/remote-data'; +import { ResourceType } from '../../shared/resource-type'; +import { EditItemMode } from './edititem-mode.model'; +import { SubmissionObject } from './submission-object.model'; + +/** + * A model class for a EditItem. + */ +@typedObject +@inheritSerialization(SubmissionObject) +@inheritLinkAnnotations(SubmissionObject) +export class EditItem extends SubmissionObject { + static type = new ResourceType('edititem'); + + /** + * The universally unique identifier of this WorkspaceItem + * This UUID is generated client-side and isn't used by the backend. + * It is based on the ID, so it will be the same for each refresh. + */ + @deserializeAs(new IDToUUIDSerializer(EditItem.type.value), 'id') + uuid: string; + + /** + * Existing EditItem modes for current EditItem + * Will be undefined unless the modes {@link HALLink} has been resolved. + */ + @link(EditItemMode.type) + modes?: Observable>>; + /** + * Existing EditItem modes for current EditItem + * Will be undefined unless the modes {@link HALLink} has been resolved. + */ + @link(EditItemMode.type) + edititemmodes?: Observable>>; +} diff --git a/src/app/core/submission/models/metadata-security-config.resource-type.ts b/src/app/core/submission/models/metadata-security-config.resource-type.ts new file mode 100644 index 00000000000..825352d5b23 --- /dev/null +++ b/src/app/core/submission/models/metadata-security-config.resource-type.ts @@ -0,0 +1,4 @@ +import { ResourceType } from '../../shared/resource-type'; + + +export const METADATA_SECURITY_TYPE = new ResourceType('securitysetting'); diff --git a/src/app/core/submission/models/metadata-security-configuration.ts b/src/app/core/submission/models/metadata-security-configuration.ts new file mode 100644 index 00000000000..e0dec03aeeb --- /dev/null +++ b/src/app/core/submission/models/metadata-security-configuration.ts @@ -0,0 +1,54 @@ +import { + autoserialize, + deserialize, + deserializeAs, +} from 'cerialize'; + +import { typedObject } from '../../cache/builders/build-decorators'; +import { CacheableObject } from '../../cache/cacheable-object.model'; +import { IDToUUIDSerializer } from '../../cache/id-to-uuid-serializer'; +import { HALLink } from '../../shared/hal-link.model'; +import { ResourceType } from '../../shared/resource-type'; +import { excludeFromEquals } from '../../utilities/equals.decorators'; +import { METADATA_SECURITY_TYPE } from './metadata-security-config.resource-type'; + +interface MetadataCustomSecurityEntries { + [metadata: string]: number[]; +} +/** + * A model class for a security configuration of metadata. + */ +@typedObject +export class MetadataSecurityConfiguration extends CacheableObject { + static type = METADATA_SECURITY_TYPE; + /** + * The universally unique identifier of this WorkspaceItem + * This UUID is generated client-side and isn't used by the backend. + * It is based on the ID, so it will be the same for each refresh. + */ + @deserializeAs(new IDToUUIDSerializer(MetadataSecurityConfiguration.type.value), 'id') + uuid: string; + /** + * List of security configurations for all of the metadatas of the entity type + */ + @autoserialize + metadataSecurityDefault: number[]; + /** + * List of security configurations for all of the metadatas of the entity type + */ + @autoserialize + metadataCustomSecurity: MetadataCustomSecurityEntries; + /** + * The object type + */ + @excludeFromEquals + @autoserialize + type: ResourceType; + /** + * The {@link HALLink}s for this MetadataSecurityConfiguration + */ + @deserialize + _links: { + self: HALLink; + }; +} diff --git a/src/app/core/submission/models/submission-section-object.model.ts b/src/app/core/submission/models/submission-section-object.model.ts index fdce5d9e7a9..8409f2bc980 100644 --- a/src/app/core/submission/models/submission-section-object.model.ts +++ b/src/app/core/submission/models/submission-section-object.model.ts @@ -75,6 +75,11 @@ export interface SubmissionSectionObject { */ isLoading: boolean; + /** + * A boolean representing if this section removal is pending + */ + removePending: boolean; + /** * A boolean representing if this section is valid */ diff --git a/src/app/core/submission/submission-response-parsing.service.ts b/src/app/core/submission/submission-response-parsing.service.ts index 035d263e460..20c5c66e6c7 100644 --- a/src/app/core/submission/submission-response-parsing.service.ts +++ b/src/app/core/submission/submission-response-parsing.service.ts @@ -22,6 +22,7 @@ import { ResponseParsingService } from '../data/parsing.service'; import { RestRequest } from '../data/rest-request.model'; import { RawRestResponse } from '../dspace-rest/raw-rest-response.model'; import { FormFieldMetadataValueObject } from '../shared/form/models/form-field-metadata-value.model'; +import { EditItem } from './models/edititem.model'; import { SubmissionObject } from './models/submission-object.model'; import { WorkflowItem } from './models/workflowitem.model'; import { WorkspaceItem } from './models/workspaceitem.model'; @@ -56,6 +57,7 @@ export function normalizeSectionData(obj: any, objIndex?: number) { result = new FormFieldMetadataValueObject( obj.value, obj.language, + obj.securityLevel, obj.authority, (obj.display || obj.value), obj.place || objIndex, @@ -144,7 +146,8 @@ export class SubmissionResponseParsingService extends BaseResponseParsingService // item = Object.assign({}, item); // In case data is an Instance of WorkspaceItem normalize field value of all the section of type form if (item instanceof WorkspaceItem - || item instanceof WorkflowItem) { + || item instanceof WorkflowItem + || item instanceof EditItem) { if (item.sections) { const precessedSection = Object.create({}); // Iterate over all workspaceitem's sections diff --git a/src/app/core/submission/submission-rest.service.ts b/src/app/core/submission/submission-rest.service.ts index 12f94a02d2b..897882d8d17 100644 --- a/src/app/core/submission/submission-rest.service.ts +++ b/src/app/core/submission/submission-rest.service.ts @@ -91,10 +91,15 @@ export class SubmissionRestService { * The identifier for the object * @param collectionId * The owning collection for the object + * @param projections */ - protected getEndpointByIDHref(endpoint, resourceID, collectionId?: string): string { + protected getEndpointByIDHref(endpoint, resourceID, collectionId?: string, projections: string[] = []): string { let url = isNotEmpty(resourceID) ? `${endpoint}/${resourceID}` : `${endpoint}`; url = new URLCombiner(url, '?embed=item,sections,collection').toString(); + + projections.forEach((projection) => { + url = new URLCombiner(url, '&projection=' + projection).toString(); + }); if (collectionId) { url = new URLCombiner(url, `&owningCollection=${collectionId}`).toString(); } @@ -135,9 +140,9 @@ export class SubmissionRestService { * @return Observable * server response */ - public getDataById(linkName: string, id: string, useCachedVersionIfAvailable = false): Observable { + public getDataById(linkName: string, id: string, useCachedVersionIfAvailable = false, projections: string[] = []): Observable { return this.halService.getEndpoint(linkName).pipe( - map((endpointURL: string) => this.getEndpointByIDHref(endpointURL, id)), + map((endpointURL: string) => this.getEndpointByIDHref(endpointURL, id, null, projections)), filter((href: string) => isNotEmpty(href)), distinctUntilChanged(), mergeMap((endpointURL: string) => { diff --git a/src/app/core/submission/vocabularies/models/vocabulary-entry-detail.model.ts b/src/app/core/submission/vocabularies/models/vocabulary-entry-detail.model.ts index a8995db5a7e..20d29f8ccec 100644 --- a/src/app/core/submission/vocabularies/models/vocabulary-entry-detail.model.ts +++ b/src/app/core/submission/vocabularies/models/vocabulary-entry-detail.model.ts @@ -1,10 +1,16 @@ -import { typedObject } from '@dspace/core/cache/builders/build-decorators'; +import { + link, + typedObject, +} from '@dspace/core/cache/builders/build-decorators'; +import { PaginatedList } from '@dspace/core/data/paginated-list.model'; +import { RemoteData } from '@dspace/core/data/remote-data'; import { HALLink } from '@dspace/core/shared/hal-link.model'; import { autoserialize, deserialize, inheritSerialization, } from 'cerialize'; +import { Observable } from 'rxjs'; import { VOCABULARY_ENTRY_DETAIL } from './vocabularies.resource-type'; import { VocabularyEntry } from './vocabulary-entry.model'; @@ -37,7 +43,21 @@ export class VocabularyEntryDetail extends VocabularyEntry { self: HALLink; vocabulary: HALLink; parent: HALLink; - children + children: HALLink; }; + /** + * The submitter for this SubmissionObject + * Will be undefined unless the submitter {@link HALLink} has been resolved. + */ + @link(VOCABULARY_ENTRY_DETAIL) + parent?: Observable>; + + /** + * The submitter for this SubmissionObject + * Will be undefined unless the submitter {@link HALLink} has been resolved. + */ + @link(VOCABULARY_ENTRY_DETAIL, true) + children?: Observable>>; + } diff --git a/src/app/core/submission/vocabularies/models/vocabulary-entry.model.ts b/src/app/core/submission/vocabularies/models/vocabulary-entry.model.ts index 10ae406cf00..7cb7aa1c428 100644 --- a/src/app/core/submission/vocabularies/models/vocabulary-entry.model.ts +++ b/src/app/core/submission/vocabularies/models/vocabulary-entry.model.ts @@ -1,6 +1,7 @@ import { typedObject } from '@dspace/core/cache/builders/build-decorators'; import { GenericConstructor } from '@dspace/core/shared/generic-constructor'; import { HALLink } from '@dspace/core/shared/hal-link.model'; +import { Metadata } from '@dspace/core/shared/metadata.utils'; import { excludeFromEquals } from '@dspace/core/utilities/equals.decorators'; import { isNotEmpty } from '@dspace/shared/utils/empty.util'; import { @@ -44,6 +45,12 @@ export class VocabularyEntry extends ListableObject { @autoserialize otherInformation: OtherInformation; + /** + * A value representing security level value of the metadata + */ + @autoserialize + securityLevel: number; + /** * A string representing the kind of vocabulary entry */ @@ -66,7 +73,7 @@ export class VocabularyEntry extends ListableObject { * @return boolean */ hasAuthority(): boolean { - return isNotEmpty(this.authority); + return Metadata.hasValidAuthority(this.authority); } /** diff --git a/src/app/core/submission/vocabularies/models/vocabulary-find-options.model.ts b/src/app/core/submission/vocabularies/models/vocabulary-find-options.model.ts index 7c586736578..b49dfa91aaa 100644 --- a/src/app/core/submission/vocabularies/models/vocabulary-find-options.model.ts +++ b/src/app/core/submission/vocabularies/models/vocabulary-find-options.model.ts @@ -8,7 +8,9 @@ import { isNotEmpty } from '@dspace/shared/utils/empty.util'; */ export class VocabularyFindOptions extends FindListOptions { - constructor(public query: string = '', + constructor(public collection, + public metadata, + public query: string = '', public filter?: string, public exact?: boolean, public entryID?: string, @@ -19,7 +21,12 @@ export class VocabularyFindOptions extends FindListOptions { super(); const searchParams = []; - + if (isNotEmpty(metadata)) { + searchParams.push(new RequestParam('metadata', metadata)); + } + if (isNotEmpty(collection)) { + searchParams.push(new RequestParam('collection', collection)); + } if (isNotEmpty(query)) { searchParams.push(new RequestParam('query', query)); } diff --git a/src/app/core/submission/vocabularies/models/vocabulary-options.model.ts b/src/app/core/submission/vocabularies/models/vocabulary-options.model.ts index 7f54b8599d6..f7b708f5157 100644 --- a/src/app/core/submission/vocabularies/models/vocabulary-options.model.ts +++ b/src/app/core/submission/vocabularies/models/vocabulary-options.model.ts @@ -8,14 +8,28 @@ export class VocabularyOptions { */ name: string; + /** + * The metadata field name (e.g. "dc.type") for which the vocabulary is used: + */ + metadata: string; + + /** + * The uuid of the collection where the item is being submitted + */ + scope: string; + /** * A boolean representing if value is closely related to a vocabulary entry or not */ closed: boolean; constructor(name: string, + metadata?: string, + scope?: string, closed: boolean = false) { this.name = name; + this.metadata = metadata; + this.scope = scope; this.closed = closed; } } diff --git a/src/app/core/submission/vocabularies/models/vocabulary.model.ts b/src/app/core/submission/vocabularies/models/vocabulary.model.ts index bc157950e82..7de580dc185 100644 --- a/src/app/core/submission/vocabularies/models/vocabulary.model.ts +++ b/src/app/core/submission/vocabularies/models/vocabulary.model.ts @@ -19,6 +19,10 @@ import { } from './vocabularies.resource-type'; import { VocabularyEntry } from './vocabulary-entry.model'; +export interface VocabularyExternalSourceMap { + [metadata: string]: string; +} + /** * Model class for a Vocabulary */ @@ -56,6 +60,20 @@ export class Vocabulary implements CacheableObject { @autoserialize preloadLevel: any; + /** + * If externalSource is available represent the entity type that can be use to create a new entity from + * this vocabulary + */ + @autoserialize + entity: string; + + /** + * A boolean variable that indicates whether the functionality of + * multiple value generation is enabled within a generator context. + */ + @autoserialize + multiValueOnGenerator: boolean; + /** * A string representing the kind of Vocabulary model */ diff --git a/src/app/core/submission/vocabularies/vocabulary-entry-details.data.service.ts b/src/app/core/submission/vocabularies/vocabulary-entry-details.data.service.ts index fb295e17392..36be243ad22 100644 --- a/src/app/core/submission/vocabularies/vocabulary-entry-details.data.service.ts +++ b/src/app/core/submission/vocabularies/vocabulary-entry-details.data.service.ts @@ -65,6 +65,22 @@ export class VocabularyEntryDetailsDataService extends IdentifiableDataService[]): Observable> { + const href$ = this.getIDHrefObs(id, ...linksToFollow); + return this.findByHref(href$, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow); + } + /** * Make a new FindListRequest with given search method * diff --git a/src/app/core/submission/vocabularies/vocabulary.data.service.ts b/src/app/core/submission/vocabularies/vocabulary.data.service.ts index 94316a2b10e..84d1ba871f3 100644 --- a/src/app/core/submission/vocabularies/vocabulary.data.service.ts +++ b/src/app/core/submission/vocabularies/vocabulary.data.service.ts @@ -16,7 +16,10 @@ import { FindAllDataImpl, } from '../../data/base/find-all-data'; import { IdentifiableDataService } from '../../data/base/identifiable-data.service'; -import { SearchDataImpl } from '../../data/base/search-data'; +import { + SearchData, + SearchDataImpl, +} from '../../data/base/search-data'; import { FindListOptions } from '../../data/find-list-options.model'; import { PaginatedList } from '../../data/paginated-list.model'; import { RemoteData } from '../../data/remote-data'; @@ -29,10 +32,10 @@ import { Vocabulary } from './models/vocabulary.model'; * Data service to retrieve vocabularies from the REST server. */ @Injectable({ providedIn: 'root' }) -export class VocabularyDataService extends IdentifiableDataService implements FindAllData { +export class VocabularyDataService extends IdentifiableDataService implements FindAllData, SearchData { protected searchByMetadataAndCollectionPath = 'byMetadataAndCollection'; - private findAllData: FindAllData; + private findAllData: FindAllDataImpl; private searchData: SearchDataImpl; constructor( @@ -65,6 +68,50 @@ export class VocabularyDataService extends IdentifiableDataService i return this.findAllData.findAll(options, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow); } + /** + * Make a new FindListRequest with given search method + * + * @param searchMethod The search method for the object + * @param options The [[FindListOptions]] object + * @param useCachedVersionIfAvailable If this is true, the request will only be sent if there's + * no valid cached version. Defaults to true + * @param reRequestOnStale Whether or not the request should automatically be re- + * requested after the response becomes stale + * @param linksToFollow List of {@link FollowLinkConfig} that indicate which + * {@link HALLink}s should be automatically resolved + * @return {Observable>} + * Return an observable that emits response from the server + */ + public searchBy(searchMethod: string, options?: FindListOptions, useCachedVersionIfAvailable?: boolean, reRequestOnStale?: boolean, ...linksToFollow: FollowLinkConfig[]): Observable>> { + return this.searchData.searchBy(searchMethod, options, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow); + } + + /** + * Create the HREF with given options object + * + * @param options The [[FindListOptions]] object + * @param linkPath The link path for the object + * @return {Observable} + * Return an observable that emits created HREF + * @param linksToFollow List of {@link FollowLinkConfig} that indicate which {@link HALLink}s should be automatically resolved + */ + getFindAllHref(options: FindListOptions = {}, linkPath?: string, ...linksToFollow: FollowLinkConfig[]): Observable { + return this.findAllData.getFindAllHref(options, linkPath, ...linksToFollow); + } + + /** + * Create the HREF for a specific object's search method with given options object + * + * @param searchMethod The search method for the object + * @param options The [[FindListOptions]] object + * @return {Observable} + * Return an observable that emits created HREF + * @param linksToFollow List of {@link FollowLinkConfig} that indicate which {@link HALLink}s should be automatically resolved + */ + public getSearchByHref(searchMethod: string, options?: FindListOptions, ...linksToFollow: FollowLinkConfig[]): Observable { + return this.searchData.getSearchByHref(searchMethod, options, ...linksToFollow); + } + /** * Return the controlled vocabulary configured for the specified metadata and collection if any (/submission/vocabularies/search/{@link searchByMetadataAndCollectionPath}?metadata=<>&collection=<>) * @param metadataField metadata field to search diff --git a/src/app/core/submission/vocabularies/vocabulary.service.spec.ts b/src/app/core/submission/vocabularies/vocabulary.service.spec.ts index 37ea7e7fdf0..a89432618c2 100644 --- a/src/app/core/submission/vocabularies/vocabulary.service.spec.ts +++ b/src/app/core/submission/vocabularies/vocabulary.service.spec.ts @@ -100,6 +100,33 @@ describe('VocabularyService', () => { type: 'vocabularyEntry', }; + const entryDetailRequestURL = `https://rest.api/rest/api/submission/vocabularyEntryDetails/${hierarchicalVocabulary.id}:testValue`; + const entryDetailParentRequestURL = `https://rest.api/rest/api/submission/vocabularyEntryDetails/${hierarchicalVocabulary.id}:testValue/parent`; + const entryDetailChildrenRequestURL = `https://rest.api/rest/api/submission/vocabularyEntryDetails/${hierarchicalVocabulary.id}:testValue/children`; + + const vocabularyEntryDetail: any = { + authority: 'authorityId', + display: 'test', + value: 'test', + otherInformation: { + id: 'authorityId', + hasChildren: 'true', + note: 'Familjeforskning', + }, + type: 'vocabularyEntryDetail', + _links: { + self: { + href: entryDetailRequestURL, + }, + parent: { + href: entryDetailParentRequestURL, + }, + children: { + href: entryDetailChildrenRequestURL, + }, + }, + }; + const vocabularyEntryParentDetail: any = { authority: 'authorityId2', display: 'testParent', @@ -172,9 +199,7 @@ describe('VocabularyService', () => { const endpointURL = `https://rest.api/rest/api/submission/vocabularies`; const requestURL = `https://rest.api/rest/api/submission/vocabularies/${vocabulary.id}`; const entryDetailEndpointURL = `https://rest.api/rest/api/submission/vocabularyEntryDetails`; - const entryDetailRequestURL = `https://rest.api/rest/api/submission/vocabularyEntryDetails/${hierarchicalVocabulary.id}:testValue`; - const entryDetailParentRequestURL = `https://rest.api/rest/api/submission/vocabularyEntryDetails/${hierarchicalVocabulary.id}:testValue/parent`; - const entryDetailChildrenRequestURL = `https://rest.api/rest/api/submission/vocabularyEntryDetails/${hierarchicalVocabulary.id}:testValue/children`; + const requestUUID = '8b3c613a-5a4b-438b-9686-be1d5b4a1c5a'; const vocabularyId = 'types'; const metadata = 'dc.type'; @@ -187,6 +212,8 @@ describe('VocabularyService', () => { const entryByIDRequestURL = `https://rest.api/rest/api/submission/vocabularies/${vocabulary.id}/entries?entryID=${entryID}`; const vocabularyOptions: VocabularyOptions = { name: vocabularyId, + metadata: metadata, + scope: collectionUUID, closed: false, }; const pageInfo = new PageInfo(); @@ -199,6 +226,7 @@ describe('VocabularyService', () => { const vocabularyRD = createSuccessfulRemoteDataObject(vocabulary); const vocabularyRD$ = createSuccessfulRemoteDataObject$(vocabulary); const vocabularyEntriesRD = createSuccessfulRemoteDataObject$(paginatedListEntries); + const vocabularyEntryDetailRD$ = createSuccessfulRemoteDataObject$(vocabularyEntryDetail); const vocabularyEntryDetailParentRD = createSuccessfulRemoteDataObject(vocabularyEntryParentDetail); const vocabularyEntryChildrenRD = createSuccessfulRemoteDataObject(childrenPaginatedList); const paginatedListRD = createSuccessfulRemoteDataObject(paginatedList); @@ -244,6 +272,7 @@ describe('VocabularyService', () => { removeByHrefSubstring: {}, getByHref: of(responseCacheEntry), getByUUID: of(responseCacheEntry), + setStaleByHrefSubstring: jasmine.createSpy('setStaleByHrefSubstring'), }); rdbService = jasmine.createSpyObj('rdbService', { buildSingle: hot('a|', { @@ -252,6 +281,7 @@ describe('VocabularyService', () => { buildList: hot('a|', { a: paginatedListRD, }), + setStaleByHrefSubstring: jasmine.createSpy('setStaleByHrefSubstring'), }); service = initTestService(); @@ -335,6 +365,24 @@ describe('VocabularyService', () => { expect(result).toBeObservable(expected); }); }); + + describe('searchVocabularyByMetadataAndCollection', () => { + it('should proxy the call to vocabularyDataService.findVocabularyByHref', () => { + scheduler.schedule(() => service.searchVocabularyByMetadataAndCollection(vocabularyOptions).subscribe()); + scheduler.flush(); + + expect((service as any).vocabularyDataService.findByHref).toHaveBeenCalledWith(searchRequestURL); + }); + + it('should return a RemoteData for the search', () => { + const result = service.searchVocabularyByMetadataAndCollection(vocabularyOptions); + const expected = cold('a|', { + a: vocabularyRD, + }); + expect(result).toBeObservable(expected); + }); + + }); }); describe('vocabulary entries', () => { @@ -429,6 +477,7 @@ describe('VocabularyService', () => { removeByHrefSubstring: {}, getByHref: of(responseCacheEntry), getByUUID: of(responseCacheEntry), + setStaleByHrefSubstring: jasmine.createSpy('setStaleByHrefSubstring'), }); rdbService = jasmine.createSpyObj('rdbService', { buildSingle: hot('a|', { @@ -490,6 +539,10 @@ describe('VocabularyService', () => { }); describe('getEntryDetailParent', () => { + beforeEach(() => { + (service as any).vocabularyEntryDetailDataService.findById.and.returnValue(vocabularyEntryDetailRD$); + }); + it('should proxy the call to vocabularyDataService.getEntryDetailParent', () => { scheduler.schedule(() => service.getEntryDetailParent('testValue', hierarchicalVocabulary.id).subscribe()); scheduler.flush(); @@ -507,12 +560,18 @@ describe('VocabularyService', () => { }); describe('getEntryDetailChildren', () => { + beforeEach(() => { + (service as any).vocabularyEntryDetailDataService.findById.and.returnValue(vocabularyEntryDetailRD$); + }); + it('should proxy the call to vocabularyDataService.getEntryDetailChildren', () => { const options: VocabularyFindOptions = new VocabularyFindOptions( null, null, null, null, + null, + null, pageInfo.elementsPerPage, pageInfo.currentPage, ); @@ -538,6 +597,8 @@ describe('VocabularyService', () => { null, null, null, + null, + null, pageInfo.elementsPerPage, pageInfo.currentPage, ); @@ -562,7 +623,7 @@ describe('VocabularyService', () => { it('should remove requests on the data service\'s endpoint', (done) => { service.clearSearchTopRequests(); - expect(requestService.removeByHrefSubstring).toHaveBeenCalledWith(`search/${(service as any).searchTopMethod}`); + expect(requestService.setStaleByHrefSubstring).toHaveBeenCalledWith(`search/${(service as any).searchTopMethod}`); done(); }); }); diff --git a/src/app/core/submission/vocabularies/vocabulary.service.ts b/src/app/core/submission/vocabularies/vocabulary.service.ts index 35f06b5c9c3..f14e540ce64 100644 --- a/src/app/core/submission/vocabularies/vocabulary.service.ts +++ b/src/app/core/submission/vocabularies/vocabulary.service.ts @@ -1,7 +1,15 @@ import { Injectable } from '@angular/core'; -import { isNotEmpty } from '@dspace/shared/utils/empty.util'; -import { Observable } from 'rxjs'; +import { createFailedRemoteDataObject } from '@dspace/core/utilities/remote-data.utils'; import { + hasValue, + isNotEmpty, +} from '@dspace/shared/utils/empty.util'; +import { + Observable, + of, +} from 'rxjs'; +import { + first, map, mergeMap, switchMap, @@ -17,6 +25,7 @@ import { FollowLinkConfig, } from '../../shared/follow-link-config.model'; import { + getFirstCompletedRemoteData, getFirstSucceededRemoteDataPayload, getFirstSucceededRemoteListPayload, } from '../../shared/operators'; @@ -34,6 +43,7 @@ import { VocabularyEntryDetailsDataService } from './vocabulary-entry-details.da */ @Injectable({ providedIn: 'root' }) export class VocabularyService { + protected searchByMetadataAndCollectionMethod = 'byMetadataAndCollection'; protected searchTopMethod = 'top'; constructor( @@ -123,6 +133,8 @@ export class VocabularyService { getVocabularyEntries(vocabularyOptions: VocabularyOptions, pageInfo: PageInfo): Observable>> { const options: VocabularyFindOptions = new VocabularyFindOptions( + vocabularyOptions.scope, + vocabularyOptions.metadata, null, null, null, @@ -150,6 +162,8 @@ export class VocabularyService { */ getVocabularyEntriesByValue(value: string, exact: boolean, vocabularyOptions: VocabularyOptions, pageInfo: PageInfo): Observable>> { const options: VocabularyFindOptions = new VocabularyFindOptions( + vocabularyOptions.scope, + vocabularyOptions.metadata, null, value, exact, @@ -166,6 +180,43 @@ export class VocabularyService { } + /** + * Get the display value for a vocabulary item, given the vocabulary name and the item value + * @param vocabularyName + * @param value + */ + getPublicVocabularyEntryByValue(vocabularyName: string, value: string): Observable>> { + const params: RequestParam[] = [ + new RequestParam('filter', value), + new RequestParam('exact', 'true'), + ]; + const options = Object.assign(new FindListOptions(), { + searchParams: params, + elementsPerPage: 1, + }); + const href$ = this.vocabularyDataService.getFindAllHref(options, vocabularyName + '/entries'); + return this.vocabularyEntryDetailDataService.findListByHref(href$); + } + + /** + * Get the display value for a hierarchical vocabulary item, + * given the vocabulary name and the entryID of that vocabulary-entry + * + * @param vocabularyName + * @param entryID + */ + getPublicVocabularyEntryByID(vocabularyName: string, entryID: string): Observable>> { + const params: RequestParam[] = [ + new RequestParam('entryID', entryID), + ]; + const options = Object.assign(new FindListOptions(), { + searchParams: params, + elementsPerPage: 1, + }); + const href$ = this.vocabularyDataService.getFindAllHref(options, vocabularyName + '/entries'); + return this.vocabularyEntryDetailDataService.findListByHref(href$); + } + /** * Return the {@link VocabularyEntry} list for a given value * @@ -199,6 +250,8 @@ export class VocabularyService { getVocabularyEntryByID(ID: string, vocabularyOptions: VocabularyOptions): Observable { const pageInfo = new PageInfo(); const options: VocabularyFindOptions = new VocabularyFindOptions( + vocabularyOptions.scope, + vocabularyOptions.metadata, null, null, null, @@ -222,6 +275,23 @@ export class VocabularyService { ); } + /** + * Return the controlled {@link Vocabulary} configured for the specified metadata and collection if any. + * + * @param vocabularyOptions The {@link VocabularyOptions} for the request to which the entry belongs + * @param linksToFollow List of {@link FollowLinkConfig} that indicate which {@link HALLink}s should be automatically resolved + * @return {Observable>>} + * Return an observable that emits object list + */ + searchVocabularyByMetadataAndCollection(vocabularyOptions: VocabularyOptions, ...linksToFollow: FollowLinkConfig[]): Observable> { + const options: VocabularyFindOptions = new VocabularyFindOptions(vocabularyOptions.scope, vocabularyOptions.metadata); + + return this.vocabularyDataService.getSearchByHref(this.searchByMetadataAndCollectionMethod, options, ...linksToFollow).pipe( + first((href: string) => hasValue(href)), + mergeMap((href: string) => this.vocabularyDataService.findByHref(href)), + ); + } + /** * Returns an observable of {@link RemoteData} of a {@link VocabularyEntryDetail}, based on an href, with a list of {@link FollowLinkConfig}, * to automatically resolve {@link HALLink}s of the {@link VocabularyEntryDetail} @@ -256,7 +326,8 @@ export class VocabularyService { * Return an observable that emits VocabularyEntryDetail object */ findEntryDetailById(id: string, name: string, useCachedVersionIfAvailable = true, reRequestOnStale = true, constructId: boolean = true, ...linksToFollow: FollowLinkConfig[]): Observable> { - const findId: string = (constructId ? `${name}:${id}` : id); + // add the vocabulary name as prefix if doesn't exist + const findId = (!constructId || id.startsWith(`${name}:`)) ? id : `${name}:${id}`; return this.vocabularyEntryDetailDataService.findById(findId, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow); } @@ -275,11 +346,20 @@ export class VocabularyService { * Return an observable that emits a PaginatedList of VocabularyEntryDetail */ getEntryDetailParent(value: string, name: string, useCachedVersionIfAvailable = true, reRequestOnStale = true, ...linksToFollow: FollowLinkConfig[]): Observable> { - const linkPath = `${name}:${value}/parent`; - - return this.vocabularyEntryDetailDataService.getBrowseEndpoint().pipe( - map((href: string) => `${href}/${linkPath}`), - mergeMap((href) => this.vocabularyEntryDetailDataService.findByHref(href, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow)), + return this.findEntryDetailById(value, name, useCachedVersionIfAvailable, reRequestOnStale, true, ...linksToFollow).pipe( + getFirstCompletedRemoteData(), + switchMap((entryRD: RemoteData) => { + if (entryRD.hasSucceeded) { + return this.vocabularyEntryDetailDataService.findByHref( + entryRD.payload._links.parent.href, + useCachedVersionIfAvailable, + reRequestOnStale, + ...linksToFollow, + ); + } else { + return of(createFailedRemoteDataObject(entryRD.errorMessage)); + } + }), ); } @@ -304,13 +384,27 @@ export class VocabularyService { null, null, null, + null, + null, pageInfo.elementsPerPage, pageInfo.currentPage, ); - return this.vocabularyEntryDetailDataService.getBrowseEndpoint().pipe( - map(href => `${href}/${name}:${value}/children`), - switchMap(href => this.vocabularyEntryDetailDataService.findListByHref(href, options, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow)), + return this.findEntryDetailById(value, name, useCachedVersionIfAvailable, reRequestOnStale, true, ...linksToFollow).pipe( + getFirstCompletedRemoteData(), + switchMap((entryRD: RemoteData) => { + if (entryRD.hasSucceeded) { + return this.vocabularyEntryDetailDataService.findListByHref( + entryRD.payload._links.children.href, + options, + useCachedVersionIfAvailable, + reRequestOnStale, + ...linksToFollow, + ); + } else { + return of(createFailedRemoteDataObject>(entryRD.errorMessage)); + } + }), ); } @@ -333,6 +427,8 @@ export class VocabularyService { null, null, null, + null, + null, pageInfo.elementsPerPage, pageInfo.currentPage, ); @@ -344,7 +440,7 @@ export class VocabularyService { * Clear all search Top Requests */ clearSearchTopRequests(): void { - this.requestService.removeByHrefSubstring(`search/${this.searchTopMethod}`); + this.requestService.setStaleByHrefSubstring(`search/${this.searchTopMethod}`); } } diff --git a/src/app/core/testing/submission-service.stub.ts b/src/app/core/testing/submission-service.stub.ts index d9d28bde0ee..4453514f38f 100644 --- a/src/app/core/testing/submission-service.stub.ts +++ b/src/app/core/testing/submission-service.stub.ts @@ -17,6 +17,7 @@ export class SubmissionServiceStub { getDisabledSectionsList = jasmine.createSpy('getDisabledSectionsList'); getSubmissionObjectLinkName = jasmine.createSpy('getSubmissionObjectLinkName'); getSubmissionScope = jasmine.createSpy('getSubmissionScope'); + getSubmissionSecurityConfiguration = jasmine.createSpy('getSubmissionSecurityConfiguration'); getSubmissionStatus = jasmine.createSpy('getSubmissionStatus'); getSubmissionSaveProcessingStatus = jasmine.createSpy('getSubmissionSaveProcessingStatus'); getSubmissionDepositProcessingStatus = jasmine.createSpy('getSubmissionDepositProcessingStatus'); @@ -25,6 +26,7 @@ export class SubmissionServiceStub { isSubmissionLoading = jasmine.createSpy('isSubmissionLoading'); notifyNewSection = jasmine.createSpy('notifyNewSection'); redirectToMyDSpace = jasmine.createSpy('redirectToMyDSpace'); + redirectToItemPage = jasmine.createSpy('redirectToItemPage'); resetAllSubmissionObjects = jasmine.createSpy('resetAllSubmissionObjects'); resetSubmissionObject = jasmine.createSpy('resetSubmissionObject'); retrieveSubmission = jasmine.createSpy('retrieveSubmission'); diff --git a/src/app/core/utilities/remote-data.utils.ts b/src/app/core/utilities/remote-data.utils.ts index fc4e13f06b6..237bb2a5614 100644 --- a/src/app/core/utilities/remote-data.utils.ts +++ b/src/app/core/utilities/remote-data.utils.ts @@ -6,6 +6,7 @@ import { import { RemoteData } from '../data/remote-data'; import { RequestEntryState } from '../data/request-entry-state.model'; +import { PathableObjectError } from '../data/response-state.model'; /** * A fixed timestamp to use in tests @@ -45,7 +46,7 @@ export function createSuccessfulRemoteDataObject$(object: T, timeCompleted?: * @param statusCode the status code * @param timeCompleted the moment when the remoteData was completed */ -export function createFailedRemoteDataObject(errorMessage?: string, statusCode?: number, timeCompleted = 1577836800000): RemoteData { +export function createFailedRemoteDataObject(errorMessage?: string, statusCode?: number, timeCompleted = 1577836800000, errors: PathableObjectError[] = []): RemoteData { return new RemoteData( timeCompleted, 15 * 60 * 1000, @@ -54,6 +55,7 @@ export function createFailedRemoteDataObject(errorMessage?: string, statusCod errorMessage, undefined, statusCode, + errors, ); } diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.html b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.html index 904a6b962f6..77b3b0d242a 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.html +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.html @@ -8,12 +8,14 @@ [mdField]="mdField" [dsoType]="dsoType" [saving$]="saving$" + [metadataSecurityConfiguration]="metadataSecurityConfiguration" [isOnlyValue]="form.fields[mdField].length === 1" (edit)="mdValue.editing = true" (confirm)="mdValue.confirmChanges($event); form.resetReinstatable(); valueSaved.emit()" (remove)="mdValue.change === DsoEditMetadataChangeTypeEnum.ADD ? form.remove(mdField, idx) : mdValue.change = DsoEditMetadataChangeTypeEnum.REMOVE; form.resetReinstatable(); valueSaved.emit()" (undo)="mdValue.change === DsoEditMetadataChangeTypeEnum.ADD ? form.remove(mdField, idx) : mdValue.discard(); valueSaved.emit()" - (dragging)="$event ? draggingMdField$.next(mdField) : draggingMdField$.next(null)"> + (dragging)="$event ? draggingMdField$.next(mdField) : draggingMdField$.next(null)" + (updateSecurityLevel)="onUpdateSecurityLevelValue($event, idx)"> } diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.ts b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.ts index b703c201777..1b591c4118a 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.ts +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component.ts @@ -12,6 +12,7 @@ import { } from '@angular/core'; import { Context } from '@dspace/core/shared/context.model'; import { DSpaceObject } from '@dspace/core/shared/dspace-object.model'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { BehaviorSubject, Observable, @@ -72,6 +73,10 @@ export class DsoEditMetadataFieldValuesComponent { */ @Input() draggingMdField$: BehaviorSubject; + /** + * Security Settings configuration for the current entity + */ + @Input() metadataSecurityConfiguration: MetadataSecurityConfiguration; /** * Emit when the value has been saved within the form */ @@ -106,4 +111,15 @@ export class DsoEditMetadataFieldValuesComponent { this.form.resetReinstatable(); this.valueSaved.emit(); } + + /** + * Update the security level for the field at the given index + */ + onUpdateSecurityLevelValue(securityLevel: number, index: number) { + if (this.form.fields[this.mdField]?.length > 0) { + this.form.fields[this.mdField][index].change = DsoEditMetadataChangeType.UPDATE; + this.form.fields[this.mdField][index].newValue.securityLevel = securityLevel; + this.valueSaved.emit(); + } + } } diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component.html b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component.html index ecaf2aa7443..15dc97f7da4 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component.html +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component.html @@ -4,6 +4,7 @@
{{ dsoType + '.edit.metadata.headers.value' | translate }}
{{ dsoType + '.edit.metadata.headers.language' | translate }}
+
{{ dsoType + '.edit.metadata.headers.authority' | translate }}
{{ dsoType + '.edit.metadata.headers.edit' | translate }}
diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component.spec.ts b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component.spec.ts index becb7b5278b..e9358c9e186 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component.spec.ts +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component.spec.ts @@ -29,7 +29,7 @@ describe('DsoEditMetadataHeadersComponent', () => { fixture.detectChanges(); }); - it('should display three headers', () => { - expect(fixture.debugElement.queryAll(By.css('.ds-flex-cell')).length).toEqual(3); + it('should display four headers', () => { + expect(fixture.debugElement.queryAll(By.css('.ds-flex-cell')).length).toEqual(4); }); }); diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-shared/dso-edit-metadata-cells.scss b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-shared/dso-edit-metadata-cells.scss index d83bacecb21..ce9ed9c481d 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-shared/dso-edit-metadata-cells.scss +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-shared/dso-edit-metadata-cells.scss @@ -12,6 +12,12 @@ max-width: var(--ds-dso-edit-lang-width); } +.ds-authority-cell { + min-width: var(--ds-dso-edit-authority-width); + max-width: var(--ds-dso-edit-authority-width); +} + + .ds-edit-cell { min-width: var(--ds-dso-edit-actions-width); } diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-authority-field/dso-edit-metadata-authority-field.component.spec.ts b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-authority-field/dso-edit-metadata-authority-field.component.spec.ts index 9eadba92488..e06fdc74f30 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-authority-field/dso-edit-metadata-authority-field.component.spec.ts +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-authority-field/dso-edit-metadata-authority-field.component.spec.ts @@ -5,6 +5,7 @@ import { } from '@angular/core/testing'; import { By } from '@angular/platform-browser'; import { ItemDataService } from '@dspace/core/data/item-data.service'; +import { APP_DATA_SERVICES_MAP } from '@dspace/core/data-services-map-type'; import { MetadataField } from '@dspace/core/metadata/metadata-field.model'; import { MetadataSchema } from '@dspace/core/metadata/metadata-schema.model'; import { NotificationsService } from '@dspace/core/notification-system/notifications.service'; @@ -15,15 +16,19 @@ import { Item } from '@dspace/core/shared/item.model'; import { MetadataValue } from '@dspace/core/shared/metadata.models'; import { Vocabulary } from '@dspace/core/submission/vocabularies/models/vocabulary.model'; import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; +import { SubmissionServiceStub } from '@dspace/core/testing/submission-service.stub'; import { createPaginatedList } from '@dspace/core/testing/utils.test'; import { VocabularyServiceStub } from '@dspace/core/testing/vocabulary-service.stub'; import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; +import { provideMockStore } from '@ngrx/store/testing'; import { TranslateModule } from '@ngx-translate/core'; import { RegistryService } from '../../../../admin/admin-registries/registry/registry.service'; import { DynamicOneboxModel } from '../../../../shared/form/builder/ds-dynamic-form-ui/models/onebox/dynamic-onebox.model'; import { DsDynamicScrollableDropdownComponent } from '../../../../shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component'; import { DynamicScrollableDropdownModel } from '../../../../shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.model'; +import { FormBuilderService } from '../../../../shared/form/builder/form-builder.service'; +import { SubmissionService } from '../../../../submission/submission.service'; import { DsoEditMetadataValue } from '../../dso-edit-metadata-form'; import { DsoEditMetadataAuthorityFieldComponent } from './dso-edit-metadata-authority-field.component'; @@ -57,6 +62,8 @@ describe('DsoEditMetadataAuthorityFieldComponent', () => { scrollable: true, hierarchical: false, preloadLevel: 0, + entity: 'Person', + multiValueOnGenerator: false, type: 'vocabulary', _links: { self: { @@ -75,6 +82,8 @@ describe('DsoEditMetadataAuthorityFieldComponent', () => { hierarchical: true, preloadLevel: 2, type: 'vocabulary', + entity: 'Publication', + multiValueOnGenerator: false, _links: { self: { href: 'self', @@ -91,6 +100,8 @@ describe('DsoEditMetadataAuthorityFieldComponent', () => { scrollable: false, hierarchical: false, preloadLevel: 0, + entity: 'Person', + multiValueOnGenerator: false, type: 'vocabulary', _links: { self: { @@ -153,6 +164,10 @@ describe('DsoEditMetadataAuthorityFieldComponent', () => { { provide: ItemDataService, useValue: itemService }, { provide: RegistryService, useValue: registryService }, { provide: NotificationsService, useValue: notificationsService }, + { provide: FormBuilderService }, + { provide: SubmissionService, useClass: SubmissionServiceStub }, + { provide: APP_DATA_SERVICES_MAP, useValue: {} }, + provideMockStore({ initialState: { core: { index: { } } } }), ], }).overrideComponent(DsoEditMetadataAuthorityFieldComponent, { remove: { diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.html b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.html index 4ce0e248c1c..ae5ae79ef9a 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.html +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.html @@ -18,7 +18,7 @@ class="w-100"> } - @if (!isVirtual && !mdValue.editing && mdValue.newValue.authority && mdValue.newValue.confidence !== ConfidenceTypeEnum.CF_UNSET && mdValue.newValue.confidence !== ConfidenceTypeEnum.CF_NOVALUE) { + @if (!isVirtual && !mdValue.editing && mdValue.newValue.authority && mdValue.newValue.confidence !== ConfidenceType.CF_UNSET && mdValue.newValue.confidence !== ConfidenceType.CF_NOVALUE) {
{{ mdValue.newValue.language }}
} +
+ @if (!mdValue.editing) { +
{{ mdValue.newValue.authority }}
+ } + @if(mdValue.editing) { + + } +
+
+
+ @if (canShowMetadataSecurity$ | async) { + + + } +
+
diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.spec.ts b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.spec.ts index 0e2c4b5d217..cd6d1877e52 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.spec.ts +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.spec.ts @@ -8,17 +8,27 @@ import { waitForAsync, } from '@angular/core/testing'; import { By } from '@angular/platform-browser'; -import { RouterModule } from '@angular/router'; +import { RouterTestingModule } from '@angular/router/testing'; import { DSONameService } from '@dspace/core/breadcrumbs/dso-name.service'; import { RelationshipDataService } from '@dspace/core/data/relationship-data.service'; +import { MetadataField } from '@dspace/core/metadata/metadata-field.model'; +import { MetadataSchema } from '@dspace/core/metadata/metadata-schema.model'; +import { NotificationsService } from '@dspace/core/notification-system/notifications.service'; +import { Collection } from '@dspace/core/shared/collection.model'; +import { DSpaceObject } from '@dspace/core/shared/dspace-object.model'; +import { Item } from '@dspace/core/shared/item.model'; import { MetadataValue, VIRTUAL_METADATA_PREFIX, } from '@dspace/core/shared/metadata.models'; import { ItemMetadataRepresentation } from '@dspace/core/shared/metadata-representation/item/item-metadata-representation.model'; import { DsoEditMetadataFieldServiceStub } from '@dspace/core/testing/dso-edit-metadata-field.service.stub'; +import { createPaginatedList } from '@dspace/core/testing/utils.test'; +import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; import { TranslateModule } from '@ngx-translate/core'; import { of } from 'rxjs'; +import { RegistryService } from 'src/app/admin/admin-registries/registry/registry.service'; +import { mockSecurityConfig } from 'src/app/submission/utils/submission.mock'; import { BtnDisabledDirective } from '../../../shared/btn-disabled.directive'; import { ThemedTypeBadgeComponent } from '../../../shared/object-collection/shared/badges/type-badge/themed-type-badge.component'; @@ -44,9 +54,27 @@ describe('DsoEditMetadataValueComponent', () => { let relationshipService: RelationshipDataService; let dsoNameService: DSONameService; let dsoEditMetadataFieldService: DsoEditMetadataFieldServiceStub; - + let registryService: RegistryService; + let notificationsService: NotificationsService; let editMetadataValue: DsoEditMetadataValue; let metadataValue: MetadataValue; + let dso: DSpaceObject; + + const collection = Object.assign(new Collection(), { + uuid: 'fake-uuid', + }); + + const item = Object.assign(new Item(), { + _links: { + self: { href: 'fake-item-url/item' }, + }, + id: 'item', + uuid: 'item', + owningCollection: createSuccessfulRemoteDataObject$(collection), + }); + + let metadataSchema: MetadataSchema; + let metadataFields: MetadataField[]; function initServices(): void { relationshipService = jasmine.createSpyObj('relationshipService', { @@ -58,6 +86,10 @@ describe('DsoEditMetadataValueComponent', () => { getName: 'Related Name', }); dsoEditMetadataFieldService = new DsoEditMetadataFieldServiceStub(); + registryService = jasmine.createSpyObj('registryService', { + queryMetadataFields: createSuccessfulRemoteDataObject$(createPaginatedList(metadataFields)), + }); + notificationsService = jasmine.createSpyObj('notificationsService', ['error', 'success']); } beforeEach(waitForAsync(async () => { @@ -68,13 +100,18 @@ describe('DsoEditMetadataValueComponent', () => { authority: undefined, }); editMetadataValue = new DsoEditMetadataValue(metadataValue); + dso = Object.assign(new DSpaceObject(), { + _links: { + self: { href: 'fake-dso-url/dso' }, + }, + }); initServices(); await TestBed.configureTestingModule({ imports: [ TranslateModule.forRoot(), - RouterModule.forRoot([]), + RouterTestingModule.withRoutes([]), DsoEditMetadataValueComponent, VarDirective, BtnDisabledDirective, @@ -83,14 +120,16 @@ describe('DsoEditMetadataValueComponent', () => { { provide: RelationshipDataService, useValue: relationshipService }, { provide: DSONameService, useValue: dsoNameService }, { provide: DsoEditMetadataFieldService, useValue: dsoEditMetadataFieldService }, + { provide: RegistryService, useValue: registryService }, + { provide: NotificationsService, useValue: notificationsService }, ], schemas: [NO_ERRORS_SCHEMA], }) .overrideComponent(DsoEditMetadataValueComponent, { remove: { imports: [ - DsoEditMetadataValueFieldLoaderComponent, ThemedTypeBadgeComponent, + DsoEditMetadataValueFieldLoaderComponent, ], }, }) @@ -101,7 +140,11 @@ describe('DsoEditMetadataValueComponent', () => { fixture = TestBed.createComponent(DsoEditMetadataValueComponent); component = fixture.componentInstance; component.mdValue = editMetadataValue; + component.dso = dso; + component.metadataSecurityConfiguration = mockSecurityConfig; + component.mdField = 'person.birthDate'; component.saving$ = of(false); + spyOn(component, 'initSecurityLevel').and.callThrough(); fixture.detectChanges(); }); @@ -111,6 +154,18 @@ describe('DsoEditMetadataValueComponent', () => { ).toBeNull(); }); + it('should call initSecurityLevel on init', () => { + expect(fixture.debugElement.query(By.css('ds-type-badge'))).toBeNull(); + expect(component.initSecurityLevel).toHaveBeenCalled(); + expect(component.mdSecurityConfigLevel$.value).toEqual([0, 1]); + }); + + it('should call initSecurityLevel when field changes', () => { + component.mdField = 'test'; + expect(component.initSecurityLevel).toHaveBeenCalled(); + expect(component.mdSecurityConfigLevel$.value).toEqual([0, 1, 2]); + }); + describe('when no changes have been made', () => { assertButton(EDIT_BTN, true, false); assertButton(CONFIRM_BTN, false); diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.ts b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.ts index 2af25e39c3b..65e00fbde5e 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.ts +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component.ts @@ -7,38 +7,69 @@ import { NgClass, } from '@angular/common'; import { + ChangeDetectorRef, Component, EventEmitter, Input, OnChanges, + OnDestroy, OnInit, Output, SimpleChanges, } from '@angular/core'; -import { FormsModule } from '@angular/forms'; +import { + FormsModule, + UntypedFormControl, + UntypedFormGroup, +} from '@angular/forms'; import { RouterLink } from '@angular/router'; import { DSONameService } from '@dspace/core/breadcrumbs/dso-name.service'; import { RelationshipDataService } from '@dspace/core/data/relationship-data.service'; import { MetadataService } from '@dspace/core/metadata/metadata.service'; +import { NotificationsService } from '@dspace/core/notification-system/notifications.service'; import { getItemPageRoute } from '@dspace/core/router/utils/dso-route.utils'; import { ConfidenceType } from '@dspace/core/shared/confidence-type'; import { Context } from '@dspace/core/shared/context.model'; import { DSpaceObject } from '@dspace/core/shared/dspace-object.model'; +import { followLink } from '@dspace/core/shared/follow-link-config.model'; import { ItemMetadataRepresentation } from '@dspace/core/shared/metadata-representation/item/item-metadata-representation.model'; import { MetadataRepresentation, MetadataRepresentationType, } from '@dspace/core/shared/metadata-representation/metadata-representation.model'; +import { + getFirstCompletedRemoteData, + metadataFieldsToString, +} from '@dspace/core/shared/operators'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { Vocabulary } from '@dspace/core/submission/vocabularies/models/vocabulary.model'; -import { hasValue } from '@dspace/shared/utils/empty.util'; +import { + hasValue, + isNotEmpty, +} from '@dspace/shared/utils/empty.util'; import { NgbTooltip } from '@ng-bootstrap/ng-bootstrap'; -import { TranslateModule } from '@ngx-translate/core'; import { + TranslateModule, + TranslateService, +} from '@ngx-translate/core'; +import { + BehaviorSubject, + combineLatest, EMPTY, Observable, + of, + Subscription, } from 'rxjs'; -import { map } from 'rxjs/operators'; +import { + distinctUntilChanged, + map, + shareReplay, + switchMap, + take, +} from 'rxjs/operators'; +import { RegistryService } from '../../../admin/admin-registries/registry/registry.service'; +import { EditMetadataSecurityComponent } from '../../../item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component'; import { BtnDisabledDirective } from '../../../shared/btn-disabled.directive'; import { AuthorityConfidenceStateDirective } from '../../../shared/form/directives/authority-confidence-state.directive'; import { ThemedTypeBadgeComponent } from '../../../shared/object-collection/shared/badges/type-badge/themed-type-badge.component'; @@ -63,6 +94,7 @@ import { DsoEditMetadataValueFieldLoaderComponent } from '../dso-edit-metadata-v CdkDragHandle, DebounceDirective, DsoEditMetadataValueFieldLoaderComponent, + EditMetadataSecurityComponent, FormsModule, NgbTooltip, NgClass, @@ -74,7 +106,7 @@ import { DsoEditMetadataValueFieldLoaderComponent } from '../dso-edit-metadata-v /** * Component displaying a single editable row for a metadata value */ -export class DsoEditMetadataValueComponent implements OnInit, OnChanges { +export class DsoEditMetadataValueComponent implements OnInit, OnChanges, OnDestroy { @Input() context: Context; @@ -83,16 +115,44 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges { * Also used to determine metadata-representations in case of virtual metadata */ @Input() dso: DSpaceObject; + /** + * Editable metadata value to show + */ + @Input() mdValue: DsoEditMetadataValue; /** - * The metadata field that is being edited + * The metadata security configuration for the entity. */ - @Input() mdField: string; + @Input() + set metadataSecurityConfiguration(metadataSecurityConfiguration: MetadataSecurityConfiguration) { + this._metadataSecurityConfiguration$.next(metadataSecurityConfiguration); + } + + get metadataSecurityConfiguration() { + return this._metadataSecurityConfiguration$.value; + } + + protected readonly _metadataSecurityConfiguration$ = + new BehaviorSubject(null); /** - * Editable metadata value to show + * The metadata field to display a value for */ - @Input() mdValue: DsoEditMetadataValue; + @Input() + set mdField(mdField: string) { + this._mdField$.next(mdField); + } + + get mdField() { + return this._mdField$.value; + } + + protected readonly _mdField$ = new BehaviorSubject(null); + + /** + * Flag whether this is a new metadata field or exists already + */ + @Input() isNewMdField = false; /** * Type of DSO we're displaying values for @@ -137,6 +197,16 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges { */ @Output() dragging: EventEmitter = new EventEmitter(); + /** + * Emits the new value of security level + */ + @Output() updateSecurityLevel: EventEmitter = new EventEmitter(); + + /** + * Emits true when the metadata has security settings + */ + @Output() hasSecurityLevel: EventEmitter = new EventEmitter(false); + /** * The DsoEditMetadataChangeType enumeration for access in the component's template * @type {DsoEditMetadataChangeType} @@ -157,30 +227,72 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges { * The name of the item represented by this virtual metadata value (otherwise null) */ mdRepresentationName$: Observable; + readonly mdSecurityConfigLevel$: BehaviorSubject = new BehaviorSubject([]); + + canShowMetadataSecurity$: Observable; + + private sub: Subscription; + + /** + * Whether or not the authority field is currently being edited + */ + public editingAuthority = false; + + + /** + * Whether or not the free-text editing is enabled when scrollable dropdown or hierarchical vocabulary is used + */ + public enabledFreeTextEditing = false; + + /** + * Field group used by authority field + * @type {UntypedFormGroup} + */ + group = new UntypedFormGroup({ authorityField : new UntypedFormControl() }); /** * The type of edit field that should be displayed */ fieldType$: Observable; - readonly ConfidenceTypeEnum = ConfidenceType; + readonly ConfidenceType = ConfidenceType; constructor( protected relationshipService: RelationshipDataService, protected dsoNameService: DSONameService, protected metadataService: MetadataService, + protected cdr: ChangeDetectorRef, + protected registryService: RegistryService, + protected notificationsService: NotificationsService, + protected translate: TranslateService, protected dsoEditMetadataFieldService: DsoEditMetadataFieldService, ) { } ngOnInit(): void { this.initVirtualProperties(); + + this.sub = combineLatest([ + this._mdField$, + this._metadataSecurityConfiguration$, + ]).subscribe(([mdField, metadataSecurityConfig]) => this.initSecurityLevel(mdField, metadataSecurityConfig)); + + this.canShowMetadataSecurity$ = + combineLatest([ + this._mdField$.pipe(distinctUntilChanged()), + this.mdSecurityConfigLevel$, + ]).pipe( + map(([mdField, securityConfigLevel]) => hasValue(mdField) && this.hasSecurityChoice(securityConfigLevel)), + shareReplay({ refCount: false, bufferSize: 1 }), + ); } - ngOnChanges(changes: SimpleChanges): void { - if (changes.mdField) { - this.fieldType$ = this.getFieldType(); - } + /** + * Emits the edit event + * @param securityLevel + */ + changeSelectedSecurity(securityLevel: number) { + this.updateSecurityLevel.emit(securityLevel); } /** @@ -202,6 +314,30 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges { ); } + initSecurityLevel(mdField: string, metadataSecurityConfig: MetadataSecurityConfiguration) { + let appliedSecurity: number[] = []; + if (hasValue(metadataSecurityConfig)) { + if (metadataSecurityConfig?.metadataCustomSecurity[mdField]) { + appliedSecurity = metadataSecurityConfig.metadataCustomSecurity[mdField]; + } else if (metadataSecurityConfig?.metadataSecurityDefault) { + appliedSecurity = metadataSecurityConfig.metadataSecurityDefault; + } + } + this.mdSecurityConfigLevel$.next(appliedSecurity); + } + + /** + * Emits the value for the metadata security existence + */ + hasSecurityMetadata(event: boolean) { + this.hasSecurityLevel.emit(event); + } + + private hasSecurityChoice(securityConfigLevel: number[]) { + return securityConfigLevel?.length > 1; + } + + /** * Retrieves the {@link EditMetadataValueFieldType} to be displayed for the current field while in edit mode. */ @@ -219,4 +355,60 @@ export class DsoEditMetadataValueComponent implements OnInit, OnChanges { ); } + /** + * Change callback for the component. Check if the mdField has changed to retrieve whether it is metadata + * that uses a controlled vocabulary and update the related properties + * + * @param {SimpleChanges} changes + */ + ngOnChanges(changes: SimpleChanges): void { + if (isNotEmpty(changes.mdField) && !changes.mdField.firstChange) { + if (isNotEmpty(changes.mdField.currentValue) ) { + if (isNotEmpty(changes.mdField.previousValue) && + changes.mdField.previousValue !== changes.mdField.currentValue) { + // Clear authority value in case it has been assigned with the previous metadataField used + this.mdValue.newValue.authority = null; + this.mdValue.newValue.confidence = ConfidenceType.CF_UNSET; + } + + // Only ask if the current mdField have a period character to reduce request + if (changes.mdField.currentValue.includes('.')) { + this.validateMetadataField().subscribe((isValid: boolean) => { + if (isValid) { + this.cdr.detectChanges(); + } + }); + } + } + } + } + + /** + * Validate the metadata field to check if it exists on the server and return an observable boolean for success/error + */ + validateMetadataField(): Observable { + return this.registryService.queryMetadataFields(this.mdField, null, true, false, followLink('schema')).pipe( + getFirstCompletedRemoteData(), + switchMap((rd) => { + if (rd.hasSucceeded) { + return of(rd).pipe( + metadataFieldsToString(), + take(1), + map((fields: string[]) => fields.indexOf(this.mdField) > -1), + ); + } else { + this.notificationsService.error(this.translate.instant(`${this.dsoType}.edit.metadata.metadatafield.error`), rd.errorMessage); + return [false]; + } + }), + ); + } + + + ngOnDestroy(): void { + if (hasValue(this.sub)) { + this.sub.unsubscribe(); + } + } + } diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.html b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.html index d9f62d2a5f4..d2a59061a36 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.html +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.html @@ -47,6 +47,7 @@ [dsoType]="dsoType"> + (undo)="form.newValue = undefined" + (updateSecurityLevel)="onUpdateSecurityLevel($event)" + (hasSecurityLevel)="hasSecurityLevel($event)">
diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.spec.ts b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.spec.ts index c7d82285be1..2e8387cced8 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.spec.ts +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.spec.ts @@ -20,8 +20,12 @@ import { DSpaceObject } from '@dspace/core/shared/dspace-object.model'; import { Item } from '@dspace/core/shared/item.model'; import { ITEM } from '@dspace/core/shared/item.resource-type'; import { MetadataValue } from '@dspace/core/shared/metadata.models'; +import { MetadataSecurityConfigurationService } from '@dspace/core/submission/metadatasecurityconfig-data.service'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { TestDataService } from '@dspace/core/testing/test-data-service.mock'; +import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; import { TranslateModule } from '@ngx-translate/core'; +import { mockSecurityConfig } from 'src/app/submission/utils/submission.mock'; import { AlertComponent } from '../../shared/alert/alert.component'; import { BtnDisabledDirective } from '../../shared/btn-disabled.directive'; @@ -43,6 +47,10 @@ const mockDataServiceMap: any = new Map([ [ITEM.value, () => import('@dspace/core/testing/test-data-service.mock').then(m => m.TestDataService)], ]); +const metadataSecurityConfigDataServiceSpy = jasmine.createSpyObj('metadataSecurityConfigDataService', { + findById: createSuccessfulRemoteDataObject$(mockSecurityConfig), +}); + describe('DsoEditMetadataComponent', () => { let component: DsoEditMetadataComponent; let fixture: ComponentFixture; @@ -100,6 +108,7 @@ describe('DsoEditMetadataComponent', () => { providers: [ { provide: APP_DATA_SERVICES_MAP, useValue: mockDataServiceMap }, { provide: NotificationsService, useValue: notificationsService }, + { provide: MetadataSecurityConfigurationService, useValue: metadataSecurityConfigDataServiceSpy }, ArrayMoveChangeAnalyzer, TestDataService, ], @@ -128,6 +137,10 @@ describe('DsoEditMetadataComponent', () => { fixture.detectChanges(); })); + it('should set security configuration object', () => { + expect(component.securitySettings$.value).toEqual(mockSecurityConfig); + }); + describe('when no changes have been made', () => { assertButton(ADD_BTN, true, false); assertButton(REINSTATE_BTN, false); @@ -202,20 +215,35 @@ describe('DsoEditMetadataComponent', () => { expect(fixture.debugElement.query(By.css('ds-dso-edit-metadata-value'))).toBeNull(); }); }); + + it('should fetch security settings for Item', () => { + component.dso = Object.assign(new Item(), { + ...dso, + entityType: 'Person', + }); + component.getSecuritySettings().subscribe((securitySettings: MetadataSecurityConfiguration) => { + expect(securitySettings).toBeDefined(); + }); + }); }); function assertButton(name: string, exists: boolean, disabled: boolean = false): void { describe(`${name} button`, () => { let btn: DebugElement; - beforeEach(() => { + beforeEach(waitForAsync(() => { + fixture.detectChanges(); btn = fixture.debugElement.query(By.css(`#dso-${name}-btn`)); - }); + })); if (exists) { - it('should exist', () => { + it('form should be initialized', waitForAsync(() => { + expect(component.isFormInitialized$.value).toBeTrue(); + })); + + it('should exist', waitForAsync(() => { expect(btn).toBeTruthy(); - }); + })); it(`should${disabled ? ' ' : ' not '}be disabled`, () => { if (disabled) { @@ -227,9 +255,9 @@ describe('DsoEditMetadataComponent', () => { } }); } else { - it('should not exist', () => { + it('should not exist', waitForAsync(() => { expect(btn).toBeNull(); - }); + })); } }); } diff --git a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.ts b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.ts index 6dc5d4abc89..5590c71c065 100644 --- a/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.ts +++ b/src/app/dso-shared/dso-edit-metadata/dso-edit-metadata.component.ts @@ -13,7 +13,9 @@ import { ActivatedRoute, Data, } from '@angular/router'; +import { DATA_SERVICE_FACTORY } from '@dspace/core/cache/builders/build-decorators'; import { ArrayMoveChangeAnalyzer } from '@dspace/core/data/array-move-change-analyzer.service'; +import { HALDataService } from '@dspace/core/data/base/hal-data-service.interface'; import { RemoteData } from '@dspace/core/data/remote-data'; import { UpdateDataService } from '@dspace/core/data/update-data.service'; import { @@ -24,8 +26,12 @@ import { lazyDataService } from '@dspace/core/lazy-data-service'; import { NotificationsService } from '@dspace/core/notification-system/notifications.service'; import { Context } from '@dspace/core/shared/context.model'; import { DSpaceObject } from '@dspace/core/shared/dspace-object.model'; +import { GenericConstructor } from '@dspace/core/shared/generic-constructor'; +import { Item } from '@dspace/core/shared/item.model'; import { getFirstCompletedRemoteData } from '@dspace/core/shared/operators'; import { ResourceType } from '@dspace/core/shared/resource-type'; +import { MetadataSecurityConfigurationService } from '@dspace/core/submission/metadatasecurityconfig-data.service'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { hasNoValue, hasValue, @@ -37,6 +43,7 @@ import { } from '@ngx-translate/core'; import { BehaviorSubject, + combineLatest, combineLatest as observableCombineLatest, Observable, of, @@ -44,7 +51,7 @@ import { } from 'rxjs'; import { map, - mergeMap, + switchMap, tap, } from 'rxjs/operators'; @@ -53,7 +60,10 @@ import { AlertType } from '../../shared/alert/alert-type'; import { BtnDisabledDirective } from '../../shared/btn-disabled.directive'; import { ThemedLoadingComponent } from '../../shared/loading/themed-loading.component'; import { DsoEditMetadataFieldValuesComponent } from './dso-edit-metadata-field-values/dso-edit-metadata-field-values.component'; -import { DsoEditMetadataForm } from './dso-edit-metadata-form'; +import { + DsoEditMetadataChangeType, + DsoEditMetadataForm, +} from './dso-edit-metadata-form'; import { DsoEditMetadataHeadersComponent } from './dso-edit-metadata-headers/dso-edit-metadata-headers.component'; import { DsoEditMetadataValueComponent } from './dso-edit-metadata-value/dso-edit-metadata-value.component'; import { DsoEditMetadataValueHeadersComponent } from './dso-edit-metadata-value-headers/dso-edit-metadata-value-headers.component'; @@ -153,6 +163,28 @@ export class DsoEditMetadataComponent implements OnInit, OnDestroy { */ dsoUpdateSubscription: Subscription; + /** + * Field to keep track of the current security level + * in case a new mdField is added and the security level needs to be set + */ + newMdFieldWithSecurityLevelValue: number; + + /** + * Flag to indicate if the metadata security configuration is present + * for the newly added metadata field + */ + hasSecurityMetadata = false; + + /** + * Contains metadata security configuration object + */ + isFormInitialized$: BehaviorSubject = new BehaviorSubject(false); + + /** + * Contains metadata security configuration object + */ + securitySettings$: BehaviorSubject = new BehaviorSubject(null); + public readonly Context = Context; constructor(protected route: ActivatedRoute, @@ -161,7 +193,9 @@ export class DsoEditMetadataComponent implements OnInit, OnDestroy { protected parentInjector: Injector, protected arrayMoveChangeAnalyser: ArrayMoveChangeAnalyzer, protected cdr: ChangeDetectorRef, - @Inject(APP_DATA_SERVICES_MAP) private dataServiceMap: LazyDataServicesMap) { + @Inject(APP_DATA_SERVICES_MAP) private dataServiceMap: LazyDataServicesMap, + protected metadataSecurityConfigurationService: MetadataSecurityConfigurationService, + @Inject(DATA_SERVICE_FACTORY) protected getDataServiceFor: (resourceType: ResourceType) => GenericConstructor>) { } /** @@ -172,24 +206,47 @@ export class DsoEditMetadataComponent implements OnInit, OnDestroy { if (hasNoValue(this.dso)) { this.dsoUpdateSubscription = observableCombineLatest([this.route.data, this.route.parent.data]).pipe( map(([data, parentData]: [Data, Data]) => Object.assign({}, data, parentData)), - tap((data: any) => this.initDSO(data.dso.payload)), - mergeMap(() => this.retrieveDataService()), - ).subscribe((dataService: UpdateDataService) => { + tap((data: any) => this.initDSO(data.dso.payload)), + switchMap(() => combineLatest([this.retrieveDataService(),this.getSecuritySettings()])), + ).subscribe(([dataService, securitySettings]: [UpdateDataService, MetadataSecurityConfiguration]) => { + this.securitySettings$.next(securitySettings); this.initDataService(dataService); this.initForm(); + this.isFormInitialized$.next(true); }); } else { this.initDSOType(this.dso); - this.retrieveDataService().subscribe((dataService: UpdateDataService) => { - this.initDataService(dataService); - this.initForm(); - }); + observableCombineLatest([this.retrieveDataService(), this.getSecuritySettings()]) + .subscribe(([dataService, securitySettings]: [UpdateDataService, MetadataSecurityConfiguration]) => { + this.securitySettings$.next(securitySettings); + this.initDataService(dataService); + this.initForm(); + this.isFormInitialized$.next(true); + }); } this.savingOrLoadingFieldValidation$ = observableCombineLatest([this.saving$, this.loadingFieldValidation$]).pipe( map(([saving, loading]: [boolean, boolean]) => saving || loading), ); } + /** + * Get the security settings for the current DSpaceObject, + * based on entityType (e.g. Person) + */ + getSecuritySettings(): Observable { + if (this.dso instanceof Item) { + const entityType: string = (this.dso as Item).entityType; + return this.metadataSecurityConfigurationService.findById(entityType).pipe( + getFirstCompletedRemoteData(), + map((securitySettingsRD: RemoteData) => { + return securitySettingsRD.hasSucceeded ? securitySettingsRD.payload : null; + }), + ); + } else { + of(null); + } + } + /** * Resolve the data-service for the current DSpaceObject and retrieve its instance */ @@ -297,6 +354,7 @@ export class DsoEditMetadataComponent implements OnInit, OnDestroy { this.loadingFieldValidation$.next(false); if (valid) { this.form.setMetadataField(this.newMdField); + this.setSecurityLevelForNewMdField(); this.onValueSaved(); } }); @@ -326,6 +384,74 @@ export class DsoEditMetadataComponent implements OnInit, OnDestroy { this.onValueSaved(); } + /** + * Keep track of the metadata field that is currently being edited / added + * Reset the security level properties for the new metadata field + * @param value The value of the new metadata field + */ + onMdFieldChange(value: string){ + if (hasValue(value)) { + this.newMdFieldWithSecurityLevelValue = null; + this.hasSecurityMetadata = false; + } + } + + /** + * Update the security level for the field at the given index + */ + onUpdateSecurityLevel(securityLevel: number) { + this.setSecurityLevelForNewMdField(securityLevel); + } + + /** + * Set the security level for the new metadata field + * If the new metadata field has no security level yet, store the security level in a temporary variable + * until the metadata field is validated and set. + * @param securityLevel The security level to set for the new metadata field + */ + setSecurityLevelForNewMdField(securityLevel?: number) { + // if the metadata field already exists among the metadata fields, + // set the security level for the new metadata field in the right position + if (hasValue(this.newMdField) && hasValue(this.form.fields[this.newMdField]) && this.hasSecurityMetadata) { + const lastIndex = this.form.fields[this.newMdField].length - 1; + const obj = this.form.fields[this.newMdField][lastIndex]; + + if (hasValue(securityLevel)) { + // metadata field is not set yet, so store the security level for the new metadata field + this.newMdFieldWithSecurityLevelValue = securityLevel; + } else { + // metadata field is set, so set the security level for the new metadata field + obj.change = DsoEditMetadataChangeType.ADD; + const customSecurity = this.securitySettings$.value.metadataCustomSecurity[this.newMdField]; + const lastCustomSecurityLevel = customSecurity[customSecurity.length - 1]; + + obj.newValue.securityLevel = this.newMdFieldWithSecurityLevelValue ?? lastCustomSecurityLevel; + } + } + + // if the security level value is changed before the metadata field is set, + // store the security level in a temporary variable + if (hasValue(securityLevel) && hasNoValue(this.form.fields[this.newMdField])) { + this.newMdFieldWithSecurityLevelValue = securityLevel; + } + + if (!this.hasSecurityMetadata) { + // for newly added metadata fields, set the security level to the default security level + // (in case there is no custom security level for the metadata field) + const defaultSecurity = this.securitySettings$.value.metadataSecurityDefault; + const lastDefaultSecurityLevel = defaultSecurity[defaultSecurity.length - 1]; + + this.form.fields[this.newMdField][this.form.fields[this.newMdField].length - 1].newValue.securityLevel = lastDefaultSecurityLevel; + } + } + + /** + * Check if the new metadata field has a security level + */ + hasSecurityLevel(event: boolean) { + this.hasSecurityMetadata = event; + } + /** * Unsubscribe from any open subscriptions */ diff --git a/src/app/edit-item/edit-item-routes.ts b/src/app/edit-item/edit-item-routes.ts new file mode 100644 index 00000000000..cf4bdb43b93 --- /dev/null +++ b/src/app/edit-item/edit-item-routes.ts @@ -0,0 +1,21 @@ +import { Route } from '@angular/router'; + +import { authenticatedGuard } from '../core/auth/authenticated.guard'; +import { pendingChangesGuard } from '../submission/edit/pending-changes/pending-changes.guard'; +import { ThemedSubmissionEditComponent } from '../submission/edit/themed-submission-edit.component'; + +export const ROUTES: Route[] = [ + { + path: ':id', + runGuardsAndResolvers: 'always', + children: [ + { + path: '', + canActivate: [authenticatedGuard], + canDeactivate: [pendingChangesGuard], + component: ThemedSubmissionEditComponent, + data: { title: 'submission.edit.title' }, + }, + ], + }, +]; diff --git a/src/app/entity-groups/research-entities/item-pages/person/person.component.html b/src/app/entity-groups/research-entities/item-pages/person/person.component.html index e64cffd7bb8..efb92a35621 100644 --- a/src/app/entity-groups/research-entities/item-pages/person/person.component.html +++ b/src/app/entity-groups/research-entities/item-pages/person/person.component.html @@ -58,12 +58,19 @@
- + } @else { + - + + }
diff --git a/src/app/entity-groups/research-entities/item-pages/person/person.component.ts b/src/app/entity-groups/research-entities/item-pages/person/person.component.ts index 450350a6dab..bb8d79ca138 100644 --- a/src/app/entity-groups/research-entities/item-pages/person/person.component.ts +++ b/src/app/entity-groups/research-entities/item-pages/person/person.component.ts @@ -7,6 +7,7 @@ import { TranslateModule } from '@ngx-translate/core'; import { GenericItemPageFieldComponent } from '../../../../item-page/simple/field-components/specific-field/generic/generic-item-page-field.component'; import { ThemedItemPageTitleFieldComponent } from '../../../../item-page/simple/field-components/specific-field/title/themed-item-page-field.component'; import { ItemComponent } from '../../../../item-page/simple/item-types/shared/item.component'; +import { AuthorityRelatedEntitiesSearchComponent } from '../../../../item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component'; import { TabbedRelatedEntitiesSearchComponent } from '../../../../item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component'; import { RelatedItemsComponent } from '../../../../item-page/simple/related-items/related-items-component'; import { DsoEditMenuComponent } from '../../../../shared/dso-page/dso-edit-menu/dso-edit-menu.component'; @@ -22,6 +23,7 @@ import { ThemedThumbnailComponent } from '../../../../thumbnail/themed-thumbnail templateUrl: './person.component.html', imports: [ AsyncPipe, + AuthorityRelatedEntitiesSearchComponent, DsoEditMenuComponent, GenericItemPageFieldComponent, MetadataFieldWrapperComponent, diff --git a/src/app/footer/footer.component.html b/src/app/footer/footer.component.html index b4461df18a3..fe2de784086 100644 --- a/src/app/footer/footer.component.html +++ b/src/app/footer/footer.component.html @@ -100,4 +100,4 @@
Footer Content
} - \ No newline at end of file + diff --git a/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.html b/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.html new file mode 100644 index 00000000000..5a93323937c --- /dev/null +++ b/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.html @@ -0,0 +1,21 @@ +@if (securityConfigLevel?.length > 1) { +
+ @for (secLevel of securityLevelsMap; track secLevel.value) { +
+
+ +
+
+ } + +
+} + + diff --git a/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.scss b/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.scss new file mode 100644 index 00000000000..d889862bf7d --- /dev/null +++ b/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.scss @@ -0,0 +1,31 @@ +.switch-container { + height: 35px; + width: fit-content; + background-color: rgb(204, 204, 204); + border-radius: 100px; + display: flex; + + //display: flex; + //flex-wrap: wrap; + //flex: 50%; +} + +.switch-opt { + align-items: center; + display: flex; + justify-content: center; + background-color: rgb(204, 204, 204); + cursor: pointer; + width: 32px; + height: 32px; + border-radius: 100%; + position: relative; + top: 1px; + margin-left: 2px; + margin-right: 2px; +} + +.btn-link:focus { + outline: none !important; + box-shadow: none !important; +} diff --git a/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.spec.ts b/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.spec.ts new file mode 100644 index 00000000000..02827e50ab9 --- /dev/null +++ b/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.spec.ts @@ -0,0 +1,100 @@ +import { + ComponentFixture, + TestBed, +} from '@angular/core/testing'; +import { By } from '@angular/platform-browser'; + +import { EditMetadataSecurityComponent } from './edit-metadata-security.component'; + +describe('EditMetadataSecurityComponent', () => { + let component: EditMetadataSecurityComponent; + let fixture: ComponentFixture; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [EditMetadataSecurityComponent], + }) + .compileComponents(); + }); + + beforeEach(() => { + fixture = TestBed.createComponent(EditMetadataSecurityComponent); + component = fixture.componentInstance; + }); + + describe('when security levels are defined', () => { + + beforeEach(() => { + component.securityConfigLevel = [0, 1, 2]; + }); + + describe('and security level is given', () => { + beforeEach(() => { + component.securityLevel = 1; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should render the switch buttons', () => { + const btns = fixture.debugElement.queryAll(By.css('[data-test="switch-btn"]')); + expect(btns.length).toBe(3); + }); + }); + + describe('and security level is not given and is a new field', () => { + beforeEach(() => { + component.isNewMdField = true; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should render the switch buttons', () => { + const btns = fixture.debugElement.queryAll(By.css('[data-test="switch-btn"]')); + expect(btns.length).toBe(3); + }); + + it('should init security', () => { + expect(component.securityLevel).toBe(2); + }); + }); + + describe('and security level is not given and is not a new field', () => { + beforeEach(() => { + component.isNewMdField = false; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should render the switch buttons', () => { + const btns = fixture.debugElement.queryAll(By.css('[data-test="switch-btn"]')); + expect(btns.length).toBe(3); + }); + + it('should init security', () => { + expect(component.securityLevel).toBe(0); + }); + }); + }); + + describe('when security levels are not defined', () => { + + beforeEach(() => { + component.securityConfigLevel = []; + fixture.detectChanges(); + }); + + it('should not render the switch buttons', () => { + const btns = fixture.debugElement.queryAll(By.css('[data-test="switch-btn"]')); + expect(btns.length).toBe(0); + }); + }); +}); diff --git a/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.ts b/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.ts new file mode 100644 index 00000000000..5c3b012b66a --- /dev/null +++ b/src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.ts @@ -0,0 +1,106 @@ +import { NgStyle } from '@angular/common'; +import { + Component, + EventEmitter, + Input, + OnInit, + Output, +} from '@angular/core'; +import { LevelSecurityConfig } from '@dspace/config/metadata-security-config'; +import { + hasNoValue, + isEmpty, +} from '@dspace/shared/utils/empty.util'; +import { BtnDisabledDirective } from 'src/app/shared/btn-disabled.directive'; + +import { environment } from '../../../../environments/environment'; + +@Component({ + selector: 'ds-edit-metadata-security', + templateUrl: './edit-metadata-security.component.html', + styleUrls: ['./edit-metadata-security.component.scss'], + imports: [ + BtnDisabledDirective, + NgStyle, + ], +}) +export class EditMetadataSecurityComponent implements OnInit { + + /** + * A boolean representing if toggle buttons should be disabled + */ + @Input() readOnly = false; + + /** + * The start security value + */ + @Input() securityLevel: number; + + /** + * The security levels available + */ + @Input() securityConfigLevel: number[] = []; + + /** + * A boolean representing if security toggle is related to a new field + */ + @Input() isNewMdField = false; + + /** + * An event emitted when the security level is changed by the user + */ + @Output() changeSecurityLevel = new EventEmitter(); + + /** + * Emits when a metadata field has a security level configuration + */ + @Output() hasSecurityLevel = new EventEmitter(); + + public securityLevelsMap: LevelSecurityConfig[] = environment.security.levels; + + ngOnInit(): void { + this.filterSecurityLevelsMap(); + this.hasSecurityLevel.emit(true); + + if (this.securityConfigLevel.length > 0) { + if (this.isNewMdField) { + // If the metadata field is new, set the security level to the highest level automatically + this.securityLevel = this.securityConfigLevel[this.securityConfigLevel.length - 1]; + } else if (isEmpty(this.securityLevel)) { + // If the metadata field is existing but has no security value, set the security level to the lowest level automatically + this.securityLevel = this.securityConfigLevel[0]; + } + } + } + + /** + * Check if the selected security level is different from the current level, + * if so,update the security level & emit the new level + * @param level The security level to change to + */ + changeSelectedSecurityLevel(level: number) { + if (this.securityLevel !== level) { + this.securityLevel = level; + this.changeSecurityLevel.emit(level); + } + } + + private filterSecurityLevelsMap() { + this.securityLevelsMap = environment.security.levels; + if ( + hasNoValue(this.securityConfigLevel) || + (this.securityConfigLevel.length === 1 && + this.securityConfigLevel.includes(0)) + ) { + this.securityLevelsMap = null; + this.changeSecurityLevel.emit(0); + } else { + // Filter securityLevelsMap based on securityConfigLevel + this.securityLevelsMap = this.securityLevelsMap.filter( + (el: any, index) => { + return index === 0 || this.securityConfigLevel.includes(el.value); + }, + ); + } + } +} diff --git a/src/app/item-page/field-components/metadata-uri-values/metadata-uri-values.component.spec.ts b/src/app/item-page/field-components/metadata-uri-values/metadata-uri-values.component.spec.ts index e9b825dc966..092cb6ef96d 100644 --- a/src/app/item-page/field-components/metadata-uri-values/metadata-uri-values.component.spec.ts +++ b/src/app/item-page/field-components/metadata-uri-values/metadata-uri-values.component.spec.ts @@ -11,6 +11,7 @@ import { import { By } from '@angular/platform-browser'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { MetadataValue } from '@dspace/core/shared/metadata.models'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { TranslateLoaderMock } from '@dspace/core/testing/translate-loader.mock'; import { isNotEmpty } from '@dspace/shared/utils/empty.util'; import { @@ -23,6 +24,10 @@ import { MetadataUriValuesComponent } from './metadata-uri-values.component'; let comp: MetadataUriValuesComponent; let fixture: ComponentFixture; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; + const mockMetadata = [ { @@ -38,6 +43,7 @@ const mockSeperator = '
'; const mockLabel = 'fake.message'; const mockLinkText = 'fake link text'; + describe('MetadataUriValuesComponent', () => { beforeEach(waitForAsync(() => { TestBed.configureTestingModule({ @@ -49,6 +55,7 @@ describe('MetadataUriValuesComponent', () => { }), MetadataUriValuesComponent], providers: [ { provide: APP_CONFIG, useValue: environment }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(MetadataUriValuesComponent, { diff --git a/src/app/item-page/field-components/metadata-values/metadata-values.component.html b/src/app/item-page/field-components/metadata-values/metadata-values.component.html index 60fca0a8b71..7ed177f5b6d 100644 --- a/src/app/item-page/field-components/metadata-values/metadata-values.component.html +++ b/src/app/item-page/field-components/metadata-values/metadata-values.component.html @@ -1,10 +1,11 @@ @for (mdValue of mdValues; track mdValue; let last = $last) { + @let isVocabulary = isControlledVocabulary(mdValue); - + @if (!last) { @@ -50,3 +51,14 @@ [routerLink]="['/browse', browseDefinition.id]" [queryParams]="getQueryParams(value)" role="link" tabindex="0">{{value}} + + + + + @let label = getVocabularyValue(value) | async; + @if (hasBrowseDefinition()) { + + } @else { + {{label}} + } + diff --git a/src/app/item-page/field-components/metadata-values/metadata-values.component.spec.ts b/src/app/item-page/field-components/metadata-values/metadata-values.component.spec.ts index 21d5d528cbf..f3581f8cc8c 100644 --- a/src/app/item-page/field-components/metadata-values/metadata-values.component.spec.ts +++ b/src/app/item-page/field-components/metadata-values/metadata-values.component.spec.ts @@ -9,12 +9,17 @@ import { } from '@angular/core/testing'; import { By } from '@angular/platform-browser'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; +import { buildPaginatedList } from '@dspace/core/data/paginated-list.model'; import { MetadataValue } from '@dspace/core/shared/metadata.models'; +import { PageInfo } from '@dspace/core/shared/page-info.model'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { TranslateLoaderMock } from '@dspace/core/testing/translate-loader.mock'; +import { createSuccessfulRemoteDataObject } from '@dspace/core/utilities/remote-data.utils'; import { TranslateLoader, TranslateModule, } from '@ngx-translate/core'; +import { of } from 'rxjs'; import { environment } from '../../../../environments/environment'; import { MetadataValuesComponent } from './metadata-values.component'; @@ -37,6 +42,18 @@ const mockMetadata = [ }] as MetadataValue[]; const mockSeperator = '
'; const mockLabel = 'fake.message'; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; + +const controlledMetadata = { + value: 'Original Value', + authority: 'srsc:1234', + uuid: 'metadata-uuid-1', + language: 'en_US', + place: null, + confidence: 600, +} as MetadataValue; describe('MetadataValuesComponent', () => { beforeEach(waitForAsync(() => { @@ -49,6 +66,7 @@ describe('MetadataValuesComponent', () => { }), MetadataValuesComponent], providers: [ { provide: APP_CONFIG, useValue: environment }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(MetadataValuesComponent, { @@ -99,4 +117,29 @@ describe('MetadataValuesComponent', () => { expect(result.rel).toBe('noopener noreferrer'); }); + it('should detect controlled vocabulary metadata', () => { + const result = comp.isControlledVocabulary(controlledMetadata); + expect(result).toBeTrue(); + }); + + it('should return translated vocabulary value when available', (done) => { + const vocabEntry = { + display: 'Translated Value', + }; + + vocabularyServiceMock.getPublicVocabularyEntryByID.and.returnValue( + of( + createSuccessfulRemoteDataObject( + buildPaginatedList(new PageInfo(), [vocabEntry]), + ), + ), + ); + + comp.getVocabularyValue(controlledMetadata).subscribe((value) => { + expect(value).toBe('Translated Value'); + done(); + }); + }); + + }); diff --git a/src/app/item-page/field-components/metadata-values/metadata-values.component.ts b/src/app/item-page/field-components/metadata-values/metadata-values.component.ts index 666ece3f400..c37f1f975bf 100644 --- a/src/app/item-page/field-components/metadata-values/metadata-values.component.ts +++ b/src/app/item-page/field-components/metadata-values/metadata-values.component.ts @@ -1,4 +1,7 @@ -import { NgTemplateOutlet } from '@angular/common'; +import { + AsyncPipe, + NgTemplateOutlet, +} from '@angular/common'; import { Component, Inject, @@ -13,9 +16,20 @@ import { } from '@dspace/config/app-config.interface'; import { BrowseDefinition } from '@dspace/core/shared/browse-definition.model'; import { MetadataValue } from '@dspace/core/shared/metadata.models'; +import { + getFirstCompletedRemoteData, + getPaginatedListPayload, + getRemoteDataPayload, +} from '@dspace/core/shared/operators'; import { VALUE_LIST_BROWSE_DEFINITION } from '@dspace/core/shared/value-list-browse-definition.resource-type'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { hasValue } from '@dspace/shared/utils/empty.util'; import { TranslateModule } from '@ngx-translate/core'; +import { Observable } from 'rxjs'; +import { + map, + take, +} from 'rxjs/operators'; import { environment } from '../../../../environments/environment'; import { MetadataFieldWrapperComponent } from '../../../shared/metadata-field-wrapper/metadata-field-wrapper.component'; @@ -31,6 +45,7 @@ import { ImageField } from '../../simple/field-components/specific-field/image-f styleUrls: ['./metadata-values.component.scss'], templateUrl: './metadata-values.component.html', imports: [ + AsyncPipe, MarkdownDirective, MetadataFieldWrapperComponent, NgTemplateOutlet, @@ -41,6 +56,7 @@ import { ImageField } from '../../simple/field-components/specific-field/image-f export class MetadataValuesComponent implements OnChanges { constructor( + protected vocabularyService: VocabularyService, @Inject(APP_CONFIG) private appConfig: AppConfig, ) { } @@ -110,6 +126,30 @@ export class MetadataValuesComponent implements OnChanges { return false; } + /** + * Whether the metadata is a controlled vocabulary + * @param value A MetadataValue being displayed + */ + isControlledVocabulary(metadataValue: MetadataValue): boolean { + const vocabularyId = this.getVocabularyIdFromAuthorityValue(metadataValue); + return hasValue(this.getVocabularyName(vocabularyId)); + } + + /** + * Return configured vocabulary name for this metadata value + */ + getVocabularyName(vocabularyId: string): string | null { + return this.appConfig.vocabularies.find(vocabulary => vocabulary.vocabulary === vocabularyId)?.vocabulary; + } + + /** + * Get value from authority for vocabulary lookup + */ + getVocabularyIdFromAuthorityValue(metadataValue: MetadataValue): string { + const authority = metadataValue.authority ? metadataValue.authority.split(':') : undefined; + return authority?.length > 1 ? authority[0] : null; + } + /** * Return a queryparams object for use in a link, with the key dependent on whether this browse * definition is metadata browse, or item browse @@ -146,4 +186,21 @@ export class MetadataValuesComponent implements OnChanges { return { target: '_blank', rel: 'noopener noreferrer' }; } } + + /** + * Get vocabulary translated value from metadata value + */ + getVocabularyValue(metadataValue: MetadataValue): Observable { + const vocabularyId = this.getVocabularyIdFromAuthorityValue(metadataValue); + const vocabularyName = this.getVocabularyName(vocabularyId); + + return this.vocabularyService.getPublicVocabularyEntryByID(vocabularyName, metadataValue.authority.split(':')[1]).pipe( + getFirstCompletedRemoteData(), + getRemoteDataPayload(), + getPaginatedListPayload(), + map((res) => res?.length > 0 ? res[0] : null), + map((res) => res?.display ?? metadataValue.value), + take(1), + ); + } } diff --git a/src/app/item-page/simple/field-components/specific-field/abstract/item-page-abstract-field.component.spec.ts b/src/app/item-page/simple/field-components/specific-field/abstract/item-page-abstract-field.component.spec.ts index 4243accfdbb..9b2ce62d6c8 100644 --- a/src/app/item-page/simple/field-components/specific-field/abstract/item-page-abstract-field.component.spec.ts +++ b/src/app/item-page/simple/field-components/specific-field/abstract/item-page-abstract-field.component.spec.ts @@ -11,6 +11,7 @@ import { By } from '@angular/platform-browser'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { BrowseService } from '@dspace/core/browse/browse.service'; import { BrowseDefinitionDataService } from '@dspace/core/browse/browse-definition-data.service'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { BrowseDefinitionDataServiceStub } from '@dspace/core/testing/browse-definition-data-service.stub'; import { BrowseServiceStub } from '@dspace/core/testing/browse-service.stub'; import { TranslateLoaderMock } from '@dspace/core/testing/translate-loader.mock'; @@ -24,6 +25,9 @@ import { ItemPageAbstractFieldComponent } from './item-page-abstract-field.compo let comp: ItemPageAbstractFieldComponent; let fixture: ComponentFixture; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; describe('ItemPageAbstractFieldComponent', () => { beforeEach(waitForAsync(() => { @@ -41,6 +45,7 @@ describe('ItemPageAbstractFieldComponent', () => { { provide: APP_CONFIG, useValue: environment }, { provide: BrowseDefinitionDataService, useValue: BrowseDefinitionDataServiceStub }, { provide: BrowseService, useValue: BrowseServiceStub }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(ItemPageAbstractFieldComponent, { diff --git a/src/app/item-page/simple/field-components/specific-field/author/item-page-author-field.component.spec.ts b/src/app/item-page/simple/field-components/specific-field/author/item-page-author-field.component.spec.ts index 247fce3569e..f73aa4bee61 100644 --- a/src/app/item-page/simple/field-components/specific-field/author/item-page-author-field.component.spec.ts +++ b/src/app/item-page/simple/field-components/specific-field/author/item-page-author-field.component.spec.ts @@ -11,6 +11,7 @@ import { ActivatedRoute } from '@angular/router'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { BrowseService } from '@dspace/core/browse/browse.service'; import { BrowseDefinitionDataService } from '@dspace/core/browse/browse-definition-data.service'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { ActivatedRouteStub } from '@dspace/core/testing/active-router.stub'; import { BrowseDefinitionDataServiceStub } from '@dspace/core/testing/browse-definition-data-service.stub'; import { BrowseServiceStub } from '@dspace/core/testing/browse-service.stub'; @@ -30,6 +31,9 @@ let fixture: ComponentFixture; const mockFields = ['dc.contributor.author', 'dc.creator', 'dc.contributor']; const mockValue = 'test value'; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; describe('ItemPageAuthorFieldComponent', () => { beforeEach(waitForAsync(() => { @@ -45,6 +49,7 @@ describe('ItemPageAuthorFieldComponent', () => { { provide: BrowseDefinitionDataService, useValue: BrowseDefinitionDataServiceStub }, { provide: BrowseService, useValue: BrowseServiceStub }, { provide: ActivatedRoute, useValue: new ActivatedRouteStub() }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(ItemPageAuthorFieldComponent, { diff --git a/src/app/item-page/simple/field-components/specific-field/date/item-page-date-field.component.spec.ts b/src/app/item-page/simple/field-components/specific-field/date/item-page-date-field.component.spec.ts index c047be679f9..22c0080eaa5 100644 --- a/src/app/item-page/simple/field-components/specific-field/date/item-page-date-field.component.spec.ts +++ b/src/app/item-page/simple/field-components/specific-field/date/item-page-date-field.component.spec.ts @@ -11,6 +11,7 @@ import { ActivatedRoute } from '@angular/router'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { BrowseService } from '@dspace/core/browse/browse.service'; import { BrowseDefinitionDataService } from '@dspace/core/browse/browse-definition-data.service'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { ActivatedRouteStub } from '@dspace/core/testing/active-router.stub'; import { BrowseDefinitionDataServiceStub } from '@dspace/core/testing/browse-definition-data-service.stub'; import { BrowseServiceStub } from '@dspace/core/testing/browse-service.stub'; @@ -28,8 +29,12 @@ import { ItemPageDateFieldComponent } from './item-page-date-field.component'; let comp: ItemPageDateFieldComponent; let fixture: ComponentFixture; + const mockField = 'dc.date.issued'; const mockValue = 'test value'; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; describe('ItemPageDateFieldComponent', () => { beforeEach(waitForAsync(() => { @@ -45,6 +50,7 @@ describe('ItemPageDateFieldComponent', () => { { provide: BrowseDefinitionDataService, useValue: BrowseDefinitionDataServiceStub }, { provide: BrowseService, useValue: BrowseServiceStub }, { provide: ActivatedRoute, useValue: new ActivatedRouteStub() }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(ItemPageDateFieldComponent, { diff --git a/src/app/item-page/simple/field-components/specific-field/generic/generic-item-page-field.component.spec.ts b/src/app/item-page/simple/field-components/specific-field/generic/generic-item-page-field.component.spec.ts index c6d26a2b363..0b5890631ab 100644 --- a/src/app/item-page/simple/field-components/specific-field/generic/generic-item-page-field.component.spec.ts +++ b/src/app/item-page/simple/field-components/specific-field/generic/generic-item-page-field.component.spec.ts @@ -11,6 +11,7 @@ import { ActivatedRoute } from '@angular/router'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { BrowseService } from '@dspace/core/browse/browse.service'; import { BrowseDefinitionDataService } from '@dspace/core/browse/browse-definition-data.service'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { ActivatedRouteStub } from '@dspace/core/testing/active-router.stub'; import { BrowseDefinitionDataServiceStub } from '@dspace/core/testing/browse-definition-data-service.stub'; import { BrowseServiceStub } from '@dspace/core/testing/browse-service.stub'; @@ -32,6 +33,10 @@ const mockValue = 'test value'; const mockField = 'dc.test'; const mockLabel = 'test label'; const mockFields = [mockField]; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; + describe('GenericItemPageFieldComponent', () => { beforeEach(waitForAsync(() => { @@ -47,6 +52,7 @@ describe('GenericItemPageFieldComponent', () => { { provide: BrowseDefinitionDataService, useValue: BrowseDefinitionDataServiceStub }, { provide: BrowseService, useValue: BrowseServiceStub }, { provide: ActivatedRoute, useValue: new ActivatedRouteStub() }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(GenericItemPageFieldComponent, { diff --git a/src/app/item-page/simple/field-components/specific-field/img/item-page-img-field.component.spec.ts b/src/app/item-page/simple/field-components/specific-field/img/item-page-img-field.component.spec.ts index 5c8a7505219..9a2fc201ddf 100644 --- a/src/app/item-page/simple/field-components/specific-field/img/item-page-img-field.component.spec.ts +++ b/src/app/item-page/simple/field-components/specific-field/img/item-page-img-field.component.spec.ts @@ -10,6 +10,7 @@ import { By } from '@angular/platform-browser'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { BrowseService } from '@dspace/core/browse/browse.service'; import { BrowseDefinitionDataService } from '@dspace/core/browse/browse-definition-data.service'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { BrowseDefinitionDataServiceStub } from '@dspace/core/testing/browse-definition-data-service.stub'; import { BrowseServiceStub } from '@dspace/core/testing/browse-service.stub'; import { TranslateLoaderMock } from '@dspace/core/testing/translate-loader.mock'; @@ -37,6 +38,10 @@ const mockImg = { alt: 'item.page.image.alt.ROR', heightVar: '--ds-item-page-img-field-ror-inline-height', } as ImageField; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; + describe('ItemPageImgFieldComponent', () => { @@ -52,6 +57,7 @@ describe('ItemPageImgFieldComponent', () => { { provide: APP_CONFIG, useValue: environment }, { provide: BrowseDefinitionDataService, useValue: BrowseDefinitionDataServiceStub }, { provide: BrowseService, useValue: BrowseServiceStub }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }) diff --git a/src/app/item-page/simple/field-components/specific-field/item-page-field.component.spec.ts b/src/app/item-page/simple/field-components/specific-field/item-page-field.component.spec.ts index 8dac865034d..f1a7fb95726 100644 --- a/src/app/item-page/simple/field-components/specific-field/item-page-field.component.spec.ts +++ b/src/app/item-page/simple/field-components/specific-field/item-page-field.component.spec.ts @@ -18,6 +18,7 @@ import { MetadataMap, MetadataValue, } from '@dspace/core/shared/metadata.models'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { BrowseDefinitionDataServiceStub } from '@dspace/core/testing/browse-definition-data-service.stub'; import { BrowseServiceStub } from '@dspace/core/testing/browse-service.stub'; import { TranslateLoaderMock } from '@dspace/core/testing/translate-loader.mock'; @@ -43,6 +44,9 @@ const mockLabel = 'test label'; const mockAuthorField = 'dc.contributor.author'; const mockDateIssuedField = 'dc.date.issued'; const mockFields = [mockField, mockAuthorField, mockDateIssuedField]; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; describe('ItemPageFieldComponent', () => { @@ -70,6 +74,7 @@ describe('ItemPageFieldComponent', () => { { provide: BrowseDefinitionDataService, useValue: BrowseDefinitionDataServiceStub }, { provide: BrowseService, useValue: BrowseServiceStub }, { provide: MathService, useValue: {} }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(ItemPageFieldComponent, { diff --git a/src/app/item-page/simple/field-components/specific-field/uri/item-page-uri-field.component.spec.ts b/src/app/item-page/simple/field-components/specific-field/uri/item-page-uri-field.component.spec.ts index 9250f74c3a0..0c53723fa57 100644 --- a/src/app/item-page/simple/field-components/specific-field/uri/item-page-uri-field.component.spec.ts +++ b/src/app/item-page/simple/field-components/specific-field/uri/item-page-uri-field.component.spec.ts @@ -10,6 +10,7 @@ import { import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { BrowseService } from '@dspace/core/browse/browse.service'; import { BrowseDefinitionDataService } from '@dspace/core/browse/browse-definition-data.service'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { BrowseDefinitionDataServiceStub } from '@dspace/core/testing/browse-definition-data-service.stub'; import { BrowseServiceStub } from '@dspace/core/testing/browse-service.stub'; import { TranslateLoaderMock } from '@dspace/core/testing/translate-loader.mock'; @@ -29,6 +30,10 @@ let fixture: ComponentFixture; const mockField = 'dc.identifier.uri'; const mockValue = 'test value'; const mockLabel = 'test label'; +const vocabularyServiceMock = { + getPublicVocabularyEntryByID: jasmine.createSpy('getPublicVocabularyEntryByID'), +}; + describe('ItemPageUriFieldComponent', () => { beforeEach(waitForAsync(() => { @@ -43,6 +48,7 @@ describe('ItemPageUriFieldComponent', () => { { provide: APP_CONFIG, useValue: environment }, { provide: BrowseDefinitionDataService, useValue: BrowseDefinitionDataServiceStub }, { provide: BrowseService, useValue: BrowseServiceStub }, + { provide: VocabularyService, useValue: vocabularyServiceMock }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(ItemPageUriFieldComponent, { diff --git a/src/app/item-page/simple/item-types/shared/item.component.ts b/src/app/item-page/simple/item-types/shared/item.component.ts index 2c4c50eb532..965a18ef199 100644 --- a/src/app/item-page/simple/item-types/shared/item.component.ts +++ b/src/app/item-page/simple/item-types/shared/item.component.ts @@ -79,10 +79,16 @@ export class ItemComponent implements OnInit { */ geospatialItemPageFieldsEnabled = false; + /** + * Flag to check whether to use the default relations or the authority based ones + */ + areAuthorityRelationsEnabled: boolean; + constructor(protected routeService: RouteService, protected router: Router) { this.mediaViewer = environment.mediaViewer; this.geospatialItemPageFieldsEnabled = environment.geospatialMapViewer.enableItemPageFields; + this.areAuthorityRelationsEnabled = environment.item.showAuthorithyRelations; } /** diff --git a/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.html b/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.html new file mode 100644 index 00000000000..85e15cb6fbc --- /dev/null +++ b/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.html @@ -0,0 +1,41 @@ +@if (configurations.length > 1) { + + +
+} + + +@if (configurations.length === 1) { + + +} diff --git a/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.spec.ts b/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.spec.ts new file mode 100644 index 00000000000..acb3ecde6e9 --- /dev/null +++ b/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.spec.ts @@ -0,0 +1,99 @@ +import { NO_ERRORS_SCHEMA } from '@angular/core'; +import { + ComponentFixture, + TestBed, + waitForAsync, +} from '@angular/core/testing'; +import { + ActivatedRoute, + Router, +} from '@angular/router'; +import { Item } from '@dspace/core/shared/item.model'; +import { RouterMock } from '@dspace/core/testing/router.mock'; +import { TranslateModule } from '@ngx-translate/core'; +import { of } from 'rxjs'; + +import { ThemedConfigurationSearchPageComponent } from '../../../../search-page/themed-configuration-search-page.component'; +import { AuthorityRelatedEntitiesSearchComponent } from './authority-related-entities-search.component'; + + +describe('AuthorityRelatedEntitiesSearchComponent', () => { + let component: AuthorityRelatedEntitiesSearchComponent; + let fixture: ComponentFixture; + + const mockItem = { + id: 'test-id-123', + } as Item; + const router = new RouterMock(); + + + beforeEach(waitForAsync(() => { + TestBed.configureTestingModule({ + imports: [TranslateModule.forRoot(), AuthorityRelatedEntitiesSearchComponent], + providers: [ + { + provide: ActivatedRoute, + useValue: { + queryParams: of({ tab: 'relations-configuration' }), + snapshot: { + queryParams: { + scope: 'collection-uuid', + query: 'test', + }, + }, + }, + }, + { provide: Router, useValue: router }, + ], + schemas: [NO_ERRORS_SCHEMA], + }) + .overrideComponent(AuthorityRelatedEntitiesSearchComponent, { + remove: { + imports: [ + ThemedConfigurationSearchPageComponent, + ], + }, + }) + .compileComponents(); + })); + + beforeEach(() => { + fixture = TestBed.createComponent(AuthorityRelatedEntitiesSearchComponent); + component = fixture.componentInstance; + component.item = mockItem; + component.configurations = ['relations-configuration']; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should set searchFilter on init', () => { + component.item = mockItem; + component.ngOnInit(); + + expect(component.searchFilter).toBe('scope=test-id-123'); + }); + + it('should render configuration search page when configuration is provided', () => { + component.item = mockItem; + component.configurations = ['test-config']; + + fixture.detectChanges(); + + const searchPage = fixture.nativeElement.querySelector('ds-configuration-search-page'); + expect(searchPage).toBeTruthy(); + }); + + it('should NOT render configuration search page when configuration is missing', () => { + component.item = mockItem; + component.configurations = []; + + fixture.detectChanges(); + + const searchPage = fixture.nativeElement.querySelector('ds-configuration-search-page'); + expect(searchPage).toBeFalsy(); + }); + +}); diff --git a/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.ts b/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.ts new file mode 100644 index 00000000000..9450edb9ba3 --- /dev/null +++ b/src/app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component.ts @@ -0,0 +1,52 @@ +import { AsyncPipe } from '@angular/common'; +import { + Component, + Input, + OnInit, +} from '@angular/core'; +import { + NgbNav, + NgbNavContent, + NgbNavItem, + NgbNavLink, + NgbNavOutlet, +} from '@ng-bootstrap/ng-bootstrap'; +import { TranslateModule } from '@ngx-translate/core'; + +import { ThemedConfigurationSearchPageComponent } from '../../../../search-page/themed-configuration-search-page.component'; +import { TabbedRelatedEntitiesSearchComponent } from '../tabbed-related-entities-search/tabbed-related-entities-search.component'; + +@Component({ + selector: 'ds-authority-related-entities-search', + templateUrl: './authority-related-entities-search.component.html', + imports: [ + AsyncPipe, + NgbNav, + NgbNavContent, + NgbNavItem, + NgbNavLink, + NgbNavOutlet, + ThemedConfigurationSearchPageComponent, + TranslateModule, + ], +}) +/** + * A component to show related items as search results, based on authority value + */ +export class AuthorityRelatedEntitiesSearchComponent extends TabbedRelatedEntitiesSearchComponent implements OnInit { + /** + * Filter used for set scope in discovery invocation + */ + searchFilter: string; + /** + * Discovery configurations for search page + */ + @Input() configurations: string[] = []; + + + + ngOnInit() { + super.ngOnInit(); + this.searchFilter = `scope=${this.item.id}`; + } +} diff --git a/src/app/item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component.html b/src/app/item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component.html index 147650b11aa..901077dbfb1 100644 --- a/src/app/item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component.html +++ b/src/app/item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component.html @@ -1,6 +1,6 @@ @if (relationTypes.length > 1) {
    - @for (relationType of relationTypes; track relationType) { + @for (relationType of relationTypes; track relationType.configuration) {
  • {{'item.page.relationships.' + relationType.label | translate}} diff --git a/src/app/item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component.ts b/src/app/item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component.ts index 5d88d4b8b57..00c6f625407 100644 --- a/src/app/item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component.ts +++ b/src/app/item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component.ts @@ -9,7 +9,13 @@ import { Router, } from '@angular/router'; import { Item } from '@dspace/core/shared/item.model'; -import { NgbNavModule } from '@ng-bootstrap/ng-bootstrap'; +import { + NgbNav, + NgbNavContent, + NgbNavItem, + NgbNavLink, + NgbNavOutlet, +} from '@ng-bootstrap/ng-bootstrap'; import { TranslateModule } from '@ngx-translate/core'; import { Observable } from 'rxjs'; import { map } from 'rxjs/operators'; @@ -22,7 +28,11 @@ import { RelatedEntitiesSearchComponent } from '../related-entities-search/relat templateUrl: './tabbed-related-entities-search.component.html', imports: [ AsyncPipe, - NgbNavModule, + NgbNav, + NgbNavContent, + NgbNavItem, + NgbNavLink, + NgbNavOutlet, RelatedEntitiesSearchComponent, TranslateModule, VarDirective, @@ -66,8 +76,8 @@ export class TabbedRelatedEntitiesSearchComponent implements OnInit { */ activeTab$: Observable; - constructor(private route: ActivatedRoute, - private router: Router) { + constructor(protected route: ActivatedRoute, + protected router: Router) { } /** diff --git a/src/app/my-dspace-page/my-dspace-configuration-value-type.ts b/src/app/my-dspace-page/my-dspace-configuration-value-type.ts index c8484d97a06..7cc4dafcdde 100644 --- a/src/app/my-dspace-page/my-dspace-configuration-value-type.ts +++ b/src/app/my-dspace-page/my-dspace-configuration-value-type.ts @@ -1,5 +1,6 @@ export enum MyDSpaceConfigurationValueType { Workspace = 'workspace', SupervisedItems = 'supervisedWorkspace', + OtherWorkspace = 'otherworkspace', Workflow = 'workflow' } diff --git a/src/app/my-dspace-page/my-dspace-configuration.service.spec.ts b/src/app/my-dspace-page/my-dspace-configuration.service.spec.ts index a62c2c64a97..3b0429594ec 100644 --- a/src/app/my-dspace-page/my-dspace-configuration.service.spec.ts +++ b/src/app/my-dspace-page/my-dspace-configuration.service.spec.ts @@ -192,6 +192,7 @@ describe('MyDSpaceConfigurationService', () => { expect(list$).toBeObservable(cold('(b|)', { b: [ MyDSpaceConfigurationValueType.Workspace, + MyDSpaceConfigurationValueType.OtherWorkspace, ], })); }); @@ -236,6 +237,7 @@ describe('MyDSpaceConfigurationService', () => { expect(list$).toBeObservable(cold('(b|)', { b: [ MyDSpaceConfigurationValueType.Workspace, + MyDSpaceConfigurationValueType.OtherWorkspace, MyDSpaceConfigurationValueType.SupervisedItems, MyDSpaceConfigurationValueType.Workflow, ], diff --git a/src/app/my-dspace-page/my-dspace-configuration.service.ts b/src/app/my-dspace-page/my-dspace-configuration.service.ts index 7c4feb1b4db..751cc39b1d2 100644 --- a/src/app/my-dspace-page/my-dspace-configuration.service.ts +++ b/src/app/my-dspace-page/my-dspace-configuration.service.ts @@ -123,6 +123,7 @@ export class MyDSpaceConfigurationService extends SearchConfigurationService { const availableConf: MyDSpaceConfigurationValueType[] = []; if (isSubmitter) { availableConf.push(MyDSpaceConfigurationValueType.Workspace); + availableConf.push(MyDSpaceConfigurationValueType.OtherWorkspace); } if (isController || isAdmin) { availableConf.push(MyDSpaceConfigurationValueType.SupervisedItems); diff --git a/src/app/shared/entity-icon/entity-icon.directive.spec.ts b/src/app/shared/entity-icon/entity-icon.directive.spec.ts new file mode 100644 index 00000000000..4322f99e146 --- /dev/null +++ b/src/app/shared/entity-icon/entity-icon.directive.spec.ts @@ -0,0 +1,131 @@ +import { Component } from '@angular/core'; +import { + ComponentFixture, + TestBed, +} from '@angular/core/testing'; + +import { EntityIconDirective } from './entity-icon.directive'; + +describe('EntityIconDirective', () => { + let component: TestComponent; + let fixture: ComponentFixture; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [ + EntityIconDirective, + TestComponent, + ], + }).compileComponents(); + }); + + describe('with default value provided', () => { + beforeEach(() => { + fixture = TestBed.createComponent(TestComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should display a text-success icon', () => { + const successIcon = fixture.nativeElement.querySelector('[data-test="entityTestComponent"]').querySelector('i.text-success'); + expect(successIcon).toBeTruthy(); + }); + + it('should display a text-success icon after span', () => { + const successIcon = fixture.nativeElement.querySelector('[data-test="entityTestComponent"]').querySelector('i.text-success'); + const entityElement = fixture.nativeElement.querySelector('[data-test="entityTestComponent"]'); + // position 1 because the icon is after the span + expect(entityElement.children[1]).toBe(successIcon); + }); + }); + + describe('with primary value provided', () => { + beforeEach(() => { + fixture = TestBed.createComponent(TestComponent); + component = fixture.componentInstance; + component.metadata.entityType = 'person'; + component.metadata.entityStyle = 'personStaff'; + component.iconPosition = 'before'; + fixture.detectChanges(); + }); + + it('should display a text-primary icon', () => { + const primaryIcon = fixture.nativeElement.querySelector('[data-test="entityTestComponent"]').querySelector('i.text-primary'); + expect(primaryIcon).toBeTruthy(); + }); + + it('should display a text-primary icon before span', () => { + const primaryIcon = fixture.nativeElement.querySelector('[data-test="entityTestComponent"]').querySelector('i.text-primary'); + const entityElement = fixture.nativeElement.querySelector('[data-test="entityTestComponent"]'); + // position 0 because the icon is before the span + expect(entityElement.children[0]).toBe(primaryIcon); + }); + }); + + describe('when given type doesn\'t exist and fallback on default disabled', () => { + beforeEach(() => { + fixture = TestBed.createComponent(TestComponent); + component = fixture.componentInstance; + component.fallbackOnDefault = false; + component.metadata.entityType = 'TESTFAKE'; + component.metadata.entityStyle = 'personFallback'; + component.iconPosition = 'before'; + fixture.detectChanges(); + }); + + it('should not display a text-primary icon', () => { + const primaryIcon = fixture.nativeElement.querySelector('[data-test="entityTestComponent"]').querySelector('i'); + expect(primaryIcon).toBeFalsy(); + }); + }); + + describe('when given style doesn\'t exist and fallback on default disabled', () => { + beforeEach(() => { + fixture = TestBed.createComponent(TestComponent); + component = fixture.componentInstance; + component.fallbackOnDefault = false; + component.metadata.entityType = 'person'; + component.metadata.entityStyle = 'personFallback'; + component.iconPosition = 'before'; + fixture.detectChanges(); + }); + + it('should not display a text-primary icon', () => { + const primaryIcon = fixture.nativeElement.querySelector('[data-test="entityTestComponent"]').querySelector('i'); + expect(primaryIcon).toBeFalsy(); + }); + }); + +}); + + // declare a test component + @Component({ + selector: 'ds-test-cmp', + template: ` +
    + {{ metadata.value }}
    `, + imports: [ + EntityIconDirective, + ], + }) +class TestComponent { + + metadata = { + authority: null, + value: 'Test', + orcidAuthenticated: null, + entityType: 'default', + entityStyle: 'default', + }; + iconPosition = 'after'; + fallbackOnDefault = true; + + } diff --git a/src/app/shared/entity-icon/entity-icon.directive.ts b/src/app/shared/entity-icon/entity-icon.directive.ts new file mode 100644 index 00000000000..f06de65fd37 --- /dev/null +++ b/src/app/shared/entity-icon/entity-icon.directive.ts @@ -0,0 +1,130 @@ +import { + Directive, + ElementRef, + Input, + OnInit, +} from '@angular/core'; +import { + AuthorityRefConfig, + AuthorityRefEntityStyleConfig, +} from '@dspace/config/layout-config.interfaces'; +import { + isEmpty, + isNotEmpty, +} from '@dspace/shared/utils/empty.util'; + +import { environment } from '../../../environments/environment'; + + +/** + * Directive to add to the element a entity icon based on metadata entity type and entity style + */ +@Directive({ + selector: '[dsEntityIcon]', + standalone: true, +}) +export class EntityIconDirective implements OnInit { + + /** + * The metadata entity type + */ + @Input() entityType = 'default'; + + /** + * The metadata entity style + */ + @Input() entityStyle: string|string[] = 'default'; + + /** + * A boolean representing if to fallback on default style if the given one is not found + */ + @Input() fallbackOnDefault = true; + + /** + * A boolean representing if to show html icon before or after + */ + @Input() iconPosition = 'after'; + + /** + * A configuration representing authorityRef values + */ + confValue = environment.layout.authorityRef; + + /** + * Initialize instance variables + * + * @param {ElementRef} elem + */ + constructor(private elem: ElementRef) { + } + + /** + * Adding icon to element oninit + */ + ngOnInit() { + const crisRefConfig: AuthorityRefConfig = this.getCrisRefConfigByType(this.entityType); + if (isNotEmpty(crisRefConfig)) { + const crisStyle: AuthorityRefEntityStyleConfig = this.getCrisRefEntityStyleConfig(crisRefConfig, this.entityStyle); + if (isNotEmpty(crisStyle)) { + this.addIcon(crisStyle); + } + } + } + + /** + * Return the AuthorityRefConfig by the given type + * + * @param type + * @private + */ + private getCrisRefConfigByType(type: string): AuthorityRefConfig { + let filteredConf: AuthorityRefConfig = this.confValue.find((config) => config.entityType.toUpperCase() === type.toUpperCase()); + if (isEmpty(filteredConf) && this.fallbackOnDefault) { + filteredConf = this.confValue.find((config) => config.entityType.toUpperCase() === 'DEFAULT'); + } + + return filteredConf; + } + + /** + * Return the AuthorityRefEntityStyleConfig by the given style + * + * @param crisConfig + * @param styles + * @private + */ + private getCrisRefEntityStyleConfig(crisConfig: AuthorityRefConfig, styles: string|string[]): AuthorityRefEntityStyleConfig { + let filteredConf: AuthorityRefEntityStyleConfig; + if (Array.isArray(styles)) { + styles.forEach((style) => { + if (Object.keys(crisConfig.entityStyle).includes(style)) { + filteredConf = crisConfig.entityStyle[style]; + } + }); + } else { + filteredConf = crisConfig.entityStyle[styles]; + } + + if (isEmpty(filteredConf) && this.fallbackOnDefault) { + filteredConf = crisConfig.entityStyle.default; + } + + return filteredConf; + } + + /** + * Attach icon to HTML element + * + * @param crisStyle + * @private + */ + private addIcon(entityStyle: AuthorityRefEntityStyleConfig): void { + const iconElement = ``; + if (this.iconPosition === 'after') { + this.elem.nativeElement.insertAdjacentHTML('afterend', ' ' + iconElement); + } else { + this.elem.nativeElement.insertAdjacentHTML('beforebegin', iconElement + ' '); + } + } + +} diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-form-control-container.component.html b/src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-form-control-container.component.html index 1a14469a2e0..3d96f4c08f8 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-form-control-container.component.html +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-form-control-container.component.html @@ -12,14 +12,14 @@ } -
    0)}">
    - @if (hasHint && (formBuilderService.hasArrayGroupValue(model) || (!model.repeatable && (isRelationship === false || value?.value === null)) || (model.repeatable === true && context?.index === context?.context?.groups?.length - 1)) && (!showErrorMessages || errorMessages.length === 0)) { + @if (hasHint && (formBuilderService.hasArrayGroupValue(model) || ((!model.repeatable && (!(model?.isModelOfNotRepeatableGroup) || model?.isModelOfNotRepeatableGroup && context?.index === context?.context?.groups?.length - 1)) && (isRelationship === false || value?.value === null)) || (model.repeatable === true && context?.index === context?.context?.groups?.length - 1)) && (!showErrorMessages || errorMessages.length === 0)) { } @@ -28,7 +28,7 @@
    } - @if (!model.hideErrorMessages && showErrorMessages) { + @if (!model.hideErrorMessages && showErrorMessages && (!(model?.isModelOfNotRepeatableGroup) || model?.isModelOfNotRepeatableGroup && context?.index === context?.context?.groups?.length - 1) && isNotRequiredGroupAndEmpty()) {
    @for (message of errorMessages; track message) { @@ -60,6 +60,17 @@
    } + @if (model.hasSecurityToggle) { +
    + @if (model.toggleSecurityVisibility) { + + + } +
    + } @if (isRelationship) {
    - - -
    - } -
    -
    - } - +
    @if (!chips) { @@ -76,9 +15,15 @@ @if (chips && chips.hasItems()) { + (selected)="onChipSelected($event)"> } +
    diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.component.spec.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.component.spec.ts index 86e9d970fb4..0a40950997b 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.component.spec.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.component.spec.ts @@ -2,6 +2,7 @@ import { ChangeDetectorRef, Component, CUSTOM_ELEMENTS_SCHEMA, + DebugElement, } from '@angular/core'; import { ComponentFixture, @@ -18,15 +19,19 @@ import { import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { FormRowModel } from '@dspace/core/config/models/config-submission-form.model'; -import { SubmissionFormsModel } from '@dspace/core/config/models/config-submission-forms.model'; import { APP_DATA_SERVICES_MAP } from '@dspace/core/data-services-map-type'; import { FormFieldModel } from '@dspace/core/shared/form/models/form-field.model'; import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; +import { MetadataSecurityConfigurationService } from '@dspace/core/submission/metadatasecurityconfig-data.service'; +import { Vocabulary } from '@dspace/core/submission/vocabularies/models/vocabulary.model'; import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; +import { SubmissionServiceStub } from '@dspace/core/testing/submission-service.stub'; import { createTestComponent } from '@dspace/core/testing/utils.test'; import { VocabularyServiceStub } from '@dspace/core/testing/vocabulary-service.stub'; +import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; import { XSRFService } from '@dspace/core/xsrf/xsrf.service'; import { + NgbModal, NgbModule, NgbTooltip, } from '@ng-bootstrap/ng-bootstrap'; @@ -38,7 +43,13 @@ import { import { provideMockActions } from '@ngrx/effects/testing'; import { provideMockStore } from '@ngrx/store/testing'; import { TranslateModule } from '@ngx-translate/core'; -import { Observable } from 'rxjs'; +import { MockComponent } from 'ng-mocks'; +import { + Observable, + of, +} from 'rxjs'; +import { ChipsComponent } from 'src/app/shared/form/chips/chips.component'; +import { ThemedLoadingComponent } from 'src/app/shared/loading/themed-loading.component'; import { environment } from '../../../../../../../environments/environment.test'; import { SubmissionService } from '../../../../../../submission/submission.service'; @@ -51,7 +62,6 @@ import { FormService } from '../../../../form.service'; import { FormBuilderService } from '../../../form-builder.service'; import { dsDynamicFormControlMapFn } from '../../ds-dynamic-form-control-map-fn'; import { DsDynamicTypeBindRelationService } from '../../ds-dynamic-type-bind-relation.service'; -import { DsDynamicInputModel } from '../ds-dynamic-input.model'; import { DsDynamicRelationGroupComponent } from './dynamic-relation-group.components'; import { DynamicRelationGroupModel, @@ -78,6 +88,49 @@ const initialState: any = { 'route': {}, }, }; + +const vocabulary: any = Object.assign(new Vocabulary(), { + id: 'types', + name: 'types', + scrollable: true, + hierarchical: false, + preloadLevel: 1, + entity: null, + externalSource: null, + type: 'vocabulary', + uuid: 'vocabulary-types', + _links: { + self: { + href: 'https://rest.api/rest/api/submission/vocabularies/types', + }, + entries: { + href: 'https://rest.api/rest/api/submission/vocabularies/types/entries', + }, + }, +}); + +const vocabularyExternal: any = Object.assign(new Vocabulary(), { + id: 'author', + name: 'author', + scrollable: true, + hierarchical: false, + preloadLevel: 1, + entity: 'test', + externalSource: { + 'dc.contributor.author': 'authorExternalSource', + }, + type: 'vocabulary', + uuid: 'vocabulary-author', + _links: { + self: { + href: 'https://rest.api/rest/api/submission/vocabularies/types', + }, + entries: { + href: 'https://rest.api/rest/api/submission/vocabularies/types/entries', + }, + }, +}); + function init() { FORM_GROUP_TEST_MODEL_CONFIG = { disabled: false, @@ -115,6 +168,7 @@ function init() { submissionId, id: 'dc_contributor_author', label: 'Authors', + isInlineGroup: false, mandatoryField: 'dc.contributor.author', name: 'dc.contributor.author', placeholder: 'Authors', @@ -127,6 +181,7 @@ function init() { repeatable: false, metadataFields: [], hasSelectableMetadata: false, + securityConfigLevel: [], } as DynamicRelationGroupModelConfig; FORM_GROUP_TEST_GROUP = new UntypedFormGroup({ @@ -140,13 +195,27 @@ describe('DsDynamicRelationGroupComponent test suite', () => { let groupComp: DsDynamicRelationGroupComponent; let testFixture: ComponentFixture; let groupFixture: ComponentFixture; + let debugElement: DebugElement; let vocabularyServiceStub: any; let modelValue: any; let html; - let control1: UntypedFormControl; - let model1: DsDynamicInputModel; - let control2: UntypedFormControl; - let model2: DsDynamicInputModel; + let submissionServiceStub: SubmissionServiceStub; + const vocabularyService: any = new VocabularyServiceStub(); + + const metadataSecurityConfiguration = { + 'uuid': 'test', + 'metadataSecurityDefault': [ + 0, + 1, + ], + 'metadataCustomSecurity': {}, + 'type': 'securitysetting', + '_links': { + 'self': { + 'href': 'http://localhost:8080/server/api/core/securitysettings/test', + }, + }, + }; // waitForAsync beforeEach beforeEach(waitForAsync(() => { @@ -163,6 +232,7 @@ describe('DsDynamicRelationGroupComponent test suite', () => { FormComponent, DsDynamicRelationGroupComponent, TestComponent, + MockComponent(ChipsComponent), ], providers: [ ChangeDetectorRef, @@ -172,12 +242,14 @@ describe('DsDynamicRelationGroupComponent test suite', () => { FormBuilderService, FormComponent, FormService, + MetadataSecurityConfigurationService, + NgbModal, provideMockStore({ initialState }), + { provide: VocabularyService, useValue: vocabularyService }, provideMockActions(() => new Observable()), - { provide: VocabularyService, useValue: vocabularyServiceStub }, { provide: DsDynamicTypeBindRelationService, useClass: DsDynamicTypeBindRelationService }, { provide: SubmissionObjectService, useValue: {} }, - { provide: SubmissionService, useValue: {} }, + { provide: SubmissionService, useClass: SubmissionServiceStub }, { provide: XSRFService, useValue: {} }, { provide: APP_CONFIG, useValue: environment }, { provide: APP_DATA_SERVICES_MAP, useValue: {} }, @@ -188,7 +260,10 @@ describe('DsDynamicRelationGroupComponent test suite', () => { }) .overrideComponent(DsDynamicRelationGroupComponent, { remove: { - imports: [FormComponent], + imports: [ + ThemedLoadingComponent, + FormComponent, + ], }, }) .compileComponents(); @@ -198,6 +273,7 @@ describe('DsDynamicRelationGroupComponent test suite', () => { describe('', () => { // synchronous beforeEach beforeEach(() => { + spyOn(vocabularyService, 'findVocabularyById').and.returnValue(createSuccessfulRemoteDataObject$(vocabulary)); html = ` { })); }); - describe('when init model value is empty', () => { - beforeEach(inject([FormBuilderService], (service: FormBuilderService) => { - groupFixture = TestBed.createComponent(DsDynamicRelationGroupComponent); - groupComp = groupFixture.componentInstance; // FormComponent test instance - groupComp.formId = 'testForm'; - groupComp.group = FORM_GROUP_TEST_GROUP; - groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); - groupFixture.detectChanges(); - control1 = service.getFormControlById('dc_contributor_author', (groupComp as any).formRef.formGroup, groupComp.formModel) as UntypedFormControl; - model1 = service.findById('dc_contributor_author', groupComp.formModel) as DsDynamicInputModel; - control2 = service.getFormControlById('local_contributor_affiliation', (groupComp as any).formRef.formGroup, groupComp.formModel) as UntypedFormControl; - model2 = service.findById('local_contributor_affiliation', groupComp.formModel) as DsDynamicInputModel; - - // spyOn(store, 'dispatch'); - })); - - afterEach(() => { - groupFixture.destroy(); - groupComp = null; + describe('when vocabulary has no external source option', () => { + beforeEach(() => { + spyOn(vocabularyService, 'findVocabularyById').and.returnValue(createSuccessfulRemoteDataObject$(vocabulary)); }); - it('should init component properly', inject([FormBuilderService], (service: FormBuilderService) => { - const formConfig = { rows: groupComp.model.formConfiguration } as SubmissionFormsModel; - const formModel = service.modelFromConfiguration(submissionId, formConfig, groupComp.model.scopeUUID, {}, groupComp.model.submissionScope, groupComp.model.readOnly); - const chips = new Chips([], 'value', 'dc.contributor.author'); - groupComp.formCollapsed.subscribe((value) => { - expect(value).toEqual(false); - }); - expect(groupComp.formModel.length).toEqual(formModel.length); - expect(groupComp.chips.getChipsItems()).toEqual(chips.getChipsItems()); - })); + describe('when init model value is empty', () => { - it('should save a new chips item', () => { - control1.setValue('test author'); - (model1 as any).value = new FormFieldMetadataValueObject('test author'); - control2.setValue('test affiliation'); - (model2 as any).value = new FormFieldMetadataValueObject('test affiliation'); - modelValue = [{ - 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), - 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), - }]; - groupFixture.detectChanges(); - - const buttons = groupFixture.debugElement.nativeElement.querySelectorAll('button'); - const btnEl = buttons[0]; - btnEl.click(); - - expect(groupComp.chips.getChipsItems()).toEqual(modelValue); - groupComp.formCollapsed.subscribe((value) => { - expect(value).toEqual(true); - }); - }); + beforeEach(inject([FormBuilderService], (service: FormBuilderService) => { + groupFixture = TestBed.createComponent(DsDynamicRelationGroupComponent); + debugElement = groupFixture.debugElement; + groupComp = groupFixture.componentInstance; // FormComponent test instance + submissionServiceStub = TestBed.inject(SubmissionService as any); + groupComp.group = FORM_GROUP_TEST_GROUP; + groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); + groupFixture.detectChanges(); - it('should clear form inputs', () => { - control1.setValue('test author'); - (model1 as any).value = new FormFieldMetadataValueObject('test author'); - control2.setValue('test affiliation'); - (model2 as any).value = new FormFieldMetadataValueObject('test affiliation'); + })); - groupFixture.detectChanges(); + afterEach(() => { + groupFixture.destroy(); + groupComp = null; + }); - const buttons = groupFixture.debugElement.nativeElement.querySelectorAll('button'); - const btnEl = buttons[2]; - btnEl.click(); + it('should init component properly', inject([FormBuilderService], (service: FormBuilderService) => { + const chips = new Chips([], 'value', 'dc.contributor.author'); + expect(groupComp.chips.getChipsItems()).toEqual(chips.getChipsItems()); + })); - expect(control1.value).toBeNull(); - expect(control2.value).toBeNull(); - groupComp.formCollapsed.subscribe((value) => { - expect(value).toEqual(false); - }); - }); - }); + it('should save a new chips item', () => { + submissionServiceStub.getSubmissionSecurityConfiguration.and.returnValue(of(metadataSecurityConfiguration)); + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; - describe('when init model value is not empty', () => { - beforeEach(() => { + const modalRef = groupComp.openModal(); + groupFixture.detectChanges(); - groupFixture = TestBed.createComponent(DsDynamicRelationGroupComponent); - groupComp = groupFixture.componentInstance; // FormComponent test instance - groupComp.formId = 'testForm'; - groupComp.group = FORM_GROUP_TEST_GROUP; - groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); - modelValue = [{ - 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), - 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), - }]; - groupComp.model.value = modelValue; - groupFixture.detectChanges(); + modalRef.componentInstance.add.emit(modelValue[0]); - }); + expect(groupComp.chips.getChipsItems()).toEqual(modelValue); - afterEach(() => { - groupFixture.destroy(); - groupComp = null; + }); }); - it('should init component properly', inject([FormBuilderService], (service: FormBuilderService) => { - const formConfig = { rows: groupComp.model.formConfiguration } as SubmissionFormsModel; - const formModel = service.modelFromConfiguration(submissionId, formConfig, groupComp.model.scopeUUID, {}, groupComp.model.submissionScope, groupComp.model.readOnly); - const chips = new Chips(modelValue, 'value', 'dc.contributor.author'); - groupComp.formCollapsed.subscribe((value) => { - expect(value).toEqual(true); + describe('when init model value is not empty', () => { + beforeEach(() => { + + groupFixture = TestBed.createComponent(DsDynamicRelationGroupComponent); + debugElement = groupFixture.debugElement; + groupComp = groupFixture.componentInstance; // FormComponent test instance + submissionServiceStub = TestBed.inject(SubmissionService as any); + groupComp.group = FORM_GROUP_TEST_GROUP; + groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + groupComp.model.value = modelValue; + groupFixture.detectChanges(); + }); - expect(groupComp.formModel.length).toEqual(formModel.length); - expect(groupComp.chips.getChipsItems()).toEqual(chips.getChipsItems()); - })); - it('should modify existing chips item', inject([FormBuilderService], (service: FormBuilderService) => { - groupComp.onChipSelected(0); - groupFixture.detectChanges(); + afterEach(() => { + groupFixture.destroy(); + groupComp = null; + }); - control1 = service.getFormControlById('dc_contributor_author', (groupComp as any).formRef.formGroup, groupComp.formModel) as UntypedFormControl; - model1 = service.findById('dc_contributor_author', groupComp.formModel) as DsDynamicInputModel; + it('should init component properly', inject([FormBuilderService], (service: FormBuilderService) => { + const chips = new Chips(modelValue, 'value', 'dc.contributor.author'); + expect(groupComp.chips.getChipsItems()).toEqual(chips.getChipsItems()); + })); - control1.setValue('test author modify'); - (model1 as any).value = new FormFieldMetadataValueObject('test author modify'); + it('should modify existing chips item', inject([FormBuilderService], (service: FormBuilderService) => { + submissionServiceStub.getSubmissionSecurityConfiguration.and.returnValue(of(metadataSecurityConfiguration)); + const modalRef = groupComp.onChipSelected(0); + groupFixture.detectChanges(); - modelValue = [{ - 'dc.contributor.author': new FormFieldMetadataValueObject('test author modify'), - 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), - }]; - groupFixture.detectChanges(); + expect(modalRef.componentInstance.editMode).toBe(true); + expect(modalRef.componentInstance.itemIndex).toBe(0); + expect(modalRef.componentInstance.item).toBe(groupComp.chips.getChipByIndex(0).item); - const buttons = groupFixture.debugElement.nativeElement.querySelectorAll('button'); - const btnEl = buttons[0]; - btnEl.click(); + spyOn(groupComp.chips, 'update').and.callThrough(); - groupFixture.detectChanges(); + const newItemValue = { + 'dc.contributor.author': 'test author modified', + 'local.contributor.affiliation': 'test affiliation', + }; + modalRef.componentInstance.edit.emit(newItemValue); - expect(groupComp.chips.getChipsItems()).toEqual(modelValue); - groupComp.formCollapsed.subscribe((value) => { - expect(value).toEqual(true); - }); - })); + groupFixture.detectChanges(); - it('should delete existing chips item', () => { - groupComp.onChipSelected(0); - groupFixture.detectChanges(); + expect(groupComp.chips.update).toHaveBeenCalledWith(groupComp.selectedChipItem.id, newItemValue); - const buttons = groupFixture.debugElement.nativeElement.querySelectorAll('button'); - const btnEl = buttons[1]; - btnEl.click(); + })); - expect(groupComp.chips.getChipsItems()).toEqual([]); - groupComp.formCollapsed.subscribe((value) => { - expect(value).toEqual(false); - }); }); }); + }); // declare a test component diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.components.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.components.ts index ecd733697c3..838c67767cc 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.components.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.components.ts @@ -1,40 +1,33 @@ -import { - AsyncPipe, - NgClass, -} from '@angular/common'; import { ChangeDetectorRef, Component, EventEmitter, - forwardRef, Input, OnDestroy, OnInit, Output, - ViewChild, } from '@angular/core'; import { UntypedFormGroup } from '@angular/forms'; import { SubmissionFormsModel } from '@dspace/core/config/models/config-submission-forms.model'; -import { PLACEHOLDER_PARENT_METADATA } from '@dspace/core/shared/form/ds-dynamic-form-constants'; import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; +import { Metadata } from '@dspace/core/shared/metadata.utils'; import { getFirstSucceededRemoteDataPayload } from '@dspace/core/shared/operators'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { VocabularyEntryDetail } from '@dspace/core/submission/vocabularies/models/vocabulary-entry-detail.model'; import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; import { hasValue, isEmpty, - isNotEmpty, - isNotNull, } from '@dspace/shared/utils/empty.util'; -import { hasOnlyEmptyProperties } from '@dspace/shared/utils/object.util'; -import { NgbTooltip } from '@ng-bootstrap/ng-bootstrap'; +import { + NgbModal, + NgbModalRef, +} from '@ng-bootstrap/ng-bootstrap'; import { DynamicFormControlComponent, DynamicFormControlModel, - DynamicFormGroupModel, DynamicFormLayoutService, DynamicFormValidationService, - DynamicInputModel, } from '@ng-dynamic-forms/core'; import { TranslateModule } from '@ngx-translate/core'; import isEqual from 'lodash/isEqual'; @@ -46,23 +39,27 @@ import { Subscription, } from 'rxjs'; import { + distinctUntilChanged, filter, map, mergeMap, scan, + startWith, + take, } from 'rxjs/operators'; import { environment } from '../../../../../../../environments/environment'; +import { SubmissionService } from '../../../../../../submission/submission.service'; import { shrinkInOut } from '../../../../../animations/shrink'; import { BtnDisabledDirective } from '../../../../../btn-disabled.directive'; import { ThemedLoadingComponent } from '../../../../../loading/themed-loading.component'; import { ChipsComponent } from '../../../../chips/chips.component'; import { Chips } from '../../../../chips/models/chips.model'; import { ChipsItem } from '../../../../chips/models/chips-item.model'; -import { FormComponent } from '../../../../form.component'; import { FormService } from '../../../../form.service'; import { FormBuilderService } from '../../../form-builder.service'; import { DynamicRelationGroupModel } from './dynamic-relation-group.model'; +import { DsDynamicRelationGroupModalComponent } from './modal/dynamic-relation-group-modal.components'; /** * Component representing a group input field @@ -73,12 +70,8 @@ import { DynamicRelationGroupModel } from './dynamic-relation-group.model'; templateUrl: './dynamic-relation-group.component.html', animations: [shrinkInOut], imports: [ - AsyncPipe, BtnDisabledDirective, ChipsComponent, - forwardRef(() => FormComponent), - NgbTooltip, - NgClass, ThemedLoadingComponent, TranslateModule, ], @@ -98,10 +91,10 @@ export class DsDynamicRelationGroupComponent extends DynamicFormControlComponent public formModel: DynamicFormControlModel[]; public editMode = false; - private selectedChipItem: ChipsItem; + public selectedChipItem: ChipsItem; + protected selectedChipItemIndex: number; private subs: Subscription[] = []; - - @ViewChild('formRef') private formRef: FormComponent; + private valueChangeSubscription: Subscription; constructor(private vocabularyService: VocabularyService, private formBuilderService: FormBuilderService, @@ -109,189 +102,112 @@ export class DsDynamicRelationGroupComponent extends DynamicFormControlComponent private cdr: ChangeDetectorRef, protected layoutService: DynamicFormLayoutService, protected validationService: DynamicFormValidationService, + protected modalService: NgbModal, + protected submissionService: SubmissionService, ) { super(layoutService, validationService); } ngOnInit() { - const config = { rows: this.model.formConfiguration } as SubmissionFormsModel; - if (!this.model.isEmpty()) { - this.formCollapsed = of(true); - } - this.model.valueChanges.subscribe((value: any[]) => { - if ((isNotEmpty(value) && !(value.length === 1 && hasOnlyEmptyProperties(value[0])))) { - this.collapseForm(); - } else { - this.expandForm(); - } + this.valueChangeSubscription = this.model.valueChanges.pipe( + startWith([]), + distinctUntilChanged((a,b) => JSON.stringify(a) === JSON.stringify(b)), + ).subscribe(() => { + this.initChipsFromModelValue(); }); - - this.formId = this.formService.getUniqueId(this.model.id); - this.formModel = this.formBuilderService.modelFromConfiguration( - this.model.submissionId, - config, - this.model.scopeUUID, - {}, - this.model.submissionScope, - this.model.readOnly); - this.initChipsFromModelValue(); } - isMandatoryFieldEmpty() { - let res = true; - this.formModel.forEach((row) => { - const modelRow = row as DynamicFormGroupModel; - modelRow.group.forEach((model: DynamicInputModel) => { - if (model.name === this.model.mandatoryField) { - res = model.value == null; - return; - } - }); - }); - return res; + ngOnDestroy(): void { + this.subs + .filter((sub) => hasValue(sub)) + .forEach((sub) => sub.unsubscribe()); + if (hasValue(this.valueChangeSubscription)) { + this.valueChangeSubscription.unsubscribe(); + } } onBlur(event) { this.blur.emit(); } - onChipSelected(event) { - this.expandForm(); - this.selectedChipItem = this.chips.getChipByIndex(event); - this.formModel.forEach((row) => { - const modelRow = row as DynamicFormGroupModel; - modelRow.group.forEach((model: DynamicInputModel) => { - const value = (this.selectedChipItem.item[model.name] === PLACEHOLDER_PARENT_METADATA - || this.selectedChipItem.item[model.name].value === PLACEHOLDER_PARENT_METADATA) - ? null - : this.selectedChipItem.item[model.name]; - - const nextValue = (this.formBuilderService.isInputModel(model) && isNotNull(value) && (typeof value !== 'string')) ? - value.value : value; - model.value = nextValue; - - }); - }); - - this.editMode = true; + onChipSelected(index: number): NgbModalRef { + this.selectedChipItem = this.chips.getChipByIndex(index); + this.selectedChipItemIndex = index; + return this.openModal(); } onFocus(event) { this.focus.emit(event); } - collapseForm() { - this.formCollapsed = of(true); - this.clear(); - } - - expandForm() { - this.formCollapsed = of(false); - } - - clear() { - if (this.editMode) { - this.selectedChipItem.editMode = false; - this.selectedChipItem = null; - this.editMode = false; - } - this.resetForm(); - if (!this.model.isEmpty()) { - this.formCollapsed = of(true); - } - } - - save() { - if (this.editMode) { - this.modifyChip(); - } else { - this.addToChips(); - } - } - - delete() { - this.chips.remove(this.selectedChipItem); - this.clear(); - } - - ngOnDestroy(): void { - this.subs - .filter((sub) => hasValue(sub)) - .forEach((sub) => sub.unsubscribe()); - } - - private addToChips() { - if (!this.formRef.formGroup.valid) { - this.formService.validateAllFormFields(this.formRef.formGroup); - return; - } - - // Item to add - if (!this.isMandatoryFieldEmpty()) { - const item = this.buildChipItem(); + openModal(): NgbModalRef { + const modalRef = this.modalService.open(DsDynamicRelationGroupModalComponent, { + size: 'lg', + }); + this.submissionService.getSubmissionSecurityConfiguration(this.model.submissionId).pipe( + take(1)).subscribe((res: MetadataSecurityConfiguration) => { + modalRef.componentInstance.metadataSecurityConfiguration = res; + }); + modalRef.componentInstance.group = this.group; + modalRef.componentInstance.model = this.model; + + modalRef.componentInstance.editMode = !!this.selectedChipItem; + modalRef.componentInstance.itemIndex = this.selectedChipItemIndex; + modalRef.componentInstance.item = this.selectedChipItem?.item; + modalRef.componentInstance.changedSecurity = false; + modalRef.componentInstance.edit.pipe(take(1)).subscribe((item) => { + this.chips.triggerUpdate = modalRef.componentInstance.changedSecurity; + this.chips.update(this.selectedChipItem.id, item); + }); + modalRef.componentInstance.add.pipe(take(1)).subscribe((item) => { this.chips.add(item); - - this.resetForm(); - } - } - - private modifyChip() { - if (!this.formRef.formGroup.valid) { - this.formService.validateAllFormFields(this.formRef.formGroup); - return; + }); + if (hasValue(this.valueChangeSubscription)) { + this.valueChangeSubscription.unsubscribe(); } + modalRef.result.then(() => { + // close + this.handleModalResult(); + }, () => { + // dismiss + this.handleModalResult(); + }); - if (!this.isMandatoryFieldEmpty()) { - const item = this.buildChipItem(); - this.chips.update(this.selectedChipItem.id, item); - this.resetForm(); - this.cdr.detectChanges(); - } + return modalRef; } - private buildChipItem() { - const item = Object.create({}); - this.formModel.forEach((row) => { - const modelRow = row as DynamicFormGroupModel; - modelRow.group.forEach((control: DynamicInputModel) => { - item[control.name] = control.value || PLACEHOLDER_PARENT_METADATA; - }); + private handleModalResult(): void { + this.selectedChipItemIndex = null; + this.selectedChipItem = null; + if (this.valueChangeSubscription) { + this.valueChangeSubscription.unsubscribe(); + } + this.valueChangeSubscription = this.model.valueChanges.pipe( + distinctUntilChanged((a,b) => JSON.stringify(a) === JSON.stringify(b)), + ).subscribe(() => { + this.initChipsFromModelValue(); }); - return item; } private initChipsFromModelValue() { - let initChipsValue$: Observable; if (this.model.isEmpty()) { this.initChips([]); } else { - initChipsValue$ = of(this.model.value as any[]); - + initChipsValue$ = of(this.model.getGroupValue() as any[]); // If authority this.subs.push(initChipsValue$.pipe( mergeMap((valueModel) => { const returnList: Observable[] = []; valueModel.forEach((valueObj) => { + const returnObj = Object.keys(valueObj).map((fieldName) => { let return$: Observable; - if (isObject(valueObj[fieldName]) && (valueObj[fieldName] as any).hasAuthority() && isNotEmpty((valueObj[fieldName] as any).authority)) { - const fieldId = fieldName.replace(/\./g, '_'); - const model = this.formBuilderService.findById(fieldId, this.formModel); - return$ = this.vocabularyService.findEntryDetailById( - (valueObj[fieldName] as any).authority, - (model as any).vocabularyOptions.name, - ).pipe( - getFirstSucceededRemoteDataPayload(), - map((entryDetail: VocabularyEntryDetail) => Object.assign( - new FormFieldMetadataValueObject(), - valueObj[fieldName], - { - otherInformation: entryDetail.otherInformation, - }), - )); + const field = valueObj[fieldName] as FormFieldMetadataValueObject; + if (isObject(field) && this.hasValidAuthority(field) && field.otherInformation === null) { + return$ = this.getVocabulary(valueObj, fieldName); } else { - return$ = of(valueObj[fieldName]); + return$ = of(field); } return return$.pipe(map((entry) => ({ [fieldName]: entry }))); }); @@ -318,8 +234,8 @@ export class DsDynamicRelationGroupComponent extends DynamicFormControlComponent } return acc; }, []), - filter((modelValues: any[]) => (this.model.value as any[]).length === modelValues.length), - ).subscribe((modelValue) => { + filter((modelValues: any[]) => this.model.getGroupValue().length === modelValues.length), + ).pipe(distinctUntilChanged((a,b) => JSON.stringify(a) === JSON.stringify(b))).subscribe((modelValue) => { this.model.value = modelValue; this.initChips(modelValue); this.cdr.markForCheck(); @@ -343,15 +259,48 @@ export class DsDynamicRelationGroupComponent extends DynamicFormControlComponent this.model.value = items; this.change.emit(); } + } else { + if (this.chips.triggerUpdate) { + this.change.emit(); + this.chips.triggerUpdate = false; + } } }), ); } - private resetForm() { - if (this.formRef) { - this.formService.resetForm(this.formRef.formGroup, this.formModel, this.formId); + private getVocabulary(valueObj, fieldName): Observable { + const config = { rows: this.model.formConfiguration } as SubmissionFormsModel; + const formModel = this.formBuilderService.modelFromConfiguration( + this.model.submissionId, + config, + this.model.scopeUUID, + {}, // @Input model.value + this.model.submissionScope, + this.model.readOnly, + null, + true); + const fieldId = fieldName.replace(/\./g, '_'); + const model = this.formBuilderService.findById(fieldId, formModel); + if ((model as any)?.vocabularyOptions?.name) { + return this.vocabularyService.findEntryDetailById( + valueObj[fieldName].authority, + (model as any).vocabularyOptions.name, + ).pipe( + getFirstSucceededRemoteDataPayload(), + map((entryDetail: VocabularyEntryDetail) => Object.assign( + new FormFieldMetadataValueObject(), + valueObj[fieldName], + { + otherInformation: entryDetail.otherInformation, + }), + )); + } else { + return of(valueObj[fieldName]); } } + private hasValidAuthority(formMetadataValue: FormFieldMetadataValueObject) { + return Metadata.hasValidAuthority(formMetadataValue?.authority); + } } diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.model.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.model.ts index a61c27f5405..7d335706bed 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.model.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.model.ts @@ -1,6 +1,9 @@ import { FormRowModel } from '@dspace/core/config/models/config-submission-form.model'; import { DYNAMIC_FORM_CONTROL_TYPE_RELATION_GROUP } from '@dspace/core/shared/form/ds-dynamic-form-constants'; +import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; +import { VocabularyEntry } from '@dspace/core/submission/vocabularies/models/vocabulary-entry.model'; import { + hasValue, isEmpty, isNull, } from '@dspace/shared/utils/empty.util'; @@ -20,6 +23,7 @@ import { export interface DynamicRelationGroupModelConfig extends DsDynamicInputModelConfig { submissionId: string; formConfiguration: FormRowModel[]; + isInlineGroup: boolean; mandatoryField: string; relationFields: string[]; scopeUUID: string; @@ -32,6 +36,7 @@ export interface DynamicRelationGroupModelConfig extends DsDynamicInputModelConf export class DynamicRelationGroupModel extends DsDynamicInputModel { @serializable() submissionId: string; @serializable() formConfiguration: FormRowModel[]; + @serializable() isInlineGroup: boolean; @serializable() mandatoryField: string; @serializable() relationFields: string[]; @serializable() scopeUUID: string; @@ -47,8 +52,8 @@ export class DynamicRelationGroupModel extends DsDynamicInputModel { this.relationFields = config.relationFields; this.scopeUUID = config.scopeUUID; this.submissionScope = config.submissionScope; - const value = config.value || []; - this.value = value; + this.isInlineGroup = config.isInlineGroup; + this.value = config.value || []; } /* get value() { @@ -60,8 +65,8 @@ export class DynamicRelationGroupModel extends DsDynamicInputModel { return (value.length === 1 && isNull(value[0][this.mandatoryField])); } - getGroupValue(): any[] { - if (isEmpty(this.value)) { + getGroupValue(value?: any): any[] { + if (isEmpty(this.value) && isEmpty(value)) { // If items is empty, last element has been removed // so emit an empty value that allows to dispatch // a remove JSON PATCH operation @@ -72,6 +77,17 @@ export class DynamicRelationGroupModel extends DsDynamicInputModel { emptyItem[field] = null; }); return [emptyItem]; + } else if ((this.value instanceof VocabularyEntry || this.value instanceof FormFieldMetadataValueObject) || + (hasValue(value) && (value instanceof VocabularyEntry || value instanceof FormFieldMetadataValueObject))) { + + const emptyItem = {}; + emptyItem[this.mandatoryField] = hasValue(value) && (value instanceof VocabularyEntry || value instanceof FormFieldMetadataValueObject) ? value : this.value; + this.relationFields + .forEach((field) => { + emptyItem[field] = hasValue((this.value as any).otherInformation) ? (this.value as any).otherInformation[field] : null; + }); + + return [emptyItem]; } return this.value as any[]; } diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.component.html b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.component.html new file mode 100644 index 00000000000..3a228face5d --- /dev/null +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.component.html @@ -0,0 +1,45 @@ +
    +
    +
    {{ getHeader() }}
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    +
    + + @if (!model.readOnly) { + + } +
    +
    +
    diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.component.spec.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.component.spec.ts new file mode 100644 index 00000000000..1b957363cfb --- /dev/null +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.component.spec.ts @@ -0,0 +1,493 @@ +// Load the implementations that should be tested +import { + ChangeDetectorRef, + CUSTOM_ELEMENTS_SCHEMA, + DebugElement, +} from '@angular/core'; +import { + ComponentFixture, + inject, + TestBed, + waitForAsync, +} from '@angular/core/testing'; +import { + FormsModule, + ReactiveFormsModule, + UntypedFormControl, + UntypedFormGroup, +} from '@angular/forms'; +import { By } from '@angular/platform-browser'; +import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; +import { FormRowModel } from '@dspace/core/config/models/config-submission-form.model'; +import { SubmissionFormsModel } from '@dspace/core/config/models/config-submission-forms.model'; +import { APP_DATA_SERVICES_MAP } from '@dspace/core/data-services-map-type'; +import { FormFieldModel } from '@dspace/core/shared/form/models/form-field.model'; +import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; +import { SubmissionScopeType } from '@dspace/core/submission/submission-scope-type'; +import { Vocabulary } from '@dspace/core/submission/vocabularies/models/vocabulary.model'; +import { VocabularyEntryDetail } from '@dspace/core/submission/vocabularies/models/vocabulary-entry-detail.model'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; +import { StoreMock } from '@dspace/core/testing/store.mock'; +import { SubmissionServiceStub } from '@dspace/core/testing/submission-service.stub'; +import { VocabularyServiceStub } from '@dspace/core/testing/vocabulary-service.stub'; +import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; +import { + NgbActiveModal, + NgbModal, + NgbModule, +} from '@ng-bootstrap/ng-bootstrap'; +import { + DynamicFormLayoutService, + DynamicFormValidationService, +} from '@ng-dynamic-forms/core'; +import { + Store, + StoreModule, +} from '@ngrx/store'; +import { TranslateModule } from '@ngx-translate/core'; + +import { storeModuleConfig } from '../../../../../../../app.reducer'; +import { SubmissionService } from '../../../../../../../submission/submission.service'; +import { Chips } from '../../../../../chips/models/chips.model'; +import { FormComponent } from '../../../../../form.component'; +import { FormService } from '../../../../../form.service'; +import { FormBuilderService } from '../../../../form-builder.service'; +import { DsDynamicInputModel } from '../../ds-dynamic-input.model'; +import { DsDynamicRelationGroupComponent } from '../dynamic-relation-group.components'; +import { + DynamicRelationGroupModel, + DynamicRelationGroupModelConfig, +} from '../dynamic-relation-group.model'; +import { DsDynamicRelationGroupModalComponent } from './dynamic-relation-group-modal.components'; + +export let FORM_GROUP_TEST_MODEL_CONFIG; + +export let FORM_GROUP_TEST_GROUP; + +const submissionId = '1234'; + +const vocabulary: any = Object.assign(new Vocabulary(), { + id: 'types', + name: 'types', + scrollable: true, + hierarchical: false, + preloadLevel: 1, + entity: null, + externalSource: null, + type: 'vocabulary', + uuid: 'vocabulary-types', + _links: { + self: { + href: 'https://rest.api/rest/api/submission/vocabularies/types', + }, + entries: { + href: 'https://rest.api/rest/api/submission/vocabularies/types/entries', + }, + }, +}); + +const vocabularyExternal: any = Object.assign(new Vocabulary(), { + id: 'author', + name: 'author', + scrollable: true, + hierarchical: false, + preloadLevel: 1, + entity: 'test', + externalSource: { + 'dc.contributor.author': 'authorExternalSource', + }, + type: 'vocabulary', + uuid: 'vocabulary-author', + _links: { + self: { + href: 'https://rest.api/rest/api/submission/vocabularies/types', + }, + entries: { + href: 'https://rest.api/rest/api/submission/vocabularies/types/entries', + }, + }, +}); + +function init() { + FORM_GROUP_TEST_MODEL_CONFIG = { + disabled: false, + errorMessages: { required: 'You must specify at least one author.' }, + formConfiguration: [{ + fields: [{ + hints: 'Enter the name of the author.', + input: { type: 'onebox' }, + label: 'Author', + languageCodes: [], + mandatory: 'true', + mandatoryMessage: 'Required field!', + repeatable: false, + selectableMetadata: [{ + controlledVocabulary: 'RPAuthority', + closed: false, + metadata: 'dc.contributor.author', + }], + } as FormFieldModel], + } as FormRowModel, { + fields: [{ + hints: 'Enter the affiliation of the author.', + input: { type: 'onebox' }, + label: 'Affiliation', + languageCodes: [], + mandatory: 'false', + repeatable: false, + selectableMetadata: [{ + controlledVocabulary: 'OUAuthority', + closed: false, + metadata: 'local.contributor.affiliation', + }], + } as FormFieldModel], + } as FormRowModel], + submissionId, + id: 'dc_contributor_author', + label: 'Authors', + isInlineGroup: false, + mandatoryField: 'dc.contributor.author', + name: 'dc.contributor.author', + placeholder: 'Authors', + readOnly: false, + relationFields: ['local.contributor.affiliation'], + required: true, + scopeUUID: '43fe1f8c-09a6-4fcf-9c78-5d4fed8f2c8f', + submissionScope: undefined, + validators: { required: null }, + repeatable: false, + metadataFields: [], + hasSelectableMetadata: false, + } as DynamicRelationGroupModelConfig; + + FORM_GROUP_TEST_GROUP = new UntypedFormGroup({ + dc_contributor_author: new UntypedFormControl(), + }); + +} + +describe('DsDynamicRelationGroupModelComponent test suite', () => { + + let componentFixture: ComponentFixture; + let testComponent: DsDynamicRelationGroupModalComponent; + let groupComp: DsDynamicRelationGroupComponent; + let groupFixture: ComponentFixture; + let debugElement: DebugElement; + let modelValue: any; + let control1: UntypedFormControl; + let model1: DsDynamicInputModel; + let control2: UntypedFormControl; + let model2: DsDynamicInputModel; + const modal = jasmine.createSpyObj('modal', ['close', 'dismiss']); + + + const vocabularyService: any = new VocabularyServiceStub(); + + // waitForAsync beforeEach + beforeEach(waitForAsync(() => { + init(); + + /* TODO make sure these files use mocks instead of real services/components https://github.com/DSpace/dspace-angular/issues/281 */ + TestBed.configureTestingModule({ + imports: [ + BrowserAnimationsModule, + FormsModule, + ReactiveFormsModule, + NgbModule, + StoreModule.forRoot({}, storeModuleConfig), + TranslateModule.forRoot(), + FormComponent, + DsDynamicRelationGroupModalComponent, + ], // declare the test component + providers: [ + ChangeDetectorRef, + DynamicFormValidationService, + DynamicFormLayoutService, + FormBuilderService, + FormComponent, + FormService, + NgbModal, + { provide: VocabularyService, useValue: vocabularyService }, + { provide: Store, useClass: StoreMock }, + { provide: SubmissionService, useClass: SubmissionServiceStub }, + { provide: NgbActiveModal, useValue: modal }, + { provide: APP_DATA_SERVICES_MAP, useValue: {} }, + ], + schemas: [CUSTOM_ELEMENTS_SCHEMA], + }); + + })); + + describe('', () => { + // synchronous beforeEach + beforeEach(() => { + spyOn(vocabularyService, 'findVocabularyById').and.returnValue(createSuccessfulRemoteDataObject$(vocabulary)); + componentFixture = TestBed.createComponent(DsDynamicRelationGroupModalComponent); + testComponent = componentFixture.componentInstance; + }); + + afterEach(() => { + componentFixture.destroy(); + testComponent = null; + }); + + it('should create DsDynamicRelationGroupModelComponent', () => { + expect(testComponent).toBeDefined(); + }); + }); + + xdescribe('when vocabulary has no external source option', () => { + beforeEach(() => { + spyOn(vocabularyService, 'findVocabularyById').and.returnValue(createSuccessfulRemoteDataObject$(vocabulary)); + }); + + describe('when init model value is empty', () => { + beforeEach(inject([FormBuilderService], (service: FormBuilderService) => { + + + componentFixture = TestBed.createComponent(DsDynamicRelationGroupModalComponent); + testComponent = componentFixture.componentInstance; + + // groupFixture = TestBed.createComponent(DsDynamicRelationGroupComponent); + debugElement = componentFixture.debugElement; + // groupComp = groupFixture.componentInstance; // FormComponent test instance + // groupComp.formId = 'testForm'; + testComponent.group = FORM_GROUP_TEST_GROUP; + testComponent.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); + componentFixture.detectChanges(); + control1 = service.getFormControlById('dc_contributor_author', (testComponent as any).formRef.formGroup, testComponent.formModel) as UntypedFormControl; + model1 = service.findById('dc_contributor_author', testComponent.formModel) as DsDynamicInputModel; + control2 = service.getFormControlById('local_contributor_affiliation', (testComponent as any).formRef.formGroup, testComponent.formModel) as UntypedFormControl; + model2 = service.findById('local_contributor_affiliation', testComponent.formModel) as DsDynamicInputModel; + + // spyOn(store, 'dispatch'); + })); + + afterEach(() => { + groupFixture.destroy(); + testComponent = null; + }); + + it('should init component properly', inject([FormBuilderService], (service: FormBuilderService) => { + const testElement = debugElement.query(By.css('i.fa-share-square')); + const formConfig = { rows: groupComp.model.formConfiguration } as SubmissionFormsModel; + const formModel = service.modelFromConfiguration(submissionId, formConfig, testComponent.model.scopeUUID, {}, testComponent.model.submissionScope, testComponent.model.readOnly); + const chips = new Chips([], 'value', 'dc.contributor.author'); + // groupComp.formCollapsed.subscribe((value) => { + // expect(value).toEqual(false); + // }); + expect(testComponent.formModel.length).toEqual(formModel.length); + expect(groupComp.chips.getChipsItems()).toEqual(chips.getChipsItems()); + expect(testElement).toBeNull(); + })); + + it('should save a new chips item', () => { + control1.setValue('test author'); + (model1 as any).value = new FormFieldMetadataValueObject('test author'); + control2.setValue('test affiliation'); + (model2 as any).value = new FormFieldMetadataValueObject('test affiliation'); + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + groupFixture.detectChanges(); + + const buttons = groupFixture.debugElement.nativeElement.querySelectorAll('button'); + const btnEl = buttons[0]; + btnEl.click(); + + expect(groupComp.chips.getChipsItems()).toEqual(modelValue); + // groupComp.formCollapsed.subscribe((value) => { + // expect(value).toEqual(true); + // }); + }); + + it('should clear form inputs', () => { + control1.setValue('test author'); + (model1 as any).value = new FormFieldMetadataValueObject('test author'); + control2.setValue('test affiliation'); + (model2 as any).value = new FormFieldMetadataValueObject('test affiliation'); + + groupFixture.detectChanges(); + + const buttons = groupFixture.debugElement.nativeElement.querySelectorAll('button'); + const btnEl = buttons[2]; + btnEl.click(); + + expect(control1.value).toBeNull(); + expect(control2.value).toBeNull(); + // groupComp.formCollapsed.subscribe((value) => { + // expect(value).toEqual(false); + // }); + }); + }); + + describe('when init model value is not empty', () => { + beforeEach(() => { + + groupFixture = TestBed.createComponent(DsDynamicRelationGroupComponent); + debugElement = groupFixture.debugElement; + groupComp = groupFixture.componentInstance; // FormComponent test instance + // groupComp.formId = 'testForm'; + groupComp.group = FORM_GROUP_TEST_GROUP; + groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + groupComp.model.value = modelValue; + groupFixture.detectChanges(); + + }); + + afterEach(() => { + groupFixture.destroy(); + groupComp = null; + }); + + it('should init component properly', inject([FormBuilderService], (service: FormBuilderService) => { + const formConfig = { rows: groupComp.model.formConfiguration } as SubmissionFormsModel; + const formModel = service.modelFromConfiguration(submissionId, formConfig, groupComp.model.scopeUUID, {}, groupComp.model.submissionScope, groupComp.model.readOnly); + const chips = new Chips(modelValue, 'value', 'dc.contributor.author'); + // groupComp.formCollapsed.subscribe((value) => { + // expect(value).toEqual(true); + // }); + // expect(groupComp.formModel.length).toEqual(formModel.length); + expect(groupComp.chips.getChipsItems()).toEqual(chips.getChipsItems()); + })); + + it('should modify existing chips item', inject([FormBuilderService], (service: FormBuilderService) => { + groupComp.onChipSelected(0); + groupFixture.detectChanges(); + + // control1 = service.getFormControlById('dc_contributor_author', (groupComp as any).formRef.formGroup, groupComp.formModel) as FormControl; + // model1 = service.findById('dc_contributor_author', groupComp.formModel) as DsDynamicInputModel; + + control1.setValue('test author modify'); + (model1 as any).value = new FormFieldMetadataValueObject('test author modify'); + + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author modify'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + groupFixture.detectChanges(); + + const buttons = groupFixture.debugElement.nativeElement.querySelectorAll('button'); + const btnEl = buttons[0]; + btnEl.click(); + + groupFixture.detectChanges(); + + expect(groupComp.chips.getChipsItems()).toEqual(modelValue); + // groupComp.formCollapsed.subscribe((value) => { + // expect(value).toEqual(true); + // }); + })); + + it('should delete existing chips item', () => { + groupComp.onChipSelected(0); + groupFixture.detectChanges(); + + const buttons = groupFixture.debugElement.nativeElement.querySelectorAll('button'); + const btnEl = buttons[1]; + btnEl.click(); + + expect(groupComp.chips.getChipsItems()).toEqual([]); + // groupComp.formCollapsed.subscribe((value) => { + // expect(value).toEqual(false); + // }); + }); + }); + }); + + xdescribe('when vocabulary has an external source option', () => { + beforeEach(() => { + spyOn(vocabularyService, 'findVocabularyById').and.returnValue(createSuccessfulRemoteDataObject$(vocabularyExternal)); + groupFixture = TestBed.createComponent(DsDynamicRelationGroupComponent); + debugElement = groupFixture.debugElement; + groupComp = groupFixture.componentInstance; // FormComponent test instance + // groupComp.formId = 'testForm'; + groupComp.group = FORM_GROUP_TEST_GROUP; + groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + groupComp.model.value = modelValue; + }); + + afterEach(() => { + groupFixture.destroy(); + groupComp = null; + }); + + describe('and submission scope is workspaceitem', () => { + beforeEach(() => { + groupComp.model.submissionScope = SubmissionScopeType.WorkspaceItem; + groupFixture.detectChanges(); + groupComp.onChipSelected(0); + groupFixture.detectChanges(); + }); + + it('should not display external source button', inject([FormBuilderService], (service: FormBuilderService) => { + const testElement = debugElement.query(By.css('i.fa-share-square')); + expect(testElement).toBeNull(); + })); + }); + + describe('and submission scope is workflowitem', () => { + beforeEach(() => { + groupComp.model.submissionScope = SubmissionScopeType.WorkflowItem; + groupFixture.detectChanges(); + groupComp.onChipSelected(0); + groupFixture.detectChanges(); + }); + + it('should display external source button', inject([FormBuilderService], (service: FormBuilderService) => { + const testElement = debugElement.query(By.css('i.fa-share-square')); + expect(testElement).not.toBeNull(); + expect(testElement.parent.nativeElement.disabled).toBeFalsy(); + })); + }); + }); + + xdescribe('when init model value has authority and submission scope is workflowitem', () => { + beforeEach(() => { + const entryValue = Object.assign(new VocabularyEntryDetail(), { + value: 'test author', + dispaly: 'test author', + authority: 'authorityTest', + }); + spyOn(vocabularyService, 'findVocabularyById').and.returnValue(createSuccessfulRemoteDataObject$(vocabularyExternal)); + spyOn(vocabularyService, 'findEntryDetailById').and.returnValue(createSuccessfulRemoteDataObject$(entryValue)); + groupFixture = TestBed.createComponent(DsDynamicRelationGroupComponent); + debugElement = groupFixture.debugElement; + groupComp = groupFixture.componentInstance; // FormComponent test instance + // groupComp.formId = 'testForm'; + groupComp.group = FORM_GROUP_TEST_GROUP; + groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); + groupComp.model.submissionScope = SubmissionScopeType.WorkflowItem; + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author', null, null, 'authorityTest'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + groupComp.model.value = modelValue; + groupFixture.detectChanges(); + groupComp.onChipSelected(0); + groupFixture.detectChanges(); + + }); + + afterEach(() => { + groupFixture.destroy(); + groupComp = null; + }); + + it('should display external source button', inject([FormBuilderService], (service: FormBuilderService) => { + const testElement = debugElement.query(By.css('i.fa-share-square')); + expect(testElement).not.toBeNull(); + expect(testElement.parent.nativeElement.disabled).toBeTruthy(); + })); + + }); +}); diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.components.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.components.ts new file mode 100644 index 00000000000..412fb64e974 --- /dev/null +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-group/modal/dynamic-relation-group-modal.components.ts @@ -0,0 +1,345 @@ +import { NgClass } from '@angular/common'; +import { + ChangeDetectorRef, + Component, + EventEmitter, + Input, + OnDestroy, + OnInit, + Output, + ViewChild, +} from '@angular/core'; +import { FormGroup } from '@angular/forms'; +import { SubmissionFormsModel } from '@dspace/core/config/models/config-submission-forms.model'; +import { PLACEHOLDER_PARENT_METADATA } from '@dspace/core/shared/form/ds-dynamic-form-constants'; +import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; +import { getFirstSucceededRemoteDataPayload } from '@dspace/core/shared/operators'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; +import { Vocabulary } from '@dspace/core/submission/vocabularies/models/vocabulary.model'; +import { VocabularyEntry } from '@dspace/core/submission/vocabularies/models/vocabulary-entry.model'; +import { VocabularyOptions } from '@dspace/core/submission/vocabularies/models/vocabulary-options.model'; +import { VocabularyService } from '@dspace/core/submission/vocabularies/vocabulary.service'; +import { + hasValue, + isNotEmpty, + isNotNull, +} from '@dspace/shared/utils/empty.util'; +import { + NgbActiveModal, + NgbModal, +} from '@ng-bootstrap/ng-bootstrap'; +import { + DynamicFormControlComponent, + DynamicFormControlModel, + DynamicFormGroupModel, + DynamicFormLayoutService, + DynamicFormValidationService, + DynamicInputModel, +} from '@ng-dynamic-forms/core'; +import { TranslateModule } from '@ngx-translate/core'; +import { + Observable, + Subscription, +} from 'rxjs'; +import { distinctUntilChanged } from 'rxjs/operators'; +import { BtnDisabledDirective } from 'src/app/shared/btn-disabled.directive'; + +import { SubmissionService } from '../../../../../../../submission/submission.service'; +import { shrinkInOut } from '../../../../../../animations/shrink'; +import { FormComponent } from '../../../../../form.component'; +import { FormService } from '../../../../../form.service'; +import { FormBuilderService } from '../../../../form-builder.service'; +import { DsDynamicInputModel } from '../../ds-dynamic-input.model'; +import { DynamicRelationGroupModel } from '../dynamic-relation-group.model'; + +/** + * Component representing a group input field + */ +@Component({ + selector: 'ds-dynamic-relation-group-modal', + styleUrls: ['../dynamic-relation-group.component.scss'], + templateUrl: './dynamic-relation-group-modal.component.html', + animations: [shrinkInOut], + imports: [ + BtnDisabledDirective, + FormComponent, + NgClass, + TranslateModule, + ], +}) +export class DsDynamicRelationGroupModalComponent extends DynamicFormControlComponent implements OnDestroy, OnInit { + + @Input() formId: string; + @Input() group: FormGroup; + @Input() model: DynamicRelationGroupModel; + + @Input() item: any; + @Input() itemIndex: number; + @Input() changedSecurity: boolean; + @Input() metadataSecurityConfiguration: MetadataSecurityConfiguration; + + @Input() value: any; + + @Output() blur: EventEmitter = new EventEmitter(); + @Output() change: EventEmitter = new EventEmitter(); + @Output() focus: EventEmitter = new EventEmitter(); + + @Output() edit: EventEmitter = new EventEmitter(); + @Output() add: EventEmitter = new EventEmitter(); + + @ViewChild('formRef', { static: false }) private formRef: FormComponent; + + public formModel: DynamicFormControlModel[]; + public vocabulary$: Observable; + public securityLevelParent: number; + + private subs: Subscription[] = []; + + + constructor(private vocabularyService: VocabularyService, + private formBuilderService: FormBuilderService, + private formService: FormService, + private cdr: ChangeDetectorRef, + protected layoutService: DynamicFormLayoutService, + protected validationService: DynamicFormValidationService, + protected modalService: NgbModal, + protected submissionService: SubmissionService, + private activeModal: NgbActiveModal, + ) { + super(layoutService, validationService); + } + + ngOnInit() { + const config = { rows: this.model.formConfiguration } as SubmissionFormsModel; + this.formId = this.formService.getUniqueId(this.model.id); + this.formModel = this.formBuilderService.modelFromConfiguration( + this.model.submissionId, + config, + this.model.scopeUUID, + {}, + this.model.submissionScope, + this.model.readOnly, + null, + true, + this.metadataSecurityConfiguration); + this.formBuilderService.addFormModel(this.formId, this.formModel); + if (this.item) { + this.formModel.forEach((row) => { + const modelRow = row as DynamicFormGroupModel; + modelRow.group.forEach((model: DsDynamicInputModel) => { + const value = (this.item[model.name] === PLACEHOLDER_PARENT_METADATA + || this.item[model.name].value === PLACEHOLDER_PARENT_METADATA) + ? null + : this.item[model.name]; + const nextValue = (this.formBuilderService.isInputModel(model) && isNotNull(value) && (typeof value !== 'string')) ? + value.value : value; + if (isNotEmpty(nextValue)) { + model.value = nextValue; + if (isNotEmpty(nextValue?.language)) { + model.language = nextValue.language; + } + } + + this.initSecurityLevelConfig(model, modelRow); + }); + }); + } + const mandatoryFieldModel = this.getMandatoryFieldModel(); // @Input + if (mandatoryFieldModel.vocabularyOptions && isNotEmpty(mandatoryFieldModel.vocabularyOptions.name)) { + this.retrieveVocabulary(mandatoryFieldModel.vocabularyOptions); + } + + } + + getHeader() { + return this.getMandatoryFieldModel().label; + } + + isMandatoryFieldEmpty() { + const models = this.getMandatoryFields(); + return models.some(model => !model.value); + } + + hasMandatoryFieldAuthority() { + const model = this.getMandatoryFieldModel(); + return hasValue(model.value) + && typeof model.value === 'object' + && (model.value as any).hasAuthority(); + } + + onBlur(event) { + this.blur.emit(); + } + + onFocus(event) { + this.focus.emit(event); + } + + save() { + if (this.item) { + this.modifyChip(); + } else { + this.addToChips(); + } + this.closeModal(); + } + + + canImport() { + return !this.isMandatoryFieldEmpty() && this.item && !this.hasMandatoryFieldAuthority(); + } + + closeModal() { + this.activeModal.close(); + } + + + /** + * Update the model authority value. + * @param authority + */ + updateAuthority(authority: string) { + const model = this.getMandatoryFieldModel(); + const currentValue: string = (model.value instanceof FormFieldMetadataValueObject + || model.value instanceof VocabularyEntry) ? model.value.value : model.value; + const currentLang: string = (model.value instanceof FormFieldMetadataValueObject) ? model.value.language : model.language; + let security = null; + if (this.model.value instanceof VocabularyEntry) { + security = this.model.value.securityLevel; + } else { + if (this.model.metadataValue) { + security = this.model.metadataValue.securityLevel; + } + } + const valueWithAuthority: any = new FormFieldMetadataValueObject(currentValue, currentLang, security, authority); + model.value = valueWithAuthority; + this.modifyChip(); + setTimeout(() => { + this.submissionService.dispatchSave(this.model.submissionId); + }, 100); + } + + ngOnDestroy(): void { + this.subs + .filter((sub) => hasValue(sub)) + .forEach((sub) => sub.unsubscribe()); + this.formBuilderService.removeFormModel(this.formId); + } + + private addToChips() { + if (!this.formRef.formGroup.valid) { + this.formService.validateAllFormFields(this.formRef.formGroup); + return; + } + if (!this.isMandatoryFieldEmpty()) { + const item = this.buildChipItem(); + this.add.emit(item); + this.closeModal(); + } + } + + private getMandatoryFieldModel(): DsDynamicInputModel { + let mandatoryFieldModel = null; + this.formModel.forEach((row) => { + const modelRow = row as DynamicFormGroupModel; + modelRow.group.forEach((model: DynamicInputModel) => { + if (model.name === this.model.mandatoryField) { + mandatoryFieldModel = model; + this.initSecurityLevelConfig(model, modelRow); + return; + } + }); + }); + return mandatoryFieldModel; + } + + private getMandatoryFields(): DsDynamicInputModel[] { + return this.formModel + .map(row => (row as DynamicFormGroupModel).group) + .reduce((previousValue, currentValue) => previousValue.concat(currentValue)) + .map(model => model as DsDynamicInputModel) + .filter(model => !!model.validators && 'required' in model.validators); + } + + private modifyChip() { + if (!this.formRef.formGroup.valid) { + this.formService.validateAllFormFields(this.formRef.formGroup); + return; + } + if (!this.isMandatoryFieldEmpty()) { + const item = this.buildChipItem(); + this.edit.emit(item); + this.closeModal(); + } + } + + private buildChipItem() { + const item = Object.create({}); + let mainModel; + this.formModel.some((modelRow: DynamicFormGroupModel) => { + const findIndex = modelRow.group.findIndex(model => model.name === this.model.name); + if (findIndex !== -1) { + mainModel = modelRow.group[findIndex]; + return true; + } + }); + this.formModel.forEach((row) => { + const modelRow = row as DynamicFormGroupModel; + modelRow.group.forEach((control: DynamicInputModel) => { + const controlValue: any = (control?.value as any)?.value || control?.value || PLACEHOLDER_PARENT_METADATA; + const controlAuthority: any = (control?.value as any)?.authority || null; + + item[control.name] = + new FormFieldMetadataValueObject( + controlValue, + mainModel?.language, + controlValue === PLACEHOLDER_PARENT_METADATA ? null : mainModel.securityLevel, + controlAuthority, + null, 0, null, + (control?.value as any)?.otherInformation || null, + ); + }); + }); + return item; + } + + private initSecurityLevelConfig(chipModel: DynamicInputModel, modelGroup: DynamicFormGroupModel) { + if (this.model.name === chipModel.name && this.model.securityConfigLevel.length > 1) { + (chipModel as any).securityConfigLevel = this.model.securityConfigLevel; + (chipModel as any).toggleSecurityVisibility = true; + + const mainRow = modelGroup.group.find(itemModel => itemModel.name === this.model.name); + + (chipModel as any).securityLevel = (mainRow as any).securityLevel || 0; + this.securityLevelParent = (mainRow as any).securityLevel; + + modelGroup.group.forEach((item: any) => { + if (item.name !== this.model.name) { + item.securityConfigLevel = this.model.securityConfigLevel; + item.toggleSecurityVisibility = false; + item.securityLevel = this.securityLevelParent; + } + }); + } + if (this.model.securityConfigLevel.length === 1) { + modelGroup.group.forEach((item: any) => { + item.securityConfigLevel = this.model.securityConfigLevel; + item.toggleSecurityVisibility = false; + item.securityLevel = this.model.securityLevel; + }); + } + } + + private retrieveVocabulary(vocabularyOptions: VocabularyOptions): void { + this.vocabulary$ = this.vocabularyService.findVocabularyById(vocabularyOptions.name).pipe( + getFirstSucceededRemoteDataPayload(), + distinctUntilChanged(), + ); + } + + changeSecurity($event) { + if ($event.type === 'changeSecurityLevelGroup') { + this.changedSecurity = true; + } + } +} diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.html b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.html new file mode 100644 index 00000000000..e6654124d40 --- /dev/null +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.html @@ -0,0 +1,16 @@ +
    + @if (formModel) { + + } +
    diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.scss b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.scss new file mode 100644 index 00000000000..1c6d6ea7b7a --- /dev/null +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.scss @@ -0,0 +1,7 @@ +.inline-btn-group { + margin-top: 2rem; +} + +.inline-group-is-invalid ds-form:has(ds-dynamic-form-array) .grey-background { + border: 1px solid var(--bs-danger); +} diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.spec.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.spec.ts new file mode 100644 index 00000000000..0c4d5da5e4b --- /dev/null +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.component.spec.ts @@ -0,0 +1,701 @@ +import { HttpClient } from '@angular/common/http'; +import { + ChangeDetectorRef, + Component, + CUSTOM_ELEMENTS_SCHEMA, +} from '@angular/core'; +import { + ComponentFixture, + inject, + TestBed, + waitForAsync, +} from '@angular/core/testing'; +import { + FormControl, + FormGroup, + FormsModule, + ReactiveFormsModule, +} from '@angular/forms'; +import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; +import { APP_CONFIG } from '@dspace/config/app-config.interface'; +import { FormRowModel } from '@dspace/core/config/models/config-submission-form.model'; +import { SubmissionFormsModel } from '@dspace/core/config/models/config-submission-forms.model'; +import { APP_DATA_SERVICES_MAP } from '@dspace/core/data-services-map-type'; +import { PLACEHOLDER_PARENT_METADATA } from '@dspace/core/shared/form/ds-dynamic-form-constants'; +import { FormFieldModel } from '@dspace/core/shared/form/models/form-field.model'; +import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; +import { SubmissionServiceStub } from '@dspace/core/testing/submission-service.stub'; +import { createTestComponent } from '@dspace/core/testing/utils.test'; +import { XSRFService } from '@dspace/core/xsrf/xsrf.service'; +import { NgbModule } from '@ng-bootstrap/ng-bootstrap'; +import { + DYNAMIC_FORM_CONTROL_MAP_FN, + DynamicFormControlEvent, + DynamicFormGroupModel, + DynamicFormLayoutService, + DynamicFormValidationService, +} from '@ng-dynamic-forms/core'; +import { provideMockActions } from '@ngrx/effects/testing'; +import { provideMockStore } from '@ngrx/store/testing'; +import { TranslateModule } from '@ngx-translate/core'; +import { Observable } from 'rxjs'; + +import { environment } from '../../../../../../../environments/environment.test'; +import { SubmissionService } from '../../../../../../submission/submission.service'; +import { SubmissionObjectService } from '../../../../../../submission/submission-object.service'; +import { LiveRegionService } from '../../../../../live-region/live-region.service'; +import { FormComponent } from '../../../../form.component'; +import { FormService } from '../../../../form.service'; +import { FormBuilderService } from '../../../form-builder.service'; +import { dsDynamicFormControlMapFn } from '../../ds-dynamic-form-control-map-fn'; +import { DsDynamicInputModel } from '../ds-dynamic-input.model'; +import { DynamicRowArrayModel } from '../ds-dynamic-row-array-model'; +import { DynamicRowGroupModel } from '../ds-dynamic-row-group-model'; +import { + DynamicRelationGroupModel, + DynamicRelationGroupModelConfig, +} from '../relation-group/dynamic-relation-group.model'; +import { DsDynamicRelationInlineGroupComponent } from './dynamic-relation-inline-group.components'; + + +export let FORM_GROUP_TEST_MODEL_CONFIG; + +export let FORM_GROUP_TEST_GROUP; + +const submissionId = '1234'; +const metadataSecurity = { + 'uuid': null, + 'metadataSecurityDefault': [ + 0, + 1, + ], + 'metadataCustomSecurity': {}, + 'type': 'securitysetting', + '_links': { + 'self': { + 'href': 'http://localhost:8080/server/api/core/securitysettings', + }, + }, +}; + +const initialState: any = { + core: { + 'bitstreamFormats': {}, + 'cache/object': {}, + 'cache/syncbuffer': {}, + 'cache/object-updates': {}, + 'data/request': {}, + 'history': {}, + 'index': {}, + 'auth': {}, + 'json/patch': {}, + 'metaTag': {}, + 'route': {}, + }, +}; + +function init() { + FORM_GROUP_TEST_MODEL_CONFIG = { + disabled: false, + errorMessages: { required: 'You must specify at least one author.' }, + formConfiguration: [{ + fields: [{ + hints: 'Enter the name of the author.', + input: { type: 'onebox' }, + label: 'Author', + languageCodes: [], + mandatory: 'true', + mandatoryMessage: 'Required field!', + repeatable: false, + selectableMetadata: [{ + controlledVocabulary: 'RPAuthority', + closed: false, + metadata: 'dc.contributor.author', + }], + } as FormFieldModel, { + hints: 'Enter the affiliation of the author.', + input: { type: 'onebox' }, + label: 'Affiliation', + languageCodes: [], + mandatory: 'false', + repeatable: false, + selectableMetadata: [{ + controlledVocabulary: 'OUAuthority', + closed: false, + metadata: 'local.contributor.affiliation', + }], + } as FormFieldModel], + } as FormRowModel], + submissionId, + id: 'dc_contributor_author', + label: 'Authors', + isInlineGroup: true, + mandatoryField: 'dc.contributor.author', + name: 'dc.contributor.author', + placeholder: 'Authors', + readOnly: false, + relationFields: ['local.contributor.affiliation'], + required: true, + scopeUUID: '43fe1f8c-09a6-4fcf-9c78-5d4fed8f2c8f', + submissionScope: undefined, + validators: { required: null }, + repeatable: false, + metadataFields: [], + hasSelectableMetadata: false, + } as DynamicRelationGroupModelConfig; + + FORM_GROUP_TEST_GROUP = new FormGroup({ + dc_contributor_author: new FormControl(), + }); + +} + +describe('DsDynamicRelationInlineGroupComponent test suite', () => { + let testComp: TestComponent; + let groupComp: DsDynamicRelationInlineGroupComponent; + let groupCompAsAny: any; + let testFixture: ComponentFixture; + let groupFixture: ComponentFixture; + let modelValue: any; + let html; + let control1: FormControl; + let model1: DsDynamicInputModel; + let control2: FormControl; + let model2: DsDynamicInputModel; + let event: DynamicFormControlEvent; + const submissionServiceStub: any = new SubmissionServiceStub(); + + // async beforeEach + beforeEach(waitForAsync(() => { + init(); + /* TODO make sure these files use mocks instead of real services/components https://github.com/DSpace/dspace-angular/issues/281 */ + TestBed.configureTestingModule({ + imports: [ + BrowserAnimationsModule, + FormsModule, + ReactiveFormsModule, + NgbModule, + TranslateModule.forRoot(), + // MockComponent(FormComponent), + FormComponent, + DsDynamicRelationInlineGroupComponent, + TestComponent, + ], // declare the test component + providers: [ + ChangeDetectorRef, + DsDynamicRelationInlineGroupComponent, + DynamicFormValidationService, + DynamicFormLayoutService, + FormBuilderService, + FormComponent, + FormService, + provideMockStore({ initialState }), + provideMockActions(() => new Observable()), + { provide: SubmissionService, useValue: submissionServiceStub }, + { provide: XSRFService, useValue: {} }, + { provide: LiveRegionService, useValue: {} }, + { provide: APP_CONFIG, useValue: environment }, + { provide: APP_DATA_SERVICES_MAP, useValue: {} }, + { provide: DYNAMIC_FORM_CONTROL_MAP_FN, useValue: dsDynamicFormControlMapFn }, + { provide: HttpClient, useValue: {} }, + { provide: SubmissionObjectService, useValue: {} }, + ], + schemas: [CUSTOM_ELEMENTS_SCHEMA], + }); + + })); + + describe('', () => { + // synchronous beforeEach + beforeEach(() => { + html = ``; + + testFixture = createTestComponent(html, TestComponent) as ComponentFixture; + testComp = testFixture.componentInstance; + }); + + afterEach(() => { + testFixture.destroy(); + testComp = null; + }); + + it('should create DsDynamicRelationGroupComponent', inject([DsDynamicRelationInlineGroupComponent], (app: DsDynamicRelationInlineGroupComponent) => { + + expect(app).toBeDefined(); + })); + }); + + describe('when init model value is empty', () => { + beforeEach(inject([FormBuilderService], (service: FormBuilderService) => { + + groupFixture = TestBed.createComponent(DsDynamicRelationInlineGroupComponent); + service = TestBed.inject(FormBuilderService as any); + groupComp = groupFixture.componentInstance; // FormComponent test instance + groupCompAsAny = groupComp; + groupComp.formId = 'testForm'; + groupComp.group = FORM_GROUP_TEST_GROUP; + groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); + groupFixture.detectChanges(); + control1 = service.getFormControlById('dc_contributor_author', groupCompAsAny.formRef.formGroup, groupComp.formModel) as FormControl; + model1 = service.findById('dc_contributor_author', groupComp.formModel) as DsDynamicInputModel; + control2 = service.getFormControlById('local_contributor_affiliation', groupCompAsAny.formRef.formGroup, groupComp.formModel) as FormControl; + model2 = service.findById('local_contributor_affiliation', groupComp.formModel) as DsDynamicInputModel; + + })); + + afterEach(() => { + groupFixture.destroy(); + groupComp = null; + }); + + it('should init component properly', () => { + + expect(groupComp.formModel.length).toEqual(1); + expect((groupComp.formModel[0]) instanceof DynamicRowArrayModel).toBeTruthy(); + }); + + it('should init array model', () => { + const formConfig = { rows: groupComp.model.formConfiguration } as SubmissionFormsModel; + const formArrayModel = groupComp.initArrayModel(formConfig); + + expect(formArrayModel.length).toEqual(1); + expect((formArrayModel[0]) instanceof DynamicRowArrayModel).toBeTruthy(); + expect(formArrayModel[0].id).toBe('dc_contributor_author_array'); + + }); + + it('should init array item model', inject([FormBuilderService], (service: FormBuilderService) => { + const formConfig = { rows: groupComp.model.formConfiguration } as SubmissionFormsModel; + const expectedFormArrayItemModel = service.modelFromConfiguration( + submissionId, + formConfig, + groupComp.model.scopeUUID, + {}, + groupComp.model.submissionScope, + groupComp.model.readOnly, + ); + + const formArrayItemModel: DynamicFormGroupModel = groupComp.initArrayItemModel(formConfig) as DynamicFormGroupModel; + + expect(formArrayItemModel.group.length).toBe((expectedFormArrayItemModel[0] as DynamicFormGroupModel).group.length); + expect(formArrayItemModel.type).toBe('GROUP'); + })); + + it('should return emit blur event on blur', () => { + event = { + $event: new Event('blur'), + context: null, + control: null, + group: null, + model: null, + type: 'blur', + }; + spyOn(groupCompAsAny.blur, 'emit'); + + groupComp.onBlur(event); + + expect(groupCompAsAny.blur.emit).toHaveBeenCalled(); + }); + + describe('onChange', () => { + beforeEach(() => { + const formConfig = { rows: groupComp.model.formConfiguration } as SubmissionFormsModel; + const formArrayModel: DynamicRowArrayModel[] = groupComp.initArrayModel(formConfig) as DynamicRowArrayModel[]; + const group = formArrayModel[0].groups[0]; + const model = (group.group[0] as DynamicRowGroupModel).group[0]; + model.parent = group; + + event = { + $event: new Event('change'), + context: null, + control: null, + group: null, + model: model, + type: 'change', + }; + + }); + + it('should remove array item when group model is empty', () => { + + spyOn(groupComp, 'hasEmptyGroupValue').and.returnValue(true); + spyOn(groupCompAsAny, 'getRowValue'); + spyOn(groupCompAsAny, 'removeItemFromArray'); + spyOn(groupCompAsAny, 'removeItemFromModelValue'); + spyOn((groupCompAsAny).change, 'emit'); + + groupComp.onChange(event); + + expect(groupCompAsAny.getRowValue).toHaveBeenCalled(); + expect(groupCompAsAny.removeItemFromArray).toHaveBeenCalled(); + expect(groupCompAsAny.removeItemFromModelValue).toHaveBeenCalled(); + expect(groupCompAsAny.change.emit).toHaveBeenCalled(); + }); + + it('should validate form when mandatory group field is empty', () => { + + spyOn(groupComp, 'hasEmptyGroupValue').and.returnValue(false); + spyOn(groupCompAsAny, 'getRowValue').and.returnValue({ 'dc.contributor.author': null, 'local.contributor.affiliation': 'test' }); + spyOn(groupCompAsAny.formService, 'validateAllFormFields'); + spyOn(groupCompAsAny.change, 'emit'); + + groupComp.onChange(event); + + expect(groupCompAsAny.getRowValue).toHaveBeenCalled(); + expect(groupCompAsAny.formService.validateAllFormFields).toHaveBeenCalled(); + expect(groupCompAsAny.change.emit).toHaveBeenCalled(); + }); + + it('should update Array Model Value', () => { + + spyOn(groupComp, 'hasEmptyGroupValue').and.returnValue(false); + spyOn(groupCompAsAny, 'getRowValue').and.returnValue({ 'dc.contributor.author': 'test', 'local.contributor.affiliation': 'test' }); + spyOn(groupCompAsAny, 'updateArrayModelValue'); + spyOn(groupCompAsAny.change, 'emit'); + + groupComp.onChange(event); + + expect(groupCompAsAny.getRowValue).toHaveBeenCalled(); + expect(groupCompAsAny.change.emit).toHaveBeenCalled(); + }); + }); + + it('should return true when group Value is empty', () => { + + let groupValue: any = { 'dc.contributor.author': '', 'local.contributor.affiliation': PLACEHOLDER_PARENT_METADATA }; + + groupComp.hasEmptyGroupValue(groupValue); + + expect(groupComp.hasEmptyGroupValue(groupValue)).toBeTruthy(); + + groupValue = { 'dc.contributor.author': '', 'local.contributor.affiliation': '' }; + + groupComp.hasEmptyGroupValue(groupValue); + + expect(groupComp.hasEmptyGroupValue(groupValue)).toBeTruthy(); + + groupValue = {}; + + groupComp.hasEmptyGroupValue(groupValue); + + expect(groupComp.hasEmptyGroupValue(groupValue)).toBeTruthy(); + }); + + it('should return false when group Value is not empty', () => { + + let groupValue: any = { 'dc.contributor.author': 'test', 'local.contributor.affiliation': PLACEHOLDER_PARENT_METADATA }; + + groupComp.hasEmptyGroupValue(groupValue); + + expect(groupComp.hasEmptyGroupValue(groupValue)).toBeFalsy(); + + groupValue = { 'dc.contributor.author': '', 'local.contributor.affiliation': 'test' }; + + groupComp.hasEmptyGroupValue(groupValue); + + expect(groupComp.hasEmptyGroupValue(groupValue)).toBeFalsy(); + }); + + it('should return emit focus event on focus', () => { + event = { + $event: new Event('focus'), + context: null, + control: null, + group: null, + model: null, + type: 'focus', + }; + spyOn(groupCompAsAny.focus, 'emit'); + + groupComp.onFocus(event); + + expect(groupCompAsAny.focus.emit).toHaveBeenCalled(); + }); + + it('should call removeItemFromModelValue method', () => { + const model: any = { + parent: { + index: 1, + parent: { + size: 2, + }, + }, + }; + event = { + $event: new Event('remove'), + context: null, + control: null, + group: null, + model: model, + type: 'remove', + }; + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }, { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author 2'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation 2'), + }]; + groupComp.model.value = modelValue; + spyOn(groupCompAsAny, 'removeItemFromModelValue'); + + groupComp.remove(event); + + expect(groupCompAsAny.removeItemFromModelValue).toHaveBeenCalled(); + }); + + it('should not call removeItemFromModelValue method', () => { + const model: any = { + parent: { + index: 1, + parent: { + size: 1, + }, + }, + }; + event = { + $event: new Event('remove'), + context: null, + control: null, + group: null, + model: model, + type: 'remove', + }; + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }, { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author 2'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation 2'), + }]; + groupComp.model.value = modelValue; + spyOn(groupCompAsAny, 'removeItemFromModelValue'); + + groupComp.remove(event); + + expect(groupCompAsAny.removeItemFromModelValue).not.toHaveBeenCalled(); + }); + + it('should return form row value properly', () => { + const formGroup: any = { + group:[ + { + name: 'dc.contributor.author', + value: new FormFieldMetadataValueObject('test author'), + }, + { + name: 'local.contributor.affiliation', + value: new FormFieldMetadataValueObject('test affiliation'), + }, + ], + }; + const expectedValue = { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }; + + expect(groupCompAsAny.getRowValue(formGroup)).toEqual(expectedValue); + }); + + it('should normalize Group Form Value', () => { + const groupValue: any = { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject(PLACEHOLDER_PARENT_METADATA), + }; + const normalizedValue = { + 'dc.contributor.author': [new FormFieldMetadataValueObject('test author')], + }; + + expect(groupCompAsAny.normalizeGroupFormValue(groupValue)).toEqual(normalizedValue); + }); + + it('should remove item from model value array', () => { + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }, { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author 2'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation 2'), + }]; + groupComp.model.value = modelValue; + + const expectedModelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author 2'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation 2'), + }]; + spyOn(groupCompAsAny.change, 'emit'); + groupCompAsAny.removeItemFromModelValue(0); + + expect(groupCompAsAny.model.value).toEqual(expectedModelValue); + expect(groupCompAsAny.change.emit).toHaveBeenCalled(); + }); + + it('should remove item from array model', () => { + const model: any = { + parent: { + index: 1, + parent: { + parent: { + size: 2, + }, + }, + }, + }; + event = { + $event: new Event('remove'), + context: null, + control: null, + group: null, + model: model, + type: 'remove', + }; + + spyOn(groupCompAsAny.formBuilderService, 'getPath'); + spyOn(groupCompAsAny.formBuilderService, 'removeFormArrayGroup'); + spyOn(groupCompAsAny.formService, 'changeForm'); + spyOn(groupCompAsAny.formGroup, 'get'); + + groupCompAsAny.removeItemFromArray(event); + + expect(groupCompAsAny.formService.changeForm).toHaveBeenCalled(); + expect(groupCompAsAny.formBuilderService.removeFormArrayGroup).toHaveBeenCalled(); + }); + + it('should not remove item from array model when size is less than 2', () => { + const model: any = { + parent: { + index: 1, + parent: { + parent: { + size: 1, + }, + }, + }, + }; + event = { + $event: new Event('remove'), + context: null, + control: null, + group: null, + model: model, + type: 'remove', + }; + + spyOn(groupCompAsAny.formBuilderService, 'getPath'); + spyOn(groupCompAsAny.formBuilderService, 'removeFormArrayGroup'); + spyOn(groupCompAsAny.formService, 'changeForm'); + spyOn(groupCompAsAny.formGroup, 'get'); + + groupCompAsAny.removeItemFromArray(event); + + expect(groupCompAsAny.formService.changeForm).not.toHaveBeenCalled(); + expect(groupCompAsAny.formBuilderService.removeFormArrayGroup).not.toHaveBeenCalled(); + }); + + it('should update model properly', () => { + const groupValue: any = { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }; + + const expectedModelValue: any = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + + spyOn(groupCompAsAny.change, 'emit'); + + groupCompAsAny.updateArrayModelValue(groupValue, 0); + + expect(groupCompAsAny.model.value).toEqual(expectedModelValue); + }); + + it('should update model properly when model value is not empty', () => { + const groupValue: any = { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author 2'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation 2'), + }; + + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + + groupComp.model.value = modelValue; + + const expectedModelValue: any = [ + { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }, + { + 'dc.contributor.author': new FormFieldMetadataValueObject('test author 2'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation 2'), + }, + ]; + + spyOn(groupCompAsAny.change, 'emit'); + + groupCompAsAny.updateArrayModelValue(groupValue, 1); + + expect(groupCompAsAny.model.value).toEqual(expectedModelValue); + }); + }); + + describe('when init model value is not empty', () => { + beforeEach(() => { + + groupFixture = TestBed.createComponent(DsDynamicRelationInlineGroupComponent); + groupComp = groupFixture.componentInstance; // FormComponent test instance + groupComp.formId = 'testForm'; + groupComp.group = FORM_GROUP_TEST_GROUP; + groupComp.model = new DynamicRelationGroupModel(FORM_GROUP_TEST_MODEL_CONFIG); + modelValue = [{ + 'dc.contributor.author': new FormFieldMetadataValueObject('test author'), + 'local.contributor.affiliation': new FormFieldMetadataValueObject('test affiliation'), + }]; + groupComp.model.value = modelValue; + groupFixture.detectChanges(); + + }); + + afterEach(() => { + groupFixture.destroy(); + groupComp = null; + }); + + it('should init component properly', () => { + + expect(groupComp.formModel.length).toEqual(1); + expect((groupComp.formModel[0]) instanceof DynamicRowArrayModel).toBeTruthy(); + }); + + }); +}); + +// declare a test component +@Component({ + selector: 'ds-test-cmp', + template: ``, + imports: [ + FormsModule, + NgbModule, + ReactiveFormsModule, + ], +}) +class TestComponent { + + group = FORM_GROUP_TEST_GROUP; + + groupModelConfig = FORM_GROUP_TEST_MODEL_CONFIG; + + model = new DynamicRelationGroupModel(this.groupModelConfig); + + showErrorMessages = false; + +} diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.components.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.components.ts new file mode 100644 index 00000000000..0cc3fa44d38 --- /dev/null +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/relation-inline-group/dynamic-relation-inline-group.components.ts @@ -0,0 +1,279 @@ +import { NgClass } from '@angular/common'; +import { + Component, + EventEmitter, + Input, + OnDestroy, + OnInit, + Output, + ViewChild, + ViewEncapsulation, +} from '@angular/core'; +import { + FormArray, + FormGroup, +} from '@angular/forms'; +import { SubmissionFormsModel } from '@dspace/core/config/models/config-submission-forms.model'; +import { PLACEHOLDER_PARENT_METADATA } from '@dspace/core/shared/form/ds-dynamic-form-constants'; +import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; +import { + isEmpty, + isNotEmpty, +} from '@dspace/shared/utils/empty.util'; +import { + DynamicFormArrayGroupModel, + DynamicFormControlComponent, + DynamicFormControlEvent, + DynamicFormControlLayout, + DynamicFormControlModel, + DynamicFormGroupModel, + DynamicFormLayoutService, + DynamicFormValidationService, +} from '@ng-dynamic-forms/core'; +import { of } from 'rxjs'; + +import { shrinkInOut } from '../../../../../animations/shrink'; +import { FormComponent } from '../../../../form.component'; +import { FormService } from '../../../../form.service'; +import { FormBuilderService } from '../../../form-builder.service'; +import { setLayout } from '../../../parsers/parser.utils'; +import { + DynamicRowArrayModel, + DynamicRowArrayModelConfig, +} from '../ds-dynamic-row-array-model'; +import { DynamicRelationGroupModel } from '../relation-group/dynamic-relation-group.model'; + +@Component({ + encapsulation: ViewEncapsulation.None, + selector: 'ds-dynamic-relation-inline-group', + styleUrls: ['./dynamic-relation-inline-group.component.scss'], + templateUrl: './dynamic-relation-inline-group.component.html', + animations: [shrinkInOut], + imports: [ + FormComponent, + NgClass, + ], +}) +export class DsDynamicRelationInlineGroupComponent extends DynamicFormControlComponent implements OnInit, OnDestroy { + + @Input() formId: string; + @Input() group: FormGroup; + @Input() model: DynamicRelationGroupModel; + + @Output() blur: EventEmitter = new EventEmitter(); + @Output() change: EventEmitter = new EventEmitter(); + @Output() focus: EventEmitter = new EventEmitter(); + + public formCollapsed = of(false); + public formGroup: FormGroup; + public formModel: DynamicFormControlModel[]; + + @ViewChild('formRef', { static: false }) private formRef: FormComponent; + + constructor(private formBuilderService: FormBuilderService, + private formService: FormService, + protected layoutService: DynamicFormLayoutService, + protected validationService: DynamicFormValidationService, + ) { + super(layoutService, validationService); + } + + ngOnInit() { + const config = { rows: this.model.formConfiguration } as SubmissionFormsModel; + + this.formId = this.formService.getUniqueId(this.model.id); + this.formModel = this.initArrayModel(config); + this.formGroup = this.formBuilderService.createFormGroup(this.formModel); + this.formBuilderService.addFormModel(this.formId, this.formModel); + } + + initArrayModel(formConfig): DynamicRowArrayModel[] { + let arrayCounter = 0; + const config = { + id: this.model.id + '_array', + initialCount: isNotEmpty(this.model.value) ? (this.model.value as any[]).length : 1, + isDraggable: true, + isInlineGroupArray: true, + groupFactory: () => { + const fieldValue = isEmpty(this.model.value) || (arrayCounter === 0) ? {} : this.model.value[arrayCounter - 1]; + const model: any = this.initArrayItemModel(formConfig, this.normalizeGroupFormValue(fieldValue)); + arrayCounter++; + setLayout(model, 'element', 'host', 'col'); + if (model.hasLanguages) { + setLayout(model, 'grid', 'control', 'col'); + } + return [model]; + }, + } as DynamicRowArrayModelConfig; + + const layout: DynamicFormControlLayout = { + grid: { + group: 'form-row', + }, + }; + + return [new DynamicRowArrayModel(config, layout)]; + } + + initArrayItemModel(formConfig, initValues: any = {}) { + const formModel = this.formBuilderService.modelFromConfiguration( + this.model.submissionId, + formConfig, + this.model.scopeUUID, + initValues, + this.model.submissionScope, + this.model.readOnly, + this.formBuilderService.getTypeBindModel(), + true)[0]; + + return formModel; + } + + onBlur(event: DynamicFormControlEvent) { + this.blur.emit(); + } + + onChange(event: DynamicFormControlEvent) { + const index = event.model.parent.parent.index; + const groupValue = this.getRowValue(event.model.parent as DynamicFormGroupModel); + + if (this.hasEmptyGroupValue(groupValue)) { + this.removeItemFromArray(event); + this.removeItemFromModelValue(index); + } else if (isEmpty(groupValue[this.model.mandatoryField])) { + this.formService.validateAllFormFields(event.group); + } else { + this.updateArrayModelValue(groupValue, index); + } + this.change.emit(); + } + + hasEmptyGroupValue(groupValue): boolean { + const keysNotEmpty = Object.keys(groupValue) + .filter((metadata) => isNotEmpty(groupValue[metadata]) && groupValue[metadata] !== PLACEHOLDER_PARENT_METADATA); + return isEmpty(keysNotEmpty); + } + + onFocus(event: DynamicFormControlEvent) { + this.focus.emit(); + } + + remove(event: DynamicFormControlEvent) { + const index = event.model.parent.index; + const size = (event.model.parent.parent as any).size; + if (isNotEmpty(this.model.value) && size === (this.model.value as any[]).length) { + this.removeItemFromModelValue(index); + } + } + + private getRowValue(formGroup: DynamicFormGroupModel) { + const mainRow = formGroup.group.find(itemModel => itemModel.name === this.model.name); + const mainLanguage = (mainRow as any).language ?? null; + const groupValue = Object.create({}); + formGroup.group.forEach((model: any) => { + if (model.name !== this.model.mandatoryField) { + if (isEmpty(model.value)) { + groupValue[model.name] = PLACEHOLDER_PARENT_METADATA; + } else { + if (typeof model.value === 'string') { + groupValue[model.name] = new FormFieldMetadataValueObject(model.value, mainLanguage); + } else { + groupValue[model.name] = Object.assign(new FormFieldMetadataValueObject(), model.value, { language: mainLanguage }); + } + } + } else { + if (typeof model.value === 'string') { + groupValue[model.name] = new FormFieldMetadataValueObject(model.value, mainLanguage); + } else { + groupValue[model.name] = Object.assign(new FormFieldMetadataValueObject(), model.value, { language: mainLanguage }); + } + } + }); + return groupValue; + } + + private normalizeGroupFormValue(valueObj) { + const normValue = Object.create({}); + if (isNotEmpty(valueObj)) { + Object.keys(valueObj).forEach((metadata) => { + if (!this.hasPlaceholder(valueObj[metadata])) { + normValue[metadata] = [valueObj[metadata]]; + } + }); + } + + return normValue; + } + + private hasPlaceholder(value: string | FormFieldMetadataValueObject): boolean { + return (value instanceof FormFieldMetadataValueObject) ? value.hasPlaceholder() : (isNotEmpty(value) && value === PLACEHOLDER_PARENT_METADATA); + } + + private removeItemFromModelValue(removeIndex) { + const newValue = (this.model.value as any[]).filter((value, itemIndex) => itemIndex !== removeIndex); + this.model.value = newValue; + this.change.emit(); + } + + private removeItemFromArray(event: DynamicFormControlEvent): void { + const parentArrayModel: DynamicFormArrayGroupModel = event.model.parent.parent as DynamicFormArrayGroupModel; + const arraySize = parentArrayModel.parent.size; + if (arraySize > 1) { + const index = parentArrayModel.index; + const arrayContext = parentArrayModel.context; + const path = this.formBuilderService.getPath(arrayContext); + const formArrayControl = this.formGroup.get(path) as FormArray; + this.formBuilderService.removeFormArrayGroup(index, formArrayControl, arrayContext); + this.formService.changeForm(this.formId, this.formModel); + } + } + + private updateArrayModelValue(groupValue, index) { + let modelValue = this.model.value; + if (isEmpty(modelValue)) { + modelValue = [groupValue]; + } else { + modelValue[index] = groupValue; + } + this.model.value = modelValue; + } + + onCustomEvent(event) { + if (event.type === 'move') { + this.moveArrayItem(event); + } else if (event.type === 'copy') { + this.copyArrayItem(event); + } + } + + ngOnDestroy(): void { + this.formBuilderService.removeFormModel(this.formId); + } + + private moveArrayItem(event) { + const index = event.$event.index; + const previousIndex = event.$event.previousIndex; + let arrayOfValue: any = this.model.value; + + if (arrayOfValue[index] === undefined || arrayOfValue[previousIndex] === undefined) { + return; + } else if (arrayOfValue.length > 0) { + arrayOfValue = arrayOfValue.filter((el) => el !== undefined); + } else { + return; + } + + const temp = this.model.value[index]; + this.model.value[index] = this.model.value[previousIndex]; + this.model.value[previousIndex] = temp; + + this.change.emit(); + } + + private copyArrayItem(event) { + const index = Array.isArray(this.model.value) ? this.model.value.length : event.model.parent.index; + const groupValue = this.getRowValue(event.model as DynamicFormGroupModel); + this.updateArrayModelValue(groupValue, index); + this.change.emit(); + } +} diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component.spec.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component.spec.ts index e7c3e7ed835..c5796307369 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component.spec.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component.spec.ts @@ -28,20 +28,27 @@ import { mockDynamicFormLayoutService, mockDynamicFormValidationService, } from '@dspace/core/testing/dynamic-form-mock-services'; +import { SubmissionServiceStub } from '@dspace/core/testing/submission-service.stub'; import { createTestComponent, hasClass, } from '@dspace/core/testing/utils.test'; import { VocabularyServiceStub } from '@dspace/core/testing/vocabulary-service.stub'; -import { NgbModule } from '@ng-bootstrap/ng-bootstrap'; +import { + NgbModal, + NgbModule, +} from '@ng-bootstrap/ng-bootstrap'; import { DynamicFormLayoutService, DynamicFormsCoreModule, DynamicFormValidationService, } from '@ng-dynamic-forms/core'; +import { provideMockStore } from '@ngrx/store/testing'; import { TranslateModule } from '@ngx-translate/core'; import { InfiniteScrollModule } from 'ngx-infinite-scroll'; +import { SubmissionService } from 'src/app/submission/submission.service'; +import { FormBuilderService } from '../../../form-builder.service'; import { DsDynamicScrollableDropdownComponent } from './dynamic-scrollable-dropdown.component'; import { DynamicScrollableDropdownModel } from './dynamic-scrollable-dropdown.model'; @@ -102,7 +109,11 @@ describe('Dynamic Dynamic Scrollable Dropdown component', () => { { provide: VocabularyService, useValue: vocabularyServiceStub }, { provide: DynamicFormLayoutService, useValue: mockDynamicFormLayoutService }, { provide: DynamicFormValidationService, useValue: mockDynamicFormValidationService }, + { provide: FormBuilderService }, + { provide: SubmissionService, useClass: SubmissionServiceStub }, { provide: APP_DATA_SERVICES_MAP, useValue: {} }, + NgbModal, + provideMockStore(), ], schemas: [CUSTOM_ELEMENTS_SCHEMA], }); diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component.ts index 0e287236f6e..4ce9c341acf 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.component.ts @@ -35,8 +35,10 @@ import { import { NgbDropdown, NgbDropdownModule, + NgbModal, } from '@ng-bootstrap/ng-bootstrap'; import { + DynamicFormControlCustomEvent, DynamicFormLayoutService, DynamicFormValidationService, } from '@ng-dynamic-forms/core'; @@ -53,11 +55,12 @@ import { take, tap, } from 'rxjs/operators'; +import { FormBuilderService } from 'src/app/shared/form/builder/form-builder.service'; +import { SubmissionService } from 'src/app/submission/submission.service'; import { DsDynamicVocabularyComponent } from '../dynamic-vocabulary.component'; import { DynamicScrollableDropdownModel } from './dynamic-scrollable-dropdown.model'; - /** * Component representing a dropdown input field */ @@ -82,6 +85,7 @@ export class DsDynamicScrollableDropdownComponent extends DsDynamicVocabularyCom @Output() blur: EventEmitter = new EventEmitter(); @Output() change: EventEmitter = new EventEmitter(); @Output() focus: EventEmitter = new EventEmitter(); + @Output() customEvent: EventEmitter = new EventEmitter(); public currentValue: Observable; public loading = false; @@ -111,10 +115,13 @@ export class DsDynamicScrollableDropdownComponent extends DsDynamicVocabularyCom protected cdr: ChangeDetectorRef, protected layoutService: DynamicFormLayoutService, protected validationService: DynamicFormValidationService, + protected formBuilderService: FormBuilderService, + protected modalService: NgbModal, + protected submissionService: SubmissionService, protected parentInjector: Injector, @Inject(APP_DATA_SERVICES_MAP) private dataServiceMap: LazyDataServicesMap, ) { - super(vocabularyService, layoutService, validationService); + super(vocabularyService, layoutService, validationService, formBuilderService, modalService, submissionService); } /** diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/tag/dynamic-tag.component.spec.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/tag/dynamic-tag.component.spec.ts index 0df3ff9796e..6372a04092a 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/models/tag/dynamic-tag.component.spec.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/tag/dynamic-tag.component.spec.ts @@ -18,6 +18,7 @@ import { UntypedFormControl, UntypedFormGroup, } from '@angular/forms'; +import { APP_DATA_SERVICES_MAP } from '@dspace/core/data-services-map-type'; import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; import { VocabularyEntry } from '@dspace/core/submission/vocabularies/models/vocabulary-entry.model'; import { VocabularyOptions } from '@dspace/core/submission/vocabularies/models/vocabulary-options.model'; @@ -26,6 +27,7 @@ import { mockDynamicFormLayoutService, mockDynamicFormValidationService, } from '@dspace/core/testing/dynamic-form-mock-services'; +import { SubmissionServiceStub } from '@dspace/core/testing/submission-service.stub'; import { createTestComponent } from '@dspace/core/testing/utils.test'; import { VocabularyServiceStub } from '@dspace/core/testing/vocabulary-service.stub'; import { @@ -37,10 +39,13 @@ import { DynamicFormsCoreModule, DynamicFormValidationService, } from '@ng-dynamic-forms/core'; +import { provideMockStore } from '@ngrx/store/testing'; import { TranslateModule } from '@ngx-translate/core'; import { of } from 'rxjs'; +import { SubmissionService } from 'src/app/submission/submission.service'; import { Chips } from '../../../../chips/models/chips.model'; +import { FormBuilderService } from '../../../form-builder.service'; import { DsDynamicTagComponent } from './dynamic-tag.component'; import { DynamicTagModel } from './dynamic-tag.model'; @@ -112,6 +117,10 @@ describe('DsDynamicTagComponent test suite', () => { { provide: VocabularyService, useValue: vocabularyServiceStub }, { provide: DynamicFormLayoutService, useValue: mockDynamicFormLayoutService }, { provide: DynamicFormValidationService, useValue: mockDynamicFormValidationService }, + { provide: FormBuilderService }, + { provide: SubmissionService, useClass: SubmissionServiceStub }, + provideMockStore(), + { provide: APP_DATA_SERVICES_MAP, useValue: {} }, ], schemas: [CUSTOM_ELEMENTS_SCHEMA], }); @@ -232,9 +241,9 @@ describe('DsDynamicTagComponent test suite', () => { tagComp.group = TAG_TEST_GROUP; tagComp.model = new DynamicTagModel(TAG_TEST_MODEL_CONFIG); modelValue = [ - new FormFieldMetadataValueObject('a', null, 'test001'), - new FormFieldMetadataValueObject('b', null, 'test002'), - new FormFieldMetadataValueObject('c', null, 'test003'), + new FormFieldMetadataValueObject('a', null, null, 'test001'), + new FormFieldMetadataValueObject('b', null, null, 'test002'), + new FormFieldMetadataValueObject('c', null, null, 'test003'), ]; tagComp.model.value = modelValue; tagFixture.detectChanges(); diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/models/tag/dynamic-tag.component.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/models/tag/dynamic-tag.component.ts index 9270ca61ed9..2f053cfc80c 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/models/tag/dynamic-tag.component.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/models/tag/dynamic-tag.component.ts @@ -25,11 +25,13 @@ import { isNotEmpty, } from '@dspace/shared/utils/empty.util'; import { + NgbModal, NgbTypeahead, NgbTypeaheadModule, NgbTypeaheadSelectItemEvent, } from '@ng-bootstrap/ng-bootstrap'; import { + DynamicFormControlCustomEvent, DynamicFormLayoutService, DynamicFormValidationService, } from '@ng-dynamic-forms/core'; @@ -49,8 +51,10 @@ import { } from 'rxjs/operators'; import { environment } from '../../../../../../../environments/environment'; +import { SubmissionService } from '../../../../../../submission/submission.service'; import { ChipsComponent } from '../../../../chips/chips.component'; import { Chips } from '../../../../chips/models/chips.model'; +import { FormBuilderService } from '../../../form-builder.service'; import { DsDynamicVocabularyComponent } from '../dynamic-vocabulary.component'; import { DynamicTagModel } from './dynamic-tag.model'; @@ -76,6 +80,7 @@ export class DsDynamicTagComponent extends DsDynamicVocabularyComponent implemen @Output() blur: EventEmitter = new EventEmitter(); @Output() change: EventEmitter = new EventEmitter(); @Output() focus: EventEmitter = new EventEmitter(); + @Output() customEvent: EventEmitter = new EventEmitter(); @ViewChild('instance') instance: NgbTypeahead; @@ -92,8 +97,11 @@ export class DsDynamicTagComponent extends DsDynamicVocabularyComponent implemen private cdr: ChangeDetectorRef, protected layoutService: DynamicFormLayoutService, protected validationService: DynamicFormValidationService, + protected formBuilderService: FormBuilderService, + protected modalService: NgbModal, + protected submissionService: SubmissionService, ) { - super(vocabularyService, layoutService, validationService); + super(vocabularyService, layoutService, validationService, formBuilderService, modalService, submissionService); } /** diff --git a/src/app/shared/form/builder/form-builder.service.spec.ts b/src/app/shared/form/builder/form-builder.service.spec.ts index 7645e329c5f..c2d1fcd11a7 100644 --- a/src/app/shared/form/builder/form-builder.service.spec.ts +++ b/src/app/shared/form/builder/form-builder.service.spec.ts @@ -102,6 +102,8 @@ describe('FormBuilderService test suite', () => { const vocabularyOptions: VocabularyOptions = { name: 'type_programme', + metadata: null, + scope: null, closed: false, }; @@ -288,6 +290,7 @@ describe('FormBuilderService test suite', () => { }], } as FormFieldModel], } as FormRowModel], + isInlineGroup: false, mandatoryField: '', name: 'testRelationGroup', relationFields: [], diff --git a/src/app/shared/form/builder/form-builder.service.ts b/src/app/shared/form/builder/form-builder.service.ts index b7829896cfa..ef5ec96fd53 100644 --- a/src/app/shared/form/builder/form-builder.service.ts +++ b/src/app/shared/form/builder/form-builder.service.ts @@ -4,6 +4,7 @@ import { } from '@angular/core'; import { AbstractControl, + FormArray, UntypedFormControl, UntypedFormGroup, } from '@angular/forms'; @@ -25,6 +26,7 @@ import { isNotNull, isNotUndefined, isNull, + isObjectEmpty, } from '@dspace/shared/utils/empty.util'; import { DYNAMIC_FORM_CONTROL_TYPE_ARRAY, @@ -54,7 +56,11 @@ import { import { DsDynamicInputModel } from './ds-dynamic-form-ui/models/ds-dynamic-input.model'; import { DynamicQualdropModel } from './ds-dynamic-form-ui/models/ds-dynamic-qualdrop.model'; import { DynamicRowArrayModel } from './ds-dynamic-form-ui/models/ds-dynamic-row-array-model'; -import { DynamicRelationGroupModel } from './ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.model'; +import { + DynamicRelationGroupModel, + DynamicRelationGroupModelConfig, +} from './ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.model'; +import { DYNAMIC_FORM_CONTROL_TYPE_SCROLLABLE_DROPDOWN } from './ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.model'; import { DYNAMIC_FORM_CONTROL_TYPE_TAG } from './ds-dynamic-form-ui/models/tag/dynamic-tag.model'; import { RowParser } from './parsers/row-parser'; @@ -130,7 +136,7 @@ export class FormBuilderService extends DynamicFormService { } if (this.isConcatGroup(controlModel)) { - if (controlModel.id.match(new RegExp(findId + CONCAT_GROUP_SUFFIX))) { + if (controlModel.id.match(new RegExp(findId + CONCAT_GROUP_SUFFIX)) || controlModel.id.match(new RegExp(findId + CONCAT_GROUP_SUFFIX + `_\\d+$`))) { result = (controlModel as DynamicConcatModel); break; } @@ -189,33 +195,117 @@ export class FormBuilderService extends DynamicFormService { }; const normalizeValue = (controlModel, controlValue, controlModelIndex) => { - const controlLanguage = (controlModel as DsDynamicInputModel).hasLanguages ? (controlModel as DsDynamicInputModel).language : null; + let securityLevel = null; + let controlLanguage = (controlModel as DsDynamicInputModel).hasLanguages ? (controlModel as DsDynamicInputModel).language : null; + if (controlModel instanceof DynamicQualdropModel) { + // get the security value inside in the metadataValue of input + if (controlModel.group) { + controlModel.group.map((formModelDynamic: any) => { + if (formModelDynamic.metadataValue) { + if (formModelDynamic.metadataValue.securityLevel !== undefined) { + securityLevel = formModelDynamic.metadataValue.securityLevel; + } + } else { + if (formModelDynamic.value) { + if (typeof formModelDynamic.value !== 'string') { + if (formModelDynamic.value.securityLevel !== undefined) { + securityLevel = formModelDynamic.value.securityLevel; + } + } + } + } + if (!formModelDynamic.metadataValue && formModelDynamic.value && typeof formModelDynamic.value === 'string') { + if (formModelDynamic.securityLevel !== undefined) { + securityLevel = formModelDynamic.securityLevel; + } + } + }); + } + + let qualdropLanguageControl = null; + for (const control of controlModel.group) { + if (hasValue((control as DsDynamicInputModel).language)) { + qualdropLanguageControl = control as DsDynamicInputModel; + break; + } + } + if (qualdropLanguageControl) { + controlModel.language = controlLanguage ?? qualdropLanguageControl.language; + controlLanguage = controlModel.language; + } + } + if (controlModel && (controlModel as any).securityLevel !== undefined) { + securityLevel = (controlModel as any).securityLevel; + } else { + if (controlValue && (controlValue as any).securityLevel !== undefined) { + securityLevel = (controlValue as any).securityLevel; + } else { + if (controlModel && controlModel.metadataValue && controlModel.metadataValue.securityLevel !== undefined) { + securityLevel = controlModel.metadataValue.securityLevel; + } + } + } if (controlModel?.metadataValue?.authority?.includes(VIRTUAL_METADATA_PREFIX)) { return controlModel.metadataValue; } if (isString(controlValue)) { - return new FormFieldMetadataValueObject(controlValue, controlLanguage, null, null, controlModelIndex); + const lang = controlModel instanceof DynamicQualdropModel ? controlModel.language : controlLanguage; + return new FormFieldMetadataValueObject(controlValue, lang, securityLevel, null, controlModelIndex); } else if (isNgbDateStruct(controlValue)) { return new FormFieldMetadataValueObject(dateToString(controlValue)); } else if (isObject(controlValue)) { const authority = (controlValue as any).authority || (controlValue as any).id || null; const place = controlModelIndex || (controlValue as any).place; if (isNgbDateStruct(controlValue)) { - return new FormFieldMetadataValueObject(controlValue, controlLanguage, authority, controlValue as any, place); + return new FormFieldMetadataValueObject(controlValue, controlLanguage, securityLevel, authority, controlValue as any, place); } else { - return new FormFieldMetadataValueObject((controlValue as any).value, controlLanguage, authority, (controlValue as any).display, place, (controlValue as any).confidence); + return new FormFieldMetadataValueObject((controlValue as any).value, controlLanguage, securityLevel, authority, (controlValue as any).display, place, (controlValue as any).confidence); } } return controlValue; }; - const iterateControlModels = (findGroupModel: DynamicFormControlModel[], controlModelIndex: number = 0): void => { + const iterateControlModels = (findGroupModel: DynamicFormControlModel[], controlModelIndex: number = 0): DynamicFormControlModel => { let iterateResult = Object.create({}); - // Iterate over all group's controls for (const controlModel of findGroupModel) { + if ((controlModel as any).securityLevel !== undefined && (controlModel as any).securityLevel != null) { + if ((controlModel as any).value) { + if (typeof ((controlModel as any).value) === 'string') { + if ((controlModel as any).metadataValue) { + (controlModel as any).metadataValue = new FormFieldMetadataValueObject( + (controlModel as any).metadataValue.value, + (controlModel as any).metadataValue.language, + (controlModel as any).securityLevel, + (controlModel as any).metadataValue.authority, + (controlModel as any).metadataValue.display, + (controlModel as any).metadataValue.place, + (controlModel as any).metadataValue.confidence, + (controlModel as any).metadataValue.otherInformation, + (controlModel as any).metadataValue.source, + (controlModel as any).metadataValue.metadata); + } + + } else { + if (((controlModel as any).value) instanceof FormFieldMetadataValueObject) { + (controlModel as any).value = new FormFieldMetadataValueObject( + (controlModel as any).value.value, + (controlModel as any).value.language, + (controlModel as any).securityLevel, + (controlModel as any).value.authority, + (controlModel as any).value.display, + (controlModel as any).value.place, + (controlModel as any).value.confidence, + (controlModel as any).value.otherInformation, + (controlModel as any).value.source, + (controlModel as any).value.metadata); + } + } + } + } + if (this.isRowGroup(controlModel) && !this.isCustomOrListGroup(controlModel)) { iterateResult = mergeWith(iterateResult, iterateControlModels((controlModel as DynamicFormGroupModel).group), customizer); @@ -294,13 +384,13 @@ export class FormBuilderService extends DynamicFormService { modelFromConfiguration(submissionId: string, json: string | SubmissionFormsModel, scopeUUID: string, sectionData: any = {}, submissionScope?: string, readOnly = false, typeBindModel = null, - isInnerForm = false): DynamicFormControlModel[] | never { + isInnerForm = false, securityConfig: any = null, setTypeBind: boolean = true): DynamicFormControlModel[] | never { let rows: DynamicFormControlModel[] = []; const rawData = typeof json === 'string' ? JSON.parse(json, parseReviver) : json; if (rawData.rows && !isEmpty(rawData.rows)) { rawData.rows.forEach((currentRow) => { const rowParsed = this.rowParser.parse(submissionId, currentRow, scopeUUID, sectionData, submissionScope, - readOnly, this.getTypeField()); + readOnly, this.getTypeField(), isInnerForm, securityConfig); if (isNotNull(rowParsed)) { if (Array.isArray(rowParsed)) { rows = rows.concat(rowParsed); @@ -334,6 +424,10 @@ export class FormBuilderService extends DynamicFormService { || this.isRelationGroup((model as any).parent)); } + isScrollableDropdown(model: DynamicFormControlModel): boolean { + return model && (model.type === DYNAMIC_FORM_CONTROL_TYPE_SCROLLABLE_DROPDOWN); + } + isGroup(model: DynamicFormControlModel): boolean { return model && (model.type === DYNAMIC_FORM_CONTROL_TYPE_GROUP || model.type === DYNAMIC_FORM_CONTROL_TYPE_CHECKBOX_GROUP); } @@ -410,6 +504,15 @@ export class FormBuilderService extends DynamicFormService { return (tempModel.id !== tempModel.name) ? tempModel.name : tempModel.id; } + /** + * Add new form model to formModels map + * @param id id of model + * @param model model + */ + addFormModel(id: string, model: DynamicFormControlModel[]): void { + this.formModels.set(id, model); + } + /** * If present, remove form model from formModels map * @param id id of model @@ -439,6 +542,65 @@ export class FormBuilderService extends DynamicFormService { } } + /** + * This method searches a field in all forms instantiated + * by form.component and, if found, it updates its value + * + * @param fieldId id of field to update + * @param value new value to set + * @return the model updated if found + */ + updateModelValue(fieldId: string, value: FormFieldMetadataValueObject): DynamicFormControlModel { + let returnModel = null; + [...this.formModels.keys()].forEach((formId) => { + const models = this.formModels.get(formId); + let fieldModel: any = this.findById(fieldId, models); + if (hasValue(fieldModel) && !fieldModel.hidden) { + const isIterable = (typeof value[Symbol.iterator] === 'function'); + if (isNotEmpty(value)) { + if (fieldModel.repeatable && isNotEmpty(fieldModel.value) && !(!isIterable && fieldModel instanceof DynamicRelationGroupModel)) { + // if model is repeatable and has already a value add a new field instead of replacing it + const formGroup = this.formGroups.get(formId); + const arrayContext = fieldModel.parent?.context; + if (isNotEmpty(formGroup) && isNotEmpty(arrayContext)) { + const formArrayControl = this.getFormControlByModel(formGroup, arrayContext) as FormArray; + const index = arrayContext?.groups?.length; + this.insertFormArrayGroup(index, formArrayControl, arrayContext); + const newAddedModel: any = this.findById(fieldId, models, index); + this.detectChanges(); + newAddedModel.value = value; + returnModel = newAddedModel; + } + } else { + + if ((!isIterable && fieldModel instanceof DynamicRelationGroupModel) && isEmpty(fieldModel.value)) { + const config: DynamicRelationGroupModelConfig = { + submissionId: fieldModel.submissionId, + formConfiguration: fieldModel.formConfiguration, + isInlineGroup: fieldModel.isInlineGroup, + mandatoryField: fieldModel.mandatoryField, + relationFields: fieldModel.relationFields, + scopeUUID: fieldModel.scopeUUID, + submissionScope: fieldModel.submissionScope, + repeatable: fieldModel.repeatable, + metadataFields: fieldModel.metadataFields, + hasSelectableMetadata: fieldModel.hasSelectableMetadata, + id: fieldModel.id, + value: fieldModel.getGroupValue(value), + }; + fieldModel = new DynamicRelationGroupModel(config); + } else { + fieldModel.value = value; + } + returnModel = fieldModel; + + } + } + } + }); + return returnModel; + } + /** * Calculate the metadata list related to the event. * @param event @@ -546,4 +708,29 @@ export class FormBuilderService extends DynamicFormService { return this.typeField; } + /** + * Add new formbuilder in forma array by copying current formBuilder index + * @param index index of formBuilder selected to be copied + * @param formArray formArray of the inline group forms + * @param formArrayModel formArrayModel model of forms that will be created + */ + copyFormArrayGroup(index: number, formArray: FormArray, formArrayModel: DynamicFormArrayModel) { + + const groupModel = formArrayModel.insertGroup(index); + const previousGroup = formArray.controls[index] as UntypedFormGroup; + const newGroup = this.createFormGroup(groupModel.group, null, groupModel); + const previousKey = Object.keys(previousGroup.getRawValue())[0]; + const newKey = Object.keys(newGroup.getRawValue())[0]; + const rawValue = previousGroup.getRawValue()[previousKey]; + if (!isObjectEmpty(rawValue)) { + newGroup.get(newKey).patchValue(rawValue); + } + + formArray.insert(index, newGroup); + + return newGroup; + } + + + } diff --git a/src/app/shared/form/builder/parsers/concat-field-parser.ts b/src/app/shared/form/builder/parsers/concat-field-parser.ts index 386ea3e02c8..3c6c9963745 100644 --- a/src/app/shared/form/builder/parsers/concat-field-parser.ts +++ b/src/app/shared/form/builder/parsers/concat-field-parser.ts @@ -24,6 +24,7 @@ import { FieldParser, INIT_FORM_VALUES, PARSER_OPTIONS, + SECURITY_CONFIG, SUBMISSION_ID, } from './field-parser'; import { ParserOptions } from './parser-options'; @@ -35,11 +36,12 @@ export class ConcatFieldParser extends FieldParser { @Inject(CONFIG_DATA) configData: FormFieldModel, @Inject(INIT_FORM_VALUES) initFormValues, @Inject(PARSER_OPTIONS) parserOptions: ParserOptions, - translate: TranslateService, + @Inject(SECURITY_CONFIG) securityConfig: any, + protected translate: TranslateService, protected separator: string, protected firstPlaceholder: string = null, protected secondPlaceholder: string = null) { - super(submissionId, configData, initFormValues, parserOptions, translate); + super(submissionId, configData, initFormValues, parserOptions, translate, securityConfig); this.separator = separator; this.firstPlaceholder = firstPlaceholder; @@ -108,6 +110,9 @@ export class ConcatFieldParser extends FieldParser { const model1 = new DsDynamicInputModel(input1ModelConfig, clsInput); const model2 = new DsDynamicInputModel(input2ModelConfig, clsInput); + // attach the security config for children + (model1 as any).securityConfigLevel = (concatGroup as any).securityConfigLevel; + (model2 as any).securityConfigLevel = (concatGroup as any).securityConfigLevel; concatGroup.group.push(model1); concatGroup.group.push(model2); @@ -116,6 +121,7 @@ export class ConcatFieldParser extends FieldParser { control: 'row', }, }; + this.initSecurityValue(concatGroup, fieldValue as any); const concatModel = new DynamicConcatModel(concatGroup, clsGroup); concatModel.name = this.getFieldId(); diff --git a/src/app/shared/form/builder/parsers/date-field-parser.spec.ts b/src/app/shared/form/builder/parsers/date-field-parser.spec.ts index 4ebec24f37b..eba4983a70f 100644 --- a/src/app/shared/form/builder/parsers/date-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/date-field-parser.spec.ts @@ -19,6 +19,7 @@ describe('DateFieldParser test suite', () => { submissionScope: null, collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -42,13 +43,13 @@ describe('DateFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new DateFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DateFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof DateFieldParser).toBe(true); }); it('should return a DynamicDsDatePickerModel object when repeatable option is false', () => { - const parser = new DateFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DateFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -61,7 +62,7 @@ describe('DateFieldParser test suite', () => { }; const expectedValue = '1983-11-18'; - const parser = new DateFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DateFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); diff --git a/src/app/shared/form/builder/parsers/disabled-field-parser.spec.ts b/src/app/shared/form/builder/parsers/disabled-field-parser.spec.ts index a187b25f50f..e19dbff69bd 100644 --- a/src/app/shared/form/builder/parsers/disabled-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/disabled-field-parser.spec.ts @@ -16,6 +16,7 @@ describe('DisabledFieldParser test suite', () => { submissionScope: null, collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -38,13 +39,13 @@ describe('DisabledFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new DisabledFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DisabledFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof DisabledFieldParser).toBe(true); }); it('should return a DynamicDisabledModel object when repeatable option is false', () => { - const parser = new DisabledFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DisabledFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -59,7 +60,7 @@ describe('DisabledFieldParser test suite', () => { }; const expectedValue = 'test description'; - const parser = new DisabledFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DisabledFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); expect(fieldModel.value.value).toEqual(expectedValue); diff --git a/src/app/shared/form/builder/parsers/dropdown-field-parser.spec.ts b/src/app/shared/form/builder/parsers/dropdown-field-parser.spec.ts index c1b5e52e2d4..794c2b8be86 100644 --- a/src/app/shared/form/builder/parsers/dropdown-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/dropdown-field-parser.spec.ts @@ -16,6 +16,7 @@ describe('DropdownFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -40,13 +41,13 @@ describe('DropdownFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new DropdownFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DropdownFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof DropdownFieldParser).toBe(true); }); it('should return a DynamicScrollableDropdownModel object when repeatable option is false', () => { - const parser = new DropdownFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DropdownFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -55,7 +56,7 @@ describe('DropdownFieldParser test suite', () => { it('should throw when authority is not passed', () => { field.selectableMetadata[0].controlledVocabulary = null; - const parser = new DropdownFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new DropdownFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(() => parser.parse()) .toThrow(); diff --git a/src/app/shared/form/builder/parsers/dropdown-field-parser.ts b/src/app/shared/form/builder/parsers/dropdown-field-parser.ts index 815fefe2afd..1a99fe697d1 100644 --- a/src/app/shared/form/builder/parsers/dropdown-field-parser.ts +++ b/src/app/shared/form/builder/parsers/dropdown-field-parser.ts @@ -14,6 +14,7 @@ import { FieldParser, INIT_FORM_VALUES, PARSER_OPTIONS, + SECURITY_CONFIG, SUBMISSION_ID, } from './field-parser'; import { ParserOptions } from './parser-options'; @@ -25,9 +26,10 @@ export class DropdownFieldParser extends FieldParser { @Inject(CONFIG_DATA) configData: FormFieldModel, @Inject(INIT_FORM_VALUES) initFormValues, @Inject(PARSER_OPTIONS) parserOptions: ParserOptions, + @Inject(SECURITY_CONFIG) securityConfig: any = null, translate: TranslateService, ) { - super(submissionId, configData, initFormValues, parserOptions, translate); + super(submissionId, configData, initFormValues, parserOptions, securityConfig, translate); } public modelFactory(fieldValue?: FormFieldMetadataValueObject, label?: boolean): any { @@ -35,10 +37,8 @@ export class DropdownFieldParser extends FieldParser { let layout: DynamicFormControlLayout; if (isNotEmpty(this.configData.selectableMetadata[0].controlledVocabulary)) { - this.setVocabularyOptions(dropdownModelConfig); - if (isNotEmpty(fieldValue)) { - dropdownModelConfig.value = fieldValue; - } + this.setVocabularyOptions(dropdownModelConfig, this.parserOptions.collectionUUID); + this.setValues(dropdownModelConfig, fieldValue, true); layout = { element: { control: 'col', diff --git a/src/app/shared/form/builder/parsers/field-parser.ts b/src/app/shared/form/builder/parsers/field-parser.ts index be849852e50..cafe9a10a3b 100644 --- a/src/app/shared/form/builder/parsers/field-parser.ts +++ b/src/app/shared/form/builder/parsers/field-parser.ts @@ -4,6 +4,8 @@ import { } from '@angular/core'; import { FormFieldModel } from '@dspace/core/shared/form/models/form-field.model'; import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; +import { MetadataValue } from '@dspace/core/shared/metadata.models'; +import { Metadata } from '@dspace/core/shared/metadata.utils'; import { RelationshipOptions } from '@dspace/core/shared/relationship-options.model'; import { SectionVisibility } from '@dspace/core/submission/models/section-visibility.model'; import { SubmissionScopeType } from '@dspace/core/submission/submission-scope-type'; @@ -12,6 +14,7 @@ import { VocabularyOptions } from '@dspace/core/submission/vocabularies/models/v import { isNgbDateStruct } from '@dspace/shared/utils/date.util'; import { hasValue, + isEmpty, isNotEmpty, isNotNull, isNotUndefined, @@ -43,6 +46,7 @@ export const PARSER_OPTIONS: InjectionToken = new InjectionToken< * The regex itself is encapsulated inside a `RegExp` object, that will validate the pattern syntax. */ export const REGEX_FIELD_VALIDATOR = new RegExp('(\\/?)(.+)\\1([gimsuy]*)', 'i'); +export const SECURITY_CONFIG: InjectionToken = new InjectionToken('securityConfig'); export abstract class FieldParser { @@ -58,6 +62,7 @@ export abstract class FieldParser { @Inject(CONFIG_DATA) protected configData: FormFieldModel, @Inject(INIT_FORM_VALUES) protected initFormValues: any, @Inject(PARSER_OPTIONS) protected parserOptions: ParserOptions, + @Inject(SECURITY_CONFIG) protected securityConfig: any = null, protected translate: TranslateService, ) { } @@ -68,6 +73,8 @@ export abstract class FieldParser { if (((this.getInitValueCount() > 1 && !this.configData.repeatable) || (this.configData.repeatable)) && (this.configData.input.type !== ParserType.List.valueOf()) && (this.configData.input.type !== ParserType.Tag.valueOf()) + && (this.configData.input.type !== ParserType.RelationGroup.valueOf()) + && (this.configData.input.type !== ParserType.InlineGroup.valueOf()) ) { let arrayCounter = 0; let fieldArrayCounter = 0; @@ -112,9 +119,12 @@ export abstract class FieldParser { } } model = this.modelFactory(fieldValue, false); + if (!this.configData.repeatable) { + this.markAsNotRepeatable(model); + } } setLayout(model, 'element', 'host', 'col'); - if (model.hasLanguages || isNotEmpty(model.relationship)) { + if (model.hasLanguages || isNotEmpty(model.relationship) || model.hasSecurityToggle) { setLayout(model, 'grid', 'control', 'col'); } return [model]; @@ -132,17 +142,19 @@ export abstract class FieldParser { } else { const model = this.modelFactory(this.getInitFieldValue()); model.submissionId = this.submissionId; - if (model.hasLanguages || isNotEmpty(model.relationship)) { + if (model.hasLanguages || isNotEmpty(model.relationship) || model.hasSecurityToggle) { setLayout(model, 'grid', 'control', 'col'); } return model; } } - public setVocabularyOptions(controlModel) { + public setVocabularyOptions(controlModel, scope) { if (isNotEmpty(this.configData.selectableMetadata) && isNotEmpty(this.configData.selectableMetadata[0].controlledVocabulary)) { controlModel.vocabularyOptions = new VocabularyOptions( this.configData.selectableMetadata[0].controlledVocabulary, + this.configData.selectableMetadata[0].metadata, + scope, this.configData.selectableMetadata[0].closed, ); } @@ -164,6 +176,12 @@ export abstract class FieldParser { modelConfig.value = fieldValue; } else if (typeof fieldValue === 'object') { modelConfig.metadataValue = fieldValue; + + // set security level if exists + if (isNotUndefined(fieldValue.securityLevel)) { + modelConfig.securityLevel = fieldValue.securityLevel; + } + modelConfig.language = fieldValue.language; modelConfig.place = fieldValue.place; if (forceValueAsObj) { @@ -183,10 +201,24 @@ export abstract class FieldParser { } } } + this.initSecurityValue(modelConfig); return modelConfig; } + public initSecurityValue(modelConfig: any, forcedValue?: MetadataValue|string) { + // preselect the security level if is not yet selected + // or if the current security level is not available in the current configuration + if ((isEmpty(modelConfig.securityLevel) && isNotEmpty(modelConfig.securityConfigLevel)) || + (isNotEmpty(modelConfig.securityLevel) && isNotEmpty(modelConfig.securityConfigLevel) && !modelConfig.securityConfigLevel.includes(modelConfig.securityLevel) )) { + // take the first element of the securityConfigLevel array when the model config has already a value + // otherwise take the most restricted one + modelConfig.securityLevel = (Metadata.hasValue(modelConfig.value) || Metadata.hasValue(forcedValue)) ? + modelConfig.securityConfigLevel[0] : + modelConfig.securityConfigLevel[modelConfig.securityConfigLevel.length - 1]; + } + } + protected getInitValueCount(index = 0, fieldId?): number { const fieldIds = fieldId || this.getAllFieldIds(); if (isNotEmpty(this.initFormValues) && isNotNull(fieldIds) && fieldIds.length === 1 && this.initFormValues.hasOwnProperty(fieldIds[0])) { @@ -293,6 +325,7 @@ export abstract class FieldParser { // Set read only option controlModel.readOnly = this.parserOptions.readOnly || this.isFieldReadOnly(this.configData.visibility, this.configData.scope, this.parserOptions.submissionScope); controlModel.disabled = controlModel.readOnly; + controlModel.isModelOfInnerForm = this.parserOptions.isInnerForm; if (hasValue(this.configData.selectableRelationship)) { controlModel.relationship = Object.assign(new RelationshipOptions(), this.configData.selectableRelationship); } @@ -326,6 +359,7 @@ export abstract class FieldParser { (controlModel as DsDynamicInputModel).typeBindRelations = getTypeBindRelations(this.configData.typeBind, this.parserOptions.typeField); } + controlModel.securityConfigLevel = this.mapBetweenMetadataRowAndSecurityMetadataLevels(this.getFieldId()); return controlModel; } @@ -390,6 +424,16 @@ export abstract class FieldParser { { required: this.configData.mandatoryMessage }); } + protected markAsNotRepeatable(controlModel) { + controlModel.isModelOfNotRepeatableGroup = true; + controlModel.repeatable = false; + + controlModel.errorMessages = Object.assign( + {}, + controlModel.errorMessages, + { notRepeatable: 'error.validation.notRepeatable' }); + } + protected setLabel(controlModel, label = true, labelEmpty = false) { if (label) { controlModel.label = (labelEmpty) ? ' ' : this.configData.label; @@ -408,5 +452,23 @@ export abstract class FieldParser { }); } } - + mapBetweenMetadataRowAndSecurityMetadataLevels( metadata: string): any { + // look to find security for metadata + if (this.securityConfig && metadata) { + if (this.securityConfig.metadataCustomSecurity) { + const metadataConfig = (this.securityConfig.metadataCustomSecurity as any)[metadata]; + if (metadataConfig) { + return metadataConfig; + } else { + // if not found look at fallback level config + if (this.securityConfig.metadataSecurityDefault !== undefined) { + return this.securityConfig.metadataSecurityDefault; + } else { + // else undefined in order to manage differently from null value + return undefined; + } + } + } + } + } } diff --git a/src/app/shared/form/builder/parsers/list-field-parser.spec.ts b/src/app/shared/form/builder/parsers/list-field-parser.spec.ts index 349574a81e0..6a8ee17fbe3 100644 --- a/src/app/shared/form/builder/parsers/list-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/list-field-parser.spec.ts @@ -18,6 +18,7 @@ describe('ListFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -42,13 +43,13 @@ describe('ListFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof ListFieldParser).toBe(true); }); it('should return a DynamicListCheckboxGroupModel object when repeatable option is true', () => { - const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -57,20 +58,34 @@ describe('ListFieldParser test suite', () => { it('should return a DynamicListRadioGroupModel object when repeatable option is false', () => { field.repeatable = false; - const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); expect(fieldModel instanceof DynamicListRadioGroupModel).toBe(true); }); - it('should set init value properly', () => { + it('should set init value properly when repeatable option is true', () => { initFormValues = { type: [new FormFieldMetadataValueObject('test type')], }; const expectedValue = [new FormFieldMetadataValueObject('test type')]; - const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); + + const fieldModel = parser.parse(); + + expect(fieldModel.value).toEqual(expectedValue); + }); + + it('should set init value properly when repeatable option is false', () => { + field.repeatable = false; + initFormValues = { + type: [new FormFieldMetadataValueObject('test type')], + }; + const expectedValue = new FormFieldMetadataValueObject('test type'); + + const parser = new ListFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); diff --git a/src/app/shared/form/builder/parsers/list-field-parser.ts b/src/app/shared/form/builder/parsers/list-field-parser.ts index 4094f86b164..a3dbb703cb5 100644 --- a/src/app/shared/form/builder/parsers/list-field-parser.ts +++ b/src/app/shared/form/builder/parsers/list-field-parser.ts @@ -24,8 +24,11 @@ export class ListFieldParser extends FieldParser { listModelConfig.value.push(valueObj); } }); + if (!listModelConfig.repeatable) { + listModelConfig.value = listModelConfig.value[0]; + } } - this.setVocabularyOptions(listModelConfig); + this.setVocabularyOptions(listModelConfig, this.parserOptions.collectionUUID); } let listModel; diff --git a/src/app/shared/form/builder/parsers/lookup-field-parser.spec.ts b/src/app/shared/form/builder/parsers/lookup-field-parser.spec.ts index 91aa698adc3..f5e3c7f1bbe 100644 --- a/src/app/shared/form/builder/parsers/lookup-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/lookup-field-parser.spec.ts @@ -17,6 +17,7 @@ describe('LookupFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -41,13 +42,13 @@ describe('LookupFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new LookupFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new LookupFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof LookupFieldParser).toBe(true); }); it('should return a DynamicLookupModel object when repeatable option is false', () => { - const parser = new LookupFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new LookupFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -60,7 +61,7 @@ describe('LookupFieldParser test suite', () => { }; const expectedValue = new FormFieldMetadataValueObject('test journal'); - const parser = new LookupFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new LookupFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); diff --git a/src/app/shared/form/builder/parsers/lookup-field-parser.ts b/src/app/shared/form/builder/parsers/lookup-field-parser.ts index a4c92df0eeb..6e2a48d5333 100644 --- a/src/app/shared/form/builder/parsers/lookup-field-parser.ts +++ b/src/app/shared/form/builder/parsers/lookup-field-parser.ts @@ -12,7 +12,7 @@ export class LookupFieldParser extends FieldParser { if (this.configData.selectableMetadata[0].controlledVocabulary) { const lookupModelConfig: DynamicLookupModelConfig = this.initModel(null, label); - this.setVocabularyOptions(lookupModelConfig); + this.setVocabularyOptions(lookupModelConfig, this.parserOptions.collectionUUID); this.setValues(lookupModelConfig, fieldValue, true); diff --git a/src/app/shared/form/builder/parsers/lookup-name-field-parser.spec.ts b/src/app/shared/form/builder/parsers/lookup-name-field-parser.spec.ts index acc1f6d5c55..205b1510a14 100644 --- a/src/app/shared/form/builder/parsers/lookup-name-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/lookup-name-field-parser.spec.ts @@ -17,6 +17,7 @@ describe('LookupNameFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -41,13 +42,13 @@ describe('LookupNameFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new LookupNameFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new LookupNameFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof LookupNameFieldParser).toBe(true); }); it('should return a DynamicLookupNameModel object when repeatable option is false', () => { - const parser = new LookupNameFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new LookupNameFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -60,7 +61,7 @@ describe('LookupNameFieldParser test suite', () => { }; const expectedValue = new FormFieldMetadataValueObject('test author'); - const parser = new LookupNameFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new LookupNameFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); diff --git a/src/app/shared/form/builder/parsers/lookup-name-field-parser.ts b/src/app/shared/form/builder/parsers/lookup-name-field-parser.ts index 72249ea3550..53bac998c01 100644 --- a/src/app/shared/form/builder/parsers/lookup-name-field-parser.ts +++ b/src/app/shared/form/builder/parsers/lookup-name-field-parser.ts @@ -12,7 +12,7 @@ export class LookupNameFieldParser extends FieldParser { if (this.configData.selectableMetadata[0].controlledVocabulary) { const lookupModelConfig: DynamicLookupNameModelConfig = this.initModel(null, label); - this.setVocabularyOptions(lookupModelConfig); + this.setVocabularyOptions(lookupModelConfig, this.parserOptions.collectionUUID); this.setValues(lookupModelConfig, fieldValue, true); diff --git a/src/app/shared/form/builder/parsers/name-field-parser.spec.ts b/src/app/shared/form/builder/parsers/name-field-parser.spec.ts index ebc37a41245..bf34d982a6d 100644 --- a/src/app/shared/form/builder/parsers/name-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/name-field-parser.spec.ts @@ -19,6 +19,7 @@ describe('NameFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -74,13 +75,13 @@ describe('NameFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new NameFieldParser(submissionId, field1, initFormValues, parserOptions, translateService); + const parser = new NameFieldParser(submissionId, field1, initFormValues, parserOptions, null, translateService); expect(parser instanceof NameFieldParser).toBe(true); }); it('should return a DynamicConcatModel object when repeatable option is false', () => { - const parser = new NameFieldParser(submissionId, field2, initFormValues, parserOptions, translateService); + const parser = new NameFieldParser(submissionId, field2, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -88,7 +89,7 @@ describe('NameFieldParser test suite', () => { }); it('should return a DynamicConcatModel object with the correct separator', () => { - const parser = new NameFieldParser(submissionId, field2, initFormValues, parserOptions, translateService); + const parser = new NameFieldParser(submissionId, field2, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -99,9 +100,9 @@ describe('NameFieldParser test suite', () => { initFormValues = { name: [new FormFieldMetadataValueObject('test, name')], }; - const expectedValue = new FormFieldMetadataValueObject('test, name', undefined, undefined, 'test'); + const expectedValue = new FormFieldMetadataValueObject('test, name', null, null, null, 'test'); - const parser = new NameFieldParser(submissionId, field1, initFormValues, parserOptions, translateService); + const parser = new NameFieldParser(submissionId, field1, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); diff --git a/src/app/shared/form/builder/parsers/name-field-parser.ts b/src/app/shared/form/builder/parsers/name-field-parser.ts index ce278b19293..4e9aabfc114 100644 --- a/src/app/shared/form/builder/parsers/name-field-parser.ts +++ b/src/app/shared/form/builder/parsers/name-field-parser.ts @@ -7,6 +7,7 @@ import { CONFIG_DATA, INIT_FORM_VALUES, PARSER_OPTIONS, + SECURITY_CONFIG, SUBMISSION_ID, } from './field-parser'; import { ParserOptions } from './parser-options'; @@ -18,8 +19,9 @@ export class NameFieldParser extends ConcatFieldParser { @Inject(CONFIG_DATA) configData: FormFieldModel, @Inject(INIT_FORM_VALUES) initFormValues, @Inject(PARSER_OPTIONS) parserOptions: ParserOptions, + @Inject(SECURITY_CONFIG) securityConfig: any = null, translate: TranslateService, ) { - super(submissionId, configData, initFormValues, parserOptions, translate, ',', 'form.last-name', 'form.first-name'); + super(submissionId, configData, initFormValues, parserOptions, securityConfig, translate, ',', 'form.last-name', 'form.first-name'); } } diff --git a/src/app/shared/form/builder/parsers/onebox-field-parser.spec.ts b/src/app/shared/form/builder/parsers/onebox-field-parser.spec.ts index 31b456c5bc3..efdba9abd96 100644 --- a/src/app/shared/form/builder/parsers/onebox-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/onebox-field-parser.spec.ts @@ -21,6 +21,7 @@ describe('OneboxFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -76,13 +77,13 @@ describe('OneboxFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new OneboxFieldParser(submissionId, field1, initFormValues, parserOptions, translateService); + const parser = new OneboxFieldParser(submissionId, field1, initFormValues, parserOptions, null, translateService); expect(parser instanceof OneboxFieldParser).toBe(true); }); it('should return a DynamicQualdropModel object when selectableMetadata is multiple', () => { - const parser = new OneboxFieldParser(submissionId, field2, initFormValues, parserOptions, translateService); + const parser = new OneboxFieldParser(submissionId, field2, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -90,7 +91,7 @@ describe('OneboxFieldParser test suite', () => { }); it('should return a DsDynamicInputModel object when selectableMetadata is not multiple', () => { - const parser = new OneboxFieldParser(submissionId, field3, initFormValues, parserOptions, translateService); + const parser = new OneboxFieldParser(submissionId, field3, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -98,7 +99,7 @@ describe('OneboxFieldParser test suite', () => { }); it('should return a DynamicOneboxModel object when selectableMetadata has authority', () => { - const parser = new OneboxFieldParser(submissionId, field1, initFormValues, parserOptions, translateService); + const parser = new OneboxFieldParser(submissionId, field1, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -127,7 +128,7 @@ describe('OneboxFieldParser test suite', () => { languageCodes: [], } as FormFieldModel; - parser = new OneboxFieldParser(submissionId, regexField, initFormValues, parserOptions, translateService); + parser = new OneboxFieldParser(submissionId, regexField, initFormValues, parserOptions, null, translateService); fieldModel = parser.parse(); }); diff --git a/src/app/shared/form/builder/parsers/onebox-field-parser.ts b/src/app/shared/form/builder/parsers/onebox-field-parser.ts index 16e0b30b44a..7cf25e99c79 100644 --- a/src/app/shared/form/builder/parsers/onebox-field-parser.ts +++ b/src/app/shared/form/builder/parsers/onebox-field-parser.ts @@ -78,14 +78,14 @@ export class OneboxFieldParser extends FieldParser { } selectModelConfig.disabled = inputModelConfig.readOnly; inputSelectGroup.readOnly = selectModelConfig.disabled && inputModelConfig.readOnly; - + inputSelectGroup.language = inputModelConfig.language; inputSelectGroup.group.push(new DynamicSelectModel(selectModelConfig, clsSelect)); inputSelectGroup.group.push(new DsDynamicInputModel(inputModelConfig, clsInput)); return new DynamicQualdropModel(inputSelectGroup, clsGroup); } else if (this.configData.selectableMetadata[0].controlledVocabulary) { const oneboxModelConfig: DsDynamicOneboxModelConfig = this.initModel(null, label); - this.setVocabularyOptions(oneboxModelConfig); + this.setVocabularyOptions(oneboxModelConfig, this.parserOptions.collectionUUID); this.setValues(oneboxModelConfig, fieldValue, true); return new DynamicOneboxModel(oneboxModelConfig); diff --git a/src/app/shared/form/builder/parsers/parser-factory.ts b/src/app/shared/form/builder/parsers/parser-factory.ts index a56a27d77f7..2c6d5a1a9d7 100644 --- a/src/app/shared/form/builder/parsers/parser-factory.ts +++ b/src/app/shared/form/builder/parsers/parser-factory.ts @@ -9,6 +9,7 @@ import { FieldParser, INIT_FORM_VALUES, PARSER_OPTIONS, + SECURITY_CONFIG, SUBMISSION_ID, } from './field-parser'; import { ListFieldParser } from './list-field-parser'; @@ -27,6 +28,7 @@ const fieldParserDeps = [ CONFIG_DATA, INIT_FORM_VALUES, PARSER_OPTIONS, + SECURITY_CONFIG, TranslateService, ]; @@ -50,7 +52,8 @@ export class ParserFactory { deps: [...fieldParserDeps], }; } - case ParserType.RelationGroup: { + case ParserType.RelationGroup: + case ParserType.InlineGroup: { return { provide: FieldParser, useClass: RelationGroupFieldParser, diff --git a/src/app/shared/form/builder/parsers/parser-options.ts b/src/app/shared/form/builder/parsers/parser-options.ts index f7aac3449d7..15e578a0846 100644 --- a/src/app/shared/form/builder/parsers/parser-options.ts +++ b/src/app/shared/form/builder/parsers/parser-options.ts @@ -3,4 +3,5 @@ export interface ParserOptions { submissionScope: string; collectionUUID: string; typeField: string; + isInnerForm: boolean; } diff --git a/src/app/shared/form/builder/parsers/parser-type.ts b/src/app/shared/form/builder/parsers/parser-type.ts index f43d4654a0f..fb24286405c 100644 --- a/src/app/shared/form/builder/parsers/parser-type.ts +++ b/src/app/shared/form/builder/parsers/parser-type.ts @@ -2,6 +2,7 @@ export enum ParserType { Date = 'date', Dropdown = 'dropdown', RelationGroup = 'group', + InlineGroup = 'inline-group', List = 'list', Lookup = 'lookup', LookupName = 'lookup-name', diff --git a/src/app/shared/form/builder/parsers/relation-group-field-parser.spec.ts b/src/app/shared/form/builder/parsers/relation-group-field-parser.spec.ts index 53b0342c001..3faffd7150f 100644 --- a/src/app/shared/form/builder/parsers/relation-group-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/relation-group-field-parser.spec.ts @@ -8,6 +8,7 @@ import { RelationGroupFieldParser } from './relation-group-field-parser'; describe('RelationGroupFieldParser test suite', () => { let field: FormFieldModel; + let inLineField: FormFieldModel; let initFormValues = {}; let translateService = getMockTranslateService(); @@ -17,6 +18,7 @@ describe('RelationGroupFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: 'WORKSPACE', typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -75,23 +77,40 @@ describe('RelationGroupFieldParser test suite', () => { }); + afterEach(() => { + field = null; + inLineField = null; + }); + it('should init parser properly', () => { - const parser = new RelationGroupFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new RelationGroupFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof RelationGroupFieldParser).toBe(true); }); it('should return a DynamicRelationGroupModel object', () => { - const parser = new RelationGroupFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new RelationGroupFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); + + const fieldModel = parser.parse(); + + expect(fieldModel instanceof DynamicRelationGroupModel).toBe(true); + expect(fieldModel.isInlineGroup).toBe(false); + }); + + it('should return a DynamicRelationGroupModel object when has a inline group', () => { + inLineField = Object.assign({}, field); + inLineField.input.type = 'inline-group'; + const parser = new RelationGroupFieldParser(submissionId, inLineField, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); expect(fieldModel instanceof DynamicRelationGroupModel).toBe(true); + expect(fieldModel.isInlineGroup).toBe(true); }); it('should throw when rows configuration is empty', () => { field.rows = null; - const parser = new RelationGroupFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new RelationGroupFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(() => parser.parse()) .toThrow(); @@ -102,7 +121,7 @@ describe('RelationGroupFieldParser test suite', () => { author: [new FormFieldMetadataValueObject('test author')], affiliation: [new FormFieldMetadataValueObject('test affiliation')], }; - const parser = new RelationGroupFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new RelationGroupFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); const expectedValue = [{ diff --git a/src/app/shared/form/builder/parsers/relation-group-field-parser.ts b/src/app/shared/form/builder/parsers/relation-group-field-parser.ts index 1081bdeb157..ff890276fb9 100644 --- a/src/app/shared/form/builder/parsers/relation-group-field-parser.ts +++ b/src/app/shared/form/builder/parsers/relation-group-field-parser.ts @@ -9,6 +9,7 @@ import { DynamicRelationGroupModelConfig, } from '../ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.model'; import { FieldParser } from './field-parser'; +import { ParserType } from './parser-type'; export class RelationGroupFieldParser extends FieldParser { @@ -18,6 +19,7 @@ export class RelationGroupFieldParser extends FieldParser { modelConfiguration.submissionId = this.submissionId; modelConfiguration.scopeUUID = this.parserOptions.collectionUUID; modelConfiguration.submissionScope = this.parserOptions.submissionScope; + this.setVocabularyOptions(modelConfiguration, this.parserOptions.collectionUUID); if (this.configData && this.configData.rows && this.configData.rows.length > 0) { modelConfiguration.formConfiguration = this.configData.rows; modelConfiguration.relationFields = []; @@ -58,6 +60,8 @@ export class RelationGroupFieldParser extends FieldParser { const model = new DynamicRelationGroupModel(modelConfiguration, cls); model.name = this.getFieldId(); + model.isInlineGroup = (this.configData.input.type === ParserType.InlineGroup.toString()); + return model; } diff --git a/src/app/shared/form/builder/parsers/row-parser.spec.ts b/src/app/shared/form/builder/parsers/row-parser.spec.ts index ef3b1545c46..62266b0a1f9 100644 --- a/src/app/shared/form/builder/parsers/row-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/row-parser.spec.ts @@ -1,6 +1,7 @@ import { Injector } from '@angular/core'; import { FormRowModel } from '@dspace/core/config/models/config-submission-form.model'; import { FormFieldModel } from '@dspace/core/shared/form/models/form-field.model'; +import { SubmissionScopeType } from '@dspace/core/submission/submission-scope-type'; import { getMockTranslateService } from '@dspace/core/testing/translate.service.mock'; import { TranslateService } from '@ngx-translate/core'; @@ -25,7 +26,7 @@ describe('RowParser test suite', () => { const submissionId = '1234'; const scopeUUID = 'testScopeUUID'; const initFormValues = {}; - const submissionScope = 'WORKSPACE'; + const submissionScope = SubmissionScopeType.WorkspaceItem; const readOnly = false; const typeField = 'dc_type'; @@ -127,7 +128,7 @@ describe('RowParser test suite', () => { mandatory: 'false', repeatable: false, hints: 'Enter the name of the events, if any.', - scope: 'WORKFLOW', + scope: SubmissionScopeType.WorkflowItem, selectableMetadata: [ { metadata: 'otherTitle', diff --git a/src/app/shared/form/builder/parsers/row-parser.ts b/src/app/shared/form/builder/parsers/row-parser.ts index 3bc73caa2d2..f19e1e6216b 100644 --- a/src/app/shared/form/builder/parsers/row-parser.ts +++ b/src/app/shared/form/builder/parsers/row-parser.ts @@ -23,6 +23,7 @@ import { FieldParser, INIT_FORM_VALUES, PARSER_OPTIONS, + SECURITY_CONFIG, SUBMISSION_ID, } from './field-parser'; import { setLayout } from './parser.utils'; @@ -49,7 +50,9 @@ export class RowParser { initFormValues: any, submissionScope, readOnly: boolean, - typeField: string): DynamicRowGroupModel { + typeField: string, + isInnerForm: boolean = false, + securityConfig: any = null): DynamicRowGroupModel { let fieldModel: any = null; let parsedResult = null; const config: DynamicFormGroupModelConfig = { @@ -67,6 +70,7 @@ export class RowParser { submissionScope: submissionScope, collectionUUID: scopeUUID, typeField: typeField, + isInnerForm: isInnerForm, }; // Iterate over row's fields @@ -82,6 +86,7 @@ export class RowParser { { provide: CONFIG_DATA, useValue: fieldData }, { provide: INIT_FORM_VALUES, useValue: initFormValues }, { provide: PARSER_OPTIONS, useValue: parserOptions }, + { provide: SECURITY_CONFIG, useValue: securityConfig }, ], parent: this.parentInjector, }); diff --git a/src/app/shared/form/builder/parsers/series-field-parser.spec.ts b/src/app/shared/form/builder/parsers/series-field-parser.spec.ts index 2b627399064..b4df7fbea39 100644 --- a/src/app/shared/form/builder/parsers/series-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/series-field-parser.spec.ts @@ -17,6 +17,7 @@ describe('SeriesFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -37,13 +38,13 @@ describe('SeriesFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new SeriesFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new SeriesFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof SeriesFieldParser).toBe(true); }); it('should return a DynamicConcatModel object when repeatable option is false', () => { - const parser = new SeriesFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new SeriesFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -51,7 +52,7 @@ describe('SeriesFieldParser test suite', () => { }); it('should return a DynamicConcatModel object with the correct separator', () => { - const parser = new SeriesFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new SeriesFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -62,9 +63,9 @@ describe('SeriesFieldParser test suite', () => { initFormValues = { series: [new FormFieldMetadataValueObject('test; series')], }; - const expectedValue = new FormFieldMetadataValueObject('test; series', undefined, undefined, 'test'); + const expectedValue = new FormFieldMetadataValueObject('test; series', undefined, null, null, 'test'); - const parser = new SeriesFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new SeriesFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); diff --git a/src/app/shared/form/builder/parsers/series-field-parser.ts b/src/app/shared/form/builder/parsers/series-field-parser.ts index 5b6bec76eb9..5657b7fcc3d 100644 --- a/src/app/shared/form/builder/parsers/series-field-parser.ts +++ b/src/app/shared/form/builder/parsers/series-field-parser.ts @@ -7,6 +7,7 @@ import { CONFIG_DATA, INIT_FORM_VALUES, PARSER_OPTIONS, + SECURITY_CONFIG, SUBMISSION_ID, } from './field-parser'; import { ParserOptions } from './parser-options'; @@ -18,8 +19,9 @@ export class SeriesFieldParser extends ConcatFieldParser { @Inject(CONFIG_DATA) configData: FormFieldModel, @Inject(INIT_FORM_VALUES) initFormValues, @Inject(PARSER_OPTIONS) parserOptions: ParserOptions, + @Inject(SECURITY_CONFIG) securityConfig: any = null, translate: TranslateService, ) { - super(submissionId, configData, initFormValues, parserOptions, translate, ';'); + super(submissionId, configData, initFormValues, parserOptions, securityConfig, translate, ';'); } } diff --git a/src/app/shared/form/builder/parsers/tag-field-parser.spec.ts b/src/app/shared/form/builder/parsers/tag-field-parser.spec.ts index 7b9aec3f2f1..632c1cc396a 100644 --- a/src/app/shared/form/builder/parsers/tag-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/tag-field-parser.spec.ts @@ -17,6 +17,7 @@ describe('TagFieldParser test suite', () => { submissionScope: 'testScopeUUID', collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -41,13 +42,13 @@ describe('TagFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new TagFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new TagFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof TagFieldParser).toBe(true); }); it('should return a DynamicTagModel object when repeatable option is false', () => { - const parser = new TagFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new TagFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -62,7 +63,7 @@ describe('TagFieldParser test suite', () => { ], }; - const parser = new TagFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new TagFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); diff --git a/src/app/shared/form/builder/parsers/tag-field-parser.ts b/src/app/shared/form/builder/parsers/tag-field-parser.ts index d782af1c143..7cead0de898 100644 --- a/src/app/shared/form/builder/parsers/tag-field-parser.ts +++ b/src/app/shared/form/builder/parsers/tag-field-parser.ts @@ -12,7 +12,7 @@ export class TagFieldParser extends FieldParser { const tagModelConfig: DynamicTagModelConfig = this.initModel(null, label); if (this.configData.selectableMetadata[0].controlledVocabulary && this.configData.selectableMetadata[0].controlledVocabulary.length > 0) { - this.setVocabularyOptions(tagModelConfig); + this.setVocabularyOptions(tagModelConfig, this.parserOptions.collectionUUID); } this.setValues(tagModelConfig, fieldValue, null, true); diff --git a/src/app/shared/form/builder/parsers/textarea-field-parser.spec.ts b/src/app/shared/form/builder/parsers/textarea-field-parser.spec.ts index 4ebff94be6d..3bfc0c25413 100644 --- a/src/app/shared/form/builder/parsers/textarea-field-parser.spec.ts +++ b/src/app/shared/form/builder/parsers/textarea-field-parser.spec.ts @@ -17,6 +17,7 @@ describe('TextareaFieldParser test suite', () => { submissionScope: null, collectionUUID: null, typeField: 'dc_type', + isInnerForm: false, }; beforeEach(() => { @@ -39,13 +40,13 @@ describe('TextareaFieldParser test suite', () => { }); it('should init parser properly', () => { - const parser = new TextareaFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new TextareaFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); expect(parser instanceof TextareaFieldParser).toBe(true); }); it('should return a DsDynamicTextAreaModel object when repeatable option is false', () => { - const parser = new TextareaFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new TextareaFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); @@ -60,7 +61,7 @@ describe('TextareaFieldParser test suite', () => { }; const expectedValue = 'test description'; - const parser = new TextareaFieldParser(submissionId, field, initFormValues, parserOptions, translateService); + const parser = new TextareaFieldParser(submissionId, field, initFormValues, parserOptions, null, translateService); const fieldModel = parser.parse(); diff --git a/src/app/shared/form/chips/chips.component.spec.ts b/src/app/shared/form/chips/chips.component.spec.ts index 30590e6ea02..64b6d817bde 100644 --- a/src/app/shared/form/chips/chips.component.spec.ts +++ b/src/app/shared/form/chips/chips.component.spec.ts @@ -153,8 +153,8 @@ describe('ChipsComponent test suite', () => { describe('when has items as object', () => { beforeEach(() => { const item = { - mainField: new FormFieldMetadataValueObject('main test', null, 'test001', 'main test', 0, ConfidenceType.CF_ACCEPTED), - relatedField: new FormFieldMetadataValueObject('related test', null, 'test002', 'related test', 0, ConfidenceType.CF_ACCEPTED), + mainField: new FormFieldMetadataValueObject('main test', null, null, 'test001', 'main test', 0, ConfidenceType.CF_ACCEPTED), + relatedField: new FormFieldMetadataValueObject('related test', null, null, 'test002', 'related test', 0, ConfidenceType.CF_ACCEPTED), otherRelatedField: new FormFieldMetadataValueObject('other related test'), }; diff --git a/src/app/shared/form/chips/models/chips.model.ts b/src/app/shared/form/chips/models/chips.model.ts index 30541a5a051..b18b5d1fa8b 100644 --- a/src/app/shared/form/chips/models/chips.model.ts +++ b/src/app/shared/form/chips/models/chips.model.ts @@ -10,6 +10,7 @@ import findIndex from 'lodash/findIndex'; import isEqual from 'lodash/isEqual'; import isObject from 'lodash/isObject'; import { BehaviorSubject } from 'rxjs'; +import { environment } from 'src/environments/environment'; import { ChipsItem } from './chips-item.model'; @@ -18,6 +19,7 @@ export class Chips { displayField: string; displayObj: string; iconsConfig: MetadataIconConfig[]; + triggerUpdate = false; private _items: ChipsItem[]; @@ -114,6 +116,8 @@ export class Chips { const defaultConfigIndex: number = findIndex(this.iconsConfig, { name: 'default' }); const defaultConfig: MetadataIconConfig = (defaultConfigIndex !== -1) ? this.iconsConfig[defaultConfigIndex] : undefined; + const iconsVisibleWithNoAuthority = environment.submission.icons.iconsVisibleWithNoAuthority ?? []; + let config: MetadataIconConfig; let configIndex: number; let value: any; @@ -127,7 +131,7 @@ export class Chips { config = (configIndex !== -1) ? this.iconsConfig[configIndex] : defaultConfig; if (hasValue(value) && isNotEmpty(config) && !this.hasPlaceholder(value)) { - const visibleWhenAuthorityEmpty = this.displayObj !== metadata; + const visibleWhenAuthorityEmpty = this.displayObj !== metadata || (iconsVisibleWithNoAuthority.includes(config.style)); // Set icon const icon = { diff --git a/src/app/shared/form/form.component.html b/src/app/shared/form/form.component.html index 304f2cf14c6..bc75c403d15 100644 --- a/src/app/shared/form/form.component.html +++ b/src/app/shared/form/form.component.html @@ -15,6 +15,8 @@ @if ((!context.notRepeatable) && !isVirtual(context, index) && group.context.groups.length !== 1 && !isItemReadOnly(context, index)) {
    + @if (isInlineGroupForm) { +
    + } +
    + } + @if ((!context.notRepeatable) && isInlineGroupForm) { +
    +
    + +
    } @if ((!context.notRepeatable) && index === (group.context.groups.length - 1) && !isItemReadOnly(context, index)) { -
    +
    @@ -49,6 +71,10 @@ [dsBtnDisabled]="group.context.groups.length === 1 || isItemReadOnly(context, index)"> {{'form.discard' | translate}} + @if (isInlineGroupForm) { +
    + } +
    } diff --git a/src/app/shared/form/form.component.scss b/src/app/shared/form/form.component.scss index 6483553b5a8..828a29be1c8 100644 --- a/src/app/shared/form/form.component.scss +++ b/src/app/shared/form/form.component.scss @@ -56,3 +56,13 @@ select.form-control { padding-left: 15px; padding-right: 15px; } + +.isInlineGroupForm-delete { + margin-bottom: -2.5rem; + z-index: var(--ds-submission-inline-group-form-delete-z-index); + padding-right: calc(0.5 * var(--bs-spacer)); +} + +.white-background{ + background-color: #fff; +} diff --git a/src/app/shared/form/form.component.ts b/src/app/shared/form/form.component.ts index 0ec572a6f98..95ec0fe757a 100644 --- a/src/app/shared/form/form.component.ts +++ b/src/app/shared/form/form.component.ts @@ -1,4 +1,7 @@ -import { AsyncPipe } from '@angular/common'; +import { + AsyncPipe, + NgClass, +} from '@angular/common'; import { ChangeDetectorRef, Component, @@ -10,6 +13,8 @@ import { } from '@angular/core'; import { AbstractControl, + FormArray, + FormControl, ReactiveFormsModule, UntypedFormArray, UntypedFormControl, @@ -24,6 +29,7 @@ import { } from '@dspace/shared/utils/empty.util'; import { NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; import { + DynamicFormArrayGroupModel, DynamicFormArrayModel, DynamicFormControlEvent, DynamicFormControlModel, @@ -32,7 +38,9 @@ import { DynamicFormsCoreModule, } from '@ng-dynamic-forms/core'; import { TranslateModule } from '@ngx-translate/core'; +import cloneDeep from 'lodash/cloneDeep'; import findIndex from 'lodash/findIndex'; +import isEqual from 'lodash/isEqual'; import { Observable, Subscription, @@ -45,6 +53,10 @@ import { import { BtnDisabledDirective } from '../btn-disabled.directive'; import { DsDynamicFormComponent } from './builder/ds-dynamic-form-ui/ds-dynamic-form.component'; +import { DynamicConcatModel } from './builder/ds-dynamic-form-ui/models/ds-dynamic-concat.model'; +import { DynamicRowGroupModel } from './builder/ds-dynamic-form-ui/models/ds-dynamic-row-group-model'; +import { DynamicRelationGroupModel } from './builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.model'; +import { DynamicScrollableDropdownModel } from './builder/ds-dynamic-form-ui/models/scrollable-dropdown/dynamic-scrollable-dropdown.model'; import { FormBuilderService } from './builder/form-builder.service'; import { FormEntry, @@ -52,6 +64,10 @@ import { } from './form.reducer'; import { FormService } from './form.service'; +export interface MetadataFields { + [key: string]: FormFieldMetadataValueObject[] +} + /** * The default form component. */ @@ -65,6 +81,7 @@ import { FormService } from './form.service'; BtnDisabledDirective, DsDynamicFormComponent, DynamicFormsCoreModule, + NgClass, ReactiveFormsModule, TranslateModule, ], @@ -108,9 +125,11 @@ export class FormComponent implements OnDestroy, OnInit { * An array of DynamicFormControlModel type */ @Input() formModel: DynamicFormControlModel[]; - @Input() parentFormModel: DynamicFormGroupModel | DynamicFormGroupModel[]; + @Input() parentFormModel: DynamicRowGroupModel | DynamicFormGroupModel | DynamicFormGroupModel[]; @Input() formGroup: UntypedFormGroup; @Input() formLayout = null as DynamicFormLayout; + @Input() arrayButtonsStyle: string; + @Input() isInlineGroupForm: boolean; /* eslint-disable @angular-eslint/no-output-rename */ @Output('dfBlur') blur: EventEmitter = new EventEmitter(); @@ -176,7 +195,7 @@ export class FormComponent implements OnDestroy, OnInit { } private getFormGroupValidStatus() { - return this.getFormGroup().valid; + return this.getFormGroup().valid || this.getFormGroup().disabled; } /** @@ -185,6 +204,7 @@ export class FormComponent implements OnDestroy, OnInit { ngOnInit() { if (!this.formGroup) { this.formGroup = this.formBuilderService.createFormGroup(this.formModel); + this.formBuilderService.addFormGroups(this.formId, this.formGroup); } else { this.formModel.forEach((model) => { @@ -196,8 +216,7 @@ export class FormComponent implements OnDestroy, OnInit { this.formService.initForm(this.formId, this.formModel, this.getFormGroupValidStatus()); - // TODO: take a look to the following method: - // this.keepSync(); + this.keepSync(); this.formValid = this.getFormGroupValidStatus(); @@ -231,7 +250,8 @@ export class FormComponent implements OnDestroy, OnInit { } if (field) { - const model: DynamicFormControlModel = this.formBuilderService.findById(fieldId, formModel, fieldIndex); + const modelArrayIndex = fieldIndex > 0 ? fieldIndex : null; + const model: DynamicFormControlModel = this.formBuilderService.findById(fieldId, formModel, modelArrayIndex); this.formService.addErrorToField(field, model, error.message); this.changeDetectorRef.detectChanges(); @@ -272,6 +292,7 @@ export class FormComponent implements OnDestroy, OnInit { .filter((sub) => hasValue(sub)) .forEach((sub) => sub.unsubscribe()); this.formService.removeForm(this.formId); + this.formBuilderService.removeFormGroup(this.formId); } /** @@ -287,9 +308,7 @@ export class FormComponent implements OnDestroy, OnInit { private keepSync(): void { this.subs.push(this.formService.getFormData(this.formId) .subscribe((stateFormData) => { - if (!Object.is(stateFormData, this.formGroup.value) && this.formGroup) { - this.formGroup.setValue(stateFormData); - } + this.updateMetadataValue(stateFormData); })); } @@ -305,7 +324,20 @@ export class FormComponent implements OnDestroy, OnInit { } onCustomEvent(event: any) { - this.customEvent.emit(event); + if (event?.type === 'authorityEnrichment') { + event.$event.updatedModels.forEach((model) => { + const control: FormControl = this.formBuilderService.getFormControlByModel(this.formGroup, model) as FormControl; + if (control) { + const changeEvent = this.formBuilderService.createDynamicFormControlEvent(control, control.parent as UntypedFormGroup, model, 'change'); + if (model instanceof DynamicRelationGroupModel) { + control.setValue(model.value); + } + this.onChange(changeEvent); + } + }); + } else { + this.customEvent.emit(event); + } } onFocus(event: DynamicFormControlEvent): void { @@ -357,11 +389,34 @@ export class FormComponent implements OnDestroy, OnInit { removeItem($event, arrayContext: DynamicFormArrayModel, index: number): void { const formArrayControl = this.formGroup.get(this.formBuilderService.getPath(arrayContext)) as UntypedFormArray; const event = this.getEvent($event, arrayContext, index, 'remove'); - if (this.formBuilderService.isQualdropGroup(event.model as DynamicFormControlModel) && hasValue((event.model as any)?.value)) { - // In case of qualdrop value remove event must be dispatched before removing the control from array + if ((this.formBuilderService.isQualdropGroup(event.model as DynamicFormControlModel) && hasValue((event.model as any)?.value)) || this.isInlineGroupForm) { + // In case of qualdrop value or inline-group remove event must be dispatched before removing the control from array this.removeArrayItem.emit(event); } - this.formBuilderService.removeFormArrayGroup(index, formArrayControl, arrayContext); + if (index === 0 && formArrayControl.value?.length === 1) { + event.model = cloneDeep(event.model); + const fieldId = event.model.id; + + if (event.model instanceof DynamicConcatModel) { + formArrayControl.at(0).get(fieldId).reset(); + } else { + formArrayControl.at(0).get(fieldId).setValue(null); + } + } else { + this.formBuilderService.removeFormArrayGroup(index, formArrayControl, arrayContext); + } + + this.formService.changeForm(this.formId, this.formModel); + if (!this.formBuilderService.isQualdropGroup(event.model as DynamicFormControlModel) && !this.isInlineGroupForm) { + // dispatch remove event for any field type except for qualdrop value and inline-group + this.removeArrayItem.emit(event); + } + } + + clearScrollableDropdown($event, model: DynamicFormControlModel): void { + const control = this.formGroup.get(this.formBuilderService.getPath(model)) as FormControl; + const event = { $event, type: 'remove', model: cloneDeep(model), context: null, control, group: control.parent } as DynamicFormControlEvent; + control.setValue(null); this.formService.changeForm(this.formId, this.formModel); if (!this.formBuilderService.isQualdropGroup(event.model as DynamicFormControlModel)) { // dispatch remove event for any field type except for qualdrop value @@ -376,16 +431,33 @@ export class FormComponent implements OnDestroy, OnInit { this.formService.changeForm(this.formId, this.formModel); } + copyItem($event, arrayContext: DynamicFormArrayModel, index: number): void { + const formArrayControl = this.formGroup.get(this.formBuilderService.getPath(arrayContext)) as FormArray; + const newFormGroup = this.formBuilderService.copyFormArrayGroup(index, formArrayControl, arrayContext); + this.customEvent.emit(this.getEvent($event, arrayContext, index + 1, 'copy', newFormGroup)); + this.formService.changeForm(this.formId, this.formModel); + this.formGroup.markAsPristine(); + } + + isVirtual(arrayContext: DynamicFormArrayModel, index: number) { const context = arrayContext.groups[index]; const value: FormFieldMetadataValueObject = (context.group[0] as any).metadataValue; return isNotEmpty(value) && value.isVirtual; } - protected getEvent($event: any, arrayContext: DynamicFormArrayModel, index: number, type: string): DynamicFormControlEvent { + isArrayGroupEmpty(group): boolean { + return group.context.groups?.length <= 1 && !group.context.groups?.[0]?.group?.[0]?.value; + } + + isTheOnlyFieldInArrayGroup(model: DynamicScrollableDropdownModel) { + return model.parent instanceof DynamicFormArrayGroupModel && model.parent?.group?.length === 1; + } + + protected getEvent($event: any, arrayContext: DynamicFormArrayModel, index: number, type: string, formGroup?: UntypedFormGroup): DynamicFormControlEvent { const context = arrayContext.groups[index]; const itemGroupModel = context.context; - let group = this.formGroup.get(itemGroupModel.id) as UntypedFormGroup; + let group = (formGroup) ? formGroup : this.formGroup.get(itemGroupModel.id) as UntypedFormGroup; if (isNull(group)) { for (const key of Object.keys(this.formGroup.controls)) { group = this.formGroup.controls[key].get(itemGroupModel.id) as UntypedFormGroup; @@ -398,4 +470,32 @@ export class FormComponent implements OnDestroy, OnInit { const control = group.controls[index] as UntypedFormControl; return { $event, context, control, group, model, type }; } + + private updateMetadataValue(metadataFields: MetadataFields): void { + const metadataKeys = hasValue(metadataFields) ? Object.keys(metadataFields) : []; + const formKeys = hasValue(this.formGroup.value) ? Object.keys(this.formGroup.value).map(key => key.replace('_array', '')) : []; + + formKeys + .filter((key) => isNotEmpty(this.formGroup.value[key])) + .forEach((key) => { + const innerObjectKeys = (Object.keys(this.formGroup.value[key] ?? {} ) as any[]).map((oldKey) => oldKey.replaceAll('_', '.')); + const filteredKeys = innerObjectKeys.filter(innerKey => metadataKeys.includes(innerKey)); + const oldValue = this.formGroup.value[key]; + + if (filteredKeys.length > 0) { + filteredKeys.forEach((oldValueKey) => { + const newValue = { ...oldValue }; + const formattedKey = (oldValueKey as any).replaceAll('.', '_'); + const patchValue = {}; + + newValue[formattedKey] = metadataFields[oldValueKey][0]; + patchValue[key] = newValue; + + if (!isEqual(oldValue[oldValueKey], newValue[oldValueKey])) { + this.formGroup.patchValue(patchValue); + } + }); + } + }); + } } diff --git a/src/app/shared/form/form.service.spec.ts b/src/app/shared/form/form.service.spec.ts index 81ca2ba074e..907f9bb3955 100644 --- a/src/app/shared/form/form.service.spec.ts +++ b/src/app/shared/form/form.service.spec.ts @@ -5,6 +5,7 @@ import { } from '@angular/core/testing'; import { AbstractControl, + FormControl, UntypedFormControl, UntypedFormGroup, Validators, @@ -20,6 +21,7 @@ import { } from '@ngrx/store'; import { AppState } from '../../app.reducer'; +import { DynamicConcatModel } from './builder/ds-dynamic-form-ui/models/ds-dynamic-concat.model'; import { FormBuilderService } from './builder/form-builder.service'; import { formReducer } from './form.reducer'; import { FormService } from './form.service'; @@ -76,6 +78,14 @@ describe('FormService test suite', () => { }), ], }), + new DynamicConcatModel({ + id: 'name_CONCAT_GROUP', + separator: ',', + group: [ + new DynamicInputModel({ id: 'name_CONCAT_FIRST_INPUT' }), + new DynamicInputModel({ id: 'name_CONCAT_SECOND_INPUT' }), + ], + } as any), ]; let controls; @@ -130,8 +140,13 @@ describe('FormService test suite', () => { city: new UntypedFormControl(undefined), }); - formGroup = new UntypedFormGroup({ author, title, date, description, addressLocation }); - controls = { author, title, date, description , addressLocation }; + const name: UntypedFormGroup = new UntypedFormGroup({ + name_CONCAT_FIRST_INPUT: new FormControl(undefined), + name_CONCAT_SECOND_INPUT: new FormControl(undefined), + }); + + formGroup = new UntypedFormGroup({ author, title, date, description, addressLocation, name }); + controls = { author, title, date, description , addressLocation, name }; service = new FormService(builderService, store); }), ) @@ -260,8 +275,8 @@ describe('FormService test suite', () => { it('should remove errors from fields of concat group', () => { (builderService as any).isConcatGroup.and.returnValue(true); - let control = controls.addressLocation; - let model = formModel.find((mdl: DynamicFormControlModel) => mdl.id === 'addressLocation'); + let control = controls.name; + let model = formModel.find((mdl: DynamicFormControlModel) => mdl.id === 'name_CONCAT_GROUP'); let errorKeys: string[]; service.addErrorToField(control, model, 'Test error message'); @@ -276,10 +291,7 @@ describe('FormService test suite', () => { // the group's inputs should no longer have an error Object.values(control.controls).forEach((subControl: AbstractControl) => { - errorKeys = Object.keys(subControl.errors); - expect(errorKeys.length).toBe(1); - expect(subControl.hasError(errorKeys[0])).toBe(false); - expect(subControl.touched).toBe(false); + expect(subControl.errors).toBeNull(); }); }); diff --git a/src/app/shared/form/form.service.ts b/src/app/shared/form/form.service.ts index 2878bafc59b..f8a58cf1ec4 100644 --- a/src/app/shared/form/form.service.ts +++ b/src/app/shared/form/form.service.ts @@ -185,6 +185,7 @@ export class FormService { error[errorKey] = true; // add the error in the form control field.setErrors(error); + field.setValidators(() => error); } // if the field in question is a concat group, pass down the error to its fields @@ -206,6 +207,8 @@ export class FormService { if (field.hasError(errorKey)) { error[errorKey] = null; field.setErrors(error); + field.clearValidators(); + field.updateValueAndValidity(); } // if the field in question is a concat group, clear the error from its fields diff --git a/src/app/shared/form/testing/form-builder-service.mock.ts b/src/app/shared/form/testing/form-builder-service.mock.ts index 9ef34227d21..087bd7a5199 100644 --- a/src/app/shared/form/testing/form-builder-service.mock.ts +++ b/src/app/shared/form/testing/form-builder-service.mock.ts @@ -45,5 +45,9 @@ export function getMockFormBuilderService(): FormBuilderService { ], }, ), + removeFormModel: {}, + addFormModel: {}, + updateValue: {}, + addFormGroups: {}, }); } diff --git a/src/app/shared/form/testing/form-models.mock.ts b/src/app/shared/form/testing/form-models.mock.ts index 087cff1a55f..a1621f0e453 100644 --- a/src/app/shared/form/testing/form-models.mock.ts +++ b/src/app/shared/form/testing/form-models.mock.ts @@ -132,6 +132,7 @@ const relationGroupConfig = { submissionId: '1234', id: 'relationGroup', formConfiguration: [mockFormRowModel], + isInlineGroup: false, mandatoryField: 'false', relationFields: ['journal', 'issue'], scopeUUID: 'scope', @@ -154,7 +155,7 @@ const relationGroupConfig = { export const MockRelationModel: DynamicRelationGroupModel = new DynamicRelationGroupModel(relationGroupConfig); export const inputWithLanguageAndAuthorityConfig = { - vocabularyOptions: new VocabularyOptions('testAuthority', false), + vocabularyOptions: new VocabularyOptions('testAuthority', 'testWithAuthority', 'scope', false), languageCodes: [ { display: 'English', @@ -209,7 +210,7 @@ export const inputWithLanguageConfig = { export const mockInputWithLanguageModel = new DsDynamicInputModel(inputWithLanguageConfig); export const inputWithLanguageAndAuthorityArrayConfig = { - vocabularyOptions: new VocabularyOptions('testAuthority', false), + vocabularyOptions: new VocabularyOptions('testAuthority', 'testWithAuthority', 'scope', false), languageCodes: [ { display: 'English', diff --git a/src/app/shared/form/testing/form-service.mock.ts b/src/app/shared/form/testing/form-service.mock.ts index 6cd66c86dd0..24ad83b6285 100644 --- a/src/app/shared/form/testing/form-service.mock.ts +++ b/src/app/shared/form/testing/form-service.mock.ts @@ -7,7 +7,7 @@ export function getMockFormService( id$: string = 'random_id', ): any { return jasmine.createSpyObj('FormService', { - getFormData: jasmine.createSpy('getFormData'), + getFormData: of({}), initForm: jasmine.createSpy('initForm'), removeForm: jasmine.createSpy('removeForm'), getForm: of({}), diff --git a/src/app/shared/form/vocabulary-treeview-modal/vocabulary-treeview-modal.component.spec.ts b/src/app/shared/form/vocabulary-treeview-modal/vocabulary-treeview-modal.component.spec.ts index 6d3eaba24b1..d43ff3e744f 100644 --- a/src/app/shared/form/vocabulary-treeview-modal/vocabulary-treeview-modal.component.spec.ts +++ b/src/app/shared/form/vocabulary-treeview-modal/vocabulary-treeview-modal.component.spec.ts @@ -14,7 +14,7 @@ describe('VocabularyTreeviewModalComponent', () => { let fixture: ComponentFixture; const modalStub = jasmine.createSpyObj('modalStub', ['close']); - const vocabularyOptions = new VocabularyOptions('vocabularyTest', false); + const vocabularyOptions = new VocabularyOptions('vocabularyTest', null, null, false); beforeEach(async () => { await TestBed.configureTestingModule({ diff --git a/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.component.spec.ts b/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.component.spec.ts index d9b45aea026..08f407363df 100644 --- a/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.component.spec.ts +++ b/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.component.spec.ts @@ -45,7 +45,7 @@ describe('VocabularyTreeviewComponent test suite', () => { const emptyNodeMap = new Map(); const storedNodeMap = new Map().set('test', new TreeviewFlatNode(item2)); const nodeMap = new Map().set('test', new TreeviewFlatNode(item)); - const vocabularyOptions = new VocabularyOptions('vocabularyTest', false); + const vocabularyOptions = new VocabularyOptions('vocabularyTest', null, null, false); const modalStub = jasmine.createSpyObj('modalStub', ['close']); const vocabularyTreeviewServiceStub = jasmine.createSpyObj('VocabularyTreeviewService', { initialize: jasmine.createSpy('initialize'), @@ -292,7 +292,7 @@ describe('VocabularyTreeviewComponent test suite', () => { }) class TestComponent { - vocabularyOptions: VocabularyOptions = new VocabularyOptions('vocabularyTest', false); + vocabularyOptions: VocabularyOptions = new VocabularyOptions('vocabularyTest', null, null, false); preloadLevel = 2; } diff --git a/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.service.spec.ts b/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.service.spec.ts index f88cff2e75a..24060eb8746 100644 --- a/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.service.spec.ts +++ b/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.service.spec.ts @@ -177,7 +177,7 @@ describe('VocabularyTreeviewService test suite', () => { searchNodeMap = new Map([ [item.id, searchItemNode], ]); - vocabularyOptions = new VocabularyOptions('vocabularyTest', false); + vocabularyOptions = new VocabularyOptions('vocabularyTest', null, null,false); } beforeEach(waitForAsync(() => { diff --git a/src/app/shared/image.utils.ts b/src/app/shared/image.utils.ts new file mode 100644 index 00000000000..a6070364220 --- /dev/null +++ b/src/app/shared/image.utils.ts @@ -0,0 +1,34 @@ +import { + Observable, + of, +} from 'rxjs'; +import { map } from 'rxjs/operators'; + +export const getDefaultImageUrlByEntityType = (entityType: string): Observable => { + const fallbackImage = 'assets/images/file-placeholder.svg'; + + if (!entityType) { + return of(fallbackImage); + } + + const defaultImage = `assets/images/${entityType.toLowerCase()}-placeholder.svg`; + return checkImageExists(defaultImage).pipe(map((exists) => exists ? defaultImage : fallbackImage)); +}; + +const checkImageExists = (url: string): Observable => { + return new Observable((observer) => { + const img = new Image(); + + img.onload = () => { + observer.next(true); + observer.complete(); + }; + + img.onerror = () => { + observer.next(false); + observer.complete(); + }; + + img.src = url; + }); +}; diff --git a/src/app/shared/listable.module.ts b/src/app/shared/listable.module.ts index cf417129e6b..c0eb9344e78 100644 --- a/src/app/shared/listable.module.ts +++ b/src/app/shared/listable.module.ts @@ -71,6 +71,7 @@ import { ItemPageUriFieldComponent } from '../item-page/simple/field-components/ import { PublicationComponent } from '../item-page/simple/item-types/publication/publication.component'; import { UntypedItemComponent } from '../item-page/simple/item-types/untyped-item/untyped-item.component'; import { ThemedMetadataRepresentationListComponent } from '../item-page/simple/metadata-representation-list/themed-metadata-representation-list.component'; +import { AuthorityRelatedEntitiesSearchComponent } from '../item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component'; import { TabbedRelatedEntitiesSearchComponent } from '../item-page/simple/related-entities/tabbed-related-entities-search/tabbed-related-entities-search.component'; import { RelatedItemsComponent } from '../item-page/simple/related-items/related-items-component'; import { ThemedThumbnailComponent } from '../thumbnail/themed-thumbnail.component'; @@ -243,6 +244,7 @@ const ENTRY_COMPONENTS = [ ItemActionsComponent, PersonInputSuggestionsComponent, TabbedRelatedEntitiesSearchComponent, + AuthorityRelatedEntitiesSearchComponent, WorkspaceItemAdminWorkflowActionsComponent, WorkflowItemAdminWorkflowActionsComponent, FormsModule, diff --git a/src/app/shared/menu/providers/edit-item-details.menu.spec.ts b/src/app/shared/menu/providers/edit-item-details.menu.spec.ts new file mode 100644 index 00000000000..a07a1410f0e --- /dev/null +++ b/src/app/shared/menu/providers/edit-item-details.menu.spec.ts @@ -0,0 +1,89 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { TestBed } from '@angular/core/testing'; +import { DSpaceObject } from '@dspace/core/shared/dspace-object.model'; +import { EditItemDataService } from '@dspace/core/submission/edititem-data.service'; +import { createPaginatedList } from '@dspace/core/testing/utils.test'; +import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; +import { cold } from 'jasmine-marbles'; + +import { MenuItemType } from '../menu-item-type.model'; +import { EditItemDetailsMenuProvider } from './edit-item-details.menu'; + +describe('EditItemDetailsMenuProvider', () => { + + let provider: EditItemDetailsMenuProvider; + + const editItemServiceStub = jasmine.createSpyObj('EditItemDataService', [ + 'searchEditModesById', + ]); + + const mockDSO = { + id: 'test-id', + uuid: 'test-uuid', + } as DSpaceObject; + + const mockEditModes = [ + { name: 'quickedit' }, + { name: 'full' }, + ]; + + const expectedSections = [ + { + model: { + type: MenuItemType.LINK, + text: 'menu.section.quickedit', + link: jasmine.any(String), + }, + visible: true, + }, + { + model: { + type: MenuItemType.LINK, + text: 'menu.section.full', + link: jasmine.any(String), + }, + visible: true, + }, + ]; + + beforeEach(() => { + + editItemServiceStub.searchEditModesById.and.returnValue( + createSuccessfulRemoteDataObject$( + createPaginatedList(mockEditModes), + ), + ); + + TestBed.configureTestingModule({ + providers: [ + EditItemDetailsMenuProvider, + { provide: EditItemDataService, useValue: editItemServiceStub }, + ], + }); + + provider = TestBed.inject(EditItemDetailsMenuProvider); + }); + + it('should be created', () => { + expect(provider).toBeTruthy(); + }); + + it('should return menu sections', () => { + + const result = provider.getSectionsForContext(mockDSO); + + const expected = cold('(a|)', { + a: expectedSections, + }); + + expect(result).toBeObservable(expected); + }); + +}); diff --git a/src/app/shared/menu/providers/edit-item-details.menu.ts b/src/app/shared/menu/providers/edit-item-details.menu.ts new file mode 100644 index 00000000000..73ed9b2929d --- /dev/null +++ b/src/app/shared/menu/providers/edit-item-details.menu.ts @@ -0,0 +1,58 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Injectable } from '@angular/core'; +import { DSpaceObject } from '@dspace/core/shared/dspace-object.model'; +import { + getAllSucceededRemoteDataPayload, + getPaginatedListPayload, +} from '@dspace/core/shared/operators'; +import { EditItemDataService } from '@dspace/core/submission/edititem-data.service'; +import { EditItemMode } from '@dspace/core/submission/models/edititem-mode.model'; +import { URLCombiner } from '@dspace/core/url-combiner/url-combiner'; +import { + map, + Observable, +} from 'rxjs'; + +import { getEditItemPageRoute } from '../../../app-routing-paths'; +import { MenuItemType } from '../menu-item-type.model'; +import { PartialMenuSection } from '../menu-provider.model'; +import { DSpaceObjectPageMenuProvider } from './helper-providers/dso.menu'; + +/** + * Menu provider to create the "Edit details" option in the DSO audit menu + */ +@Injectable() +export class EditItemDetailsMenuProvider extends DSpaceObjectPageMenuProvider { + constructor( + protected editItemService: EditItemDataService, + ) { + super(); + } + + + public getSectionsForContext(dso: DSpaceObject): Observable { + return this.editItemService.searchEditModesById(dso.id).pipe( + getAllSucceededRemoteDataPayload(), + getPaginatedListPayload(), + map((editModes: EditItemMode[]) => { + return editModes.map(editMode => { + return { + model: { + type: MenuItemType.LINK, + text: `menu.section.${editMode.name}`, + link: new URLCombiner(getEditItemPageRoute(), `${dso.uuid}:${editMode.name}`).toString(), + }, + visible: true, + }; + }); + }), + ); + } + +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.html b/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.html new file mode 100644 index 00000000000..7a19f47d347 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.html @@ -0,0 +1,21 @@ +
    + @if (isLoading()) { +
    +
    +
    + +
    +
    +
    + } + + @if (src() !== null) { + + } + @if (src() === null && isLoading() === false) { +
    + +
    + } +
    diff --git a/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.scss b/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.scss new file mode 100644 index 00000000000..598ca7ceed4 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.scss @@ -0,0 +1,10 @@ +:host{ + img { + height: 80px; + width: 80px; + min-width: 80px; + border: 1px solid #ccc; + border-radius: 50%; + object-fit: cover; + } +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.spec.ts b/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.spec.ts new file mode 100644 index 00000000000..472283ceedd --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.spec.ts @@ -0,0 +1,82 @@ +import { + ComponentFixture, + TestBed, + waitForAsync, +} from '@angular/core/testing'; +import { AuthService } from '@dspace/core/auth/auth.service'; +import { AuthorizationDataService } from '@dspace/core/data/feature-authorization/authorization-data.service'; +import { FileService } from '@dspace/core/shared/file.service'; +import { TranslateModule } from '@ngx-translate/core'; +import { of } from 'rxjs'; + +import { ThemedLoadingComponent } from '../../loading/themed-loading.component'; +import { MetadataLinkViewAvatarPopoverComponent } from './metadata-link-view-avatar-popover.component'; + +describe('MetadataLinkViewAvatarPopoverComponent', () => { + let component: MetadataLinkViewAvatarPopoverComponent; + let fixture: ComponentFixture; + let authService; + let authorizationService; + let fileService; + + beforeEach(waitForAsync(() => { + authService = jasmine.createSpyObj('AuthService', { + isAuthenticated: of(true), + }); + authorizationService = jasmine.createSpyObj('AuthorizationService', { + isAuthorized: of(true), + }); + fileService = jasmine.createSpyObj('FileService', { + retrieveFileDownloadLink: null, + }); + + TestBed.configureTestingModule({ + imports: [ + MetadataLinkViewAvatarPopoverComponent, + TranslateModule.forRoot(), + ], + providers: [ + { provide: AuthService, useValue: authService }, + { provide: AuthorizationDataService, useValue: authorizationService }, + { provide: FileService, useValue: fileService }, + ], + }) + .overrideComponent(MetadataLinkViewAvatarPopoverComponent, { remove: { imports: [ThemedLoadingComponent] } }).compileComponents(); + })); + + beforeEach(() => { + fixture = TestBed.createComponent(MetadataLinkViewAvatarPopoverComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should set fallback image if no entity type', (done) => { + component.ngOnInit(); + component.placeholderImageUrl$.subscribe((url) => { + expect(url).toBe('assets/images/file-placeholder.svg'); + done(); + }); + }); + + it('should set correct placeholder image based on entity type if image exists', (done) => { + component.entityType = 'OrgUnit'; + component.ngOnInit(); + component.placeholderImageUrl$.subscribe((url) => { + expect(url).toBe('assets/images/orgunit-placeholder.svg'); + done(); + }); + }); + + it('should set correct fallback image if image does not exists', (done) => { + component.entityType = 'missingEntityType'; + component.ngOnInit(); + component.placeholderImageUrl$.subscribe((url) => { + expect(url).toBe('assets/images/file-placeholder.svg'); + done(); + }); + }); +}); diff --git a/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.ts b/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.ts new file mode 100644 index 00000000000..42fb08d9216 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component.ts @@ -0,0 +1,46 @@ +import { + AsyncPipe, + NgClass, +} from '@angular/common'; +import { + Component, + Input, + OnInit, +} from '@angular/core'; +import { TranslateModule } from '@ngx-translate/core'; +import { Observable } from 'rxjs'; +import { ThumbnailComponent } from 'src/app/thumbnail/thumbnail.component'; + +import { getDefaultImageUrlByEntityType } from '../../image.utils'; +import { ThemedLoadingComponent } from '../../loading/themed-loading.component'; +import { SafeUrlPipe } from '../../utils/safe-url-pipe'; + +@Component({ + selector: 'ds-metadata-link-view-avatar-popover', + templateUrl: './metadata-link-view-avatar-popover.component.html', + styleUrls: ['./metadata-link-view-avatar-popover.component.scss'], + imports: [ + AsyncPipe, + NgClass, + SafeUrlPipe, + ThemedLoadingComponent, + TranslateModule, + ], +}) +export class MetadataLinkViewAvatarPopoverComponent extends ThumbnailComponent implements OnInit { + + + /** + * Placeholder image url that changes based on entity type + */ + placeholderImageUrl$: Observable; + + /** + * The entity type of the item which the avatar belong + */ + @Input() entityType: string; + + ngOnInit() { + this.placeholderImageUrl$ = getDefaultImageUrlByEntityType(this.entityType); + } +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.html b/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.html new file mode 100644 index 00000000000..c62715fba13 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.html @@ -0,0 +1,23 @@ +@let hasBadge = hasOrcidBadge(); +@let orcidUrl = orcidUrl$ | async; + +@if (hasBadge || orcidUrl) { + + @if (orcidUrl) { + + {{ metadataValue }} + + } @else { + {{ metadataValue }} + } + + @if (hasBadge) { + orcid-logo + } + +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.scss b/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.scss new file mode 100644 index 00000000000..b92a52cd35d --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.scss @@ -0,0 +1,4 @@ +.orcid-icon { + height: 1.2rem; + padding-left: 0.3rem; +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.spec.ts b/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.spec.ts new file mode 100644 index 00000000000..cb89a89f67f --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.spec.ts @@ -0,0 +1,74 @@ +import { + ComponentFixture, + TestBed, +} from '@angular/core/testing'; +import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; +import { ConfigurationDataService } from '@dspace/core/data/configuration-data.service'; +import { TranslateLoaderMock } from '@dspace/core/testing/translate-loader.mock'; +import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; +import { + TranslateLoader, + TranslateModule, +} from '@ngx-translate/core'; +import { Item } from 'src/app/core/shared/item.model'; +import { MetadataValue } from 'src/app/core/shared/metadata.models'; + +import { MetadataLinkViewOrcidComponent } from './metadata-link-view-orcid.component'; + +describe('MetadataLinkViewOrcidComponent', () => { + let component: MetadataLinkViewOrcidComponent; + let fixture: ComponentFixture; + + const configurationDataService = jasmine.createSpyObj('configurationDataService', { + findByPropertyName: createSuccessfulRemoteDataObject$({ values: ['https://sandbox.orcid.org'] }), + }); + + + const metadataValue = Object.assign(new MetadataValue(), { + 'value': '0000-0001-8918-3592', + 'language': 'en_US', + 'authority': null, + 'confidence': -1, + 'place': 0, + }); + + const testItem = Object.assign(new Item(), + { + type: 'item', + metadata: { + 'person.identifier.orcid': [metadataValue], + 'dspace.orcid.authenticated': [ + { + language: null, + value: 'authenticated', + }, + ], + }, + uuid: 'test-item-uuid', + }, + ); + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [TranslateModule.forRoot({ + loader: { + provide: TranslateLoader, + useClass: TranslateLoaderMock, + }, + }), BrowserAnimationsModule, MetadataLinkViewOrcidComponent], + providers: [ + { provide: ConfigurationDataService, useValue: configurationDataService }, + ], + }) + .compileComponents(); + + fixture = TestBed.createComponent(MetadataLinkViewOrcidComponent); + component = fixture.componentInstance; + component.itemValue = testItem; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); +}); diff --git a/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.ts b/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.ts new file mode 100644 index 00000000000..cc0deba1ce4 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-orcid/metadata-link-view-orcid.component.ts @@ -0,0 +1,64 @@ +import { AsyncPipe } from '@angular/common'; +import { + Component, + Input, + OnInit, +} from '@angular/core'; +import { ConfigurationDataService } from '@dspace/core/data/configuration-data.service'; +import { RemoteData } from '@dspace/core/data/remote-data'; +import { ConfigurationProperty } from '@dspace/core/shared/configuration-property.model'; +import { Item } from '@dspace/core/shared/item.model'; +import { getFirstCompletedRemoteData } from '@dspace/core/shared/operators'; +import { NgbTooltipModule } from '@ng-bootstrap/ng-bootstrap'; +import { TranslateModule } from '@ngx-translate/core'; +import { + map, + Observable, +} from 'rxjs'; + +@Component({ + selector: 'ds-metadata-link-view-orcid', + templateUrl: './metadata-link-view-orcid.component.html', + styleUrls: ['./metadata-link-view-orcid.component.scss'], + imports: [ + AsyncPipe, + NgbTooltipModule, + TranslateModule, + ], +}) +export class MetadataLinkViewOrcidComponent implements OnInit { + /** + * Item value to display the metadata for + */ + @Input() itemValue: Item; + + metadataValue: string; + + orcidUrl$: Observable; + + constructor(protected configurationService: ConfigurationDataService) {} + + ngOnInit(): void { + this.orcidUrl$ = this.configurationService + .findByPropertyName('orcid.domain-url') + .pipe( + getFirstCompletedRemoteData(), + map((propertyPayload: RemoteData) => + propertyPayload.hasSucceeded ? + (propertyPayload.payload?.values?.length > 0 ? propertyPayload.payload.values[0] : null) + : null, + ), + ); + this.metadataValue = this.itemValue.firstMetadataValue( + 'person.identifier.orcid', + ); + } + + public hasOrcid(): boolean { + return this.itemValue.hasMetadata('person.identifier.orcid'); + } + + public hasOrcidBadge(): boolean { + return this.itemValue.hasMetadata('dspace.orcid.authenticated'); + } +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.html b/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.html new file mode 100644 index 00000000000..fa18562e38d --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.html @@ -0,0 +1,77 @@ +
    + +
    + @if (item.thumbnail | async) { + + } +
    {{title}}
    +
    + + @for (metadata of entityMetdataFields; track metadata) { + @if (item.hasMetadata(metadata)) { +
    +
    + {{ "metadata-link-view.popover.label." + (isOtherEntityType ? "other" : item.entityType) + "." + metadata | translate }} +
    +
    + @if (longTextMetadataList.includes(metadata)) { + + {{ item.firstMetadataValue(metadata) }} + + } + @if (isLink(item.firstMetadataValue(metadata)) && !getSourceSubTypeIdentifier(metadata)) { + + {{ item.firstMetadataValue(metadata) }} + + } + @if (getSourceSubTypeIdentifier(metadata)) { +
    + + @if (isLink(rorValue)) { + + {{ item.firstMetadataValue(metadata) }} + + } + @if (!isLink(rorValue)) { + + {{ item.firstMetadataValue(metadata) }} + + } + + source-logo +
    + } + @if (!isLink(item.firstMetadataValue(metadata)) && !longTextMetadataList.includes(metadata)) { +
    + @if (metadata === 'person.identifier.orcid') { + + } @else { + {{ item.firstMetadataValue(metadata) }} + } +
    + } +
    +
    + } + } + +
    + + {{ "metadata-link-view.popover.label.more-info" | translate }} + +
    +
    diff --git a/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.scss b/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.scss new file mode 100644 index 00000000000..47ea2c353d2 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.scss @@ -0,0 +1,6 @@ +.source-icon { + height: var(--ds-identifier-subtype-icon-height); + min-height: 16px; + width: auto; + padding-left: 0.3rem; +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.spec.ts b/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.spec.ts new file mode 100644 index 00000000000..6fce6f93233 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.spec.ts @@ -0,0 +1,178 @@ +import { NO_ERRORS_SCHEMA } from '@angular/core'; +import { + ComponentFixture, + TestBed, + waitForAsync, +} from '@angular/core/testing'; +import { By } from '@angular/platform-browser'; +import { ActivatedRoute } from '@angular/router'; +import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; +import { TranslateModule } from '@ngx-translate/core'; +import { Bitstream } from 'src/app/core/shared/bitstream.model'; +import { Item } from 'src/app/core/shared/item.model'; +import { MetadataValueFilter } from 'src/app/core/shared/metadata.models'; +import { environment } from 'src/environments/environment.test'; + +import { MetadataLinkViewAvatarPopoverComponent } from '../metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component'; +import { MetadataLinkViewOrcidComponent } from '../metadata-link-view-orcid/metadata-link-view-orcid.component'; +import { MetadataLinkViewPopoverComponent } from './metadata-link-view-popover.component'; + +describe('MetadataLinkViewPopoverComponent', () => { + let component: MetadataLinkViewPopoverComponent; + let fixture: ComponentFixture; + + + const itemMock = Object.assign(new Item(), { + uuid: '1234-1234-1234-1234', + entityType: 'Publication', + + firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string { + return itemMock.metadata[keyOrKeys as string][0].value; + }, + + metadata: { + 'dc.title': [ + { + value: 'file name', + language: null, + }, + ], + 'dc.identifier.uri': [ + { + value: 'http://example.com', + language: null, + }, + ], + 'dc.description.abstract': [ + { + value: 'Long text description', + language: null, + }, + ], + 'organization.identifier.ror': [ + { + value: 'https://ror.org/1234', + language: null, + }, + ], + 'person.identifier.orcid': [ + { + value: 'https://orcid.org/0000-0000-0000-0000', + language: null, + }, + ], + 'dspace.entity.type': [ + { + value: 'Person', + language: null, + }, + ], + }, + thumbnail: createSuccessfulRemoteDataObject$(new Bitstream()), + }); + + beforeEach(waitForAsync(() => { + TestBed.configureTestingModule({ + imports: [TranslateModule.forRoot(), MetadataLinkViewPopoverComponent], + schemas: [NO_ERRORS_SCHEMA], + providers: [ + { provide: ActivatedRoute, useValue: { snapshot: { data: { dso: itemMock } } } }, + ], + }) + .overrideComponent(MetadataLinkViewPopoverComponent, { remove: { imports: [MetadataLinkViewOrcidComponent, MetadataLinkViewAvatarPopoverComponent] } }).compileComponents(); + })); + + beforeEach(() => { + fixture = TestBed.createComponent(MetadataLinkViewPopoverComponent); + component = fixture.componentInstance; + component.item = itemMock; + itemMock.firstMetadataValue = jasmine.createSpy() + .withArgs('dspace.entity.type').and.returnValue('Person') + .withArgs('dc.title').and.returnValue('Test Title') + .withArgs('dc.identifier.uri').and.returnValue('http://example.com') + .withArgs('dc.description.abstract').and.returnValue('Long text description') + .withArgs('organization.identifier.ror').and.returnValue('https://ror.org/1234') + .withArgs('person.identifier.orcid').and.returnValue('https://orcid.org/0000-0000-0000-0000') + .withArgs('dc.nonexistent').and.returnValue(null); + + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should display the item title', () => { + const titleElement = fixture.debugElement.query(By.css('.font-weight-bold.h4')); + expect(titleElement.nativeElement.textContent).toContain('Test Title'); + }); + + it('should display a link for each metadata field that is a valid link', () => { + component.entityMetdataFields = ['dc.identifier.uri']; + fixture.detectChanges(); + const linkElement = fixture.debugElement.query(By.css('a[href="http://example.com"]')); + expect(linkElement).toBeTruthy(); + }); + + it('should retrieve the identifier subtype configuration based on the given metadata value', () => { + const metadataValue = 'organization.identifier.ror'; + const expectedSubtypeConfig = environment.identifierSubtypes.find((config) => config.name === 'ror'); + expect(component.getSourceSubTypeIdentifier(metadataValue)).toEqual(expectedSubtypeConfig); + }); + + + it('should check if a given metadata value is a valid link', () => { + const validLink = 'http://example.com'; + const invalidLink = 'not a link'; + expect(component.isLink(validLink)).toBeTrue(); + expect(component.isLink(invalidLink)).toBeFalse(); + }); + + it('should display the "more info" link with the correct router link', () => { + spyOn(component, 'getItemPageRoute').and.returnValue('/item/' + itemMock.uuid); + fixture.detectChanges(); + const moreInfoLinkElement = fixture.debugElement.query(By.css('a[data-test="more-info-link"]')); + expect(moreInfoLinkElement.nativeElement.href).toContain('/item/' + itemMock.uuid); + }); + + it('should display the avatar popover when item has a thumbnail', () => { + const avatarPopoverElement = fixture.debugElement.query(By.css('ds-metadata-link-view-avatar-popover')); + expect(avatarPopoverElement).toBeTruthy(); + }); + + describe('getTitleFromMetadataList', () => { + + it('should return title from configured metadata when available', () => { + component.metadataLinkViewPopoverData = { + entityDataConfig: [ + { + entityType: 'Publication', + metadataList: ['dc.title', 'dc.identifier.uri'], + titleMetadataList: ['dc.title', 'dc.identifier.uri'], + }, + ], + fallbackMetdataList: [], + }; + + const title = component.getTitleFromMetadataList(); + expect(title).toBe('Test Title, http://example.com'); + }); + + it('should fallback to defaultTitleMetadataList when no configured title is present', () => { + component.metadataLinkViewPopoverData = { + entityDataConfig: [ + { + entityType: 'Publication', + metadataList: ['dc.title', 'dc.identifier.uri'], + titleMetadataList: ['dc.nonexistent'], + }, + ], + fallbackMetdataList: [], + }; + + const title = component.getTitleFromMetadataList(); + expect(title).toBe('Test Title'); + }); + }); + +}); diff --git a/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.ts b/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.ts new file mode 100644 index 00000000000..924c419b99d --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view-popover/metadata-link-view-popover.component.ts @@ -0,0 +1,142 @@ +import { + AsyncPipe, + NgOptimizedImage, +} from '@angular/common'; +import { + Component, + Input, + OnInit, +} from '@angular/core'; +import { RouterLink } from '@angular/router'; +import { IdentifierSubtypesConfig } from '@dspace/config/identifier-subtypes-config.interface'; +import { MetadataLinkViewPopoverDataConfig } from '@dspace/config/metadata-link-view-popoverdata-config.interface'; +import { getItemPageRoute } from '@dspace/core/router/utils/dso-route.utils'; +import { Item } from '@dspace/core/shared/item.model'; +import { + hasNoValue, + hasValue, +} from '@dspace/shared/utils/empty.util'; +import { NgbTooltipModule } from '@ng-bootstrap/ng-bootstrap'; +import { TranslateModule } from '@ngx-translate/core'; +import { AuthorithyIcon } from 'src/config/submission-config.interface'; +import { environment } from 'src/environments/environment'; + +import { VarDirective } from '../../utils/var.directive'; +import { MetadataLinkViewAvatarPopoverComponent } from '../metadata-link-view-avatar-popover/metadata-link-view-avatar-popover.component'; +import { MetadataLinkViewOrcidComponent } from '../metadata-link-view-orcid/metadata-link-view-orcid.component'; + + +@Component({ + selector: 'ds-metadata-link-view-popover', + templateUrl: './metadata-link-view-popover.component.html', + styleUrls: ['./metadata-link-view-popover.component.scss'], + imports: [ + AsyncPipe, + MetadataLinkViewAvatarPopoverComponent, + MetadataLinkViewOrcidComponent, + NgbTooltipModule, + NgOptimizedImage, + RouterLink, + TranslateModule, + VarDirective, + ], +}) +export class MetadataLinkViewPopoverComponent implements OnInit { + + /** + * The item to display the metadata for + */ + @Input() item: Item; + + /** + * The metadata link view popover data configuration. + * This configuration is used to determine which metadata fields to display for the given entity type + */ + metadataLinkViewPopoverData: MetadataLinkViewPopoverDataConfig = environment.metadataLinkViewPopoverData; + + /** + * The metadata fields to display for the given entity type + */ + entityMetdataFields: string[] = []; + + /** + * The metadata fields including long text metadata values. + * These metadata values should be truncated to a certain length. + */ + longTextMetadataList = ['dc.description.abstract', 'dc.description']; + + /** + * The source icons configuration + */ + sourceIcons: AuthorithyIcon[] = environment.submission.icons.authority.sourceIcons; + + /** + * The identifier subtype configurations + */ + identifierSubtypeConfig: IdentifierSubtypesConfig[] = environment.identifierSubtypes; + + /** + * Whether the entity type is not found in the metadataLinkViewPopoverData configuration + */ + isOtherEntityType = false; + + /** + * The title to be displayed + */ + title: string; + + private readonly titleSeparator = ', '; + private readonly defaultTitleMetadataList = ['dc.title']; + + /** + * If `metadataLinkViewPopoverData` is provided, it retrieves the metadata fields based on the entity type. + * If no metadata fields are found for the entity type, it falls back to the fallback metadata list. + */ + ngOnInit() { + if (this.metadataLinkViewPopoverData) { + const metadataFields = this.metadataLinkViewPopoverData.entityDataConfig.find((config) => config.entityType === this.item.entityType); + this.entityMetdataFields = hasValue(metadataFields) ? metadataFields.metadataList : this.metadataLinkViewPopoverData.fallbackMetdataList; + this.isOtherEntityType = hasNoValue(metadataFields); + this.title = this.getTitleFromMetadataList(); + } + } + + /** + * Checks if the given metadata value is a valid link. + */ + isLink(metadataValue: string): boolean { + const urlRegex = /^(http|https):\/\/[^ "]+$/; + return urlRegex.test(metadataValue); + } + + /** + * Returns the page route for the item. + * @returns The page route for the item. + */ + getItemPageRoute(): string { + return getItemPageRoute(this.item); + } + + /** + * Retrieves the identifier subtype configuration based on the given metadata value. + * @param metadataValue - The metadata value used to determine the identifier subtype. + * @returns The identifier subtype configuration object. + */ + getSourceSubTypeIdentifier(metadataValue: string): IdentifierSubtypesConfig { + const metadataValueSplited = metadataValue.split('.'); + const subtype = metadataValueSplited[metadataValueSplited.length - 1]; + const identifierSubtype = this.identifierSubtypeConfig.find((config) => config.name === subtype); + return identifierSubtype; + } + + /** + * Generates the title for the popover based on the title metadata list. + * @returns The generated title as a string. + */ + getTitleFromMetadataList(): string { + const titleMetadataList = this.metadataLinkViewPopoverData.entityDataConfig.find((config) => config.entityType === this.item.entityType)?.titleMetadataList; + const itemHasConfiguredTitle = titleMetadataList?.length && titleMetadataList.map(metadata => this.item.firstMetadataValue(metadata)).some(value => hasValue(value)); + return (itemHasConfiguredTitle ? titleMetadataList : this.defaultTitleMetadataList) + .map(metadataField => this.item.firstMetadataValue(metadataField)).join(this.titleSeparator); + } +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view.component.html b/src/app/shared/metadata-link-view/metadata-link-view.component.html new file mode 100644 index 00000000000..abc7a38549e --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view.component.html @@ -0,0 +1,51 @@ +
    + @if (metadataView) { + + } +
    + + + + + {{metadataView.value}} + + + + @if (metadataView.orcidAuthenticated) { + orcid-logo + } + + + + {{normalizeValue(metadataView.value)}} + + + + {{normalizeValue(metadataView.value)}} + + + + + + diff --git a/src/app/shared/metadata-link-view/metadata-link-view.component.scss b/src/app/shared/metadata-link-view/metadata-link-view.component.scss new file mode 100644 index 00000000000..f34f101c7e0 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view.component.scss @@ -0,0 +1,11 @@ +.orcid-icon { + height: 1.2rem; + padding-left: 0.3rem; +} + + +::ng-deep .popover { + max-width: 400px !important; + width: 100%; + min-width: 300px !important; +} diff --git a/src/app/shared/metadata-link-view/metadata-link-view.component.spec.ts b/src/app/shared/metadata-link-view/metadata-link-view.component.spec.ts new file mode 100644 index 00000000000..789730fca64 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view.component.spec.ts @@ -0,0 +1,217 @@ +import { + ComponentFixture, + TestBed, + waitForAsync, +} from '@angular/core/testing'; +import { By } from '@angular/platform-browser'; +import { RouterTestingModule } from '@angular/router/testing'; +import { NgbTooltipModule } from '@ng-bootstrap/ng-bootstrap'; +import { of } from 'rxjs'; +import { v4 as uuidv4 } from 'uuid'; + +import { ItemDataService } from '../../core/data/item-data.service'; +import { Item } from '../../core/shared/item.model'; +import { MetadataValue } from '../../core/shared/metadata.models'; +import { EntityIconDirective } from '../entity-icon/entity-icon.directive'; +import { VarDirective } from '../utils/var.directive'; +import { MetadataLinkViewComponent } from './metadata-link-view.component'; +import SpyObj = jasmine.SpyObj; +import { + createFailedRemoteDataObject$, + createSuccessfulRemoteDataObject$, +} from '@dspace/core/utilities/remote-data.utils'; + +import { MetadataLinkViewPopoverComponent } from './metadata-link-view-popover/metadata-link-view-popover.component'; + +describe('MetadataLinkViewComponent', () => { + let component: MetadataLinkViewComponent; + let fixture: ComponentFixture; + let itemService: SpyObj; + const validAuthority = uuidv4(); + + const testPerson = Object.assign(new Item(), { + id: '1', + bundles: of({}), + metadata: { + 'dspace.entity.type': [ + Object.assign(new MetadataValue(), { + value: 'Person', + }), + ], + 'person.orgunit.id': [ + Object.assign(new MetadataValue(), { + value: 'OrgUnit', + authority: '2', + }), + ], + 'person.identifier.orcid': [ + Object.assign(new MetadataValue(), { + language: 'en_US', + value: '0000-0001-8918-3592', + }), + ], + 'dspace.orcid.authenticated': [ + Object.assign(new MetadataValue(), { + language: null, + value: 'authenticated', + }), + ], + }, + entityType: 'Person', + }); + + const testOrgunit = Object.assign(new Item(), { + id: '2', + bundles: of({}), + metadata: { + 'dspace.entity.type': [ + Object.assign(new MetadataValue(), { + value: 'OrgUnit', + }), + ], + 'orgunit.person.id': [ + Object.assign(new MetadataValue(), { + value: 'Person', + authority: '1', + }), + ], + }, + entityType: 'OrgUnit', + }); + + const testMetadataValueWithoutAuthority = Object.assign(new MetadataValue(), { + authority: null, + confidence: -1, + language: null, + place: 0, + uuid: '56e99d82-2cae-4cce-8d12-39899dea7c72', + value: 'Università degli Studi di Milano Bicocca', + }); + + const testMetadataValueWithAuthority = Object.assign(new MetadataValue(), { + authority: validAuthority, + confidence: 600, + language: null, + place: 0, + uuid: '56e99d82-2cae-4cce-8d12-39899dea7c72', + value: 'Università degli Studi di Milano Bicocca', + }); + + itemService = jasmine.createSpyObj('ItemDataService', { + findById: jasmine.createSpy('findById'), + }); + + beforeEach(waitForAsync(() => { + TestBed.configureTestingModule({ + imports: [ + NgbTooltipModule, + RouterTestingModule, + MetadataLinkViewComponent, EntityIconDirective, VarDirective, + ], + providers: [ + { provide: ItemDataService, useValue: itemService }, + ], + }) + .overrideComponent(MetadataLinkViewComponent, { remove: { imports: [MetadataLinkViewPopoverComponent] } }).compileComponents(); + })); + + describe('Check metadata without authority', () => { + beforeEach(() => { + fixture = TestBed.createComponent(MetadataLinkViewComponent); + itemService.findById.and.returnValue(createSuccessfulRemoteDataObject$(testOrgunit)); + component = fixture.componentInstance; + component.metadata = testMetadataValueWithoutAuthority; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should render the span element', () => { + const text = fixture.debugElement.query(By.css('[data-test="textWithoutIcon"]')); + const link = fixture.debugElement.query(By.css('[data-test="linkToAuthority"]')); + + expect(text).toBeTruthy(); + expect(link).toBeNull(); + }); + + }); + + describe('Check metadata with authority', () => { + describe('when item is found with orcid', () => { + beforeEach(() => { + fixture = TestBed.createComponent(MetadataLinkViewComponent); + itemService.findById.and.returnValue(createSuccessfulRemoteDataObject$(testPerson)); + component = fixture.componentInstance; + component.metadata = testMetadataValueWithAuthority; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should render the link element', () => { + const link = fixture.debugElement.query(By.css('[data-test="linkToAuthority"]')); + + expect(link).toBeTruthy(); + }); + + it('should render the orcid icon', () => { + const icon = fixture.debugElement.query(By.css('[data-test="orcidIcon"]')); + + expect(icon).toBeTruthy(); + }); + }); + + describe('when item is found without orcid', () => { + beforeEach(() => { + fixture = TestBed.createComponent(MetadataLinkViewComponent); + itemService.findById.and.returnValue(createSuccessfulRemoteDataObject$(testOrgunit)); + component = fixture.componentInstance; + component.metadata = testMetadataValueWithAuthority; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should render the link element', () => { + const link = fixture.debugElement.query(By.css('[data-test="linkToAuthority"]')); + + expect(link).toBeTruthy(); + }); + + it('should not render the orcid icon', () => { + const icon = fixture.debugElement.query(By.css('[data-test="orcidIcon"]')); + + expect(icon).toBeFalsy(); + }); + }); + + describe('when item is not found', () => { + beforeEach(() => { + fixture = TestBed.createComponent(MetadataLinkViewComponent); + itemService.findById.and.returnValue(createFailedRemoteDataObject$()); + component = fixture.componentInstance; + component.metadata = testMetadataValueWithAuthority; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should render the span element', () => { + const text = fixture.debugElement.query(By.css('[data-test="textWithIcon"]')); + const link = fixture.debugElement.query(By.css('[data-test="linkToAuthority"]')); + + expect(text).toBeTruthy(); + expect(link).toBeNull(); + }); + }); + }); + +}); diff --git a/src/app/shared/metadata-link-view/metadata-link-view.component.ts b/src/app/shared/metadata-link-view/metadata-link-view.component.ts new file mode 100644 index 00000000000..0c4d7f5fd55 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-link-view.component.ts @@ -0,0 +1,182 @@ +import { + AsyncPipe, + NgTemplateOutlet, +} from '@angular/common'; +import { + Component, + Input, + OnInit, +} from '@angular/core'; +import { RouterLink } from '@angular/router'; +import { getItemPageRoute } from '@dspace/core/router/utils/dso-route.utils'; +import { followLink } from '@dspace/core/shared/follow-link-config.model'; +import { PLACEHOLDER_PARENT_METADATA } from '@dspace/core/shared/form/ds-dynamic-form-constants'; +import { isNotEmpty } from '@dspace/shared/utils/empty.util'; +import { + NgbPopoverModule, + NgbTooltipModule, +} from '@ng-bootstrap/ng-bootstrap'; +import { + Observable, + of, +} from 'rxjs'; +import { + map, + switchMap, + take, +} from 'rxjs/operators'; + +import { ItemDataService } from '../../core/data/item-data.service'; +import { RemoteData } from '../../core/data/remote-data'; +import { Item } from '../../core/shared/item.model'; +import { MetadataValue } from '../../core/shared/metadata.models'; +import { Metadata } from '../../core/shared/metadata.utils'; +import { getFirstCompletedRemoteData } from '../../core/shared/operators'; +import { EntityIconDirective } from '../entity-icon/entity-icon.directive'; +import { VarDirective } from '../utils/var.directive'; +import { MetadataLinkViewPopoverComponent } from './metadata-link-view-popover/metadata-link-view-popover.component'; +import { MetadataView } from './metadata-view.model'; +import { StickyPopoverDirective } from './sticky-popover.directive'; + +@Component({ + selector: 'ds-metadata-link-view', + templateUrl: './metadata-link-view.component.html', + styleUrls: ['./metadata-link-view.component.scss'], + imports: [ + AsyncPipe, + EntityIconDirective, + MetadataLinkViewPopoverComponent, + NgbPopoverModule, + NgbTooltipModule, + NgTemplateOutlet, + RouterLink, + StickyPopoverDirective, + VarDirective, + ], +}) +export class MetadataLinkViewComponent implements OnInit { + + /** + * Metadata value that we need to show in the template + */ + @Input() metadata: MetadataValue; + + /** + * Processed metadata to create MetadataOrcid with the information needed to show + */ + metadataView$: Observable; + + /** + * Position of the Icon before/after the element + */ + iconPosition = 'after'; + + /** + * Related item of the metadata value + */ + relatedItem: Item; + + /** + * Route of related item page + */ + relatedDsoRoute: string; + + /** + * Map all entities with the icons specified in the environment configuration file + */ + constructor(private itemService: ItemDataService) { } + + /** + * On init process metadata to get the information and form MetadataOrcid model + */ + ngOnInit(): void { + this.metadataView$ = of(this.metadata).pipe( + switchMap((metadataValue: MetadataValue) => this.getMetadataView(metadataValue)), + take(1), + ); + } + + + /** + * Retrieves the metadata view for a given metadata value. + * If the metadata value has a valid authority, it retrieves the item using the authority and creates a metadata view. + * If the metadata value does not have a valid authority, it creates a metadata view with null values. + * + * @param metadataValue The metadata value for which to retrieve the metadata view. + * @returns An Observable that emits the metadata view. + */ + private getMetadataView(metadataValue: MetadataValue): Observable { + const linksToFollow = [followLink('thumbnail')]; + + if (Metadata.hasValidAuthority(metadataValue.authority)) { + return this.itemService.findById(metadataValue.authority, true, false, ...linksToFollow).pipe( + getFirstCompletedRemoteData(), + map((itemRD: RemoteData) => this.createMetadataView(itemRD, metadataValue)), + ); + } else { + return of({ + authority: null, + value: metadataValue.value, + orcidAuthenticated: null, + entityType: null, + entityStyle: null, + }); + } + } + + /** + * Creates a MetadataView object based on the provided itemRD and metadataValue. + * @param itemRD - The RemoteData object containing the item information. + * @param metadataValue - The MetadataValue object containing the metadata information. + * @returns The created MetadataView object. + */ + private createMetadataView(itemRD: RemoteData, metadataValue: MetadataValue): MetadataView { + if (itemRD.hasSucceeded && itemRD.payload) { + this.relatedItem = itemRD.payload; + this.relatedDsoRoute = this.getItemPageRoute(this.relatedItem); + return { + authority: metadataValue.authority, + value: metadataValue.value, + orcidAuthenticated: this.getOrcid(itemRD.payload), + entityType: (itemRD.payload as Item)?.entityType, + }; + } else { + return { + authority: null, + value: metadataValue.value, + orcidAuthenticated: null, + entityType: 'PRIVATE', + }; + } + } + + /** + * Returns the orcid for given item, or null if there is no metadata authenticated for person + * + * @param referencedItem Item of the metadata being shown + */ + getOrcid(referencedItem: Item): string { + if (referencedItem?.hasMetadata('dspace.orcid.authenticated')) { + return referencedItem.firstMetadataValue('person.identifier.orcid'); + } + return null; + } + + /** + * Normalize value to display + * + * @param value + */ + normalizeValue(value: string): string { + if (isNotEmpty(value) && value.includes(PLACEHOLDER_PARENT_METADATA)) { + return ''; + } else { + return value; + } + } + + getItemPageRoute(item: Item): string { + return getItemPageRoute(item); + } + +} diff --git a/src/app/shared/metadata-link-view/metadata-view.model.ts b/src/app/shared/metadata-link-view/metadata-view.model.ts new file mode 100644 index 00000000000..fc5ecf24792 --- /dev/null +++ b/src/app/shared/metadata-link-view/metadata-view.model.ts @@ -0,0 +1,6 @@ +export interface MetadataView { + authority: string; + value: string; + orcidAuthenticated: string; + entityType: string; +} diff --git a/src/app/shared/metadata-link-view/sticky-popover.directive.ts b/src/app/shared/metadata-link-view/sticky-popover.directive.ts new file mode 100644 index 00000000000..0809fde9a97 --- /dev/null +++ b/src/app/shared/metadata-link-view/sticky-popover.directive.ts @@ -0,0 +1,129 @@ +import { DOCUMENT } from '@angular/common'; +import { + ApplicationRef, + ChangeDetectorRef, + Directive, + ElementRef, + Inject, + Injector, + Input, + NgZone, + OnDestroy, + OnInit, + Renderer2, + TemplateRef, + ViewContainerRef, +} from '@angular/core'; +import { + NavigationStart, + Router, +} from '@angular/router'; +import { + NgbPopover, + NgbPopoverConfig, +} from '@ng-bootstrap/ng-bootstrap'; +import { Subscription } from 'rxjs'; + +/** + * Directive to create a sticky popover using NgbPopover. + * The popover remains open when the mouse is over its content and closes when the mouse leaves. + */ +@Directive({ + selector: '[dsStickyPopover]', + standalone:true, +}) +export class StickyPopoverDirective extends NgbPopover implements OnInit, OnDestroy { + /** Template for the sticky popover content */ + @Input() dsStickyPopover: TemplateRef; + + /** Subscriptions to manage router events */ + subs: Subscription[] = []; + + /** Flag to determine if the popover can be closed */ + private canClosePopover: boolean; + + /** Reference to the element the directive is applied to */ + private readonly _elRef; + + /** Renderer to listen to and manipulate DOM elements */ + private readonly _render; + + constructor( + _elementRef: ElementRef, + _renderer: Renderer2, injector: Injector, + viewContainerRef: ViewContainerRef, + config: NgbPopoverConfig, + _ngZone: NgZone, + @Inject(DOCUMENT) _document: Document, + _changeDetector: ChangeDetectorRef, + applicationRef: ApplicationRef, + private router: Router, + ) { + super(_elementRef, _renderer, injector, viewContainerRef, config, _ngZone, document, _changeDetector, applicationRef); + this._elRef = _elementRef; + this._render = _renderer; + this.triggers = 'manual'; + this.container = 'body'; + } + + /** + * Sets up event listeners for mouse enter, mouse leave, and click events. + */ + ngOnInit(): void { + super.ngOnInit(); + this.ngbPopover = this.dsStickyPopover; + + this._render.listen(this._elRef.nativeElement, 'mouseenter', () => { + this.canClosePopover = true; + this.open(); + }); + + this._render.listen(this._elRef.nativeElement, 'mouseleave', () => { + setTimeout(() => { + if (this.canClosePopover) { + this.close(); + } + }, 100); + }); + + this._render.listen(this._elRef.nativeElement, 'click', () => { + this.close(); + }); + + this.subs.push( + this.router.events.subscribe((event) => { + if (event instanceof NavigationStart) { + this.close(); + } + }), + ); + } + + /** + * Opens the popover and sets up event listeners for mouse over and mouse out events on the popover. + */ + open() { + super.open(); + const popover = window.document.querySelector('.popover'); + this._render.listen(popover, 'mouseover', () => { + this.canClosePopover = false; + }); + + this._render.listen(popover, 'mouseout', () => { + this.canClosePopover = true; + setTimeout(() => { + if (this.canClosePopover) { + this.close(); + } + }, 0); + }); + } + + /** + * Unsubscribes from all subscriptions when the directive is destroyed. + */ + ngOnDestroy() { + super.ngOnDestroy(); + this.subs.forEach((sub) => sub.unsubscribe()); + } +} diff --git a/src/app/shared/metadata-representation/metadata-representation.decorator.ts b/src/app/shared/metadata-representation/metadata-representation.decorator.ts index 5fc916daef5..e7cb2a720bd 100644 --- a/src/app/shared/metadata-representation/metadata-representation.decorator.ts +++ b/src/app/shared/metadata-representation/metadata-representation.decorator.ts @@ -15,6 +15,7 @@ import { DEFAULT_THEME, resolveTheme, } from '../object-collection/shared/listable-object/listable-object.decorator'; +import { AuthorityLinkMetadataListElementComponent } from '../object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component'; import { BrowseLinkMetadataListElementComponent } from '../object-list/metadata-representation-list-element/browse-link/browse-link-metadata-list-element.component'; import { ItemMetadataListElementComponent } from '../object-list/metadata-representation-list-element/item/item-metadata-list-element.component'; import { PlainTextMetadataListElementComponent } from '../object-list/metadata-representation-list-element/plain-text/plain-text-metadata-list-element.component'; @@ -34,7 +35,8 @@ export type MetadataRepresentationComponent = typeof ItemMetadataListElementComponent | typeof OrgUnitItemMetadataListElementComponent | typeof PersonItemMetadataListElementComponent | - typeof ProjectItemMetadataListElementComponent; + typeof ProjectItemMetadataListElementComponent | + typeof AuthorityLinkMetadataListElementComponent; export const METADATA_REPRESENTATION_COMPONENT_DECORATOR_MAP = new Map>>>([ @@ -42,21 +44,27 @@ export const METADATA_REPRESENTATION_COMPONENT_DECORATOR_MAP = [MetadataRepresentationType.PlainText, new Map([ [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, PlainTextMetadataListElementComponent as any]])]])], [MetadataRepresentationType.AuthorityControlled, new Map([ - [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, PlainTextMetadataListElementComponent]])]])], + [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, AuthorityLinkMetadataListElementComponent]])]])], [MetadataRepresentationType.BrowseLink, new Map([ [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, BrowseLinkMetadataListElementComponent]])]])], [MetadataRepresentationType.Item, new Map([ [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, ItemMetadataListElementComponent]])]])], ])], ['Person', new Map([ + [MetadataRepresentationType.AuthorityControlled, new Map([ + [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, AuthorityLinkMetadataListElementComponent as any]])]])], [MetadataRepresentationType.Item, new Map([ [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, PersonItemMetadataListElementComponent]])]])], ])], ['OrgUnit', new Map([ + [MetadataRepresentationType.AuthorityControlled, new Map([ + [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, AuthorityLinkMetadataListElementComponent as any]])]])], [MetadataRepresentationType.Item, new Map([ [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, OrgUnitItemMetadataListElementComponent]])]])], ])], ['Project', new Map([ + [MetadataRepresentationType.AuthorityControlled, new Map([ + [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, AuthorityLinkMetadataListElementComponent as any]])]])], [MetadataRepresentationType.Item, new Map([ [DEFAULT_CONTEXT, new Map([[DEFAULT_THEME, ProjectItemMetadataListElementComponent]])]])], ])], diff --git a/src/app/shared/object-list/item-list-element/item-types/item/item-list-element.component.spec.ts b/src/app/shared/object-list/item-list-element/item-types/item/item-list-element.component.spec.ts index 2eba47d4fb7..1140df6df2a 100644 --- a/src/app/shared/object-list/item-list-element/item-types/item/item-list-element.component.spec.ts +++ b/src/app/shared/object-list/item-list-element/item-types/item/item-list-element.component.spec.ts @@ -10,6 +10,7 @@ import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { AuthService } from '@dspace/core/auth/auth.service'; import { DSONameService } from '@dspace/core/breadcrumbs/dso-name.service'; import { AuthorizationDataService } from '@dspace/core/data/feature-authorization/authorization-data.service'; +import { APP_DATA_SERVICES_MAP } from '@dspace/core/data-services-map-type'; import { Item } from '@dspace/core/shared/item.model'; import { ActivatedRouteStub } from '@dspace/core/testing/active-router.stub'; import { AuthServiceStub } from '@dspace/core/testing/auth-service.stub'; @@ -17,6 +18,7 @@ import { AuthorizationDataServiceStub } from '@dspace/core/testing/authorization import { DSONameServiceMock } from '@dspace/core/testing/dso-name.service.mock'; import { TruncatableServiceStub } from '@dspace/core/testing/truncatable-service.stub'; import { XSRFService } from '@dspace/core/xsrf/xsrf.service'; +import { provideMockStore } from '@ngrx/store/testing'; import { TranslateModule } from '@ngx-translate/core'; import { of } from 'rxjs'; @@ -85,8 +87,6 @@ describe('ItemListElementComponent', () => { TranslateModule.forRoot(), TruncatePipe, ], - declarations: [ - ], providers: [ { provide: DSONameService, useValue: new DSONameServiceMock() }, { provide: APP_CONFIG, useValue: environment }, @@ -96,6 +96,8 @@ describe('ItemListElementComponent', () => { { provide: ThemeService, useValue: themeService }, { provide: TruncatableService, useValue: truncatableService }, { provide: XSRFService, useValue: {} }, + { provide: APP_DATA_SERVICES_MAP, useValue: {} }, + provideMockStore(), ], }).overrideComponent(ItemListElementComponent, { set: { changeDetection: ChangeDetectionStrategy.Default }, diff --git a/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.html b/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.html new file mode 100644 index 00000000000..847d69e8e11 --- /dev/null +++ b/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.html @@ -0,0 +1 @@ + diff --git a/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.spec.ts b/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.spec.ts new file mode 100644 index 00000000000..5477752846c --- /dev/null +++ b/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.spec.ts @@ -0,0 +1,65 @@ +import { + ChangeDetectionStrategy, + NO_ERRORS_SCHEMA, +} from '@angular/core'; +import { + ComponentFixture, + TestBed, + waitForAsync, +} from '@angular/core/testing'; +import { ItemDataService } from '@dspace/core/data/item-data.service'; +import { MetadataRepresentationType } from '@dspace/core/shared/metadata-representation/metadata-representation.model'; +import { MetadatumRepresentation } from '@dspace/core/shared/metadata-representation/metadatum/metadatum-representation.model'; +import { ValueListBrowseDefinition } from '@dspace/core/shared/value-list-browse-definition.model'; + +import { MetadataLinkViewComponent } from '../../../metadata-link-view/metadata-link-view.component'; +import { AuthorityLinkMetadataListElementComponent } from './authority-link-metadata-list-element.component'; + + +const mockMetadataRepresentation = Object.assign(new MetadatumRepresentation('type'), { + key: 'dc.contributor.author', + value: 'Test Author', + browseDefinition: Object.assign(new ValueListBrowseDefinition(), { + id: 'author', + }), +} as Partial); + +const itemService = jasmine.createSpyObj('ItemDataService', { + findByIdWithProjections: jasmine.createSpy('findByIdWithProjections'), +}); + +describe('AuthorityLinkMetadataListElementComponent', () => { + let comp: AuthorityLinkMetadataListElementComponent; + let fixture: ComponentFixture; + + beforeEach(waitForAsync(() => { + void TestBed.configureTestingModule({ + imports: [AuthorityLinkMetadataListElementComponent, MetadataLinkViewComponent], + schemas: [NO_ERRORS_SCHEMA], + providers: [ + { provide: ItemDataService, useValue: itemService }, + ], + }).overrideComponent(AuthorityLinkMetadataListElementComponent, { + set: { changeDetection: ChangeDetectionStrategy.Default }, + }).compileComponents(); + })); + + beforeEach(() => { + fixture = TestBed.createComponent(AuthorityLinkMetadataListElementComponent); + comp = fixture.componentInstance; + }); + + describe('with authorithy controlled metadata', () => { + beforeEach(() => { + comp.mdRepresentation = mockMetadataRepresentation; + spyOnProperty(comp.mdRepresentation, 'representationType', 'get').and.returnValue(MetadataRepresentationType.AuthorityControlled); + fixture.detectChanges(); + }); + + it('should contain the value', () => { + expect(fixture.debugElement.nativeElement.textContent).toContain(mockMetadataRepresentation.value); + }); + + }); + +}); diff --git a/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.ts b/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.ts new file mode 100644 index 00000000000..6d4bbea52c8 --- /dev/null +++ b/src/app/shared/object-list/metadata-representation-list-element/authority-link/authority-link-metadata-list-element.component.ts @@ -0,0 +1,29 @@ + +import { + Component, + OnInit, +} from '@angular/core'; +import { MetadatumRepresentation } from '@dspace/core/shared/metadata-representation/metadatum/metadatum-representation.model'; + +import { MetadataLinkViewComponent } from '../../../metadata-link-view/metadata-link-view.component'; +import { MetadataRepresentationListElementComponent } from '../metadata-representation-list-element.component'; + +@Component({ + selector: 'ds-authority-link-metadata-list-element', + templateUrl: './authority-link-metadata-list-element.component.html', + imports: [ + MetadataLinkViewComponent, + ], +}) +/** + * A component for displaying MetadataRepresentation objects with authority in the form of a link + * It will simply use the value retrieved from MetadataRepresentation.getValue() to display a link to the item + */ +export class AuthorityLinkMetadataListElementComponent extends MetadataRepresentationListElementComponent implements OnInit { + + metadataValue: MetadatumRepresentation; + + ngOnInit() { + this.metadataValue = this.mdRepresentation as MetadatumRepresentation; + } +} diff --git a/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.html b/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.html index 2c9c7e44bd4..7d8c407e741 100644 --- a/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.html +++ b/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.html @@ -30,10 +30,9 @@

    + @for (author of authorMetadataList; track author.uuid; let last = $last) { + + @if (!last) { ; } diff --git a/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.spec.ts b/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.spec.ts index bc8d916f7f8..1e16028c1a7 100644 --- a/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.spec.ts +++ b/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.spec.ts @@ -19,6 +19,7 @@ import { import { of } from 'rxjs'; import { ThemedThumbnailComponent } from '../../../../thumbnail/themed-thumbnail.component'; +import { MetadataLinkViewComponent } from '../../../metadata-link-view/metadata-link-view.component'; import { ThemedBadgesComponent } from '../../../object-collection/shared/badges/themed-badges.component'; import { ItemCollectionComponent } from '../../../object-collection/shared/mydspace-item-collection/item-collection.component'; import { ItemSubmitterComponent } from '../../../object-collection/shared/mydspace-item-submitter/item-submitter.component'; @@ -119,6 +120,7 @@ describe('ItemListPreviewComponent', () => { ThemedThumbnailComponent, ThemedBadgesComponent, TruncatableComponent, TruncatablePartComponent, ItemSubmitterComponent, ItemCollectionComponent, + MetadataLinkViewComponent, ], }, }).compileComponents(); @@ -127,18 +129,12 @@ describe('ItemListPreviewComponent', () => { beforeEach(waitForAsync(() => { fixture = TestBed.createComponent(ItemListPreviewComponent); component = fixture.componentInstance; - - })); - - beforeEach(() => { component.object = { hitHighlights: {} } as any; - }); + component.item = mockItemWithAuthorAndDate; + fixture.detectChanges(); + })); describe('When showThumbnails is true', () => { - beforeEach(() => { - component.item = mockItemWithAuthorAndDate; - fixture.detectChanges(); - }); it('should add the thumbnail element', () => { const thumbnail = fixture.debugElement.query(By.css('ds-thumbnail')); expect(thumbnail).toBeTruthy(); @@ -146,35 +142,24 @@ describe('ItemListPreviewComponent', () => { }); describe('When the item has an author', () => { - beforeEach(() => { - component.item = mockItemWithAuthorAndDate; - fixture.detectChanges(); - }); - it('should show the author paragraph', () => { - const itemAuthorField = fixture.debugElement.query(By.css('span.item-list-authors')); + const itemAuthorField = fixture.debugElement.query(By.css('span.item-list-authors ds-metadata-link-view')); expect(itemAuthorField).not.toBeNull(); }); }); describe('When the item has no author', () => { - beforeEach(() => { + beforeEach(waitForAsync(() => { component.item = mockItemWithoutAuthorAndDate; fixture.detectChanges(); - }); - + })); it('should not show the author paragraph', () => { - const itemAuthorField = fixture.debugElement.query(By.css('span.item-list-authors')); + const itemAuthorField = fixture.debugElement.query(By.css('span.item-list-authors ds-metadata-link-view')); expect(itemAuthorField).toBeNull(); }); }); describe('When the item has an issuedate', () => { - beforeEach(() => { - component.item = mockItemWithAuthorAndDate; - fixture.detectChanges(); - }); - it('should show the issuedate span', () => { const dateField = fixture.debugElement.query(By.css('span.item-list-date')); expect(dateField).not.toBeNull(); @@ -182,11 +167,6 @@ describe('ItemListPreviewComponent', () => { }); describe('When the item has no issuedate', () => { - beforeEach(() => { - component.item = mockItemWithoutAuthorAndDate; - fixture.detectChanges(); - }); - it('should show the issuedate empty placeholder', () => { const dateField = fixture.debugElement.query(By.css('span.item-list-date')); expect(dateField).not.toBeNull(); @@ -205,54 +185,3 @@ describe('ItemListPreviewComponent', () => { }); }); }); - -describe('ItemListPreviewComponent', () => { - beforeEach(waitForAsync(() => { - TestBed.configureTestingModule({ - imports: [ - TranslateModule.forRoot({ - loader: { - provide: TranslateLoader, - useClass: TranslateLoaderMock, - }, - }), - NoopAnimationsModule, - ItemListPreviewComponent, TruncatePipe, - ], - providers: [ - { provide: 'objectElementProvider', useValue: { mockItemWithAuthorAndDate } }, - { provide: APP_CONFIG, useValue: enviromentNoThumbs }, - ], - schemas: [NO_ERRORS_SCHEMA], - }).overrideComponent(ItemListPreviewComponent, { - add: { changeDetection: ChangeDetectionStrategy.Default }, - remove: { - imports: [ - ThemedThumbnailComponent, ThemedBadgesComponent, - TruncatableComponent, TruncatablePartComponent, - ItemSubmitterComponent, ItemCollectionComponent, - ], - }, - }).compileComponents(); - })); - beforeEach(waitForAsync(() => { - fixture = TestBed.createComponent(ItemListPreviewComponent); - component = fixture.componentInstance; - - })); - - beforeEach(() => { - component.object = { hitHighlights: {} } as any; - }); - - describe('When showThumbnails is true', () => { - beforeEach(() => { - component.item = mockItemWithAuthorAndDate; - fixture.detectChanges(); - }); - it('should add the thumbnail element', () => { - const thumbnail = fixture.debugElement.query(By.css('ds-thumbnail')); - expect(thumbnail).toBeFalsy(); - }); - }); -}); diff --git a/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.ts b/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.ts index 0a60c7aa878..fab8d15cf98 100644 --- a/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.ts +++ b/src/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.ts @@ -15,12 +15,14 @@ import { import { DSONameService } from '@dspace/core/breadcrumbs/dso-name.service'; import { Context } from '@dspace/core/shared/context.model'; import { Item } from '@dspace/core/shared/item.model'; +import { MetadataValue } from '@dspace/core/shared/metadata.models'; import { SearchResult } from '@dspace/core/shared/search/models/search-result.model'; import { WorkflowItem } from '@dspace/core/submission/models/workflowitem.model'; import { TranslateModule } from '@ngx-translate/core'; import { ThemedThumbnailComponent } from '../../../../thumbnail/themed-thumbnail.component'; import { fadeInOut } from '../../../animations/fade'; +import { MetadataLinkViewComponent } from '../../../metadata-link-view/metadata-link-view.component'; import { ThemedBadgesComponent } from '../../../object-collection/shared/badges/themed-badges.component'; import { ItemCollectionComponent } from '../../../object-collection/shared/mydspace-item-collection/item-collection.component'; import { ItemSubmitterComponent } from '../../../object-collection/shared/mydspace-item-submitter/item-submitter.component'; @@ -39,6 +41,7 @@ import { TruncatablePartComponent } from '../../../truncatable/truncatable-part/ AsyncPipe, ItemCollectionComponent, ItemSubmitterComponent, + MetadataLinkViewComponent, NgClass, ThemedBadgesComponent, ThemedThumbnailComponent, @@ -81,6 +84,8 @@ export class ItemListPreviewComponent implements OnInit { dsoTitle: string; + authorMetadataList: MetadataValue[] = []; + constructor( @Inject(APP_CONFIG) protected appConfig: AppConfig, public dsoNameService: DSONameService, @@ -90,6 +95,7 @@ export class ItemListPreviewComponent implements OnInit { ngOnInit(): void { this.showThumbnails = this.appConfig.browseBy.showThumbnails; this.dsoTitle = this.dsoNameService.getHitHighlights(this.object, this.item, true); + this.authorMetadataList = this.item.allMetadata(['dc.contributor.author', 'dc.creator', 'dc.contributor.*'], undefined, true); } diff --git a/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.html b/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.html index ba12d01189a..3a2f5ed03af 100644 --- a/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.html +++ b/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.html @@ -23,45 +23,60 @@ }

    - @if (object !== undefined && object !== null) { - - @if (linkType !== linkTypes.None) { - - } - @if (linkType === linkTypes.None) { - - } - - - @if (firstMetadataValue('dc.publisher') || firstMetadataValue('dc.date.issued')) { - (@if (firstMetadataValue('dc.publisher')) { - - } - @if (firstMetadataValue('dc.publisher') && firstMetadataValue('dc.date.issued')) { - , - } - @if (firstMetadataValue('dc.date.issued')) { - - }) - } - @if (allMetadataValues(['dc.contributor.author', 'dc.creator', 'dc.contributor.*']).length > 0) { - - @for (author of allMetadataValues(['dc.contributor.author', 'dc.creator', 'dc.contributor.*']); track author; let last = $last) { - - - @if (!last) { - ; + @if (object !== undefined && object !== null) { + + @if (linkType !== linkTypes.None) { + + } + @if (linkType === linkTypes.None) { + + } + + + @if (firstMetadataValue('dc.publisher') || firstMetadataValue('dc.date.issued')) { + (@if (firstMetadataValue('dc.publisher')) { + + } + @if (firstMetadataValue('dc.publisher') && firstMetadataValue('dc.date.issued')) { + , + } + @if (firstMetadataValue('dc.date.issued')) { + + }) + } + @if (dso.allMetadataValues(authorMetadata, placeholderFilter).length > 0) { + + @let collapsed = isCollapsed() | async; + + @if (collapsed) { + @for (author of dso.limitedMetadata(authorMetadata, additionalMetadataLimit, placeholderFilter); track author; let last = $last) { + + + @if (!last) { + ; + } + + } + } + @if (!collapsed) { + @for (author of dso.allMetadata(authorMetadata, placeholderFilter); track author; let last = $last) { + + + @if (!last) { + ; + } + } - } - - } - - - @if (firstMetadataValue('dc.description.abstract'); as abstract) { + + + } + + + @if (firstMetadataValue('dc.description.abstract'); as abstract) {
    @@ -69,6 +84,6 @@
    }     - } - + } + diff --git a/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.spec.ts b/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.spec.ts index 242f4535a1a..2707d3b5339 100644 --- a/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.spec.ts +++ b/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.spec.ts @@ -13,6 +13,7 @@ import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { AuthService } from '@dspace/core/auth/auth.service'; import { DSONameService } from '@dspace/core/breadcrumbs/dso-name.service'; import { AuthorizationDataService } from '@dspace/core/data/feature-authorization/authorization-data.service'; +import { APP_DATA_SERVICES_MAP } from '@dspace/core/data-services-map-type'; import { Item } from '@dspace/core/shared/item.model'; import { ItemSearchResult } from '@dspace/core/shared/object-collection/item-search-result.model'; import { ActivatedRouteStub } from '@dspace/core/testing/active-router.stub'; @@ -24,6 +25,10 @@ import { import { mockTruncatableService } from '@dspace/core/testing/mock-trucatable.service'; import { TranslateModule } from '@ngx-translate/core'; import { of } from 'rxjs'; +import { MetadataLinkViewComponent } from 'src/app/shared/metadata-link-view/metadata-link-view.component'; +import { TruncatableComponent } from 'src/app/shared/truncatable/truncatable.component'; +import { TruncatablePartComponent } from 'src/app/shared/truncatable/truncatable-part/truncatable-part.component'; +import { ThemedThumbnailComponent } from 'src/app/thumbnail/themed-thumbnail.component'; import { getMockThemeService } from '../../../../../theme-support/test/theme-service.mock'; import { ThemeService } from '../../../../../theme-support/theme.service'; @@ -225,10 +230,18 @@ describe('ItemSearchResultListElementComponent', () => { 'invalidateAuthorizationsRequestCache', ]), }, + { provide: APP_DATA_SERVICES_MAP, useValue: {} }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(ItemSearchResultListElementComponent, { add: { changeDetection: ChangeDetectionStrategy.Default }, + }).overrideComponent(ItemSearchResultListElementComponent, { + remove: { imports: [ + ThemedThumbnailComponent, + TruncatableComponent, + TruncatablePartComponent, + MetadataLinkViewComponent, + ] }, }).compileComponents(); })); @@ -277,6 +290,32 @@ describe('ItemSearchResultListElementComponent', () => { }); }); + describe('When the item has authors and isCollapsed is true', () => { + beforeEach(() => { + spyOn(publicationListElementComponent, 'isCollapsed').and.returnValue(of(true)); + publicationListElementComponent.object = mockItemWithMetadata; + fixture.detectChanges(); + }); + + it('should show limitedMetadata', () => { + const authorElements = fixture.debugElement.queryAll(By.css('span.item-list-authors ds-metadata-link-view')); + expect(authorElements.length).toBe(mockItemWithMetadata.indexableObject.limitedMetadata(publicationListElementComponent.authorMetadata, publicationListElementComponent.additionalMetadataLimit).length); + }); + }); + + describe('When the item has authors and isCollapsed is false', () => { + beforeEach(() => { + spyOn(publicationListElementComponent, 'isCollapsed').and.returnValue(of(false)); + publicationListElementComponent.object = mockItemWithMetadata; + fixture.detectChanges(); + }); + + it('should show allMetadata', () => { + const authorElements = fixture.debugElement.queryAll(By.css('span.item-list-authors ds-metadata-link-view')); + expect(authorElements.length).toBe(mockItemWithMetadata.indexableObject.allMetadata(publicationListElementComponent.authorMetadata).length); + }); + }); + describe('When the item has a publisher', () => { beforeEach(() => { publicationListElementComponent.object = mockItemWithMetadata; @@ -413,6 +452,13 @@ describe('ItemSearchResultListElementComponent', () => { schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(ItemSearchResultListElementComponent, { set: { changeDetection: ChangeDetectionStrategy.Default }, + }).overrideComponent(ItemSearchResultListElementComponent, { + remove: { imports: [ + ThemedThumbnailComponent, + TruncatableComponent, + TruncatablePartComponent, + MetadataLinkViewComponent, + ] }, }).compileComponents(); })); diff --git a/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.ts b/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.ts index 8b4e3d028c3..ceecab94105 100644 --- a/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.ts +++ b/src/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.ts @@ -9,10 +9,14 @@ import { import { RouterLink } from '@angular/router'; import { getItemPageRoute } from '@dspace/core/router/utils/dso-route.utils'; import { Item } from '@dspace/core/shared/item.model'; +import { MetadataValueFilter } from '@dspace/core/shared/metadata.models'; +import { PLACEHOLDER_VALUE } from '@dspace/core/shared/metadata.utils'; import { ItemSearchResult } from '@dspace/core/shared/object-collection/item-search-result.model'; import { ViewMode } from '@dspace/core/shared/view-mode.model'; +import { environment } from '../../../../../../../environments/environment'; import { ThemedThumbnailComponent } from '../../../../../../thumbnail/themed-thumbnail.component'; +import { MetadataLinkViewComponent } from '../../../../../metadata-link-view/metadata-link-view.component'; import { ThemedBadgesComponent } from '../../../../../object-collection/shared/badges/themed-badges.component'; import { listableObjectComponent } from '../../../../../object-collection/shared/listable-object/listable-object.decorator'; import { TruncatableComponent } from '../../../../../truncatable/truncatable.component'; @@ -27,6 +31,7 @@ import { SearchResultListElementComponent } from '../../../search-result-list-el templateUrl: './item-search-result-list-element.component.html', imports: [ AsyncPipe, + MetadataLinkViewComponent, NgClass, RouterLink, ThemedBadgesComponent, @@ -44,6 +49,14 @@ export class ItemSearchResultListElementComponent extends SearchResultListElemen */ itemPageRoute: string; + authorMetadata = environment.searchResult.authorMetadata; + + + readonly placeholderFilter: MetadataValueFilter = { + negate: true, + value: PLACEHOLDER_VALUE, + }; + ngOnInit(): void { super.ngOnInit(); this.showThumbnails = this.showThumbnails ?? this.appConfig.browseBy.showThumbnails; diff --git a/src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts b/src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts index bfb85285442..dcff3a6967b 100644 --- a/src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts +++ b/src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts @@ -28,6 +28,11 @@ export class SearchResultListElementComponent, K exten dso: K; dsoTitle: string; + /** + * Limit of additional metadata values to show + */ + additionalMetadataLimit: number; + public constructor(protected truncatableService: TruncatableService, public dsoNameService: DSONameService, @Inject(APP_CONFIG) protected appConfig?: AppConfig) { @@ -38,6 +43,7 @@ export class SearchResultListElementComponent, K exten * Retrieve the dso from the search result */ ngOnInit(): void { + this.additionalMetadataLimit = this.appConfig?.followAuthorityMetadataValuesLimit; if (hasValue(this.object)) { this.dso = this.object.indexableObject; this.dsoTitle = this.dsoNameService.getHitHighlights(this.object, this.dso, true); diff --git a/src/app/shared/object-list/sidebar-search-list-element/sidebar-search-list-element.component.spec.ts b/src/app/shared/object-list/sidebar-search-list-element/sidebar-search-list-element.component.spec.ts index b9a1385087b..8f4111fb271 100644 --- a/src/app/shared/object-list/sidebar-search-list-element/sidebar-search-list-element.component.spec.ts +++ b/src/app/shared/object-list/sidebar-search-list-element/sidebar-search-list-element.component.spec.ts @@ -5,6 +5,7 @@ import { waitForAsync, } from '@angular/core/testing'; import { RouterTestingModule } from '@angular/router/testing'; +import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { DSONameService } from '@dspace/core/breadcrumbs/dso-name.service'; import { LinkService } from '@dspace/core/cache/builders/link.service'; import { ChildHALResource } from '@dspace/core/shared/child-hal-resource.model'; @@ -16,6 +17,7 @@ import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote import { TranslateModule } from '@ngx-translate/core'; import { TruncatableService } from '../../truncatable/truncatable.service'; +import { TruncatablePartComponent } from '../../truncatable/truncatable-part/truncatable-part.component'; import { VarDirective } from '../../utils/var.directive'; export function createSidebarSearchListElementTests( @@ -33,6 +35,12 @@ export function createSidebarSearchListElementTests( let linkService; + const environment = { + browseBy: { + showThumbnails: true, + }, + }; + beforeEach(waitForAsync(() => { linkService = jasmine.createSpyObj('linkService', { resolveLink: Object.assign(new HALResource(), { @@ -44,11 +52,12 @@ export function createSidebarSearchListElementTests( providers: [ { provide: TruncatableService, useValue: mockTruncatableService }, { provide: LinkService, useValue: linkService }, + { provide: APP_CONFIG, useValue: environment }, DSONameService, ...extraProviders, ], schemas: [NO_ERRORS_SCHEMA], - }).compileComponents(); + }).overrideComponent(componentClass, { remove: { imports: [TruncatablePartComponent] } }).compileComponents(); })); beforeEach(() => { diff --git a/src/app/shared/search/search-filters/search-filter/search-facet-filter/search-facet-filter.component.spec.ts b/src/app/shared/search/search-filters/search-filter/search-facet-filter/search-facet-filter.component.spec.ts index 647443d3a08..ee8f7344240 100644 --- a/src/app/shared/search/search-filters/search-filter/search-facet-filter/search-facet-filter.component.spec.ts +++ b/src/app/shared/search/search-filters/search-filter/search-facet-filter/search-facet-filter.component.spec.ts @@ -13,6 +13,7 @@ import { Router } from '@angular/router'; import { RemoteDataBuildService } from '@dspace/core/cache/builders/remote-data-build.service'; import { PageInfo } from '@dspace/core/shared/page-info.model'; import { AppliedFilter } from '@dspace/core/shared/search/models/applied-filter.model'; +import { FacetValue } from '@dspace/core/shared/search/models/facet-value.model'; import { FacetValues } from '@dspace/core/shared/search/models/facet-values.model'; import { FilterType } from '@dspace/core/shared/search/models/filter-type.model'; import { SearchFilterConfig } from '@dspace/core/shared/search/models/search-filter-config.model'; @@ -41,6 +42,8 @@ describe('SearchFacetFilterComponent', () => { const value2 = 'test2'; const value3 = 'another value3'; const value4 = '52d629dc-7d2f-47b9-aa2d-258b92e45ae1'; + const value5 = 'test authority'; + const authority = '52d629dc-7d2f-47b9-aa2d-258b92e45ae1'; const mockFilterConfig: SearchFilterConfig = Object.assign(new SearchFilterConfig(), { name: filterName1, filterType: FilterType.text, @@ -72,12 +75,40 @@ describe('SearchFacetFilterComponent', () => { label: value4, value: value4, }); + const appliedFilter5: AppliedFilter = Object.assign(new AppliedFilter(), { + filter: filterName1, + operator: 'authority', + label: authority, + value: authority, + }); + const facetValue1: FacetValue = Object.assign(new FacetValue(), { + label: value1, + value: value1, + }); + const facetValue2: FacetValue = Object.assign(new FacetValue(), { + label: value2, + value: value2, + }); + const facetValue3: FacetValue = Object.assign(new FacetValue(), { + label: value3, + value: value3, + }); + const facetValue4: FacetValue = Object.assign(new FacetValue(), { + label: value5, + value: authority, + }); const values: Partial = { appliedFilters: [ appliedFilter1, appliedFilter2, appliedFilter3, ], + page: [ + facetValue1, + facetValue2, + facetValue3, + facetValue4, + ], pageInfo: Object.assign(new PageInfo(), { currentPage: 0, }), @@ -246,4 +277,23 @@ describe('SearchFacetFilterComponent', () => { })); }); }); + + describe('when selected value has an authority', () => { + let selectedValues$: BehaviorSubject; + + beforeEach(() => { + selectedValues$ = new BehaviorSubject([appliedFilter5]); + spyOn(searchService, 'getSelectedValuesForFilter').and.returnValue(selectedValues$); + comp.ngOnInit(); + }); + + it('should updated the label with the one of the related FacetValue', () => { + const expectedValue = Object.assign(appliedFilter5, { + label: facetValue4.label, + }); + expect(comp.selectedAppliedFilters$).toBeObservable(cold('a', { + a: [expectedValue], + })); + }); + }); }); diff --git a/src/app/shared/search/search-filters/search-filter/search-facet-filter/search-facet-filter.component.ts b/src/app/shared/search/search-filters/search-filter/search-facet-filter/search-facet-filter.component.ts index 324cfc46b0c..d1bd15fd914 100644 --- a/src/app/shared/search/search-filters/search-filter/search-facet-filter/search-facet-filter.component.ts +++ b/src/app/shared/search/search-filters/search-filter/search-facet-filter/search-facet-filter.component.ts @@ -27,17 +27,23 @@ import { SearchOptions } from '@dspace/core/shared/search/models/search-options. import { hasNoValue, hasValue, + isNotEmpty, } from '@dspace/shared/utils/empty.util'; import { BehaviorSubject, + combineLatest, combineLatest as observableCombineLatest, + from, Observable, of, Subscription, } from 'rxjs'; import { distinctUntilChanged, + filter, map, + mergeMap, + reduce, switchMap, take, tap, @@ -46,6 +52,10 @@ import { import { SEARCH_CONFIG_SERVICE } from '../../../../../my-dspace-page/my-dspace-configuration.service'; import { InputSuggestion } from '../../../../input-suggestions/input-suggestions.model'; import { SearchService } from '../../../search.service'; +import { + getFacetValueForType, + stripOperatorFromFilterValue, +} from '../../../search.utils'; import { SearchConfigurationService } from '../../../search-configuration.service'; import { SearchFilterService } from '../../search-filter.service'; @@ -167,7 +177,29 @@ export class SearchFacetFilterComponent implements OnInit, OnDestroy { this.searchOptions$.subscribe(() => this.updateFilterValueList()), this.retrieveFilterValues().subscribe(), ); - this.selectedAppliedFilters$ = this.searchService.getSelectedValuesForFilter(this.filterConfig.name).pipe( + + this.selectedAppliedFilters$ = combineLatest([ + this.searchService.getSelectedValuesForFilter(this.filterConfig.name), + this.facetValues$.asObservable().pipe( + mergeMap((values: FacetValues[]) => from(values).pipe( + reduce((acc: FacetValue[], value: FacetValues) => acc.concat(value.page), []), + )), + ), + ]).pipe( + filter(([allAppliedFilters, facetValues]: [AppliedFilter[], FacetValue[]]) => isNotEmpty(facetValues)), + map(([allAppliedFilters, facetValues]) => + allAppliedFilters.map((appliedValue) => { + const fValue = facetValues.find((facetValue: FacetValue) => { + const valueForType = getFacetValueForType(facetValue, this.filterConfig); + return hasValue(valueForType) && + stripOperatorFromFilterValue(valueForType) === appliedValue.value; + }); + + return hasValue(fValue) + ? Object.assign(appliedValue, { label: fValue.label }) + : appliedValue; + }), + ), map((allAppliedFilters: AppliedFilter[]) => allAppliedFilters.filter((appliedFilter: AppliedFilter) => FACET_OPERATORS.includes(appliedFilter.operator))), distinctUntilChanged((previous: AppliedFilter[], next: AppliedFilter[]) => JSON.stringify(previous) === JSON.stringify(next)), ); diff --git a/src/app/shared/search/search-labels/search-labels.component.html b/src/app/shared/search/search-labels/search-labels.component.html index de8e59de78e..c7f70e0e110 100644 --- a/src/app/shared/search/search-labels/search-labels.component.html +++ b/src/app/shared/search/search-labels/search-labels.component.html @@ -1,5 +1,5 @@
    - @for (appliedFilter of appliedFilters$ | async; track appliedFilter) { + @for (appliedFilter of appliedFilters$ | async; track appliedFilter.value) { diff --git a/src/app/submission/edit/pending-changes/pending-changes.guard.spec.ts b/src/app/submission/edit/pending-changes/pending-changes.guard.spec.ts new file mode 100644 index 00000000000..8e456a7e370 --- /dev/null +++ b/src/app/submission/edit/pending-changes/pending-changes.guard.spec.ts @@ -0,0 +1,82 @@ +import { + TestBed, + waitForAsync, +} from '@angular/core/testing'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { cold } from 'jasmine-marbles'; +import { + Observable, + of, +} from 'rxjs'; + +import { SubmissionEditCanDeactivateService } from '../submission-edit-can-deactivate.service'; +import { pendingChangesGuard } from './pending-changes.guard'; +import SpyObj = jasmine.SpyObj; + +describe('pendingChangesGuard', () => { + + let modalService: SpyObj; + + const modalStub: any = { + componentInstance: { + headerLabel: 'headerLabel', + infoLabel: 'infoLabel', + cancelLabel: 'cancelLabel', + confirmLabel: 'confirmLabel', + brandColor: 'brandColor', + confirmIcon: 'confirmIcon', + response: of(true), + }, + }; + + const canDeactivateServiceSpy = jasmine.createSpyObj('canDeactivateService', ['canDeactivate']); + + const modalServiceSpy = jasmine.createSpyObj('modalService', { + open: jasmine.createSpy('open'), + }); + + beforeEach(waitForAsync(() => { + TestBed.configureTestingModule({ + imports: [], + providers: [ + { provide: NgbModal, useValue: modalServiceSpy }, + { provide: SubmissionEditCanDeactivateService, useValue: canDeactivateServiceSpy }, + ], + }); + modalService = TestBed.inject(NgbModal) as SpyObj; + modalService.open.and.returnValue(modalStub); + })); + + it('should be created', () => { + expect(pendingChangesGuard).toBeTruthy(); + }); + + describe('when there are unsaved changes', () => { + beforeEach(() => { + canDeactivateServiceSpy.canDeactivate.and.returnValue(of(false)); + }); + it('should open confirmation modal', () => { + const result$ = TestBed.runInInjectionContext(() => { + return pendingChangesGuard({ params: { id: 'test-id' } } as any, null, null, null); + }) as Observable; + result$.subscribe(() => { + expect(modalService.open).toHaveBeenCalled(); + }); + }); + }); + + describe('when there are not unsaved changes', () => { + beforeEach(() => { + canDeactivateServiceSpy.canDeactivate.and.returnValue(of(true)); + }); + it('should allow navigation', () => { + TestBed.runInInjectionContext(() => { + const result = pendingChangesGuard({ params: { id: 'test-id' } } as any, null, null, null); + const expected = cold('(a|)', { + a: true, + }); + expect(result).toBeObservable(expected); + }); + }); + }); +}); diff --git a/src/app/submission/edit/pending-changes/pending-changes.guard.ts b/src/app/submission/edit/pending-changes/pending-changes.guard.ts new file mode 100644 index 00000000000..a767814a4e7 --- /dev/null +++ b/src/app/submission/edit/pending-changes/pending-changes.guard.ts @@ -0,0 +1,43 @@ +import { inject } from '@angular/core'; +import { + ActivatedRouteSnapshot, + CanDeactivateFn, + RouterStateSnapshot, +} from '@angular/router'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + Observable, + of, +} from 'rxjs'; +import { switchMap } from 'rxjs/operators'; + +import { ConfirmationModalComponent } from '../../../shared/confirmation-modal/confirmation-modal.component'; +import { SubmissionEditCanDeactivateService } from '../submission-edit-can-deactivate.service'; +import { ThemedSubmissionEditComponent } from '../themed-submission-edit.component'; + +export const pendingChangesGuard: CanDeactivateFn = ( + component: ThemedSubmissionEditComponent, + route: ActivatedRouteSnapshot, + state: RouterStateSnapshot, +): Observable => { + const modalService = inject(NgbModal); + const canDeactivateService = inject(SubmissionEditCanDeactivateService); + + return canDeactivateService.canDeactivate(route?.params?.id).pipe( + switchMap((canDeactivate) => { + if (canDeactivate) { + return of(true); + } else { + const modalRef = modalService.open(ConfirmationModalComponent); + const labelPrefix = 'confirmation-modal.pending-changes.'; + modalRef.componentInstance.headerLabel = labelPrefix + 'header'; + modalRef.componentInstance.infoLabel = labelPrefix + 'info'; + modalRef.componentInstance.cancelLabel = labelPrefix + 'cancel'; + modalRef.componentInstance.confirmLabel = labelPrefix + 'confirm'; + modalRef.componentInstance.brandColor = 'danger'; + modalRef.componentInstance.confirmIcon = 'fas fa-trash'; + return modalRef.componentInstance.response as Observable; + } + }), + ); +}; diff --git a/src/app/submission/edit/submission-edit-can-deactivate.service.spec.ts b/src/app/submission/edit/submission-edit-can-deactivate.service.spec.ts new file mode 100644 index 00000000000..6076aeb827d --- /dev/null +++ b/src/app/submission/edit/submission-edit-can-deactivate.service.spec.ts @@ -0,0 +1,98 @@ +import { TestBed } from '@angular/core/testing'; +import { + ActivatedRoute, + Router, +} from '@angular/router'; +import { cold } from 'jasmine-marbles'; +import { of } from 'rxjs'; + +import { SubmissionService } from '../submission.service'; +import { SubmissionEditCanDeactivateService } from './submission-edit-can-deactivate.service'; + +describe('SubmissionEditCanDeactivateService', () => { + let service: SubmissionEditCanDeactivateService; + let submissionService: SubmissionService; + + const submissionServiceSpy = jasmine.createSpyObj('submissionService', ['hasUnsavedModification', 'isSubmissionDiscarding']); + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [], + providers: [ + { provide: ActivatedRoute, useValue: {} }, + { provide: Router, useValue: {} }, + { provide: SubmissionService, useValue: submissionServiceSpy }, + ], + }); + service = TestBed.inject(SubmissionEditCanDeactivateService); + submissionService = TestBed.inject(SubmissionService); + }); + + it('should be created', () => { + expect(service).toBeTruthy(); + }); + + describe('when submission is discarding', () => { + beforeEach(() => { + submissionServiceSpy.isSubmissionDiscarding.and.returnValue(of(true)); + }); + + describe('and there are unsaved changes', () => { + beforeEach(() => { + submissionServiceSpy.hasUnsavedModification.and.returnValue(of(true)); + }); + it('canDeactivate() should return true', () => { + const result = service.canDeactivate('id'); + const expected = cold('(a|)', { + a: true, + }); + expect(result).toBeObservable(expected); + }); + }); + + describe('and there are not unsaved changes', () => { + beforeEach(() => { + submissionServiceSpy.hasUnsavedModification.and.returnValue(of(false)); + }); + it('canDeactivate() should return true', () => { + const result = service.canDeactivate('id'); + const expected = cold('(a|)', { + a: true, + }); + expect(result).toBeObservable(expected); + }); + }); + }); + + describe('when submission is not discarding', () => { + beforeEach(() => { + submissionServiceSpy.isSubmissionDiscarding.and.returnValue(of(false)); + }); + + describe('and there are unsaved changes', () => { + beforeEach(() => { + submissionServiceSpy.hasUnsavedModification.and.returnValue(of(true)); + }); + it('canDeactivate() should return false', () => { + const result = service.canDeactivate('id'); + const expected = cold('(a|)', { + a: false, + }); + expect(result).toBeObservable(expected); + }); + }); + + describe('and there are not unsaved changes', () => { + beforeEach(() => { + submissionServiceSpy.hasUnsavedModification.and.returnValue(of(false)); + }); + it('canDeactivate() should return true', () => { + const result = service.canDeactivate('id'); + const expected = cold('(a|)', { + a: true, + }); + expect(result).toBeObservable(expected); + }); + }); + }); +}); diff --git a/src/app/submission/edit/submission-edit-can-deactivate.service.ts b/src/app/submission/edit/submission-edit-can-deactivate.service.ts new file mode 100644 index 00000000000..bac092ede21 --- /dev/null +++ b/src/app/submission/edit/submission-edit-can-deactivate.service.ts @@ -0,0 +1,38 @@ +import { Injectable } from '@angular/core'; +import { + ActivatedRoute, + Router, +} from '@angular/router'; +import { + combineLatest, + Observable, +} from 'rxjs'; +import { map } from 'rxjs/operators'; + +import { SubmissionService } from '../submission.service'; + +interface PendingChangesGuardComponentInterface { + canDeactivate: (id: string) => boolean | Observable; +} + +@Injectable({ + providedIn: 'root', +}) +export class SubmissionEditCanDeactivateService implements PendingChangesGuardComponentInterface { + + constructor( + private route: ActivatedRoute, + private router: Router, + private submissionService: SubmissionService, + ) { } + + public canDeactivate(id: string): Observable { + return combineLatest([ + this.submissionService.isSubmissionDiscarding(id), + this.submissionService.hasUnsavedModification(), + ]).pipe( + map(([isSubmissionDiscarding,hasUnsavedModification]) => isSubmissionDiscarding || !hasUnsavedModification), + ); + } + +} diff --git a/src/app/submission/edit/submission-edit.component.html b/src/app/submission/edit/submission-edit.component.html index 40b569c2020..7311a65fbf0 100644 --- a/src/app/submission/edit/submission-edit.component.html +++ b/src/app/submission/edit/submission-edit.component.html @@ -7,5 +7,6 @@ [item]="item" [collectionModifiable]="collectionModifiable" [submissionId]="submissionId" + [metadataSecurityConfiguration]="metadataSecurityConfiguration" [entityType]="entityType">
    diff --git a/src/app/submission/edit/submission-edit.component.spec.ts b/src/app/submission/edit/submission-edit.component.spec.ts index b00d0bdbb6e..eb0eecfee9c 100644 --- a/src/app/submission/edit/submission-edit.component.spec.ts +++ b/src/app/submission/edit/submission-edit.component.spec.ts @@ -11,10 +11,12 @@ import { } from '@angular/router'; import { RouterTestingModule } from '@angular/router/testing'; import { AuthService } from '@dspace/core/auth/auth.service'; +import { CollectionDataService } from '@dspace/core/data/collection-data.service'; import { ItemDataService } from '@dspace/core/data/item-data.service'; import { APP_DATA_SERVICES_MAP } from '@dspace/core/data-services-map-type'; import { NotificationsService } from '@dspace/core/notification-system/notifications.service'; import { HALEndpointService } from '@dspace/core/shared/hal-endpoint.service'; +import { MetadataSecurityConfigurationService } from '@dspace/core/submission/metadatasecurityconfig-data.service'; import { SubmissionJsonPatchOperationsService } from '@dspace/core/submission/submission-json-patch-operations.service'; import { ActivatedRouteStub } from '@dspace/core/testing/active-router.stub'; import { AuthServiceStub } from '@dspace/core/testing/auth-service.stub'; @@ -36,6 +38,7 @@ import { SectionsService } from '../sections/sections.service'; import { SubmissionService } from '../submission.service'; import { mockSubmissionObject } from '../utils/submission.mock'; import { SubmissionEditComponent } from './submission-edit.component'; +import { SubmissionEditCanDeactivateService } from './submission-edit-can-deactivate.service'; describe('SubmissionEditComponent Component', () => { @@ -43,6 +46,9 @@ describe('SubmissionEditComponent Component', () => { let fixture: ComponentFixture; let submissionServiceStub: SubmissionServiceStub; let itemDataService: ItemDataService; + let metadataSecurityConfigDataService: MetadataSecurityConfigurationService; + let canDeactivateService: SubmissionEditCanDeactivateService; + let collectionDataService: CollectionDataService; let submissionJsonPatchOperationsServiceStub: SubmissionJsonPatchOperationsServiceStub; let router: RouterStub; let halService: jasmine.SpyObj; @@ -59,14 +65,29 @@ describe('SubmissionEditComponent Component', () => { }, }); - beforeEach(waitForAsync(() => { - itemDataService = jasmine.createSpyObj('itemDataService', { - findByHref: createSuccessfulRemoteDataObject$(submissionObject.item), - }); + const collectionDataServiceSpy: jasmine.SpyObj = jasmine.createSpyObj('collectionDataService', { + findById: jasmine.createSpy('findById'), + getAuthorizedCollectionByCommunity: jasmine.createSpy('getAuthorizedCollectionByCommunity'), + getAuthorizedCollectionByCommunityAndEntityType: jasmine.createSpy('getAuthorizedCollectionByCommunityAndEntityType'), + }); + + const canDeactivateServiceSpy: jasmine.SpyObj = jasmine.createSpyObj('canDeactivateService', { + canDeactivate: of(true), + }); + const itemDataServiceSpy = jasmine.createSpyObj('itemDataService', { + findByHref: createSuccessfulRemoteDataObject$(submissionObject.item), + }); + + halService = jasmine.createSpyObj('halService', { + getEndpoint: of('fake-url'), + }); + + const metadataSecurityConfigDataServiceSpy = jasmine.createSpyObj('metadataSecurityConfigDataService', { + findById: createSuccessfulRemoteDataObject$(submissionObject.metadataSecurityConfiguration), + }); - halService = jasmine.createSpyObj('halService', { - getEndpoint: of('fake-url'), - }); + + beforeEach(waitForAsync(() => { TestBed.configureTestingModule({ imports: [ @@ -80,7 +101,9 @@ describe('SubmissionEditComponent Component', () => { { provide: NotificationsService, useClass: NotificationsServiceStub }, { provide: SubmissionService, useClass: SubmissionServiceStub }, { provide: SubmissionJsonPatchOperationsService, useClass: SubmissionJsonPatchOperationsServiceStub }, - { provide: ItemDataService, useValue: itemDataService }, + { provide: ItemDataService, useValue: itemDataServiceSpy }, + { provide: MetadataSecurityConfigurationService, useValue: metadataSecurityConfigDataServiceSpy }, + { provide: CollectionDataService, useValue: collectionDataServiceSpy }, { provide: Router, useValue: new RouterStub() }, { provide: ActivatedRoute, useValue: route }, { provide: AuthService, useValue: new AuthServiceStub() }, @@ -90,6 +113,7 @@ describe('SubmissionEditComponent Component', () => { { provide: XSRFService, useValue: {} }, { provide: APP_DATA_SERVICES_MAP, useValue: {} }, provideMockStore(), + { provide: SubmissionEditCanDeactivateService, useValue: canDeactivateServiceSpy }, ], schemas: [NO_ERRORS_SCHEMA], }).overrideComponent(SubmissionEditComponent, { @@ -105,6 +129,10 @@ describe('SubmissionEditComponent Component', () => { submissionServiceStub = TestBed.inject(SubmissionService as any); submissionJsonPatchOperationsServiceStub = TestBed.inject(SubmissionJsonPatchOperationsService as any); router = TestBed.inject(Router as any); + canDeactivateService = TestBed.inject(SubmissionEditCanDeactivateService); + collectionDataService = TestBed.inject(CollectionDataService); + itemDataService = TestBed.inject(ItemDataService); + metadataSecurityConfigDataService = TestBed.inject(MetadataSecurityConfigurationService); }); afterEach(() => { @@ -174,5 +202,4 @@ describe('SubmissionEditComponent Component', () => { }); - }); diff --git a/src/app/submission/edit/submission-edit.component.ts b/src/app/submission/edit/submission-edit.component.ts index ded2c60e1ef..83c637c1b8b 100644 --- a/src/app/submission/edit/submission-edit.component.ts +++ b/src/app/submission/edit/submission-edit.component.ts @@ -1,6 +1,7 @@ import { ChangeDetectorRef, Component, + HostListener, OnDestroy, OnInit, } from '@angular/core'; @@ -15,31 +16,42 @@ import { RemoteData } from '@dspace/core/data/remote-data'; import { NotificationsService } from '@dspace/core/notification-system/notifications.service'; import { Collection } from '@dspace/core/shared/collection.model'; import { Item } from '@dspace/core/shared/item.model'; -import { getAllSucceededRemoteData } from '@dspace/core/shared/operators'; +import { + getAllSucceededRemoteData, + getFirstCompletedRemoteData, +} from '@dspace/core/shared/operators'; +import { MetadataSecurityConfigurationService } from '@dspace/core/submission/metadatasecurityconfig-data.service'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { SubmissionError } from '@dspace/core/submission/models/submission-error.model'; import { SubmissionObject } from '@dspace/core/submission/models/submission-object.model'; import { WorkspaceitemSectionsObject } from '@dspace/core/submission/models/workspaceitem-sections.model'; import { SubmissionJsonPatchOperationsService } from '@dspace/core/submission/submission-json-patch-operations.service'; +import { createFailedRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; import { hasValue, isEmpty, + isNotEmpty, isNotEmptyOperator, isNotNull, } from '@dspace/shared/utils/empty.util'; import { TranslateService } from '@ngx-translate/core'; import { BehaviorSubject, + combineLatest, + of, Subscription, } from 'rxjs'; import { debounceTime, filter, + mergeMap, switchMap, } from 'rxjs/operators'; import { ThemedSubmissionFormComponent } from '../form/themed-submission-form.component'; import { SubmissionService } from '../submission.service'; import parseSectionErrors from '../utils/parseSectionErrors'; +import { SubmissionEditCanDeactivateService } from './submission-edit-can-deactivate.service'; /** * This component allows to edit an existing workspaceitem/workflowitem. @@ -118,6 +130,12 @@ export class SubmissionEditComponent implements OnDestroy, OnInit { * The item for this submission. */ public item: Item; + /** + * The metadata security configuration for the entity. + */ + public metadataSecurityConfiguration: MetadataSecurityConfiguration; + + private canDeactivate = false; /** * Initialize instance variables @@ -130,15 +148,27 @@ export class SubmissionEditComponent implements OnDestroy, OnInit { * @param {SubmissionService} submissionService * @param {TranslateService} translate * @param {SubmissionJsonPatchOperationsService} submissionJsonPatchOperationsService + * @param metadataSecurityConfigDataService + * @param canDeactivateService */ - constructor(private changeDetectorRef: ChangeDetectorRef, - private notificationsService: NotificationsService, - private route: ActivatedRoute, - private router: Router, - private itemDataService: ItemDataService, - private submissionService: SubmissionService, - private translate: TranslateService, - private submissionJsonPatchOperationsService: SubmissionJsonPatchOperationsService) { + constructor( + private changeDetectorRef: ChangeDetectorRef, + private notificationsService: NotificationsService, + private route: ActivatedRoute, + private router: Router, + private itemDataService: ItemDataService, + private submissionService: SubmissionService, + private translate: TranslateService, + private submissionJsonPatchOperationsService: SubmissionJsonPatchOperationsService, + private metadataSecurityConfigDataService: MetadataSecurityConfigurationService, + private canDeactivateService: SubmissionEditCanDeactivateService, + ) { + } + + // @HostListener allows to also guard against browser refresh, close, etc. + @HostListener('window:beforeunload') + preventRefresh(): boolean { + return this.canDeactivate; } /** @@ -150,15 +180,43 @@ export class SubmissionEditComponent implements OnDestroy, OnInit { this.subs.push( this.route.paramMap.pipe( - switchMap((params: ParamMap) => this.submissionService.retrieveSubmission(params.get('id'))), - // NOTE new submission is retrieved on the browser side only, so get null on server side rendering - filter((submissionObjectRD: RemoteData) => isNotNull(submissionObjectRD)), - ).subscribe((submissionObjectRD: RemoteData) => { + switchMap((params: ParamMap) => this.canDeactivateService.canDeactivate(params.get('id'))), + ).subscribe((res) => { + this.canDeactivate = res; + }), + this.route.paramMap.pipe( + switchMap((params: ParamMap) => this.submissionService.retrieveSubmission(params.get('id'), ['full','allLanguages']).pipe( + // NOTE new submission is retrieved on the browser side only, so get null on server side rendering + filter((submissionObjectRD: RemoteData) => isNotNull(submissionObjectRD)), + mergeMap((submissionObjectRD: RemoteData) => combineLatest([ + of(submissionObjectRD), + of(submissionObjectRD).pipe( + mergeMap(() => { + if (submissionObjectRD.hasSucceeded && isNotEmpty(submissionObjectRD.payload)) { + const metadata = (submissionObjectRD.payload.collection as Collection).metadata['dspace.entity.type']; + if (metadata && metadata[0]) { + this.entityType = metadata[0].value; + } + // get security configuration based on entity type + return this.metadataSecurityConfigDataService.findById(this.entityType).pipe( + getFirstCompletedRemoteData(), + ); + } else { + return createFailedRemoteDataObject$(); + } + }), + ), + ]), + ))), + ).subscribe(([submissionObjectRD, metadataSecurityRD]: [RemoteData, RemoteData]) => { if (submissionObjectRD.hasSucceeded) { if (isEmpty(submissionObjectRD.payload)) { this.notificationsService.info(null, this.translate.get('submission.general.cannot_submit')); this.router.navigate(['/mydspace']); } else { + if (metadataSecurityRD.hasSucceeded) { + this.metadataSecurityConfiguration = metadataSecurityRD.payload; + } const collection = submissionObjectRD.payload.collection as Collection; this.entityType = (hasValue(collection) && collection.hasMetadata('dspace.entity.type')) ? collection.firstMetadataValue('dspace.entity.type') : null; @@ -177,7 +235,6 @@ export class SubmissionEditComponent implements OnDestroy, OnInit { // redirect to not found page this.router.navigate(['/404'], { skipLocationChange: true }); } - // TODO handle generic error } }), this.itemLink$.pipe( diff --git a/src/app/submission/form/submission-form.component.spec.ts b/src/app/submission/form/submission-form.component.spec.ts index 66d31e23bf2..d686ec5f29e 100644 --- a/src/app/submission/form/submission-form.component.spec.ts +++ b/src/app/submission/form/submission-form.component.spec.ts @@ -12,11 +12,13 @@ import { import { AuthService } from '@dspace/core/auth/auth.service'; import { HALEndpointService } from '@dspace/core/shared/hal-endpoint.service'; import { Item } from '@dspace/core/shared/item.model'; +import { MetadataSecurityConfigurationService } from '@dspace/core/submission/metadatasecurityconfig-data.service'; import { VisibilityType } from '@dspace/core/submission/visibility-type'; import { AuthServiceStub } from '@dspace/core/testing/auth-service.stub'; import { HALEndpointServiceStub } from '@dspace/core/testing/hal-endpoint-service.stub'; import { SubmissionServiceStub } from '@dspace/core/testing/submission-service.stub'; import { createTestComponent } from '@dspace/core/testing/utils.test'; +import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; import { TranslateModule } from '@ngx-translate/core'; import { cold, @@ -35,6 +37,7 @@ import { mockSubmissionCollectionId, mockSubmissionDefinition, mockSubmissionId, + mockSubmissionObject, mockSubmissionObjectNew, mockSubmissionSelfUrl, mockSubmissionState, @@ -52,7 +55,9 @@ describe('SubmissionFormComponent', () => { let fixture: ComponentFixture; let authServiceStub: AuthServiceStub; let scheduler: TestScheduler; + let metadataSecurityConfigDataService: MetadataSecurityConfigurationService; + const submissionObject: any = mockSubmissionObject; const submissionServiceStub: SubmissionServiceStub = new SubmissionServiceStub(); const submissionId = mockSubmissionId; const collectionId = mockSubmissionCollectionId; @@ -64,6 +69,9 @@ describe('SubmissionFormComponent', () => { const sectionsData: any = mockSectionsData; beforeEach(waitForAsync(() => { + metadataSecurityConfigDataService = jasmine.createSpyObj('metadataSecurityConfigDataService', { + findById: createSuccessfulRemoteDataObject$(submissionObject.metadataSecurityConfiguration), + }); TestBed.configureTestingModule({ imports: [ SubmissionFormComponent, @@ -74,6 +82,7 @@ describe('SubmissionFormComponent', () => { { provide: AuthService, useClass: AuthServiceStub }, { provide: HALEndpointService, useValue: new HALEndpointServiceStub('workspaceitems') }, { provide: SubmissionService, useValue: submissionServiceStub }, + { provide: MetadataSecurityConfigurationService, useValue: metadataSecurityConfigDataService }, { provide: SectionsService, useValue: { isSectionTypeAvailable: () => of(true) } }, ChangeDetectorRef, SubmissionFormComponent, @@ -158,7 +167,7 @@ describe('SubmissionFormComponent', () => { comp.sections = sectionsData; comp.submissionErrors = null; comp.item = new Item(); - + comp.entityType = 'publication'; submissionServiceStub.getSubmissionObject.and.returnValue(of(submissionState)); submissionServiceStub.getSubmissionSections.and.returnValue(of(sectionsList)); spyOn(authServiceStub, 'buildAuthHeader').and.returnValue('token'); @@ -181,7 +190,8 @@ describe('SubmissionFormComponent', () => { submissionDefinition, sectionsData, comp.item, - null); + null, + undefined); expect(submissionServiceStub.startAutoSave).toHaveBeenCalled(); done(); }); @@ -219,6 +229,7 @@ describe('SubmissionFormComponent', () => { comp.selfUrl = selfUrl; comp.sections = sectionsData; comp.item = new Item(); + comp.entityType = 'publication'; scheduler.schedule(() => { comp.onCollectionChange(submissionObjectNew); @@ -237,6 +248,7 @@ describe('SubmissionFormComponent', () => { submissionObjectNew.submissionDefinition, submissionObjectNew.sections, comp.item, + submissionObject.metadataSecurityConfiguration, ); done(); }); @@ -249,6 +261,7 @@ describe('SubmissionFormComponent', () => { comp.selfUrl = selfUrl; comp.sections = sectionsData; comp.item = new Item(); + comp.entityType = 'publication'; scheduler.schedule(() => { comp.onCollectionChange({ diff --git a/src/app/submission/form/submission-form.component.ts b/src/app/submission/form/submission-form.component.ts index 89ca7286df0..06b0406bafd 100644 --- a/src/app/submission/form/submission-form.component.ts +++ b/src/app/submission/form/submission-form.component.ts @@ -13,6 +13,9 @@ import { SubmissionSectionModel } from '@dspace/core/config/models/config-submis import { Collection } from '@dspace/core/shared/collection.model'; import { HALEndpointService } from '@dspace/core/shared/hal-endpoint.service'; import { Item } from '@dspace/core/shared/item.model'; +import { getFirstCompletedRemoteData } from '@dspace/core/shared/operators'; +import { MetadataSecurityConfigurationService } from '@dspace/core/submission/metadatasecurityconfig-data.service'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { SectionVisibility } from '@dspace/core/submission/models/section-visibility.model'; import { SubmissionError } from '@dspace/core/submission/models/submission-error.model'; import { SubmissionObject } from '@dspace/core/submission/models/submission-object.model'; @@ -114,7 +117,11 @@ export class SubmissionFormComponent implements OnChanges, OnDestroy { * @type {string} */ @Input() submissionId: string; - + /** + * The metadata security config based on the entity type + * @type {MetadataSecurityConfiguration} + */ + @Input() metadataSecurityConfiguration: MetadataSecurityConfiguration; /** * The entity type input used to create a new submission * @type {string} @@ -170,13 +177,15 @@ export class SubmissionFormComponent implements OnChanges, OnDestroy { * @param {HALEndpointService} halService * @param {SubmissionService} submissionService * @param {SectionsService} sectionsService + * @param metadataSecurityConfigDataService */ constructor( private authService: AuthService, private changeDetectorRef: ChangeDetectorRef, private halService: HALEndpointService, private submissionService: SubmissionService, - private sectionsService: SectionsService) { + private sectionsService: SectionsService, + private metadataSecurityConfigDataService: MetadataSecurityConfigurationService) { this.isActive = true; } @@ -226,7 +235,8 @@ export class SubmissionFormComponent implements OnChanges, OnDestroy { this.submissionDefinition, this.sections, this.item, - this.submissionErrors); + this.submissionErrors, + this.metadataSecurityConfiguration); this.changeDetectorRef.detectChanges(); }), ); @@ -293,20 +303,32 @@ export class SubmissionFormComponent implements OnChanges, OnDestroy { * new submission object */ onCollectionChange(submissionObject: SubmissionObject) { - if (this.definitionId !== (submissionObject.submissionDefinition as SubmissionDefinitionsModel).name) { - this.sections = submissionObject.sections; - this.submissionDefinition = (submissionObject.submissionDefinition as SubmissionDefinitionsModel); - this.definitionId = this.submissionDefinition.name; - this.submissionService.resetSubmissionObject( - (submissionObject.collection as Collection).id, - this.submissionId, - submissionObject._links.self.href, - this.submissionDefinition, - this.sections, - this.item); - } else { - this.changeDetectorRef.detectChanges(); + const metadata = (submissionObject.collection as Collection).metadata ? (submissionObject.collection as Collection).metadata['dspace.entity.type'] : null; + if (metadata && metadata[0]) { + this.entityType = metadata[0].value; } + this.metadataSecurityConfigDataService.findById(this.entityType).pipe( + getFirstCompletedRemoteData(), + ).subscribe(res => { + this.metadataSecurityConfiguration = res.payload; + this.collectionId = (submissionObject.collection as Collection).id; + if (this.definitionId !== (submissionObject.submissionDefinition as SubmissionDefinitionsModel).name) { + this.sections = submissionObject.sections; + this.submissionDefinition = (submissionObject.submissionDefinition as SubmissionDefinitionsModel); + this.definitionId = this.submissionDefinition.name; + this.submissionService.resetSubmissionObject( + (submissionObject.collection as Collection).id, + this.submissionId, + submissionObject._links.self.href, + this.submissionDefinition, + this.sections, + this.item, + this.metadataSecurityConfiguration, + ); + } else { + this.changeDetectorRef.detectChanges(); + } + }); } protected getSectionsList(): Observable { diff --git a/src/app/submission/form/submission-upload-files/submission-upload-files.component.spec.ts b/src/app/submission/form/submission-upload-files/submission-upload-files.component.spec.ts index 1673faa7828..cca72508de3 100644 --- a/src/app/submission/form/submission-upload-files/submission-upload-files.component.spec.ts +++ b/src/app/submission/form/submission-upload-files/submission-upload-files.component.spec.ts @@ -36,7 +36,6 @@ import { mockSubmissionCollectionId, mockSubmissionId, mockSubmissionObject, - mockUploadResponse1ParsedErrors, mockUploadResponse2Errors, mockUploadResponse2ParsedErrors, } from '../../utils/submission.mock'; @@ -164,16 +163,19 @@ describe('SubmissionUploadFilesComponent Component', () => { }); it('should show a success notification and call updateSectionData if successful', () => { - const expectedErrors: any = mockUploadResponse1ParsedErrors; + const expectedErrors: any = []; fixture.detectChanges(); + const data = { + upload: { + files: [{ url: 'testUrl' }], + } }; + comp.onCompleteItem(Object.assign({}, uploadRestResponse, { sections: data })); - comp.onCompleteItem(Object.assign({}, uploadRestResponse, { sections: mockSectionsData })); - - Object.keys(mockSectionsData).forEach((sectionId) => { + Object.keys(data).forEach((sectionId) => { expect(sectionsServiceStub.updateSectionData).toHaveBeenCalledWith( submissionId, sectionId, - mockSectionsData[sectionId], + data[sectionId], expectedErrors[sectionId], expectedErrors[sectionId], ); diff --git a/src/app/submission/form/themed-submission-form.component.ts b/src/app/submission/form/themed-submission-form.component.ts index 20c4d375276..9a8afbcb24b 100644 --- a/src/app/submission/form/themed-submission-form.component.ts +++ b/src/app/submission/form/themed-submission-form.component.ts @@ -4,6 +4,7 @@ import { } from '@angular/core'; import { SubmissionDefinitionsModel } from '@dspace/core/config/models/config-submission-definitions.model'; import { Item } from '@dspace/core/shared/item.model'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { SubmissionError } from '@dspace/core/submission/models/submission-error.model'; import { WorkspaceitemSectionsObject } from '@dspace/core/submission/models/workspaceitem-sections.model'; @@ -33,7 +34,9 @@ export class ThemedSubmissionFormComponent extends ThemedComponent { { provide: SubmissionJsonPatchOperationsService, useValue: submissionJsonPatchOperationsServiceStub }, { provide: WorkspaceitemDataService, useValue: {} }, { provide: WorkflowItemDataService, useValue: {} }, - { provide: WorkflowItemDataService, useValue: {} }, - { provide: HALEndpointService, useValue: {} }, + { provide: EditItemDataService, useValue: {} }, + { provide: HALEndpointService, useValue: new HALEndpointServiceStub('test') }, { provide: SubmissionObjectService, useValue: submissionObjectDataServiceStub }, { provide: WorkspaceitemDataService, useValue: workspaceItemDataService }, ], @@ -304,16 +310,39 @@ describe('SubmissionObjectEffects test suite', () => { }); submissionJsonPatchOperationsServiceStub.jsonPatchByResourceType.and.callFake( - () => observableThrowError('Error'), + () => throwError(() => createFailedRemoteDataObject(undefined, undefined, undefined)), ); const expected = cold('--b-', { b: new SaveSubmissionFormErrorAction( - submissionId, + submissionId, undefined, undefined, ), }); expect(submissionObjectEffects.saveSubmission$).toBeObservable(expected); }); + + it('should return a UPDATE_SECTION_ERRORS actions on pathable errors', () => { + actions = hot('--a-', { + a: { + type: SubmissionObjectActionTypes.SAVE_SUBMISSION_FORM, + payload: { + submissionId: submissionId, + }, + }, + }); + + submissionJsonPatchOperationsServiceStub.jsonPatchByResourceType.and.callFake( + () => throwError(() => createFailedRemoteDataObject('error', 422, undefined, mockSectionsErrors)), + ); + const errorsList = parseSectionErrors(mockSectionsErrors); + const expected = cold('--(ab)-', { + a: new UpdateSectionErrorsAction(submissionId, 'traditionalpageone', errorsList.traditionalpageone, errorsList.traditionalpageone), + b: new UpdateSectionErrorsAction(submissionId, 'license', errorsList.license, errorsList.license), + }); + + expect(submissionObjectEffects.saveSubmission$).toBeObservable(expected); + }); + }); describe('saveForLaterSubmission$', () => { @@ -349,16 +378,38 @@ describe('SubmissionObjectEffects test suite', () => { }); submissionJsonPatchOperationsServiceStub.jsonPatchByResourceType.and.callFake( - () => observableThrowError('Error'), + () => throwError(() => createFailedRemoteDataObject(undefined, undefined, undefined)), ); const expected = cold('--b-', { b: new SaveSubmissionFormErrorAction( - submissionId, + submissionId, undefined, undefined, ), }); expect(submissionObjectEffects.saveForLaterSubmission$).toBeObservable(expected); }); + + it('should return a UPDATE_SECTION_ERRORS actions on pathable errors', () => { + actions = hot('--a-', { + a: { + type: SubmissionObjectActionTypes.SAVE_FOR_LATER_SUBMISSION_FORM, + payload: { + submissionId: submissionId, + }, + }, + }); + + submissionJsonPatchOperationsServiceStub.jsonPatchByResourceType.and.callFake( + () => throwError(() => createFailedRemoteDataObject('error', 422, undefined, mockSectionsErrors)), + ); + const errorsList = parseSectionErrors(mockSectionsErrors); + const expected = cold('--(ab)-', { + a: new UpdateSectionErrorsAction(submissionId, 'traditionalpageone', errorsList.traditionalpageone, errorsList.traditionalpageone), + b: new UpdateSectionErrorsAction(submissionId, 'license', errorsList.license, errorsList.license), + }); + + expect(submissionObjectEffects.saveForLaterSubmission$).toBeObservable(expected); + }); }); describe('saveSubmissionSuccess$', () => { @@ -863,7 +914,7 @@ describe('SubmissionObjectEffects test suite', () => { expect(submissionObjectEffects.saveSection$).toBeObservable(expected); }); - it('should return a SAVE_SUBMISSION_SECTION_FORM_ERROR action on error', () => { + it('should return a SAVE_SUBMISSION_FORM_ERROR action on error', () => { actions = hot('--a-', { a: { type: SubmissionObjectActionTypes.SAVE_SUBMISSION_SECTION_FORM, @@ -875,16 +926,39 @@ describe('SubmissionObjectEffects test suite', () => { }); submissionJsonPatchOperationsServiceStub.jsonPatchByResourceID.and.callFake( - () => observableThrowError('Error'), + () => throwError(() => createFailedRemoteDataObject(undefined, undefined, undefined)), ); const expected = cold('--b-', { - b: new SaveSubmissionSectionFormErrorAction( - submissionId, + b: new SaveSubmissionFormErrorAction( + submissionId, undefined, undefined, ), }); expect(submissionObjectEffects.saveSection$).toBeObservable(expected); }); + + it('should return a UPDATE_SECTION_ERRORS actions on pathable errors', () => { + actions = hot('--a-', { + a: { + type: SubmissionObjectActionTypes.SAVE_SUBMISSION_SECTION_FORM, + payload: { + submissionId: submissionId, + sectionId: 'traditionalpageone', + }, + }, + }); + + submissionJsonPatchOperationsServiceStub.jsonPatchByResourceID.and.callFake( + () => throwError(() => createFailedRemoteDataObject('error', 422, undefined, mockSectionsErrors)), + ); + const errorsList = parseSectionErrors(mockSectionsErrors); + const expected = cold('--(ab)-', { + a: new UpdateSectionErrorsAction(submissionId, 'traditionalpageone', errorsList.traditionalpageone, errorsList.traditionalpageone), + b: new UpdateSectionErrorsAction(submissionId, 'license', errorsList.license, errorsList.license), + }); + + expect(submissionObjectEffects.saveSection$).toBeObservable(expected); + }); }); describe('saveAndDepositSection$', () => { @@ -955,16 +1029,38 @@ describe('SubmissionObjectEffects test suite', () => { }); submissionJsonPatchOperationsServiceStub.jsonPatchByResourceType.and.callFake( - () => observableThrowError('Error'), + () => throwError(() => createFailedRemoteDataObject(undefined, undefined, undefined)), ); const expected = cold('--b-', { b: new SaveSubmissionFormErrorAction( - submissionId, + submissionId, undefined, undefined, ), }); expect(submissionObjectEffects.saveAndDeposit$).toBeObservable(expected); }); + + it('should return a UPDATE_SECTION_ERRORS actions on pathable errors', () => { + actions = hot('--a-', { + a: { + type: SubmissionObjectActionTypes.SAVE_AND_DEPOSIT_SUBMISSION, + payload: { + submissionId: submissionId, + }, + }, + }); + + submissionJsonPatchOperationsServiceStub.jsonPatchByResourceType.and.callFake( + () => observableThrowError(createFailedRemoteDataObject('error', 422, undefined, mockSectionsErrors)), + ); + const errorsList = parseSectionErrors(mockSectionsErrors); + const expected = cold('--(ab)-', { + a: new UpdateSectionErrorsAction(submissionId, 'traditionalpageone', errorsList.traditionalpageone, errorsList.traditionalpageone), + b: new UpdateSectionErrorsAction(submissionId, 'license', errorsList.license, errorsList.license), + }); + + expect(submissionObjectEffects.saveAndDeposit$).toBeObservable(expected); + }); }); describe('depositSubmission$', () => { @@ -1011,7 +1107,7 @@ describe('SubmissionObjectEffects test suite', () => { }); submissionServiceStub.depositSubmission.and.callFake( - () => observableThrowError('Error'), + () => throwError(() => createFailedRemoteDataObject(undefined, undefined, undefined)), ); const expected = cold('--b-', { b: new DepositSubmissionErrorAction( @@ -1025,6 +1121,7 @@ describe('SubmissionObjectEffects test suite', () => { describe('saveForLaterSubmissionSuccess$', () => { it('should display a new success notification and redirect to mydspace', () => { + submissionServiceStub.getSubmissionScope.and.returnValue(SubmissionScopeType.WorkspaceItem); actions = hot('--a-', { a: { type: SubmissionObjectActionTypes.SAVE_FOR_LATER_SUBMISSION_FORM_SUCCESS, @@ -1035,10 +1132,30 @@ describe('SubmissionObjectEffects test suite', () => { }, }); - submissionObjectEffects.saveForLaterSubmissionSuccess$.subscribe(() => { - expect(notificationsServiceStub.success).toHaveBeenCalled(); - expect(submissionServiceStub.redirectToMyDSpace).toHaveBeenCalled(); + submissionObjectEffects.saveForLaterSubmissionSuccess$.subscribe(); + + getTestScheduler().flush(); + expect(notificationsServiceStub.success).toHaveBeenCalled(); + expect(submissionServiceStub.redirectToMyDSpace).toHaveBeenCalled(); + }); + + it('should redirect to item page when the submission scope is EditItem', () => { + + submissionServiceStub.getSubmissionScope.and.returnValue(SubmissionScopeType.EditItem); + + actions = hot('--a-', { + a: { + type: SubmissionObjectActionTypes.SAVE_FOR_LATER_SUBMISSION_FORM_SUCCESS, + payload: { + submissionId: submissionId, + submissionObject: mockSubmissionRestResponse, + }, + }, }); + submissionObjectEffects.saveForLaterSubmissionSuccess$.subscribe(); + + getTestScheduler().flush(); + expect(submissionServiceStub.redirectToItemPage).toHaveBeenCalled(); }); }); @@ -1153,7 +1270,7 @@ describe('SubmissionObjectEffects test suite', () => { }); submissionServiceStub.discardSubmission.and.callFake( - () => observableThrowError('Error'), + () => throwError(() => 'Error'), ); const expected = cold('--b-', { b: new DiscardSubmissionErrorAction( diff --git a/src/app/submission/objects/submission-objects.effects.ts b/src/app/submission/objects/submission-objects.effects.ts index 3edc5ffaa13..ed53c03232b 100644 --- a/src/app/submission/objects/submission-objects.effects.ts +++ b/src/app/submission/objects/submission-objects.effects.ts @@ -1,10 +1,14 @@ import { Injectable } from '@angular/core'; import { RemoteData } from '@dspace/core/data/remote-data'; +import { NotificationOptions } from '@dspace/core/notification-system/models/notification-options.model'; import { NotificationsService } from '@dspace/core/notification-system/notifications.service'; import { followLink } from '@dspace/core/shared/follow-link-config.model'; import { Item } from '@dspace/core/shared/item.model'; import { getFirstSucceededRemoteDataPayload } from '@dspace/core/shared/operators'; -import { SubmissionObject } from '@dspace/core/submission/models/submission-object.model'; +import { + SubmissionObject, + SubmissionObjectError, +} from '@dspace/core/submission/models/submission-object.model'; import { SubmissionSectionError } from '@dspace/core/submission/models/submission-section-error.model'; import { SubmissionSectionObject } from '@dspace/core/submission/models/submission-section-object.model'; import { WorkflowItem } from '@dspace/core/submission/models/workflowitem.model'; @@ -14,6 +18,7 @@ import { WorkspaceitemSectionUploadObject } from '@dspace/core/submission/models import { WorkspaceitemSectionsObject } from '@dspace/core/submission/models/workspaceitem-sections.model'; import { SectionsType } from '@dspace/core/submission/sections-type'; import { SubmissionJsonPatchOperationsService } from '@dspace/core/submission/submission-json-patch-operations.service'; +import { SubmissionScopeType } from '@dspace/core/submission/submission-scope-type'; import { WorkspaceitemDataService } from '@dspace/core/submission/workspaceitem-data.service'; import { isEmpty, @@ -37,6 +42,7 @@ import { } from 'rxjs'; import { catchError, + concatMap, filter, map, mergeMap, @@ -60,6 +66,9 @@ import { DepositSubmissionAction, DepositSubmissionErrorAction, DepositSubmissionSuccessAction, + DisableSectionAction, + DisableSectionErrorAction, + DisableSectionSuccessAction, DiscardSubmissionErrorAction, DiscardSubmissionSuccessAction, InitSectionAction, @@ -78,6 +87,7 @@ import { SubmissionObjectActionTypes, UpdateSectionDataAction, UpdateSectionDataSuccessAction, + UpdateSectionErrorsAction, } from './submission-objects.actions'; import { SubmissionObjectEntry } from './submission-objects.reducer'; @@ -157,13 +167,20 @@ export class SubmissionObjectEffects { */ saveSubmission$ = createEffect(() => this.actions$.pipe( ofType(SubmissionObjectActionTypes.SAVE_SUBMISSION_FORM), - switchMap((action: SaveSubmissionFormAction) => { + concatMap((action: SaveSubmissionFormAction) => { return this.operationsService.jsonPatchByResourceType( this.submissionService.getSubmissionObjectLinkName(), action.payload.submissionId, - 'sections').pipe( + 'sections', + ).pipe( map((response: SubmissionObject[]) => new SaveSubmissionFormSuccessAction(action.payload.submissionId, response, action.payload.isManual, action.payload.isManual)), - catchError(() => of(new SaveSubmissionFormErrorAction(action.payload.submissionId)))); + catchError((rd: unknown) => { + if (rd instanceof RemoteData) { + return observableFrom( + this.parseErrorResponse(false, rd.errors, action.payload.submissionId, rd.statusCode, rd.errorMessage), + ); + } + })); }))); /** @@ -171,13 +188,20 @@ export class SubmissionObjectEffects { */ saveForLaterSubmission$ = createEffect(() => this.actions$.pipe( ofType(SubmissionObjectActionTypes.SAVE_FOR_LATER_SUBMISSION_FORM), - switchMap((action: SaveForLaterSubmissionFormAction) => { + concatMap((action: SaveForLaterSubmissionFormAction) => { return this.operationsService.jsonPatchByResourceType( this.submissionService.getSubmissionObjectLinkName(), action.payload.submissionId, - 'sections').pipe( + 'sections', + ).pipe( map((response: SubmissionObject[]) => new SaveForLaterSubmissionFormSuccessAction(action.payload.submissionId, response)), - catchError(() => of(new SaveSubmissionFormErrorAction(action.payload.submissionId)))); + catchError((rd: unknown) => { + if (rd instanceof RemoteData) { + return observableFrom( + this.parseErrorResponse(false, rd.errors, action.payload.submissionId, rd.statusCode, rd.errorMessage), + ); + } + })); }))); /** @@ -211,14 +235,21 @@ export class SubmissionObjectEffects { */ saveSection$ = createEffect(() => this.actions$.pipe( ofType(SubmissionObjectActionTypes.SAVE_SUBMISSION_SECTION_FORM), - switchMap((action: SaveSubmissionSectionFormAction) => { + concatMap((action: SaveSubmissionSectionFormAction) => { return this.operationsService.jsonPatchByResourceID( this.submissionService.getSubmissionObjectLinkName(), action.payload.submissionId, 'sections', - action.payload.sectionId).pipe( + action.payload.sectionId, + ).pipe( map((response: SubmissionObject[]) => new SaveSubmissionSectionFormSuccessAction(action.payload.submissionId, response)), - catchError(() => of(new SaveSubmissionSectionFormErrorAction(action.payload.submissionId)))); + catchError((rd: unknown) => { + if (rd instanceof RemoteData) { + return observableFrom( + this.parseErrorResponse(false, rd.errors, action.payload.submissionId, rd.statusCode, rd.errorMessage), + ); + } + })); }))); /** @@ -235,7 +266,7 @@ export class SubmissionObjectEffects { saveAndDeposit$ = createEffect(() => this.actions$.pipe( ofType(SubmissionObjectActionTypes.SAVE_AND_DEPOSIT_SUBMISSION), withLatestFrom(this.submissionService.hasUnsavedModification()), - switchMap(([action, hasUnsavedModification]: [SaveAndDepositSubmissionAction, boolean]) => { + concatMap(([action, hasUnsavedModification]: [SaveAndDepositSubmissionAction, boolean]) => { let response$: Observable; if (hasUnsavedModification) { response$ = this.operationsService.jsonPatchByResourceType( @@ -262,9 +293,28 @@ export class SubmissionObjectEffects { return new SaveSubmissionFormSuccessAction(action.payload.submissionId, response, false, true); } }), - catchError(() => of(new SaveSubmissionFormErrorAction(action.payload.submissionId)))); + catchError((rd: unknown) => { + if (rd instanceof RemoteData) { + return observableFrom( + this.parseErrorResponse(false, rd.errors, action.payload.submissionId, rd.statusCode, rd.errorMessage), + ); + } + })); }))); + removeSection$ = createEffect(() => this.actions$.pipe( + ofType(SubmissionObjectActionTypes.DISABLE_SECTION), + concatMap((action: DisableSectionAction) => { + return this.operationsService.jsonPatchByResourceID( + this.submissionService.getSubmissionObjectLinkName(), + action.payload.submissionId, + 'sections', + action.payload.sectionId).pipe( + map(() => new DisableSectionSuccessAction(action.payload.submissionId, action.payload.sectionId)), + catchError(() => of(new DisableSectionErrorAction(action.payload.submissionId, action.payload.sectionId)))); + })), + ); + /** * Dispatch a [DepositSubmissionSuccessAction] or a [DepositSubmissionErrorAction] on error */ @@ -283,7 +333,14 @@ export class SubmissionObjectEffects { saveForLaterSubmissionSuccess$ = createEffect(() => this.actions$.pipe( ofType(SubmissionObjectActionTypes.SAVE_FOR_LATER_SUBMISSION_FORM_SUCCESS), tap(() => this.notificationsService.success(null, this.translate.get('submission.sections.general.save_success_notice'))), - tap(() => this.submissionService.redirectToMyDSpace())), { dispatch: false }); + tap((action: SaveForLaterSubmissionFormSuccessAction) => { + const scope = this.submissionService.getSubmissionScope(); + if (scope === SubmissionScopeType.EditItem) { + this.submissionService.redirectToItemPage(action.payload.submissionId); + } else { + this.submissionService.redirectToMyDSpace(); + } + })), { dispatch: false }); /** * Show a notification on success and redirect to MyDSpace page @@ -484,6 +541,62 @@ export class SubmissionObjectEffects { } return mappedActions; } + + /** + * Parse the error response retrieved from REST and return actions to dispatch + * + * @param isSaveForSection + * A boolean representing if save has been dispatched for a section or for the entire submission + * @param errors + * The list of submission object error + * @param submissionId + * The submission id + * @param statusCode + * the submission's response error code + * @param errorMessage + * the submission's response error message + * @return SubmissionObjectAction[] + * List of SubmissionObjectAction to dispatch + */ + protected parseErrorResponse( + isSaveForSection: boolean, + errors: SubmissionObjectError[], + submissionId: string, + statusCode: number, + errorMessage: string, + ): SubmissionObjectAction[] { + + const mappedActions = []; + let errorsList = Object.create({}); + + if (errors && isNotEmpty(errors)) { + // to avoid dispatching an action for every error, create an array of errors per section + errorsList = parseSectionErrors(errors); + } + + if (isNotEmpty(errorsList)) { + // Notify warning message + this.notificationsService.warning( + null, + this.translate.get('submission.sections.general.invalid_state_error'), + new NotificationOptions(10000), + ); + + // Dispatch actions to update section errors + Object.keys(errorsList).forEach((sectionId) => { + const sectionErrors = errorsList[sectionId] || []; + mappedActions.push(new UpdateSectionErrorsAction(submissionId, sectionId, sectionErrors, sectionErrors)); + }); + } else { + if (isSaveForSection) { + mappedActions.push(new SaveSubmissionSectionFormErrorAction(submissionId, statusCode, errorMessage)); + } else { + mappedActions.push(new SaveSubmissionFormErrorAction(submissionId, statusCode, errorMessage)); + } + } + + return mappedActions; + } } function getForm(forms, currentState, sectionId) { diff --git a/src/app/submission/objects/submission-objects.reducer.spec.ts b/src/app/submission/objects/submission-objects.reducer.spec.ts index 1156b1ca8f8..1f1540a831c 100644 --- a/src/app/submission/objects/submission-objects.reducer.spec.ts +++ b/src/app/submission/objects/submission-objects.reducer.spec.ts @@ -19,6 +19,7 @@ import { DepositSubmissionErrorAction, DepositSubmissionSuccessAction, DisableSectionAction, + DisableSectionSuccessAction, DiscardSubmissionAction, DiscardSubmissionSuccessAction, EditFileDataAction, @@ -41,6 +42,7 @@ import { SectionStatusChangeAction, SubmissionObjectAction, UpdateSectionDataAction, + UpdateSectionErrorsAction, } from './submission-objects.actions'; import { submissionObjectReducer, @@ -69,7 +71,9 @@ describe('submissionReducer test suite', () => { activeSection: null, sections: Object.create(null), isLoading: true, + isDiscarding: false, savePending: false, + saveDecisionPending: false, depositPending: false, }, }; @@ -102,6 +106,7 @@ describe('submissionReducer test suite', () => { activeSection: null, sections: Object.create(null), isLoading: true, + isDiscarding: false, savePending: false, depositPending: false, }, @@ -109,7 +114,7 @@ describe('submissionReducer test suite', () => { const action = new ResetSubmissionFormAction(collectionId, submissionId, selfUrl, {}, submissionDefinition, new Item()); const newState = submissionObjectReducer(initState, action); - + console.log('NEW STATE ', newState); expect(newState).toEqual(expectedState); }); @@ -161,7 +166,7 @@ describe('submissionReducer test suite', () => { expect(newState[826].savePending).toBeFalsy(); - action = new SaveSubmissionFormErrorAction(submissionId); + action = new SaveSubmissionFormErrorAction(submissionId, undefined, undefined); newState = submissionObjectReducer(state, action); expect(newState[826].savePending).toBeFalsy(); @@ -171,7 +176,7 @@ describe('submissionReducer test suite', () => { expect(newState[826].savePending).toBeFalsy(); - action = new SaveSubmissionSectionFormErrorAction(submissionId); + action = new SaveSubmissionSectionFormErrorAction(submissionId, undefined, undefined); newState = submissionObjectReducer(state, action); expect(newState[826].savePending).toBeFalsy(); @@ -222,8 +227,7 @@ describe('submissionReducer test suite', () => { it('should reset state once the discard action is completed successfully', () => { const action: any = new DiscardSubmissionSuccessAction(submissionId); const newState = submissionObjectReducer(initState, action); - - expect(newState).toEqual({}); + expect(newState).toEqual(Object.assign({}, initState, { 826: Object.assign({}, initState[826], { isDiscarding: true }) })); }); it('should return same state once the discard action is completed unsuccessfully', () => { @@ -248,6 +252,7 @@ describe('submissionReducer test suite', () => { serverValidationErrors: [], isLoading: false, isValid: true, + removePending: false, } as any; let action: any = new InitSubmissionFormAction(collectionId, submissionId, selfUrl, submissionDefinition, {}, new Item(), null); @@ -288,6 +293,13 @@ describe('submissionReducer test suite', () => { action = new DisableSectionAction(submissionId, 'traditionalpagetwo'); newState = submissionObjectReducer(newState, action); + expect(newState[826].sections.traditionalpagetwo.removePending).toBeTruthy(); + expect(newState[826].sections.traditionalpagetwo.enabled).toBeTruthy(); + + action = new DisableSectionSuccessAction(submissionId, 'traditionalpagetwo'); + newState = submissionObjectReducer(newState, action); + + expect(newState[826].sections.traditionalpagetwo.removePending).toBeFalsy(); expect(newState[826].sections.traditionalpagetwo.enabled).toBeFalsy(); }); @@ -369,6 +381,21 @@ describe('submissionReducer test suite', () => { expect(newState[826].sections.traditionalpageone.errorsToShow).toEqual(errors); }); + it('should add submission section errors properly', () => { + const errors = [ + { + path: '/sections/traditionalpageone/dc.title/0', + message: 'error.validation.traditionalpageone.required', + }, + ]; + + const action = new UpdateSectionErrorsAction(submissionId, 'traditionalpageone', errors, errors); + const newState = submissionObjectReducer(initState, action); + + expect(newState[826].sections.traditionalpageone.errorsToShow).toEqual(errors); + expect(newState[826].savePending).toBeFalsy(); + }); + it('should remove all submission section errors properly', () => { const action: any = new RemoveSectionErrorsAction(submissionId, 'traditionalpageone'); let newState; diff --git a/src/app/submission/objects/submission-objects.reducer.ts b/src/app/submission/objects/submission-objects.reducer.ts index f1ab23e39c1..a82c2e4f3a8 100644 --- a/src/app/submission/objects/submission-objects.reducer.ts +++ b/src/app/submission/objects/submission-objects.reducer.ts @@ -23,6 +23,8 @@ import { DepositSubmissionErrorAction, DepositSubmissionSuccessAction, DisableSectionAction, + DisableSectionErrorAction, + DiscardSubmissionSuccessAction, EditFileDataAction, EditFilePrimaryBitstreamAction, EnableSectionAction, @@ -48,6 +50,7 @@ import { SubmissionObjectAction, SubmissionObjectActionTypes, UpdateSectionDataAction, + UpdateSectionErrorsAction, } from './submission-objects.actions'; /** @@ -96,10 +99,19 @@ export interface SubmissionObjectEntry { */ savePending?: boolean; + /** + * A boolean representing if a duplicate decision is pending + */ + saveDecisionPending?: boolean; + /** * A boolean representing if a submission deposit operation is pending */ depositPending?: boolean; + /** + * A boolean representing if a submission is discarded or not + */ + isDiscarding?: boolean; } /** @@ -170,7 +182,7 @@ export function submissionObjectReducer(state = initialState, action: Submission } case SubmissionObjectActionTypes.DISCARD_SUBMISSION_SUCCESS: { - return initialState; + return discardSuccess(state, action as DiscardSubmissionSuccessAction); } case SubmissionObjectActionTypes.DISCARD_SUBMISSION_ERROR: { @@ -199,10 +211,22 @@ export function submissionObjectReducer(state = initialState, action: Submission return updateSectionData(state, action as UpdateSectionDataAction); } + case SubmissionObjectActionTypes.UPDATE_SECTION_ERRORS: { + return updateSectionErrors(state, action as UpdateSectionErrorsAction); + } + case SubmissionObjectActionTypes.DISABLE_SECTION: { + return changeSectionRemoveState(state, action as DisableSectionAction, true); + } + + case SubmissionObjectActionTypes.DISABLE_SECTION_SUCCESS: { return changeSectionState(state, action as DisableSectionAction, false); } + case SubmissionObjectActionTypes.DISABLE_SECTION_ERROR: { + return changeSectionRemoveState(state, action as DisableSectionErrorAction, false); + } + case SubmissionObjectActionTypes.SECTION_STATUS_CHANGE: { return setIsValid(state, action as SectionStatusChangeAction); } @@ -346,7 +370,9 @@ function initSubmission(state: SubmissionObjectState, action: InitSubmissionForm sections: Object.create(null), isLoading: true, savePending: false, + saveDecisionPending: false, depositPending: false, + isDiscarding: false, }; return newState; } @@ -396,6 +422,28 @@ function completeInit(state: SubmissionObjectState, action: CompleteInitSubmissi } } +/** + * Set submission discard to true. + * + * @param state + * the current state + * @param action + * a DiscardSubmissionSuccessAction + * @return SubmissionObjectState + * the new state, with the discard success. + */ +function discardSuccess(state: SubmissionObjectState, action: DiscardSubmissionSuccessAction): SubmissionObjectState { + if (hasValue(state[ action.payload.submissionId ])) { + return Object.assign({}, state, { + [ action.payload.submissionId ]: Object.assign({}, state[ action.payload.submissionId ], { + isDiscarding: true, + }), + }); + } else { + return state; + } +} + /** * Set submission save flag to true * @@ -575,6 +623,7 @@ function initSection(state: SubmissionObjectState, action: InitSectionAction): S serverValidationErrors: action.payload.errors || [], isLoading: false, isValid: isEmpty(action.payload.errors), + removePending: false, }, }), }), @@ -642,6 +691,36 @@ function updateSectionData(state: SubmissionObjectState, action: UpdateSectionDa } } +/** + * Update section's data. + * + * @param state + * the current state + * @param action + * an UpdateSectionDataAction + * @return SubmissionObjectState + * the new state, with the section's data updated. + */ +function updateSectionErrors(state: SubmissionObjectState, action: UpdateSectionErrorsAction): SubmissionObjectState { + if (isNotEmpty(state[ action.payload.submissionId ]) + && isNotEmpty(state[ action.payload.submissionId ].sections[ action.payload.sectionId])) { + return Object.assign({}, state, { + [ action.payload.submissionId ]: Object.assign({}, state[ action.payload.submissionId ], { + sections: Object.assign({}, state[ action.payload.submissionId ].sections, { + [ action.payload.sectionId ]: Object.assign({}, state[ action.payload.submissionId ].sections [ action.payload.sectionId ], { + enabled: true, + errorsToShow: action.payload.errorsToShow, + serverValidationErrors: action.payload.errorsToShow, + }), + }), + savePending: false, + }), + }); + } else { + return state; + } +} + /** * Updates the state of the section metadata only when a new value is provided. * Keep the existent otherwise. @@ -680,6 +759,37 @@ function changeSectionState(state: SubmissionObjectState, action: EnableSectionA sections: Object.assign({}, state[ action.payload.submissionId ].sections, { [ action.payload.sectionId ]: Object.assign({}, state[ action.payload.submissionId ].sections [ action.payload.sectionId ], { enabled, + data: (enabled) ? state[ action.payload.submissionId ].sections [ action.payload.sectionId ] : {}, + removePending: false, + }), + }), + }), + }); + } else { + return state; + } +} + +/** + * Change removePending flag. + * + * @param state + * the current state + * @param action + * a DisableSectionAction or a DisableSectionErrorAction + * @param removePending + * representing if remove operation is pending or not. + * @return SubmissionObjectState + * the new state, with the section removed. + */ +function changeSectionRemoveState(state: SubmissionObjectState, action: DisableSectionAction | DisableSectionErrorAction, removePending: boolean): SubmissionObjectState { + if (hasValue(state[ action.payload.submissionId ].sections[ action.payload.sectionId ])) { + return Object.assign({}, state, { + [ action.payload.submissionId ]: Object.assign({}, state[ action.payload.submissionId ], { + // sections: deleteProperty(state[ action.payload.submissionId ].sections, action.payload.sectionId), + sections: Object.assign({}, state[ action.payload.submissionId ].sections, { + [ action.payload.sectionId ]: Object.assign({}, state[ action.payload.submissionId ].sections [ action.payload.sectionId ], { + removePending, }), }), }), @@ -845,12 +955,20 @@ function editFileData(state: SubmissionObjectState, action: EditFileDataAction): */ function deleteFile(state: SubmissionObjectState, action: DeleteUploadedFileAction): SubmissionObjectState { const filesData = state[ action.payload.submissionId ].sections[ action.payload.sectionId ].data as WorkspaceitemSectionUploadObject; + const filesErrorsToShow = state[ action.payload.submissionId ].sections[ action.payload.sectionId ].errorsToShow ?? []; + const filesSeverValidationErrors = state[ action.payload.submissionId ].sections[ action.payload.sectionId ].serverValidationErrors ?? []; + if (hasValue(filesData.files)) { const fileIndex: any = findKey( filesData.files, { uuid: action.payload.fileId }); if (isNotNull(fileIndex)) { const newData = Array.from(filesData.files); + const newErrorsToShow = filesData.files.length > 1 ? filesErrorsToShow + .filter(errorToShow => !errorToShow.path.includes(fileIndex)) : []; + const newServerErrorsToShow = filesData.files.length > 1 ? filesSeverValidationErrors + .filter(serverError => !serverError.path.includes(fileIndex)) : []; + newData.splice(fileIndex, 1); return Object.assign({}, state, { [ action.payload.submissionId ]: Object.assign({}, state[action.payload.submissionId], { @@ -860,6 +978,8 @@ function deleteFile(state: SubmissionObjectState, action: DeleteUploadedFileActi data: Object.assign({}, state[ action.payload.submissionId ].sections[ action.payload.sectionId ].data, { files: newData, }), + errorsToShow: newErrorsToShow, + serverValidationErrors: newServerErrorsToShow, }), }), ), diff --git a/src/app/submission/sections/form/section-form-operations.service.spec.ts b/src/app/submission/sections/form/section-form-operations.service.spec.ts index e5feed170ca..ed37c02091d 100644 --- a/src/app/submission/sections/form/section-form-operations.service.spec.ts +++ b/src/app/submission/sections/form/section-form-operations.service.spec.ts @@ -745,7 +745,7 @@ describe('SectionFormOperationsService test suite', () => { serviceAsAny.dispatchOperationsFromMap(valueMap, pathCombiner, dynamicFormControlChangeEvent, previousValue); - expect(jsonPatchOpBuilder.add).toHaveBeenCalledWith(pathCombiner.getPath('path'), ['testMapNew'], true); + expect(jsonPatchOpBuilder.add).toHaveBeenCalledWith(pathCombiner.getPath('path'), ['testMapNew'], true, null, undefined); }); it('should dispatch a json-path add operation when a map entry has changed', () => { @@ -758,7 +758,7 @@ describe('SectionFormOperationsService test suite', () => { serviceAsAny.dispatchOperationsFromMap(valueMap, pathCombiner, dynamicFormControlChangeEvent, previousValue); - expect(jsonPatchOpBuilder.add).toHaveBeenCalledWith(pathCombiner.getPath('path'), ['testMapNew'], true); + expect(jsonPatchOpBuilder.add).toHaveBeenCalledWith(pathCombiner.getPath('path'), ['testMapNew'], true, false, undefined); }); it('should dispatch a json-path remove operation when a map entry has changed', () => { diff --git a/src/app/submission/sections/form/section-form-operations.service.ts b/src/app/submission/sections/form/section-form-operations.service.ts index b209f719786..fd9019a3dbd 100644 --- a/src/app/submission/sections/form/section-form-operations.service.ts +++ b/src/app/submission/sections/form/section-form-operations.service.ts @@ -64,17 +64,19 @@ export class SectionFormOperationsService { * the [[FormFieldPreviousValueObject]] for the specified operation * @param hasStoredValue * representing if field value related to the specified operation has stored value + * @param languageMap */ public dispatchOperationsFromEvent(pathCombiner: JsonPatchOperationPathCombiner, event: DynamicFormControlEvent, previousValue: FormFieldPreviousValueObject, - hasStoredValue: boolean): void { + hasStoredValue: boolean, + languageMap: Map = null): void { switch (event.type) { case 'remove': this.dispatchOperationsFromRemoveEvent(pathCombiner, event, previousValue); break; case 'change': - this.dispatchOperationsFromChangeEvent(pathCombiner, event, previousValue, hasStoredValue); + this.dispatchOperationsFromChangeEvent(pathCombiner, event, previousValue, hasStoredValue, languageMap); break; case 'move': this.dispatchOperationsFromMoveEvent(pathCombiner, event, previousValue); @@ -315,7 +317,7 @@ export class SectionFormOperationsService { } else if (event.context && event.context instanceof DynamicFormArrayGroupModel) { // Model is a DynamicRowArrayModel this.handleArrayGroupPatch(pathCombiner, event, (event as any).context.context, previousValue); - } else if ((isNotEmpty(value) && typeof value === 'string') || (isNotEmpty(value) && value instanceof FormFieldMetadataValueObject && value.hasValue())) { + } else if ((isNotEmpty(value) && typeof value === 'string') || (isNotEmpty(value) && (value instanceof FormFieldMetadataValueObject || value instanceof VocabularyEntry) && value.hasValue())) { this.operationsBuilder.remove(pathCombiner.getPath(path)); } } @@ -367,12 +369,13 @@ export class SectionFormOperationsService { * the [[FormFieldPreviousValueObject]] for the specified operation * @param hasStoredValue * representing if field value related to the specified operation has stored value + * @param languageMap */ protected dispatchOperationsFromChangeEvent(pathCombiner: JsonPatchOperationPathCombiner, event: DynamicFormControlEvent, previousValue: FormFieldPreviousValueObject, - hasStoredValue: boolean): void { - + hasStoredValue: boolean, + languageMap?: Map): void { if (event.context && event.context instanceof DynamicFormArrayGroupModel) { // Model is a DynamicRowArrayModel this.handleArrayGroupPatch(pathCombiner, event, (event as any).context.context, previousValue); @@ -386,7 +389,7 @@ export class SectionFormOperationsService { if (this.formBuilder.isQualdropGroup(event.model.parent as DynamicFormControlModel) || this.formBuilder.isQualdropGroup(event.model as DynamicFormControlModel)) { // It's a qualdrup model - this.dispatchOperationsFromMap(this.getQualdropValueMap(event), pathCombiner, event, previousValue); + this.dispatchOperationsFromMap(this.getQualdropValueMap(event), pathCombiner, event, previousValue, languageMap); } else if (this.formBuilder.isRelationGroup(event.model)) { // It's a relation model this.dispatchOperationsFromMap(this.getValueMap(value), pathCombiner, event, previousValue); @@ -455,11 +458,13 @@ export class SectionFormOperationsService { * the [[DynamicFormControlEvent]] for the specified operation * @param previousValue * the [[FormFieldPreviousValueObject]] for the specified operation + * @param languageMap */ protected dispatchOperationsFromMap(valueMap: Map, pathCombiner: JsonPatchOperationPathCombiner, event: DynamicFormControlEvent, - previousValue: FormFieldPreviousValueObject): void { + previousValue: FormFieldPreviousValueObject, + languageMap: Map = null): void { const currentValueMap = valueMap; if (event.type === 'remove') { const path = this.getQualdropItemPathFromEvent(event); @@ -470,7 +475,8 @@ export class SectionFormOperationsService { const currentValue = currentValueMap.get(index); if (currentValue) { if (!isEqual(entry, currentValue)) { - this.operationsBuilder.add(pathCombiner.getPath(index), currentValue, true); + const metadataFromPath = pathCombiner.getPath(index).path.split('/').slice(-1)[0]; + this.operationsBuilder.add(pathCombiner.getPath(index), currentValue, true, false, languageMap?.get(metadataFromPath)); } currentValueMap.delete(index); } else if (!currentValue) { @@ -483,7 +489,8 @@ export class SectionFormOperationsService { // The last item of the group has been deleted so make a remove op this.operationsBuilder.remove(pathCombiner.getPath(index)); } else { - this.operationsBuilder.add(pathCombiner.getPath(index), entry, true); + const metadataFromPath = pathCombiner.getPath(index).path.split('/').slice(-1)[0]; + this.operationsBuilder.add(pathCombiner.getPath(index), entry, true, null, languageMap?.get(metadataFromPath)); } }); } diff --git a/src/app/submission/sections/form/section-form.component.spec.ts b/src/app/submission/sections/form/section-form.component.spec.ts index cf32f179add..ce8c2d46252 100644 --- a/src/app/submission/sections/form/section-form.component.spec.ts +++ b/src/app/submission/sections/form/section-form.component.spec.ts @@ -204,12 +204,13 @@ describe('SubmissionSectionFormComponent test suite', () => { { provide: 'collectionIdProvider', useValue: collectionId }, { provide: 'sectionDataProvider', useValue: Object.assign({}, sectionObject) }, { provide: 'submissionIdProvider', useValue: submissionId }, + { provide: 'entityType', useValue: 'Publication' }, { provide: SubmissionObjectService, useValue: { getHrefByID: () => of('testUrl'), findById: () => createSuccessfulRemoteDataObject$(new WorkspaceItem()) } }, ChangeDetectorRef, SubmissionSectionFormComponent, ], schemas: [NO_ERRORS_SCHEMA], - }).compileComponents().then(); + }).overrideComponent(SubmissionSectionFormComponent, { remove: { imports: [FormComponent] } }).compileComponents().then(); })); describe('', () => { @@ -270,6 +271,7 @@ describe('SubmissionSectionFormComponent test suite', () => { formConfigService.findByHref.and.returnValue(createSuccessfulRemoteDataObject$(testFormConfiguration)); sectionsServiceStub.getSectionData.and.returnValue(of(sectionData)); sectionsServiceStub.getSectionServerErrors.and.returnValue(of([])); + submissionServiceStub.getSubmissionSecurityConfiguration.and.returnValue(of(sectionData)); sectionsServiceStub.isSectionReadOnly.and.returnValue(of(false)); spyOn(comp, 'initForm'); diff --git a/src/app/submission/sections/form/section-form.component.ts b/src/app/submission/sections/form/section-form.component.ts index f953c3020af..a8ae44358e0 100644 --- a/src/app/submission/sections/form/section-form.component.ts +++ b/src/app/submission/sections/form/section-form.component.ts @@ -3,6 +3,7 @@ import { ChangeDetectorRef, Component, Inject, + OnDestroy, ViewChild, } from '@angular/core'; import { ObjectCacheService } from '@dspace/core/cache/object-cache.service'; @@ -20,6 +21,7 @@ import { getFirstSucceededRemoteData, getRemoteDataPayload, } from '@dspace/core/shared/operators'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { SubmissionObject } from '@dspace/core/submission/models/submission-object.model'; import { SubmissionSectionError } from '@dspace/core/submission/models/submission-section-error.model'; import { SubmissionSectionObject } from '@dspace/core/submission/models/submission-section-object.model'; @@ -43,7 +45,9 @@ import findIndex from 'lodash/findIndex'; import isEqual from 'lodash/isEqual'; import { combineLatest as observableCombineLatest, + interval, Observable, + race, Subscription, } from 'rxjs'; import { @@ -51,12 +55,14 @@ import { filter, find, map, + mapTo, mergeMap, take, tap, } from 'rxjs/operators'; import { environment } from '../../../../environments/environment'; +import { DynamicQualdropModel } from '../../../shared/form/builder/ds-dynamic-form-ui/models/ds-dynamic-qualdrop.model'; import { FormBuilderService } from '../../../shared/form/builder/form-builder.service'; import { FormComponent } from '../../../shared/form/form.component'; import { FormService } from '../../../shared/form/form.service'; @@ -80,7 +86,7 @@ import { SectionFormOperationsService } from './section-form-operations.service' ThemedLoadingComponent, ], }) -export class SubmissionSectionFormComponent extends SectionModelComponent { +export class SubmissionSectionFormComponent extends SectionModelComponent implements OnDestroy { /** * The form id @@ -148,6 +154,8 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { */ protected subs: Subscription[] = []; + protected metadataSecurityConfiguration: MetadataSecurityConfiguration; + protected submissionObject: SubmissionObject; /** @@ -176,6 +184,7 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { * @param {ObjectCacheService} objectCache * @param {RequestService} requestService * @param {string} injectedCollectionId + * @param {string} entityType * @param {SectionDataObject} injectedSectionData * @param {string} injectedSubmissionId */ @@ -192,6 +201,7 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { protected objectCache: ObjectCacheService, protected requestService: RequestService, @Inject('collectionIdProvider') public injectedCollectionId: string, + @Inject('entityType') public entityType: string, @Inject('sectionDataProvider') public injectedSectionData: SectionDataObject, @Inject('submissionIdProvider') public injectedSubmissionId: string) { super(injectedCollectionId, injectedSectionData, injectedSubmissionId); @@ -207,17 +217,28 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { this.formConfigService.findByHref(this.sectionData.config).pipe( map((configData: RemoteData) => configData.payload), tap((config: SubmissionFormsModel) => this.formConfig = config), - mergeMap(() => - observableCombineLatest([ - this.sectionService.getSectionData(this.submissionId, this.sectionData.id, this.sectionData.sectionType), - this.submissionObjectService.findById(this.submissionId, true, false, followLink('item')).pipe( + mergeMap(() => { + const findById$ = this.submissionObjectService.findById(this.submissionId, false, true, followLink('item')).pipe( + getFirstSucceededRemoteData(), + getRemoteDataPayload(), + ); + const findByIdCached$ = interval(200).pipe( + mapTo(this.submissionObjectService.findById(this.submissionId, true, true, followLink('item')).pipe( getFirstSucceededRemoteData(), - getRemoteDataPayload()), + getRemoteDataPayload(), + )), + ); + return observableCombineLatest([ + this.sectionService.getSectionData(this.submissionId, this.sectionData.id, this.sectionData.sectionType), + race([findById$, findByIdCached$]), + this.submissionService.getSubmissionSecurityConfiguration(this.submissionId).pipe(take(1)), this.sectionService.isSectionReadOnly(this.submissionId, this.sectionData.id, this.submissionService.getSubmissionScope()), - ])), + ]); + }), take(1)) - .subscribe(([sectionData, submissionObject, isSectionReadOnly]: [WorkspaceitemSectionFormObject, SubmissionObject, boolean]) => { + .subscribe(([sectionData, submissionObject, metadataSecurity, isSectionReadOnly]: [WorkspaceitemSectionFormObject, SubmissionObject, MetadataSecurityConfiguration, boolean]) => { if (isUndefined(this.formModel)) { + this.metadataSecurityConfiguration = metadataSecurity; // this.sectionData.errorsToShow = []; this.submissionObject = submissionObject; this.isSectionReadonly = isSectionReadOnly; @@ -335,9 +356,14 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { sectionData, this.submissionService.getSubmissionScope(), this.isSectionReadonly, + null, + false, + this.metadataSecurityConfiguration, ); const sectionMetadata = this.sectionService.computeSectionConfiguredMetadata(this.formConfig); this.sectionService.updateSectionData(this.submissionId, this.sectionData.id, sectionData, errorsToShow, serverValidationErrors, sectionMetadata); + // Add created model to formBulderService + this.formBuilderService.addFormModel(this.formId, this.formModel); } catch (e: unknown) { const msg: string = this.translate.instant('error.submission.sections.init-form-error') + (e as Error).toString(); const sectionError: SubmissionSectionError = { @@ -435,22 +461,57 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { * the [[DynamicFormControlEvent]] emitted */ onChange(event: DynamicFormControlEvent): void { - this.formOperationsService.dispatchOperationsFromEvent( - this.pathCombiner, - event, - this.previousValue, - this.hasStoredValue(this.formBuilderService.getId(event.model), this.formOperationsService.getArrayIndexFromEvent(event))); + const languageMap = new Map(); + const isQualdrop = event.model.parent instanceof DynamicQualdropModel; + + if (isQualdrop) { + const qualdropMap = this.formOperationsService.getQualdropValueMap(event); + + if (qualdropMap) { + const groupMetadata = qualdropMap.keys(); + this.formService.getForm(this.formId).pipe(take(1)).subscribe((form) => { + for (const metadata of groupMetadata) { + if (hasValue(form.data[metadata]) && form.data[metadata].length > 1) { + form.data[metadata].forEach((entry: any) => { + languageMap.set(metadata, [...(languageMap.get(metadata) ?? []), entry.language]); + }); + } else { + languageMap.set(metadata, [form.data[metadata][0].language]); + } + } + }); + } + + this.formOperationsService.dispatchOperationsFromEvent( + this.pathCombiner, + event, + this.previousValue, + this.hasStoredValue(this.formBuilderService.getId(event.model), this.formOperationsService.getArrayIndexFromEvent(event)), + languageMap, + ); + } else { + this.formOperationsService.dispatchOperationsFromEvent( + this.pathCombiner, + event, + this.previousValue, + this.hasStoredValue(this.formBuilderService.getId(event.model), this.formOperationsService.getArrayIndexFromEvent(event)), + null, + ); + } + + const metadata = this.formOperationsService.getFieldPathSegmentedFromChangeEvent(event); const value = this.formOperationsService.getFieldValueFromChangeEvent(event); - if ((environment.submission.autosave.metadata.indexOf(metadata) !== -1 && isNotEmpty(value)) || this.hasRelatedCustomError(metadata)) { + const eventAutoSave = !event.$event?.hasOwnProperty('autoSave') || event.$event?.autoSave; + if (eventAutoSave && (environment.submission.autosave.metadata.indexOf(metadata) !== -1 && isNotEmpty(value)) || this.hasRelatedCustomError(metadata)) { this.submissionService.dispatchSave(this.submissionId); } } private hasRelatedCustomError(medatata): boolean { const index = findIndex(this.sectionData.errorsToShow, { path: this.pathCombiner.getPath(medatata).path }); - if (index !== -1) { + if (index !== -1) { const error = this.sectionData.errorsToShow[index]; const validator = error.message.replace('error.validation.', ''); return !environment.form.validatorMap.hasOwnProperty(validator); @@ -467,6 +528,10 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { * the [[DynamicFormControlEvent]] emitted */ onFocus(event: DynamicFormControlEvent): void { + this.updatePreviousValue(event); + } + + private updatePreviousValue(event: DynamicFormControlEvent): void { const value = this.formOperationsService.getFieldValueFromChangeEvent(event); const path = this.formBuilderService.getPath(event.model); if (this.formBuilderService.hasMappedGroupValue(event.model)) { @@ -478,6 +543,11 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { } } + private clearPreviousValue(): void { + this.previousValue.path = null; + this.previousValue.value = null; + } + /** * Method called when a form remove event is fired. * Dispatch form operations based on changes. @@ -486,6 +556,7 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { * the [[DynamicFormControlEvent]] emitted */ onRemove(event: DynamicFormControlEvent): void { + this.updatePreviousValue(event); const fieldId = this.formBuilderService.getId(event.model); const fieldIndex = this.formOperationsService.getArrayIndexFromEvent(event); @@ -503,7 +574,7 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { event, this.previousValue, this.hasStoredValue(fieldId, fieldIndex)); - + this.clearPreviousValue(); } /** @@ -539,7 +610,7 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { /** * Handle the customEvent (ex. drag-drop move event). * The customEvent is stored inside event.$event - * @param $event + * @param event */ onCustomEvent(event: DynamicFormControlEvent) { this.formOperationsService.dispatchOperationsFromEvent( @@ -548,4 +619,11 @@ export class SubmissionSectionFormComponent extends SectionModelComponent { this.previousValue, null); } + + ngOnDestroy(): void { + super.ngOnDestroy(); + // Remove this model from formBulderService + this.formBuilderService.removeFormModel(this.sectionData.id); + } + } diff --git a/src/app/submission/selectors.ts b/src/app/submission/selectors.ts index 6ea60326c2d..8653851277e 100644 --- a/src/app/submission/selectors.ts +++ b/src/app/submission/selectors.ts @@ -2,6 +2,7 @@ import { keySelector, subStateSelector, } from '@dspace/core/ngrx/selectors-utils'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { SubmissionSectionObject } from '@dspace/core/submission/models/submission-section-object.model'; import { MemoizedSelector } from '@ngrx/store'; @@ -51,3 +52,7 @@ export function submissionSectionServerErrorsFromIdSelector(submissionId: string return subStateSelector(submissionIdSelector, 'serverValidationErrors'); } +export function securityConfigurationObjectFromIdSelector(submissionId: string): MemoizedSelector { + const submissionIdSelector = submissionObjectFromIdSelector(submissionId); + return subStateSelector(submissionIdSelector, 'metadataSecurityConfiguration'); +} diff --git a/src/app/submission/submission-object.service.spec.ts b/src/app/submission/submission-object.service.spec.ts index 8f6d570846c..8789f111a20 100644 --- a/src/app/submission/submission-object.service.spec.ts +++ b/src/app/submission/submission-object.service.spec.ts @@ -2,6 +2,7 @@ import { TestBed } from '@angular/core/testing'; import { APP_CONFIG } from '@dspace/config/app-config.interface'; import { RemoteData } from '@dspace/core/data/remote-data'; import { HALEndpointService } from '@dspace/core/shared/hal-endpoint.service'; +import { EditItemDataService } from '@dspace/core/submission/edititem-data.service'; import { SubmissionObject } from '@dspace/core/submission/models/submission-object.model'; import { SubmissionScopeType } from '@dspace/core/submission/submission-scope-type'; import { WorkflowItemDataService } from '@dspace/core/submission/workflowitem-data.service'; @@ -15,11 +16,13 @@ describe('SubmissionObjectService', () => { let submissionService: SubmissionService; let workspaceitemDataService: WorkspaceitemDataService; let workflowItemDataService: WorkflowItemDataService; + let editItemDataService: EditItemDataService; let halService: HALEndpointService; const submissionId = '1234'; const wsiResult = 'wsiResult' as any; const wfiResult = 'wfiResult' as any; + const eiResult = 'eiResult' as any; beforeEach(() => { workspaceitemDataService = jasmine.createSpyObj('WorkspaceitemDataService', { @@ -28,6 +31,9 @@ describe('SubmissionObjectService', () => { workflowItemDataService = jasmine.createSpyObj('WorkflowItemDataService', { findById: wfiResult, }); + editItemDataService = jasmine.createSpyObj('EditItemDataService', { + findById: eiResult, + }); halService = jasmine.createSpyObj('HALEndpointService', { getEndpoint: '/workspaceItem', }); @@ -38,6 +44,7 @@ describe('SubmissionObjectService', () => { { provide: WorkflowItemDataService, useValue: workflowItemDataService }, { provide: HALEndpointService, useValue: halService }, { provide: SubmissionService, useValue: submissionService }, + { provide: EditItemDataService, useValue: editItemDataService }, { provide: APP_CONFIG, useValue: { cache : { msToLive: { default : 15 * 60 * 1000 } } } }, SubmissionObjectService, ], diff --git a/src/app/submission/submission-object.service.ts b/src/app/submission/submission-object.service.ts index 8caa5f3f352..0ccb9496bf2 100644 --- a/src/app/submission/submission-object.service.ts +++ b/src/app/submission/submission-object.service.ts @@ -11,6 +11,7 @@ import { RemoteData } from '@dspace/core/data/remote-data'; import { RequestEntryState } from '@dspace/core/data/request-entry-state.model'; import { FollowLinkConfig } from '@dspace/core/shared/follow-link-config.model'; import { HALEndpointService } from '@dspace/core/shared/hal-endpoint.service'; +import { EditItemDataService } from '@dspace/core/submission/edititem-data.service'; import { SubmissionObject } from '@dspace/core/submission/models/submission-object.model'; import { SubmissionScopeType } from '@dspace/core/submission/submission-scope-type'; import { WorkflowItemDataService } from '@dspace/core/submission/workflowitem-data.service'; @@ -36,6 +37,7 @@ export class SubmissionObjectService { constructor( private workspaceitemDataService: WorkspaceitemDataService, private workflowItemDataService: WorkflowItemDataService, + private editItemDataService: EditItemDataService, private submissionService: SubmissionService, private halService: HALEndpointService, ) { @@ -46,7 +48,18 @@ export class SubmissionObjectService { * @param id The identifier for the object */ getHrefByID(id): Observable { - const dataService: IdentifiableDataService = this.submissionService.getSubmissionScope() === SubmissionScopeType.WorkspaceItem ? this.workspaceitemDataService : this.workflowItemDataService; + let dataService: IdentifiableDataService = this.submissionService.getSubmissionScope() === SubmissionScopeType.WorkspaceItem ? this.workspaceitemDataService : this.workflowItemDataService; + switch (this.submissionService.getSubmissionScope()) { + case SubmissionScopeType.WorkspaceItem: + dataService = this.workspaceitemDataService; + break; + case SubmissionScopeType.WorkflowItem: + dataService = this.workflowItemDataService; + break; + case SubmissionScopeType.EditItem: + dataService = this.editItemDataService; + break; + } return this.halService.getEndpoint(dataService.getLinkPath()).pipe( map((endpoint: string) => dataService.getIDHref(endpoint, encodeURIComponent(id)))); @@ -69,6 +82,8 @@ export class SubmissionObjectService { return this.workspaceitemDataService.findById(id, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow); case SubmissionScopeType.WorkflowItem: return this.workflowItemDataService.findById(id, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow); + case SubmissionScopeType.EditItem: + return this.editItemDataService.findById(id, useCachedVersionIfAvailable, reRequestOnStale,...linksToFollow); default: { const now = new Date().getTime(); return of(new RemoteData( diff --git a/src/app/submission/submission.service.spec.ts b/src/app/submission/submission.service.spec.ts index aa5b9862f59..1e64ca2a069 100644 --- a/src/app/submission/submission.service.spec.ts +++ b/src/app/submission/submission.service.spec.ts @@ -1,4 +1,7 @@ -import { HttpHeaders } from '@angular/common/http'; +import { + HttpHeaders, + HttpParams, +} from '@angular/common/http'; import { fakeAsync, flush, @@ -225,6 +228,7 @@ describe('SubmissionService test suite', () => { }, isLoading: false, savePending: false, + saveDecisionPending: false, depositPending: false, }, }, @@ -382,6 +386,7 @@ describe('SubmissionService test suite', () => { }, isLoading: false, savePending: false, + saveDecisionPending: false, depositPending: false, }, }, @@ -442,17 +447,38 @@ describe('SubmissionService test suite', () => { describe('createSubmission', () => { it('should create a new submission', () => { + const paramsObj = Object.create({}); + const params = new HttpParams({ fromObject: paramsObj }); + const options: HttpOptions = Object.create({}); + options.params = params; service.createSubmission(); expect((service as any).restService.postToEndpoint).toHaveBeenCalled(); - expect((service as any).restService.postToEndpoint).toHaveBeenCalledWith('workspaceitems', {}, null, null, undefined); + expect((service as any).restService.postToEndpoint).toHaveBeenCalledWith('workspaceitems', {}, null, options, undefined); + }); + + it('should create a new submission with entity type', () => { + const entityType = 'Publication'; + const params = new HttpParams({ fromObject: { entityType: entityType } }); + const options: HttpOptions = Object.create({}); + options.params = params; + + service.createSubmission(undefined, 'Publication'); + + expect((service as any).restService.postToEndpoint).toHaveBeenCalled(); + expect((service as any).restService.postToEndpoint).toHaveBeenCalledWith('workspaceitems', {}, null, options, undefined); }); it('should create a new submission with collection', () => { + const paramsObj = Object.create({}); + const params = new HttpParams({ fromObject: paramsObj }); + const options: HttpOptions = Object.create({}); + options.params = params; + service.createSubmission(collectionId); expect((service as any).restService.postToEndpoint).toHaveBeenCalled(); - expect((service as any).restService.postToEndpoint).toHaveBeenCalledWith('workspaceitems', {}, null, null, collectionId); + expect((service as any).restService.postToEndpoint).toHaveBeenCalledWith('workspaceitems', {}, null, options, collectionId); }); }); @@ -1086,6 +1112,27 @@ describe('SubmissionService test suite', () => { }); }); + describe('redirectToEditItem', () => { + it('should redirect to Item page', () => { + scheduler = getTestScheduler(); + + const itemUuid = 'd62fc60f-e9a5-48e6-973a-90819acf23ae'; + let itemSubmissionId = itemUuid + ':FULL'; + + scheduler.schedule(() => service.redirectToItemPage(itemSubmissionId)); + scheduler.flush(); + + expect((service as any).router.navigateByUrl).toHaveBeenCalledWith('/items/' + itemUuid, { replaceUrl: true }); + + itemSubmissionId = itemUuid; + scheduler.schedule(() => service.redirectToItemPage(itemSubmissionId)); + scheduler.flush(); + + expect((service as any).router.navigateByUrl).toHaveBeenCalledWith('/items/' + itemUuid, { replaceUrl: true }); + + }); + }); + describe('resetAllSubmissionObjects', () => { it('should dispatch a new CancelSubmissionFormAction', () => { service.resetAllSubmissionObjects(); diff --git a/src/app/submission/submission.service.ts b/src/app/submission/submission.service.ts index 428a13766a0..87d311dddfc 100644 --- a/src/app/submission/submission.service.ts +++ b/src/app/submission/submission.service.ts @@ -1,4 +1,7 @@ -import { HttpHeaders } from '@angular/common/http'; +import { + HttpHeaders, + HttpParams, +} from '@angular/common/http'; import { Injectable } from '@angular/core'; import { Router } from '@angular/router'; import { ErrorResponse } from '@dspace/core/cache/response.models'; @@ -9,6 +12,7 @@ import { HttpOptions } from '@dspace/core/dspace-rest/dspace-rest.service'; import { NotificationsService } from '@dspace/core/notification-system/notifications.service'; import { RouteService } from '@dspace/core/services/route.service'; import { Item } from '@dspace/core/shared/item.model'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { SectionScope } from '@dspace/core/submission/models/section-visibility.model'; import { SubmissionError } from '@dspace/core/submission/models/submission-error.model'; import { SubmissionObject } from '@dspace/core/submission/models/submission-object.model'; @@ -25,6 +29,7 @@ import { import { hasValue, isEmpty, + isNotEmpty, isNotUndefined, } from '@dspace/shared/utils/empty.util'; import { @@ -71,7 +76,10 @@ import { SubmissionSectionEntry, } from './objects/submission-objects.reducer'; import { SectionDataObject } from './sections/models/section-data.model'; -import { submissionObjectFromIdSelector } from './selectors'; +import { + securityConfigurationObjectFromIdSelector, + submissionObjectFromIdSelector, +} from './selectors'; import { submissionSelector, SubmissionState, @@ -109,6 +117,8 @@ export class SubmissionService { private workspaceLinkPath = 'workspaceitems'; private workflowLinkPath = 'workflowitems'; + private editItemsLinkPath = 'edititems'; + /** * Initialize service variables * @param {NotificationsService} notificationsService @@ -158,11 +168,46 @@ export class SubmissionService { * * @param collectionId * The owning collection id + * @param entityType + * The entity type + * @return Observable + * observable of SubmissionObject + */ + createSubmission(collectionId?: string, entityType?: string): Observable { + const paramsObj = Object.create({}); + + if (isNotEmpty(entityType)) { + paramsObj.entityType = entityType; + } + + const params = new HttpParams({ fromObject: paramsObj }); + const options: HttpOptions = Object.create({}); + options.params = params; + return this.restService.postToEndpoint(this.workspaceLinkPath, {}, null, options, collectionId).pipe( + map((workspaceitem: SubmissionObject[]) => workspaceitem[0] as SubmissionObject), + catchError(() => of({} as SubmissionObject))); + } + + /** + * Perform a REST call to create a new workspaceitem for a specified collection and return response + * + * @param collectionId + * The collection id * @return Observable * observable of SubmissionObject */ - createSubmission(collectionId?: string): Observable { - return this.restService.postToEndpoint(this.workspaceLinkPath, {}, null, null, collectionId).pipe( + createSubmissionForCollection(collectionId: string): Observable { + const paramsObj = Object.create({}); + + if (isNotEmpty(collectionId)) { + paramsObj.collection = collectionId; + } + + const params = new HttpParams({ fromObject: paramsObj }); + const options: HttpOptions = Object.create({}); + options.params = params; + + return this.restService.postToEndpoint(this.workspaceLinkPath, {}, null, options).pipe( map((workspaceitem: SubmissionObject[]) => workspaceitem[0] as SubmissionObject), catchError(() => of({} as SubmissionObject))); } @@ -185,6 +230,30 @@ export class SubmissionService { return this.restService.postToEndpoint(this.workspaceLinkPath, selfUrl, null, options, collectionId) as Observable; } + /** + * Perform a REST call to create a new workspaceitem by item and return response + * + * @return Observable + * observable of SubmissionObject + */ + createSubmissionByItem(itemId: string, relationshipName?: string): Observable { + const paramsObj = Object.create({}); + + if (isNotEmpty(itemId)) { + paramsObj.item = itemId; + } + if (isNotEmpty(relationshipName)) { + paramsObj.relationship = relationshipName; + } + + const params = new HttpParams({ fromObject: paramsObj }); + const options: HttpOptions = Object.create({}); + options.params = params; + + return this.restService.postToEndpoint(this.workspaceLinkPath, {}, null, options).pipe( + map((workspaceitem: SubmissionObject[]) => workspaceitem[0] as SubmissionObject)); + } + /** * Perform a REST call to deposit a workspaceitem and return response * @@ -226,8 +295,10 @@ export class SubmissionService { * The [SubmissionDefinitionsModel] that define submission configuration * @param sections * The [WorkspaceitemSectionsObject] that define submission sections init data + * @param item * @param errors * The [SubmissionSectionError] that define submission sections init errors + * @param metadataSecurityConfiguration */ dispatchInit( collectionId: string, @@ -236,8 +307,9 @@ export class SubmissionService { submissionDefinition: SubmissionDefinitionsModel, sections: WorkspaceitemSectionsObject, item: Item, - errors: SubmissionError) { - this.store.dispatch(new InitSubmissionFormAction(collectionId, submissionId, selfUrl, submissionDefinition, sections, item, errors)); + errors: SubmissionError, + metadataSecurityConfiguration?: MetadataSecurityConfiguration) { + this.store.dispatch(new InitSubmissionFormAction(collectionId, submissionId, selfUrl, submissionDefinition, sections, item, errors, metadataSecurityConfiguration)); } /** @@ -324,6 +396,19 @@ export class SubmissionService { filter((submission: SubmissionObjectEntry) => isNotUndefined(submission))); } + /** + * Return the [MetadataSecurityConfiguration] for the specified submission + * + * @param submissionId + * The submission id + * @return Observable + * observable of MetadataSecurityConfiguration + */ + getSubmissionSecurityConfiguration(submissionId: string): Observable { + return this.store.select(securityConfigurationObjectFromIdSelector(submissionId)).pipe( + filter((securityConfiguration: MetadataSecurityConfiguration) => isNotUndefined(securityConfiguration))); + } + /** * Return a list of the active [SectionDataObject] belonging to the specified submission * @@ -400,7 +485,7 @@ export class SubmissionService { } else if (url.startsWith('/workflowitems')) { return this.workflowLinkPath; } else { - return 'edititems'; + return this.editItemsLinkPath; } } @@ -419,6 +504,9 @@ export class SubmissionService { case this.workflowLinkPath: scope = SubmissionScopeType.WorkflowItem; break; + case this.editItemsLinkPath: + scope = SubmissionScopeType.EditItem; + break; } return scope; } @@ -530,6 +618,21 @@ export class SubmissionService { distinctUntilChanged()); } + /** + * Return the discard status of the submission + * + * @param submissionId + * The submission id + * @return Observable + * observable with submission discard status + */ + isSubmissionDiscarding(submissionId: string): Observable { + return this.store.select(submissionObjectFromIdSelector(submissionId)).pipe( + map((submission: SubmissionObjectEntry) => isEmpty(submission) || submission?.isDiscarding), + distinctUntilChanged(), + ); + } + /** * Show a notification when a new section is added to submission form * @@ -568,6 +671,14 @@ export class SubmissionService { ).subscribe(); } + /** + * Redirect to Item page + */ + redirectToItemPage(submissionId: string) { + const itemUuid = submissionId.indexOf(':') > -1 ? submissionId.split(':')[0] : submissionId; + this.router.navigateByUrl('/items/' + itemUuid, { replaceUrl: true }); + } + /** * Dispatch a new [CancelSubmissionFormAction] */ @@ -588,6 +699,8 @@ export class SubmissionService { * The [SubmissionDefinitionsModel] that define submission configuration * @param sections * The [WorkspaceitemSectionsObject] that define submission sections init data + * @param item + * @param metadataSecurityConfiguration */ resetSubmissionObject( collectionId: string, @@ -596,8 +709,9 @@ export class SubmissionService { submissionDefinition: SubmissionDefinitionsModel, sections: WorkspaceitemSectionsObject, item: Item, + metadataSecurityConfiguration: MetadataSecurityConfiguration = null, ) { - this.store.dispatch(new ResetSubmissionFormAction(collectionId, submissionId, selfUrl, sections, submissionDefinition, item)); + this.store.dispatch(new ResetSubmissionFormAction(collectionId, submissionId, selfUrl, sections, submissionDefinition, item, metadataSecurityConfiguration)); } /** @@ -606,8 +720,8 @@ export class SubmissionService { * @return Observable> * observable of RemoteData */ - retrieveSubmission(submissionId): Observable> { - return this.restService.getDataById(this.getSubmissionObjectLinkName(), submissionId).pipe( + retrieveSubmission(submissionId, projections: string[] = []): Observable> { + return this.restService.getDataById(this.getSubmissionObjectLinkName(), submissionId, false, projections).pipe( find((submissionObjects: SubmissionObject[]) => isNotUndefined(submissionObjects)), map((submissionObjects: SubmissionObject[]) => createSuccessfulRemoteDataObject( submissionObjects[0])), diff --git a/src/app/submission/utils/submission.mock.ts b/src/app/submission/utils/submission.mock.ts index 35b97993c4c..ff7d297b04f 100644 --- a/src/app/submission/utils/submission.mock.ts +++ b/src/app/submission/utils/submission.mock.ts @@ -3,6 +3,8 @@ import { buildPaginatedList } from '@dspace/core/data/paginated-list.model'; import { Group } from '@dspace/core/eperson/models/group.model'; import { FormFieldMetadataValueObject } from '@dspace/core/shared/form/models/form-field-metadata-value.model'; import { PageInfo } from '@dspace/core/shared/page-info.model'; +import { METADATA_SECURITY_TYPE } from '@dspace/core/submission/models/metadata-security-config.resource-type'; +import { MetadataSecurityConfiguration } from '@dspace/core/submission/models/metadata-security-configuration'; import { createSuccessfulRemoteDataObject$ } from '@dspace/core/utilities/remote-data.utils'; import { SubmissionObjectState } from '../objects/submission-objects.reducer'; @@ -324,6 +326,18 @@ export const mockSubmissionRestResponse = [ }, ]; +export const mockSecurityConfig: MetadataSecurityConfiguration = { + 'uuid' : 'Person', + 'metadataSecurityDefault' : [ 0, 1, 2 ], + 'metadataCustomSecurity' : { 'person.birthDate': [ 0, 1 ] }, + 'type' : METADATA_SECURITY_TYPE, + '_links' : { + 'self' : { + 'href' : 'http://localhost:8080/server/api/core/securitysettings/Person', + }, + }, +}; + export const mockSubmissionObject = { collection: { handle: '10673/2', @@ -581,6 +595,7 @@ export const mockSubmissionObject = { ], }, ], + metadataSecurityConfiguration: mockSecurityConfig, type: 'workspaceitem', _links: { collection: { href: 'https://rest.api/dspace-spring-rest/api/submission/workspaceitems/826/collection' }, @@ -1126,6 +1141,7 @@ export const mockSubmissionState: SubmissionObjectState = Object.assign({}, { } as any, }, isLoading: false, + isDiscarding: false, savePending: false, depositPending: false, }, @@ -1152,6 +1168,7 @@ export const mockSubmissionStateWithDuplicate: SubmissionObjectState = Object.as errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, collection: { config: '', @@ -1167,6 +1184,7 @@ export const mockSubmissionStateWithDuplicate: SubmissionObjectState = Object.as errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, traditionalpageone: { header: 'submit.progressbar.describe.stepone', @@ -1180,6 +1198,7 @@ export const mockSubmissionStateWithDuplicate: SubmissionObjectState = Object.as formId: '2_traditionalpageone', isLoading: false, isValid: false, + removePending: false, } as any, traditionalpagetwo: { header: 'submit.progressbar.describe.steptwo', @@ -1192,6 +1211,7 @@ export const mockSubmissionStateWithDuplicate: SubmissionObjectState = Object.as errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, upload: { header: 'submit.progressbar.upload', @@ -1206,6 +1226,7 @@ export const mockSubmissionStateWithDuplicate: SubmissionObjectState = Object.as errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, license: { header: 'submit.progressbar.license', @@ -1222,9 +1243,11 @@ export const mockSubmissionStateWithDuplicate: SubmissionObjectState = Object.as errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, }, isLoading: false, + isDiscarding: false, savePending: false, depositPending: false, }, @@ -1310,6 +1333,7 @@ export const mockSubmissionStateWithoutUpload: SubmissionObjectState = Object.as } as any, }, isLoading: false, + isDiscarding: false, savePending: false, depositPending: false, }, @@ -1345,6 +1369,7 @@ export const mockSectionsState = Object.assign({}, { errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, traditionalpageone: { header: 'submit.progressbar.describe.stepone', @@ -1357,6 +1382,7 @@ export const mockSectionsState = Object.assign({}, { errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, traditionalpagetwo: { header: 'submit.progressbar.describe.steptwo', @@ -1369,6 +1395,7 @@ export const mockSectionsState = Object.assign({}, { errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, upload: { header: 'submit.progressbar.upload', @@ -1381,6 +1408,7 @@ export const mockSectionsState = Object.assign({}, { errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, license: { header: 'submit.progressbar.license', @@ -1397,6 +1425,7 @@ export const mockSectionsState = Object.assign({}, { errorsToShow: [], isLoading: false, isValid: false, + removePending: false, } as any, }); @@ -1820,4 +1849,3 @@ export const mockAccessesFormData = { }, ], }; - diff --git a/src/assets/i18n/en.json5 b/src/assets/i18n/en.json5 index 0fc94d16210..ea6025c35c7 100644 --- a/src/assets/i18n/en.json5 +++ b/src/assets/i18n/en.json5 @@ -1379,18 +1379,34 @@ "collection.form.errors.title.required": "Please enter a collection name", + "collection.form.errors.submissionDefinition.required": "Please choose a submission definition for this collection", + + "collection.form.errors.entityType.required": "Please choose an entity type for this collection", + "collection.form.license": "License", "collection.form.provenance": "Provenance", "collection.form.rights": "Copyright text (HTML)", + "collection.form.sharedWorkspace": "Shared workspace", + "collection.form.tableofcontents": "News (HTML)", "collection.form.title": "Name", "collection.form.entityType": "Entity Type", + "collection.form.errors.entityType.required": "Please choose an entity type for this collection", + + "collection.form.errors.submissionDefinition.required": "Please choose a submission definition for this collection", + + "collection.form.submissionDefinition": "Submission definition", + + "collection.form.correctionSubmissionDefinition": "Submission definition for correction request", + + + "collection.listelement.badge": "Collection", "collection.logo": "Collection logo", @@ -1665,6 +1681,14 @@ "community.sub-community-list.head": "Communities in this Community", + "confirmation-modal.pending-changes.header": "Unsaved changes", + + "confirmation-modal.pending-changes.info": "There are unsaved changes. Do you want to leave the page?", + + "confirmation-modal.pending-changes.cancel": "Cancel", + + "confirmation-modal.pending-changes.confirm": "Leave", + "context-menu.actions.audit-item.btn": "Audit", "cookies.consent.accept-all": "Accept all", @@ -2101,6 +2125,8 @@ "form.clear-help": "Click here to remove the selected value", + "form.copy": "Duplicate", + "form.discard": "Discard", "form.drag": "Drag", @@ -2111,6 +2137,12 @@ "form.first-name": "First name", + "form.group.add": "Add", + + "form.group.close": "Close", + + "form.group.set": "Set", + "form.group-collapse": "Collapse", "form.group-collapse-help": "Click here to collapse", @@ -2143,6 +2175,40 @@ "form.other-information.orcid": "ORCID", + "form.other-information.person_identifier_orcid": "ORCID", + + "form.other-information.oairecerif_author_affiliation": "Affiliation", + + "form.other-information.oairecerif_editor_affiliation": "Affiliation", + + "form.other-information.person_identifier_orcid": "ORCID iD", + + "form.other-information.institution-affiliation-name": "Affiliation(s)", + + "form.other-information.dc_relation_grantno": "Grant Number", + + "form.other-information.not-available": "Not available", + + "form.other-information.ror_orgunit_id": "ROR ID", + + "form.other-information.ror_orgunit_type": "ROR type", + + "form.other-information.ror_orgunit_acronym": "ROR acronym", + + "form.other-information.ror_orgunit_countryName": "ROR country", + + "form.entry.source.local": "", + + "form.entry.source.orcid": "", + + "form.entry.source.ror": "", + + "form.entry.source.openaire": "", + + "form.entry.source.zdb": "", + + "form.entry.source.sherpa": "- Sherpa Romeo", + "form.remove": "Remove", "form.save": "Save", @@ -2627,6 +2693,8 @@ "item.edit.metadata.headers.language": "Lang", + "item.edit.metadata.headers.authority": "Authority", + "item.edit.metadata.headers.value": "Value", "item.edit.metadata.metadatafield": "Edit field", @@ -2971,7 +3039,7 @@ "item.page.date": "Date", - "item.page.edit": "Edit this item", + "item.page.edit": "Administer", "item.page.files": "Files", @@ -3011,6 +3079,10 @@ "item.page.relationships.isOrgUnitOfProject": "Research Projects", + "item.page.relationships.RELATION.Person.researchoutputs": "Publications", + + "item.page.relationships.RELATION.Person.projects": "Projects", + "item.page.subject": "Keywords", "item.page.uri": "URI", @@ -3311,6 +3383,8 @@ "itemtemplate.edit.metadata.headers.value": "Value", + "itemtemplate.edit.metadata.headers.authority": "Authority", + "itemtemplate.edit.metadata.metadatafield": "Edit field", "itemtemplate.edit.metadata.metadatafield.error": "An error occurred validating the metadata field", @@ -3345,7 +3419,7 @@ "journal.page.description": "Description", - "journal.page.edit": "Edit this item", + "journal.page.edit": "Administer", "journal.page.editor": "Editor-in-Chief", @@ -3367,7 +3441,7 @@ "journalissue.page.description": "Description", - "journalissue.page.edit": "Edit this item", + "journalissue.page.edit": "Administer", "journalissue.page.issuedate": "Issue Date", @@ -3389,7 +3463,7 @@ "journalvolume.page.description": "Description", - "journalvolume.page.edit": "Edit this item", + "journalvolume.page.edit": "Administer", "journalvolume.page.issuedate": "Issue Date", @@ -3661,6 +3735,14 @@ "menu.section.workflow": "Administer Workflow", + "menu.section.FULL": "Edit all the details", + + "menu.section.OWNER": "Edit", + + "menu.section.DIRECTOR": "Edit", + + "menu.section.INVESTIGATOR": "Edit", + "metadata-export-search.tooltip": "Export search results as CSV", "metadata-export-search.submit.success": "The export was started successfully", @@ -3727,6 +3809,8 @@ "mydspace.show.workspace": "Your submissions", + "mydspace.show.otherworkspace": "Other Workspace Submissions", + "mydspace.show.supervisedWorkspace": "Supervised items", "mydspace.status": "My DSpace status:", @@ -3955,7 +4039,7 @@ "orgunit.page.description": "Description", - "orgunit.page.edit": "Edit this item", + "orgunit.page.edit": "Administer", "orgunit.page.id": "ID", @@ -3983,7 +4067,7 @@ "person.page.birthdate": "Birth Date", - "person.page.edit": "Edit this item", + "person.page.edit": "Administer", "person.page.email": "Email Address", @@ -4239,7 +4323,7 @@ "project.page.description": "Description", - "project.page.edit": "Edit this item", + "project.page.edit": "Administer", "project.page.expectedcompletion": "Expected Completion", @@ -4263,7 +4347,7 @@ "publication.page.description": "Description", - "publication.page.edit": "Edit this item", + "publication.page.edit": "Administer", "publication.page.journal-issn": "Journal ISSN", @@ -4627,6 +4711,10 @@ "resource-policies.table.headers.title.for.collection": "Policies for Collection", + "RELATION.Person.researchoutputs.search.results.head": "Research Output", + + "RELATION.Person.projects.search.results.head": "Projects", + "root.skip-to-content": "Skip to main content", "search.description": "", @@ -6038,6 +6126,8 @@ "workflow.search.results.head": "Workflow tasks", + "otherworkspace.search.results.head": "Workspace submissions", + "supervision.search.results.head": "Workflow and Workspace tasks", "workflow-item.edit.breadcrumbs": "Edit workflowitem", @@ -6390,6 +6480,8 @@ "home.recent-submissions.head": "Recent Submissions", + "authority-confidence.search-label": "Search", + "listable-notification-object.default-message": "This object couldn't be retrieved", "system-wide-alert-banner.retrieval.error": "Something went wrong retrieving the system-wide alert banner", @@ -7291,4 +7383,22 @@ "item.preview.organization.address.addressLocality": "City", "item.preview.organization.alternateName": "Alternative name", + + "metadata-link-view.popover.label.Person.dc.title": "Fullname", + + "metadata-link-view.popover.label.Person.person.affiliation.name": "Main affiliation", + + "metadata-link-view.popover.label.Person.person.email": "Email", + + "metadata-link-view.popover.label.Person.person.identifier.orcid": "ORCID", + + "metadata-link-view.popover.label.Person.dc.description.abstract": "Abstract", + + "metadata-link-view.popover.label.Person.person.jobTitle": "Job title", + + "metadata-link-view.popover.label.other.dc.title": "Title", + + "metadata-link-view.popover.label.other.dc.description.abstract": "Description", + + "metadata-link-view.popover.label.more-info": "More info", } diff --git a/src/assets/images/local.logo.icon.svg b/src/assets/images/local.logo.icon.svg new file mode 100644 index 00000000000..fe25b833c9d --- /dev/null +++ b/src/assets/images/local.logo.icon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/assets/images/openaire.logo.icon.svg b/src/assets/images/openaire.logo.icon.svg new file mode 100644 index 00000000000..ea4d2014d5b --- /dev/null +++ b/src/assets/images/openaire.logo.icon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/assets/images/ror.logo.icon.svg b/src/assets/images/ror.logo.icon.svg new file mode 100644 index 00000000000..6bea5c60952 --- /dev/null +++ b/src/assets/images/ror.logo.icon.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/src/assets/images/sherpa.logo.icon.svg b/src/assets/images/sherpa.logo.icon.svg new file mode 100644 index 00000000000..e6a4921f3e6 --- /dev/null +++ b/src/assets/images/sherpa.logo.icon.svg @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + diff --git a/src/assets/images/zdb.logo.icon.svg b/src/assets/images/zdb.logo.icon.svg new file mode 100644 index 00000000000..a495cc2718f --- /dev/null +++ b/src/assets/images/zdb.logo.icon.svg @@ -0,0 +1 @@ +180509 ZDB-Logo diff --git a/src/config/additional-metadata.config.ts b/src/config/additional-metadata.config.ts new file mode 100644 index 00000000000..968cbd247c2 --- /dev/null +++ b/src/config/additional-metadata.config.ts @@ -0,0 +1,23 @@ +import { Config } from './config.interface'; + +export type AdditionalMetadataConfigRenderingTypes = + 'text' + | 'crisref' + | 'link' + | 'link.email' + | 'identifier' + | 'valuepair' + | 'date' + | 'authors' + | 'currentRole' + | 'lastRole'; + +export interface AdditionalMetadataConfig extends Config { + name: string, + rendering: AdditionalMetadataConfigRenderingTypes, + label?: string, + prefix?: string, + suffix?: string, + limitTo?: number, + startFromLast?: boolean +} diff --git a/src/config/app-config.interface.ts b/src/config/app-config.interface.ts index 681e494c6bd..916958e308b 100644 --- a/src/config/app-config.interface.ts +++ b/src/config/app-config.interface.ts @@ -19,16 +19,22 @@ import { FilterVocabularyConfig } from './filter-vocabulary-config'; import { FormConfig } from './form-config.interfaces'; import { GeospatialMapConfig } from './geospatial-map-config'; import { HomeConfig } from './homepage-config.interface'; +import { IdentifierSubtypesConfig } from './identifier-subtypes-config.interface'; import { InfoConfig } from './info-config.interface'; import { ItemConfig } from './item-config.interface'; import { LangConfig } from './lang-config.interface'; +import { LayoutConfig } from './layout-config.interfaces'; import { LiveRegionConfig } from './live-region.config'; import { MarkdownConfig } from './markdown-config.interface'; import { MatomoConfig } from './matomo-config.interface'; import { MediaViewerConfig } from './media-viewer-config.interface'; +import { MetadataLinkViewPopoverDataConfig } from './metadata-link-view-popoverdata-config.interface'; +import { MetadataSecurityConfig } from './metadata-security-config'; import { INotificationBoardOptions } from './notifications-config.interfaces'; import { QualityAssuranceConfig } from './quality-assurance.config'; +import { FollowAuthorityMetadata } from './search-follow-metadata.interface'; import { SearchConfig } from './search-page-config.interface'; +import { SearchResultConfig } from './search-result-config.interface'; import { ServerConfig } from './server-config.interface'; import { SubmissionConfig } from './submission-config.interface'; import { SuggestionConfig } from './suggestion-config.interfaces'; @@ -69,6 +75,14 @@ interface AppConfig extends Config { matomo?: MatomoConfig; geospatialMapViewer: GeospatialMapConfig; accessibility: AccessibilitySettingsConfig; + layout: LayoutConfig; + metadataLinkViewPopoverData: MetadataLinkViewPopoverDataConfig; + identifierSubtypes: IdentifierSubtypesConfig[]; + searchResult: SearchResultConfig; + followAuthorityMetadata: FollowAuthorityMetadata[]; + followAuthorityMaxItemLimit: number; + followAuthorityMetadataValuesLimit: number; + security: MetadataSecurityConfig; } /** diff --git a/src/config/default-app-config.ts b/src/config/default-app-config.ts index 4840c93e1ba..3111604954f 100644 --- a/src/config/default-app-config.ts +++ b/src/config/default-app-config.ts @@ -1,3 +1,6 @@ +import { LayoutConfig } from '@dspace/config/layout-config.interfaces'; +import { SearchResultConfig } from '@dspace/config/search-result-config.interface'; + import { AccessibilitySettingsConfig } from './accessibility-settings.config'; import { ActuatorsConfig } from './actuators.config'; import { AdminNotifyMetricsRow } from './admin-notify-metrics.config'; @@ -14,6 +17,10 @@ import { FilterVocabularyConfig } from './filter-vocabulary-config'; import { FormConfig } from './form-config.interfaces'; import { GeospatialMapConfig } from './geospatial-map-config'; import { HomeConfig } from './homepage-config.interface'; +import { + IdentifierSubtypesConfig, + IdentifierSubtypesIconPositionEnum, +} from './identifier-subtypes-config.interface'; import { InfoConfig } from './info-config.interface'; import { ItemConfig } from './item-config.interface'; import { LangConfig } from './lang-config.interface'; @@ -21,12 +28,15 @@ import { LiveRegionConfig } from './live-region.config'; import { MarkdownConfig } from './markdown-config.interface'; import { MatomoConfig } from './matomo-config.interface'; import { MediaViewerConfig } from './media-viewer-config.interface'; +import { MetadataLinkViewPopoverDataConfig } from './metadata-link-view-popoverdata-config.interface'; +import { MetadataSecurityConfig } from './metadata-security-config'; import { INotificationBoardOptions, NotificationAnimationsType, } from './notifications-config.interfaces'; import { QualityAssuranceConfig } from './quality-assurance.config'; import { RestRequestMethod } from './rest-request-method'; +import { FollowAuthorityMetadata } from './search-follow-metadata.interface'; import { SearchConfig } from './search-page-config.interface'; import { ServerConfig } from './server-config.interface'; import { SubmissionConfig } from './submission-config.interface'; @@ -252,7 +262,34 @@ export class DefaultAppConfig implements AppConfig { }, ], + sourceIcons: [ + { + source: 'orcid', + path: 'assets/images/orcid.logo.icon.svg', + }, + { + source: 'openaire', + path: 'assets/images/openaire.logo.icon.svg', + }, + { + source: 'ror', + path: 'assets/images/ror.logo.icon.svg', + }, + { + source: 'sherpa', + path: 'assets/images/sherpa.logo.icon.svg', + }, + { + source: 'zdb', + path: 'assets/images/zdb.logo.icon.svg', + }, + { + source: 'local', + path: 'assets/images/local.logo.icon.svg', + }, + ], }, + iconsVisibleWithNoAuthority: ['fas fa-user'], }, }; @@ -346,6 +383,9 @@ export class DefaultAppConfig implements AppConfig { // Show the bitstream access status label showAccessStatuses: false, }, + // If true, the search result in item page will display relations based on authority. + // If false,the search result in item page will display default DSpace relations. + showAuthorithyRelations: true, }; // Community Page Config @@ -646,4 +686,118 @@ export class DefaultAppConfig implements AppConfig { accessibility: AccessibilitySettingsConfig = { cookieExpirationDuration: 7, }; + + layout: LayoutConfig = { + authorityRef: [ + { + entityType: 'DEFAULT', + entityStyle: { + default: { + icon: 'fa fa-info', + style: 'text-info', + }, + }, + }, + { + entityType: 'PERSON', + entityStyle: { + default: { + icon: 'fa fa-user', + style: 'text-info', + }, + }, + }, + { + entityType: 'ORGUNIT', + entityStyle: { + default: { + icon: 'fa fa-university', + style: 'text-info', + }, + }, + }, + { + entityType: 'PROJECT', + entityStyle: { + default: { + icon: 'fas fa-project-diagram', + style: 'text-info', + }, + }, + }, + ], + }; + + searchResult: SearchResultConfig = { + additionalMetadataFields: [], + authorMetadata: ['dc.contributor.author', 'dc.creator', 'dc.contributor.*'], + }; + + // Configuration for the metadata link view popover + metadataLinkViewPopoverData: MetadataLinkViewPopoverDataConfig = { + fallbackMetdataList: ['dc.description.abstract'], + + entityDataConfig: [ + { + entityType: 'Person', + metadataList: ['person.affiliation.name', 'person.email', 'person.jobTitle', 'dc.description.abstract'], + titleMetadataList: ['person.givenName', 'person.familyName' ], + }, + ], + }; + + identifierSubtypes: IdentifierSubtypesConfig[] = [ + { + name: 'ror', + icon: 'assets/images/ror.logo.icon.svg', + iconPosition: IdentifierSubtypesIconPositionEnum.LEFT, + link: 'https://ror.org', + }, + ]; + + // The maximum number of item to process when following authority metadata values. + followAuthorityMaxItemLimit = 100; + // The maximum number of metadata values to process for each metadata key + // when following authority metadata values. + followAuthorityMetadataValuesLimit = 5; + + // When the search results are retrieved, for each item type the metadata with a valid authority value are inspected. + // Referenced items will be fetched with a find all by id strategy to avoid individual rest requests + // to efficiently display the search results. + followAuthorityMetadata: FollowAuthorityMetadata[] = [ + { + type: 'Publication', + metadata: ['dc.contributor.author'], + }, + { + type: 'Product', + metadata: ['dc.contributor.author'], + }, + { + type: 'Patent', + metadata: ['dc.contributor.author'], + }, + ]; + + + security: MetadataSecurityConfig = { + levels: [ + { + value: 0, + icon: 'fa fa-globe', + color: 'green', + }, + { + value: 1, + icon: 'fa fa-key', + color: 'orange', + }, + { + value: 2, + icon: 'fa fa-lock', + color: 'red', + }, + ], + }; + } diff --git a/src/config/identifier-subtypes-config.interface.ts b/src/config/identifier-subtypes-config.interface.ts new file mode 100644 index 00000000000..370fd2a1bf2 --- /dev/null +++ b/src/config/identifier-subtypes-config.interface.ts @@ -0,0 +1,15 @@ +/** + * Represents the configuration for identifier subtypes. + */ +export interface IdentifierSubtypesConfig { + name: string; // The name of the identifier subtype + icon: string; // The icon to display for the identifier subtype + iconPosition: IdentifierSubtypesIconPositionEnum; // The position of the icon relative to the identifier + link: string; // The link to navigate to when the icon is clicked +} + +export enum IdentifierSubtypesIconPositionEnum { + NONE = 'NONE', + LEFT = 'LEFT', + RIGHT = 'RIGHT', +} diff --git a/src/config/item-config.interface.ts b/src/config/item-config.interface.ts index 1b629bf8726..659a9819bb0 100644 --- a/src/config/item-config.interface.ts +++ b/src/config/item-config.interface.ts @@ -15,4 +15,6 @@ export interface ItemConfig extends Config { // Show the bitstream access status label showAccessStatuses: boolean; } + + showAuthorithyRelations: boolean; } diff --git a/src/config/layout-config.interfaces.ts b/src/config/layout-config.interfaces.ts new file mode 100644 index 00000000000..c2a0a5f7d2e --- /dev/null +++ b/src/config/layout-config.interfaces.ts @@ -0,0 +1,19 @@ +import { Config } from './config.interface'; + +export interface AuthorityRefEntityStyleConfig extends Config { + icon: string; + style: string; +} + +export interface AuthorityRefConfig extends Config { + entityType: string; + entityStyle: { + default: AuthorityRefEntityStyleConfig; + [entity: string]: AuthorityRefEntityStyleConfig; + }; +} + + +export interface LayoutConfig extends Config { + authorityRef: AuthorityRefConfig[]; +} diff --git a/src/config/metadata-link-view-popoverdata-config.interface.ts b/src/config/metadata-link-view-popoverdata-config.interface.ts new file mode 100644 index 00000000000..0193722e3ee --- /dev/null +++ b/src/config/metadata-link-view-popoverdata-config.interface.ts @@ -0,0 +1,27 @@ +export interface MetadataLinkViewPopoverDataConfig { + /** + * The list of entity types to display the metadata for + */ + entityDataConfig: EntityDataConfig[]; + + /** + * The list of metadata keys to fallback to + */ + fallbackMetdataList: string[]; +} + + +export interface EntityDataConfig { + /** + * The metadata entity type + */ + entityType: string; + /** + * The list of metadata keys to display + */ + metadataList: string[]; + /** + * The list of title metadata keys to display as title (optional as default is on dc.title) + **/ + titleMetadataList?: string[]; +} diff --git a/src/config/metadata-security-config.ts b/src/config/metadata-security-config.ts new file mode 100644 index 00000000000..fe12905c91b --- /dev/null +++ b/src/config/metadata-security-config.ts @@ -0,0 +1,11 @@ +import { Config } from './config.interface'; + +export interface MetadataSecurityConfig extends Config { + levels: LevelSecurityConfig[]; +} + +export interface LevelSecurityConfig extends Config { + value: number; + icon: string; + color: string; +} diff --git a/src/config/search-follow-metadata.interface.ts b/src/config/search-follow-metadata.interface.ts new file mode 100644 index 00000000000..b6c60a5f23a --- /dev/null +++ b/src/config/search-follow-metadata.interface.ts @@ -0,0 +1,18 @@ +import { Config } from './config.interface'; + +/** + * Config that determines how to follow metadata of search results. + */ +export interface FollowAuthorityMetadata extends Config { + + /** + * The type of the browse by dspace object result. + */ + type: string; + + /** + * The metadata to follow of the browse by dspace object result. + */ + metadata: string[]; + +} diff --git a/src/config/search-result-config.interface.ts b/src/config/search-result-config.interface.ts new file mode 100644 index 00000000000..e90a080a21b --- /dev/null +++ b/src/config/search-result-config.interface.ts @@ -0,0 +1,12 @@ +import { AdditionalMetadataConfig } from './additional-metadata.config'; +import { Config } from './config.interface'; + +export interface SearchResultConfig extends Config { + additionalMetadataFields: SearchResultAdditionalMetadataEntityTypeConfig[], + authorMetadata: string[]; +} + +export interface SearchResultAdditionalMetadataEntityTypeConfig extends Config { + entityType: string, + metadataConfiguration: Array[] +} diff --git a/src/config/submission-config.interface.ts b/src/config/submission-config.interface.ts index afc81a39e25..c163b9827b5 100644 --- a/src/config/submission-config.interface.ts +++ b/src/config/submission-config.interface.ts @@ -13,11 +13,18 @@ interface TypeBindConfig extends Config { field: string; } +export interface AuthorithyIcon { + source: string, + path: string +} + interface IconsConfig extends Config { metadata: MetadataIconConfig[]; authority: { confidence: ConfidenceIconConfig[]; + sourceIcons?: AuthorithyIcon[] }; + iconsVisibleWithNoAuthority?: string[] } export interface MetadataIconConfig extends Config { diff --git a/src/environments/environment.test.ts b/src/environments/environment.test.ts index a93c1fe9389..289d3777a12 100644 --- a/src/environments/environment.test.ts +++ b/src/environments/environment.test.ts @@ -290,6 +290,7 @@ export const environment: BuildConfig = { // Show the bitstream access status label showAccessStatuses: false, }, + showAuthorithyRelations: false, }, community: { defaultBrowseTab: 'search', @@ -477,4 +478,117 @@ export const environment: BuildConfig = { accessibility: { cookieExpirationDuration: 7, }, + + layout: { + authorityRef: [ + { + entityType: 'DEFAULT', + entityStyle: { + default: { + icon: 'fa fa-user', + style: 'text-success', + }, + }, + }, + { + entityType: 'PERSON', + entityStyle: { + person: { + icon: 'fa fa-user', + style: 'text-success', + }, + personStaff: { + icon: 'fa fa-user', + style: 'text-primary', + }, + default: { + icon: 'fa fa-user', + style: 'text-success', + }, + }, + }, + { + entityType: 'ORGUNIT', + entityStyle: { + default: { + icon: 'fa fa-university', + style: 'text-success', + }, + }, + }, + ], + }, + + searchResult: { + additionalMetadataFields: [], + authorMetadata: ['dc.contributor.author', 'dc.creator', 'dc.contributor.*'], + }, + + metadataLinkViewPopoverData: { + fallbackMetdataList: ['dc.description.abstract'], + + entityDataConfig: [ + { + entityType: 'Person', + metadataList: ['person.affiliation.name', 'person.email', 'person.identifier.orcid', 'dc.description.abstract'], + titleMetadataList: ['person.givenName', 'person.familyName' ], + }, + { + entityType: 'OrgUnit', + metadataList: ['organization.parentOrganization', 'organization.identifier.ror', 'crisou.director', 'dc.description.abstract'], + }, + { + entityType: 'Project', + metadataList: ['oairecerif.project.status', 'dc.description.abstract'], + }, + { + entityType: 'Funding', + metadataList: ['oairecerif.funder', 'oairecerif.fundingProgram', 'dc.description.abstract'], + }, + { + entityType: 'Publication', + metadataList: ['dc.identifier.doi', 'dc.identifier.uri', 'dc.description.abstract'], + }, + ], + }, + + identifierSubtypes: [], + + followAuthorityMaxItemLimit: 100, + + followAuthorityMetadataValuesLimit: 5, + + followAuthorityMetadata: [ + { + type: 'Publication', + metadata: ['dc.contributor.author'], + }, + { + type: 'Product', + metadata: ['dc.contributor.author'], + }, + { + type: 'Patent', + metadata: ['dc.contributor.author'], + }, + ], + + security: { + levels: [ + { + value: 0, + icon: 'fa fa-globe', + color: 'green', + }, + { + value: 1, + icon: 'fa fa-key', + color: 'orange', + }, + { + value: 2, + icon: 'fa fa-lock', + color: 'red', + }], + }, }; diff --git a/src/styles/_custom_variables.scss b/src/styles/_custom_variables.scss index 8b0e1ad32f7..c9410b60329 100644 --- a/src/styles/_custom_variables.scss +++ b/src/styles/_custom_variables.scss @@ -125,6 +125,7 @@ --ds-dso-edit-field-width: 210px; --ds-dso-edit-lang-width: 90px; + --ds-dso-edit-authority-width: 150px; --ds-dso-edit-actions-width: 173px; --ds-dso-edit-virtual-tooltip-min-width: 300px; @@ -164,4 +165,5 @@ --ds-filters-skeleton-height: 40px; --ds-filters-skeleton-spacing: 12px; + --ds-identifier-subtype-icon-height: 24px; } diff --git a/src/styles/_mixins.scss b/src/styles/_mixins.scss index eb39b8c7866..b1012c9a1f7 100644 --- a/src/styles/_mixins.scss +++ b/src/styles/_mixins.scss @@ -38,3 +38,21 @@ background-color: var(--ds-dark-scrollbar-bg); } } + +/* Define a mixin for vertical ellipsis + To be used as a class e.g. ellipsis-y-1,... ellipsis-y-4,... ellipsis-y-10 + */ +@mixin ellipsis-y($lines) { + display: -webkit-box; + -webkit-line-clamp: $lines; // number of lines + -webkit-box-orient: vertical; + overflow: hidden; + text-overflow: ellipsis; +} + +// Generate classes for 1 to 10 lines +@for $i from 1 through 10 { + .ellipsis-y-#{$i} { + @include ellipsis-y($i); + } +} diff --git a/src/themes/custom/app/entity-groups/research-entities/item-pages/person/person.component.ts b/src/themes/custom/app/entity-groups/research-entities/item-pages/person/person.component.ts index b7e21671c36..5bb6ae3a686 100644 --- a/src/themes/custom/app/entity-groups/research-entities/item-pages/person/person.component.ts +++ b/src/themes/custom/app/entity-groups/research-entities/item-pages/person/person.component.ts @@ -14,6 +14,7 @@ import { ThemedResultsBackButtonComponent } from 'src/app/shared/results-back-bu import { ThemedThumbnailComponent } from 'src/app/thumbnail/themed-thumbnail.component'; import { PersonComponent as BaseComponent } from '../../../../../../../app/entity-groups/research-entities/item-pages/person/person.component'; +import { AuthorityRelatedEntitiesSearchComponent } from '../../../../../../../app/item-page/simple/related-entities/authority-related-entities-search/authority-related-entities-search.component'; import { listableObjectComponent } from '../../../../../../../app/shared/object-collection/shared/listable-object/listable-object.decorator'; @listableObjectComponent('Person', ViewMode.StandalonePage, Context.Any, 'custom') @@ -25,6 +26,7 @@ import { listableObjectComponent } from '../../../../../../../app/shared/object- templateUrl: '../../../../../../../app/entity-groups/research-entities/item-pages/person/person.component.html', imports: [ AsyncPipe, + AuthorityRelatedEntitiesSearchComponent, DsoEditMenuComponent, GenericItemPageFieldComponent, MetadataFieldWrapperComponent, diff --git a/src/themes/custom/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.ts b/src/themes/custom/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.ts index 5ae2eac5d88..2e34e555eaf 100644 --- a/src/themes/custom/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.ts +++ b/src/themes/custom/app/shared/object-list/my-dspace-result-list-element/item-list-preview/item-list-preview.component.ts @@ -6,6 +6,7 @@ import { Component } from '@angular/core'; import { TranslateModule } from '@ngx-translate/core'; import { fadeInOut } from '../../../../../../../app/shared/animations/fade'; +import { MetadataLinkViewComponent } from '../../../../../../../app/shared/metadata-link-view/metadata-link-view.component'; import { ThemedBadgesComponent } from '../../../../../../../app/shared/object-collection/shared/badges/themed-badges.component'; import { ItemCollectionComponent } from '../../../../../../../app/shared/object-collection/shared/mydspace-item-collection/item-collection.component'; import { ItemSubmitterComponent } from '../../../../../../../app/shared/object-collection/shared/mydspace-item-submitter/item-submitter.component'; @@ -25,6 +26,7 @@ import { ThemedThumbnailComponent } from '../../../../../../../app/thumbnail/the AsyncPipe, ItemCollectionComponent, ItemSubmitterComponent, + MetadataLinkViewComponent, NgClass, ThemedBadgesComponent, ThemedThumbnailComponent, diff --git a/src/themes/custom/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.ts b/src/themes/custom/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.ts index a370c0e3467..fd54859022d 100644 --- a/src/themes/custom/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.ts +++ b/src/themes/custom/app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.ts @@ -8,6 +8,7 @@ import { Context } from '@dspace/core/shared/context.model'; import { ItemSearchResult } from '@dspace/core/shared/object-collection/item-search-result.model'; import { ViewMode } from '@dspace/core/shared/view-mode.model'; +import { MetadataLinkViewComponent } from '../../../../../../../../../app/shared/metadata-link-view/metadata-link-view.component'; import { ThemedBadgesComponent } from '../../../../../../../../../app/shared/object-collection/shared/badges/themed-badges.component'; import { listableObjectComponent } from '../../../../../../../../../app/shared/object-collection/shared/listable-object/listable-object.decorator'; import { ItemSearchResultListElementComponent as BaseComponent } from '../../../../../../../../../app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component'; @@ -25,6 +26,7 @@ import { ThemedThumbnailComponent } from '../../../../../../../../../app/thumbna templateUrl: '../../../../../../../../../app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component.html', imports: [ AsyncPipe, + MetadataLinkViewComponent, NgClass, RouterLink, ThemedBadgesComponent,