@contrail/data-grouping 1.0.4 → 1.0.6

package/README.md

@@ -1,2 +1,2 @@
-Library for use with @contrail/documents that allows for the quick/automation generation of 
+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

@@ -0,0 +1,6 @@
+import { DataGroup, DataGroupStructure, DataGroupingProperty } from "../interfaces";
+export declare class DataGroupGenerator {
+    static buildChildDataGroups(data: any, parentGroup: DataGroup, groupingProperties: any, leafNodeDataCount: any, currentDepth: any): void;
+    static buildDataGroupStructure(data: Array<any>, groupingProperties: Array<DataGroupingProperty>, leafNodeDataCount: number, currentDepth?: number): DataGroupStructure;
+    static createFrameGroupsForData(parentGroup: DataGroup, data: Array<any>, leafNodeDataCount: number): Array<DataGroup>;
+}

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

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataGroupGenerator = void 0;
+const util_1 = require("@contrail/util");
+class DataGroupGenerator {
+    static buildChildDataGroups(data, parentGroup, groupingProperties, leafNodeDataCount, currentDepth) {
+        const groupingProperty = groupingProperties[currentDepth];
+        const index = groupingProperty.scope + "." + groupingProperty.property.slug;
+        const distinctValues = [...new Set(data.filter(obj => util_1.ObjectUtil.getByPath(obj, index))
+                .map(obj => util_1.ObjectUtil.getByPath(obj, index)))
+        ].sort((v1, v2) => {
+            return v1 > v2 ? 1 : -1;
+        });
+        for (let val of distinctValues) {
+            const groupData = data.filter(obj => util_1.ObjectUtil.getByPath(obj, index) === val);
+            const group = {
+                data: [],
+                subGroups: [],
+                properties: {},
+                name: ''
+            };
+            group.properties[groupingProperty.property.slug] = val;
+            group.name = val;
+            if (currentDepth === groupingProperties.length - 1) {
+                group.subGroups = this.createFrameGroupsForData(group, groupData, leafNodeDataCount);
+            }
+            else if (currentDepth < groupingProperties.length - 1) {
+                this.buildChildDataGroups(groupData, group, groupingProperties, leafNodeDataCount, currentDepth + 1);
+            }
+            parentGroup.subGroups.push(group);
+        }
+    }
+    static buildDataGroupStructure(data, groupingProperties, leafNodeDataCount, currentDepth = 0) {
+        const structure = {
+            rootGroup: {
+                subGroups: [],
+                name: "root",
+                properties: {},
+                data: [],
+            },
+            groupingProperties: [],
+            depth: groupingProperties ? groupingProperties.length + 1 : 0,
+        };
+        this.buildChildDataGroups(data, structure.rootGroup, groupingProperties, leafNodeDataCount, 0);
+        return structure;
+    }
+    static createFrameGroupsForData(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,
+                properties: parentGroup.properties,
+            };
+            groups.push(group);
+        }
+        return groups;
+    }
+}
+exports.DataGroupGenerator = DataGroupGenerator;

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

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

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

@@ -0,0 +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);

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,17 +1,19 @@
-"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);
+"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,14 +1,20 @@
-import { TypeProperty } from "@contrail/types";
-export interface DataGroup {
-    subGroups: Array<DataGroup>;
-    name: string;
-    properties: {
-        [key: string]: any;
-    };
-    data: Array<any>;
-}
-export interface DataGroupStructure {
-    rootGroup: DataGroup;
-    depth: number;
-    groupingProperties: Array<TypeProperty>;
-}
+import { TypeProperty } from "@contrail/types";
+export interface DataGroup {
+    subGroups: Array<DataGroup>;
+    name: string;
+    properties: {
+        [key: string]: any;
+    };
+    data: Array<any>;
+}
+export interface DataGroupStructure {
+    rootGroup: DataGroup;
+    depth: number;
+    groupingProperties: Array<DataGroupingProperty>;
+}
+export interface DataGroupingProperty {
+    property: TypeProperty;
+    values?: Array<string>;
+    scope: string;
+    sort: string;
+}

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,43 +1,43 @@
-{
-  "name": "@contrail/data-grouping",
-  "version": "1.0.4",
-  "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": {
-    "@types/jest": "^23.3.14",
-    "jest": "^23.6.0",
-    "prettier": "^1.19.1",
-    "ts-jest": "^23.10.5",
-    "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.6",
+  "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": {
+    "@types/jest": "^23.3.14",
+    "jest": "^23.6.0",
+    "prettier": "^1.19.1",
+    "ts-jest": "^23.10.5",
+    "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"
+  }
+}