[AAE-11496] Make aca-shared buildable (#2916)

projects/aca-shared/ng-package.json

@@ -1,5 +1,5 @@
 {
-  "dest": "../../dist/aca-shared",
+  "dest": "../../dist/@alfresco/aca-shared",
   "lib": {
     "entryFile": "src/public-api.ts"
   }

projects/aca-shared/src/lib/components/document-base-page/document-base-page.component.ts

@@ -0,0 +1,194 @@
+/*!
+ * @license
+ * Alfresco Example Content Application
+ *
+ * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { DocumentListComponent, ShareDataRow } from '@alfresco/adf-content-services';
+import { ShowHeaderMode } from '@alfresco/adf-core';
+import { ContentActionRef, DocumentListPresetRef, SelectionState } from '@alfresco/adf-extensions';
+import { OnDestroy, OnInit, OnChanges, ViewChild, SimpleChanges, Directive } from '@angular/core';
+import { Store } from '@ngrx/store';
+import { MinimalNodeEntity, MinimalNodeEntryEntity, NodePaging } from '@alfresco/js-api';
+import { Observable, Subject, Subscription } from 'rxjs';
+import { takeUntil, map } from 'rxjs/operators';
+import { DocumentBasePageService } from './document-base-page.service';
+import {
+  AppStore,
+  ReloadDocumentListAction,
+  getCurrentFolder,
+  getAppSelection,
+  getDocumentDisplayMode,
+  isInfoDrawerOpened,
+  getSharedUrl,
+  ViewNodeAction,
+  ViewNodeExtras,
+  SetSelectedNodesAction
+} from '@alfresco/aca-shared/store';
+import { AppExtensionService } from '../../services/app.extension.service';
+import { isLibrary, isLocked } from '../../utils/node.utils';
+
+/* eslint-disable @angular-eslint/directive-class-suffix */
+@Directive()
+export abstract class PageComponent implements OnInit, OnDestroy, OnChanges {
+  onDestroy$: Subject<boolean> = new Subject<boolean>();
+
+  @ViewChild(DocumentListComponent)
+  documentList: DocumentListComponent;
+
+  title = 'Page';
+  infoDrawerOpened$: Observable<boolean>;
+  node: MinimalNodeEntryEntity;
+  selection: SelectionState;
+  documentDisplayMode$: Observable<string>;
+  sharedPreviewUrl$: Observable<string>;
+  actions: Array<ContentActionRef> = [];
+  viewerToolbarActions: Array<ContentActionRef> = [];
+  canUpdateNode = false;
+  canUpload = false;
+  nodeResult: NodePaging;
+  showHeader = ShowHeaderMode.Data;
+  filterSorting = 'name-asc';
+
+  protected subscriptions: Subscription[] = [];
+
+  protected constructor(protected store: Store<AppStore>, protected extensions: AppExtensionService, protected content: DocumentBasePageService) {}
+
+  ngOnInit() {
+    this.sharedPreviewUrl$ = this.store.select(getSharedUrl);
+    this.infoDrawerOpened$ = this.store.select(isInfoDrawerOpened).pipe(map((infoDrawerState) => !this.isOutletPreviewUrl() && infoDrawerState));
+
+    this.documentDisplayMode$ = this.store.select(getDocumentDisplayMode);
+
+    this.store
+      .select(getAppSelection)
+      .pipe(takeUntil(this.onDestroy$))
+      .subscribe((selection) => {
+        this.selection = selection;
+        this.canUpdateNode = this.selection.count === 1 && this.content.canUpdateNode(selection.first);
+      });
+
+    this.extensions
+      .getAllowedToolbarActions()
+      .pipe(takeUntil(this.onDestroy$))
+      .subscribe((actions) => {
+        this.actions = actions;
+      });
+
+    this.extensions
+      .getViewerToolbarActions()
+      .pipe(takeUntil(this.onDestroy$))
+      .subscribe((actions) => {
+        this.viewerToolbarActions = actions;
+      });
+
+    this.store
+      .select(getCurrentFolder)
+      .pipe(takeUntil(this.onDestroy$))
+      .subscribe((node) => {
+        this.canUpload = node && this.content.canUploadContent(node);
+      });
+  }
+
+  ngOnChanges(changes: SimpleChanges) {
+    if (changes.nodeResult && changes.nodeResult.currentValue) {
+      this.nodeResult = changes.nodeResult.currentValue;
+    }
+  }
+
+  ngOnDestroy() {
+    this.subscriptions.forEach((subscription) => subscription.unsubscribe());
+    this.subscriptions = [];
+
+    this.onDestroy$.next(true);
+    this.onDestroy$.complete();
+    this.store.dispatch(new SetSelectedNodesAction([]));
+  }
+
+  showPreview(node: MinimalNodeEntity, extras?: ViewNodeExtras) {
+    if (node && node.entry) {
+      let id: string;
+
+      if (node.entry.nodeType === 'app:filelink') {
+        id = node.entry.properties['cm:destination'];
+      } else {
+        id = (node as any).entry.nodeId || (node as any).entry.guid || node.entry.id;
+      }
+
+      this.store.dispatch(new ViewNodeAction(id, extras));
+    }
+  }
+
+  getParentNodeId(): string {
+    return this.node ? this.node.id : null;
+  }
+
+  imageResolver(row: ShareDataRow): string | null {
+    if (isLocked(row.node)) {
+      return 'assets/images/baseline-lock-24px.svg';
+    }
+
+    if (isLibrary(row.node)) {
+      return 'assets/images/baseline-library_books-24px.svg';
+    }
+
+    return null;
+  }
+
+  reload(selectedNode?: MinimalNodeEntity): void {
+    if (this.isOutletPreviewUrl()) {
+      return;
+    }
+
+    this.store.dispatch(new ReloadDocumentListAction());
+    if (selectedNode) {
+      this.store.dispatch(new SetSelectedNodesAction([selectedNode]));
+    }
+  }
+
+  trackByActionId(_: number, action: ContentActionRef) {
+    return action.id;
+  }
+
+  trackById(_: number, obj: { id: string }) {
+    return obj.id;
+  }
+
+  trackByColumnId(_: number, obj: DocumentListPresetRef): string {
+    return obj.id;
+  }
+
+  private isOutletPreviewUrl(): boolean {
+    return location.href.includes('viewer:view');
+  }
+
+  onSortingChanged(event) {
+    this.filterSorting = event.detail.key + '-' + event.detail.direction;
+  }
+
+  onAllFilterCleared() {
+    if (!this.isOutletPreviewUrl()) {
+      this.documentList.node = null;
+      this.store.dispatch(new ReloadDocumentListAction());
+    }
+  }
+}

projects/aca-shared/src/lib/components/document-base-page/document-base-page.service.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright © 2005 - 2021 Alfresco Software, Ltd. All rights reserved.
+ *
+ * License rights for this program may be obtained from Alfresco Software, Ltd.
+ * pursuant to a written agreement and any use of this program without such an
+ * agreement is prohibited.
+ */
+
+import { MinimalNodeEntity, MinimalNodeEntryEntity } from '@alfresco/js-api';
+
+export abstract class DocumentBasePageService {
+  abstract canUpdateNode(node: MinimalNodeEntity): boolean;
+  abstract canUploadContent(node: MinimalNodeEntryEntity): boolean;
+}

projects/aca-shared/src/lib/components/document-base-page/document-base-page.spec.ts

@@ -0,0 +1,344 @@
+/*!
+ * @license
+ * Alfresco Example Content Application
+ *
+ * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { TestBed, ComponentFixture } from '@angular/core/testing';
+import { PageComponent } from './document-base-page.component';
+import { ReloadDocumentListAction, SetSelectedNodesAction, AppState, AppStore, ViewNodeAction } from '@alfresco/aca-shared/store';
+import { AppExtensionService } from '@alfresco/aca-shared';
+import { MinimalNodeEntity, Node, NodePaging } from '@alfresco/js-api';
+import { DocumentBasePageService } from './document-base-page.service';
+import { Store, StoreModule } from '@ngrx/store';
+import { Component, Injectable } from '@angular/core';
+import { DocumentListComponent } from '@alfresco/adf-content-services';
+import { MockStore, provideMockStore } from '@ngrx/store/testing';
+import { MaterialModule, PipeModule } from '@alfresco/adf-core';
+import { HttpClientModule } from '@angular/common/http';
+import { NoopAnimationsModule } from '@angular/platform-browser/animations';
+import { RouterTestingModule } from '@angular/router/testing';
+import { EffectsModule } from '@ngrx/effects';
+
+export const INITIAL_APP_STATE: AppState = {
+  appName: 'Alfresco Content Application',
+  headerColor: '#ffffff',
+  headerTextColor: '#000000',
+  logoPath: 'assets/images/alfresco-logo-white.svg',
+  headerImagePath: 'assets/images/mastHead-bg-shapesPattern.svg',
+  customCssPath: '',
+  webFontPath: '',
+  sharedUrl: '',
+  user: {
+    isAdmin: null,
+    id: null,
+    firstName: '',
+    lastName: ''
+  },
+  selection: {
+    nodes: [],
+    libraries: [],
+    isEmpty: true,
+    count: 0
+  },
+  navigation: {
+    currentFolder: null
+  },
+  currentNodeVersion: null,
+  infoDrawerOpened: false,
+  infoDrawerPreview: false,
+  infoDrawerMetadataAspect: '',
+  showFacetFilter: true,
+  fileUploadingDialog: true,
+  documentDisplayMode: 'list',
+  showLoader: false,
+  repository: {
+    status: {
+      isQuickShareEnabled: true
+    }
+  } as any
+};
+
+@Injectable()
+class DocumentBasePageServiceMock extends DocumentBasePageService {
+  canUpdateNode(_node: MinimalNodeEntity): boolean {
+    return true;
+  }
+  canUploadContent(_node: Node): boolean {
+    return true;
+  }
+}
+
+@Component({
+  selector: 'aca-test',
+  template: ''
+})
+class TestComponent extends PageComponent {
+  node: any;
+
+  constructor(store: Store<AppStore>, extensions: AppExtensionService, content: DocumentBasePageService) {
+    super(store, extensions, content);
+  }
+}
+
+describe('PageComponent', () => {
+  let component: TestComponent;
+  let store: Store<AppState>;
+  let fixture: ComponentFixture<TestComponent>;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [
+        NoopAnimationsModule,
+        HttpClientModule,
+        RouterTestingModule,
+        MaterialModule,
+        StoreModule.forRoot(
+          { app: (state) => state },
+          {
+            initialState: {
+              app: INITIAL_APP_STATE
+            },
+            runtimeChecks: {
+              strictStateImmutability: false,
+              strictActionImmutability: false
+            }
+          }
+        ),
+        EffectsModule.forRoot([]),
+        PipeModule
+      ],
+      declarations: [TestComponent],
+      providers: [
+        {
+          provide: DocumentBasePageService,
+          useClass: DocumentBasePageServiceMock
+        },
+        AppExtensionService
+      ]
+    });
+
+    store = TestBed.inject(Store);
+    fixture = TestBed.createComponent(TestComponent);
+    component = fixture.componentInstance;
+  });
+
+  afterEach(() => {
+    fixture.destroy();
+  });
+
+  describe('getParentNodeId()', () => {
+    it('returns parent node id when node is set', () => {
+      component.node = { id: 'node-id' };
+
+      expect(component.getParentNodeId()).toBe('node-id');
+    });
+
+    it('returns null when node is not set', () => {
+      component.node = null;
+
+      expect(component.getParentNodeId()).toBe(null);
+    });
+  });
+
+  describe('Reload', () => {
+    const locationHref = location.href;
+
+    afterEach(() => {
+      window.history.pushState({}, null, locationHref);
+    });
+
+    it('should not reload if url contains viewer outlet', () => {
+      window.history.pushState({}, null, `${locationHref}#test(viewer:view)`);
+      spyOn(store, 'dispatch');
+
+      component.reload();
+      expect(store.dispatch).not.toHaveBeenCalled();
+    });
+
+    it('should reload if url does not contain viewer outlet', () => {
+      spyOn(store, 'dispatch');
+
+      component.reload();
+      expect(store.dispatch).toHaveBeenCalledWith(new ReloadDocumentListAction());
+    });
+
+    it('should set selection after reload if node is passed', () => {
+      const node = {
+        entry: {
+          id: 'node-id'
+        }
+      } as MinimalNodeEntity;
+      spyOn(store, 'dispatch');
+
+      component.reload(node);
+      expect(store.dispatch['calls'].mostRecent().args[0]).toEqual(new SetSelectedNodesAction([node]));
+    });
+
+    it('should clear results onAllFilterCleared event', () => {
+      component.documentList = {
+        node: {
+          list: {
+            pagination: {},
+            entries: [{ entry: { id: 'new-node-id' } }]
+          }
+        } as NodePaging
+      } as DocumentListComponent;
+      spyOn(store, 'dispatch');
+
+      component.onAllFilterCleared();
+      expect(component.documentList.node).toBe(null);
+      expect(store.dispatch['calls'].mostRecent().args[0]).toEqual(new ReloadDocumentListAction());
+    });
+
+    it('should call onAllFilterCleared event if page is viewer outlet', () => {
+      window.history.pushState({}, null, `${locationHref}#test(viewer:view)`);
+      const nodePaging = {
+        list: {
+          pagination: {},
+          entries: [{ entry: { id: 'new-node-id' } }]
+        }
+      } as NodePaging;
+
+      component.documentList = { node: nodePaging } as DocumentListComponent;
+      spyOn(store, 'dispatch');
+
+      component.onAllFilterCleared();
+      expect(component.documentList.node).toEqual(nodePaging);
+      expect(store.dispatch).not.toHaveBeenCalled();
+    });
+
+    it('should call ViewNodeAction on showPreview for selected node', () => {
+      spyOn(store, 'dispatch');
+      const node = {
+        entry: {
+          id: 'node-id'
+        }
+      } as MinimalNodeEntity;
+
+      component.showPreview(node);
+      expect(store.dispatch).toHaveBeenCalledWith(new ViewNodeAction(node.entry.id));
+    });
+
+    it('should call ViewNodeAction on showPreview for `app:filelink` node type', () => {
+      spyOn(store, 'dispatch');
+      const linkNode = {
+        entry: {
+          id: 'node-id',
+          nodeType: 'app:filelink',
+          properties: {
+            'cm:destination': 'original-node-id'
+          }
+        }
+      } as MinimalNodeEntity;
+
+      component.showPreview(linkNode);
+      const id = linkNode.entry.properties['cm:destination'];
+      expect(store.dispatch).toHaveBeenCalledWith(new ViewNodeAction(id));
+    });
+  });
+});
+
+describe('Info Drawer state', () => {
+  let component: TestComponent;
+  let fixture: ComponentFixture<TestComponent>;
+
+  let store: MockStore<{ app: Partial<AppState> }>;
+  let appState: Partial<AppState> = {};
+
+  beforeEach(() => {
+    appState = {
+      selection: {
+        count: 2,
+        isEmpty: false,
+        libraries: [],
+        nodes: []
+      },
+      navigation: {},
+      infoDrawerOpened: false
+    };
+
+    TestBed.configureTestingModule({
+      imports: [NoopAnimationsModule, HttpClientModule, RouterTestingModule],
+      declarations: [TestComponent],
+      providers: [
+        { provide: DocumentBasePageService, useClass: DocumentBasePageServiceMock },
+        AppExtensionService,
+        provideMockStore({
+          initialState: { app: appState }
+        })
+      ]
+    });
+
+    store = TestBed.inject(MockStore);
+    fixture = TestBed.createComponent(TestComponent);
+    component = fixture.componentInstance;
+  });
+
+  afterEach(() => {
+    fixture.destroy();
+  });
+
+  const locationHref = location.href;
+
+  afterEach(() => {
+    window.history.pushState({}, null, locationHref);
+  });
+
+  it('should open info drawer on action event', (done) => {
+    window.history.pushState({}, null, `${locationHref}#test`);
+    fixture.detectChanges();
+
+    fixture.whenStable().then(() => {
+      component.infoDrawerOpened$.subscribe((state) => {
+        expect(state).toBe(true);
+        done();
+      });
+    });
+
+    store.setState({
+      app: {
+        ...appState,
+        infoDrawerOpened: true
+      }
+    });
+  });
+
+  it('should not open info drawer if viewer outlet is active', (done) => {
+    window.history.pushState({}, null, `${locationHref}#test(viewer:view)`);
+    fixture.detectChanges();
+
+    fixture.whenStable().then(() => {
+      component.infoDrawerOpened$.subscribe((state) => {
+        expect(state).toBe(false);
+        done();
+      });
+    });
+
+    store.setState({
+      app: {
+        ...appState,
+        infoDrawerOpened: true
+      }
+    });
+  });
+});

projects/aca-shared/src/lib/services/app.extension.service.ts

@@ -57,7 +57,7 @@ import { ViewerRules } from '../models/viewer.rules';
 import { SettingsGroupRef } from '../models/types';
 import { NodePermissionService } from '../services/node-permission.service';
 import { filter, map } from 'rxjs/operators';
-import { ModalConfiguration } from '@alfresco/aca-shared';
+import { ModalConfiguration } from '../models/modal-configuration';
 
 @Injectable({
   providedIn: 'root'

projects/aca-shared/src/public-api.ts

@@ -40,6 +40,8 @@ export * from './lib/components/tool-bar/toolbar-menu/toolbar-menu.component';
 export * from './lib/components/tool-bar/toolbar-menu-item/toolbar-menu-item.component';
 export * from './lib/components/info-drawer/info-drawer.component';
 export * from './lib/components/info-drawer/shared-info-drawer.module';
+export * from './lib/components/document-base-page/document-base-page.component';
+export * from './lib/components/document-base-page/document-base-page.service';
 
 export * from './lib/directives/contextmenu/contextmenu.directive';
 export * from './lib/directives/contextmenu/contextmenu.module';