@contrail/flexplm 1.1.51 → 1.1.53

package/src/transform/identifier-conversion.spec.ts

@@ -0,0 +1,354 @@
+import { MapFileUtil } from "@contrail/transform-data";
+import { IdentifierConversion } from "./identifier-conversion";
+import { DataConverter } from "../util/data-converter";
+import { FCConfig } from "../interfaces/interfaces";
+import { Entities } from "@contrail/sdk";
+
+const mapFile1Data = require('./identifier-conversion-spec-mockData');
+const mapFile1Mappings = mapFile1Data?.mapping;
+const mapFile2Mappings = mapFile1Data?.mapping2;
+const mappings = {
+  mapFile1: mapFile1Mappings,
+  mapFile2: mapFile2Mappings
+};
+
+describe('getAssortmentFromObject', () => {
+  const transformMapFile1 = 'mapFile1';
+  const transformMapFile2 = 'mapFile2';
+  const config = {} as FCConfig;
+  const mapFileUtil = new MapFileUtil(new Entities());
+  mapFileUtil.getMapFile = async (fileId: string) => {
+    return mappings[fileId];
+  };
+  const dc = new DataConverter(config, mapFileUtil);
+  dc.getEntityValues = async (objectClass: string, data: any, keysToSkip: string[] = []) => {
+    const entityValues = {};
+    for (const key of Object.keys(data)) {
+      const value = data[key];
+      if (value) {
+        const to = typeof value;
+        if (['string', 'number', 'boolean'].includes(to)) {
+          entityValues[key] = value;
+        } else if (Array.isArray(value)) {
+          //multi select
+          entityValues[key] = value.map((v) => v.value);
+        } else if (value.value) {
+          //single select
+          entityValues[key] = value.value;
+        }
+      }
+    }
+    return entityValues;
+  };
+
+  it('should error if no object is provided', async () => {
+    try {
+      await IdentifierConversion.getAssortmentCriteriaFromObject(transformMapFile1, mapFileUtil, dc, null);
+    } catch (e) {
+      expect(e.message).toEqual(expect.stringContaining(IdentifierConversion.MISSING_OBJECT));
+    }
+  });
+
+  it('should error if no flexPLMObjectClass is provided', async () => {
+    try {
+      await IdentifierConversion.getAssortmentCriteriaFromObject(transformMapFile1, mapFileUtil, dc, {});
+    } catch (e) {
+      expect(e.message).toEqual(expect.stringContaining(IdentifierConversion.MISSING_FLEXPLM_OBJECT_CLASS));
+    }
+  });
+
+  it('should return the assortment criteria from the object - flexPLMSeasonName', async () => {
+    const object = {
+      "brand": {
+        "display": "Vibe IQ",
+        "value": "vibeiq"
+      },
+      "flexPLMObjectClass": "LCSSeason",
+      "flexPLMTypePath": "Season",
+      "seasonName": "Vibe IQ Spring 2004",
+      "seasonType": {
+        "display": "Spring",
+        "value": "spring"
+      },
+      "year": {
+        "display": "2004",
+        "value": "2004"
+      }
+    };
+    const criteriaObject = {
+      flexPLMObjectClass: 'LCSSeason',
+      flexPLMSeasonName: 'Vibe IQ Spring 2004',
+      flexPLMTypePath: 'Season'
+    };
+    const resultsObject = {
+      flexPLMSeasonName: 'Vibe IQ Spring 2004'
+    };
+    let getEntityValuesSpyOn = undefined
+    try {
+
+      getEntityValuesSpyOn = jest.spyOn(dc, 'getEntityValues');
+      const result = await IdentifierConversion.getAssortmentCriteriaFromObject(transformMapFile1, mapFileUtil, dc, object);
+      expect(getEntityValuesSpyOn).toHaveBeenCalledWith('LCSSeason', criteriaObject, []);
+      expect(result).toEqual(resultsObject);
+    } finally {
+      if (getEntityValuesSpyOn) {
+        getEntityValuesSpyOn.mockRestore();
+      }
+    }
+  });
+
+  it('should return the assortment criteria from the object - brand,year,seasonType', async () => {
+    const object = {
+      brand: {
+        display: "Vibe IQ",
+        value: "vibeiq"
+      },
+      flexPLMObjectClass: "LCSSeason",
+      flexPLMTypePath: "Season",
+      seasonName: "Vibe IQ Spring 2004",
+      seasonType: {
+        display: "Spring",
+        value: "spring"
+      },
+      year: {
+        "display": "2004",
+        "value": "2004"
+      }
+    };
+    const criteriaObject = {
+      flexPLMObjectClass: 'LCSSeason',
+      brand: {
+        "display": "Vibe IQ",
+        "value": "vibeiq"
+      },
+      year: {
+        "display": "2004",
+        "value": "2004"
+      },
+      seasonType: {
+        "display": "Spring",
+        "value": "spring"
+      },
+      flexPLMTypePath: 'Season'
+    };
+    const resultsObject = {
+      brand: 'vibeiq',
+      year: '2004',
+      seasonType: 'spring'
+    };
+    let getEntityValuesSpyOn = undefined
+    try {
+
+      getEntityValuesSpyOn = jest.spyOn(dc, 'getEntityValues');
+      const result = await IdentifierConversion.getAssortmentCriteriaFromObject(transformMapFile2, mapFileUtil, dc, object);
+      expect(getEntityValuesSpyOn).toHaveBeenCalledWith('LCSSeason', criteriaObject, []);
+      expect(result).toEqual(resultsObject);
+    } finally {
+      if (getEntityValuesSpyOn) {
+        getEntityValuesSpyOn.mockRestore();
+      }
+    }
+  });
+
+});
+
+describe('getItemCriteriaFromObject', () => {
+  const transformMapFile1 = 'mapFile1';
+  const transformMapFile2 = 'mapFile2';
+  const config = {} as FCConfig;
+  const mapFileUtil = new MapFileUtil(new Entities());
+  mapFileUtil.getMapFile = async (fileId: string) => {
+    return mappings[fileId];
+  };
+  const dc = new DataConverter(config, mapFileUtil);
+  dc.getEntityValues = async (objectClass: string, data: any, keysToSkip: string[] = []) => {
+    const entityValues = {};
+    for (const key of Object.keys(data)) {
+      const value = data[key];
+      if (value) {
+        const to = typeof value;
+        if (['string', 'number', 'boolean'].includes(to)) {
+          entityValues[key] = value;
+        } else if (Array.isArray(value)) {
+          //multi select
+          entityValues[key] = value.map((v) => v.value);
+        } else if (value.value) {
+          //single select
+          entityValues[key] = value.value;
+        }
+      }
+    }
+    return entityValues;
+  };
+
+  it('should error if no object is provided', async () => {
+    try {
+      await IdentifierConversion.getItemCriteriaFromObject(transformMapFile1, mapFileUtil, dc, null);
+    } catch (e) {
+      expect(e.message).toEqual(expect.stringContaining(IdentifierConversion.MISSING_OBJECT));
+    }
+  });
+
+  it('should error if no flexPLMObjectClass is provided', async () => {
+    try {
+      await IdentifierConversion.getItemCriteriaFromObject(transformMapFile1, mapFileUtil, dc, {});
+    } catch (e) {
+      expect(e.message).toEqual(expect.stringContaining(IdentifierConversion.MISSING_FLEXPLM_OBJECT_CLASS));
+    }
+  });
+
+  it('should error if missing identifier properties -itemNumber', async () => {
+    const object = {
+      "flexBoolean": false,
+      "flexMultiSelect": [
+      ],
+      "flexNumber": 0,
+      "flexPLMObjectClass": "LCSProduct",
+      "flexPLMTypePath": "Product\\Pants",
+      "flexSingleList": {
+        "display": "Five",
+        "value": "five"
+      },
+      "productName": "Feb 3 - 1 Option A",
+      "NotvibeIQIdentifier": 966
+    };
+    const criteriaObject = {
+      flexPLMObjectClass: 'LCSProduct',
+      flexPLMTypePath: 'Product\\Pants',
+    };
+
+    let getEntityValuesSpyOn = undefined
+    try {
+
+      getEntityValuesSpyOn = jest.spyOn(dc, 'getEntityValues');
+      await IdentifierConversion.getItemCriteriaFromObject(transformMapFile1, mapFileUtil, dc, object);
+    }catch (e) {
+      expect(getEntityValuesSpyOn).toHaveBeenCalledWith('LCSProduct', criteriaObject, []);
+      expect(e.message).toEqual(expect.stringContaining(IdentifierConversion.INBOUND_ENTITY_MISSING_IDENIFIER_PROPS));
+
+    } finally {
+      if (getEntityValuesSpyOn) {
+        getEntityValuesSpyOn.mockRestore();
+      }
+    }
+  });
+
+  it('should return the item family criteria from the object -itemNumber', async () => {
+    const object = {
+      "flexBoolean": false,
+      "flexMultiSelect": [
+      ],
+      "flexNumber": 0,
+      "flexPLMObjectClass": "LCSProduct",
+      "flexPLMTypePath": "Product\\Pants",
+      "flexSingleList": {
+        "display": "Five",
+        "value": "five"
+      },
+      "productName": "Feb 3 - 1 Option A",
+      "vibeIQIdentifier": 966
+    };
+    const criteriaObject = {
+      flexPLMObjectClass: 'LCSProduct',
+      itemNumber: 966,
+      flexPLMTypePath: 'Product\\Pants',
+    };
+    const resultsObject = {
+      roles: 'family',
+      itemNumber: 966
+    };
+    let getEntityValuesSpyOn = undefined
+    try {
+
+      getEntityValuesSpyOn = jest.spyOn(dc, 'getEntityValues');
+      const result = await IdentifierConversion.getItemCriteriaFromObject(transformMapFile1, mapFileUtil, dc, object);
+      expect(getEntityValuesSpyOn).toHaveBeenCalledWith('LCSProduct', criteriaObject, []);
+      expect(result).toEqual(resultsObject);
+    } finally {
+      if (getEntityValuesSpyOn) {
+        getEntityValuesSpyOn.mockRestore();
+      }
+    }
+  });
+
+  it('should return the item option criteria from the object -itemNumber', async () => {
+    const object = {
+      "flexBoolean": false,
+      "flexMultiSelect": [
+      ],
+      "flexNumber": 0,
+      "flexPLMObjectClass": "LCSSKU",
+      "flexPLMTypePath": "Product\\Pants",
+      "flexSingleList": {
+        "display": "Five",
+        "value": "five"
+      },
+      "productName": "Feb 3 - 1 Option A",
+      "vibeIQIdentifier": 2876
+    };
+    const criteriaObject = {
+      flexPLMObjectClass: 'LCSSKU',
+      itemNumber: 2876,
+      flexPLMTypePath: 'Product\\Pants',
+    };
+    const resultsObject = {
+      roles: 'color',
+      itemNumber: 2876
+    };
+    let getEntityValuesSpyOn = undefined
+    try {
+
+      getEntityValuesSpyOn = jest.spyOn(dc, 'getEntityValues');
+      const result = await IdentifierConversion.getItemCriteriaFromObject(transformMapFile1, mapFileUtil, dc, object);
+      expect(getEntityValuesSpyOn).toHaveBeenCalledWith('LCSSKU', criteriaObject, []);
+      expect(result).toEqual(resultsObject);
+    } finally {
+      if (getEntityValuesSpyOn) {
+        getEntityValuesSpyOn.mockRestore();
+      }
+    }
+  });
+
+  it('should return the item option criteria from the object -uniqueIdentifierA, uniqueIdentifierB', async () => {
+    const object = {
+      "flexBoolean": false,
+      "flexMultiSelect": [
+      ],
+      "flexNumber": 0,
+      "flexPLMObjectClass": "LCSSKU",
+      "flexPLMTypePath": "Product\\Pants",
+      "flexSingleList": {
+        "display": "Five",
+        "value": "five"
+      },
+      "productName": "Feb 3 - 1 Option A",
+      uniqueIdentifierA: 28,
+      uniqueIdentifierB: 29,
+      "vibeIQIdentifier": 2876
+    };
+    const criteriaObject = {
+      flexPLMObjectClass: 'LCSSKU',
+      uniqueIdentifierA: 28,
+      uniqueIdentifierB: 29,
+      flexPLMTypePath: 'Product\\Pants',
+    };
+    const resultsObject = {
+      roles: 'color',
+      uniqueIdentifierA: 28,
+      uniqueIdentifierB: 29,
+    };
+    let getEntityValuesSpyOn = undefined
+    try {
+
+      getEntityValuesSpyOn = jest.spyOn(dc, 'getEntityValues');
+      const result = await IdentifierConversion.getItemCriteriaFromObject(transformMapFile2, mapFileUtil, dc, object);
+      expect(getEntityValuesSpyOn).toHaveBeenCalledWith('LCSSKU', criteriaObject, []);
+      expect(result).toEqual(resultsObject);
+    } finally {
+      if (getEntityValuesSpyOn) {
+        getEntityValuesSpyOn.mockRestore();
+      }
+    }
+  });
+
+});

package/src/transform/identifier-conversion.ts

@@ -3,8 +3,14 @@ import { ProductFederation, SeasonFederation, SeasonGroupFederation, SkuFederati
 import { MapUtil } from "../util/map-utils";
 import { TypeConversionUtils } from "../util/type-conversion-utils";
 import { DataConverter } from "../util/data-converter";
+import { EventShortMessageStatus } from "../util/event-short-message-status";
 
 export class IdentifierConversion {
+  static readonly INBOUND_ENTITY_MISSING_IDENIFIER_PROPS = 'IdentifierConversion.getEntityCriteriaFromObject(): missing identifier properties: ';
+
+  static readonly MISSING_OBJECT = 'IdentifierConversion.getEntityCriteriaFromObject(): missing: object';
+
+  static readonly MISSING_FLEXPLM_OBJECT_CLASS = 'IdentifierConversion.getEntityCriteriaFromObject(): missing: flexPLMObjectClass';
 
   /** Takes in an assortment and returns an object to query for an LCSSeason
    * This will only return the identifier properties, and information properties if specified.
@@ -223,4 +229,54 @@ export class IdentifierConversion {
 
     return skuObj as SkuFederation;
   }
+
+  static async getEntityCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any> {
+    if(!object){
+      const e =new Error(IdentifierConversion.MISSING_OBJECT)
+      e['shortStatusMessage'] = EventShortMessageStatus.MISSING_INPUT;
+      throw e;
+    } else if(!object.flexPLMObjectClass){
+      const e = new Error(IdentifierConversion.MISSING_FLEXPLM_OBJECT_CLASS);
+      e['shortStatusMessage'] = EventShortMessageStatus.MISSING_INPUT;
+      throw e;
+    }
+    const mapKey: string = await TypeConversionUtils.getMapKeyFromObject(transformMapFile, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
+
+    const identifierKeys: string[] = await TypeConversionUtils.getIdentifierPropertiesFromObject(transformMapFile, mapFileUtil, object);
+    const objectData = await MapUtil.applyTransformMap(transformMapFile, mapFileUtil, object, mapKey, TypeConversionUtils.FLEX2VIBE_DIRECTION);
+
+    let identifierValues = identifierKeys.reduce((acc, key) => {
+      acc[key] = objectData[key];
+      return acc;
+    }, {});
+    identifierValues['flexPLMObjectClass']= objectData?.flexPLMObjectClass;
+    identifierValues['flexPLMTypePath']= objectData?.flexPLMTypePath;
+
+    identifierValues = await dc.getEntityValues(objectData?.flexPLMObjectClass, identifierValues, []);
+
+    const entityKeys = Object.keys(identifierValues);
+    const hasAllIdentifiers = identifierKeys.every(key => entityKeys.includes(key));
+    if (!hasAllIdentifiers) {
+      const e = new Error(IdentifierConversion.INBOUND_ENTITY_MISSING_IDENIFIER_PROPS + identifierKeys);
+      e['shortStatusMessage'] = EventShortMessageStatus.MISSING_IDENTIFIER_PROPERTIES;
+
+      throw e;
+    }
+    const criteria = {};
+    for (const key of identifierKeys) {
+      criteria[key] = identifierValues[key];
+    }
+    return criteria;
+  }
+  static async getAssortmentCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any> {
+    return IdentifierConversion.getEntityCriteriaFromObject(transformMapFile, mapFileUtil, dc, object);
+  }
+
+  static async getItemCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any> {
+    const criteria = await IdentifierConversion.getEntityCriteriaFromObject(transformMapFile, mapFileUtil, dc, object);
+    const roles = (object.flexPLMObjectClass === 'LCSProduct') ? 'family' : 'color';
+    criteria['roles'] = roles;
+
+    return criteria;
+  }
 }

package/src/util/event-short-message-status.ts

@@ -0,0 +1,17 @@
+export enum EventShortMessageStatus {
+  SUCCESS = 'Success',
+  FAILURE = 'Failure',
+  CREATED = 'Created',
+  MISSING_IDENTIFIER_PROPERTIES = 'Missing_identifier_properties',
+  MISSING_INPUT = 'Missing_input',
+  NOT_CREATABLE = 'Not_creatable',
+  NO_CHANGES = 'No_Changes',
+  TOO_MANY_ENTITIES_FOUND = 'Too_Many_Entities_Found',
+  UPDATED = 'Updated',
+
+  //Publish
+  NOT_PUBLISHABLE = 'Not_Publishable',
+  NO_FEDERATION_INFO = 'No_Federation_Information',
+  NO_EVENTS_TO_SEND = 'No_Events_to_Send',
+
+}

package/src/util/flexplm-connect.ts

@@ -58,8 +58,10 @@ export class FlexPLMConnect {
       const message = 'Error connecting to FlexPLM:status: ' + response.status;
       console.error(message);
       console.error(await response.text());
-      throw new Error(message);
-    }
+      const e = new Error(message);
+      e['httpResponseStatus'] = response.status;
+      throw e;
+}
 
     try{
 
@@ -130,7 +132,9 @@ export class FlexPLMConnect {
       const message = 'Error sending data to FlexPLM:status: ' + response.status;
       console.error(message);
       console.error(await response.text());
-      throw new Error(message);
+      const e = new Error(message);
+      e['httpResponseStatus'] = status;
+      throw e;
     }
 
     try{