diff --git a/demo-shell/src/app.config.json b/demo-shell/src/app.config.json index 83080386de..ac2a175541 100644 --- a/demo-shell/src/app.config.json +++ b/demo-shell/src/app.config.json @@ -600,7 +600,7 @@ "content-metadata": { "presets": { "default": { - "exif:exif": "*" + "exif:exif": "*" } } }, diff --git a/docs/content-services/components/content-metadata-card.component.md b/docs/content-services/components/content-metadata-card.component.md index 9d4c5f239a..830900e10b 100644 --- a/docs/content-services/components/content-metadata-card.component.md +++ b/docs/content-services/components/content-metadata-card.component.md @@ -130,8 +130,7 @@ A final example shows the same process applied to a custom preset called "kitten ### Layout oriented config You can also go beyond the aspect oriented configuration if you need to configure the groups and properties in a more detailed way. With this type of configuration any property of any aspect/type -can be "cherry picked" and grouped into an accordion drawer, along with a translatable title -defined in the preset configuration. +can be "cherry picked" and grouped into an accordion drawer, along with a translatable title defined in the preset configuration. #### Basic elements @@ -217,6 +216,80 @@ The result of this config would be two accordion groups with the following prope | kitten:favourite-food | | kitten:recommended-food | + +### Displaying all properties + +You can list all the properties by simply adding the `includeAll: boolean` to your config. This config will display all the aspects and properties available for that specific file. + +```json +"content-metadata": { + "presets": { + "default": { + "includeAll": true + } + } +}, +``` + +Futhermore, you can also exclude specific aspects by adding the `exclude` property. It can be either a string if it's only one aspect or an array if you want to exclude multiple aspects at once: + +```json +"content-metadata": { + "presets": { + "default": { + "includeAll": true, + "exclude": "exif:exif" + } + } +}, +``` + +```json +"content-metadata": { + "presets": { + "default": { + "includeAll": true, + "exclude": ["exif:exif", "owner:parameters"] + } + } +}, +``` + +When using this configuration you can still whitelist aspects and properties as you desire. Let's see more complex examples for each of the config layouts: + +##### Aspect oriented config +```json +"content-metadata": { + "presets": { + "default": { + "includeAll": true, + "exclude": "exif:exif", + "exif:exif": [ "exif:pixelXDimension", "exif:pixelYDimension"] + } + } +}, +``` + +##### Layout oriented config +```json +"content-metadata": { + "presets": { + "robot-images": [ + { + "includeAll": true, + "exclude": ["cm:content", "exif:exif"] + }, + { + "title": "Robot Group", + "items": [ + { "aspect": "exif:exif", "properties": [ "exif:pixelXDimension", "exif:pixelYDimension"] } + ] + } + ] + } +}, +``` + ## What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect Nothing - since this aspect is not related to the node, it will simply be ignored and not diff --git a/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.html b/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.html index 996ea9f747..e1c344b2c9 100644 --- a/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.html +++ b/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.html @@ -21,7 +21,7 @@
- diff --git a/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.spec.ts b/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.spec.ts index 6b7b355542..64d6b78b9c 100644 --- a/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.spec.ts +++ b/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.spec.ts @@ -21,7 +21,10 @@ import { By } from '@angular/platform-browser'; import { Node } from '@alfresco/js-api'; import { ContentMetadataComponent } from './content-metadata.component'; import { ContentMetadataService } from '../../services/content-metadata.service'; -import { CardViewBaseItemModel, CardViewComponent, CardViewUpdateService, NodesApiService, LogService, setupTestBed } from '@alfresco/adf-core'; +import { + CardViewBaseItemModel, CardViewComponent, CardViewUpdateService, NodesApiService, + LogService, setupTestBed +} from '@alfresco/adf-core'; import { throwError, of } from 'rxjs'; import { ContentTestingModule } from '../../../testing/content.testing.module'; @@ -206,6 +209,7 @@ describe('ContentMetadataComponent', () => { spyOn(contentMetadataService, 'getGroupedProperties').and.callFake(() => { return of([{ properties: expectedProperties }]); }); + spyOn(component, 'showGroup').and.returnValue(true); component.ngOnChanges({ node: new SimpleChange(node, expectedNode, false) }); @@ -221,6 +225,7 @@ describe('ContentMetadataComponent', () => { component.displayEmpty = false; fixture.detectChanges(); spyOn(contentMetadataService, 'getGroupedProperties').and.returnValue(of([{ properties: [] }])); + spyOn(component, 'showGroup').and.returnValue(true); component.ngOnChanges({ node: new SimpleChange(node, expectedNode, false) }); @@ -230,6 +235,42 @@ describe('ContentMetadataComponent', () => { expect(basicPropertiesComponent.displayEmpty).toBe(false); }); })); + + it('should hide card views group when the grouped properties are empty', async(() => { + component.expanded = true; + fixture.detectChanges(); + spyOn(contentMetadataService, 'getGroupedProperties').and.returnValue(of([{ properties: [] }])); + + component.ngOnChanges({ node: new SimpleChange(node, expectedNode, false) }); + + component.basicProperties$.subscribe(() => { + fixture.detectChanges(); + const basicPropertiesGroup = fixture.debugElement.query(By.css('.adf-metadata-grouped-properties-container mat-expansion-panel')); + expect(basicPropertiesGroup).toBeNull(); + }); + })); + + it('should display card views group when there is at least one property that is not empty', async(() => { + component.expanded = true; + fixture.detectChanges(); + const cardViewGroup = {title: 'Group 1', properties: [{ + data: null, + default: null, + displayValue: 'DefaultName', + icon: '', + key: 'properties.cm:default', + label: 'To' + }]}; + spyOn(contentMetadataService, 'getGroupedProperties').and.returnValue(of([{ properties: [cardViewGroup] }])); + + component.ngOnChanges({ node: new SimpleChange(node, expectedNode, false) }); + + component.basicProperties$.subscribe(() => { + fixture.detectChanges(); + const basicPropertiesGroup = fixture.debugElement.query(By.css('.adf-metadata-grouped-properties-container mat-expansion-panel')); + expect(basicPropertiesGroup).toBeDefined(); + }); + })); }); describe('Properties displaying', () => { diff --git a/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts b/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts index f03250d27e..d3c4004263 100644 --- a/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts +++ b/lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts @@ -106,6 +106,14 @@ export class ContentMetadataComponent implements OnChanges, OnInit, OnDestroy { return this.nodesApiService.updateNode(this.node.id, nodeBody); } + showGroup(group: CardViewGroup) { + const properties = group.properties.filter((property) => { + return !!property.displayValue; + }); + + return properties.length; + } + ngOnDestroy() { this.disposableNodeUpdate.unsubscribe(); } diff --git a/lib/content-services/content-metadata/interfaces/aspect-oriented-config.interface.ts b/lib/content-services/content-metadata/interfaces/aspect-oriented-config.interface.ts index 85fcd5f22b..b8a70eaef6 100644 --- a/lib/content-services/content-metadata/interfaces/aspect-oriented-config.interface.ts +++ b/lib/content-services/content-metadata/interfaces/aspect-oriented-config.interface.ts @@ -16,5 +16,5 @@ */ export declare interface AspectOrientedConfig { - [key: string]: string | string[]; + [key: string]: string | string[] | boolean; } diff --git a/lib/content-services/content-metadata/interfaces/content-metadata-config.interface.ts b/lib/content-services/content-metadata/interfaces/content-metadata-config.interface.ts index 55818a96f2..230c301120 100644 --- a/lib/content-services/content-metadata/interfaces/content-metadata-config.interface.ts +++ b/lib/content-services/content-metadata/interfaces/content-metadata-config.interface.ts @@ -21,4 +21,7 @@ import { OrganisedPropertyGroup } from './organised-property-group.interface'; export interface ContentMetadataConfig { isGroupAllowed(groupName: string): boolean; reorganiseByConfig(propertyGroups: PropertyGroupContainer): OrganisedPropertyGroup[]; + filterExcludedPreset(propertyGroups: OrganisedPropertyGroup[]): OrganisedPropertyGroup[]; + appendAllPreset(propertyGroups: PropertyGroupContainer): OrganisedPropertyGroup[]; + isIncludeAllEnabled(): boolean; } diff --git a/lib/content-services/content-metadata/interfaces/layout-oriented-config.interface.ts b/lib/content-services/content-metadata/interfaces/layout-oriented-config.interface.ts index 984649a23e..6cba42cd70 100644 --- a/lib/content-services/content-metadata/interfaces/layout-oriented-config.interface.ts +++ b/lib/content-services/content-metadata/interfaces/layout-oriented-config.interface.ts @@ -19,6 +19,8 @@ export interface LayoutOrientedConfigItem { aspect?: string; type?: string; properties: string | string[]; + includeAll?: boolean; + exclude?: string | string[]; } export interface LayoutOrientedConfigLayoutBlock { diff --git a/lib/content-services/content-metadata/services/config/aspect-oriented-config.service.spec.ts b/lib/content-services/content-metadata/services/config/aspect-oriented-config.service.spec.ts index fbab0c65a4..a494455880 100644 --- a/lib/content-services/content-metadata/services/config/aspect-oriented-config.service.spec.ts +++ b/lib/content-services/content-metadata/services/config/aspect-oriented-config.service.spec.ts @@ -175,4 +175,52 @@ describe('AspectOrientedConfigService', () => { }); }); }); + + describe('appendAllPreset', () => { + + const property1 = { name: 'property1' }, + property2 = { name: 'property2' }, + property3 = { name: 'property3' }, + property4 = { name: 'property4' }; + + const propertyGroups: PropertyGroupContainer = { + berseria: { title: 'Berseria', description: '', name: 'berseria', properties: { property1, property2 } }, + zestiria: { title: 'Zestiria', description: '', name: 'zestiria', properties: { property3, property4 } } + }; + + it(`should return all the propertyGorups`, () => { + const testCase = { + name: 'Not existing property', + config: { + includeAll: true + }, + expectations: [ + { + title: 'Berseria', + properties: [ property1, property2 ] + }, + { + title: 'Zestiria', + properties: [ property3, property4 ] + } + ] + }; + configService = createConfigService(testCase.config); + + const organisedPropertyGroups = configService.appendAllPreset(propertyGroups); + + expect(organisedPropertyGroups.length).toBe(testCase.expectations.length, 'Group count should match'); + testCase.expectations.forEach((expectation, i) => { + expect(organisedPropertyGroups[i].title).toBe(expectation.title, 'Group\'s title should match' ); + expect(organisedPropertyGroups[i].properties.length).toBe( + expectation.properties.length, + `Property count for "${organisedPropertyGroups[i].title}" group should match.` + ); + + expectation.properties.forEach((property, j) => { + expect(organisedPropertyGroups[i].properties[j]).toBe(property, `Property should match ${property.name}`); + }); + }); + }); + }); }); diff --git a/lib/content-services/content-metadata/services/config/aspect-oriented-config.service.ts b/lib/content-services/content-metadata/services/config/aspect-oriented-config.service.ts index 235b9fcae3..4eea2223d8 100644 --- a/lib/content-services/content-metadata/services/config/aspect-oriented-config.service.ts +++ b/lib/content-services/content-metadata/services/config/aspect-oriented-config.service.ts @@ -20,9 +20,12 @@ import { getGroup, getProperty } from './property-group-reader'; export class AspectOrientedConfigService implements ContentMetadataConfig { - constructor(private config: any) {} + constructor(private config: any) { } public isGroupAllowed(groupName: string): boolean { + if (this.isIncludeAllEnabled()) { + return true; + } const groupNames = Object.keys(this.config); return groupNames.indexOf(groupName) !== -1; } @@ -39,6 +42,33 @@ export class AspectOrientedConfigService implements ContentMetadataConfig { .filter((organisedPropertyGroup) => organisedPropertyGroup.properties.length > 0); } + public appendAllPreset(propertyGroups: PropertyGroupContainer): OrganisedPropertyGroup[] { + const groups = Object.keys(propertyGroups) + .map((groupName) => { + const propertyGroup = propertyGroups[groupName], + properties = propertyGroup.properties; + + return Object.assign({}, propertyGroup, { + properties: Object.keys(properties).map((propertyName) => properties[propertyName]) + }); + }); + + return groups; + } + + public filterExcludedPreset(propertyGroups: OrganisedPropertyGroup[]): OrganisedPropertyGroup[] { + if (this.config.exclude) { + return propertyGroups.filter((preset) => { + return !this.config.exclude.includes(preset.name); + }); + } + return propertyGroups; + } + + public isIncludeAllEnabled() { + return this.config.includeAll; + } + private getOrganisedPropertyGroup(propertyGroups, aspectName) { const group = getGroup(propertyGroups, aspectName); let newGroup = []; @@ -55,7 +85,7 @@ export class AspectOrientedConfigService implements ContentMetadataConfig { .filter((props) => props !== undefined); } - newGroup = [ { title: group.title, properties } ]; + newGroup = [{ title: group.title, properties }]; } return newGroup; diff --git a/lib/content-services/content-metadata/services/config/content-metadata-config.factory.spec.ts b/lib/content-services/content-metadata/services/config/content-metadata-config.factory.spec.ts index 15b1107b96..59c444dbe8 100644 --- a/lib/content-services/content-metadata/services/config/content-metadata-config.factory.spec.ts +++ b/lib/content-services/content-metadata/services/config/content-metadata-config.factory.spec.ts @@ -92,7 +92,7 @@ describe('ContentMetadataConfigFactory', () => { })); }); - xdescribe('set', () => { + describe('set', () => { function setConfig(presetName, presetConfig) { appConfig.config['content-metadata'] = { diff --git a/lib/content-services/content-metadata/services/config/indifferent-config.service.ts b/lib/content-services/content-metadata/services/config/indifferent-config.service.ts index 8ae02dd3ab..f122936888 100644 --- a/lib/content-services/content-metadata/services/config/indifferent-config.service.ts +++ b/lib/content-services/content-metadata/services/config/indifferent-config.service.ts @@ -38,4 +38,16 @@ export class IndifferentConfigService implements ContentMetadataConfig { }); }); } + + public filterExcludedPreset(propertyGroups: OrganisedPropertyGroup[]): OrganisedPropertyGroup[] { + return propertyGroups; + } + + public appendAllPreset(propertyGroups: PropertyGroupContainer): OrganisedPropertyGroup[] { + return[]; + } + + public isIncludeAllEnabled(): boolean { + return true; + } } diff --git a/lib/content-services/content-metadata/services/config/layout-oriented-config.service.spec.ts b/lib/content-services/content-metadata/services/config/layout-oriented-config.service.spec.ts index 63d2aa5e94..c1e009302f 100644 --- a/lib/content-services/content-metadata/services/config/layout-oriented-config.service.spec.ts +++ b/lib/content-services/content-metadata/services/config/layout-oriented-config.service.spec.ts @@ -66,6 +66,13 @@ describe('LayoutOrientedConfigService', () => { ], expectation: false, groupNameToQuery: 'phantasia' + }, + { + config: [ + { title: 'Deamons', includeAll: true, items: [{ aspect: 'zestiria', properties: '*' }] } + ], + expectation: true, + groupNameToQuery: 'phantasia' } ]; diff --git a/lib/content-services/content-metadata/services/config/layout-oriented-config.service.ts b/lib/content-services/content-metadata/services/config/layout-oriented-config.service.ts index f9de848407..680135cb31 100644 --- a/lib/content-services/content-metadata/services/config/layout-oriented-config.service.ts +++ b/lib/content-services/content-metadata/services/config/layout-oriented-config.service.ts @@ -25,16 +25,19 @@ import { getProperty } from './property-group-reader'; export class LayoutOrientedConfigService implements ContentMetadataConfig { - constructor(private config: any) {} + constructor(private config: any) { } public isGroupAllowed(groupName: string): boolean { + if (this.isIncludeAllEnabled()) { + return true; + } return this.getMatchingGroups(groupName).length > 0; } public reorganiseByConfig(propertyGroups: PropertyGroupContainer): OrganisedPropertyGroup[] { - const layoutBlocks = this.config; + const layoutBlocks = this.config.filter((itemsGroup) => itemsGroup.items); - return layoutBlocks.map((layoutBlock) => { + let organisedPropertyGroup = layoutBlocks.map((layoutBlock) => { const flattenedItems = this.flattenItems(layoutBlock.items), properties = flattenedItems.reduce((props, explodedItem) => { const property = getProperty(propertyGroups, explodedItem.groupName, explodedItem.propertyName) || []; @@ -46,6 +49,44 @@ export class LayoutOrientedConfigService implements ContentMetadataConfig { properties }; }); + + return organisedPropertyGroup; + } + + public appendAllPreset(propertyGroups: PropertyGroupContainer): OrganisedPropertyGroup[] { + return Object.keys(propertyGroups) + .map((groupName) => { + const propertyGroup = propertyGroups[groupName], + properties = propertyGroup.properties; + + return Object.assign({}, propertyGroup, { + properties: Object.keys(properties).map((propertyName) => properties[propertyName]) + }); + }); + } + + public filterExcludedPreset(propertyGroups: OrganisedPropertyGroup[]): OrganisedPropertyGroup[] { + let excludedConfig = this.config + .map((config) => config.exclude) + .find((exclude) => exclude !== undefined); + + if (excludedConfig === undefined) { + excludedConfig = []; + } else if (typeof excludedConfig === 'string') { + excludedConfig = [excludedConfig]; + } + + return propertyGroups.filter((props) => { + return !excludedConfig.includes(props.name); + }); + } + + public isIncludeAllEnabled() { + let includeAllProperty = this.config + .map((config) => config.includeAll) + .find((includeAll) => includeAll !== undefined); + + return includeAllProperty !== undefined ? includeAllProperty : false; } private flattenItems(items) { diff --git a/lib/content-services/content-metadata/services/content-metadata.service.spec.ts b/lib/content-services/content-metadata/services/content-metadata.service.spec.ts index 879af08748..0bca6f192a 100644 --- a/lib/content-services/content-metadata/services/content-metadata.service.spec.ts +++ b/lib/content-services/content-metadata/services/content-metadata.service.spec.ts @@ -210,5 +210,40 @@ describe('ContentMetaDataService', () => { expect(classesApi.getClass).toHaveBeenCalledWith('cm_content'); }); + it('should exclude the property if this property is excluded from config', (done) => { + const fakeNode: Node = { name: 'Node Action', id: 'fake-id', nodeType: 'cm:content', isFile: true, aspectNames: [] } ; + + const customLayoutOrientedScheme = [ + { + 'id': 'app.content.metadata.customGroup', + 'title': 'Exif', + 'includeAll': true, + 'exclude': ['cm:content'], + 'items': [ + { + 'id': 'app.content.metadata.exifAspect2', + 'aspect': 'exif:exif', + 'properties': '*' + } + ] + } + ]; + + setConfig('custom', customLayoutOrientedScheme); + spyOn(classesApi, 'getClass').and.callFake(() => { + return of(contentResponse); + }); + + service.getGroupedProperties(fakeNode, 'custom').subscribe( + (res) => { + expect(res.length).toEqual(0); + done(); + } + ); + + expect(classesApi.getClass).toHaveBeenCalledTimes(1); + expect(classesApi.getClass).toHaveBeenCalledWith('cm_content'); + }); + }); }); diff --git a/lib/content-services/content-metadata/services/content-metadata.service.ts b/lib/content-services/content-metadata/services/content-metadata.service.ts index 2200e5183b..678978cb6e 100644 --- a/lib/content-services/content-metadata/services/content-metadata.service.ts +++ b/lib/content-services/content-metadata/services/content-metadata.service.ts @@ -18,13 +18,13 @@ import { Injectable } from '@angular/core'; import { Node } from '@alfresco/js-api'; import { BasicPropertiesService } from './basic-properties.service'; -import { Observable, of } from 'rxjs'; +import { Observable, of, iif } from 'rxjs'; import { PropertyGroupTranslatorService } from './property-groups-translator.service'; import { CardViewItem } from '@alfresco/adf-core'; import { CardViewGroup, OrganisedPropertyGroup } from '../interfaces/content-metadata.interfaces'; import { ContentMetadataConfigFactory } from './config/content-metadata-config.factory'; import { PropertyDescriptorsService } from './property-descriptors.service'; -import { map } from 'rxjs/operators'; +import { map, switchMap } from 'rxjs/operators'; @Injectable({ providedIn: 'root' @@ -45,14 +45,20 @@ export class ContentMetadataService { let groupedProperties = of([]); if (node.aspectNames) { - const config = this.contentMetadataConfigFactory.get(presetName), + const contentMetadataConfig = this.contentMetadataConfigFactory.get(presetName), groupNames = node.aspectNames .concat(node.nodeType) - .filter((groupName) => config.isGroupAllowed(groupName)); + .filter((groupName) => contentMetadataConfig.isGroupAllowed(groupName)); if (groupNames.length > 0) { groupedProperties = this.propertyDescriptorsService.load(groupNames).pipe( - map((groups) => config.reorganiseByConfig(groups)), + switchMap((groups) => + iif( + () => contentMetadataConfig.isIncludeAllEnabled(), + of(contentMetadataConfig.appendAllPreset(groups).concat(contentMetadataConfig.reorganiseByConfig(groups))), + of(contentMetadataConfig.reorganiseByConfig(groups)) + )), + map((groups) => contentMetadataConfig.filterExcludedPreset(groups)), map((groups) => this.filterEmptyPreset(groups)), map((groups) => this.setTitleToNameIfNotSet(groups)), map((groups) => this.propertyGroupTranslatorService.translateToCardViewGroups(groups, node.properties)) diff --git a/lib/core/app-config/schema.json b/lib/core/app-config/schema.json index b3fa971e95..ecfe2b9969 100644 --- a/lib/core/app-config/schema.json +++ b/lib/core/app-config/schema.json @@ -328,6 +328,31 @@ "description": "Property name", "type": "string" } + }, + { + "description": "Include every property", + "type": "boolean" + }, + { + "description": "Properties array", + "type": "object", + "required": [ + "includeAll", + "exclude" + ], + "properties": { + "includeAll": { + "type": "boolean" + }, + "exclude": { + "type": "array", + "items": { + "description": "Property name", + "type": "string" + } + + } + } } ] } @@ -340,10 +365,6 @@ { "description": "Content metadata's one layout group definition", "type": "object", - "required": [ - "title", - "items" - ], "properties": { "title": { "type": "string", @@ -804,7 +825,6 @@ "properties": { "presets": { "description": "Presets for content metadata component", - "type": "object", "patternProperties": { ".*": { "oneOf": [ @@ -813,6 +833,23 @@ "pattern": "^\\*$", "description": "Wildcard for every aspect" }, + { + "type": "object", + "description": "", + "required": [ + "includeAll" + ], + "properties": { + "includeAll": { + "description": "includeAll all property", + "type": "boolean" + }, + "postfix": { + "description": "exclude", + "type": ["string","array"] + } + } + }, { "$ref": "#/definitions/content-metadata-aspect" },