@contrail/flexplm 1.5.0-alpha.98b8b06 → 1.5.0

package/src/util/logger-config.ts

@@ -0,0 +1,20 @@
+import { LogLevel, Logger } from '@contrail/app-framework';
+
+export async function setLoggerConfig(appConfig) {
+  let logLevel: LogLevel = LogLevel.INFO;
+  if(!appConfig.logLevel) {
+    //pass
+  } else if (appConfig.logLevel === 'error') {
+    logLevel = LogLevel.ERROR;
+  } else if (appConfig.logLevel === 'warn') {
+    logLevel = LogLevel.WARN;
+  } else if (appConfig.logLevel === 'info') {
+    logLevel = LogLevel.INFO;
+  } else if (appConfig.logLevel === 'debug') {
+    logLevel = LogLevel.DEBUG;
+  } else {
+    console.log('could not parse log level:', appConfig);
+  }
+
+  Logger.setConfig({logLevel: logLevel});
+}

package/src/util/map-util-spec-mockData.ts

@@ -0,0 +1,231 @@
+'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/src/util/map-utils.spec.ts

@@ -0,0 +1,103 @@
+
+const maps = require('./map-util-spec-mockData').mapping;
+
+const mockData = {
+  file1: maps
+};
+
+const mockGetMapFileFunction = jest.fn(async (fileId) =>{
+  return mockData[fileId];
+});
+
+
+import { Entities } from '@contrail/sdk';
+import { MapFileUtil } from '@contrail/transform-data';
+import { MapUtil } from './map-utils';
+
+describe('getMapKey', () =>{
+  const transformMapFile = 'file1';
+  const mapFileUtil = new MapFileUtil(new Entities());
+  let spy;
+  beforeAll(() =>{
+    spy = jest.spyOn(mapFileUtil, 'getMapFile').mockImplementation(mockGetMapFileFunction);
+  });
+  beforeEach(()=>{
+    spy.mockClear();
+  });
+  afterAll(() =>{
+    spy.mockRestore();
+  });
+  it('custom-entity:pack', async () =>{
+    const entity = {
+      typePath: 'custom-entity:pack',
+      entityType: 'custom-entity'
+    }
+    const expectedMapKey = 'packaging';
+
+    const results:string = await MapUtil.getMapKey(transformMapFile, mapFileUtil, entity, entity.entityType, 'vibe2flex');;
+    expect(results).toEqual(expectedMapKey);
+  });
+
+  it('custom-entity:prefix', async () =>{
+    const entity = {
+      typePath: 'custom-entity:prefix',
+      entityType: 'custom-entity'
+    }
+    const expectedMapKey = 'prefix';
+
+    const results:string = await MapUtil.getMapKey(transformMapFile, mapFileUtil, entity, entity.entityType, 'vibe2flex');;
+    expect(results).toEqual(expectedMapKey);
+  });
+
+  it('color - no mapping exists', async () =>{
+    const entity = {
+      typePath: 'color',
+      entityType: 'color'
+    }
+    const expectedMapKey = undefined;
+
+    const results:string = await MapUtil.getMapKey(transformMapFile, mapFileUtil, entity, entity.entityType, 'vibe2flex');;
+    expect(results).toEqual(expectedMapKey);
+  });
+
+});
+
+describe('getFullMapSection', () =>{
+  const transformMapFile = 'file1';
+  const mapFileUtil = new MapFileUtil(new Entities());
+  let spy;
+  beforeAll(() =>{
+    spy = jest.spyOn(mapFileUtil, 'getMapFile').mockImplementation(mockGetMapFileFunction);
+  });
+  beforeEach(()=>{
+    spy.mockClear();
+  });
+  afterAll(() =>{
+    spy.mockRestore();
+  });
+  it('custom-entity:pack', async () =>{
+    const mapKey = 'packaging';
+
+    const mapSection = await MapUtil.getFullMapSection(transformMapFile, mapFileUtil, mapKey);
+    expect(mapSection).toHaveProperty('vibe2flex');
+    expect(mapSection).toHaveProperty('flex2vibe');
+  });
+
+  it('custom-entity:catName', async () =>{
+    const mapKey = 'catName';
+
+    const mapSection = await MapUtil.getFullMapSection(transformMapFile, mapFileUtil, mapKey);
+    expect(mapSection).toHaveProperty('vibe2flex');
+    expect(mapSection).toHaveProperty('flex2vibe');
+    expect(mapSection).toHaveProperty('getIdentifierProperties');
+    expect(mapSection).toHaveProperty('getInformationalProperties');
+  });
+
+  it('color - no mapping exists', async () =>{
+    const mapKey = 'color';
+
+    const mapSection = await MapUtil.getFullMapSection(transformMapFile, mapFileUtil, mapKey);
+    expect(mapSection).toBeUndefined();
+  });
+
+});

package/src/util/map-utils.ts

@@ -0,0 +1,41 @@
+import { MapFileUtil } from '@contrail/transform-data';
+export 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: any, mapSectionKey: string, direction: string, transformTaskOrderKey: string = 'transformOrder'): Promise<any> {
+        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: MapFileUtil, data: any, type: string, direction: string): Promise<string> {
+        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: string, mapFileUtil: MapFileUtil, mapSectionKey: string):Promise<any> {
+        return await mapFileUtil.getFullMapSection(transformMapFile, mapSectionKey);
+    }
+}

package/src/util/mockData.ts

@@ -0,0 +1,101 @@
+export const empty_custom_sizes = [];
+export const four_custom_sizes = [
+  {
+    size: 1000,
+    id: '-QwFOWnCs0Gb5jkA',
+    slug: 'CS_1000',
+    name: 'CS_1000'
+  },
+  {
+    size: 300,
+    id: 'AKXOowvhJRnkerG8',
+    slug: 'CS_300',
+    name: 'CS_300'
+  },
+  {
+    size: 500,
+    id: '9asQ65N188RIYgnh',
+    slug: 'CS_500',
+    name: 'CS_500'
+  },
+  {
+    size: 800,
+    id: 'xkzhwE4nJ6iRwfvP',
+    slug: 'CS_800',
+    name: 'CS_800'
+  }
+];
+
+export const thumbnail_content_entity = {
+  fileName: 'JACKET 300_SOLDIER OLIVE.png',
+  primaryFileId: 'yn2d5oHD4rXHRzyB',
+  primaryFileUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Ff646d3cd-e23a-4689-bd16-0301d2036720.png',
+  primaryFile: {
+    fileName: 'JACKET 300_SOLDIER OLIVE.png',
+    id: 'yn2d5oHD4rXHRzyB',
+    size: 1757973
+  },
+  tinyViewableId: '6HWzJrQ-Jx1iefmj',
+  tinyViewableUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Fb68f8652-f33f-452f-ae34-25397b4521eb.png',
+  tinyViewable: {
+    fileName: 'JACKET 300_SOLDIER OLIVE_tiny.png',
+    id: '6HWzJrQ-Jx1iefmj',
+    size: 1784
+  },
+  smallViewableId: 'D3WRW4iRmjLzp5VX',
+  smallViewableUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2F541c53f8-fd85-418e-ae28-ad7410658b90.png',
+  smallViewable: {
+    fileName: 'JACKET 300_SOLDIER OLIVE_small.png',
+    id: 'D3WRW4iRmjLzp5VX',
+    size: 8699
+  },
+  mediumViewableId: 'AsRvJenpeqxksUNW',
+  mediumViewableUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Fe803c2d3-3e1b-4d9c-9bb9-2c488f1f295b.png',
+  mediumViewable: {
+    fileName: 'JACKET 300_SOLDIER OLIVE_medium.png',
+    id: 'AsRvJenpeqxksUNW',
+    size: 77558
+  },
+  largeViewableId: 'vo4N4mCd-tFrw101',
+  largeViewableUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Fb1b7a55c-b8ba-4857-be4e-e1c3f11d8e9a.png',
+  largeViewable: {
+    fileName: 'JACKET 300_SOLDIER OLIVE_large.png',
+    id: 'vo4N4mCd-tFrw101',
+    size: 1781538
+  },
+  CS_300Id: '6A5AG33nVu3Z6ogO',
+  CS_300Url: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2F3f2ea306-a77f-4cc3-a49a-75fb5d8b113c.png',
+  CS_300: {
+    fileName: 'JACKET 300_SOLDIER OLIVE_CS_300.png',
+    id: '6A5AG33nVu3Z6ogO',
+    size: 141153
+  },
+  CS_500Id: 'rBaHc1J2xdOWdbhI',
+  CS_500Url: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2F979c8c65-b63f-4220-aa2e-11520f2f68bf.png',
+  CS_500: {
+    fileName: 'JACKET 300_SOLDIER OLIVE_CS_500.png',
+    id: 'rBaHc1J2xdOWdbhI',
+    size: 382057
+  },
+  CS_800Id: 'ZPAeYI3JiqjQ7unY',
+  CS_800Url: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Fc58eeffa-2592-4698-a058-19281cda447c.png',
+  CS_800:{
+    fileName: 'JACKET 300_SOLDIER OLIVE_CS_800.png',
+    id: 'ZPAeYI3JiqjQ7unY',
+    size: 1008702
+  },
+  CS_1000Id: 'Hg_CthwsD4ozopCb',
+  CS_1000Url: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2F2c827c7b-361b-4e05-b77d-4280294f9d9c.png',
+  CS_1000: {
+    fileName: 'JACKET 300_SOLDIER OLIVE_CS_1000.png',
+    id: 'Hg_CthwsD4ozopCb',
+    size: 1605889
+  },
+  createdOn: '2023-07-05T15:02:13.950Z',
+  orgId: '5LZnKVTNxvwMqufy',
+  id: 'cuRficeyoStwTF-f',
+  contentType: 'image/png',
+  createdById: 'SWIFPZeZzkBvrSLD',
+  updatedById: 'SWIFPZeZzkBvrSLD',
+  fileSize: 1757973
+};