@contrail/flexplm 1.5.1-alpha.c9b11be → 1.6.0-alpha.6f15d4e

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

@@ -31,9 +31,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;
                 }
             }
@@ -167,9 +169,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

@@ -6,9 +6,11 @@ const util_1 = require("@contrail/util");
 const type_defaults_1 = require("./type-defaults");
 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(',');
         }
@@ -26,6 +28,7 @@ class ConfigDefaults {
         const pass = outputConfig.password;
         outputConfig.userName = () => uName;
         outputConfig.password = () => pass;
+        //Don't allow overwriting this.
         outputConfig['OOBvibeEventEndpoint'] = '/rfa/vibeiq/vibeEvents';
         type_defaults_1.TypeDefaults.applyConfig(outputConfig);
         console.log('outputConfig: ' + JSON.stringify(outputConfig));

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

@@ -22,11 +22,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) {
@@ -36,10 +38,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) {
@@ -50,9 +54,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) {
@@ -64,8 +70,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) {
@@ -216,6 +224,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,26 +19,123 @@ 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>;
     private applyInboundTransformMap;
     private buildObjectReferenceContext;
     private lookupObjectReferenceViaIdentityService;
     private lookupObjectReferenceViaQuery;
     private pickSingleResult;
+    /**
+     * 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>;
 }