@contrail/flexplm 1.3.0-alpha.ccc03be → 1.3.1-alpha.3e8dbdd

package/lib/publish/base-process-publish-assortment.spec.js

@@ -13,6 +13,7 @@ let federatedId = '';
 jest.mock('../util/data-converter', () => {
     return {
         DataConverter: class {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-vars
             getFlexPLMObjectData(newData, dataToSkip, inflateObjRef) {
                 return newData;
             }
@@ -95,6 +96,7 @@ describe('getPublishInfo', () => {
             return { id: assortmentId, name: assortmentName };
         });
         const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
             .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
             return versionHistoryNumber;
         });
@@ -120,6 +122,7 @@ describe('getPublishInfo', () => {
             return { id: assortmentId, name: undefined };
         });
         const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
             .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
             return versionHistoryNumber;
         });
@@ -145,6 +148,7 @@ describe('getPublishInfo', () => {
             return undefined;
         });
         const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
             .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
             return versionHistoryNumber;
         });
@@ -179,6 +183,7 @@ describe('getPublishInfo', () => {
             return { id: assortmentId, name: assortmentName };
         });
         const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
             .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
             return versionHistoryNumber;
         });
@@ -203,6 +208,7 @@ describe('getPublishInfo', () => {
             return { id: assortmentId, name: assortmentName };
         });
         const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
             .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
             return versionHistoryNumber;
         });
@@ -229,6 +235,7 @@ describe('getPublishInfo', () => {
             return { id: assortmentId, name: assortmentName };
         });
         const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
             .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
             return versionHistoryNumber;
         });
@@ -255,6 +262,7 @@ describe('getPublishInfo', () => {
             return { id: assortmentId, name: assortmentName };
         });
         const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
             .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
             return versionHistoryNumber;
         });
@@ -408,6 +416,7 @@ describe('getSnapshotVersion', () => {
             {
                 id: 'qewrwer',
                 assortmentChangeId: 'bad-id',
+                // createdOn: '2023-01-14T19:13:58.902Z',
                 versionNumber
             }
         ];
@@ -1140,6 +1149,7 @@ describe('getItemFamilyChanges', () => {
         const ifcs = pcd.itemFamilyChanges;
         expect(ifcs.size).toEqual(1);
         const ifc = ifcs.get(itemFamilyId);
+        // expect(ifc.familyAdd).toBe(true);
         expect(ifc.colorAdds.length).toEqual(1);
     });
     it('Feb 3 - 2+ Option A', () => {
@@ -1169,6 +1179,7 @@ describe('getItemFamilyChanges', () => {
         const ifcs = pcd.itemFamilyChanges;
         expect(ifcs.size).toEqual(1);
         const ifc = ifcs.get(itemFamilyId);
+        // expect(ifc.familyAdd).toBe(true);
         expect(ifc.colorAdds.length).toEqual(2);
     });
     it('Feb 3 - 2+ Option A & Feb 3 - 1 Option A', () => {
@@ -1300,6 +1311,8 @@ describe('getItemFamilyChanges', () => {
         const ifcs = pcd.itemFamilyChanges;
         expect(ifcs.size).toEqual(1);
         const ifc = ifcs.get(itemFamilyId);
+        //TODO fix
+        // expect(ifc.familyDelete).toBe(true);
         expect(ifc.colorAdds.length).toEqual(0);
         expect(ifc.colorDeletes.length).toEqual(1);
     });
@@ -1572,9 +1585,10 @@ describe('getEventsForItemFamilyChanges - conditional eventType', () => {
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierProperties').mockResolvedValue(['identifier']);
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getInformationalProperties').mockResolvedValue([]);
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'isOutboundCreatableFromEntity')
-            .mockResolvedValueOnce(true)
-            .mockResolvedValueOnce(true);
+            .mockResolvedValueOnce(true) // for family
+            .mockResolvedValueOnce(true); // for SKU
         const events = await bppa.getEventsForItemFamilyChanges(itemFamilyChanges, 'assort123', seasonFed, new Map());
+        // Should have both family and SKU events because familyAssortmentItem is true when colorAdds.length > 0
         expect(events).toHaveLength(2);
         const skuEvent = events.find(e => e.objectClass === 'LCSSKUSeasonLink');
         expect(skuEvent.eventType).toBe('UPSERT_ON_SEASON');
@@ -1613,9 +1627,10 @@ describe('getEventsForItemFamilyChanges - conditional eventType', () => {
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierProperties').mockResolvedValue(['identifier']);
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getInformationalProperties').mockResolvedValue([]);
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'isOutboundCreatableFromEntity')
-            .mockResolvedValueOnce(false)
-            .mockResolvedValueOnce(false);
+            .mockResolvedValueOnce(false) // for family
+            .mockResolvedValueOnce(false); // for SKU
         const events = await bppa.getEventsForItemFamilyChanges(itemFamilyChanges, 'assort123', seasonFed, new Map());
+        // Should have both family and SKU events because familyAssortmentItem is true when colorUpdates.length > 0
         expect(events).toHaveLength(2);
         const skuEvent = events.find(e => e.objectClass === 'LCSSKUSeasonLink');
         expect(skuEvent.eventType).toBe('UPDATE_ON_SEASON');
@@ -1654,6 +1669,7 @@ describe('getEventsForItemFamilyChanges - conditional eventType', () => {
         jest.spyOn(map_utils_1.MapUtil, 'applyTransformMap').mockResolvedValue({ transformedData: 'value' });
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierProperties').mockResolvedValue(['identifier']);
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getInformationalProperties').mockResolvedValue([]);
+        // Product is creatable (true), SKU is not (false)
         jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'isOutboundCreatableFromEntity')
             .mockResolvedValueOnce(true)
             .mockResolvedValueOnce(false);
@@ -1664,7 +1680,9 @@ describe('getEventsForItemFamilyChanges - conditional eventType', () => {
         expect(productEvent.eventType).toBe('UPSERT_ON_SEASON');
         expect(skuEvent.eventType).toBe('UPDATE_ON_SEASON');
         expect(type_conversion_utils_1.TypeConversionUtils.isOutboundCreatableFromEntity).toHaveBeenCalledTimes(2);
+        // Verify product event called with assortment entity
         expect(type_conversion_utils_1.TypeConversionUtils.isOutboundCreatableFromEntity).toHaveBeenNthCalledWith(1, undefined, mapFileUtil, familyProjectItem, { item: prodEntityData, assortment });
+        // Verify SKU event called with assortment entity
         expect(type_conversion_utils_1.TypeConversionUtils.isOutboundCreatableFromEntity).toHaveBeenNthCalledWith(2, undefined, mapFileUtil, colorProjectItem, { item: itemData, assortment });
     });
 });

package/lib/publish/mockData.js

@@ -3399,6 +3399,11 @@ exports.fall_2003_fedMapping = [
         mappedReference: 'VR:com.lcs.wc.product.LCSSKU:372509'
     }
 ];
+//SYHfQzYWlfXDqK7r - 4 adds
+//JreGRNvoJ3FsoRZI - 1 delete
+//NaPUhAdEzKB-5tQ3 - no changes
+//CHGKSCT358qyh1Nu - 1 delete
+//H4L4dHziO6WZRIwa - re-add from JreGRNvoJ3FsoRZI
 exports.apc_2bOWR2j9R0QThDVu_delete_history = [
     {
         adds: 4,

package/lib/transform/identifier-conversion-spec-mockData.js

@@ -31,6 +31,20 @@ exports.mapping = {
                 }
             }
         }
+        // flex2vibe: {
+        //   LCSRevisableEntity: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSLast: {
+        //     getMapKey: (object) => {return object;}
+        //   },
+        //   LCSMaterial: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSBusinessObject: {
+        //     getMapKey: (object) => {return object;}
+        //   }
+        // },
     },
     LCSSeason: {
         vibe2flex: {
@@ -54,7 +68,7 @@ exports.mapping = {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSProduct',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {
@@ -79,7 +93,7 @@ exports.mapping = {
                 vibeIQIdentifier: 'itemNumber'
             },
             valueTransform: {
-                transformEx: (row) => {
+                transformEx: (row /*, dependencies*/) => {
                     return row['otherProp'] + 'xxx';
                 }
             }
@@ -97,7 +111,7 @@ exports.mapping = {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSSKU',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {
@@ -252,6 +266,20 @@ exports.mapping2 = {
                 }
             }
         }
+        // flex2vibe: {
+        //   LCSRevisableEntity: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSLast: {
+        //     getMapKey: (object) => {return object;}
+        //   },
+        //   LCSMaterial: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSBusinessObject: {
+        //     getMapKey: (object) => {return object;}
+        //   }
+        // },
     },
     LCSSeason: {
         getIdentifierProperties: () => ['brand', 'year', 'seasonType'],
@@ -274,7 +302,7 @@ exports.mapping2 = {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSProduct',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {
@@ -299,7 +327,7 @@ exports.mapping2 = {
                 vibeIQIdentifier: 'itemNumber'
             },
             valueTransform: {
-                transformEx: (row) => {
+                transformEx: (row /*, dependencies*/) => {
                     return row['otherProp'] + 'xxx';
                 }
             }
@@ -318,7 +346,7 @@ exports.mapping2 = {
         getIdentifierProperties: () => ['uniqueIdentifierA', 'uniqueIdentifierB'],
         vibe2flex: {
             getClass: () => 'LCSSKU',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {

package/lib/transform/identifier-conversion.d.ts

@@ -5,9 +5,45 @@ export declare class IdentifierConversion {
     static readonly INBOUND_ENTITY_MISSING_IDENIFIER_PROPS = "IdentifierConversion.getEntityCriteriaFromObject(): missing identifier properties: ";
     static readonly MISSING_OBJECT = "IdentifierConversion.getEntityCriteriaFromObject(): missing: object";
     static readonly MISSING_FLEXPLM_OBJECT_CLASS = "IdentifierConversion.getEntityCriteriaFromObject(): missing: flexPLMObjectClass";
+    /** Takes in an assortment and returns an object to query for an LCSSeason
+     * This will only return the identifier properties, and information properties if specified.
+     * @param transformMapFile
+     * @param mapFileUtil
+     * @param dc
+     * @param assortment
+     * @param includeInformationKeys defaults true
+     * @returns
+     */
     static getSeasonIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, assortment: any, includeInformationKeys?: boolean): Promise<SeasonFederation>;
+    /** Takes in an assortment and returns an object to query for an SeasonGroup
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
     static getSeasonGroupIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, assortment: any, includeInformationKeys?: boolean): Promise<SeasonGroupFederation>;
+    /** Takes in an item and returns an object to query for an LCSProduct
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
     static getProductIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, itemFamilyObject: any, includeInformationKeys?: boolean): Promise<ProductFederation>;
+    /** Takes in an item and returns an object to query for an LCSSKU
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
     static getSKUIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, itemObject: any, includeInformationKeys?: boolean): Promise<SkuFederation>;
     static getEntityCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any>;
     static getAssortmentCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any>;

package/lib/transform/identifier-conversion.js

@@ -5,6 +5,15 @@ const map_utils_1 = require("../util/map-utils");
 const type_conversion_utils_1 = require("../util/type-conversion-utils");
 const event_short_message_status_1 = require("../util/event-short-message-status");
 class IdentifierConversion {
+    /** Takes in an assortment and returns an object to query for an LCSSeason
+     * This will only return the identifier properties, and information properties if specified.
+     * @param transformMapFile
+     * @param mapFileUtil
+     * @param dc
+     * @param assortment
+     * @param includeInformationKeys defaults true
+     * @returns
+     */
     static async getSeasonIdentityObject(transformMapFile, mapFileUtil, dc, assortment, includeInformationKeys = true) {
         if (!assortment) {
             throw new Error('IdentifierConversion.getSeasonIdentityObject(): assortment must be provided.');
@@ -49,6 +58,15 @@ class IdentifierConversion {
         }
         return seasonObj;
     }
+    /** Takes in an assortment and returns an object to query for an SeasonGroup
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
     static async getSeasonGroupIdentityObject(transformMapFile, mapFileUtil, dc, assortment, includeInformationKeys = true) {
         if (!assortment) {
             throw new Error('IdentifierConversion.getSeasonGroupIdentityObject(): assortment must be provided.');
@@ -92,6 +110,15 @@ class IdentifierConversion {
         }
         return seasonGroupObj;
     }
+    /** Takes in an item and returns an object to query for an LCSProduct
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
     static async getProductIdentityObject(transformMapFile, mapFileUtil, dc, itemFamilyObject, includeInformationKeys = true) {
         if (!itemFamilyObject) {
             throw new Error('IdentifierConversion.getProductIdentityObject(): itemFamilyObject must be provided.');
@@ -129,6 +156,15 @@ class IdentifierConversion {
             .applyTransformMap(transformMapFile, mapFileUtil, prodObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
         return prodObj;
     }
+    /** Takes in an item and returns an object to query for an LCSSKU
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
     static async getSKUIdentityObject(transformMapFile, mapFileUtil, dc, itemObject, includeInformationKeys = true) {
         if (!itemObject) {
             throw new Error('IdentifierConversion.getSKUIdentityObject(): itemObject must be provided.');

package/lib/transform/identifier-conversion.spec.js

@@ -30,9 +30,11 @@ describe('getAssortmentFromObject', () => {
                     entityValues[key] = value;
                 }
                 else if (Array.isArray(value)) {
+                    //multi select
                     entityValues[key] = value.map((v) => v.value);
                 }
                 else if (value.value) {
+                    //single select
                     entityValues[key] = value.value;
                 }
             }
@@ -166,9 +168,11 @@ describe('getItemCriteriaFromObject', () => {
                     entityValues[key] = value;
                 }
                 else if (Array.isArray(value)) {
+                    //multi select
                     entityValues[key] = value.map((v) => v.value);
                 }
                 else if (value.value) {
+                    //single select
                     entityValues[key] = value.value;
                 }
             }

package/lib/util/config-defaults.js

@@ -5,9 +5,11 @@ const sdk_1 = require("@contrail/sdk");
 const util_1 = require("@contrail/util");
 class ConfigDefaults {
     static async setConfigDefaults(config) {
+        //Validate config
         if (!config.apiHost || !config.userName || !config.password) {
             throw new Error(ConfigDefaults.NEED_CONFIG_VALUES);
         }
+        //List will be comma separated list in UI, so convert to array
         if (config?.itemPreDevelopmentLifecycleStages && !(config?.itemPreDevelopmentLifecycleStages instanceof Array)) {
             config.itemPreDevelopmentLifecycleStages = config.itemPreDevelopmentLifecycleStages.split(',');
         }
@@ -40,6 +42,7 @@ class ConfigDefaults {
         const pass = outputConfig.password;
         outputConfig.userName = () => uName;
         outputConfig.password = () => pass;
+        //Don't allow overwriting this.
         outputConfig['OOBvibeEventEndpoint'] = '/rfa/vibeiq/vibeEvents';
         console.log('outputConfig: ' + JSON.stringify(outputConfig));
         return outputConfig;

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

@@ -21,11 +21,13 @@ describe('all tests', () => {
     describe('setConfigDefaults - required values', () => {
         it('missing apiHost', async () => {
             const config = {
+                //apiHost: 'http://test.com',
                 userName: 'vibeiq',
                 password: 'vibeiq',
                 plmEnviornment: 'SB'
             };
             try {
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-vars
                 const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(config);
             }
             catch (e) {
@@ -35,10 +37,12 @@ describe('all tests', () => {
         it('missing userName', async () => {
             const config = {
                 apiHost: 'http://test.com',
+                //userName: 'vibeiq',
                 password: 'vibeiq',
                 plmEnviornment: 'SB'
             };
             try {
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-vars
                 const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(config);
             }
             catch (e) {
@@ -49,9 +53,11 @@ describe('all tests', () => {
             const config = {
                 apiHost: 'http://test.com',
                 userName: 'vibeiq',
+                //password: 'vibeiq',
                 plmEnviornment: 'SB'
             };
             try {
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-vars
                 const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(config);
             }
             catch (e) {
@@ -63,8 +69,10 @@ describe('all tests', () => {
                 apiHost: 'http://test.com',
                 userName: 'vibeiq',
                 password: 'vibeiq',
+                //plmEnviornment: 'SB'
             };
             try {
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-vars
                 const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(config);
             }
             catch (e) {
@@ -215,6 +223,7 @@ describe('all tests', () => {
             const startConfig = Object.assign({}, config);
             const objectClass = 'LCSSeason';
             const expectedAtts = ['flexPLMSeasonName'];
+            // const expectedAtts =['seasonType', 'seasonYear'];
             const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
             const identifierAtts = fcConfig.identifierAtts[objectClass];
             expect(identifierAtts instanceof Array).toBeTruthy();

package/lib/util/data-converter-spec-mockData.js

@@ -31,12 +31,26 @@ exports.mapping = {
                 }
             }
         }
+        // flex2vibe: {
+        //   LCSRevisableEntity: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSLast: {
+        //     getMapKey: (object) => {return object;}
+        //   },
+        //   LCSMaterial: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSBusinessObject: {
+        //     getMapKey: (object) => {return object;}
+        //   }
+        // },
     },
     LCSProduct: {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSProduct',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {
@@ -61,7 +75,7 @@ exports.mapping = {
                 vibeIQIdentifier: 'itemNumber'
             },
             valueTransform: {
-                transformEx: (row) => {
+                transformEx: (row /*, dependencies*/) => {
                     return row['otherProp'] + 'xxx';
                 }
             }
@@ -79,7 +93,7 @@ exports.mapping = {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSSKU',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {

package/lib/util/data-converter.d.ts

@@ -19,21 +19,118 @@ export declare class DataConverter {
     getFlexPLMObjectDataFromEvent(event: any, dataToSkip: string[]): Promise<{}>;
     getFlexPLMObjectData(newData: any, dataToSkip: string[], inflateObjRef: boolean): Promise<{}>;
     getFlexPLMValue(prop: any, newData: any, inflateObjRef: boolean): Promise<any>;
+    /** Returns the display values for list properties (choice & multi_select)
+     *
+     * @param prop
+     * @param newData
+     * @returns
+     */
     getEnumerationValue(prop: any, nd: any): any;
     getObjectReferenceValue(prop: any, newData: any, inflateObjRef?: boolean): Promise<any>;
+    /** (Deprecated) Use TypeConversionUtils.getMapKey()
+     * Will return the class to use to get mapping.
+     * This is needed because mappings will be different for different sub types
+     * of custom-entity
+     *
+     * @param obj: Entity being checked
+     * @param mapping: The whole mapping file
+     */
     getMappingClass(entity: object, mapping: any): string;
+    /** Sets entity values from FlexPLM data passed in
+     * Assumes the entity has a VibeIQ typeId and 'roles' value to filter if necessary.
+     * @param entity the entity to update
+     * @param data the FlexPLM data
+     * @param keysToSkip properties to skip
+     * @returns the modified entity with VibeIQ values
+     */
     setEntityValues(entity: any, data: any, keysToSkip?: string[]): Promise<any>;
+    /** Gets the entity values from FlexPLM data
+     * Assumes there isn't a VibeIQ typeId, so uses FlexPLM data to determine type
+     * @param objectClass FlexPLM object class
+     * @param data object data
+     * @param keysToSkip type properties to not process
+     * @returns object with VibeIQ values
+     */
     getEntityValues(objectClass: string, data: any, keysToSkip?: string[]): Promise<{}>;
+    /** Gets the VibeIQ value for the property from data
+     *
+     * @param prop the VibeIQ property
+     * @param data the FlexPLM data
+     * @returns value to be set in VibeIQ
+     */
     getEntityValue(prop: any, data: any): Promise<any>;
     setEnumerationKeys(prop: any, nd: any, matchByDisplay: any): any;
+    /** Compares the potential changes to the entity and returns only the actual differences.
+     *
+     * @param entity the full entity
+     * @param changes the potential changes
+     * @returns only the change values that are different from the entity's value
+     */
     getPersistableChanges(entity: object, changes: object): object;
+    /** Sets object reference value from FlexPLM data passed in
+     *
+     * @param prop the VibeIQ property
+     * @param nd the VibeIQ data
+     * @returns the object reference id from VibeIQ
+     */
     setObjectReferenceValue(prop: any, nd: any): Promise<any>;
+    /**
+     * Retrieves all object references of a specified entity type based on the provided criteria.
+     * This function handles pagination and asynchronously fetches object references until there are no more pages.
+     * @param {string} entityType - The type of entity for which object references are to be retrieved.
+     * @param {object} rootTypeCriteria - The criteria used to filter object references.
+     * @returns {Promise<Array>} A Promise that resolves to an array containing all object references.
+     */
     getAllObjectReferences(entityType: string, rootTypeCriteria: any, postProcessCriteria?: any): Promise<any[]>;
+    /**
+     * Checks if all keys and values of a given object are present in an array of objects.
+     * @param {Object} criteria - The object whose keys and values are to be checked in the array of objects.
+     * @param {Array<Object>} arrayOfObjects - The array of objects to be searched for matching keys and values.
+     * @param {string} entityTypePath - The type / subtype for the property; objects must be this type or a sub type of it.
+     * @returns {(Object|boolean)} Returns the array of objects that matches all keys and values of the provided object.
+     *                             If no match is found, returns empty array.
+     */
     checkKeysAndValues(criteria: any, arrayOfObjects: any, entityTypePath: any): any[];
+    /** Filters out archived and trashed entities from the provided array of entities.
+     *
+     * @param entities
+     * @returns
+     */
     filterOutArchivedAndTrashedEntities(entities: any[]): any[];
+    /** Sets userListId value from FlexPLM data passed in
+     *
+     * @param prop the VibeIQ property
+     * @param nd the VibeIQ data
+     * @returns the modified entity with FlexPLM values
+     */
     setUserListValue(prop: any, nd: any): Promise<any>;
+    /** Makes batch calls of 1000 of user-org entities until
+     * it find one with userEmail of passed in nd.email.
+     * Maxes out after querying for 15,000 user-org entities
+     *
+     * @param nd
+     * @returns
+     */
     getUserByEmail(nd: any): Promise<any>;
+    /** Shows warning if user email address not present in group associated to property
+     *
+     * @param prop the VibeIQ property
+     * @param userEmail user email address
+     */
     processGroupMemberCheck(prop: any, userEmail: any): Promise<void>;
+    /** Gets the VibeIQ value for the userList property from data
+     *
+     * @param prop the VibeIQ property
+     * @param newData the FlexPLM data
+     * @returns value to be set in VibeIQ
+     */
     getUserListValue(prop: any, newData: any): Promise<any>;
+    /** Makes batch calls of 1000 of user-org entities until
+     * it find one with user.id of passed in userId.
+     * Maxes out after querying for 15,000 user-org entities
+     *
+     * @param userId
+     * @returns
+     */
     getUserById(userId: any): Promise<any>;
 }