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

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

@@ -1,205 +1,219 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.mapping = {
-    typeConversion: {
-        vibe2flex: {
-            'custom-entity': {
-                getMapKey: (entity) => {
-                    const typePath = entity['typePath'];
-                    let mapKey = '';
-                    switch (typePath) {
-                        case 'custom-entity:pack':
-                            mapKey = 'packaging';
-                            break;
-                        case 'custom-entity:prefix':
-                            mapKey = 'prefix';
-                            break;
-                        case 'custom-entity:catName':
-                            mapKey = 'catName';
-                            break;
-                        case 'custom-entity:partnerOrg':
-                            mapKey = 'partnerOrg';
-                            break;
-                        case 'custom-entity:catFamily':
-                            mapKey = 'catFamily';
-                            break;
-                        case 'custom-entity:formName':
-                            mapKey = 'formName';
-                            break;
-                    }
-                    return mapKey;
-                }
-            }
-        }
-    },
-    LCSProduct: {
-        vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
-        vibe2flex: {
-            getClass: () => 'LCSProduct',
-            getSoftType: (entity) => {
-                const prodType = entity['prodType'];
-                let val = '';
-                switch (prodType) {
-                    case 'acc':
-                        val = 'Product\\Accesories';
-                        break;
-                    case 'app':
-                        val = 'Product\\Apparel';
-                        break;
-                    case 'eqp':
-                        val = 'Product\\Equipment';
-                        break;
-                    case 'foot':
-                        val = 'Product\\Footwear';
-                        break;
-                }
-                return val;
-            },
-            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }, { processor: 'VALUE_TRANSFORM', functionTransformersKey: 'valueTransform' }],
-            rekey: {
-                productName: 'name',
-                vibeIQIdentifier: 'itemNumber'
-            },
-            valueTransform: {
-                transformEx: (row) => {
-                    return row['otherProp'] + 'xxx';
-                }
-            }
-        },
-        flex2vibe: {
-            getClass: () => 'item',
-            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-            rekey: {
-                itemNumber: 'vibeIQIdentifier',
-                name: 'productName',
-            }
-        }
-    },
-    LCSSKU: {
-        vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
-        vibe2flex: {
-            getClass: () => 'LCSSKU',
-            getSoftType: (entity) => {
-                const prodType = entity['prodType'];
-                let val = '';
-                switch (prodType) {
-                    case 'acc':
-                        val = 'Product\\Accesories';
-                        break;
-                    case 'app':
-                        val = 'Product\\Apparel';
-                        break;
-                    case 'eqp':
-                        val = 'Product\\Equipment';
-                        break;
-                    case 'foot':
-                        val = 'Product\\Footwear';
-                        break;
-                }
-                return val;
-            },
-            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-            rekey: {
-                skuName: 'optionName',
-                vibeIQIdentifier: 'itemNumber'
-            }
-        },
-        flex2vibe: {
-            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-            rekey: {
-                itemNumber: 'vibeIQIdentifier',
-                optionName: 'skuName',
-            }
-        }
-    },
-    packaging: {
-        vibe2flex: {
-            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-            rekey: {
-                retailPackType: 'packType',
-                retailIntroDate: 'introDate'
-            },
-            getSoftType: () => 'Revisable Entity\\packaging',
-            getClass: () => 'LCSRevisableEntity'
-        },
-        flex2vibe: {
-            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-            rekey: {
-                packType: 'retailPackType',
-                introDate: 'retailIntroDate'
-            },
-            getClass: () => 'custom-entity',
-            getSoftType: () => 'custom-entity:pack',
-        }
-    },
-    prefix: {
-        vibe2flex: {
-            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-            rekey: {
-                retailOwner: 'owner',
-                retailIntroDate: 'introDate'
-            },
-            getSoftType: () => 'Revisable Entity\\prefix',
-            getClass: () => 'LCSRevisableEntity'
-        },
-        flex2vibe: {
-            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-            rekey: {
-                owner: 'retailOwner',
-                introDate: 'retailIntroDate'
-            },
-            getClass: () => 'custom-entity',
-            getSoftType: () => 'custom-entity:prefix',
-        }
-    },
-    catName: {
-        getIdentifierProperties: () => ['catName', 'catNumber'],
-        getInformationalProperties: () => ['longName'],
-        vibe2flex: {
-            transformOrder: [],
-            getSoftType: () => 'Last\\catName',
-            getClass: () => 'LCSLast'
-        },
-        flex2vibe: {
-            transformOrder: [],
-            getClass: () => 'custom-entity',
-            getSoftType: () => 'custom-entity:catName',
-        }
-    },
-    partnerOrg: {
-        vibe2flex: {
-            transformOrder: [],
-            getSoftType: () => 'Business Object\\partnerOrg',
-            getClass: () => 'LCSLifecycleManaged'
-        },
-        flex2vibe: {
-            transformOrder: [],
-            getClass: () => 'custom-entity',
-            getSoftType: () => 'custom-entity:partnerOrg',
-        }
-    },
-    catFamily: {
-        vibe2flex: {
-            transformOrder: [],
-            getSoftType: () => 'Revisable Entity\\catFamily',
-            getClass: () => 'LCSRevisableEntity'
-        },
-        flex2vibe: {
-            transformOrder: [],
-            getClass: () => 'custom-entity',
-            getSoftType: () => 'custom-entity:catFamily',
-        }
-    },
-    formName: {
-        vibe2flex: {
-            transformOrder: [],
-            getSoftType: () => 'Material\\form',
-            getClass: () => 'LCSMaterial'
-        },
-        flex2vibe: {
-            transformOrder: [],
-            getClass: () => 'custom-entity',
-            getSoftType: () => 'custom-entity:formName',
-        }
-    },
-};
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.mapping = {
+    typeConversion: {
+        vibe2flex: {
+            'custom-entity': {
+                getMapKey: (entity) => {
+                    const typePath = entity['typePath'];
+                    let mapKey = '';
+                    switch (typePath) {
+                        case 'custom-entity:pack':
+                            mapKey = 'packaging';
+                            break;
+                        case 'custom-entity:prefix':
+                            mapKey = 'prefix';
+                            break;
+                        case 'custom-entity:catName':
+                            mapKey = 'catName';
+                            break;
+                        case 'custom-entity:partnerOrg':
+                            mapKey = 'partnerOrg';
+                            break;
+                        case 'custom-entity:catFamily':
+                            mapKey = 'catFamily';
+                            break;
+                        case 'custom-entity:formName':
+                            mapKey = 'formName';
+                            break;
+                    }
+                    return mapKey;
+                }
+            }
+        }
+        // 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 /*, dependencies*/) => {
+                const prodType = entity['prodType'];
+                let val = '';
+                switch (prodType) {
+                    case 'acc':
+                        val = 'Product\\Accesories';
+                        break;
+                    case 'app':
+                        val = 'Product\\Apparel';
+                        break;
+                    case 'eqp':
+                        val = 'Product\\Equipment';
+                        break;
+                    case 'foot':
+                        val = 'Product\\Footwear';
+                        break;
+                }
+                return val;
+            },
+            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }, { processor: 'VALUE_TRANSFORM', functionTransformersKey: 'valueTransform' }],
+            rekey: {
+                productName: 'name',
+                vibeIQIdentifier: 'itemNumber'
+            },
+            valueTransform: {
+                transformEx: (row /*, dependencies*/) => {
+                    return row['otherProp'] + 'xxx';
+                }
+            }
+        },
+        flex2vibe: {
+            getClass: () => 'item',
+            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+            rekey: {
+                itemNumber: 'vibeIQIdentifier',
+                name: 'productName',
+            }
+        }
+    },
+    LCSSKU: {
+        vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
+        vibe2flex: {
+            getClass: () => 'LCSSKU',
+            getSoftType: (entity /*, dependencies*/) => {
+                const prodType = entity['prodType'];
+                let val = '';
+                switch (prodType) {
+                    case 'acc':
+                        val = 'Product\\Accesories';
+                        break;
+                    case 'app':
+                        val = 'Product\\Apparel';
+                        break;
+                    case 'eqp':
+                        val = 'Product\\Equipment';
+                        break;
+                    case 'foot':
+                        val = 'Product\\Footwear';
+                        break;
+                }
+                return val;
+            },
+            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+            rekey: {
+                skuName: 'optionName',
+                vibeIQIdentifier: 'itemNumber'
+            }
+        },
+        flex2vibe: {
+            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+            rekey: {
+                itemNumber: 'vibeIQIdentifier',
+                optionName: 'skuName',
+            }
+        }
+    },
+    packaging: {
+        vibe2flex: {
+            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+            rekey: {
+                retailPackType: 'packType',
+                retailIntroDate: 'introDate'
+            },
+            getSoftType: () => 'Revisable Entity\\packaging',
+            getClass: () => 'LCSRevisableEntity'
+        },
+        flex2vibe: {
+            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+            rekey: {
+                packType: 'retailPackType',
+                introDate: 'retailIntroDate'
+            },
+            getClass: () => 'custom-entity',
+            getSoftType: () => 'custom-entity:pack',
+        }
+    },
+    prefix: {
+        vibe2flex: {
+            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+            rekey: {
+                retailOwner: 'owner',
+                retailIntroDate: 'introDate'
+            },
+            getSoftType: () => 'Revisable Entity\\prefix',
+            getClass: () => 'LCSRevisableEntity'
+        },
+        flex2vibe: {
+            transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+            rekey: {
+                owner: 'retailOwner',
+                introDate: 'retailIntroDate'
+            },
+            getClass: () => 'custom-entity',
+            getSoftType: () => 'custom-entity:prefix',
+        }
+    },
+    catName: {
+        getIdentifierProperties: () => ['catName', 'catNumber'],
+        getInformationalProperties: () => ['longName'],
+        vibe2flex: {
+            transformOrder: [],
+            getSoftType: () => 'Last\\catName',
+            getClass: () => 'LCSLast'
+        },
+        flex2vibe: {
+            transformOrder: [],
+            getClass: () => 'custom-entity',
+            getSoftType: () => 'custom-entity:catName',
+        }
+    },
+    partnerOrg: {
+        vibe2flex: {
+            transformOrder: [],
+            getSoftType: () => 'Business Object\\partnerOrg',
+            getClass: () => 'LCSLifecycleManaged'
+        },
+        flex2vibe: {
+            transformOrder: [],
+            getClass: () => 'custom-entity',
+            getSoftType: () => 'custom-entity:partnerOrg',
+        }
+    },
+    catFamily: {
+        vibe2flex: {
+            transformOrder: [],
+            getSoftType: () => 'Revisable Entity\\catFamily',
+            getClass: () => 'LCSRevisableEntity'
+        },
+        flex2vibe: {
+            transformOrder: [],
+            getClass: () => 'custom-entity',
+            getSoftType: () => 'custom-entity:catFamily',
+        }
+    },
+    formName: {
+        vibe2flex: {
+            transformOrder: [],
+            getSoftType: () => 'Material\\form',
+            getClass: () => 'LCSMaterial'
+        },
+        flex2vibe: {
+            transformOrder: [],
+            getClass: () => 'custom-entity',
+            getSoftType: () => 'custom-entity:formName',
+        }
+    },
+};

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

@@ -1,39 +1,136 @@
-import { FCConfig } from '../interfaces/interfaces';
-import { MapFileUtil } from '@contrail/transform-data';
-export declare class DataConverter {
-    private config;
-    private mapFileUtil;
-    private typeUtils;
-    private transformMapFile;
-    private useDisplayForEnumerationMatching;
-    private verboseDebug;
-    private objRefCache;
-    private userRefCache;
-    static staticUserCache: {};
-    static clearStaticUserCache(): void;
-    static getFromStaticCache(id: string): any;
-    static setToStaticCache(id: string, value: any): void;
-    constructor(config: FCConfig, mapFileUtil: MapFileUtil);
-    setVerboseDebug(val?: boolean): void;
-    isVerboseDebugOn(): boolean;
-    getFlexPLMObjectDataFromEvent(event: any, dataToSkip: string[]): Promise<{}>;
-    getFlexPLMObjectData(newData: any, dataToSkip: string[], inflateObjRef: boolean): Promise<{}>;
-    getFlexPLMValue(prop: any, newData: any, inflateObjRef: boolean): Promise<any>;
-    getEnumerationValue(prop: any, nd: any): any;
-    getObjectReferenceValue(prop: any, newData: any, inflateObjRef?: boolean): Promise<any>;
-    getMappingClass(entity: object, mapping: any): string;
-    setEntityValues(entity: any, data: any, keysToSkip?: string[]): Promise<any>;
-    getEntityValues(objectClass: string, data: any, keysToSkip?: string[]): Promise<{}>;
-    getEntityValue(prop: any, data: any): Promise<any>;
-    setEnumerationKeys(prop: any, nd: any, matchByDisplay: any): any;
-    getPersistableChanges(entity: object, changes: object): object;
-    setObjectReferenceValue(prop: any, nd: any): Promise<any>;
-    getAllObjectReferences(entityType: string, rootTypeCriteria: any, postProcessCriteria?: any): Promise<any[]>;
-    checkKeysAndValues(criteria: any, arrayOfObjects: any, entityTypePath: any): any[];
-    filterOutArchivedAndTrashedEntities(entities: any[]): any[];
-    setUserListValue(prop: any, nd: any): Promise<any>;
-    getUserByEmail(nd: any): Promise<any>;
-    processGroupMemberCheck(prop: any, userEmail: any): Promise<void>;
-    getUserListValue(prop: any, newData: any): Promise<any>;
-    getUserById(userId: any): Promise<any>;
-}
+import { FCConfig } from '../interfaces/interfaces';
+import { MapFileUtil } from '@contrail/transform-data';
+export declare class DataConverter {
+    private config;
+    private mapFileUtil;
+    private typeUtils;
+    private transformMapFile;
+    private useDisplayForEnumerationMatching;
+    private verboseDebug;
+    private objRefCache;
+    private userRefCache;
+    static staticUserCache: {};
+    static clearStaticUserCache(): void;
+    static getFromStaticCache(id: string): any;
+    static setToStaticCache(id: string, value: any): void;
+    constructor(config: FCConfig, mapFileUtil: MapFileUtil);
+    setVerboseDebug(val?: boolean): void;
+    isVerboseDebugOn(): boolean;
+    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>;
+}