@contrail/flexplm 1.3.2-alpha.30ca8bf → 1.3.2-alpha.3ffe557

package/lib/util/type-conversion-utils.js

@@ -3,9 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypeConversionUtils = void 0;
 const type_defaults_1 = require("./type-defaults");
 const map_utils_1 = require("./map-utils");
+/** This class is helper functions to get the data for converting
+ * VibeIQ entities to / from FlexPLM Objects
+*/
 class TypeConversionUtils {
     constructor() {
     }
+    /** Takes in a VibeIQ entity object and returns the correct FlexPLM
+     * object class associated to the entity. Order of precedence
+     * Property 'flexPLMObjectClass'
+     * Map file entry in 'typeConversion:vibe2flex:<value>:getObjectClass()'
+     *  for value from 'entityClass' or root from 'typePath'
+     * TypeDefaults.getDefaultObjectClass() function
+     * @param transformMapFile id for mapFile
+     * @param mapFileUtil class to get mapfile
+     * @param entity
+     * @returns Promise<string>
+     */
     static async getObjectClass(transformMapFile, mapFileUtil, entity) {
         let objectClass = entity['flexPLMObjectClass'];
         if (objectClass) {
@@ -23,6 +37,18 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultObjectClass(entity);
     }
+    /** Takes in a VibeIQ entity object and returns the correct FlexPLM
+     * FlexType associated to the entity. Order of precedence
+     * Property 'flexPLMTypePath'
+     * Map file entry in 'typeConversion:vibe2flex:<value>:getSoftType()'
+     *  for value from 'entityClass' or root from 'typePath'
+     * TypeDefaults.getDefaultObjectTypePath() function
+     *
+     * @param transformMapFile id for mapFile
+     * @param mapFileUtil class to get mapfile
+     * @param entity VibeIQ entity
+     * @returns Promise<string>
+     */
     static async getObjectTypePath(transformMapFile, mapFileUtil, entity) {
         let typePath = entity['flexPLMTypePath'];
         if (typePath) {
@@ -40,6 +66,18 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultObjectTypePath(entity);
     }
+    /**Takes in a VibeIQ entity object and returns the correct
+     * identifier properties.  Order of precedence
+     * Property 'flexPLMIdentifierProperties'
+     * Map file entry in 'typeConversion:vibe2flex:<value>:getIdentifierProperties()'
+     *  for value from 'entityClass' or root from 'typePath'
+     * TypeDefaults.getDefaultIdentifierProperties() function
+     *
+     * @param transformMapFile id for mapFile
+     * @param mapFileUtil class to get mapfile
+     * @param entity
+     * @returns Promise<string[]>
+     */
     static async getIdentifierProperties(transformMapFile, mapFileUtil, entity) {
         let identifiers = entity['flexPLMIdentifierProperties'];
         if (identifiers) {
@@ -57,6 +95,18 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultIdentifierProperties(entity);
     }
+    /**Takes in a VibeIQ entity object and returns the correct
+   * informational properties.  Order of precedence
+   * Property 'flexPLMInformationalProperties'
+   * Map file entry in 'typeConversion:vibe2flex:<value>:getInformationalProperties()'
+   *  for value from 'entityClass' or root from 'typePath'
+   * TypeDefaults.getDefaultObjectTypePath() function
+   *
+   * @param transformMapFile id for mapFile
+   * @param mapFileUtil class to get mapfile
+   * @param entity
+   * @returns string
+   */
     static async getInformationalProperties(transformMapFile, mapFileUtil, entity) {
         let identifiers = entity['flexPLMInformationalProperties'];
         if (identifiers) {
@@ -74,6 +124,19 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultInformationalProperties(entity);
     }
+    /**Takes in a VibeIQ entity object and returns the correct mapKey
+   * Order of precedence:
+   * Map file entry in 'typeConversion:<direction>:<value>:getObjectClass()'
+   *  for value from 'entityClass' or root from 'typePath'
+   * TypeDefaults.getDefaultObjectClass() function
+     *
+     * @param transformMapFile
+     * @param mapFileUtil
+     * @param entity
+     * @param type
+     * @param direction
+     * @returns
+     */
     static async getMapKey(transformMapFile, mapFileUtil, entity, direction) {
         if (transformMapFile) {
             const type = this.getEntityType(entity);
@@ -85,6 +148,12 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultObjectClass(entity);
     }
+    /** Returns the VibeIQ entity type from an entity.
+     * Throws error if it can't determine the entity type
+     *
+     * @param entity
+     * @returns string
+     */
     static getEntityType(entity) {
         let entityType = entity['entityType'];
         if (!entityType) {
@@ -101,6 +170,18 @@ class TypeConversionUtils {
         }
         return entityType;
     }
+    /** Takes in a FlexPLM object and returns the correct VibeIQ entity
+     * class associated to the object. Order of precedence
+     * Property 'vibeIQEntityClass'
+     * Map file entry in 'typeConversion:flex2vibe:<value>:getObjectClass()'
+     *  for value from 'objectClass'
+     * TypeDefaults.getDefaultEntityClass() function
+     *
+     * @param fileId id for mapFile
+     * @param mapFileUtil class to get mapfile
+     * @param object FlexPLM object
+     * @returns Promise<string>
+     */
     static async getEntityClassFromObject(fileId, mapFileUtil, object) {
         let entityClass = object['vibeIQEntityClass'];
         if (entityClass) {
@@ -118,23 +199,22 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
     }
-    static async getUniquenessPoolKeyFromObject(fileId, mapFileUtil, object) {
-        let uniquenessPool;
-        if (fileId) {
-            const mapKey = await this.getMapKeyFromObject(fileId, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-            if (mapKey) {
-                const mapData = await map_utils_1.MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
-                if (mapData && mapData['uniquenessPool']) {
-                    uniquenessPool = mapData['uniquenessPool'];
-                }
-            }
-        }
-        if (uniquenessPool) {
-            return uniquenessPool;
-        }
-        return type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
-    }
     static async getEntityTypePathFromOjbect(fileId, mapFileUtil, object) {
+        return await this.getEntityTypePathFromObject(fileId, mapFileUtil, object);
+    }
+    /** Takes in a FlexPLM object and returns the correct VibeIQ
+   * type associated to the object. Order of precedence
+   * Property 'vibeIQTypePath'
+   * Map file entry in 'typeConversion:flex2vibe:<value>:getSoftType()'
+   *  for value from 'objectClass' or root from 'flexPLMTypePath'
+   * TypeDefaults.getDefaultEntityTypePath() function
+   *
+   * @param transformMapFile id for mapFile
+   * @param mapFileUtil class to get mapfile
+   * @param entity VibeIQ entity
+   * @returns Promise<string>
+   */
+    static async getEntityTypePathFromObject(fileId, mapFileUtil, object) {
         let typePath = object['vibeIQTypePath'];
         if (typePath) {
             return typePath;
@@ -151,6 +231,18 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object);
     }
+    /**Takes in a FlexPLM object and returns the correct
+   * identifier properties.  Order of precedence
+   * Property 'vibeIQIdentifierProperties'
+   * Map file entry in 'typeConversion:flex2vibe:<value>:getIdentifierProperties()'
+   *  for value from 'objectClass'
+   * TypeDefaults.getDefaultIdentifierPropertiesFromObject() function
+   *
+   * @param transformMapFile id for mapFile
+   * @param mapFileUtil class to get mapfile
+   * @param object
+   * @returns Promise<string[]>
+   */
     static async getIdentifierPropertiesFromObject(fileId, mapFileUtil, object) {
         let identifiers = object['vibeIQIdentifierProperties'];
         if (identifiers) {
@@ -168,6 +260,18 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultIdentifierPropertiesFromObject(object);
     }
+    /**Takes in a FlexPLM object and returns the correct
+ * identifier properties.  Order of precedence
+ * Property 'vibeIQIdentifierProperties'
+ * Map file entry in 'typeConversion:flex2vibe:<value>:getInformationalProperties()'
+ *  for value from 'objectClass'
+ * TypeDefaults.getDefaultIdentifierPropertiesFromObject() function
+ *
+ * @param transformMapFile id for mapFile
+ * @param mapFileUtil class to get mapfile
+ * @param object
+ * @returns Promise<string[]>
+ */
     static async getInformationalPropertiesFromObject(fileId, mapFileUtil, object) {
         let identifiers = object['vibeIQInformationalProperties'];
         if (identifiers) {
@@ -195,6 +299,7 @@ class TypeConversionUtils {
             }
             return type;
         }
+        //TODO use TypeDefaults?
     }
     static async isInboundCreatableFromObject(fileId, mapFileUtil, object, context) {
         let isInboundCreatable = false;
@@ -228,6 +333,17 @@ class TypeConversionUtils {
         }
         return isOutboundCreatable;
     }
+    /** Takes in a FlexPLM object and determines whether inbound
+     * images should be synced. In most cases, the creation owning system
+     * will also control image syncing. Defaults to false if no mapping exists.
+     * Map file entry in '<mapKey>:syncInboundImages()'
+     *
+     * @param fileId id for mapFile
+     * @param mapFileUtil class to get mapfile
+     * @param object FlexPLM object
+     * @param context optional context object
+     * @returns Promise<boolean>
+     */
     static async syncInboundImages(fileId, mapFileUtil, object, context) {
         let syncImages = false;
         if (!fileId) {
@@ -249,6 +365,17 @@ class TypeConversionUtils {
         }
         return syncImages;
     }
+    /** Takes in a VibeIQ entity object and determines whether outbound
+     * images should be synced. In most cases, the creation owning system
+     * will also control image syncing. Defaults to true if no mapping exists.
+     * Map file entry in '<mapKey>:syncOutboundImages()'
+     *
+     * @param fileId id for mapFile
+     * @param mapFileUtil class to get mapfile
+     * @param entity VibeIQ entity
+     * @param context optional context object
+     * @returns Promise<boolean>
+     */
     static async syncOutboundImages(fileId, mapFileUtil, entity, context) {
         let syncImages = true;
         if (!fileId) {

package/lib/util/type-conversion-utils.spec.js

@@ -328,65 +328,6 @@ describe('conversion-utils', () => {
             }
         });
     });
-    describe('getUniquenessPoolKeyFromObject', () => {
-        const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
-        it('uses mapping-catName', async () => {
-            const expectedPool = 'catName-pool';
-            const object = {
-                flexPLMObjectClass: 'LCSLast',
-                flexPLMTypePath: 'Last\\catName'
-            };
-            const spy = jest.spyOn(mapFileUtil, 'getMapFile')
-                .mockImplementation(async () => {
-                return mapping;
-            });
-            try {
-                const results = await type_conversion_utils_1.TypeConversionUtils.getUniquenessPoolKeyFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object);
-                expect(results).toEqual(expectedPool);
-            }
-            finally {
-                spy.mockRestore();
-            }
-        });
-        it('uses default-noMap', async () => {
-            const expectedClass = 'color';
-            const object = {
-                flexPLMObjectClass: 'LCSColor',
-                flexPLMTypePath: 'Color'
-            };
-            const spy = jest.spyOn(mapFileUtil, 'getMapFile')
-                .mockImplementation(async () => {
-                return mapping;
-            });
-            const spyDefaults = jest.spyOn(type_defaults_1.TypeDefaults, 'getDefaultEntityClass')
-                .mockImplementation(() => expectedClass);
-            try {
-                const results = await type_conversion_utils_1.TypeConversionUtils.getUniquenessPoolKeyFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object);
-                expect(results).toEqual(expectedClass);
-                expect(spyDefaults).toBeCalledTimes(1);
-            }
-            finally {
-                spy.mockRestore();
-                spyDefaults.mockRestore();
-            }
-        });
-        it('uses default-noFileId', async () => {
-            const expectedClass = 'color';
-            const object = {
-                flexPLMObjectClass: 'LCSColor',
-            };
-            const spyDefaults = jest.spyOn(type_defaults_1.TypeDefaults, 'getDefaultEntityClass')
-                .mockImplementation(() => expectedClass);
-            try {
-                const results = await type_conversion_utils_1.TypeConversionUtils.getUniquenessPoolKeyFromObject(null, mapFileUtil, object);
-                expect(results).toEqual(expectedClass);
-                expect(spyDefaults).toBeCalledTimes(1);
-            }
-            finally {
-                spyDefaults.mockRestore();
-            }
-        });
-    });
     describe('getEntityTypePathFromOjbect', () => {
         const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
         it('vibeIQTypePath', async () => {

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

@@ -3,14 +3,72 @@ export declare class TypeDefaults {
     static NO_OBJECT_CLASS: string;
     static NO_TYPE_PATH: string;
     constructor();
+    /**Takes in full entity and returs the default FlexPLM
+     * object class.
+     *
+     * @param entity
+     * @returns string
+     */
     static getDefaultObjectClass(entity: any): string;
+    /**Takes in full entity and returns the default FlexPLM type path
+     * object class.
+     *
+     * @param entity
+     * @returns string
+     */
     static getDefaultObjectTypePath(entity: any): string;
+    /**Takes in full entity and returns the slugs for the default identifier
+     *  properties. These properties are used when searching for an entity
+     * object class.
+     *
+     * @param entity
+     * @returns string[]
+     */
     static getDefaultIdentifierProperties(entity: any): string[];
+    /** Takes in full entity and returns the slugs for informational
+     * properties.  These properties are helpful when debugging issues
+     * where the identifier properties don't find a match.
+     *
+     * @param entity
+     * @returns string[]
+     */
     static getDefaultInformationalProperties(entity: any): string[];
+    /** Returns the VibeIQ entity type from an entity.
+     * Throws error if it can't determine the entity type
+     *
+     * @param entity
+     * @returns string
+     */
     static getEntityType(entity: any): any;
+    /**Takes in full object and returns the default VibeIQ
+   * entity class.
+   *
+   * @param entity
+   * @returns string
+   */
     static getDefaultEntityClass(object: any): string;
+    /**Takes in full object and returns the default VibeIQ type path
+   * object class.
+   *
+   * @param object
+   * @returns string
+   */
     static getDefaultEntityTypePath(object: any): string;
+    /**Takes in full entity and returns the slugs for the default identifier
+ *  properties. These properties are used when searching for an entity
+ * object class.
+ *
+ * @param entity
+ * @returns string[]
+ */
     static getDefaultIdentifierPropertiesFromObject(object: any): string[];
+    /** Takes in full object and returns the slugs for informational
+   * properties.  These properties are helpful when debugging issues
+   * where the identifier properties don't find a match.
+   *
+   * @param object
+   * @returns string[]
+   */
     static getDefaultInformationalPropertiesFromObject(object: any): string[];
     static getObjectClass(object: any): string;
 }

package/lib/util/type-defaults.js

@@ -4,6 +4,12 @@ exports.TypeDefaults = void 0;
 class TypeDefaults {
     constructor() {
     }
+    /**Takes in full entity and returs the default FlexPLM
+     * object class.
+     *
+     * @param entity
+     * @returns string
+     */
     static getDefaultObjectClass(entity) {
         const entityType = this.getEntityType(entity);
         let objectClass = '';
@@ -42,6 +48,12 @@ class TypeDefaults {
         }
         return objectClass;
     }
+    /**Takes in full entity and returns the default FlexPLM type path
+     * object class.
+     *
+     * @param entity
+     * @returns string
+     */
     static getDefaultObjectTypePath(entity) {
         let typePath = '';
         const entityType = this.getEntityType(entity);
@@ -70,6 +82,13 @@ class TypeDefaults {
         }
         return typePath;
     }
+    /**Takes in full entity and returns the slugs for the default identifier
+     *  properties. These properties are used when searching for an entity
+     * object class.
+     *
+     * @param entity
+     * @returns string[]
+     */
     static getDefaultIdentifierProperties(entity) {
         const identifierProps = [];
         const entityType = this.getEntityType(entity);
@@ -95,6 +114,13 @@ class TypeDefaults {
         }
         return identifierProps;
     }
+    /** Takes in full entity and returns the slugs for informational
+     * properties.  These properties are helpful when debugging issues
+     * where the identifier properties don't find a match.
+     *
+     * @param entity
+     * @returns string[]
+     */
     static getDefaultInformationalProperties(entity) {
         const entityType = this.getEntityType(entity);
         let properties = [];
@@ -111,6 +137,12 @@ class TypeDefaults {
         }
         return properties;
     }
+    /** Returns the VibeIQ entity type from an entity.
+     * Throws error if it can't determine the entity type
+     *
+     * @param entity
+     * @returns string
+     */
     static getEntityType(entity) {
         let entityType = entity['entityType'];
         if (!entityType) {
@@ -127,6 +159,12 @@ class TypeDefaults {
         }
         return entityType;
     }
+    /**Takes in full object and returns the default VibeIQ
+   * entity class.
+   *
+   * @param entity
+   * @returns string
+   */
     static getDefaultEntityClass(object) {
         let entityClass = '';
         let objectClass = TypeDefaults.getObjectClass(object);
@@ -149,6 +187,12 @@ class TypeDefaults {
             throw Error(TypeDefaults.NO_OBJECT_CLASS);
         return entityClass;
     }
+    /**Takes in full object and returns the default VibeIQ type path
+   * object class.
+   *
+   * @param object
+   * @returns string
+   */
     static getDefaultEntityTypePath(object) {
         let typePath = '';
         const objectClass = TypeDefaults.getObjectClass(object);
@@ -173,6 +217,13 @@ class TypeDefaults {
             throw Error(TypeDefaults.NO_TYPE_PATH);
         return typePath;
     }
+    /**Takes in full entity and returns the slugs for the default identifier
+ *  properties. These properties are used when searching for an entity
+ * object class.
+ *
+ * @param entity
+ * @returns string[]
+ */
     static getDefaultIdentifierPropertiesFromObject(object) {
         const identifierProps = [];
         const objectClass = TypeDefaults.getObjectClass(object);
@@ -197,6 +248,13 @@ class TypeDefaults {
         }
         return identifierProps;
     }
+    /** Takes in full object and returns the slugs for informational
+   * properties.  These properties are helpful when debugging issues
+   * where the identifier properties don't find a match.
+   *
+   * @param object
+   * @returns string[]
+   */
     static getDefaultInformationalPropertiesFromObject(object) {
         const objectClass = TypeDefaults.getObjectClass(object);
         let properties = [];

package/lib/util/type-defaults.spec.js

@@ -304,7 +304,7 @@ describe('Type Defaults', () => {
             expect(() => type_defaults_1.TypeDefaults.getEntityType(entity)).toThrowError();
             expect(() => type_defaults_1.TypeDefaults.getEntityType(entity)).toThrow(type_defaults_1.TypeDefaults.NO_ENTITY_TYPE);
         });
-    });
+    }); //getEntityType
     describe('getDefaultEntityClass', () => {
         it('item - LCSProduct', () => {
             const object = {
@@ -369,7 +369,7 @@ describe('Type Defaults', () => {
             const entityClass = type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
             expect(entityClass).toBe('custom-entity');
         });
-    });
+    }); //getDefaultEntityClass
     describe('getDefaultEntityTypePath', () => {
         it('LCSProduct', () => {
             const object = {
@@ -420,7 +420,7 @@ describe('Type Defaults', () => {
             const typePath = type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object);
             expect(typePath).toBe('assortment');
         });
-    });
+    }); //getDefaultEntityTypePath
     describe('getDefaultIdentifierPropertiesFromObject', () => {
         it('LCSProduct', () => {
             const object = {
@@ -478,7 +478,7 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-    });
+    }); //getDefaultIdentifierPropertiesFromObject
     describe('getDefaultInformationalPropertiesFromObject', () => {
         it('LCSProduct', () => {
             const object = {
@@ -512,5 +512,5 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-    });
+    }); //getDefaultInformationalPropertiesFromObject
 });

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

@@ -5,9 +5,30 @@ export declare class TypeUtils {
     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

@@ -9,6 +9,7 @@ class TypeUtils {
         this.typesObj = new sdk_1.Types();
     }
     async getTypeById(id) {
+        // this.logger.log('!-getTypeById: ' + id);
         const type = await this.typesObj.getType({
             id,
             relations: ['typeProperties', 'typeInterfaces']
@@ -19,9 +20,16 @@ class TypeUtils {
         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) {
@@ -48,6 +56,9 @@ class TypeUtils {
         }
         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);
@@ -57,6 +68,10 @@ class TypeUtils {
         };
         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)) {
@@ -75,6 +90,7 @@ class TypeUtils {
             };
         }
         else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
+            //TODO need to write logic using mapping file
             tco = {
                 root: 'custom-entity'
             };
@@ -82,6 +98,13 @@ class TypeUtils {
         }
         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'];

package/lib/util/type-utils.spec.js

@@ -103,6 +103,7 @@ describe('filterProperties-item', () => {
         expect(filteredProps.length).toEqual(len);
     });
 });
+//project-item
 describe('filterProperties-project-item', () => {
     const projectItemType = {
         typePath: 'project-item'
@@ -152,6 +153,7 @@ describe('filterProperties-project-item', () => {
         expect(filteredProps.length).toEqual(len);
     });
 });
+//color
 describe('filterProperties-color', () => {
     const colorType = {
         typePath: 'color'