Adiciona endpoint de bibliografia baseado em CSL para itens

PR do DSpace: DSpace/dspace-angular#4779

Author: ciscocarvalho

src/app/core/data-services-map.ts

@@ -38,6 +38,7 @@ import { ORCID_QUEUE } from './orcid/model/orcid-queue.resource-type';
 import { RESEARCHER_PROFILE } from './profile/model/researcher-profile.resource-type';
 import { RESOURCE_POLICY } from './resource-policy/models/resource-policy.resource-type';
 import { AUTHORIZATION } from './shared/authorization.resource-type';
+import { BIBLIOGRAPHY } from './shared/bibliography/bibliography.resource-type';
 import { BITSTREAM } from './shared/bitstream.resource-type';
 import { BITSTREAM_FORMAT } from './shared/bitstream-format.resource-type';
 import { BROWSE_DEFINITION } from './shared/browse-definition.resource-type';
@@ -88,6 +89,7 @@ export const LAZY_DATA_SERVICES: LazyDataServicesMap = new Map([
   [SUBSCRIPTION.value, () => import('../shared/subscriptions/subscriptions-data.service').then(m => m.SubscriptionsDataService)],
   [COMMUNITY.value, () => import('./data/community-data.service').then(m => m.CommunityDataService)],
   [VOCABULARY.value, () => import('./submission/vocabularies/vocabulary.data.service').then(m => m.VocabularyDataService)],
+  [BIBLIOGRAPHY.value, () => import('./data/bibliography-data.service').then(m => m.ItemBibliographyService)],
   [BUNDLE.value, () => import('./data/bundle-data.service').then(m => m.BundleDataService)],
   [CONFIG_PROPERTY.value, () => import('./data/configuration-data.service').then(m => m.ConfigurationDataService)],
   [POOL_TASK.value, () => import('./tasks/pool-task-data.service').then(m => m.PoolTaskDataService)],

src/app/core/data/bibliography-data.service.ts

@@ -0,0 +1,37 @@
+import { Injectable } from '@angular/core';
+import {
+  map,
+  Observable,
+} from 'rxjs';
+
+import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
+import { ObjectCacheService } from '../cache/object-cache.service';
+import { BibliographyData } from '../shared/bibliography/bibliography-data.model';
+import { HALEndpointService } from '../shared/hal-endpoint.service';
+import { Item } from '../shared/item.model';
+import { getFirstCompletedRemoteData } from '../shared/operators';
+import { BaseDataService } from './base/base-data.service';
+import { RequestService } from './request.service';
+
+
+
+
+@Injectable({ providedIn: 'root' })
+export class ItemBibliographyService extends BaseDataService<BibliographyData> {
+
+  constructor(
+    protected requestService: RequestService,
+    protected rdbService: RemoteDataBuildService,
+    protected objectCache: ObjectCacheService,
+    protected halService: HALEndpointService,
+  ) {
+    super('bibliographies', requestService, rdbService, objectCache, halService);
+  }
+
+  getBibliographies(item: Item): Observable<BibliographyData> {
+    return this.findByHref(item._links.bibliography.href).pipe(
+      getFirstCompletedRemoteData(),
+      map(res => res.payload),
+    );
+  }
+}

src/app/core/provide-core.ts

@@ -41,6 +41,7 @@ import { OrcidQueue } from './orcid/model/orcid-queue.model';
 import { ResearcherProfile } from './profile/model/researcher-profile.model';
 import { ResourcePolicy } from './resource-policy/models/resource-policy.model';
 import { Authorization } from './shared/authorization.model';
+import { BibliographyData } from './shared/bibliography/bibliography-data.model';
 import { Bitstream } from './shared/bitstream.model';
 import { BitstreamFormat } from './shared/bitstream-format.model';
 import { BrowseDefinition } from './shared/browse-definition.model';
@@ -111,6 +112,7 @@ export const models =
   [
     Root,
     DSpaceObject,
+    BibliographyData,
     Bundle,
     Bitstream,
     BitstreamFormat,

src/app/core/shared/bibliography/bibliography-data.model.ts

@@ -0,0 +1,42 @@
+import {
+  autoserialize,
+  deserialize,
+} from 'cerialize';
+import { typedObject } from 'src/app/core/cache/builders/build-decorators';
+import { DSpaceObject } from 'src/app/core/shared/dspace-object.model';
+import { HALLink } from 'src/app/core/shared/hal-link.model';
+import { ResourceType } from 'src/app/core/shared/resource-type';
+import { excludeFromEquals } from 'src/app/core/utilities/equals.decorators';
+
+import { Bibliography } from './bibliography.model';
+import { BIBLIOGRAPHY } from './bibliography.resource-type';
+
+/**
+ * Class representing a DSpace Version
+ */
+@typedObject
+export class BibliographyData extends DSpaceObject {
+  static type = BIBLIOGRAPHY;
+
+  /**
+   * The type for this IdentifierData
+   */
+  @excludeFromEquals
+  @autoserialize
+  type: ResourceType;
+
+  /**
+   * The
+   */
+  @autoserialize
+  bibliographies: Bibliography[];
+
+  /**
+   * The {@link HALLink}s for this IdentifierData
+   */
+  @deserialize
+  _links: {
+    self: HALLink;
+  };
+
+}

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

@@ -0,0 +1,9 @@
+import { autoserialize } from 'cerialize';
+
+export class Bibliography {
+  @autoserialize
+  style: string;
+
+  @autoserialize
+  value: string;
+}

src/app/core/shared/bibliography/bibliography.resource-type.ts

@@ -0,0 +1,9 @@
+import { ResourceType } from 'src/app/core/shared/resource-type';
+
+/**
+ * The resource type for Bibliography
+ *
+ * Needs to be in a separate file to prevent circular
+ * dependencies in webpack.
+ */
+export const BIBLIOGRAPHY = new ResourceType('bibliography');

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

@@ -82,6 +82,7 @@ export class Item extends DSpaceObject implements ChildHALResource, HandleObject
     mappedCollections: HALLink;
     relationships: HALLink;
     bundles: HALLink;
+    bibliography: HALLink;
     owningCollection: HALLink;
     templateItemOf: HALLink;
     version: HALLink;
@@ -130,8 +131,8 @@ 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, false, 'accessStatus')
-     accessStatus?: Observable<RemoteData<AccessStatusObject>>;
+  @link(ACCESS_STATUS, false, 'accessStatus')
+  accessStatus?: Observable<RemoteData<AccessStatusObject>>;
 
   /**
    * The identifier data for this Item

src/app/core/shared/listable.module.ts

@@ -3,6 +3,7 @@ import { NgModule } from '@angular/core';
 import { FormsModule } from '@angular/forms';
 import { RouterModule } from '@angular/router';
 import { TranslateModule } from '@ngx-translate/core';
+import { ItemPageBibliographyComponent } from 'src/app/item-page/simple/field-components/specific-field/bibliography/item-page-bibliography.component';
 
 import { CollectionAdminSearchResultGridElementComponent } from '../../admin/admin-search-page/admin-search-results/admin-search-result-grid-element/collection-search-result/collection-admin-search-result-grid-element.component';
 import { CommunityAdminSearchResultGridElementComponent } from '../../admin/admin-search-page/admin-search-results/admin-search-result-grid-element/community-search-result/community-admin-search-result-grid-element.component';
@@ -219,6 +220,7 @@ const ENTRY_COMPONENTS = [
     TruncatableComponent,
     TruncatablePartComponent,
     ThumbnailComponent,
+    ItemPageBibliographyComponent,
     BadgesComponent,
     ThemedBadgesComponent,
     ItemDetailPreviewComponent,

src/app/item-page/simple/field-components/specific-field/bibliography/item-page-bibliography.component.html

@@ -0,0 +1,53 @@
+<a href="javascript:void(0)" (click)="openModal(citationModal)">
+  <i class="fas fa-quote-right"></i>
+  {{ "item.cite.open-modal" | translate }}
+</a>
+
+<ng-template #citationModal let-modal>
+  <div class="modal-header">
+    <h4 class="modal-title">{{ "item.cite.modal.title" | translate }}</h4>
+    <button
+      type="button"
+      class="btn-close"
+      aria-label="Close"
+      (click)="modal.dismiss()"
+    ></button>
+  </div>
+
+  <div class="modal-body">
+    @if (loading) {
+    <div class="text-center">
+      <i class="fas fa-spinner fa-spin"></i> {{ "loading" | translate }}
+    </div>
+    } @if (error) {
+    <div class="alert alert-danger">
+      {{ "item.cite.modal.error" | translate }}
+    </div>
+    } @if (bibliographies?.length) { @for (c of bibliographies; track c.style) {
+    <div class="mb-3">
+      <strong>{{ c.style | translate }}</strong>
+      <div>
+       @if (c.style === 'bibtex') {
+        <code>{{ c.value }}</code>
+       } @else {
+         <span>{{ c.value }}</span>
+       }
+        <button
+          title="{{ 'item.cite.modal.copy' | translate }}"
+          type="button"
+          class="btn btn-sm btn-outline-primary mt-1"
+          (click)="copyToClipboard(c.value)"
+        >
+          <i class="fas fa-copy"></i>
+        </button>
+      </div>
+    </div>
+    } }
+  </div>
+
+  <div class="modal-footer">
+    <button type="button" class="btn btn-secondary" (click)="modal.close()">
+      {{ "item.cite.modal.close" | translate }}
+    </button>
+  </div>
+</ng-template>

src/app/item-page/simple/field-components/specific-field/bibliography/item-page-bibliography.component.spec.ts

@@ -0,0 +1,116 @@
+import { NO_ERRORS_SCHEMA } from '@angular/core';
+import {
+  ComponentFixture,
+  fakeAsync,
+  TestBed,
+  tick,
+  waitForAsync,
+} from '@angular/core/testing';
+import { NgbModal } from '@ng-bootstrap/ng-bootstrap';
+import {
+  TranslateLoader,
+  TranslateModule,
+} from '@ngx-translate/core';
+import {
+  delay,
+  of,
+  throwError,
+} from 'rxjs';
+
+import { ItemBibliographyService } from '../../../../../core/data/bibliography-data.service';
+import { Bibliography } from '../../../../../core/shared/bibliography/bibliography.model';
+import { BibliographyData } from '../../../../../core/shared/bibliography/bibliography-data.model';
+import { Item } from '../../../../../core/shared/item.model';
+import { TranslateLoaderMock } from '../../../../../shared/testing/translate-loader.mock';
+import { ItemPageBibliographyComponent } from './item-page-bibliography.component';
+
+describe('ItemPageBibliographyComponent', () => {
+  let component: ItemPageBibliographyComponent;
+  let fixture: ComponentFixture<ItemPageBibliographyComponent>;
+  let mockService: jasmine.SpyObj<ItemBibliographyService>;
+  let mockModalService: jasmine.SpyObj<NgbModal>;
+  let testItem: Item;
+
+  beforeEach(waitForAsync(() => {
+    mockService = jasmine.createSpyObj('ItemBibliographyService', ['getBibliographies']);
+    mockModalService = jasmine.createSpyObj('NgbModal', ['open']);
+
+    void TestBed.configureTestingModule({
+      imports: [
+        ItemPageBibliographyComponent,
+        TranslateModule.forRoot({
+          loader: { provide: TranslateLoader, useClass: TranslateLoaderMock },
+        }),
+      ],
+      providers: [
+        { provide: ItemBibliographyService, useValue: mockService },
+        { provide: NgbModal, useValue: mockModalService },
+      ],
+      schemas: [NO_ERRORS_SCHEMA],
+    })
+      .overrideComponent(ItemPageBibliographyComponent, {
+        set: { providers: [{ provide: NgbModal, useValue: mockModalService }] },
+      })
+      .compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(ItemPageBibliographyComponent);
+    component = fixture.componentInstance;
+    testItem = new Item();
+    component.item = testItem;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+
+  it('should load bibliographies and open modal', fakeAsync(() => {
+    const mockBibliographies: Bibliography[] = [
+      { style: 'bibtex', value: '@article{test}' },
+      { style: 'apa', value: 'Author, 2025' },
+    ];
+    const mockData = { bibliographies: mockBibliographies };
+    mockService.getBibliographies.and.returnValue(of(mockData as BibliographyData).pipe(delay(0)));
+    const modalContent = {};
+
+    component.openModal(modalContent);
+    expect(component.loading).toBeTrue();
+    expect(component.error).toBeFalse();
+
+    tick();
+    expect(component.bibliographies).toEqual(mockBibliographies);
+    expect(component.loading).toBeFalse();
+    expect(mockModalService.open).toHaveBeenCalledWith(modalContent, { size: 'lg' });
+  }));
+
+  it('should handle error when loading bibliographies', fakeAsync(() => {
+    const mockError = new Error('Failed');
+    mockService.getBibliographies.and.returnValue(throwError(() => mockError));
+    const modalContent = {};
+
+    component.openModal(modalContent);
+    tick();
+
+    expect(component.loading).toBeFalse();
+    expect(component.error).toBeTrue();
+    expect(mockModalService.open).not.toHaveBeenCalled();
+  }));
+
+  it('should copy text to clipboard', () => {
+    const text = 'Some text to copy';
+    spyOn(navigator.clipboard, 'writeText').and.returnValue(Promise.resolve());
+
+    component.copyToClipboard(text);
+    expect(navigator.clipboard.writeText).toHaveBeenCalledWith(text);
+  });
+
+  it('should copy HTML text to clipboard as plain text', () => {
+    const htmlText = '<p>HTML text</p>';
+    spyOn(navigator.clipboard, 'writeText').and.returnValue(Promise.resolve());
+
+    component.copyToClipboard(htmlText);
+    expect(navigator.clipboard.writeText).toHaveBeenCalledWith('HTML text');
+  });
+});