@contrail/flexplm 1.1.13 → 1.1.15

package/lib/util/config-defaults.spec.d.ts

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

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

@@ -0,0 +1,264 @@
+"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('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', () => {
+        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.d.ts

@@ -7,6 +7,7 @@ export declare class DataConverter {
     private transformMapFile;
     private useDisplayForEnumerationMatching;
     private objRefCache;
+    private userRefCache;
     constructor(config: FCConfig, mapFileUtil: MapFileUtil);
     getFlexPLMObjectDataFromEvent(event: any, dataToSkip: string[]): Promise<{}>;
     getFlexPLMObjectData(newData: any, dataToSkip: string[], inflateObjRef: boolean): Promise<{}>;
@@ -19,4 +20,7 @@ export declare class DataConverter {
     getEntityValue(prop: any, data: any): Promise<any>;
     setEnumerationKeys(prop: any, nd: any, matchByDisplay: any): any;
     getPersistableChanges(entity: object, changes: object): object;
+    setUserListValue(prop: any, nd: any): Promise<any>;
+    processGroupMemberCheck(prop: any, userEmail: any): Promise<void>;
+    getUserListValue(prop: any, newData: any): Promise<any>;
 }

package/lib/util/data-converter.js

@@ -13,6 +13,7 @@ class DataConverter {
         this.mapFileUtil = mapFileUtil;
         this.useDisplayForEnumerationMatching = false;
         this.objRefCache = {};
+        this.userRefCache = {};
         this.typeUtils = new type_utils_1.TypeUtils();
         this.transformMapFile = this.config['transformMapFile'];
         this.useDisplayForEnumerationMatching = this.config['dataConverter']
@@ -88,6 +89,9 @@ class DataConverter {
         else if ('json' === propertyType) {
             value = nd;
         }
+        else if ('userList' === propertyType) {
+            value = await this.getUserListValue(prop, newData);
+        }
         return value;
     }
     getEnumerationValue(prop, nd) {
@@ -194,8 +198,13 @@ class DataConverter {
         const dataKeys = Object.getOwnPropertyNames(data);
         typeProps = typeProps.filter(prop => dataKeys.includes(prop['slug']));
         for (const prop of typeProps) {
+            const propertyType = prop['propertyType'];
             const slug = prop['slug'];
-            entity[slug] = await this.getEntityValue(prop, data);
+            let keyName = slug;
+            if (propertyType === 'userList') {
+                keyName = slug + 'Id';
+            }
+            entity[keyName] = await this.getEntityValue(prop, data);
         }
         return entity;
     }
@@ -260,6 +269,9 @@ class DataConverter {
         }
         else if ('json' === propertyType) {
         }
+        else if ('userList' === propertyType) {
+            value = await this.setUserListValue(prop, nd);
+        }
         return value;
     }
     setEnumerationKeys(prop, nd, matchByDisplay) {
@@ -309,5 +321,80 @@ class DataConverter {
         }
         return diffValues;
     }
+    async setUserListValue(prop, nd) {
+        if (!nd?.email) {
+            return "";
+        }
+        if (this.userRefCache[nd.email]) {
+            if (app_framework_1.Logger.isDebugOn()) {
+                console.debug('user cache hit: ' + nd.email);
+            }
+            await this.processGroupMemberCheck(prop, nd.email);
+            return this.userRefCache[nd.email];
+        }
+        const entities = await new sdk_1.Entities().get({
+            entityName: 'user-org',
+            take: 1000
+        });
+        const result = entities.find(element => element['userEmail'] === nd.email);
+        const value = (result) ? result.id : undefined;
+        if (value) {
+            this.userRefCache[nd.email] = value;
+            await this.processGroupMemberCheck(prop, nd.email);
+        }
+        return value;
+    }
+    async processGroupMemberCheck(prop, userEmail) {
+        let arrUserList = [];
+        if (this.userRefCache[prop.typePropertyUserListId]) {
+            arrUserList = this.userRefCache[prop.typePropertyUserListId];
+        }
+        else {
+            const userListResult = await new sdk_1.Entities().get({
+                entityName: 'user-list',
+                id: prop.typePropertyUserListId
+            });
+            if (userListResult && Object.keys(userListResult).length) {
+                arrUserList = userListResult.userList;
+                this.userRefCache[prop.typePropertyUserListId] = arrUserList;
+            }
+        }
+        if (arrUserList.length) {
+            const result = arrUserList.find(element => element['display'] === userEmail);
+            if (!result) {
+                console.warn(`The passed in user ${userEmail} in property slug ${prop.slug} should be a member of the group associated with the property 'typePropertyUserListId'`);
+            }
+        }
+    }
+    async getUserListValue(prop, newData) {
+        const slug = prop['slug'];
+        if (app_framework_1.Logger.isDebugOn()) {
+            console.debug('getUserListValue-prop: ' + slug);
+        }
+        const entityId = newData[slug + 'Id'];
+        if (!entityId) {
+            return {};
+        }
+        if (this.userRefCache[entityId]) {
+            if (app_framework_1.Logger.isDebugOn()) {
+                console.debug('user cache hit: ' + entityId);
+            }
+            return this.userRefCache[entityId];
+        }
+        const entities = await new sdk_1.Entities().get({
+            entityName: 'user-org',
+            id: entityId
+        });
+        const value = (entities) ? {
+            email: entities.userEmail,
+            firstName: entities.first,
+            lastName: entities.last,
+            isSsoUser: entities.isSsoUser,
+        } : undefined;
+        if (value) {
+            this.userRefCache[entityId] = value;
+        }
+        return value;
+    }
 }
 exports.DataConverter = DataConverter;

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

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