@hmcts/media-viewer 4.2.4-exui-3994-f → 4.2.4-exui-3994-g

package/projects/media-viewer/src/lib/annotations/services/annotation-api/annotation-api.service.spec.ts

@@ -1,242 +0,0 @@
-import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
-import { fakeAsync, inject, TestBed } from '@angular/core/testing';
-import { firstValueFrom, of } from 'rxjs';
-
-import { AnnotationApiService } from './annotation-api.service';
-import { AnnotationSet } from '../../annotation-set/annotation-set.model';
-import { User } from '../../models/user.model';
-import { Annotation } from '../../annotation-set/annotation-view/annotation.model';
-import { Comment } from '../../comment-set/comment/comment.model';
-
-describe('AnnotationApiService', () => {
-  let httpMock: HttpTestingController;
-  let api: AnnotationApiService;
-  const dmDocumentId = 'ad88d12c-8526-49b6-ae5e-3f7ea5d08168';
-  const annotationSetId = 'ae2133a4-8dc5-430b-bb20-5290bd801f94';
-  const annotationId = 'f6225689-29ab-4e0d-9bea-8519a06d16f9';
-  const user: User = {
-    email: 'example@example.org',
-    forename: 'Forename',
-    surname: 'Surname'
-  };
-
-  const comments: Comment[] = [
-    {
-      id: '1',
-      annotationId: annotationId,
-      createdBy: 'example@example.org',
-      createdByDetails: user,
-      createdDate: '2019-06-03T10:00:00Z',
-      lastModifiedBy: 'example@example.org',
-      lastModifiedByDetails: user,
-      lastModifiedDate: '2019-06-03T10:00:00Z',
-      content: 'Test comment 1',
-      page: 1,
-      pageHeight: 1122,
-      selected: false,
-      editable: false,
-      tags: [],
-      pages: []
-    },
-    {
-      id: '2',
-      annotationId: annotationId,
-      createdBy: 'example@example.org',
-      createdByDetails: user,
-      createdDate: '2019-06-03T10:00:00Z',
-      lastModifiedBy: 'example@example.org',
-      lastModifiedByDetails: user,
-      lastModifiedDate: '2019-06-03T10:00:00Z',
-      content: 'Test comment 2',
-      page: 1,
-      pageHeight: 1122,
-      selected: false,
-      editable: false,
-      tags: [],
-      pages: []
-    },
-    {
-      id: '3',
-      annotationId: annotationId,
-      createdBy: 'example@example.org',
-      createdByDetails: user,
-      createdDate: '2019-06-03T10:00:00Z',
-      lastModifiedBy: 'example@example.org',
-      lastModifiedByDetails: user,
-      lastModifiedDate: '2019-06-03T10:00:00Z',
-      content: 'Test comment 3',
-      page: 1,
-      pageHeight: 1122,
-      selected: false,
-      editable: false,
-      tags: [],
-      pages: []
-    },
-  ];
-
-  const annotation1: Annotation = {
-    id: annotationId,
-    annotationSetId: annotationSetId,
-    createdBy: 'example@example.org',
-    createdByDetails: user,
-    createdDate: '2019-06-03T10:00:00Z',
-    lastModifiedBy: 'example@example.org',
-    lastModifiedByDetails: user,
-    lastModifiedDate: '2019-06-03T10:00:00Z',
-    page: 1,
-    color: 'FFFF00',
-    type: 'highlight',
-    comments: comments,
-    rectangles: [{
-      annotationId,
-      x: 100,
-      y: 100,
-      width: 150,
-      height: 50,
-      id: null,
-      createdBy: null,
-      createdDate: null,
-      createdByDetails: null,
-      lastModifiedBy: null,
-      lastModifiedDate: null,
-      lastModifiedByDetails: null
-    }],
-    tags: []
-  };
-
-  const annotation2: Annotation = {
-    id: '2',
-    annotationSetId: annotationSetId,
-    createdBy: 'example@example.org',
-    createdByDetails: user,
-    createdDate: '2019-06-03T10:00:00Z',
-    lastModifiedBy: 'example@example.org',
-    lastModifiedByDetails: user,
-    lastModifiedDate: '2019-06-03T10:00:00Z',
-    page: 1,
-    color: 'FFFF00',
-    type: 'highlight',
-    comments: comments,
-    rectangles: [{
-      annotationId,
-      x: 100,
-      y: 120,
-      width: 150,
-      height: 50,
-      id: null,
-      createdBy: null,
-      createdDate: null,
-      createdByDetails: null,
-      lastModifiedBy: null,
-      lastModifiedDate: null,
-      lastModifiedByDetails: null
-    }],
-    tags: []
-  };
-
-  const annotation3: Annotation = {
-    id: '3',
-    annotationSetId: annotationSetId,
-    createdBy: 'example@example.org',
-    createdByDetails: user,
-    createdDate: '2019-06-03T10:00:00Z',
-    lastModifiedBy: 'example@example.org',
-    lastModifiedByDetails: user,
-    lastModifiedDate: '2019-06-03T10:00:00Z',
-    page: 2,
-    color: 'FFFF00',
-    type: 'highlight',
-    comments: [],
-    rectangles: [],
-    tags: []
-  };
-
-  const annotationSet: AnnotationSet = {
-    id: annotationSetId,
-    createdBy: 'example@example.org',
-    createdByDetails: user,
-    createdDate: '2019-06-03T10:00:00Z',
-    lastModifiedBy: 'example@example.org',
-    lastModifiedByDetails: user,
-    lastModifiedDate: '2019-06-03T10:00:00Z',
-    documentId: dmDocumentId,
-    annotations: [annotation1, annotation2, annotation3]
-  };
-
-  beforeEach(() => {
-    TestBed.configureTestingModule({
-      providers: [
-        AnnotationApiService
-      ],
-      imports: [
-        HttpClientTestingModule
-      ]
-    });
-
-    api = TestBed.inject(AnnotationApiService);
-    api.annotationApiUrl = '/my-context-path';
-    httpMock = TestBed.inject(HttpTestingController);
-  });
-
-  afterEach(() => httpMock.verify());
-
-  it('should createAnnotationSet', fakeAsync(() => {
-    const requestBody = {
-      documentId: dmDocumentId,
-      id: '6d1f5e09-98ad-4891-aecc-936282b06148'
-    };
-
-    api.postAnnotationSet(requestBody).subscribe({
-      next: (response) => {
-        expect(response.documentId).toEqual(dmDocumentId);
-      },
-      error: (err) => fail(err) // no done()
-    });
-
-    const req = httpMock.expectOne('/my-context-path/annotation-sets');
-    expect(req.request.method).toBe('POST');
-    expect(req.request.body.documentId).toBe(dmDocumentId);
-    expect(req.request.body.id).toBeTruthy();
-    req.flush(annotationSet);
-  }));
-
-  it('get annotation set', fakeAsync(() => {
-    api.getAnnotationSet(dmDocumentId).subscribe({
-      next: (response) => expect(response.body.documentId).toBe(dmDocumentId),
-      error: (err) => fail(err)
-    });
-
-    const req = httpMock.expectOne(`/my-context-path/annotation-sets/filter?documentId=${dmDocumentId}`);
-    expect(req.request.method).toBe('GET');
-    req.flush(annotationSet);
-  }));
-
-  it('delete annotation', fakeAsync(() => {
-    api.deleteAnnotation(annotation1.id).subscribe({
-      next: (response) => expect(response).toEqual(null),
-      error: (err) => fail(err)
-    });
-
-    const req = httpMock.expectOne(`/my-context-path/annotations/${annotation1.id}`);
-    expect(req.request.method).toBe('DELETE');
-    req.flush(null);
-  }));
-
-  it('save annotation', fakeAsync((done) => {
-    api.postAnnotation(annotation1).subscribe({
-      next: (response) => expect(response.annotationSetId).toEqual(annotationSet.id),
-      error: (err) => fail(err)
-    });
-
-    const req = httpMock.expectOne('/my-context-path/annotations');
-    expect(req.request.method).toBe('POST');
-    req.flush(annotation1);
-  }));
-
-  it('get comments', async () => {
-    const result = await firstValueFrom(api.getComments(of(annotationSet)));
-    expect(result[0].content).toBe('Test comment 1');
-    expect(result[1].content).toBe('Test comment 2');
-    expect(result[2].content).toBe('Test comment 3');
-  });
-});

package/projects/media-viewer/src/lib/annotations/services/annotation-api/annotation-api.service.ts

@@ -1,77 +0,0 @@
-import { HttpClient } from '@angular/common/http';
-import { Injectable } from '@angular/core';
-import { Observable } from 'rxjs';
-import { catchError, map } from 'rxjs/operators';
-
-import { AnnotationSet } from '../../annotation-set/annotation-set.model';
-import { Annotation } from '../../annotation-set/annotation-view/annotation.model';
-import { Comment } from '../../comment-set/comment/comment.model';
-
-@Injectable()
-export class AnnotationApiService {
-
-  public annotationApiUrl = '/em-anno';
-
-  private annotationSetBaseUrl = '/annotation-sets';
-  private annotationBaseUrl = '/annotations';
-
-  constructor(
-    private readonly httpClient: HttpClient
-  ) { }
-
-  public getAnnotationSet(documentId: string): Observable<any> { // todo add model
-    const fixedUrl = `${this.annotationSetsFullUrl}/filter?documentId=${documentId}`;
-    return this.httpClient
-      .get<AnnotationSet>(fixedUrl, { observe: 'response', withCredentials: true });
-  }
-
-  public postAnnotationSet(body: Partial<AnnotationSet>): Observable<AnnotationSet> {
-    return this.httpClient
-      .post<AnnotationSet>(this.annotationSetsFullUrl, body, { observe: 'response', withCredentials: true })
-      .pipe(
-        map(response => response.body),
-        catchError(() => [])
-      );
-  }
-
-  public getComments(annotationSet: Observable<AnnotationSet>): Observable<Comment[]> {
-    return annotationSet
-      .pipe(
-        map(this.sortAnnotations),
-        map(this.extractComments)
-      );
-  }
-
-  /**
-   * Sort the annotations in the response by page and then y position of their first rectangle
-   */
-  private sortAnnotations(r: AnnotationSet): Annotation[] {
-    return r.annotations.sort((a, b) => a.page !== b.page ? a.page - b.page : a.rectangles[0].y - b.rectangles[0].y);
-  }
-
-  private extractComments(annotations: Annotation[]) {
-    return [].concat(...annotations.map(a => a.comments));
-  }
-
-  public deleteAnnotation(annotationId: string): Observable<null> {
-    const url = `${this.annotationFullsUrl}/${annotationId}`;
-
-    return this.httpClient
-      .delete<null>(url, { observe: 'response', withCredentials: true })
-      .pipe(map(response => response.body));
-  }
-
-  public postAnnotation(annotation: Partial<Annotation>): Observable<Annotation> {
-    return this.httpClient
-      .post<Annotation>(this.annotationFullsUrl, annotation, { observe: 'response', withCredentials: true })
-      .pipe(map(response => response.body));
-  }
-
-  get annotationSetsFullUrl() {
-    return this.annotationApiUrl + this.annotationSetBaseUrl;
-  }
-
-  get annotationFullsUrl() {
-    return this.annotationApiUrl + this.annotationBaseUrl;
-  }
-}

package/projects/media-viewer/src/lib/annotations/services/bookmarks-api/bookmarks-api.service.spec.ts

@@ -1,82 +0,0 @@
-import { BookmarksApiService } from './bookmarks-api.service';
-import { fakeAsync, TestBed } from '@angular/core/testing';
-import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
-
-describe('BookmarksApiService', () => {
-
-  let service: BookmarksApiService;
-  let mockHttpClient: HttpTestingController;
-
-  const bookmark = {
-    name: 'bookmark', xCoordinate: 100, yCoordinate: 50, documentId: 'documentId', id: 'id', pageNumber: 1, zoom: 1
-  } as any;
-
-  beforeEach(() => {
-    TestBed.configureTestingModule({
-      providers: [BookmarksApiService],
-      imports: [HttpClientTestingModule]
-    });
-    service = TestBed.inject(BookmarksApiService);
-    mockHttpClient = TestBed.inject(HttpTestingController);
-  });
-
-  it('should get bookmarks', fakeAsync((done) => {
-    service.getBookmarks('documentId').subscribe((resp) => {
-      expect(resp.body).toEqual([bookmark]);
-    }, error => done(error));
-
-    const request = mockHttpClient.expectOne(req => req.url.endsWith('/documentId/bookmarks'));
-    expect(request.request.method).toBe('GET');
-    request.flush([bookmark]);
-  }));
-
-  it('should create bookmark', fakeAsync((done) => {
-    service.createBookmark(bookmark).subscribe((resp) => {
-      expect(resp).toEqual(bookmark);
-    }, error => done(error));
-
-    const request = mockHttpClient.expectOne(req => req.url.endsWith('/bookmarks'));
-    expect(request.request.method).toBe('POST');
-    request.flush(bookmark);
-  }));
-
-  it('should update bookmark', fakeAsync((done) => {
-    service.updateBookmark(bookmark).subscribe((resp) => {
-      expect(resp).toEqual(bookmark);
-    }, error => done(error));
-
-    const request = mockHttpClient.expectOne(req => req.url.endsWith('/bookmarks'));
-    expect(request.request.method).toBe('PUT');
-    request.flush(bookmark);
-  }));
-
-  it('should delete bookmark', fakeAsync((done) => {
-    service.deleteBookmark('bookmarkId').subscribe((resp) => {
-      expect(resp).toEqual(null);
-    }, error => done(error));
-
-    const request = mockHttpClient.expectOne(req => req.url.endsWith('/bookmarks/bookmarkId'));
-    expect(request.request.method).toBe('DELETE');
-    request.flush(null);
-  }));
-
-  it('should update multiple bookmarks', fakeAsync((done) => {
-    service.updateMultipleBookmarks([bookmark]).subscribe((resp) => {
-      expect(resp).toEqual([bookmark]);
-    }, error => done(error));
-
-    const request = mockHttpClient.expectOne(req => req.url.endsWith('/bookmarks_multiple'));
-    expect(request.request.method).toBe('PUT');
-    request.flush([bookmark]);
-  }));
-
-  it('should delete multiple bookmarks', fakeAsync((done) => {
-    service.deleteMultipleBookmarks({ deleted: ['bookmarkId'], updated: undefined })
-      .subscribe((resp) => expect(resp).toEqual(null),
-          error => done(error));
-
-    const request = mockHttpClient.expectOne(req => req.url.endsWith('/bookmarks_multiple'));
-    expect(request.request.method).toBe('DELETE');
-    request.flush(null);
-  }));
-});

package/projects/media-viewer/src/lib/annotations/services/bookmarks-api/bookmarks-api.service.ts

@@ -1,56 +0,0 @@
-import { Observable } from 'rxjs';
-import { HttpClient } from '@angular/common/http';
-import { Injectable } from '@angular/core';
-import { map } from 'rxjs/operators';
-import { Bookmark } from '../../../viewers/pdf-viewer/side-bar/bookmarks/bookmarks.interfaces';
-
-@Injectable()
-export class BookmarksApiService {
-
-  private readonly ANNOTATIONS_API = '/em-anno';
-
-  constructor(
-    private readonly httpClient: HttpClient
-  ) {}
-
-  public getBookmarks(documentId: string): Observable<any> {
-    return this.httpClient
-      .get(`${this.ANNOTATIONS_API}/${documentId}/bookmarks`,
-        { observe: 'response' , withCredentials: true });
-  }
-
-  public createBookmark(bookmark: Partial<Bookmark>): Observable<Bookmark> {
-    return this.httpClient
-      .post<Bookmark>(`${this.ANNOTATIONS_API}/bookmarks`,
-        bookmark, { observe: 'response' , withCredentials: true })
-      .pipe(map(response => response.body));
-  }
-
-  public updateBookmark(bookmark: Partial<Bookmark>): Observable<Bookmark> {
-    return this.httpClient
-      .put<Bookmark>(`${this.ANNOTATIONS_API}/bookmarks`,
-        bookmark, { observe: 'response' , withCredentials: true })
-      .pipe(map(response => response.body));
-  }
-
-  public updateMultipleBookmarks(bookmarks: Partial<Bookmark[]>): Observable<Bookmark[]> {
-    return this.httpClient
-      .put<Bookmark[]>(`${this.ANNOTATIONS_API}/bookmarks_multiple`,
-        bookmarks, { observe: 'response' , withCredentials: true })
-      .pipe(map(response => response.body));
-  }
-
-  public deleteBookmark(bookmarkId: string): Observable<void> {
-    return this.httpClient
-      .delete<void>(`${this.ANNOTATIONS_API}/bookmarks/${bookmarkId}`,
-        { observe: 'response' , withCredentials: true })
-      .pipe(map(response => response.body));
-  }
-
-  public deleteMultipleBookmarks(payload: { deleted: string[], updated: Bookmark }): Observable<void> {
-    return this.httpClient
-      .request<void>('DELETE', `${this.ANNOTATIONS_API}/bookmarks_multiple`,
-        { body: payload, observe: 'response' , withCredentials: true })
-      .pipe(map(response => response.body));
-  }
-}

package/projects/media-viewer/src/lib/annotations/services/tags/tags.service.spec.ts

@@ -1,61 +0,0 @@
-import { TestBed,  } from '@angular/core/testing';
-import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
-import { TagsServices } from '../../services/tags/tags.services';
-
-const mockTags = [{ name: 'tag1', label: 'Tag 1'}];
-
-describe('TagsService', () => {
-  let httpMock: HttpTestingController;
-  let tagsService: TagsServices;
-
-  beforeEach(() => {
-    TestBed.configureTestingModule({
-      imports: [
-        HttpClientTestingModule,
-      ],
-      providers: [
-        TagsServices
-      ],
-    });
-
-    httpMock = TestBed.inject(HttpTestingController);
-    tagsService = TestBed.inject(TagsServices);
-  });
-
-  afterEach(() => {
-    httpMock.verify();
-  });
-
-  it('should fetch data from the API', () => {
-    const mockUserId = 'user123';
-
-    tagsService.getAllTags(mockUserId).subscribe(data => {
-      expect(data).toEqual(mockTags);
-    });
-
-    const req = httpMock.expectOne(`/em-anno/tags/${mockUserId}`);
-    expect(req.request.method).toBe('GET');
-    req.flush(mockTags);
-  });
-
-  describe('getNewTags', () => {
-    it('should return a tags array', () => {
-      tagsService.tagItems = {
-        123: [...mockTags]
-      };
-
-      expect(tagsService.getNewTags('123')).toEqual(mockTags);
-    });
-
-    it('should return an empty array', () => {
-      expect(tagsService.getNewTags('321')).toEqual([]);
-    });
-  });
-
-  it('should have updateTagItems', () => {
-    const mockItems = [{ name: 'This should be a snake cased', label: 'One' }];
-    tagsService.updateTagItems(mockItems, '111');
-
-    expect(tagsService.tagItems['111']).toEqual([{ name: 'this_should_be_a_snake_cased', label: 'One' }]);
-  });
-});

package/projects/media-viewer/src/lib/annotations/services/tags/tags.services.ts

@@ -1,44 +0,0 @@
-import { Injectable } from '@angular/core';
-import { HttpClient } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { TagsModel } from '../../models/tags.model';
-
-@Injectable()
-export class TagsServices {
-
-  public tagItems: {[id: string]: TagsModel[]};
-
-  constructor(private http: HttpClient) {}
-
-  public getAllTags(createdBy: string): Observable<TagsModel[]> {
-    const url = `/em-anno/tags/${createdBy}`;
-    return this.http.get<TagsModel[]>(url);
-  }
-
-  // @TODO: Move everything below this to NgRx store
-  getNewTags(annoid: string): TagsModel[] {
-    return this.tagItems ? this.tagItems[annoid] : [];
-  }
-
-  updateTagItems(items: Array<TagsModel>, annoId: string) {
-    const snakeCased = items.map(item => {
-      return {
-        ...item,
-        name: this.snakeCase(item.name)
-      };
-    });
-
-    this.tagItems = {
-      ...this.tagItems,
-      [annoId]: snakeCased
-    };
-  }
-
-  private snakeCase = string => {
-    // transform string_to_snake_case
-    return string.replace(/ +/g, ' ')  // find space
-      .split(/ |\B(?=[A-Z])/) // split it into array
-      .map(word => word.toLowerCase()) // transform to lover case
-      .join('_'); // trun array into sting using _
-  }
-}

package/projects/media-viewer/src/lib/annotations/tags/tags.component.html

@@ -1,34 +0,0 @@
-<div class="tags">
-  <tag-input
-    *ngIf="editable" class="tags__edit"
-    [maxItems]="10"
-    [ngModel]="tagItems"
-    (ngModelChange)="tagItems = $event; onUpdateTags($event)"
-    [ngModelOptions]="{standalone:true}"
-    [placeholder]="'Add tag'"
-    [displayBy]="'label'"
-    [identifyBy]="'name'"
-    [onTextChangeDebounce]="250"
-    [secondaryPlaceholder]="'Search or add tags'"
-    [validators]="validators"
-    [errorMessages]="errorMessages"
-    [onlyFromAutocomplete]="false">
-    <tag-input-dropdown
-      [autocompleteObservable]="requestAutocompleteItems"
-      [displayBy]="'label'"
-      [identifyBy]="'name'"
-      [zIndex]="10000"
-      [minimumTextLength]="2">
-      <ng-template let-item="item" let-index="index">
-        {{ item.label }}
-      </ng-template>
-    </tag-input-dropdown>
-  </tag-input>
-
-  <div class="tags__renderer" *ngIf="!editable && (tagItems && tagItems.length)">
-    <span *ngFor="let tag of tagItems" class="tags__item hmcts-badge">
-      {{tag.label}}
-    </span>
-  </div>
-</div>
-

package/projects/media-viewer/src/lib/annotations/tags/tags.component.spec.ts

@@ -1,47 +0,0 @@
-import { ComponentFixture, TestBed } from '@angular/core/testing';
-import {TagsComponent} from './tags.component';
-import {TagInputModule} from 'ngx-chips';
-import {TagsServices} from '../services/tags/tags.services';
-import {NO_ERRORS_SCHEMA} from '@angular/core';
-import {HttpClientTestingModule} from '@angular/common/http/testing';
-import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
-
-describe('Tags Component', () => {
-  let component: TagsComponent;
-  let fixture: ComponentFixture<TagsComponent>;
-
-  beforeEach(() => {
-    return TestBed.configureTestingModule({
-      declarations: [
-        TagsComponent,
-      ],
-      imports: [TagInputModule, HttpClientTestingModule, BrowserAnimationsModule],
-      providers: [TagsServices],
-      schemas: [NO_ERRORS_SCHEMA]
-    }).compileComponents();
-  });
-
-  beforeEach(() => {
-    fixture = TestBed.createComponent(TagsComponent);
-    component = fixture.componentInstance;
-    component.userId = '1234';
-    component.tagItems = [];
-    component.annoId = '123';
-    component.editable = true;
-
-    fixture.detectChanges();
-  });
-
-  it('should create', () => {
-    expect(component).toBeTruthy();
-  });
-
-  it('should display have tagItems, autocompleteItems', () => {
-    fixture.detectChanges();
-    expect(component.tagItems).toBeDefined();
-    expect(component.userId).toBeDefined();
-    expect(component.editable).toBeDefined();
-    expect(component.annoId).toBeDefined();
-  });
-
-});