@contrail/flexplm 1.3.0-alpha.0 → 1.3.0-alpha.4

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

@@ -0,0 +1,293 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_defaults_1 = require("./config-defaults");
+let entityObject = {};
+jest.mock('@contrail/sdk', () => {
+    return {
+        Entities: class {
+            get() {
+                return entityObject;
+            }
+        }
+    };
+});
+let fetchJson = {};
+global.fetch = jest.fn().mockImplementation(() => {
+    return Promise.resolve({
+        json: () => Promise.resolve(fetchJson)
+    });
+});
+describe('all tests', () => {
+    describe('setConfigDefaults - required values', () => {
+        it('missing apiHost', async () => {
+            const config = {
+                userName: 'vibeiq',
+                password: 'vibeiq',
+                plmEnviornment: 'SB'
+            };
+            try {
+                const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(config);
+            }
+            catch (e) {
+                expect(e.message).toEqual(config_defaults_1.ConfigDefaults.NEED_CONFIG_VALUES);
+            }
+        });
+        it('missing userName', async () => {
+            const config = {
+                apiHost: 'http://test.com',
+                password: 'vibeiq',
+                plmEnviornment: 'SB'
+            };
+            try {
+                const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(config);
+            }
+            catch (e) {
+                expect(e.message).toEqual(config_defaults_1.ConfigDefaults.NEED_CONFIG_VALUES);
+            }
+        });
+        it('missing password', async () => {
+            const config = {
+                apiHost: 'http://test.com',
+                userName: 'vibeiq',
+                plmEnviornment: 'SB'
+            };
+            try {
+                const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(config);
+            }
+            catch (e) {
+                expect(e.message).toEqual(config_defaults_1.ConfigDefaults.NEED_CONFIG_VALUES);
+            }
+        });
+        it('missing plmEnviornment', async () => {
+            const config = {
+                apiHost: 'http://test.com',
+                userName: 'vibeiq',
+                password: 'vibeiq',
+            };
+            try {
+                const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(config);
+            }
+            catch (e) {
+                expect(e.message).toEqual(config_defaults_1.ConfigDefaults.NEED_CONFIG_VALUES);
+            }
+        });
+    });
+    describe('userName & password as functions', () => {
+        const config = {
+            apiHost: 'http://test.com',
+            userName: 'vibeiq',
+            password: 'vibeiq',
+            plmEnviornment: 'SB'
+        };
+        it('userName as function', async () => {
+            const startConfig = Object.assign({}, config, { userName: 'newName' });
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig.userName()).toEqual('newName');
+        });
+        it('password as function', async () => {
+            const startConfig = Object.assign({}, config, { password: 'strange' });
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig.password()).toEqual('strange');
+        });
+    });
+    describe('setConfigDefaults-setting defaults', () => {
+        const config = {
+            apiHost: 'http://test.com',
+            userName: 'vibeiq',
+            password: 'vibeiq',
+            plmEnviornment: 'SB'
+        };
+        it('urlContext-get default', async () => {
+            const startConfig = Object.assign({}, config);
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig.urlContext).toEqual('/Windchill');
+        });
+        it('urlContext-set value', async () => {
+            const startConfig = Object.assign({}, config);
+            startConfig['urlContext'] = '/FlexPLM';
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig.urlContext).toEqual('/FlexPLM');
+        });
+        it('sendMode-ASYNC_PUBLISH_SEASON-get default', async () => {
+            const startConfig = Object.assign({}, config);
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig['sendMode']['ASYNC_PUBLISH_SEASON']).toEqual('vibeiqfile');
+        });
+        it('sendMode-ASYNC_PUBLISH_SEASON-set value', async () => {
+            const startConfig = Object.assign({}, config);
+            startConfig['sendMode'] = { ASYNC_PUBLISH_SEASON: 'vibeiqfile-dontsendtoflexplm' };
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig['sendMode']['ASYNC_PUBLISH_SEASON']).toEqual('vibeiqfile-dontsendtoflexplm');
+        });
+        it('sendMode-NO_DEFAULT-get default', async () => {
+            const startConfig = Object.assign({}, config);
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig['sendMode']['NO_DEFAULT']).toBeUndefined();
+        });
+        it('sendMode-NO_DEFAULT-set value', async () => {
+            const startConfig = Object.assign({}, config);
+            startConfig['sendMode'] = { NO_DEFAULT: 'vibeiqfile-dontsendtoflexplm' };
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig['sendMode']['NO_DEFAULT']).toEqual('vibeiqfile-dontsendtoflexplm');
+        });
+        it('itemPreDevelopmentLifecycleStages-get default', async () => {
+            const startConfig = Object.assign({}, config);
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            expect(fcConfig['itemPreDevelopmentLifecycleStages']).toEqual(['concept']);
+        });
+        it('itemPreDevelopmentLifecycleStages-set value', async () => {
+            const startConfig = Object.assign({}, config);
+            const concept = 'concept';
+            const development = 'development';
+            startConfig['itemPreDevelopmentLifecycleStages'] = concept + ',' + development;
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            const itemPreDevelopmentLifecycleStages = fcConfig['itemPreDevelopmentLifecycleStages'];
+            expect(itemPreDevelopmentLifecycleStages instanceof Array).toBeTruthy();
+            expect(itemPreDevelopmentLifecycleStages.length).toBe(2);
+            expect(itemPreDevelopmentLifecycleStages.includes(concept));
+            expect(itemPreDevelopmentLifecycleStages.includes(development));
+        });
+        it('itemPreDevelopmentLifecycleStages-set value with space', async () => {
+            const startConfig = Object.assign({}, config);
+            const concept = 'concept';
+            const development = 'development';
+            startConfig['itemPreDevelopmentLifecycleStages'] = concept + ', ' + development;
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            const itemPreDevelopmentLifecycleStages = fcConfig['itemPreDevelopmentLifecycleStages'];
+            expect(itemPreDevelopmentLifecycleStages instanceof Array).toBeTruthy();
+            expect(itemPreDevelopmentLifecycleStages.length).toBe(2);
+            expect(itemPreDevelopmentLifecycleStages.includes(concept));
+            expect(itemPreDevelopmentLifecycleStages.includes(development));
+        });
+        it('itemPreDevelopmentLifecycleStages as empty string', async () => {
+            console.log('itemPreDevelopmentLifecycleStages as empty string');
+            const concept = 'concept';
+            const startConfig = Object.assign({}, config);
+            startConfig['itemPreDevelopmentLifecycleStages'] = '';
+            console.log('startConfig: ' + JSON.stringify(startConfig));
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            console.log('fcConfig: ' + JSON.stringify(fcConfig));
+            const itemPreDevelopmentLifecycleStages = fcConfig['itemPreDevelopmentLifecycleStages'];
+            expect(itemPreDevelopmentLifecycleStages instanceof Array).toBeTruthy();
+            expect(itemPreDevelopmentLifecycleStages.length).toBe(1);
+            expect(itemPreDevelopmentLifecycleStages.includes(concept));
+        });
+        it('itemPreDevelopmentLifecycleStages as empty array', async () => {
+            console.log('itemPreDevelopmentLifecycleStages as empty string');
+            const concept = 'concept';
+            const startConfig = Object.assign({}, config);
+            startConfig['itemPreDevelopmentLifecycleStages'] = [];
+            console.log('startConfig: ' + JSON.stringify(startConfig));
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            console.log('fcConfig: ' + JSON.stringify(fcConfig));
+            const itemPreDevelopmentLifecycleStages = fcConfig['itemPreDevelopmentLifecycleStages'];
+            expect(itemPreDevelopmentLifecycleStages instanceof Array).toBeTruthy();
+            expect(itemPreDevelopmentLifecycleStages.length).toBe(1);
+            expect(itemPreDevelopmentLifecycleStages.includes(concept));
+        });
+        it('identifierAtts-LCSProduct-get default', async () => {
+            const startConfig = Object.assign({}, config);
+            const objectClass = 'LCSProduct';
+            const expectedAtts = ['name'];
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            const identifierAtts = fcConfig.identifierAtts[objectClass];
+            expect(identifierAtts instanceof Array).toBeTruthy();
+            expect(identifierAtts.length).toBe(expectedAtts.length);
+            for (const att of expectedAtts) {
+                expect(identifierAtts.includes(att));
+            }
+        });
+        it('identifierAtts-LCSProduct-set value', async () => {
+            const startConfig = Object.assign({}, config);
+            const objectClass = 'LCSProduct';
+            const expectedAtts = ['val1', 'val2'];
+            startConfig['identifierAtts'] = {};
+            startConfig['identifierAtts'][objectClass] = expectedAtts;
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            const identifierAtts = fcConfig.identifierAtts[objectClass];
+            expect(identifierAtts instanceof Array).toBeTruthy();
+            expect(identifierAtts.length).toBe(expectedAtts.length);
+            for (const att of expectedAtts) {
+                expect(identifierAtts.includes(att));
+            }
+        });
+        it('identifierAtts-LCSSeason-get default', async () => {
+            const startConfig = Object.assign({}, config);
+            const objectClass = 'LCSSeason';
+            const expectedAtts = ['flexPLMSeasonName'];
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            const identifierAtts = fcConfig.identifierAtts[objectClass];
+            expect(identifierAtts instanceof Array).toBeTruthy();
+            expect(identifierAtts.length).toBe(expectedAtts.length);
+            for (const att of expectedAtts) {
+                expect(identifierAtts.includes(att));
+            }
+        });
+        it('identifierAtts-LCSSeason-set value', async () => {
+            const startConfig = Object.assign({}, config);
+            const objectClass = 'LCSSeason';
+            const expectedAtts = ['val1', 'val2'];
+            startConfig['identifierAtts'] = {};
+            startConfig['identifierAtts'][objectClass] = expectedAtts;
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            const identifierAtts = fcConfig.identifierAtts[objectClass];
+            expect(identifierAtts instanceof Array).toBeTruthy();
+            expect(identifierAtts.length).toBe(expectedAtts.length);
+            for (const att of expectedAtts) {
+                expect(identifierAtts.includes(att));
+            }
+        });
+        it('identifierAtts-LCSSKU-get default', async () => {
+            const startConfig = Object.assign({}, config);
+            const objectClass = 'LCSSKU';
+            const expectedAtts = ['optionName'];
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            const identifierAtts = fcConfig.identifierAtts[objectClass];
+            expect(identifierAtts instanceof Array).toBeTruthy();
+            expect(identifierAtts.length).toBe(expectedAtts.length);
+            for (const att of expectedAtts) {
+                expect(identifierAtts.includes(att));
+            }
+        });
+        it('identifierAtts-LCSSKU-set value', async () => {
+            const startConfig = Object.assign({}, config);
+            const objectClass = 'LCSSKU';
+            const expectedAtts = ['val1', 'val2'];
+            startConfig['identifierAtts'] = {};
+            startConfig['identifierAtts'][objectClass] = expectedAtts;
+            const fcConfig = await config_defaults_1.ConfigDefaults.setConfigDefaults(startConfig);
+            const identifierAtts = fcConfig.identifierAtts[objectClass];
+            expect(identifierAtts instanceof Array).toBeTruthy();
+            expect(identifierAtts.length).toBe(expectedAtts.length);
+            for (const att of expectedAtts) {
+                expect(identifierAtts.includes(att));
+            }
+        });
+    });
+    describe('getConfigFile', () => {
+        beforeEach(() => {
+            config_defaults_1.ConfigDefaults.clearConfigCache();
+        });
+        it('response has test var', async () => {
+            fetchJson = { testVar: true };
+            entityObject = { downloadUrl: 'http://sss.com' };
+            const config = await config_defaults_1.ConfigDefaults.getConfigFile('id-1');
+            expect(config).toBeDefined();
+            expect(config['testVar']).toBeTruthy();
+        });
+        it('undefined file object', async () => {
+            fetchJson = { testVar: true };
+            entityObject = undefined;
+            const config = await config_defaults_1.ConfigDefaults.getConfigFile('id-1');
+            expect(config).toBeDefined();
+            expect(Object.keys(config).length).toEqual(0);
+        });
+        it('response no downloadUrl', async () => {
+            fetchJson = { testVar: true };
+            entityObject = {};
+            const config = await config_defaults_1.ConfigDefaults.getConfigFile('id-1');
+            expect(config).toBeDefined();
+            expect(Object.keys(config).length).toEqual(0);
+        });
+    });
+});

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

@@ -0,0 +1,205 @@
+'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',
+        }
+    },
+};

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

@@ -0,0 +1,39 @@
+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>;
+}