Merge pull request DSpace#3882 from nibou230/2413-bitstream-access-status

Display the access status (embargo) for the bitstream

Author: tdonohue

config/config.example.yml

@@ -350,6 +350,8 @@ item:
     # Rounded to the nearest size in the list of selectable sizes on the
     # settings menu.  See pageSizeOptions in 'pagination-component-options.model.ts'.
     pageSize: 5
+    # Show the bitstream access status label on the item page
+    showAccessStatuses: false
 
 # Community Page Config
 community:

src/app/admin/admin-search-page/admin-search-results/admin-search-result-grid-element/item-search-result/item-admin-search-result-grid-element.component.spec.ts

@@ -10,7 +10,6 @@ import { TranslateModule } from '@ngx-translate/core';
 import { Observable } from 'rxjs';
 
 import { AuthService } from '../../../../../core/auth/auth.service';
-import { AccessStatusDataService } from '../../../../../core/data/access-status-data.service';
 import { BitstreamDataService } from '../../../../../core/data/bitstream-data.service';
 import { AuthorizationDataService } from '../../../../../core/data/feature-authorization/authorization-data.service';
 import { RemoteData } from '../../../../../core/data/remote-data';
@@ -22,7 +21,6 @@ import { ViewMode } from '../../../../../core/shared/view-mode.model';
 import { mockTruncatableService } from '../../../../../shared/mocks/mock-trucatable.service';
 import { getMockThemeService } from '../../../../../shared/mocks/theme-service.mock';
 import { CollectionElementLinkType } from '../../../../../shared/object-collection/collection-element-link.type';
-import { AccessStatusObject } from '../../../../../shared/object-collection/shared/badges/access-status-badge/access-status.model';
 import { ItemSearchResult } from '../../../../../shared/object-collection/shared/item-search-result.model';
 import { createSuccessfulRemoteDataObject$ } from '../../../../../shared/remote-data.utils';
 import { AuthServiceStub } from '../../../../../shared/testing/auth-service.stub';
@@ -44,12 +42,6 @@ describe('ItemAdminSearchResultGridElementComponent', () => {
     },
   };
 
-  const mockAccessStatusDataService = {
-    findAccessStatusFor(item: Item): Observable<RemoteData<AccessStatusObject>> {
-      return createSuccessfulRemoteDataObject$(new AccessStatusObject());
-    },
-  };
-
   const mockThemeService = getMockThemeService();
 
   function init() {
@@ -74,7 +66,6 @@ describe('ItemAdminSearchResultGridElementComponent', () => {
           { provide: TruncatableService, useValue: mockTruncatableService },
           { provide: BitstreamDataService, useValue: mockBitstreamDataService },
           { provide: ThemeService, useValue: mockThemeService },
-          { provide: AccessStatusDataService, useValue: mockAccessStatusDataService },
           { provide: AuthService, useClass: AuthServiceStub },
           { provide: FileService, useClass: FileServiceStub },
           { provide: AuthorizationDataService, useClass: AuthorizationDataServiceStub },

src/app/core/data/access-status-data.service.spec.ts

@@ -46,11 +46,11 @@ describe('AccessStatusDataService', () => {
       createService();
     });
 
-    describe('when calling findAccessStatusFor', () => {
+    describe('when calling findItemAccessStatusFor', () => {
       let contentSource$;
 
       beforeEach(() => {
-        contentSource$ = service.findAccessStatusFor(mockItem);
+        contentSource$ = service.findItemAccessStatusFor(mockItem);
       });
 
       it('should send a new GetRequest', fakeAsync(() => {

src/app/core/data/access-status-data.service.ts

@@ -29,7 +29,7 @@ export class AccessStatusDataService extends BaseDataService<AccessStatusObject>
    * Returns {@link RemoteData} of {@link AccessStatusObject} that is the access status of the given item
    * @param item Item we want the access status of
    */
-  findAccessStatusFor(item: Item): Observable<RemoteData<AccessStatusObject>> {
+  findItemAccessStatusFor(item: Item): Observable<RemoteData<AccessStatusObject>> {
     return this.findByHref(item._links.accessStatus.href);
   }
 }

src/app/core/provide-core.ts

@@ -176,7 +176,6 @@ export const models =
     ResearcherProfile,
     OrcidQueue,
     OrcidHistory,
-    AccessStatusObject,
     IdentifierData,
     Subscription,
     ItemRequest,

src/app/core/shared/bitstream.model.ts

@@ -4,6 +4,8 @@ import {
   inheritSerialization,
 } from 'cerialize';
 import { Observable } from 'rxjs';
+import { AccessStatusObject } from 'src/app/shared/object-collection/shared/badges/access-status-badge/access-status.model';
+import { ACCESS_STATUS } from 'src/app/shared/object-collection/shared/badges/access-status-badge/access-status.resource-type';
 
 import {
   link,
@@ -52,6 +54,7 @@ export class Bitstream extends DSpaceObject implements ChildHALResource {
     format: HALLink;
     content: HALLink;
     thumbnail: HALLink;
+    accessStatus: HALLink;
   };
 
   /**
@@ -75,6 +78,13 @@ export class Bitstream extends DSpaceObject implements ChildHALResource {
   @link(BUNDLE)
   bundle?: Observable<RemoteData<Bundle>>;
 
+  /**
+   * The access status for this Bitstream
+   * Will be undefined unless the access status {@link HALLink} has been resolved.
+   */
+  @link(ACCESS_STATUS, false, 'accessStatus')
+  accessStatus?: Observable<RemoteData<AccessStatusObject>>;
+
   getParentLinkKey(): keyof this['_links'] {
     return 'format';
   }

src/app/core/shared/item.model.ts

@@ -130,7 +130,7 @@ export class Item extends DSpaceObject implements ChildHALResource, HandleObject
    * The access status for this Item
    * Will be undefined unless the access status {@link HALLink} has been resolved.
    */
-   @link(ACCESS_STATUS)
+   @link(ACCESS_STATUS, false, 'accessStatus')
      accessStatus?: Observable<RemoteData<AccessStatusObject>>;
 
   /**

src/app/item-page/full/field-components/file-section/full-file-section.component.ts

@@ -109,6 +109,7 @@ export class FullFileSectionComponent extends FileSectionComponent implements On
         true,
         followLink('format'),
         followLink('thumbnail'),
+        followLink('accessStatus'),
       )),
       tap((rd: RemoteData<PaginatedList<Bitstream>>) => {
         if (hasValue(rd.errorMessage)) {
@@ -127,6 +128,7 @@ export class FullFileSectionComponent extends FileSectionComponent implements On
         true,
         followLink('format'),
         followLink('thumbnail'),
+        followLink('accessStatus'),
       )),
       tap((rd: RemoteData<PaginatedList<Bitstream>>) => {
         if (hasValue(rd.errorMessage)) {

src/app/item-page/simple/field-components/file-section/file-section.component.ts

@@ -28,6 +28,7 @@ import { ThemedLoadingComponent } from '../../../../shared/loading/themed-loadin
 import { MetadataFieldWrapperComponent } from '../../../../shared/metadata-field-wrapper/metadata-field-wrapper.component';
 import { NotificationsService } from '../../../../shared/notifications/notifications.service';
 import { FileSizePipe } from '../../../../shared/utils/file-size-pipe';
+import { followLink } from '../../../../shared/utils/follow-link-config.model';
 import { VarDirective } from '../../../../shared/utils/var.directive';
 
 /**
@@ -109,7 +110,7 @@ export class FileSectionComponent implements OnInit {
     this.bitstreamDataService.findAllByItemAndBundleName(this.item, 'ORIGINAL', {
       currentPage: this.currentPage,
       elementsPerPage: this.pageSize,
-    }).pipe(
+    }, true, true, followLink('accessStatus')).pipe(
       getFirstCompletedRemoteData(),
     ).subscribe((bitstreamsRD: RemoteData<PaginatedList<Bitstream>>) => {
       if (bitstreamsRD.errorMessage) {

src/app/process-page/detail/process-detail.component.html

@@ -29,7 +29,7 @@ <h1 class="flex-grow-1">
           [title]="'process.detail.output-files'">
           <div class="d-flex flex-column">
             @for (file of files; track file; let last = $last) {
-              <ds-file-download-link [bitstream]="file">
+              <ds-file-download-link [bitstream]="file" [showAccessStatusBadge]="false">
                 <span>{{getFileName(file)}}</span>
                 <span>({{(file?.sizeBytes) | dsFileSize }})</span>
               </ds-file-download-link>