diff --git a/src/app/item-page/edit-item-page/edit-item-page.module.ts b/src/app/item-page/edit-item-page/edit-item-page.module.ts index 0a75394ddd..60aa2828bd 100644 --- a/src/app/item-page/edit-item-page/edit-item-page.module.ts +++ b/src/app/item-page/edit-item-page/edit-item-page.module.ts @@ -46,6 +46,9 @@ import { ResultsBackButtonModule } from '../../shared/results-back-button/result import { AccessControlFormModule } from '../../shared/access-control-form-container/access-control-form.module'; +import { + EditRelationshipListWrapperComponent +} from './item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component'; /** * Module that contains all components related to the Edit Item page administrator functionality @@ -94,6 +97,7 @@ import { ItemRegisterDoiComponent, ItemCurateComponent, ItemAccessControlComponent, + EditRelationshipListWrapperComponent, ], providers: [ BundleDataService, diff --git a/src/app/item-page/edit-item-page/item-relationships/edit-item-relationships.service.spec.ts b/src/app/item-page/edit-item-page/item-relationships/edit-item-relationships.service.spec.ts index f969416783..6ca7f57739 100644 --- a/src/app/item-page/edit-item-page/item-relationships/edit-item-relationships.service.spec.ts +++ b/src/app/item-page/edit-item-page/item-relationships/edit-item-relationships.service.spec.ts @@ -265,6 +265,95 @@ describe('EditItemRelationshipsService', () => { }); }); + describe('isProvidedItemTypeLeftType', () => { + it('should return true if the provided item corresponds to the left type of the relationship', (done) => { + const relationshipType = Object.assign(new RelationshipType(), { + leftType: createSuccessfulRemoteDataObject$({id: 'leftType'}), + rightType: createSuccessfulRemoteDataObject$({id: 'rightType'}), + }); + const itemType = Object.assign(new ItemType(), {id: 'leftType'} ); + const item = Object.assign(new Item(), {uuid: 'item-uuid'}); + + const result = service.isProvidedItemTypeLeftType(relationshipType, itemType, item); + result.subscribe((resultValue) => { + expect(resultValue).toBeTrue(); + done(); + }); + }); + + it('should return false if the provided item corresponds to the right type of the relationship', (done) => { + const relationshipType = Object.assign(new RelationshipType(), { + leftType: createSuccessfulRemoteDataObject$({id: 'leftType'}), + rightType: createSuccessfulRemoteDataObject$({id: 'rightType'}), + }); + const itemType = Object.assign(new ItemType(), {id: 'rightType'} ); + const item = Object.assign(new Item(), {uuid: 'item-uuid'}); + + const result = service.isProvidedItemTypeLeftType(relationshipType, itemType, item); + result.subscribe((resultValue) => { + expect(resultValue).toBeFalse(); + done(); + }); + }); + + it('should return undefined if the provided item corresponds does not match any of the relationship types', (done) => { + const relationshipType = Object.assign(new RelationshipType(), { + leftType: createSuccessfulRemoteDataObject$({id: 'leftType'}), + rightType: createSuccessfulRemoteDataObject$({id: 'rightType'}), + }); + const itemType = Object.assign(new ItemType(), {id: 'something-else'} ); + const item = Object.assign(new Item(), {uuid: 'item-uuid'}); + + const result = service.isProvidedItemTypeLeftType(relationshipType, itemType, item); + result.subscribe((resultValue) => { + expect(resultValue).toBeUndefined(); + done(); + }); + }); + }); + + describe('relationshipMatchesBothSameTypes', () => { + it('should return true if both left and right type of the relationship type are the same and match the provided itemtype', (done) => { + const relationshipType = Object.assign(new RelationshipType(), { + leftType: createSuccessfulRemoteDataObject$({id: 'sameType'}), + rightType: createSuccessfulRemoteDataObject$({id:'sameType'}), + }); + const itemType = Object.assign(new ItemType(), {id: 'sameType'} ); + + const result = service.relationshipMatchesBothSameTypes(relationshipType, itemType); + result.subscribe((resultValue) => { + expect(resultValue).toBeTrue(); + done(); + }); + }); + it('should return false if both left and right type of the relationship type are the same and do not match the provided itemtype', (done) => { + const relationshipType = Object.assign(new RelationshipType(), { + leftType: createSuccessfulRemoteDataObject$({id: 'sameType'}), + rightType: createSuccessfulRemoteDataObject$({id: 'sameType'}), + }); + const itemType = Object.assign(new ItemType(), {id: 'something-else'} ); + + const result = service.relationshipMatchesBothSameTypes(relationshipType, itemType); + result.subscribe((resultValue) => { + expect(resultValue).toBeFalse(); + done(); + }); + }); + it('should return false if both left and right type of the relationship type are different', (done) => { + const relationshipType = Object.assign(new RelationshipType(), { + leftType: createSuccessfulRemoteDataObject$({id: 'leftType'}), + rightType: createSuccessfulRemoteDataObject$({id: 'rightType'}), + }); + const itemType = Object.assign(new ItemType(), {id: 'leftType'} ); + + const result = service.relationshipMatchesBothSameTypes(relationshipType, itemType); + result.subscribe((resultValue) => { + expect(resultValue).toBeFalse(); + done(); + }); + }); + }); + describe('displayNotifications', () => { it('should show one success notification when multiple requests succeeded', () => { service.displayNotifications([ diff --git a/src/app/item-page/edit-item-page/item-relationships/edit-item-relationships.service.ts b/src/app/item-page/edit-item-page/item-relationships/edit-item-relationships.service.ts index 2cecd878b7..f14e95f66f 100644 --- a/src/app/item-page/edit-item-page/item-relationships/edit-item-relationships.service.ts +++ b/src/app/item-page/edit-item-page/item-relationships/edit-item-relationships.service.ts @@ -10,7 +10,7 @@ import { } from '../../../core/data/object-updates/object-updates.reducer'; import { RemoteData } from '../../../core/data/remote-data'; import { Relationship } from '../../../core/shared/item-relationships/relationship.model'; -import { EMPTY, Observable, BehaviorSubject, Subscription } from 'rxjs'; +import { EMPTY, Observable, BehaviorSubject, Subscription, combineLatest as observableCombineLatest } from 'rxjs'; import { ObjectUpdatesService } from '../../../core/data/object-updates/object-updates.service'; import { ItemDataService } from '../../../core/data/item-data.service'; import { Item } from '../../../core/shared/item.model'; @@ -20,6 +20,9 @@ import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { RelationshipDataService } from '../../../core/data/relationship-data.service'; import { EntityTypeDataService } from '../../../core/data/entity-type-data.service'; import { TranslateService } from '@ngx-translate/core'; +import { ItemType } from '../../../core/shared/item-relationships/item-type.model'; +import { getFirstSucceededRemoteData, getRemoteDataPayload } from '../../../core/shared/operators'; +import { RelationshipType } from '../../../core/shared/item-relationships/relationship-type.model'; @Injectable({ providedIn: 'root' @@ -169,6 +172,49 @@ export class EditItemRelationshipsService { } } + isProvidedItemTypeLeftType(relationshipType: RelationshipType, itemType: ItemType, item: Item): Observable { + return this.getRelationshipLeftAndRightType(relationshipType).pipe( + map(([leftType, rightType]: [ItemType, ItemType]) => { + if (leftType.id === itemType.id) { + return true; + } + + if (rightType.id === itemType.id) { + return false; + } + + // should never happen... + console.warn(`The item ${item.uuid} is not on the right or the left side of relationship type ${relationshipType.uuid}`); + return undefined; + }) + ); + } + + relationshipMatchesBothSameTypes(relationshipType: RelationshipType, itemType: ItemType): Observable { + return this.getRelationshipLeftAndRightType(relationshipType).pipe( + map(([leftType, rightType]: [ItemType, ItemType]) => { + return leftType.id === itemType.id && rightType.id === itemType.id; + }) + ); + } + + protected getRelationshipLeftAndRightType(relationshipType: RelationshipType): Observable<[ItemType, ItemType]> { + const leftType$: Observable = relationshipType.leftType.pipe( + getFirstSucceededRemoteData(), + getRemoteDataPayload(), + ); + + const rightType$: Observable = relationshipType.rightType.pipe( + getFirstSucceededRemoteData(), + getRemoteDataPayload(), + ); + + return observableCombineLatest([ + leftType$, + rightType$, + ]); + } + /** @@ -185,6 +231,5 @@ export class EditItemRelationshipsService { */ getNotificationContent(key: string): string { return this.translateService.instant(this.notificationsPrefix + key + '.content'); - } } diff --git a/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.html b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.html new file mode 100644 index 0000000000..e6c1aa25f7 --- /dev/null +++ b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.html @@ -0,0 +1,30 @@ + + + + + + + + + diff --git a/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.scss b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.scss new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.spec.ts b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.spec.ts new file mode 100644 index 0000000000..6c1aa9dafe --- /dev/null +++ b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.spec.ts @@ -0,0 +1,108 @@ +import { ChangeDetectorRef, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; +import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing'; +import { of as observableOf } from 'rxjs'; +import { EditRelationshipListWrapperComponent } from './edit-relationship-list-wrapper.component'; +import { EditItemRelationshipsService } from '../edit-item-relationships.service'; +import { By } from '@angular/platform-browser'; +import { RelationshipType } from '../../../../core/shared/item-relationships/relationship-type.model'; +import { createSuccessfulRemoteDataObject$ } from '../../../../shared/remote-data.utils'; +import { ItemType } from '../../../../core/shared/item-relationships/item-type.model'; +import { Item } from '../../../../core/shared/item.model'; + +describe('EditRelationshipListWrapperComponent', () => { + let editItemRelationshipsService: EditItemRelationshipsService; + let comp: EditRelationshipListWrapperComponent; + let fixture: ComponentFixture; + + const leftType = Object.assign(new ItemType(), {id: 'leftType', label: 'leftTypeString'}); + const rightType = Object.assign(new ItemType(), {id: 'rightType', label: 'rightTypeString'}); + + const relationshipType = Object.assign(new RelationshipType(), { + id: '1', + leftMaxCardinality: null, + leftMinCardinality: 0, + leftType: createSuccessfulRemoteDataObject$(leftType), + leftwardType: 'isOrgUnitOfOrgUnit', + rightMaxCardinality: null, + rightMinCardinality: 0, + rightType: createSuccessfulRemoteDataObject$(rightType), + rightwardType: 'isOrgUnitOfOrgUnit', + uuid: 'relationshiptype-1', + }); + + const item = Object.assign(new Item(), {uuid: 'item-uuid'}); + + beforeEach(waitForAsync(() => { + + editItemRelationshipsService = jasmine.createSpyObj('editItemRelationshipsService', { + isProvidedItemTypeLeftType: observableOf(true), + relationshipMatchesBothSameTypes: observableOf(false) + }); + + + TestBed.configureTestingModule({ + // imports: [NoopAnimationsModule, SharedModule, TranslateModule.forRoot()], + declarations: [EditRelationshipListWrapperComponent], + providers: [ + {provide: EditItemRelationshipsService, useValue: editItemRelationshipsService}, + ChangeDetectorRef + ], schemas: [ + CUSTOM_ELEMENTS_SCHEMA + ] + }).compileComponents(); + + })); + + beforeEach(() => { + fixture = TestBed.createComponent(EditRelationshipListWrapperComponent); + comp = fixture.componentInstance; + comp.relationshipType = relationshipType; + comp.itemType = leftType; + comp.item = item; + + fixture.detectChanges(); + }); + + describe('onInit', () => { + it('should render the component', () => { + expect(comp).toBeTruthy(); + }); + it('should set currentItemIsLeftItem$ and bothItemsMatchType$ based on the provided relationshipType, itemType and item', () => { + expect(editItemRelationshipsService.isProvidedItemTypeLeftType).toHaveBeenCalledWith(relationshipType, leftType, item); + expect(editItemRelationshipsService.relationshipMatchesBothSameTypes).toHaveBeenCalledWith(relationshipType, leftType); + + expect(comp.currentItemIsLeftItem$.getValue()).toEqual(true); + expect(comp.bothItemsMatchType$.getValue()).toEqual(false); + }); + }); + + describe('when the current item is left', () => { + it('should render one relationship list section', () => { + const relationshipLists = fixture.debugElement.queryAll(By.css('ds-edit-relationship-list')); + expect(relationshipLists.length).toEqual(1); + }); + }); + + describe('when the current item is right', () => { + it('should render one relationship list section', () => { + (editItemRelationshipsService.isProvidedItemTypeLeftType as jasmine.Spy).and.returnValue(observableOf(false)); + comp.ngOnInit(); + fixture.detectChanges(); + + const relationshipLists = fixture.debugElement.queryAll(By.css('ds-edit-relationship-list')); + expect(relationshipLists.length).toEqual(1); + }); + }); + + describe('when the current item is both left and right', () => { + it('should render two relationship list sections', () => { + (editItemRelationshipsService.relationshipMatchesBothSameTypes as jasmine.Spy).and.returnValue(observableOf(true)); + comp.ngOnInit(); + fixture.detectChanges(); + + const relationshipLists = fixture.debugElement.queryAll(By.css('ds-edit-relationship-list')); + expect(relationshipLists.length).toEqual(2); + }); + }); + +}); diff --git a/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.ts b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.ts new file mode 100644 index 0000000000..8231eaa542 --- /dev/null +++ b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list-wrapper/edit-relationship-list-wrapper.component.ts @@ -0,0 +1,91 @@ +import { Component, EventEmitter, Input, OnDestroy, OnInit, Output } from '@angular/core'; +import { BehaviorSubject, Observable, Subscription } from 'rxjs'; +import { Item } from '../../../../core/shared/item.model'; +import { hasValue } from '../../../../shared/empty.util'; +import { RelationshipType } from '../../../../core/shared/item-relationships/relationship-type.model'; +import { ItemType } from '../../../../core/shared/item-relationships/item-type.model'; +import { EditItemRelationshipsService } from '../edit-item-relationships.service'; + +@Component({ + selector: 'ds-edit-relationship-list-wrapper', + styleUrls: ['./edit-relationship-list-wrapper.component.scss'], + templateUrl: './edit-relationship-list-wrapper.component.html', +}) +/** + * A component creating a list of editable relationships of a certain type + * The relationships are rendered as a list of related items + */ +export class EditRelationshipListWrapperComponent implements OnInit, OnDestroy { + + /** + * The item to display related items for + */ + @Input() item: Item; + + @Input() itemType: ItemType; + + /** + * The URL to the current page + * Used to fetch updates for the current item from the store + */ + @Input() url: string; + + /** + * The label of the relationship-type we're rendering a list for + */ + @Input() relationshipType: RelationshipType; + + /** + * If updated information has changed + */ + @Input() hasChanges!: Observable; + + /** + * The event emmiter to submit the new information + */ + @Output() submitModal: EventEmitter = new EventEmitter(); + + /** + * Observable that emits true if {@link itemType} is on the left-hand side of {@link relationshipType}, + * false if it is on the right-hand side and undefined in the rare case that it is on neither side. + */ + currentItemIsLeftItem$: BehaviorSubject = new BehaviorSubject(undefined); + + + isLeftItem$ = new BehaviorSubject(true); + + isRightItem$ = new BehaviorSubject(false); + + bothItemsMatchType$: BehaviorSubject = new BehaviorSubject(undefined); + + /** + * Array to track all subscriptions and unsubscribe them onDestroy + * @type {Array} + */ + private subs: Subscription[] = []; + + constructor( + protected editItemRelationshipsService: EditItemRelationshipsService, + ) { + } + + + ngOnInit(): void { + this.subs.push(this.editItemRelationshipsService.isProvidedItemTypeLeftType(this.relationshipType, this.itemType, this.item) + .subscribe((nextValue: boolean) => { + this.currentItemIsLeftItem$.next(nextValue); + })); + + this.subs.push(this.editItemRelationshipsService.relationshipMatchesBothSameTypes(this.relationshipType, this.itemType) + .subscribe((nextValue: boolean) => { + this.bothItemsMatchType$.next(nextValue); + })); + } + + + ngOnDestroy(): void { + this.subs + .filter((subscription) => hasValue(subscription)) + .forEach((subscription) => subscription.unsubscribe()); + } +} diff --git a/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.spec.ts b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.spec.ts index 3a627232a4..9504ebb078 100644 --- a/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.spec.ts +++ b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.spec.ts @@ -2,7 +2,7 @@ import { DebugElement, NO_ERRORS_SCHEMA } from '@angular/core'; import { waitForAsync, ComponentFixture, TestBed } from '@angular/core/testing'; import { By } from '@angular/platform-browser'; import { TranslateModule } from '@ngx-translate/core'; -import { of as observableOf } from 'rxjs'; +import { BehaviorSubject, of as observableOf } from 'rxjs'; import { LinkService } from '../../../../core/cache/builders/link.service'; import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; import { RelationshipDataService } from '../../../../core/data/relationship-data.service'; @@ -63,6 +63,7 @@ describe('EditRelationshipListComponent', () => { let relationships: Relationship[]; let relationshipType: RelationshipType; let paginationOptions: PaginationComponentOptions; + let currentItemIsLeftItem$ = new BehaviorSubject(true); const resetComponent = () => { fixture = TestBed.createComponent(EditRelationshipListComponent); @@ -73,6 +74,7 @@ describe('EditRelationshipListComponent', () => { comp.url = url; comp.relationshipType = relationshipType; comp.hasChanges = observableOf(false); + comp.currentItemIsLeftItem$ = currentItemIsLeftItem$; fixture.detectChanges(); }; @@ -293,6 +295,7 @@ describe('EditRelationshipListComponent', () => { leftwardType: 'isAuthorOfPublication', rightwardType: 'isPublicationOfAuthor', }); + currentItemIsLeftItem$ = new BehaviorSubject(true); relationshipService.getItemRelationshipsByLabel.calls.reset(); resetComponent(); }); @@ -317,6 +320,7 @@ describe('EditRelationshipListComponent', () => { leftwardType: 'isPublicationOfAuthor', rightwardType: 'isAuthorOfPublication', }); + currentItemIsLeftItem$ = new BehaviorSubject(false); relationshipService.getItemRelationshipsByLabel.calls.reset(); resetComponent(); }); diff --git a/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.ts b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.ts index c4b2bba36f..c105f0ef93 100644 --- a/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.ts +++ b/src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.ts @@ -113,7 +113,7 @@ export class EditRelationshipListComponent implements OnInit, OnDestroy { * Observable that emits true if {@link itemType} is on the left-hand side of {@link relationshipType}, * false if it is on the right-hand side and undefined in the rare case that it is on neither side. */ - private currentItemIsLeftItem$: BehaviorSubject = new BehaviorSubject(undefined); + @Input() currentItemIsLeftItem$: BehaviorSubject = new BehaviorSubject(undefined); relatedEntityType$: Observable; @@ -213,18 +213,15 @@ export class EditRelationshipListComponent implements OnInit, OnDestroy { * Get the relevant label for this relationship type */ private getLabel(): Observable { - return observableCombineLatest([ - this.relationshipType.leftType, - this.relationshipType.rightType, - ].map((itemTypeRD) => itemTypeRD.pipe( - getFirstSucceededRemoteData(), - getRemoteDataPayload(), - ))).pipe( - map((itemTypes: ItemType[]) => [ - this.relationshipType.leftwardType, - this.relationshipType.rightwardType, - ][itemTypes.findIndex((itemType) => itemType.id === this.itemType.id)]), - ); + return this.currentItemIsLeftItem$.pipe( + map((currentItemIsLeftItem) => { + if (currentItemIsLeftItem) { + return this.relationshipType.leftwardType; + } else { + return this.relationshipType.rightwardType; + } + }) + ); } /** @@ -251,6 +248,7 @@ export class EditRelationshipListComponent implements OnInit, OnDestroy { modalComp.toAdd = []; modalComp.toRemove = []; modalComp.isPending = false; + modalComp.hiddenQuery = '-search.resourceid:' + this.item.uuid; this.item.owningCollection.pipe( getFirstSucceededRemoteDataPayload() @@ -424,24 +422,6 @@ export class EditRelationshipListComponent implements OnInit, OnDestroy { this.relationshipMessageKey$ = this.getRelationshipMessageKey(); - this.subs.push(this.relationshipLeftAndRightType$.pipe( - map(([leftType, rightType]: [ItemType, ItemType]) => { - if (leftType.id === this.itemType.id) { - return true; - } - - if (rightType.id === this.itemType.id) { - return false; - } - - // should never happen... - console.warn(`The item ${this.item.uuid} is not on the right or the left side of relationship type ${this.relationshipType.uuid}`); - return undefined; - }) - ).subscribe((nextValue: boolean) => { - this.currentItemIsLeftItem$.next(nextValue); - })); - // initialize the pagination options this.paginationConfig = new PaginationComponentOptions(); diff --git a/src/app/item-page/edit-item-page/item-relationships/item-relationships.component.html b/src/app/item-page/edit-item-page/item-relationships/item-relationships.component.html index 755731f576..85f41a25d9 100644 --- a/src/app/item-page/edit-item-page/item-relationships/item-relationships.component.html +++ b/src/app/item-page/edit-item-page/item-relationships/item-relationships.component.html @@ -5,13 +5,13 @@
- + >
diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/dynamic-lookup-relation-modal.component.html b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/dynamic-lookup-relation-modal.component.html index 71cc8de0ac..703fb8c812 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/dynamic-lookup-relation-modal.component.html +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/dynamic-lookup-relation-modal.component.html @@ -19,6 +19,7 @@ [repeatable]="repeatable" [context]="context" [query]="query" + [hiddenQuery]="hiddenQuery" [relationshipType]="relationshipType" [isLeft]="isLeft" [item]="item" diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/dynamic-lookup-relation-modal.component.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/dynamic-lookup-relation-modal.component.ts index ac436639bc..1881cc1efa 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/dynamic-lookup-relation-modal.component.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/dynamic-lookup-relation-modal.component.ts @@ -97,6 +97,11 @@ export class DsDynamicLookupRelationModalComponent implements OnInit, OnDestroy query: string; + /** + * A hidden query that will be used but not displayed in the url/searchbar + */ + hiddenQuery: string; + /** * A map of subscriptions within this component */ diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.html b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.html index 00bfa7981a..caf3116a53 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.html +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.html @@ -2,6 +2,7 @@ [configuration]="this.relationship.searchConfiguration" [context]="context" [fixedFilterQuery]="this.relationship.filter" + [hiddenQuery]="hiddenQuery" [inPlaceSearch]="true" [linkType]="linkTypes.ExternalLink" [searchFormPlaceholder]="'submission.sections.describe.relationship-lookup.search-tab.search-form.placeholder'" diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.ts index 3e874d8c50..24b5ae3595 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.ts @@ -93,6 +93,11 @@ export class DsDynamicLookupRelationSearchTabComponent implements OnInit, OnDest */ @Input() isEditRelationship: boolean; + /** + * A hidden query that will be used but not displayed in the url/searchbar + */ + @Input() hiddenQuery: string; + /** * Send an event to deselect an object from the list */ diff --git a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/themed-dynamic-lookup-relation-search-tab.component.ts b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/themed-dynamic-lookup-relation-search-tab.component.ts index d3ad1e2b78..9770de9745 100644 --- a/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/themed-dynamic-lookup-relation-search-tab.component.ts +++ b/src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/themed-dynamic-lookup-relation-search-tab.component.ts @@ -18,7 +18,7 @@ import { DSpaceObject } from '../../../../../../core/shared/dspace-object.model' }) export class ThemedDynamicLookupRelationSearchTabComponent extends ThemedComponent { protected inAndOutputNames: (keyof DsDynamicLookupRelationSearchTabComponent & keyof this)[] = ['relationship', 'listId', - 'query', 'repeatable', 'selection$', 'context', 'relationshipType', 'item', 'isLeft', 'toRemove', 'isEditRelationship', + 'query', 'hiddenQuery', 'repeatable', 'selection$', 'context', 'relationshipType', 'item', 'isLeft', 'toRemove', 'isEditRelationship', 'deselectObject', 'selectObject', 'resultFound']; @Input() relationship: RelationshipOptions; @@ -27,6 +27,8 @@ export class ThemedDynamicLookupRelationSearchTabComponent extends ThemedCompone @Input() query: string; + @Input() hiddenQuery: string; + @Input() repeatable: boolean; @Input() selection$: Observable; diff --git a/src/app/shared/search/search.component.spec.ts b/src/app/shared/search/search.component.spec.ts index d0d9bdda86..876390e3a8 100644 --- a/src/app/shared/search/search.component.spec.ts +++ b/src/app/shared/search/search.component.spec.ts @@ -108,6 +108,7 @@ const searchServiceStub = jasmine.createSpyObj('SearchService', { }) as SearchService; const configurationParam = 'default'; const queryParam = 'test query'; +const hiddenQuery = 'hidden query'; const scopeParam = '7669c72a-3f2a-451f-a3b9-9210e7a4c02f'; const fixedFilter = 'fixed filter'; @@ -250,6 +251,7 @@ describe('SearchComponent', () => { comp = fixture.componentInstance; // SearchComponent test instance comp.inPlaceSearch = false; comp.paginationId = paginationId; + comp.hiddenQuery = hiddenQuery; spyOn((comp as any), 'getSearchOptions').and.returnValue(paginatedSearchOptions$.asObservable()); diff --git a/src/app/shared/search/search.component.ts b/src/app/shared/search/search.component.ts index 61f3a119c8..a5bc4c19cb 100644 --- a/src/app/shared/search/search.component.ts +++ b/src/app/shared/search/search.component.ts @@ -75,6 +75,11 @@ export class SearchComponent implements OnInit { */ @Input() fixedFilterQuery: string; + /** + * A hidden query that will be used but not displayed in the url/searchbar + */ + @Input() hiddenQuery: string; + /** * If this is true, the request will only be sent if there's * no valid cached version. Defaults to true @@ -337,6 +342,7 @@ export class SearchComponent implements OnInit { if (combinedOptions.query === '') { combinedOptions.query = this.query; } + const newSearchOptions = new PaginatedSearchOptions(combinedOptions); // check if search options are changed // if so retrieve new related results otherwise skip it @@ -440,8 +446,18 @@ export class SearchComponent implements OnInit { if (this.configuration === 'supervision') { followLinks.push(followLink('supervisionOrders', { isOptional: true }) as any); } + + const searchOptionsWithHidden = Object.assign (new PaginatedSearchOptions({}), searchOptions); + if (isNotEmpty(this.hiddenQuery)) { + if (isNotEmpty(searchOptionsWithHidden.query)) { + searchOptionsWithHidden.query = searchOptionsWithHidden.query + ' AND ' + this.hiddenQuery; + } else { + searchOptionsWithHidden.query = this.hiddenQuery; + } + } + this.service.search( - searchOptions, + searchOptionsWithHidden, undefined, this.useCachedVersionIfAvailable, true, @@ -450,7 +466,7 @@ export class SearchComponent implements OnInit { .subscribe((results: RemoteData>) => { if (results.hasSucceeded) { if (this.trackStatistics) { - this.service.trackSearch(searchOptions, results.payload); + this.service.trackSearch(searchOptionsWithHidden, results.payload); } if (results.payload?.page?.length > 0) { this.resultFound.emit(results.payload); diff --git a/src/app/shared/search/themed-search.component.ts b/src/app/shared/search/themed-search.component.ts index fe531e4f0f..5ca2dceab1 100644 --- a/src/app/shared/search/themed-search.component.ts +++ b/src/app/shared/search/themed-search.component.ts @@ -19,7 +19,7 @@ import { ListableObject } from '../object-collection/shared/listable-object.mode templateUrl: '../theme-support/themed.component.html', }) export class ThemedSearchComponent extends ThemedComponent { - protected inAndOutputNames: (keyof SearchComponent & keyof this)[] = ['configurationList', 'context', 'configuration', 'fixedFilterQuery', 'useCachedVersionIfAvailable', 'inPlaceSearch', 'linkType', 'paginationId', 'searchEnabled', 'sideBarWidth', 'searchFormPlaceholder', 'selectable', 'selectionConfig', 'showCsvExport', 'showSidebar', 'showThumbnails', 'showViewModes', 'useUniquePageId', 'viewModeList', 'showScopeSelector', 'resultFound', 'deselectObject', 'selectObject', 'trackStatistics', 'query']; + protected inAndOutputNames: (keyof SearchComponent & keyof this)[] = ['configurationList', 'context', 'configuration', 'fixedFilterQuery', 'hiddenQuery', 'useCachedVersionIfAvailable', 'inPlaceSearch', 'linkType', 'paginationId', 'searchEnabled', 'sideBarWidth', 'searchFormPlaceholder', 'selectable', 'selectionConfig', 'showCsvExport', 'showSidebar', 'showThumbnails', 'showViewModes', 'useUniquePageId', 'viewModeList', 'showScopeSelector', 'resultFound', 'deselectObject', 'selectObject', 'trackStatistics', 'query']; @Input() configurationList: SearchConfigurationOption[]; @@ -29,6 +29,8 @@ export class ThemedSearchComponent extends ThemedComponent { @Input() fixedFilterQuery: string; + @Input() hiddenQuery: string; + @Input() useCachedVersionIfAvailable: boolean; @Input() inPlaceSearch: boolean;