@contrail/flexplm 1.1.12 → 1.1.14

package/src/util/thumbnail-util.spec.ts

@@ -0,0 +1,152 @@
+import { FCConfig } from '../interfaces/interfaces';
+import { ThumbnailUtil } from './thumbnail-util';
+
+import { empty_custom_sizes, four_custom_sizes, thumbnail_content_entity, cuRficeyoStwTF_f_fileEntities } from './mockData';
+
+describe('ThumbnailUtil Tests', () =>{
+  const config = {} as FCConfig;
+  describe('setOutboundThumbnail()', () =>{
+    const tu = new ThumbnailUtil(config);
+    beforeEach(() =>{
+      jest.clearAllMocks();
+    });
+
+    it('no data', async () =>{
+      const data = {};
+      const event = {};
+      const results = await tu.setOutboundThumbnail(data, event);
+      const keys = Object.keys(results);
+
+      expect(results).toEqual(data);
+      expect(keys.length).toEqual(0);
+    });
+
+    it('remove thumbnail', async () =>{
+      const data = {};
+      const event = {
+        propertyDiffs: {
+          largeViewableDownloadUrl: {
+            oldValue: '123',
+            newValue: null
+          }
+        }
+      };
+      const results = await tu.setOutboundThumbnail(data, event);
+      const keys = Object.keys(results);
+
+      expect(keys.length).toEqual(1);
+      expect(keys[0]).toEqual(ThumbnailUtil.NEW_THUMBNAIL_ID);
+      expect(results[ThumbnailUtil.NEW_THUMBNAIL_ID]).toEqual(ThumbnailUtil.REMOVE_THUMBNAIL);
+
+    });
+
+    it('calling getFileId - new thumbnail', async () =>{
+      const data = {};
+      const newDownloadUrl = 'https://api.vibeiq.com/dev/api/files/downloadUrl/w3ckfeGAD8ViOZj-%2Fcontent:E1iBQuWbr74lcdcw%2F9e30ds9o-d34b-451e-ae59-b4km36018d5a.png';
+      const oldDownloadUrl = 'xxx';
+      const thumbnailId = 'Eey3ZOiqdrUA84F8';
+      const event = {
+        newData: {
+          primaryViewableId: 'm5bJa4RtTLUtKBP5',
+          largeViewableDownloadUrl: newDownloadUrl
+        },
+        propertyDiffs: {
+          largeViewableDownloadUrl :{
+            newValue: newDownloadUrl,
+            oldValue: oldDownloadUrl
+          }
+        }
+      };
+
+      const spyGetFileId = jest.spyOn(tu, 'getFileId');
+      spyGetFileId.mockReturnValue(Promise.resolve(thumbnailId));
+      const results = await tu.setOutboundThumbnail(data, event);
+      const keys = Object.keys(results);
+      expect(keys.length).toEqual(1);
+      expect(keys[0]).toEqual(ThumbnailUtil.NEW_THUMBNAIL_ID);
+      const thumbnailValue = results[ThumbnailUtil.NEW_THUMBNAIL_ID];
+      expect(thumbnailValue).toEqual(thumbnailId);
+    });
+
+    it('calling getFileId - existing thumbnail', async () =>{
+      const data = {};
+      const newDownloadUrl = 'https://api.vibeiq.com/dev/api/files/downloadUrl/w3ckfeGAD8ViOZj-%2Fcontent:E1iBQuWbr74lcdcw%2F9e30ds9o-d34b-451e-ae59-b4km36018d5a.png';
+      const thumbnailId = 'Eey3ZOiqdrUA84F8';
+      const event = {
+        newData: {
+          primaryViewableId: 'm5bJa4RtTLUtKBP5',
+          largeViewableDownloadUrl: newDownloadUrl
+        },
+        propertyDiffs: {}
+      };
+
+      const spyGetFileId = jest.spyOn(tu, 'getFileId');
+      spyGetFileId.mockReturnValue(Promise.resolve(thumbnailId));
+      const results = await tu.setOutboundThumbnail(data, event);
+      const keys = Object.keys(results);
+      expect(keys.length).toEqual(1);
+      expect(keys[0]).toEqual(ThumbnailUtil.EXISTING_THUMBNAIL_ID);
+      const thumbnailValue = results[ThumbnailUtil.EXISTING_THUMBNAIL_ID];
+      expect(thumbnailValue).toEqual(thumbnailId);
+    });
+  });
+
+  describe('getFileId', () =>{
+    const primaryFileId = 'yn2d5oHD4rXHRzyB';
+    beforeEach(() =>{
+      jest.clearAllMocks();
+    });
+    it('no custom sizes, default max_thumbnail_size - result large', async () =>{
+      const tu = new ThumbnailUtil(config);
+      const spyCustomSizes = jest.spyOn(tu, 'getCustomSizes');
+      spyCustomSizes.mockReturnValue(Promise.resolve(empty_custom_sizes));
+      const spyContentEntity = jest.spyOn(tu, 'getContentEntity');
+      const content = thumbnail_content_entity;
+      spyContentEntity.mockReturnValue(Promise.resolve(content));
+
+      const spyGetFileEntities = jest.spyOn(tu, 'getFileEntities');
+      spyGetFileEntities.mockReturnValue(Promise.resolve(cuRficeyoStwTF_f_fileEntities));
+
+      const results = await tu.getFileId(primaryFileId);
+      expect(results).toEqual('vo4N4mCd-tFrw101');
+    });
+
+    it('no custom sizes, 750 * 1_024 max_thumbnail_size - result medium', async () =>{
+      const config1 = {
+        max_thumbnail_size: 750 * 1_024
+      } as any as FCConfig;
+      const tu = new ThumbnailUtil(config1);
+      const spyCustomSizes = jest.spyOn(tu, 'getCustomSizes');
+      spyCustomSizes.mockReturnValue(Promise.resolve(empty_custom_sizes));
+      const spyContentEntity = jest.spyOn(tu, 'getContentEntity');
+      const content = thumbnail_content_entity;
+      spyContentEntity.mockReturnValue(Promise.resolve(content));
+
+      const spyGetFileEntities = jest.spyOn(tu, 'getFileEntities');
+      spyGetFileEntities.mockReturnValue(Promise.resolve(cuRficeyoStwTF_f_fileEntities));
+
+      const results = await tu.getFileId(primaryFileId);
+      expect(results).toEqual('AsRvJenpeqxksUNW');
+    });
+
+    it('custom sizes, 750 * 1_024 max_thumbnail_size - result CS_500Id', async () =>{
+      console.log('custom sizes, 750 * 1_024 max_thumbnail_size - result CS_500Id');
+      const config1 = {
+        max_thumbnail_size: 750 * 1_024
+      } as any as FCConfig;
+      const tu = new ThumbnailUtil(config1);
+      const spyCustomSizes = jest.spyOn(tu, 'getCustomSizes');
+      spyCustomSizes.mockReturnValue(Promise.resolve(four_custom_sizes));
+      const spyContentEntity = jest.spyOn(tu, 'getContentEntity');
+      const content = thumbnail_content_entity;
+      spyContentEntity.mockReturnValue(Promise.resolve(content));
+
+      const spyGetFileEntities = jest.spyOn(tu, 'getFileEntities');
+      spyGetFileEntities.mockReturnValue(Promise.resolve(cuRficeyoStwTF_f_fileEntities));
+
+      const results = await tu.getFileId(primaryFileId);
+      expect(results).toEqual('rBaHc1J2xdOWdbhI');
+    });
+
+  });
+});

package/src/util/thumbnail-util.ts

@@ -0,0 +1,128 @@
+import { Logger } from '@contrail/app-framework';
+import { Entities } from '@contrail/sdk';
+import { FCConfig } from '../interfaces/interfaces';
+
+export class ThumbnailUtil {
+  private max_thumbnail_size = 5 * 1_024 * 1_024;
+  private entities: Entities;
+  static NEW_THUMBNAIL_ID = 'NEW_THUMBNAIL_ID';
+  static EXISTING_THUMBNAIL_ID = 'EXISTING_THUMBNAIL_ID';
+  static REMOVE_THUMBNAIL = 'REMOVE_THUMBNAIL';
+  constructor(private config: FCConfig){
+    this.entities = new Entities();
+    if(this.config['max_thumbnail_size']){
+      this.max_thumbnail_size = this.config['max_thumbnail_size'];
+    }
+  }
+  async setOutboundThumbnail(data, event){
+    if(event?.newData?.primaryViewableId && event?.newData?.largeViewableDownloadUrl){
+      const primaryViewableId = event.newData.primaryViewableId;
+
+      //get custom sizes
+      const fileId = await this.getFileId(primaryViewableId);
+
+      if(fileId){
+        const key = (event?.propertyDiffs?.largeViewableDownloadUrl)
+          ? ThumbnailUtil.NEW_THUMBNAIL_ID
+          : ThumbnailUtil.EXISTING_THUMBNAIL_ID;
+        data[key] = fileId;
+      }
+    } else if(event?.propertyDiffs?.largeViewableDownloadUrl?.oldValue && !event?.propertyDiffs?.largeViewableDownloadUrl?.newValue){
+      data[ThumbnailUtil.NEW_THUMBNAIL_ID] = ThumbnailUtil.REMOVE_THUMBNAIL;
+
+    }
+    return data;
+  }
+
+  public async getFileId(primaryViewableId: string): Promise<string> {
+    console.info('getFileId()-' + primaryViewableId);
+    const sizes = await this.getCustomSizes();
+
+    const OOBSizes = [{ slug: 'largeViewable' }, { slug: 'mediumViewable' }, { slug: 'smallViewable' }, { slug: 'tinyViewable' }];
+    sizes.push(...OOBSizes);
+    console.info('sizes: ' + JSON.stringify(sizes));
+
+    //get Content
+    const content = await this.getContentEntity(primaryViewableId);
+    if(Logger.isDebugOn()){
+      console.debug('content: ' + JSON.stringify(content));
+
+    }
+    if (!content) {
+      return undefined;
+    }
+    //get file entities
+    const contentKeys = Object.getOwnPropertyNames(content);
+    const fileEntityIds = [];
+    for (const size of sizes) {
+      const key = size.slug + 'Id';
+      if (contentKeys.includes(key) && !fileEntityIds.includes(content[key])) {
+        fileEntityIds.push(content[key]);
+        size['fileId'] = content[key];
+      }
+    }
+
+    const fileResults = await this.getFileEntities(fileEntityIds);
+
+    if(Logger.isDebugOn()){
+      console.debug('fileResults: ' + JSON.stringify(fileResults));
+    }
+
+    // Finding largest image that is under the max limit
+    let fileId = undefined;
+    let tempFileSize = 0;
+    const isDebugOn = Logger.isDebugOn();
+    for (const sizeObj of sizes) {
+      if(isDebugOn){
+        console.debug('size: ' + JSON.stringify(sizeObj));
+      }
+      if (sizeObj['fileId']) {
+        const file = fileResults.find(f => f['id'] === sizeObj['fileId']);
+        if (file['size'] > tempFileSize && file['size'] < this.max_thumbnail_size) {
+          tempFileSize = file['size'];
+          fileId = file['id'];
+          if(isDebugOn){
+            console.debug('fileId: ' + fileId);
+          }
+        }
+      }
+    }
+    console.info('getFileId(): returning-' + fileId);
+    return fileId;
+  }
+
+  async getCustomSizes() {
+    const customSizes = await this.entities.get({
+      entityName: 'content-custom-size'
+    });
+    const sizes = [];
+    sizes.push(...customSizes);
+    return sizes;
+  }
+
+  async getContentEntity(primaryViewableId: any) {
+    const criteria = {
+      id: primaryViewableId
+    };
+    const contentResults = await this.entities.get({
+      entityName: 'content',
+      criteria
+    });
+    console.info('contentResults: ' + JSON.stringify(contentResults));
+    const content = (contentResults && contentResults[0]) ? contentResults[0] : undefined;
+    return content;
+  }
+
+  async getFileEntities(fileEntityIds: any[]) {
+    const criteria = {
+      ids: fileEntityIds
+    };
+
+    const fileResults = await this.entities.get({
+      entityName: 'file',
+      criteria
+    });
+    return fileResults;
+  }
+
+}

package/src/util/type-conversion-utils-spec-mockData.ts

@@ -0,0 +1,238 @@
+'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: {
+      LCSLast: {
+        getMapKey: (object) =>{ return 'catName';}
+      },
+      LCSRevisableEntity : {
+        getMapKey: (object) =>{
+          const typePath = object['flexPLMTypePath'];
+          let mapKey = '';
+          switch (typePath) {
+            case 'Revisable Entity\\packaging':
+              mapKey = 'packaging';
+              break
+            case 'Revisable Entity\\prefix':
+              mapKey = 'prefix';
+              break
+          };
+          return mapKey;
+        }
+      }
+    }
+
+  },
+  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: () => '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',
+
+    }
+  },
+
+};