[DSC-1594] Implementing hide field inside edit bitstream view

Author: Simone-Ramundi

src/app/bitstream-page/edit-bitstream-page/edit-bitstream-page.component.spec.ts

@@ -25,6 +25,10 @@ import { Item } from '../../core/shared/item.model';
 import { MetadataValueFilter } from '../../core/shared/metadata.models';
 import { DSONameService } from '../../core/breadcrumbs/dso-name.service';
 import { PrimaryBitstreamService } from '../../core/data/primary-bitstream.service';
+import {VocabularyService} from '../../core/submission/vocabularies/vocabulary.service';
+import {VocabularyEntry} from '../../core/submission/vocabularies/models/vocabulary-entry.model';
+import {buildPaginatedList} from '../../core/data/paginated-list.model';
+import {PageInfo} from '../../core/shared/page-info.model';
 
 const infoNotification: INotification = new Notification('id', NotificationType.Info, 'info');
 const warningNotification: INotification = new Notification('id', NotificationType.Warning, 'warning');
@@ -49,11 +53,22 @@ let fixture: ComponentFixture<EditBitstreamPageComponent>;
 
 describe('EditBitstreamPageComponent', () => {
 
+  const entries = [
+    Object.assign(new VocabularyEntry(), {display: 'true', value: 'true' }),
+    Object.assign(new VocabularyEntry(), {display: 'false', value: 'false' }),
+  ];
+
+  const mockVocabularyService = jasmine.createSpyObj('vocabularyService', {
+    getVocabularyEntries: jasmine.createSpy('getVocabularyEntries'),
+  });
+
   beforeEach(() => {
     bitstreamID = 'current-bitstream-id';
     currentPrimary = bitstreamID;
     differentPrimary = '12345-abcde-54321-edcba';
 
+    mockVocabularyService.getVocabularyEntries.and.returnValue(createSuccessfulRemoteDataObject$(buildPaginatedList(new PageInfo(), entries)));
+
     allFormats = [
       Object.assign({
         id: '1',
@@ -213,6 +228,7 @@ describe('EditBitstreamPageComponent', () => {
           { provide: DSONameService, useValue: dsoNameService },
           { provide: BitstreamFormatDataService, useValue: bitstreamFormatService },
           { provide: PrimaryBitstreamService, useValue: primaryBitstreamService },
+          { provide: VocabularyService, useValue: mockVocabularyService},
           ChangeDetectorRef
         ],
         schemas: [NO_ERRORS_SCHEMA]
@@ -511,6 +527,7 @@ describe('EditBitstreamPageComponent', () => {
           {provide: DSONameService, useValue: dsoNameService},
           {provide: BitstreamFormatDataService, useValue: bitstreamFormatService},
           { provide: PrimaryBitstreamService, useValue: primaryBitstreamService },
+          { provide: VocabularyService, useValue: mockVocabularyService},
           ChangeDetectorRef
         ],
         schemas: [NO_ERRORS_SCHEMA]
@@ -549,7 +566,7 @@ describe('EditBitstreamPageComponent', () => {
     });
   });
 
-    describe('ignore OTHERCONTENT bundle', () => {
+  describe('ignore OTHERCONTENT bundle', () => {
 
       const bundleName = 'OTHERCONTENT';
 
@@ -640,6 +657,7 @@ describe('EditBitstreamPageComponent', () => {
             {provide: DSONameService, useValue: dsoNameService},
             {provide: BitstreamFormatDataService, useValue: bitstreamFormatService},
             { provide: PrimaryBitstreamService, useValue: primaryBitstreamService },
+            { provide: VocabularyService, useValue: mockVocabularyService},
             ChangeDetectorRef
           ],
           schemas: [NO_ERRORS_SCHEMA]

src/app/bitstream-page/edit-bitstream-page/edit-bitstream-page.component.ts

@@ -26,6 +26,10 @@ import { Item } from '../../core/shared/item.model';
 import { DsDynamicInputModel } from '../../shared/form/builder/ds-dynamic-form-ui/models/ds-dynamic-input.model';
 import { DsDynamicTextAreaModel } from '../../shared/form/builder/ds-dynamic-form-ui/models/ds-dynamic-textarea.model';
 import { PrimaryBitstreamService } from '../../core/data/primary-bitstream.service';
+import {VocabularyService} from '../../core/submission/vocabularies/vocabulary.service';
+import {VocabularyOptions} from '../../core/submission/vocabularies/models/vocabulary-options.model';
+import {PageInfo} from '../../core/shared/page-info.model';
+import {VocabularyEntry} from '../../core/submission/vocabularies/models/vocabulary-entry.model';
 
 @Component({
   selector: 'ds-edit-bitstream-page',
@@ -254,6 +258,8 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
     }
   });
 
+  hideModel: DynamicSelectModel<string>;
+
   /**
    * All input models in a simple array for easier iterations
    */
@@ -326,6 +332,11 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
         host: 'col-12 d-inline-block'
       }
     },
+    hide: {
+      grid: {
+        host: 'col-12 d-inline-block'
+      }
+    },
     embargo: {
       grid: {
         host: 'col-12 d-inline-block'
@@ -405,6 +416,7 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
               private notificationsService: NotificationsService,
               private bitstreamFormatService: BitstreamFormatDataService,
               private primaryBitstreamService: PrimaryBitstreamService,
+              private vocabularyService: VocabularyService
               ) {
   }
 
@@ -446,22 +458,32 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
       switchMap((bundle: Bundle) => bundle.item),
       getFirstSucceededRemoteDataPayload(),
     );
+    const vocabularyOptions = new VocabularyOptions(
+      'truefalse',
+      'bitstream.hide',
+    );
+    const pageInfo = new PageInfo();
+    const hide$: Observable<VocabularyEntry[]> = this.vocabularyService.getVocabularyEntries(vocabularyOptions, pageInfo).pipe(
+      getFirstCompletedRemoteData(),
+      map((rq)=> rq.hasSucceeded ? rq.payload.page : []),
+    );
     this.subs.push(
-      observableCombineLatest(
+      observableCombineLatest([
         bitstream$,
         allFormats$,
         bundle$,
         primaryBitstream$,
         item$,
-      ).pipe()
-        .subscribe(([bitstream, allFormats, bundle, primaryBitstream, item]) => {
+        hide$,
+      ]).subscribe(([bitstream, allFormats, bundle, primaryBitstream, item,entries]) => {
           this.bitstream = bitstream as Bitstream;
           this.formats = allFormats.page;
           this.bundle = bundle;
           // hasValue(primaryBitstream) because if there's no primaryBitstream on the bundle it will
           // be a success response, but empty
           this.primaryBitstreamUUID = hasValue(primaryBitstream) ? primaryBitstream.uuid : null;
           this.itemId = item.uuid;
+          this.handleHideBitstream(entries);
           this.setIiifStatus(this.bitstream);
         })
     );
@@ -473,6 +495,26 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
         })
     );
   }
+  handleHideBitstream(entries: VocabularyEntry[]) {
+    if (isEmpty(entries)) {
+      return;
+    }
+    const options = entries.map((entry) => ({label: entry.display, value: entry.value}));
+    let hideModel = new DynamicSelectModel({
+      id: 'hide',
+      name: 'hide',
+      options: options
+    });
+    this.hideModel = hideModel;
+    this.inputModels.push(this.hideModel);
+    const groupModel = new DynamicFormGroupModel({
+      id: 'hideContainer',
+      group: [
+        hideModel
+      ]
+    });
+    this.formModel.push(groupModel);
+  }
 
   /**
    * Initializes the form.
@@ -500,6 +542,9 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
       fileTypeContainer: {
         fileType: bitstream.firstMetadataValue('dc.type')
       },
+      hideContainer: {
+        hide: bitstream.firstMetadataValue('bitstream.hide')
+      },
       formatContainer: {
         newFormat: hasValue(bitstream.firstMetadata('dc.format')) ? bitstream.firstMetadata('dc.format').value : undefined
       }
@@ -711,6 +756,11 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
     } else {
       Metadata.setFirstValue(newMetadata, 'dc.type', rawForm.fileTypeContainer.fileType);
     }
+    if (isEmpty(rawForm.hideContainer.hide)) {
+      delete newMetadata['bitstream.hide'];
+    } else {
+      Metadata.setFirstValue(newMetadata, 'bitstream.hide', rawForm.hideContainer.hide);
+    }
     if (this.isIIIF) {
       // It's helpful to remove these metadata elements entirely when the form value is empty.
       // This avoids potential issues on the REST side and makes it possible to do things like

src/assets/i18n/en.json5

@@ -896,6 +896,10 @@
 
   "bitstream.edit.form.fileType.hint": "Personal picture, logo, main article, etc.",
 
+  "bitstream.edit.form.hide.label": "Hide",
+
+  "bitstream.edit.form.hide.hint": "Hide the bitstream on the item page.",
+
   "bitstream.edit.form.selectedFormat.hint": "If the format is not in the above list, <b>select \"format not in list\" above</b> and describe it under \"Describe new format\".",
 
   "bitstream.edit.form.selectedFormat.label": "Selected Format",