@contrail/flexplm 1.2.0-alpha.0 → 1.3.0-alpha.0

package/lib/transform/identifier-conversion.spec.js

@@ -1,339 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const transform_data_1 = require("@contrail/transform-data");
-const identifier_conversion_1 = require("./identifier-conversion");
-const data_converter_1 = require("../util/data-converter");
-const sdk_1 = require("@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 = {};
-    const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
-    mapFileUtil.getMapFile = async (fileId) => {
-        return mappings[fileId];
-    };
-    const dc = new data_converter_1.DataConverter(config, mapFileUtil);
-    dc.getEntityValues = async (objectClass, data, keysToSkip = []) => {
-        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)) {
-                    entityValues[key] = value.map((v) => v.value);
-                }
-                else if (value.value) {
-                    entityValues[key] = value.value;
-                }
-            }
-        }
-        return entityValues;
-    };
-    it('should error if no object is provided', async () => {
-        try {
-            await identifier_conversion_1.IdentifierConversion.getAssortmentCriteriaFromObject(transformMapFile1, mapFileUtil, dc, null);
-        }
-        catch (e) {
-            expect(e.message).toEqual(expect.stringContaining(identifier_conversion_1.IdentifierConversion.MISSING_OBJECT));
-        }
-    });
-    it('should error if no flexPLMObjectClass is provided', async () => {
-        try {
-            await identifier_conversion_1.IdentifierConversion.getAssortmentCriteriaFromObject(transformMapFile1, mapFileUtil, dc, {});
-        }
-        catch (e) {
-            expect(e.message).toEqual(expect.stringContaining(identifier_conversion_1.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 identifier_conversion_1.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 identifier_conversion_1.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 = {};
-    const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
-    mapFileUtil.getMapFile = async (fileId) => {
-        return mappings[fileId];
-    };
-    const dc = new data_converter_1.DataConverter(config, mapFileUtil);
-    dc.getEntityValues = async (objectClass, data, keysToSkip = []) => {
-        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)) {
-                    entityValues[key] = value.map((v) => v.value);
-                }
-                else if (value.value) {
-                    entityValues[key] = value.value;
-                }
-            }
-        }
-        return entityValues;
-    };
-    it('should error if no object is provided', async () => {
-        try {
-            await identifier_conversion_1.IdentifierConversion.getItemCriteriaFromObject(transformMapFile1, mapFileUtil, dc, null);
-        }
-        catch (e) {
-            expect(e.message).toEqual(expect.stringContaining(identifier_conversion_1.IdentifierConversion.MISSING_OBJECT));
-        }
-    });
-    it('should error if no flexPLMObjectClass is provided', async () => {
-        try {
-            await identifier_conversion_1.IdentifierConversion.getItemCriteriaFromObject(transformMapFile1, mapFileUtil, dc, {});
-        }
-        catch (e) {
-            expect(e.message).toEqual(expect.stringContaining(identifier_conversion_1.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 identifier_conversion_1.IdentifierConversion.getItemCriteriaFromObject(transformMapFile1, mapFileUtil, dc, object);
-        }
-        catch (e) {
-            expect(getEntityValuesSpyOn).toHaveBeenCalledWith('LCSProduct', criteriaObject, []);
-            expect(e.message).toEqual(expect.stringContaining(identifier_conversion_1.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 identifier_conversion_1.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 identifier_conversion_1.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 identifier_conversion_1.IdentifierConversion.getItemCriteriaFromObject(transformMapFile2, mapFileUtil, dc, object);
-            expect(getEntityValuesSpyOn).toHaveBeenCalledWith('LCSSKU', criteriaObject, []);
-            expect(result).toEqual(resultsObject);
-        }
-        finally {
-            if (getEntityValuesSpyOn) {
-                getEntityValuesSpyOn.mockRestore();
-            }
-        }
-    });
-});

package/lib/util/config-defaults.d.ts

@@ -1,8 +0,0 @@
-import { FCConfig } from '../interfaces/interfaces';
-export declare class ConfigDefaults {
-    static NEED_CONFIG_VALUES: string;
-    static STATIC_CONFIG_CACHE: {};
-    static setConfigDefaults(config: any): Promise<FCConfig>;
-    static getConfigFile(fileId: string): Promise<any>;
-    static clearConfigCache(): void;
-}

package/lib/util/config-defaults.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigDefaults = void 0;
-const sdk_1 = require("@contrail/sdk");
-const util_1 = require("@contrail/util");
-class ConfigDefaults {
-    static async setConfigDefaults(config) {
-        if (!config.apiHost || !config.userName || !config.password) {
-            throw new Error(ConfigDefaults.NEED_CONFIG_VALUES);
-        }
-        if (config?.itemPreDevelopmentLifecycleStages && !(config?.itemPreDevelopmentLifecycleStages instanceof Array)) {
-            config.itemPreDevelopmentLifecycleStages = config.itemPreDevelopmentLifecycleStages.split(',');
-        }
-        else if (Object.keys(config).includes('itemPreDevelopmentLifecycleStages')) {
-            delete config['itemPreDevelopmentLifecycleStages'];
-        }
-        const defaultConfig = {
-            urlContext: '/Windchill',
-            sendMode: {
-                ASYNC_PUBLISH_SEASON: 'vibeiqfile'
-            },
-            itemPreDevelopmentLifecycleStages: ['concept'],
-            identifierAtts: {
-                LCSProduct: ['itemNumber'],
-                LCSSeason: ['flexPLMSeasonName'],
-                LCSSKU: ['itemNumber']
-            },
-            csrfEndpoint: '/servlet/rest/security/csrf',
-            vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
-            payloadDefaultAsArray: true
-        };
-        const configArr = [defaultConfig];
-        if (config.configFile) {
-            const fileConfig = await ConfigDefaults.getConfigFile(config.configFile);
-            configArr.push(fileConfig);
-        }
-        configArr.push(config);
-        const outputConfig = util_1.ObjectUtil.mergeDeep({}, ...configArr);
-        const uName = outputConfig.userName;
-        const pass = outputConfig.password;
-        outputConfig.userName = () => uName;
-        outputConfig.password = () => pass;
-        outputConfig['OOBvibeEventEndpoint'] = '/rfa/vibeiq/vibeEvents';
-        console.log('outputConfig: ' + JSON.stringify(outputConfig));
-        return outputConfig;
-    }
-    static async getConfigFile(fileId) {
-        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 sdk_1.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 clearConfigCache() {
-        ConfigDefaults.STATIC_CONFIG_CACHE = {};
-    }
-}
-exports.ConfigDefaults = ConfigDefaults;
-ConfigDefaults.NEED_CONFIG_VALUES = 'To connect to FlexPLM all these APP values need to be set apiHost, userName, and password';
-ConfigDefaults.STATIC_CONFIG_CACHE = {};

package/lib/util/config-defaults.spec.d.ts

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