@contrail/flexplm 1.3.0 → 1.3.1-alpha.3507ab6

package/lib/util/type-utils.d.ts

@@ -1,13 +1,34 @@
-import { TypeClientOptions } from '@contrail/sdk';
-import { TypeProperty } from '@contrail/types';
-export declare class TypeUtils {
-    private typesObj;
-    constructor();
-    getTypeById(id: any): Promise<import("@contrail/types").Type>;
-    getByRootAndPath(options: TypeClientOptions): Promise<import("@contrail/types").Type>;
-    static getFlexPLMTypePath(entity: any): any;
-    getEventObjectClass(entityType: string, newData: any): string;
-    getEntityTypeClientOptionsUsingMapping(transformMapFile: any, mapFileUtil: any, data: any): Promise<TypeClientOptions>;
-    getEntityTypeClientOptions(objectClass: string, data: any): TypeClientOptions;
-    filterTypeProperties(type: any, newData: any): TypeProperty[];
-}
+import { TypeClientOptions } from '@contrail/sdk';
+import { TypeProperty } from '@contrail/types';
+export declare class TypeUtils {
+    private typesObj;
+    constructor();
+    getTypeById(id: any): Promise<import("@contrail/types").Type>;
+    getByRootAndPath(options: TypeClientOptions): Promise<import("@contrail/types").Type>;
+    /** Deprecated: use TypeConversionUtils.getObjectTypePath() */
+    static getFlexPLMTypePath(entity: any): any;
+    /**  Deprecated: use TypeConversionUtils.getObjectClass()
+     *
+     * @param entityType
+     * @param newData
+     * @returns
+     */
+    getEventObjectClass(entityType: string, newData: any): string;
+    /** Gets the VibeIQ entity type for the object data
+     * @param data: object data
+     */
+    getEntityTypeClientOptionsUsingMapping(transformMapFile: any, mapFileUtil: any, data: any): Promise<TypeClientOptions>;
+    /** Gets the VibeIQ entity type for the object data
+     * @param objectClass: string object class
+     * @param data: object data
+     */
+    getEntityTypeClientOptions(objectClass: string, data: any): TypeClientOptions;
+    /** This will filter the properties based the newData entity.
+     * It is assumed the type is correct for the entity
+     *
+     * @param type entire type object
+     * @param newData the entity being processed
+     * @returns TypeProperty[] of applicable properties
+     */
+    filterTypeProperties(type: any, newData: any): TypeProperty[];
+}

package/lib/util/type-utils.js

@@ -1,114 +1,137 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeUtils = void 0;
-const app_framework_1 = require("@contrail/app-framework");
-const sdk_1 = require("@contrail/sdk");
-const type_conversion_utils_1 = require("./type-conversion-utils");
-class TypeUtils {
-    constructor() {
-        this.typesObj = new sdk_1.Types();
-    }
-    async getTypeById(id) {
-        const type = await this.typesObj.getType({
-            id,
-            relations: ['typeProperties', 'typeInterfaces']
-        });
-        return type;
-    }
-    async getByRootAndPath(options) {
-        const type = await this.typesObj.getByRootAndPath(options);
-        return type;
-    }
-    static getFlexPLMTypePath(entity) {
-        return entity['flexPLMTypePath'] || entity['flexTypePath'] || '';
-    }
-    getEventObjectClass(entityType, newData) {
-        let objectClass = '';
-        if ('item' === entityType) {
-            if (newData.roles.includes('family')) {
-                objectClass = 'LCSProduct';
-            }
-            else if (newData.roles.includes('color')) {
-                objectClass = 'LCSSKU';
-            }
-        }
-        else if ('project-item' === entityType) {
-            if (newData.roles.includes('family')) {
-                objectClass = 'LCSProductSeasonLink';
-            }
-            else if (newData.roles.includes('color')) {
-                objectClass = 'LCSSKUSeasonLink';
-            }
-        }
-        else if ('color' === entityType) {
-            objectClass = 'LCSColor';
-        }
-        else if ('custom-entity' === entityType) {
-            objectClass = 'LCSRevisableEntity';
-        }
-        return objectClass;
-    }
-    async getEntityTypeClientOptionsUsingMapping(transformMapFile, mapFileUtil, data) {
-        const root = await type_conversion_utils_1.TypeConversionUtils.getEntityClassFromObject(transformMapFile, mapFileUtil, data);
-        const path = await type_conversion_utils_1.TypeConversionUtils.getEntityTypePathFromOjbect(transformMapFile, mapFileUtil, data);
-        let tco = {
-            root,
-            path
-        };
-        return tco;
-    }
-    getEntityTypeClientOptions(objectClass, data) {
-        let tco;
-        if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
-            tco = {
-                root: 'item'
-            };
-        }
-        else if ('LCSSeason' === objectClass) {
-            tco = {
-                root: 'assortment'
-            };
-        }
-        else if ('LCSColor' === objectClass) {
-            tco = {
-                root: 'color'
-            };
-        }
-        else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
-            tco = {
-                root: 'custom-entity'
-            };
-            console.log('data: ' + data);
-        }
-        return tco;
-    }
-    filterTypeProperties(type, newData) {
-        let filteredProps = type['typeProperties'];
-        const typePath = type['typePath'];
-        const roles = newData['roles'];
-        if (typePath && (typePath.startsWith('item') || typePath.startsWith('project-item'))) {
-            if (app_framework_1.Logger.isDebugOn()) {
-                console.debug('filterTypeProperties():id: ' + newData?.id
-                    + ', typePath: ' + typePath
-                    + ', newData.roles: ' + newData?.roles);
-            }
-            if (roles) {
-                const isFamily = roles.includes('family');
-                if (app_framework_1.Logger.isDebugOn()) {
-                    console.debug('isFamily: ' + isFamily);
-                }
-                filteredProps = filteredProps.filter(prop => {
-                    const propertyLevel = prop.propertyLevel;
-                    const applies = (isFamily && 'option' != propertyLevel) ||
-                        (!isFamily && 'family' != propertyLevel);
-                    return applies;
-                });
-            }
-            else {
-                console.error('filterTypeProperties():Entity missing role-id: ' + newData['id']);
-            }
-        }
-        return filteredProps;
-    }
-}
-exports.TypeUtils = TypeUtils;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeUtils = void 0;
+const app_framework_1 = require("@contrail/app-framework");
+const sdk_1 = require("@contrail/sdk");
+const type_conversion_utils_1 = require("./type-conversion-utils");
+class TypeUtils {
+    constructor() {
+        this.typesObj = new sdk_1.Types();
+    }
+    async getTypeById(id) {
+        // this.logger.log('!-getTypeById: ' + id);
+        const type = await this.typesObj.getType({
+            id,
+            relations: ['typeProperties', 'typeInterfaces']
+        });
+        return type;
+    }
+    async getByRootAndPath(options) {
+        const type = await this.typesObj.getByRootAndPath(options);
+        return type;
+    }
+    /** Deprecated: use TypeConversionUtils.getObjectTypePath() */
+    static getFlexPLMTypePath(entity) {
+        return entity['flexPLMTypePath'] || entity['flexTypePath'] || '';
+    }
+    /**  Deprecated: use TypeConversionUtils.getObjectClass()
+     *
+     * @param entityType
+     * @param newData
+     * @returns
+     */
+    getEventObjectClass(entityType, newData) {
+        let objectClass = '';
+        if ('item' === entityType) {
+            if (newData.roles.includes('family')) {
+                objectClass = 'LCSProduct';
+            }
+            else if (newData.roles.includes('color')) {
+                objectClass = 'LCSSKU';
+            }
+        }
+        else if ('project-item' === entityType) {
+            if (newData.roles.includes('family')) {
+                objectClass = 'LCSProductSeasonLink';
+            }
+            else if (newData.roles.includes('color')) {
+                objectClass = 'LCSSKUSeasonLink';
+            }
+        }
+        else if ('color' === entityType) {
+            objectClass = 'LCSColor';
+        }
+        else if ('custom-entity' === entityType) {
+            objectClass = 'LCSRevisableEntity';
+        }
+        return objectClass;
+    }
+    /** Gets the VibeIQ entity type for the object data
+     * @param data: object data
+     */
+    async getEntityTypeClientOptionsUsingMapping(transformMapFile, mapFileUtil, data) {
+        const root = await type_conversion_utils_1.TypeConversionUtils.getEntityClassFromObject(transformMapFile, mapFileUtil, data);
+        const path = await type_conversion_utils_1.TypeConversionUtils.getEntityTypePathFromOjbect(transformMapFile, mapFileUtil, data);
+        let tco = {
+            root,
+            path
+        };
+        return tco;
+    }
+    /** Gets the VibeIQ entity type for the object data
+     * @param objectClass: string object class
+     * @param data: object data
+     */
+    getEntityTypeClientOptions(objectClass, data) {
+        let tco;
+        if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
+            tco = {
+                root: 'item'
+            };
+        }
+        else if ('LCSSeason' === objectClass) {
+            tco = {
+                root: 'assortment'
+            };
+        }
+        else if ('LCSColor' === objectClass) {
+            tco = {
+                root: 'color'
+            };
+        }
+        else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
+            //TODO need to write logic using mapping file
+            tco = {
+                root: 'custom-entity'
+            };
+            console.log('data: ' + data);
+        }
+        return tco;
+    }
+    /** This will filter the properties based the newData entity.
+     * It is assumed the type is correct for the entity
+     *
+     * @param type entire type object
+     * @param newData the entity being processed
+     * @returns TypeProperty[] of applicable properties
+     */
+    filterTypeProperties(type, newData) {
+        let filteredProps = type['typeProperties'];
+        const typePath = type['typePath'];
+        const roles = newData['roles'];
+        if (typePath && (typePath.startsWith('item') || typePath.startsWith('project-item'))) {
+            if (app_framework_1.Logger.isDebugOn()) {
+                console.debug('filterTypeProperties():id: ' + newData?.id
+                    + ', typePath: ' + typePath
+                    + ', newData.roles: ' + newData?.roles);
+            }
+            if (roles) {
+                const isFamily = roles.includes('family');
+                if (app_framework_1.Logger.isDebugOn()) {
+                    console.debug('isFamily: ' + isFamily);
+                }
+                filteredProps = filteredProps.filter(prop => {
+                    const propertyLevel = prop.propertyLevel;
+                    const applies = (isFamily && 'option' != propertyLevel) ||
+                        (!isFamily && 'family' != propertyLevel);
+                    return applies;
+                });
+            }
+            else {
+                console.error('filterTypeProperties():Entity missing role-id: ' + newData['id']);
+            }
+        }
+        return filteredProps;
+    }
+}
+exports.TypeUtils = TypeUtils;

package/lib/util/type-utils.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};