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

package/src/util/config-defaults.spec.ts

@@ -1,445 +0,0 @@
-import { ConfigDefaults } from './config-defaults';
-import { FCConfig } from '../interfaces/interfaces';
-import { TypeDefaults } from './type-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 = {
-        //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: FCConfig = await ConfigDefaults.setConfigDefaults(config);
-
-      } catch (e) {
-        expect(e.message).toEqual(ConfigDefaults.NEED_CONFIG_VALUES);
-      }
-    });
-    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: FCConfig = await ConfigDefaults.setConfigDefaults(config);
-
-      } catch (e) {
-        expect(e.message).toEqual(ConfigDefaults.NEED_CONFIG_VALUES);
-      }
-    });
-
-    it('missing password', 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: FCConfig = await ConfigDefaults.setConfigDefaults(config);
-
-      } catch (e) {
-        expect(e.message).toEqual(ConfigDefaults.NEED_CONFIG_VALUES);
-      }
-    });
-
-    it('missing plmEnviornment', 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: FCConfig = await ConfigDefaults.setConfigDefaults(config);
-
-      } catch (e) {
-        expect(e.message).toEqual(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 ConfigDefaults.setConfigDefaults(startConfig);
-      expect(fcConfig.userName()).toEqual('newName');
-
-    });
-    it('password as function', async () =>{
-      const startConfig = Object.assign({}, config, { password: 'strange' });
-      const fcConfig = await 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 ConfigDefaults.setConfigDefaults(startConfig);
-      expect(fcConfig.urlContext).toEqual('/Windchill');
-    });
-
-    it('urlContext-set value', async () => {
-      const startConfig = Object.assign({}, config);
-      startConfig['urlContext'] = '/FlexPLM';
-      const fcConfig = await ConfigDefaults.setConfigDefaults(startConfig);
-      expect(fcConfig.urlContext).toEqual('/FlexPLM');
-    });
-
-    it('sendMode-ASYNC_PUBLISH_SEASON-get default', async () => {
-      const startConfig = Object.assign({}, config);
-      const fcConfig: FCConfig = await 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: FCConfig = await 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: FCConfig = await 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: FCConfig = await ConfigDefaults.setConfigDefaults(startConfig);
-      expect(fcConfig['sendMode']['NO_DEFAULT']).toEqual('vibeiqfile-dontsendtoflexplm');
-    });
-
-    it('itemPreDevelopmentLifecycleStages-get default', async () => {
-      const startConfig = Object.assign({}, config);
-      const fcConfig: FCConfig = await 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: FCConfig = await 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: FCConfig = await 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: FCConfig = await 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: FCConfig = await 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 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 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 expectedAtts =['seasonType', 'seasonYear'];
-
-      const fcConfig = await 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 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 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 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('isPropertyTrue', () => {
-    it('returns true for boolean true', () => {
-      expect(ConfigDefaults.isPropertyTrue(true)).toBe(true);
-    });
-
-    it('returns true for string true', () => {
-      expect(ConfigDefaults.isPropertyTrue('true')).toBe(true);
-    });
-
-    it('returns true for string TRUE', () => {
-      expect(ConfigDefaults.isPropertyTrue('TRUE')).toBe(true);
-    });
-
-    it('returns true for string True', () => {
-      expect(ConfigDefaults.isPropertyTrue('True')).toBe(true);
-    });
-
-    it('returns false for boolean false', () => {
-      expect(ConfigDefaults.isPropertyTrue(false)).toBe(false);
-    });
-
-    it('returns false for string false', () => {
-      expect(ConfigDefaults.isPropertyTrue('false')).toBe(false);
-    });
-
-    it('returns false for null', () => {
-      expect(ConfigDefaults.isPropertyTrue(null)).toBe(false);
-    });
-
-    it('returns false for undefined', () => {
-      expect(ConfigDefaults.isPropertyTrue(undefined)).toBe(false);
-    });
-
-    it('returns false for empty string', () => {
-      expect(ConfigDefaults.isPropertyTrue('')).toBe(false);
-    });
-
-    it('returns false for number 1', () => {
-      expect(ConfigDefaults.isPropertyTrue(1)).toBe(false);
-    });
-  });
-
-  describe('getDefaultConfig', () => {
-    it('returns LCSMaterial.processAsItem=false by default', () => {
-      const dc: any = ConfigDefaults.getDefaultConfig();
-      expect(dc.LCSMaterial).toBeDefined();
-      expect(dc.LCSMaterial.processAsItem).toBe(false);
-    });
-
-    it('returns a fresh object each call (no shared reference)', () => {
-      const a: any = ConfigDefaults.getDefaultConfig();
-      const b: any = ConfigDefaults.getDefaultConfig();
-      expect(a).not.toBe(b);
-      expect(a.LCSMaterial).not.toBe(b.LCSMaterial);
-      a.LCSMaterial.processAsItem = true;
-      expect(b.LCSMaterial.processAsItem).toBe(false);
-    });
-  });
-
-  describe('setConfigDefaults - LCSMaterial', () => {
-    const config = {
-      apiHost: 'http://test.com',
-      userName: 'vibeiq',
-      password: 'vibeiq'
-    };
-
-    it('LCSMaterial.processAsItem-get default', async () => {
-      const startConfig = Object.assign({}, config);
-      const fcConfig: any = await ConfigDefaults.setConfigDefaults(startConfig);
-      expect(fcConfig.LCSMaterial.processAsItem).toBe(false);
-    });
-
-    it('LCSMaterial.processAsItem-override', async () => {
-      const startConfig: any = Object.assign({}, config);
-      startConfig.LCSMaterial = { processAsItem: true };
-      const fcConfig: any = await ConfigDefaults.setConfigDefaults(startConfig);
-      expect(fcConfig.LCSMaterial.processAsItem).toBe(true);
-    });
-
-    it('applies LCSMaterial.processAsItem to TypeDefaults', async () => {
-      try {
-        const startConfig: any = Object.assign({}, config, { LCSMaterial: { processAsItem: true } });
-        await ConfigDefaults.setConfigDefaults(startConfig);
-        expect(TypeDefaults.processLCSMaterialAsItem).toBe(true);
-
-        const defaultStart: any = Object.assign({}, config);
-        await ConfigDefaults.setConfigDefaults(defaultStart);
-        expect(TypeDefaults.processLCSMaterialAsItem).toBe(false);
-      } finally {
-        TypeDefaults.applyConfig({});
-      }
-    });
-  });
-
-  describe('getConfigFile', () => {
-    beforeEach(() => {
-      ConfigDefaults.clearConfigCache();
-    });
-
-    it('response has test var', async () => {
-      fetchJson = { testVar: true };
-      entityObject = { downloadUrl: 'http://sss.com' };
-
-      const config = await ConfigDefaults.getConfigFile('id-1');
-      expect(config).toBeDefined();
-      expect(config['testVar']).toBeTruthy();
-    });
-
-    it('undefined file object', async () => {
-      fetchJson = { testVar: true };
-      entityObject = undefined;
-
-      const config = await 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 ConfigDefaults.getConfigFile('id-1');
-      expect(config).toBeDefined();
-      expect(Object.keys(config).length).toEqual(0);
-    });
-
-  });
-});

package/src/util/config-defaults.ts

@@ -1,106 +0,0 @@
-import { Entities } from '@contrail/sdk';
-import { FCConfig } from '../interfaces/interfaces';
-import { ObjectUtil } from '@contrail/util';
-import { TypeDefaults } from './type-defaults';
-
-export class ConfigDefaults {
-  static NEED_CONFIG_VALUES = 'To connect to FlexPLM all these APP values need to be set apiHost, userName, and password';
-  static STATIC_CONFIG_CACHE = {};
-  static async setConfigDefaults(config): Promise<FCConfig> {
-  //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(',');
-    } else if(Object.keys(config).includes('itemPreDevelopmentLifecycleStages')){
-      delete config['itemPreDevelopmentLifecycleStages'];
-    }
-
-    const configArr = [ConfigDefaults.getDefaultConfig()];
-
-    if(config.configFile){
-      const fileConfig = await ConfigDefaults.getConfigFile(config.configFile);
-      configArr.push(fileConfig);
-    }
-    configArr.push(config);
-    const outputConfig = ObjectUtil.mergeDeep({}, ...configArr);
-    const uName = outputConfig.userName;
-    const pass = outputConfig.password;
-    outputConfig.userName = () => uName;
-    outputConfig.password = () => pass;
-
-    //Don't allow overwriting this.
-    outputConfig['OOBvibeEventEndpoint'] = '/rfa/vibeiq/vibeEvents';
-
-    TypeDefaults.applyConfig(outputConfig);
-
-    console.log('outputConfig: ' + JSON.stringify(outputConfig));
-    return outputConfig as FCConfig;
-  }
-
-  static getDefaultConfig() {
-    return {
-      urlContext: '/Windchill',
-      sendMode: {
-        ASYNC_PUBLISH_SEASON: 'vibeiqfile'
-      },
-      itemPreDevelopmentLifecycleStages: ['concept'],
-      identifierAtts: {
-        LCSProduct: ['itemNumber'],
-        LCSSeason: ['flexPLMSeasonName'],
-        LCSSKU: ['itemNumber']
-      },
-      LCSMaterial: {
-        processAsItem: false
-      },
-      csrfEndpoint: '/servlet/rest/security/csrf',
-      vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
-      payloadDefaultAsArray: true
-    };
-  }
-
-  static async getConfigFile(fileId: string) {
-    try {
-
-      if(ConfigDefaults.STATIC_CONFIG_CACHE[fileId]){
-        console.debug('returning cached config file: ' + fileId);
-        return ConfigDefaults.STATIC_CONFIG_CACHE[fileId];
-      }
-      const options = {
-        entityName: 'file',
-        id: fileId,
-      };
-      const file = await new Entities().get(options);
-      if (!file){
-        console.log('failed to find file with id: ' + fileId);
-        return {};
-      }
-      const downloadUrl = file['downloadUrl'];
-
-      if(!downloadUrl){
-        console.log('file didnt have downloadUrl. fileId: ' + fileId);
-        return {};
-      }
-      const response = await fetch(downloadUrl);
-      const config = await response.json();
-      if(config){
-        ConfigDefaults.STATIC_CONFIG_CACHE[fileId] = config;
-      }
-      return config ? config: {};
-    }catch(e){
-      console.log('Error getting config file: ' + fileId + '- ' +e.message);
-      return {};
-    }
-  }
-
-  static isPropertyTrue(value: any): boolean {
-    return value === true || (typeof value === 'string' && value.toLowerCase() === 'true');
-  }
-
-  static clearConfigCache(){
-    ConfigDefaults.STATIC_CONFIG_CACHE = {};
-  }
-}