w2p-85847 Add Authority to browse indexes

src/app/browse-by/browse-by-date-page/browse-by-date-page.component.ts

@@ -63,7 +63,7 @@ export class BrowseByDatePageComponent extends BrowseByMetadataPageComponent {
         this.browseId = params.id || this.defaultBrowseId;
         this.startsWith = +params.startsWith || params.startsWith;
         const searchOptions = browseParamsToOptions(params, currentPage, currentSort, this.browseId);
-        this.updatePageWithItems(searchOptions, this.value);
+        this.updatePageWithItems(searchOptions, this.value, undefined);
         this.updateParent(params.scope);
         this.updateStartsWithOptions(this.browseId, metadataField, params.scope);
       }));

src/app/browse-by/browse-by-metadata-page/browse-by-metadata-page.component.ts

@@ -99,6 +99,11 @@ export class BrowseByMetadataPageComponent implements OnInit {
    */
   value = '';
 
+  /**
+   * The authority key (may be undefined) associated with {@link #value}.
+   */
+   authority: string;
+
   /**
    * The current startsWith option (fetched and updated from query-params)
    */
@@ -123,11 +128,12 @@ export class BrowseByMetadataPageComponent implements OnInit {
         })
       ).subscribe(([params, currentPage, currentSort]: [Params, PaginationComponentOptions, SortOptions]) => {
           this.browseId = params.id || this.defaultBrowseId;
+          this.authority = params.authority;
           this.value = +params.value || params.value || '';
           this.startsWith = +params.startsWith || params.startsWith;
           const searchOptions = browseParamsToOptions(params, currentPage, currentSort, this.browseId);
           if (isNotEmpty(this.value)) {
-            this.updatePageWithItems(searchOptions, this.value);
+            this.updatePageWithItems(searchOptions, this.value, this.authority);
           } else {
             this.updatePage(searchOptions);
           }
@@ -166,8 +172,8 @@ export class BrowseByMetadataPageComponent implements OnInit {
    *                          scope: string }
    * @param value          The value of the browse-entry to display items for
    */
-  updatePageWithItems(searchOptions: BrowseEntrySearchOptions, value: string) {
+  updatePageWithItems(searchOptions: BrowseEntrySearchOptions, value: string, authority: string) {
-    this.items$ = this.browseService.getBrowseItemsFor(value, searchOptions);
+    this.items$ = this.browseService.getBrowseItemsFor(value, authority, searchOptions);
   }
 
   /**

src/app/browse-by/browse-by-title-page/browse-by-title-page.component.ts

@@ -46,7 +46,7 @@ export class BrowseByTitlePageComponent extends BrowseByMetadataPageComponent {
         })
       ).subscribe(([params, currentPage, currentSort]: [Params, PaginationComponentOptions, SortOptions]) => {
         this.browseId = params.id || this.defaultBrowseId;
-        this.updatePageWithItems(browseParamsToOptions(params, currentPage, currentSort, this.browseId), undefined);
+        this.updatePageWithItems(browseParamsToOptions(params, currentPage, currentSort, this.browseId), undefined, undefined);
         this.updateParent(params.scope);
       }));
     this.updateStartsWithTextOptions();

src/app/core/browse/browse.service.spec.ts

@@ -129,6 +129,7 @@ describe('BrowseService', () => {
   describe('getBrowseEntriesFor and findList', () => {
     // should contain special characters such that url encoding can be tested as well
     const mockAuthorName = 'Donald Smith & Sons';
+    const mockAuthorityKey = 'some authority key ?=;';
 
     beforeEach(() => {
       requestService = getMockRequestService(getRequestEntry$(true));
@@ -155,7 +156,7 @@ describe('BrowseService', () => {
       it('should call hrefOnlyDataService.findAllByHref with the expected href', () => {
         const expected = browseDefinitions[1]._links.items.href + '?filterValue=' + encodeURIComponent(mockAuthorName);
 
-        scheduler.schedule(() => service.getBrowseItemsFor(mockAuthorName, new BrowseEntrySearchOptions(browseDefinitions[1].id)).subscribe());
+        scheduler.schedule(() => service.getBrowseItemsFor(mockAuthorName, undefined, new BrowseEntrySearchOptions(browseDefinitions[1].id)).subscribe());
         scheduler.flush();
 
         expect(getFirstUsedArgumentOfSpyMethod(hrefOnlyDataService.findAllByHref)).toBeObservable(cold('(a|)', {
@@ -164,6 +165,20 @@ describe('BrowseService', () => {
       });
 
     });
+    describe('when getBrowseItemsFor is called with a valid filter value and authority key', () => {
+      it('should call hrefOnlyDataService.findAllByHref with the expected href', () => {
+        const expected = browseDefinitions[1]._links.items.href +
+          '?filterValue=' + encodeURIComponent(mockAuthorName) +
+          '&filterAuthority=' + encodeURIComponent(mockAuthorityKey);
+
+        scheduler.schedule(() => service.getBrowseItemsFor(mockAuthorName, mockAuthorityKey, new BrowseEntrySearchOptions(browseDefinitions[1].id)).subscribe());
+        scheduler.flush();
+
+        expect(getFirstUsedArgumentOfSpyMethod(hrefOnlyDataService.findAllByHref)).toBeObservable(cold('(a|)', {
+          a: expected
+        }));
+      });
+    });
   });
 
   describe('getBrowseURLFor', () => {

src/app/core/browse/browse.service.ts

@@ -105,7 +105,7 @@ export class BrowseService {
    * @param options                   Options to narrow down your search
    * @returns {Observable<RemoteData<PaginatedList<Item>>>}
    */
-  getBrowseItemsFor(filterValue: string, options: BrowseEntrySearchOptions): Observable<RemoteData<PaginatedList<Item>>> {
+  getBrowseItemsFor(filterValue: string, filterAuthority: string, options: BrowseEntrySearchOptions): Observable<RemoteData<PaginatedList<Item>>> {
     const href$ = this.getBrowseDefinitions().pipe(
       getBrowseDefinitionLinks(options.metadataDefinition),
       hasValueOperator(),
@@ -132,6 +132,9 @@ export class BrowseService {
         if (isNotEmpty(filterValue)) {
           args.push(`filterValue=${encodeURIComponent(filterValue)}`);
         }
+        if (isNotEmpty(filterAuthority)) {
+          args.push(`filterAuthority=${encodeURIComponent(filterAuthority)}`);
+        }
         if (isNotEmpty(args)) {
           href = new URLCombiner(href, `?${args.join('&')}`).toString();
         }

src/app/shared/object-list/browse-entry-list-element/browse-entry-list-element.component.html

@@ -1,5 +1,5 @@
 <div class="d-flex flex-row">
-    <a *ngIf="linkType != linkTypes.None" [target]="(linkType == linkTypes.ExternalLink) ? '_blank' : '_self'" rel="noopener noreferrer" [routerLink]="" [queryParams]="{value: object.value, startsWith: undefined}" [queryParamsHandling]="'merge'" class="lead">
+    <a *ngIf="linkType != linkTypes.None" [target]="(linkType == linkTypes.ExternalLink) ? '_blank' : '_self'" rel="noopener noreferrer" [routerLink]="" [queryParams]="getQueryParams()" [queryParamsHandling]="'merge'" class="lead">
         {{object.value}}
     </a>
     <span *ngIf="linkType == linkTypes.None" class="lead">

src/app/shared/object-list/browse-entry-list-element/browse-entry-list-element.component.ts

@@ -15,4 +15,16 @@ import { listableObjectComponent } from '../../object-collection/shared/listable
  * This component is automatically used to create a list view for BrowseEntry objects when used in ObjectCollectionComponent
  */
 @listableObjectComponent(BrowseEntry, ViewMode.ListElement)
-export class BrowseEntryListElementComponent extends AbstractListableElementComponent<BrowseEntry> {}
+export class BrowseEntryListElementComponent extends AbstractListableElementComponent<BrowseEntry> {
+
+  /**
+   * Get the query params to access the item page of this browse entry.
+   */
+  public getQueryParams(): {[param: string]: any} {
+    return {
+      value: this.object.value,
+      authority: !!this.object.authority ? this.object.authority : undefined,
+      startsWith: undefined,
+    };
+  }
+}