[ADF-3869] extensibility related components (#4107)

* extensions: dynamic column

* content: trashcan name column

* content: library status column

* content: library role column

* content: library name column

* style fixes

* content: name column

* demo: use name column in DL example

* fix tests

* lint fixes

* code fixes

* update docs

* add toggle to demo shell

lib/content-services/document-list/components/library-name-column/library-name-column.component.spec.ts

@@ -0,0 +1,96 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TestBed, ComponentFixture } from '@angular/core/testing';
+import { NO_ERRORS_SCHEMA, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
+import { setupTestBed } from '@alfresco/adf-core';
+import { LibraryNameColumnComponent } from './library-name-column.component';
+import { ContentTestingModule } from '../../../testing/content.testing.module';
+
+describe('LibraryNameColumnComponent', () => {
+    let fixture: ComponentFixture<LibraryNameColumnComponent>;
+    let component: LibraryNameColumnComponent;
+    let node;
+
+    setupTestBed({
+        imports: [ContentTestingModule],
+        schemas: [CUSTOM_ELEMENTS_SCHEMA, NO_ERRORS_SCHEMA]
+    });
+
+    beforeEach(() => {
+        node = <any> {
+            id: 'nodeId',
+            path: {
+                elements: []
+            }
+        };
+    });
+
+    beforeEach(() => {
+        fixture = TestBed.createComponent(LibraryNameColumnComponent);
+        component = fixture.componentInstance;
+    });
+
+    describe('makeLibraryTooltip()', () => {
+        it('maps tooltip to description', () => {
+            node.description = 'description';
+            const tooltip = component.makeLibraryTooltip(node);
+
+            expect(tooltip).toBe(node.description);
+        });
+
+        it('maps tooltip to description', () => {
+            node.title = 'title';
+            const tooltip = component.makeLibraryTooltip(node);
+
+            expect(tooltip).toBe(node.title);
+        });
+
+        it('sets tooltip to empty string', () => {
+            const tooltip = component.makeLibraryTooltip(node);
+
+            expect(tooltip).toBe('');
+        });
+    });
+
+    describe('makeLibraryTitle()', () => {
+        it('sets title with id when duplicate nodes title exists in list', () => {
+            node.title = 'title';
+
+            const rows = [
+                <any> { node: { entry: { id: 'some-id', title: 'title' } } }
+            ];
+
+            const title = component.makeLibraryTitle(node, rows);
+            expect(title).toContain('nodeId');
+        });
+
+        it('sets title when no duplicate nodes title exists in list', () => {
+            node.title = 'title';
+
+            const rows = [
+                <any> {
+                    node: { entry: { id: 'some-id', title: 'title-some-id' } }
+                }
+            ];
+
+            const title = component.makeLibraryTitle(node, rows);
+
+            expect(title).toBe('title');
+        });
+    });
+});

lib/content-services/document-list/components/library-name-column/library-name-column.component.ts

@@ -0,0 +1,90 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  Component,
+  ChangeDetectionStrategy,
+  ViewEncapsulation,
+  OnInit,
+  Input,
+  ElementRef
+} from '@angular/core';
+import { MinimalNodeEntity } from 'alfresco-js-api';
+import { ShareDataRow } from '../../data/share-data-row.model';
+
+@Component({
+  selector: 'adf-library-name-column',
+  template: `
+    <span title="{{ displayTooltip }}" (click)="onClick()">
+      {{ displayText }}
+    </span>
+  `,
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  encapsulation: ViewEncapsulation.None,
+  host: { class: 'adf-datatable-cell adf-datatable-link adf-library-name-column' }
+})
+export class LibraryNameColumnComponent implements OnInit {
+  @Input()
+  context: any;
+
+  displayTooltip: string;
+  displayText: string;
+  node: MinimalNodeEntity;
+
+  constructor(private element: ElementRef) {}
+
+  ngOnInit() {
+    this.node = this.context.row.node;
+    const rows: Array<ShareDataRow> = this.context.data.rows || [];
+    if (this.node && this.node.entry) {
+      this.displayText = this.makeLibraryTitle(this.node.entry, rows);
+      this.displayTooltip = this.makeLibraryTooltip(this.node.entry);
+    }
+  }
+
+  onClick() {
+    this.element.nativeElement.dispatchEvent(
+      new CustomEvent('name-click', {
+        bubbles: true,
+        detail: {
+          node: this.node
+        }
+      })
+    );
+  }
+
+  makeLibraryTooltip(library: any): string {
+    const { description, title } = library;
+
+    return description || title || '';
+  }
+
+  makeLibraryTitle(library: any, rows: Array<ShareDataRow>): string {
+    const entries = rows.map((r: ShareDataRow) => r.node.entry);
+    const { title, id } = library;
+
+    let isDuplicate = false;
+
+    if (entries) {
+      isDuplicate = entries.some((entry: any) => {
+        return entry.id !== id && entry.title === title;
+      });
+    }
+
+    return isDuplicate ? `${title} (${id})` : `${title}`;
+  }
+}

lib/content-services/document-list/components/library-role-column/library-role-column.component.spec.ts

@@ -0,0 +1,77 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { setupTestBed } from '@alfresco/adf-core';
+import { LibraryRoleColumnComponent } from './library-role-column.component';
+import { TestBed, ComponentFixture } from '@angular/core/testing';
+import { NO_ERRORS_SCHEMA, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
+import { ContentTestingModule } from '../../../testing/content.testing.module';
+
+describe('LibraryNameColumnComponent', () => {
+    let fixture: ComponentFixture<LibraryRoleColumnComponent>;
+    let component: LibraryRoleColumnComponent;
+
+    setupTestBed({
+        imports: [ContentTestingModule],
+        schemas: [CUSTOM_ELEMENTS_SCHEMA, NO_ERRORS_SCHEMA]
+    });
+
+    beforeEach(() => {
+        fixture = TestBed.createComponent(LibraryRoleColumnComponent);
+        component = fixture.componentInstance;
+    });
+
+    it('should render Manager', () => {
+        component.context = {
+            row: { node: { entry: { role: 'SiteManager' } } }
+        };
+        fixture.detectChanges();
+        expect(component.displayText).toBe('LIBRARY.ROLE.MANAGER');
+    });
+
+    it('should render Collaborator', () => {
+        component.context = {
+            row: { node: { entry: { role: 'SiteCollaborator' } } }
+        };
+        fixture.detectChanges();
+        expect(component.displayText).toBe('LIBRARY.ROLE.COLLABORATOR');
+    });
+
+    it('should render Contributor', () => {
+        component.context = {
+            row: { node: { entry: { role: 'SiteContributor' } } }
+        };
+        fixture.detectChanges();
+        expect(component.displayText).toBe('LIBRARY.ROLE.CONTRIBUTOR');
+    });
+
+    it('should render Consumer', () => {
+        component.context = {
+            row: { node: { entry: { role: 'SiteConsumer' } } }
+        };
+        fixture.detectChanges();
+        expect(component.displayText).toBe('LIBRARY.ROLE.CONSUMER');
+    });
+
+    it('should not render text for unknown', () => {
+        component.context = {
+            row: { node: { entry: { role: 'ROLE' } } }
+        };
+        fixture.detectChanges();
+        expect(component.displayText).toBe('');
+    });
+});

lib/content-services/document-list/components/library-role-column/library-role-column.component.ts

@@ -0,0 +1,58 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Component, OnInit, Input } from '@angular/core';
+
+@Component({
+  selector: 'adf-library-role-column',
+  template: `
+    <span title="{{ displayText | translate }}">
+      {{ displayText | translate }}
+    </span>
+  `,
+  host: { class: 'adf-library-role-column' }
+})
+export class LibraryRoleColumnComponent implements OnInit {
+  @Input()
+  context: any;
+
+  displayText: string;
+
+  ngOnInit() {
+    const node = this.context.row.node;
+    if (node && node.entry) {
+      const role: string = node.entry.role;
+      switch (role) {
+        case 'SiteManager':
+          this.displayText = 'LIBRARY.ROLE.MANAGER';
+          break;
+        case 'SiteCollaborator':
+          this.displayText = 'LIBRARY.ROLE.COLLABORATOR';
+          break;
+        case 'SiteContributor':
+          this.displayText = 'LIBRARY.ROLE.CONTRIBUTOR';
+          break;
+        case 'SiteConsumer':
+          this.displayText = 'LIBRARY.ROLE.CONSUMER';
+          break;
+        default:
+          this.displayText = '';
+          break;
+      }
+    }
+  }
+}

lib/content-services/document-list/components/library-status-column/library-status-column.component.spec.ts

@@ -0,0 +1,24 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { LibraryStatusColumnComponent } from './library-status-column.component';
+
+describe('LibraryStatusColumnComponent', () => {
+  it('should be defined', () => {
+    expect(LibraryStatusColumnComponent).toBeDefined();
+  });
+});

lib/content-services/document-list/components/library-status-column/library-status-column.component.ts

@@ -0,0 +1,56 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Component, Input, OnInit } from '@angular/core';
+
+@Component({
+  selector: 'adf-library-status-column',
+  template: `
+    <span title="{{ displayText | translate }}">
+      {{ displayText | translate }}
+    </span>
+  `,
+  host: { class: 'adf-library-status-column' }
+})
+export class LibraryStatusColumnComponent implements OnInit {
+  @Input()
+  context: any;
+
+  displayText: string;
+
+  ngOnInit() {
+    const node = this.context.row.node;
+    if (node && node.entry) {
+      const visibility: string = node.entry.visibility;
+
+      switch (visibility.toUpperCase()) {
+        case 'PUBLIC':
+          this.displayText = 'LIBRARY.VISIBILITY.PUBLIC';
+          break;
+        case 'PRIVATE':
+          this.displayText = 'LIBRARY.VISIBILITY.PRIVATE';
+          break;
+        case 'MODERATED':
+          this.displayText = 'LIBRARY.VISIBILITY.MODERATED';
+          break;
+        default:
+          this.displayText = 'UNKNOWN';
+          break;
+      }
+    }
+  }
+}

lib/content-services/document-list/components/name-column/name-column.component.spec.ts

@@ -0,0 +1,24 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { NameColumnComponent } from './name-column.component';
+
+describe('NameColumnComponent', () => {
+  it('should be defined', () => {
+    expect(NameColumnComponent).toBeDefined();
+  });
+});

lib/content-services/document-list/components/name-column/name-column.component.ts

@@ -0,0 +1,65 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  Component,
+  Input,
+  OnInit,
+  ChangeDetectionStrategy,
+  ViewEncapsulation,
+  ElementRef
+} from '@angular/core';
+import { MinimalNodeEntity } from 'alfresco-js-api';
+
+@Component({
+  selector: 'adf-name-column',
+  template: `
+    <span title="{{ node | adfNodeNameTooltip }}" (click)="onClick()">
+      {{ displayText }}
+    </span>
+  `,
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  encapsulation: ViewEncapsulation.None,
+  host: { class: 'adf-datatable-cell adf-datatable-link adf-name-column' }
+})
+export class NameColumnComponent implements OnInit {
+  @Input()
+  context: any;
+
+  displayText: string;
+  node: MinimalNodeEntity;
+
+  constructor(private element: ElementRef) {}
+
+  ngOnInit() {
+    this.node = this.context.row.node;
+    if (this.node && this.node.entry) {
+      this.displayText = this.node.entry.name || this.node.entry.id;
+    }
+  }
+
+  onClick() {
+    this.element.nativeElement.dispatchEvent(
+      new CustomEvent('name-click', {
+        bubbles: true,
+        detail: {
+          node: this.node
+        }
+      })
+    );
+  }
+}

lib/content-services/document-list/components/trashcan-name-column/trashcan-name-column.component.spec.ts

@@ -0,0 +1,106 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TrashcanNameColumnComponent } from './trashcan-name-column.component';
+
+describe('TrashcanNameColumnComponent', () => {
+    let component;
+
+    beforeEach(() => {
+        component = new TrashcanNameColumnComponent();
+    });
+
+    it('should set displayText for content files', () => {
+        const context = {
+            data: { rows: [] },
+            row: {
+                node: {
+                    entry: {
+                        name: 'contentName',
+                        nodeType: 'content'
+                    }
+                }
+            }
+        };
+
+        component.context = context;
+        component.ngOnInit();
+
+        expect(component.displayText).toBe('contentName');
+    });
+
+    it('should set displayText for library', () => {
+        const context = {
+            data: {
+                rows: []
+            },
+            row: {
+                node: {
+                    entry: {
+                        nodeType: 'st:site',
+                        properties: {
+                            'cm:title': 'libraryTitle'
+                        }
+                    }
+                }
+            }
+        };
+
+        component.context = context;
+        component.ngOnInit();
+
+        expect(component.displayText).toBe('libraryTitle');
+    });
+
+    it('should set custom displayText for libraries with same name', () => {
+        const context = {
+            data: {
+                rows: [
+                    {
+                        node: {
+                            entry: {
+                                id: 'id1',
+                                name: 'name1',
+                                nodeType: 'st:site',
+                                properties: {
+                                    'cm:title': 'bogus'
+                                }
+                            }
+                        }
+                    }
+                ]
+            },
+            row: {
+                node: {
+                    entry: {
+                        id: 'id2',
+                        name: 'name1',
+                        nodeType: 'st:site',
+                        properties: {
+                            'cm:title': 'bogus'
+                        }
+                    }
+                }
+            }
+        };
+
+        component.context = context;
+        component.ngOnInit();
+
+        expect(component.displayText).toBe('bogus (name1)');
+    });
+});

lib/content-services/document-list/components/trashcan-name-column/trashcan-name-column.component.ts

@@ -0,0 +1,87 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  Component,
+  ChangeDetectionStrategy,
+  ViewEncapsulation,
+  OnInit,
+  Input
+} from '@angular/core';
+import { MinimalNodeEntity } from 'alfresco-js-api';
+import { ShareDataRow } from '../../data/share-data-row.model';
+
+@Component({
+  selector: 'adf-trashcan-name-column',
+  template: `
+    <ng-container *ngIf="!isLibrary">
+      <span title="{{ node | adfNodeNameTooltip }}">{{ displayText }}</span>
+    </ng-container>
+    <ng-container *ngIf="isLibrary">
+      <span title="{{ displayTooltip }}">{{ displayText }}</span>
+    </ng-container>
+  `,
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  encapsulation: ViewEncapsulation.None,
+  host: { class: 'adf-datatable-cell adf-trashcan-name-column' }
+})
+export class TrashcanNameColumnComponent implements OnInit {
+  @Input()
+  context: any;
+
+  isLibrary = false;
+  displayText: string;
+  displayTooltip: string;
+  node: MinimalNodeEntity;
+
+  ngOnInit() {
+    this.node = this.context.row.node;
+    const rows: Array<ShareDataRow> = this.context.data.rows || [];
+
+    if (this.node && this.node.entry) {
+      this.isLibrary = this.node.entry.nodeType === 'st:site';
+
+      if (this.isLibrary) {
+        const { properties } = this.node.entry;
+
+        this.displayText = this.makeLibraryTitle(this.node.entry, rows);
+        this.displayTooltip =
+          properties['cm:description'] || properties['cm:title'];
+      } else {
+        this.displayText = this.node.entry.name || this.node.entry.id;
+      }
+    }
+  }
+
+  makeLibraryTitle(library: any, rows: Array<ShareDataRow>): string {
+    const entries = rows.map((r: ShareDataRow) => r.node.entry);
+    const { id } = library;
+    const title = library.properties['cm:title'];
+
+    let isDuplicate = false;
+
+    if (entries) {
+      isDuplicate = entries.some((entry: any) => {
+        return entry.id !== id && entry.properties['cm:title'] === title;
+      });
+    }
+
+    return isDuplicate
+      ? `${library.properties['cm:title']} (${library.name})`
+      : `${library.properties['cm:title']}`;
+  }
+}

lib/content-services/document-list/document-list.module.ts

@@ -31,6 +31,11 @@ import { DocumentListComponent } from './components/document-list.component';
 
 import { EmptyFolderContentDirective } from './components/empty-folder/empty-folder-content.directive';
 import { NoPermissionContentDirective } from './components/no-permission/no-permission-content.directive';
+import { TrashcanNameColumnComponent } from './components/trashcan-name-column/trashcan-name-column.component';
+import { LibraryStatusColumnComponent } from './components/library-status-column/library-status-column.component';
+import { LibraryRoleColumnComponent } from './components/library-role-column/library-role-column.component';
+import { LibraryNameColumnComponent } from './components/library-name-column/library-name-column.component';
+import { NameColumnComponent } from './components/name-column/name-column.component';
 
 @NgModule({
     imports: [
@@ -43,6 +48,11 @@ import { NoPermissionContentDirective } from './components/no-permission/no-perm
     declarations: [
         DocumentListComponent,
         ContentColumnComponent,
+        TrashcanNameColumnComponent,
+        LibraryStatusColumnComponent,
+        LibraryRoleColumnComponent,
+        LibraryNameColumnComponent,
+        NameColumnComponent,
         ContentColumnListComponent,
         ContentActionComponent,
         ContentActionListComponent,
@@ -52,6 +62,11 @@ import { NoPermissionContentDirective } from './components/no-permission/no-perm
     exports: [
         DocumentListComponent,
         ContentColumnComponent,
+        TrashcanNameColumnComponent,
+        LibraryStatusColumnComponent,
+        LibraryRoleColumnComponent,
+        LibraryNameColumnComponent,
+        NameColumnComponent,
         ContentColumnListComponent,
         ContentActionComponent,
         ContentActionListComponent,