@contrail/data-grouping 1.0.24 → 1.0.25

package/README.md

@@ -1,2 +1,2 @@
-Library for use with @contrail/documents that allows for the quick/automation generation of 
-documents based on templates and layout options.
+Library for use with @contrail/documents that allows for the quick/automation generation of
+documents based on templates and layout options.

package/lib/data-group-generator/data-group-generator.d.ts

@@ -1,7 +1,7 @@
-import { DataGroup, DataGroupStructure, DataGroupingProperty } from "../interfaces";
-export declare class DataGroupGenerator {
-    static getDistinctValues(data: any, index: any, altIndex?: any, groupMultiSelectInSeparateFrame?: boolean): any[];
-    static buildChildDataGroups(data: any, parentGroup: DataGroup, groupingProperties: Array<DataGroupingProperty>, leafNodeDataCount: any, currentDepth: any, groupMultiSelectInSeparateFrame?: boolean): void;
-    static buildDataGroupStructure(data: Array<any>, groupingProperties: Array<DataGroupingProperty>, leafNodeDataCount: number, groupMultiSelectInSeparateFrame?: boolean): DataGroupStructure;
-    static createPartitionedGroupsFromData(parentGroup: DataGroup, data: Array<any>, leafNodeDataCount: number): Array<DataGroup>;
-}
+import { DataGroup, DataGroupStructure, DataGroupingProperty } from '../interfaces';
+export declare class DataGroupGenerator {
+    static getDistinctValues(data: any, indexRootSlug: any, indexSlug?: any, altIndexRootSlug?: any, altIndexSlug?: any, groupMultiSelectInSeparateFrame?: boolean): any[];
+    static buildChildDataGroups(data: any, parentGroup: DataGroup, groupingProperties: Array<DataGroupingProperty>, leafNodeDataCount: any, currentDepth: any, groupMultiSelectInSeparateFrame?: boolean): void;
+    static buildDataGroupStructure(data: Array<any>, groupingProperties: Array<DataGroupingProperty>, leafNodeDataCount: number, groupMultiSelectInSeparateFrame?: boolean): DataGroupStructure;
+    static createPartitionedGroupsFromData(parentGroup: DataGroup, data: Array<any>, leafNodeDataCount: number): Array<DataGroup>;
+}

package/lib/data-group-generator/data-group-generator.js

@@ -1,130 +1,133 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataGroupGenerator = void 0;
-const util_1 = require("@contrail/util");
-const types_1 = require("@contrail/types");
-class DataGroupGenerator {
-    static getDistinctValues(data, index, altIndex = null, groupMultiSelectInSeparateFrame = false) {
-        const map = new Map();
-        const sortingArray = [];
-        data.forEach(obj => {
-            if (!obj) {
-                return;
-            }
-            let key = util_1.ObjectUtil.getByPath(obj, index);
-            let altKey = null;
-            if (altIndex) {
-                altKey = util_1.ObjectUtil.getByPath(obj, altIndex);
-                if (!key) {
-                    key = altKey;
-                }
-            }
-            let value = key;
-            if (!value) {
-                return;
-            }
-            if (key && value && typeof key === 'object') {
-                key = value.id || value.name || value;
-            }
-            if (Array.isArray(value) && !groupMultiSelectInSeparateFrame) {
-                value.forEach(arrayValue => {
-                    map[arrayValue] = arrayValue;
-                    if (!sortingArray.includes(arrayValue)) {
-                        sortingArray.push(arrayValue);
-                    }
-                });
-            }
-            else {
-                map[key] = value;
-                if (!sortingArray.includes(value)) {
-                    sortingArray.push(value);
-                }
-            }
-        });
-        const distinctValues = [...(Object.values(map))].sort((v1, v2) => {
-            let val1 = (v1 && typeof v1 === 'object') ? v1.name : v1;
-            let val2 = (v2 && typeof v2 === 'object') ? v2.name : v2;
-            return sortingArray.indexOf(val1) - sortingArray.indexOf(val2);
-        });
-        return distinctValues;
-    }
-    static buildChildDataGroups(data, parentGroup, groupingProperties, leafNodeDataCount, currentDepth, groupMultiSelectInSeparateFrame = false) {
-        const groupingProperty = groupingProperties[currentDepth];
-        const index = groupingProperty.typeRootSlug + "." + groupingProperty.propertyDefinition.slug;
-        const altIndex = util_1.StringUtil.convertToCamelCase(groupingProperty.typeRootSlug) + "." + groupingProperty.propertyDefinition.slug;
-        let distinctValues = this.getDistinctValues(data, index, altIndex, groupMultiSelectInSeparateFrame);
-        for (let val of distinctValues) {
-            const groupData = data.filter(obj => {
-                const objVal = util_1.ObjectUtil.getByPath(obj, index) || util_1.ObjectUtil.getByPath(obj, altIndex);
-                if (Array.isArray(val) && Array.isArray(objVal)) {
-                    return val.sort().join() === objVal.sort().join();
-                }
-                else if (!Array.isArray(val) && Array.isArray(objVal)) {
-                    return objVal.includes(val);
-                }
-                else if (val.id && (objVal === null || objVal === void 0 ? void 0 : objVal.id)) {
-                    return val.id === objVal.id;
-                }
-                else {
-                    return (objVal === val);
-                }
-            });
-            const group = {
-                data: [],
-                subGroups: [],
-                propertyValues: {},
-                name: ''
-            };
-            if (groupingProperty.isSecondaryGroup) {
-                group.isSecondaryGroup = true;
-            }
-            if (groupData.length > 0) {
-                const details = groupData[0];
-                group.propertyValues = Object.assign({}, details);
-            }
-            group.propertyValues[groupingProperty.propertyDefinition.slug] = val;
-            const label = new types_1.PropertyValueFormatter().formatValueForProperty(val, groupingProperty.propertyDefinition);
-            group.name = label;
-            if (currentDepth === groupingProperties.length - 1) {
-                group.subGroups = this.createPartitionedGroupsFromData(group, groupData, leafNodeDataCount);
-            }
-            else if (currentDepth < groupingProperties.length - 1) {
-                this.buildChildDataGroups(groupData, group, groupingProperties, leafNodeDataCount, currentDepth + 1, groupMultiSelectInSeparateFrame);
-            }
-            parentGroup.subGroups.push(group);
-        }
-    }
-    static buildDataGroupStructure(data, groupingProperties, leafNodeDataCount, groupMultiSelectInSeparateFrame = false) {
-        const structure = {
-            rootGroup: {
-                subGroups: [],
-                name: "root",
-                propertyValues: {},
-                data: [],
-            },
-            groupingProperties,
-            depth: groupingProperties ? groupingProperties.length : 0,
-        };
-        this.buildChildDataGroups(data, structure.rootGroup, groupingProperties, leafNodeDataCount, 0, groupMultiSelectInSeparateFrame);
-        return structure;
-    }
-    static createPartitionedGroupsFromData(parentGroup, data, leafNodeDataCount) {
-        const dataLength = data.length;
-        const frameCount = Math.ceil(dataLength / leafNodeDataCount);
-        const groups = [];
-        for (let i = 1; i <= frameCount; i++) {
-            const startIndex = (i - 1) * leafNodeDataCount;
-            const endIndex = startIndex + leafNodeDataCount;
-            let groupData = data.slice(startIndex, endIndex);
-            const group = {
-                data: groupData,
-                subGroups: [],
-                name: parentGroup.name,
-                propertyValues: parentGroup.propertyValues,
-            };
-            groups.push(group);
-        }
-        return groups;
-    }
-}
-exports.DataGroupGenerator = DataGroupGenerator;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataGroupGenerator = void 0;
+const util_1 = require("@contrail/util");
+const types_1 = require("@contrail/types");
+class DataGroupGenerator {
+    static getDistinctValues(data, indexRootSlug, indexSlug = null, altIndexRootSlug = null, altIndexSlug = null, groupMultiSelectInSeparateFrame = false) {
+        const map = new Map();
+        const sortingArray = [];
+        data.forEach(obj => {
+            if (!obj) {
+                return;
+            }
+            let key = util_1.ObjectUtil.getBySlugs(obj, indexRootSlug, indexSlug);
+            let altKey = null;
+            if (altIndexRootSlug) {
+                altKey = util_1.ObjectUtil.getBySlugs(obj, altIndexRootSlug, altIndexSlug);
+                if (!key) {
+                    key = altKey;
+                }
+            }
+            let value = key;
+            if (!value) {
+                return;
+            }
+            if (key && value && typeof key === 'object') {
+                key = value.id || value.name || value;
+            }
+            if (Array.isArray(value) && !groupMultiSelectInSeparateFrame) {
+                value.forEach(arrayValue => {
+                    map[arrayValue] = arrayValue;
+                    if (!sortingArray.includes(arrayValue)) {
+                        sortingArray.push(arrayValue);
+                    }
+                });
+            }
+            else {
+                map[key] = value;
+                if (!sortingArray.includes(value)) {
+                    sortingArray.push(value);
+                }
+            }
+        });
+        const distinctValues = [...Object.values(map)].sort((v1, v2) => {
+            let val1 = v1 && typeof v1 === 'object' ? v1.name : v1;
+            let val2 = v2 && typeof v2 === 'object' ? v2.name : v2;
+            return sortingArray.indexOf(val1) - sortingArray.indexOf(val2);
+        });
+        return distinctValues;
+    }
+    static buildChildDataGroups(data, parentGroup, groupingProperties, leafNodeDataCount, currentDepth, groupMultiSelectInSeparateFrame = false) {
+        const groupingProperty = groupingProperties[currentDepth];
+        const indexRootSlug = groupingProperty.typeRootSlug;
+        const indexSlug = groupingProperty.propertyDefinition.slug;
+        const altIndexRootSlug = util_1.StringUtil.convertToCamelCase(groupingProperty.typeRootSlug);
+        const altIndexSlug = groupingProperty.propertyDefinition.slug;
+        let distinctValues = this.getDistinctValues(data, indexRootSlug, indexSlug, altIndexRootSlug, altIndexSlug, groupMultiSelectInSeparateFrame);
+        for (let val of distinctValues) {
+            const groupData = data.filter(obj => {
+                const objVal = util_1.ObjectUtil.getBySlugs(obj, indexRootSlug, indexSlug) ||
+                    util_1.ObjectUtil.getBySlugs(obj, altIndexRootSlug, altIndexSlug);
+                if (Array.isArray(val) && Array.isArray(objVal)) {
+                    return val.sort().join() === objVal.sort().join();
+                }
+                else if (!Array.isArray(val) && Array.isArray(objVal)) {
+                    return objVal.includes(val);
+                }
+                else if (val.id && (objVal === null || objVal === void 0 ? void 0 : objVal.id)) {
+                    return val.id === objVal.id;
+                }
+                else {
+                    return objVal === val;
+                }
+            });
+            const group = {
+                data: [],
+                subGroups: [],
+                propertyValues: {},
+                name: '',
+            };
+            if (groupingProperty.isSecondaryGroup) {
+                group.isSecondaryGroup = true;
+            }
+            if (groupData.length > 0) {
+                const details = groupData[0];
+                group.propertyValues = Object.assign({}, details);
+            }
+            group.propertyValues[groupingProperty.propertyDefinition.slug] = val;
+            const label = new types_1.PropertyValueFormatter().formatValueForProperty(val, groupingProperty.propertyDefinition);
+            group.name = label;
+            if (currentDepth === groupingProperties.length - 1) {
+                group.subGroups = this.createPartitionedGroupsFromData(group, groupData, leafNodeDataCount);
+            }
+            else if (currentDepth < groupingProperties.length - 1) {
+                this.buildChildDataGroups(groupData, group, groupingProperties, leafNodeDataCount, currentDepth + 1, groupMultiSelectInSeparateFrame);
+            }
+            parentGroup.subGroups.push(group);
+        }
+    }
+    static buildDataGroupStructure(data, groupingProperties, leafNodeDataCount, groupMultiSelectInSeparateFrame = false) {
+        const structure = {
+            rootGroup: {
+                subGroups: [],
+                name: 'root',
+                propertyValues: {},
+                data: [],
+            },
+            groupingProperties,
+            depth: groupingProperties ? groupingProperties.length : 0,
+        };
+        this.buildChildDataGroups(data, structure.rootGroup, groupingProperties, leafNodeDataCount, 0, groupMultiSelectInSeparateFrame);
+        return structure;
+    }
+    static createPartitionedGroupsFromData(parentGroup, data, leafNodeDataCount) {
+        const dataLength = data.length;
+        const frameCount = Math.ceil(dataLength / leafNodeDataCount);
+        const groups = [];
+        for (let i = 1; i <= frameCount; i++) {
+            const startIndex = (i - 1) * leafNodeDataCount;
+            const endIndex = startIndex + leafNodeDataCount;
+            let groupData = data.slice(startIndex, endIndex);
+            const group = {
+                data: groupData,
+                subGroups: [],
+                name: parentGroup.name,
+                propertyValues: parentGroup.propertyValues,
+            };
+            groups.push(group);
+        }
+        return groups;
+    }
+}
+exports.DataGroupGenerator = DataGroupGenerator;

package/lib/data-group-generator/index.d.ts

@@ -1 +1 @@
-export * from './data-group-generator';
+export * from './data-group-generator';

package/lib/data-group-generator/index.js

@@ -1,17 +1,17 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./data-group-generator"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./data-group-generator"), exports);

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-export * from './interfaces';
-export * from './data-group-generator';
+export * from './interfaces';
+export * from './data-group-generator';

package/lib/index.js

@@ -1,19 +1,18 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./interfaces"), exports);
-;
-__exportStar(require("./data-group-generator"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./data-group-generator"), exports);

package/lib/interfaces.d.ts

@@ -1,31 +1,31 @@
-import { TypeProperty } from "@contrail/types";
-export interface DataGroup {
-    subGroups: Array<DataGroup>;
-    name: string;
-    propertyValues: {
-        [key: string]: any;
-    };
-    aggregateValues?: {
-        [key: string]: any;
-    };
-    data: Array<any>;
-    isSecondaryGroup?: boolean;
-}
-export interface DataGroupStructure {
-    rootGroup: DataGroup;
-    depth: number;
-    groupingProperties: Array<DataGroupingProperty>;
-    aggregationProperties?: Array<DataGroupingProperty>;
-    sourceDataDefinition?: {
-        sourceDataReference: string;
-        filterDefinition?: any;
-        sortDefinition?: any;
-    };
-}
-export interface DataGroupingProperty {
-    propertyDefinition: TypeProperty;
-    values?: Array<string>;
-    typeRootSlug: string;
-    sort: string;
-    isSecondaryGroup?: boolean;
-}
+import { TypeProperty } from '@contrail/types';
+export interface DataGroup {
+    subGroups: Array<DataGroup>;
+    name: string;
+    propertyValues: {
+        [key: string]: any;
+    };
+    aggregateValues?: {
+        [key: string]: any;
+    };
+    data: Array<any>;
+    isSecondaryGroup?: boolean;
+}
+export interface DataGroupStructure {
+    rootGroup: DataGroup;
+    depth: number;
+    groupingProperties: Array<DataGroupingProperty>;
+    aggregationProperties?: Array<DataGroupingProperty>;
+    sourceDataDefinition?: {
+        sourceDataReference: string;
+        filterDefinition?: any;
+        sortDefinition?: any;
+    };
+}
+export interface DataGroupingProperty {
+    propertyDefinition: TypeProperty;
+    values?: Array<string>;
+    typeRootSlug: string;
+    sort: string;
+    isSecondaryGroup?: boolean;
+}

package/lib/interfaces.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,44 +1,44 @@
-{
-  "name": "@contrail/data-grouping",
-  "version": "1.0.24",
-  "description": "Utilities and interfaces for grouping data into hierarchial data structures based on properties.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-    "lint": "tslint -p tsconfig.json",
-    "test": "jest"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@contrail/util": "^1.0.34",
-    "@types/jest": "^29.5.2",
-    "jest": "^29.5.0",
-    "prettier": "^1.19.1",
-    "ts-jest": "^29.1.1",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^4.0.0"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".spec.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
-  },
-  "dependencies": {
-    "@contrail/documents": "^1.0.38",
-    "@contrail/types": "^3.0.27"
-  }
-}
+{
+  "name": "@contrail/data-grouping",
+  "version": "1.0.25",
+  "description": "Utilities and interfaces for grouping data into hierarchial data structures based on properties.",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "lint": "tslint -p tsconfig.json",
+    "test": "jest"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@contrail/util": "^1.0.62",
+    "@types/jest": "^29.5.2",
+    "jest": "^29.5.0",
+    "prettier": "^1.19.1",
+    "ts-jest": "^29.1.1",
+    "tslint": "^5.11.0",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^4.0.0"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  },
+  "dependencies": {
+    "@contrail/documents": "^1.0.38",
+    "@contrail/types": "^3.0.27"
+  }
+}