@contrail/flexplm 1.3.0 → 1.3.1-alpha.585afc1

package/lib/util/map-util-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: () => 'Revisable Entity\\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: () => 'Revisable Entity\\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/map-utils.d.ts

@@ -1,6 +1,33 @@
-import { MapFileUtil } from '@contrail/transform-data';
-export declare class MapUtil {
-    static applyTransformMap(transformMapFile: any, mapFileUtil: any, data: any, mapSectionKey: string, direction: string, transformTaskOrderKey?: string): Promise<any>;
-    static getMapKey(transformMapFile: any, mapFileUtil: MapFileUtil, data: any, type: string, direction: string): Promise<string>;
-    static getFullMapSection(transformMapFile: string, mapFileUtil: MapFileUtil, mapSectionKey: string): Promise<any>;
-}
+import { MapFileUtil } from '@contrail/transform-data';
+export declare class MapUtil {
+    /** Transforms the data, assumes mapSectionKey has been correctly determined.
+     *
+     * @param transformMapFile id of map file
+     * @param mapFileUtil
+     * @param data
+     * @param mapSectionKey key for section of map file
+     * @param direction vibe2flex or flex2vibe
+     * @param transformTaskOrderKey key for the list of tasks to be processed. default is 'transformOrder'
+     * @returns The converted data
+     */
+    static applyTransformMap(transformMapFile: any, mapFileUtil: any, data: any, mapSectionKey: string, direction: string, transformTaskOrderKey?: string): Promise<any>;
+    /** Returns the mapKey based on the 'typeConversion' section of the map file.
+     * If the map file doesn't have a section for the type in question, 'undefined' is returned.
+     *
+     * @param fileId
+     * @param mapFileUtil
+     * @param data The full object
+     * @param type The entity or object class of the object.  The functions are keyed based on this.
+     * @param direction
+     * @returns
+     */
+    static getMapKey(transformMapFile: any, mapFileUtil: MapFileUtil, data: any, type: string, direction: string): Promise<string>;
+    /** Returns the full map section with both directions; identifier and informational properties; etc.
+     *
+     * @param transformMapFile id if map file
+     * @param mapFileUtil
+     * @param mapSectionKey key of the map section
+     * @returns
+     */
+    static getFullMapSection(transformMapFile: string, mapFileUtil: MapFileUtil, mapSectionKey: string): Promise<any>;
+}

package/lib/util/map-utils.js

@@ -1,15 +1,42 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MapUtil = void 0;
-class MapUtil {
-    static async applyTransformMap(transformMapFile, mapFileUtil, data, mapSectionKey, direction, transformTaskOrderKey = 'transformOrder') {
-        return await mapFileUtil.applyTransformMap(transformMapFile, data, mapSectionKey, direction, transformTaskOrderKey);
-    }
-    static async getMapKey(transformMapFile, mapFileUtil, data, type, direction) {
-        return await mapFileUtil.getMapKey(transformMapFile, data, type, direction);
-    }
-    static async getFullMapSection(transformMapFile, mapFileUtil, mapSectionKey) {
-        return await mapFileUtil.getFullMapSection(transformMapFile, mapSectionKey);
-    }
-}
-exports.MapUtil = MapUtil;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapUtil = void 0;
+class MapUtil {
+    /** Transforms the data, assumes mapSectionKey has been correctly determined.
+     *
+     * @param transformMapFile id of map file
+     * @param mapFileUtil
+     * @param data
+     * @param mapSectionKey key for section of map file
+     * @param direction vibe2flex or flex2vibe
+     * @param transformTaskOrderKey key for the list of tasks to be processed. default is 'transformOrder'
+     * @returns The converted data
+     */
+    static async applyTransformMap(transformMapFile, mapFileUtil, data, mapSectionKey, direction, transformTaskOrderKey = 'transformOrder') {
+        return await mapFileUtil.applyTransformMap(transformMapFile, data, mapSectionKey, direction, transformTaskOrderKey);
+    }
+    /** Returns the mapKey based on the 'typeConversion' section of the map file.
+     * If the map file doesn't have a section for the type in question, 'undefined' is returned.
+     *
+     * @param fileId
+     * @param mapFileUtil
+     * @param data The full object
+     * @param type The entity or object class of the object.  The functions are keyed based on this.
+     * @param direction
+     * @returns
+     */
+    static async getMapKey(transformMapFile, mapFileUtil, data, type, direction) {
+        return await mapFileUtil.getMapKey(transformMapFile, data, type, direction);
+    }
+    /** Returns the full map section with both directions; identifier and informational properties; etc.
+     *
+     * @param transformMapFile id if map file
+     * @param mapFileUtil
+     * @param mapSectionKey key of the map section
+     * @returns
+     */
+    static async getFullMapSection(transformMapFile, mapFileUtil, mapSectionKey) {
+        return await mapFileUtil.getFullMapSection(transformMapFile, mapSectionKey);
+    }
+}
+exports.MapUtil = MapUtil;

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

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