@contrail/flexplm 1.3.0 → 1.3.1-alpha.3507ab6

package/lib/transform/identifier-conversion.d.ts

@@ -1,15 +1,51 @@
-import { MapFileUtil } from "@contrail/transform-data";
-import { ProductFederation, SeasonFederation, SeasonGroupFederation, SkuFederation } from "../interfaces/interfaces";
-import { DataConverter } from "../util/data-converter";
-export declare 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";
-    static getSeasonIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, assortment: any, includeInformationKeys?: boolean): Promise<SeasonFederation>;
-    static getSeasonGroupIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, assortment: any, includeInformationKeys?: boolean): Promise<SeasonGroupFederation>;
-    static getProductIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, itemFamilyObject: any, includeInformationKeys?: boolean): Promise<ProductFederation>;
-    static getSKUIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, itemObject: any, includeInformationKeys?: boolean): Promise<SkuFederation>;
-    static getEntityCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any>;
-    static getAssortmentCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any>;
-    static getItemCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any>;
-}
+import { MapFileUtil } from "@contrail/transform-data";
+import { ProductFederation, SeasonFederation, SeasonGroupFederation, SkuFederation } from "../interfaces/interfaces";
+import { DataConverter } from "../util/data-converter";
+export declare 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.
+     * @param transformMapFile
+     * @param mapFileUtil
+     * @param dc
+     * @param assortment
+     * @param includeInformationKeys defaults true
+     * @returns
+     */
+    static getSeasonIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, assortment: any, includeInformationKeys?: boolean): Promise<SeasonFederation>;
+    /** Takes in an assortment and returns an object to query for an SeasonGroup
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
+    static getSeasonGroupIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, assortment: any, includeInformationKeys?: boolean): Promise<SeasonGroupFederation>;
+    /** Takes in an item and returns an object to query for an LCSProduct
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
+    static getProductIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, itemFamilyObject: any, includeInformationKeys?: boolean): Promise<ProductFederation>;
+    /** Takes in an item and returns an object to query for an LCSSKU
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
+    static getSKUIdentityObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, itemObject: any, includeInformationKeys?: boolean): Promise<SkuFederation>;
+    static getEntityCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any>;
+    static getAssortmentCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any>;
+    static getItemCriteriaFromObject(transformMapFile: string, mapFileUtil: MapFileUtil, dc: DataConverter, object: any): Promise<any>;
+}

package/lib/transform/identifier-conversion.js

@@ -1,212 +1,248 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IdentifierConversion = void 0;
-const map_utils_1 = require("../util/map-utils");
-const type_conversion_utils_1 = require("../util/type-conversion-utils");
-const event_short_message_status_1 = require("../util/event-short-message-status");
-class IdentifierConversion {
-    static async getSeasonIdentityObject(transformMapFile, mapFileUtil, dc, assortment, includeInformationKeys = true) {
-        if (!assortment) {
-            throw new Error('IdentifierConversion.getSeasonIdentityObject(): assortment must be provided.');
-        }
-        assortment['flex2vibeMapKeyRoot'] = 'LCSSeason';
-        const flexPLMTypePath = await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(transformMapFile, mapFileUtil, assortment);
-        let seasonObj = {
-            entityReference: 'assortment:' + assortment?.id,
-            objectClass: 'LCSSeason',
-            flexPLMTypePath
-        };
-        try {
-            const assortmentObj = await dc.getFlexPLMObjectData(assortment, [], true);
-            const identifierKeys = await type_conversion_utils_1.TypeConversionUtils.getIdentifierProperties(transformMapFile, mapFileUtil, assortment);
-            for (const key of identifierKeys) {
-                if (assortmentObj[key]) {
-                    seasonObj[key] = assortmentObj[key];
-                }
-            }
-            if (includeInformationKeys) {
-                const informationKeys = await type_conversion_utils_1.TypeConversionUtils
-                    .getInformationalProperties(transformMapFile, mapFileUtil, assortment);
-                for (const key of informationKeys) {
-                    if (assortmentObj[key]) {
-                        seasonObj[key] = assortmentObj[key];
-                    }
-                }
-            }
-            const objectKeys = Object.keys(seasonObj);
-            const hasAllIdentifiers = identifierKeys.every(key => objectKeys.includes(key));
-            if (!hasAllIdentifiers) {
-                console.error('IdentifierConversion.getSeasonIdentityObject(): doesnt have all identifier properties - ' + identifierKeys);
-                console.error('assortment: ' + JSON.stringify(assortment));
-            }
-            const mapKey = await type_conversion_utils_1.TypeConversionUtils
-                .getMapKey(transformMapFile, mapFileUtil, assortment, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-            seasonObj = await map_utils_1.MapUtil
-                .applyTransformMap(transformMapFile, mapFileUtil, seasonObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-        }
-        finally {
-            delete assortment['flex2vibeMapKeyRoot'];
-        }
-        return seasonObj;
-    }
-    static async getSeasonGroupIdentityObject(transformMapFile, mapFileUtil, dc, assortment, includeInformationKeys = true) {
-        if (!assortment) {
-            throw new Error('IdentifierConversion.getSeasonGroupIdentityObject(): assortment must be provided.');
-        }
-        assortment['flex2vibeMapKeyRoot'] = 'SeasonGroup';
-        const flexPLMTypePath = await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(transformMapFile, mapFileUtil, assortment);
-        let seasonGroupObj = {
-            entityReference: 'assortment:' + assortment?.id,
-            objectClass: 'SeasonGroup',
-            flexPLMTypePath
-        };
-        try {
-            const assortmentObj = await dc.getFlexPLMObjectData(assortment, [], true);
-            const identifierKeys = await type_conversion_utils_1.TypeConversionUtils
-                .getIdentifierProperties(transformMapFile, mapFileUtil, assortment);
-            for (const key of identifierKeys) {
-                if (assortmentObj[key]) {
-                    seasonGroupObj[key] = assortmentObj[key];
-                }
-            }
-            if (includeInformationKeys) {
-                const informationKeys = await type_conversion_utils_1.TypeConversionUtils
-                    .getInformationalProperties(transformMapFile, mapFileUtil, assortment);
-                for (const key of informationKeys) {
-                    if (assortmentObj[key]) {
-                        seasonGroupObj[key] = assortmentObj[key];
-                    }
-                }
-            }
-            const objectKeys = Object.keys(seasonGroupObj);
-            const hasAllIdentifiers = identifierKeys.every(key => objectKeys.includes(key));
-            if (!hasAllIdentifiers) {
-                console.error('IdentifierConversion.getSeasonGroupIdentityObject(): doesnt have all identifier properties - ' + identifierKeys);
-                console.error('assortment: ' + JSON.stringify(assortment));
-            }
-            const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKey(transformMapFile, mapFileUtil, assortment, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-            seasonGroupObj = await map_utils_1.MapUtil.applyTransformMap(transformMapFile, mapFileUtil, seasonGroupObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-        }
-        finally {
-            delete assortment['flex2vibeMapKeyRoot'];
-        }
-        return seasonGroupObj;
-    }
-    static async getProductIdentityObject(transformMapFile, mapFileUtil, dc, itemFamilyObject, includeInformationKeys = true) {
-        if (!itemFamilyObject) {
-            throw new Error('IdentifierConversion.getProductIdentityObject(): itemFamilyObject must be provided.');
-        }
-        const itemObj = await dc.getFlexPLMObjectData(itemFamilyObject, [], true);
-        const flexPLMTypePath = await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(transformMapFile, mapFileUtil, itemFamilyObject);
-        let prodObj = {
-            entityReference: 'item:' + itemFamilyObject?.id,
-            objectClass: 'LCSProduct',
-            flexPLMTypePath
-        };
-        const identifierKeys = await type_conversion_utils_1.TypeConversionUtils
-            .getIdentifierProperties(transformMapFile, mapFileUtil, itemFamilyObject);
-        for (const key of identifierKeys) {
-            if (itemObj[key]) {
-                prodObj[key] = itemObj[key];
-            }
-        }
-        if (includeInformationKeys) {
-            const informationKeys = await type_conversion_utils_1.TypeConversionUtils
-                .getInformationalProperties(transformMapFile, mapFileUtil, itemFamilyObject);
-            for (const key of informationKeys) {
-                if (itemObj[key]) {
-                    prodObj[key] = itemObj[key];
-                }
-            }
-        }
-        const vibeIQIdentifier = 'vibeIQIdentifier';
-        if (!prodObj[vibeIQIdentifier]) {
-            prodObj['vibeIQIdentifier'] = itemFamilyObject['identifier'] || itemFamilyObject['itemNumber'];
-        }
-        const mapKey = await type_conversion_utils_1.TypeConversionUtils
-            .getMapKey(transformMapFile, mapFileUtil, itemFamilyObject, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-        prodObj = await map_utils_1.MapUtil
-            .applyTransformMap(transformMapFile, mapFileUtil, prodObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-        return prodObj;
-    }
-    static async getSKUIdentityObject(transformMapFile, mapFileUtil, dc, itemObject, includeInformationKeys = true) {
-        if (!itemObject) {
-            throw new Error('IdentifierConversion.getSKUIdentityObject(): itemObject must be provided.');
-        }
-        const itemObj = await dc.getFlexPLMObjectData(itemObject, [], true);
-        const flexPLMTypePath = await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(transformMapFile, mapFileUtil, itemObject);
-        let skuObj = {
-            entityReference: 'item:' + itemObject?.id,
-            objectClass: 'LCSSKU',
-            flexPLMTypePath
-        };
-        const identifierKeys = await type_conversion_utils_1.TypeConversionUtils.getIdentifierProperties(transformMapFile, mapFileUtil, itemObject);
-        for (const key of identifierKeys) {
-            if (itemObj[key]) {
-                skuObj[key] = itemObj[key];
-            }
-        }
-        if (includeInformationKeys) {
-            const informationKeys = await type_conversion_utils_1.TypeConversionUtils.getInformationalProperties(transformMapFile, mapFileUtil, itemObject);
-            for (const key of informationKeys) {
-                if (itemObj[key]) {
-                    skuObj[key] = itemObj[key];
-                }
-            }
-        }
-        const vibeIQIdentifier = 'vibeIQIdentifier';
-        if (!skuObj[vibeIQIdentifier]) {
-            skuObj['vibeIQIdentifier'] = itemObject['identifier'] || itemObject['itemNumber'];
-        }
-        const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKey(transformMapFile, mapFileUtil, itemObject, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-        skuObj = await map_utils_1.MapUtil.applyTransformMap(transformMapFile, mapFileUtil, skuObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-        return skuObj;
-    }
-    static async getEntityCriteriaFromObject(transformMapFile, mapFileUtil, dc, object) {
-        if (!object) {
-            const e = new Error(IdentifierConversion.MISSING_OBJECT);
-            e['shortStatusMessage'] = event_short_message_status_1.EventShortMessageStatus.MISSING_INPUT;
-            throw e;
-        }
-        else if (!object.flexPLMObjectClass) {
-            const e = new Error(IdentifierConversion.MISSING_FLEXPLM_OBJECT_CLASS);
-            e['shortStatusMessage'] = event_short_message_status_1.EventShortMessageStatus.MISSING_INPUT;
-            throw e;
-        }
-        const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(transformMapFile, mapFileUtil, object, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
-        const identifierKeys = await type_conversion_utils_1.TypeConversionUtils.getIdentifierPropertiesFromObject(transformMapFile, mapFileUtil, object);
-        const objectData = await map_utils_1.MapUtil.applyTransformMap(transformMapFile, mapFileUtil, object, mapKey, type_conversion_utils_1.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'] = event_short_message_status_1.EventShortMessageStatus.MISSING_IDENTIFIER_PROPERTIES;
-            throw e;
-        }
-        const criteria = {};
-        for (const key of identifierKeys) {
-            criteria[key] = identifierValues[key];
-        }
-        return criteria;
-    }
-    static async getAssortmentCriteriaFromObject(transformMapFile, mapFileUtil, dc, object) {
-        return IdentifierConversion.getEntityCriteriaFromObject(transformMapFile, mapFileUtil, dc, object);
-    }
-    static async getItemCriteriaFromObject(transformMapFile, mapFileUtil, dc, object) {
-        const criteria = await IdentifierConversion.getEntityCriteriaFromObject(transformMapFile, mapFileUtil, dc, object);
-        const roles = (object.flexPLMObjectClass === 'LCSProduct') ? 'family' : 'color';
-        criteria['roles'] = roles;
-        return criteria;
-    }
-}
-exports.IdentifierConversion = IdentifierConversion;
-IdentifierConversion.INBOUND_ENTITY_MISSING_IDENIFIER_PROPS = 'IdentifierConversion.getEntityCriteriaFromObject(): missing identifier properties: ';
-IdentifierConversion.MISSING_OBJECT = 'IdentifierConversion.getEntityCriteriaFromObject(): missing: object';
-IdentifierConversion.MISSING_FLEXPLM_OBJECT_CLASS = 'IdentifierConversion.getEntityCriteriaFromObject(): missing: flexPLMObjectClass';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentifierConversion = void 0;
+const map_utils_1 = require("../util/map-utils");
+const type_conversion_utils_1 = require("../util/type-conversion-utils");
+const event_short_message_status_1 = require("../util/event-short-message-status");
+class IdentifierConversion {
+    /** 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.
+     * @param transformMapFile
+     * @param mapFileUtil
+     * @param dc
+     * @param assortment
+     * @param includeInformationKeys defaults true
+     * @returns
+     */
+    static async getSeasonIdentityObject(transformMapFile, mapFileUtil, dc, assortment, includeInformationKeys = true) {
+        if (!assortment) {
+            throw new Error('IdentifierConversion.getSeasonIdentityObject(): assortment must be provided.');
+        }
+        assortment['flex2vibeMapKeyRoot'] = 'LCSSeason';
+        const flexPLMTypePath = await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(transformMapFile, mapFileUtil, assortment);
+        let seasonObj = {
+            entityReference: 'assortment:' + assortment?.id,
+            objectClass: 'LCSSeason',
+            flexPLMTypePath
+        };
+        try {
+            const assortmentObj = await dc.getFlexPLMObjectData(assortment, [], true);
+            const identifierKeys = await type_conversion_utils_1.TypeConversionUtils.getIdentifierProperties(transformMapFile, mapFileUtil, assortment);
+            for (const key of identifierKeys) {
+                if (assortmentObj[key]) {
+                    seasonObj[key] = assortmentObj[key];
+                }
+            }
+            if (includeInformationKeys) {
+                const informationKeys = await type_conversion_utils_1.TypeConversionUtils
+                    .getInformationalProperties(transformMapFile, mapFileUtil, assortment);
+                for (const key of informationKeys) {
+                    if (assortmentObj[key]) {
+                        seasonObj[key] = assortmentObj[key];
+                    }
+                }
+            }
+            const objectKeys = Object.keys(seasonObj);
+            const hasAllIdentifiers = identifierKeys.every(key => objectKeys.includes(key));
+            if (!hasAllIdentifiers) {
+                console.error('IdentifierConversion.getSeasonIdentityObject(): doesnt have all identifier properties - ' + identifierKeys);
+                console.error('assortment: ' + JSON.stringify(assortment));
+            }
+            const mapKey = await type_conversion_utils_1.TypeConversionUtils
+                .getMapKey(transformMapFile, mapFileUtil, assortment, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+            seasonObj = await map_utils_1.MapUtil
+                .applyTransformMap(transformMapFile, mapFileUtil, seasonObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+        }
+        finally {
+            delete assortment['flex2vibeMapKeyRoot'];
+        }
+        return seasonObj;
+    }
+    /** Takes in an assortment and returns an object to query for an SeasonGroup
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
+    static async getSeasonGroupIdentityObject(transformMapFile, mapFileUtil, dc, assortment, includeInformationKeys = true) {
+        if (!assortment) {
+            throw new Error('IdentifierConversion.getSeasonGroupIdentityObject(): assortment must be provided.');
+        }
+        assortment['flex2vibeMapKeyRoot'] = 'SeasonGroup';
+        const flexPLMTypePath = await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(transformMapFile, mapFileUtil, assortment);
+        let seasonGroupObj = {
+            entityReference: 'assortment:' + assortment?.id,
+            objectClass: 'SeasonGroup',
+            flexPLMTypePath
+        };
+        try {
+            const assortmentObj = await dc.getFlexPLMObjectData(assortment, [], true);
+            const identifierKeys = await type_conversion_utils_1.TypeConversionUtils
+                .getIdentifierProperties(transformMapFile, mapFileUtil, assortment);
+            for (const key of identifierKeys) {
+                if (assortmentObj[key]) {
+                    seasonGroupObj[key] = assortmentObj[key];
+                }
+            }
+            if (includeInformationKeys) {
+                const informationKeys = await type_conversion_utils_1.TypeConversionUtils
+                    .getInformationalProperties(transformMapFile, mapFileUtil, assortment);
+                for (const key of informationKeys) {
+                    if (assortmentObj[key]) {
+                        seasonGroupObj[key] = assortmentObj[key];
+                    }
+                }
+            }
+            const objectKeys = Object.keys(seasonGroupObj);
+            const hasAllIdentifiers = identifierKeys.every(key => objectKeys.includes(key));
+            if (!hasAllIdentifiers) {
+                console.error('IdentifierConversion.getSeasonGroupIdentityObject(): doesnt have all identifier properties - ' + identifierKeys);
+                console.error('assortment: ' + JSON.stringify(assortment));
+            }
+            const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKey(transformMapFile, mapFileUtil, assortment, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+            seasonGroupObj = await map_utils_1.MapUtil.applyTransformMap(transformMapFile, mapFileUtil, seasonGroupObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+        }
+        finally {
+            delete assortment['flex2vibeMapKeyRoot'];
+        }
+        return seasonGroupObj;
+    }
+    /** Takes in an item and returns an object to query for an LCSProduct
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
+    static async getProductIdentityObject(transformMapFile, mapFileUtil, dc, itemFamilyObject, includeInformationKeys = true) {
+        if (!itemFamilyObject) {
+            throw new Error('IdentifierConversion.getProductIdentityObject(): itemFamilyObject must be provided.');
+        }
+        const itemObj = await dc.getFlexPLMObjectData(itemFamilyObject, [], true);
+        const flexPLMTypePath = await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(transformMapFile, mapFileUtil, itemFamilyObject);
+        let prodObj = {
+            entityReference: 'item:' + itemFamilyObject?.id,
+            objectClass: 'LCSProduct',
+            flexPLMTypePath
+        };
+        const identifierKeys = await type_conversion_utils_1.TypeConversionUtils
+            .getIdentifierProperties(transformMapFile, mapFileUtil, itemFamilyObject);
+        for (const key of identifierKeys) {
+            if (itemObj[key]) {
+                prodObj[key] = itemObj[key];
+            }
+        }
+        if (includeInformationKeys) {
+            const informationKeys = await type_conversion_utils_1.TypeConversionUtils
+                .getInformationalProperties(transformMapFile, mapFileUtil, itemFamilyObject);
+            for (const key of informationKeys) {
+                if (itemObj[key]) {
+                    prodObj[key] = itemObj[key];
+                }
+            }
+        }
+        const vibeIQIdentifier = 'vibeIQIdentifier';
+        if (!prodObj[vibeIQIdentifier]) {
+            prodObj['vibeIQIdentifier'] = itemFamilyObject['identifier'] || itemFamilyObject['itemNumber'];
+        }
+        const mapKey = await type_conversion_utils_1.TypeConversionUtils
+            .getMapKey(transformMapFile, mapFileUtil, itemFamilyObject, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+        prodObj = await map_utils_1.MapUtil
+            .applyTransformMap(transformMapFile, mapFileUtil, prodObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+        return prodObj;
+    }
+    /** Takes in an item and returns an object to query for an LCSSKU
+   * This will only return the identifier properties, and information properties if specified.
+   * @param transformMapFile
+   * @param mapFileUtil
+   * @param dc
+   * @param assortment
+   * @param includeInformationKeys defaults true
+   * @returns
+   */
+    static async getSKUIdentityObject(transformMapFile, mapFileUtil, dc, itemObject, includeInformationKeys = true) {
+        if (!itemObject) {
+            throw new Error('IdentifierConversion.getSKUIdentityObject(): itemObject must be provided.');
+        }
+        const itemObj = await dc.getFlexPLMObjectData(itemObject, [], true);
+        const flexPLMTypePath = await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(transformMapFile, mapFileUtil, itemObject);
+        let skuObj = {
+            entityReference: 'item:' + itemObject?.id,
+            objectClass: 'LCSSKU',
+            flexPLMTypePath
+        };
+        const identifierKeys = await type_conversion_utils_1.TypeConversionUtils.getIdentifierProperties(transformMapFile, mapFileUtil, itemObject);
+        for (const key of identifierKeys) {
+            if (itemObj[key]) {
+                skuObj[key] = itemObj[key];
+            }
+        }
+        if (includeInformationKeys) {
+            const informationKeys = await type_conversion_utils_1.TypeConversionUtils.getInformationalProperties(transformMapFile, mapFileUtil, itemObject);
+            for (const key of informationKeys) {
+                if (itemObj[key]) {
+                    skuObj[key] = itemObj[key];
+                }
+            }
+        }
+        const vibeIQIdentifier = 'vibeIQIdentifier';
+        if (!skuObj[vibeIQIdentifier]) {
+            skuObj['vibeIQIdentifier'] = itemObject['identifier'] || itemObject['itemNumber'];
+        }
+        const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKey(transformMapFile, mapFileUtil, itemObject, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+        skuObj = await map_utils_1.MapUtil.applyTransformMap(transformMapFile, mapFileUtil, skuObj, mapKey, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+        return skuObj;
+    }
+    static async getEntityCriteriaFromObject(transformMapFile, mapFileUtil, dc, object) {
+        if (!object) {
+            const e = new Error(IdentifierConversion.MISSING_OBJECT);
+            e['shortStatusMessage'] = event_short_message_status_1.EventShortMessageStatus.MISSING_INPUT;
+            throw e;
+        }
+        else if (!object.flexPLMObjectClass) {
+            const e = new Error(IdentifierConversion.MISSING_FLEXPLM_OBJECT_CLASS);
+            e['shortStatusMessage'] = event_short_message_status_1.EventShortMessageStatus.MISSING_INPUT;
+            throw e;
+        }
+        const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(transformMapFile, mapFileUtil, object, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
+        const identifierKeys = await type_conversion_utils_1.TypeConversionUtils.getIdentifierPropertiesFromObject(transformMapFile, mapFileUtil, object);
+        const objectData = await map_utils_1.MapUtil.applyTransformMap(transformMapFile, mapFileUtil, object, mapKey, type_conversion_utils_1.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'] = event_short_message_status_1.EventShortMessageStatus.MISSING_IDENTIFIER_PROPERTIES;
+            throw e;
+        }
+        const criteria = {};
+        for (const key of identifierKeys) {
+            criteria[key] = identifierValues[key];
+        }
+        return criteria;
+    }
+    static async getAssortmentCriteriaFromObject(transformMapFile, mapFileUtil, dc, object) {
+        return IdentifierConversion.getEntityCriteriaFromObject(transformMapFile, mapFileUtil, dc, object);
+    }
+    static async getItemCriteriaFromObject(transformMapFile, mapFileUtil, dc, object) {
+        const criteria = await IdentifierConversion.getEntityCriteriaFromObject(transformMapFile, mapFileUtil, dc, object);
+        const roles = (object.flexPLMObjectClass === 'LCSProduct') ? 'family' : 'color';
+        criteria['roles'] = roles;
+        return criteria;
+    }
+}
+exports.IdentifierConversion = IdentifierConversion;
+IdentifierConversion.INBOUND_ENTITY_MISSING_IDENIFIER_PROPS = 'IdentifierConversion.getEntityCriteriaFromObject(): missing identifier properties: ';
+IdentifierConversion.MISSING_OBJECT = 'IdentifierConversion.getEntityCriteriaFromObject(): missing: object';
+IdentifierConversion.MISSING_FLEXPLM_OBJECT_CLASS = 'IdentifierConversion.getEntityCriteriaFromObject(): missing: flexPLMObjectClass';

package/lib/transform/identifier-conversion.spec.d.ts

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