@contrail/flexplm 1.0.9 → 1.0.11

package/lib/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@contrail/flexplm",
+    "version": "1.0.10",
+    "description": "Library used for integration with flexplm.",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "scripts": {
+        "build": "tsc",
+        "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+        "lint": "tslint -p tsconfig.json",
+        "test": "jest"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "devDependencies": {
+        "@types/jest": "^29.5.2",
+        "jest": "^29.5.0",
+        "prettier": "^1.19.1",
+        "ts-jest": "^29.1.1",
+        "tslint": "^5.11.0",
+        "tslint-config-prettier": "^1.18.0",
+        "typescript": "^4.0.0"
+    },
+    "jest": {
+        "moduleFileExtensions": [
+            "js",
+            "json",
+            "ts"
+        ],
+        "rootDir": "src",
+        "testRegex": ".spec.ts$",
+        "transform": {
+            "^.+\\.(t|j)s$": "ts-jest"
+        },
+        "coverageDirectory": "../coverage",
+        "testEnvironment": "node"
+    },
+    "dependencies": {
+        "@contrail/app-framework": "^1.2.0",
+        "@contrail/sdk": "^1.2.11",
+        "@contrail/transform-data": "^1.0.8",
+        "axios": "^1.4.0",
+        "p-limit": "^3.1.0"
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/lib/flexplm-request.d.ts

@@ -1,3 +0,0 @@
-export declare class FlexPLMRequest {
-    static request(path: string, data: any): Promise<any>;
-}

package/lib/flexplm-request.js

@@ -1,34 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlexPLMRequest = void 0;
-const axios_1 = __importDefault(require("axios"));
-const BASE_URL = 'https://PP-2006031951wo.portal.ptc.io/Windchill/servlet/rest/cdee';
-const BASE_CONFIG = {
-    method: 'POST',
-    headers: {
-        'Accept': 'application/json',
-        'Content-Type': 'application/json',
-        'CSRF_NONCE': '2OaLp+0dWNBtrkTwtdDC491zaacu6Hykvqi/lpl6bZgJ/QXBrK/B1J5FErMkmAmktr/I3thcbO1Xn3HJ7Ne/l9kpaedUmn7H75Xey4ZbNLsenW+anM3vxIZ7ELosk3k=',
-        'Authorization': 'Basic d2NhZG1pbjpSZXRhaWwyMDIwLQ==',
-        'Cookie': 'JSESSIONID=36D5B3C74C1F963C6C73E9AF5B6BDA78.tomcat1; JSESSIONID=B8090C802D8548EA773C97F5886FAB79.tomcat1',
-    },
-};
-class FlexPLMRequest {
-    static async request(path, data) {
-        const config = Object.assign({}, BASE_CONFIG);
-        config.url = BASE_URL + path;
-        config.data = data;
-        try {
-            const resp = await (0, axios_1.default)(config);
-            return Promise.resolve(resp.data);
-        }
-        catch (error) {
-            console.error(`${FlexPLMRequest} error: ${error.message}`);
-            return Promise.resolve(null);
-        }
-    }
-}
-exports.FlexPLMRequest = FlexPLMRequest;

package/lib/flexplm-utils.d.ts

@@ -1,5 +0,0 @@
-export declare class FlexPLMUtils {
-    static convertTypePath: (path: string) => string;
-    static getParentTypePath: (path: string) => string;
-    static computeLevelFromPath(path: string): number;
-}

package/lib/flexplm-utils.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlexPLMUtils = void 0;
-class FlexPLMUtils {
-    static computeLevelFromPath(path) {
-        return (path.match(/:/g) || []).length + 1;
-    }
-}
-exports.FlexPLMUtils = FlexPLMUtils;
-FlexPLMUtils.convertTypePath = (path) => {
-    if (!path) {
-        return null;
-    }
-    let newPath = path;
-    while (newPath.indexOf('\\') > 1) {
-        newPath = newPath.replace('\\', ':');
-    }
-    while (newPath.indexOf('[') > 1) {
-        newPath = newPath.replace('[', '*');
-    }
-    while (newPath.indexOf(']') > 1) {
-        newPath = newPath.replace(']', '*');
-    }
-    while (newPath.indexOf(' ') > 1) {
-        newPath = newPath.replace(' ', '_');
-    }
-    newPath = newPath.toLowerCase();
-    return newPath;
-};
-FlexPLMUtils.getParentTypePath = (path) => {
-    const newPath = FlexPLMUtils.convertTypePath(path);
-    return (!newPath || newPath.indexOf(':') < 0) ? null : newPath.substring(0, newPath.lastIndexOf(':'));
-};

package/lib/index.d.ts

@@ -1,10 +0,0 @@
-export * from './flexplm-request';
-export * from './flexplm-utils';
-export * from './util/config-defaults';
-export * from './util/data-converter';
-export * from './util/federation';
-export * from './util/flexplm-connect';
-export * from './util/interfaces';
-export * from './util/logger-config';
-export * from './util/thumbnail-util';
-export * from './util/type-utils';

package/lib/index.js

@@ -1,26 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./flexplm-request"), exports);
-__exportStar(require("./flexplm-utils"), exports);
-__exportStar(require("./util/config-defaults"), exports);
-__exportStar(require("./util/data-converter"), exports);
-__exportStar(require("./util/federation"), exports);
-__exportStar(require("./util/flexplm-connect"), exports);
-__exportStar(require("./util/interfaces"), exports);
-__exportStar(require("./util/logger-config"), exports);
-__exportStar(require("./util/thumbnail-util"), exports);
-__exportStar(require("./util/type-utils"), exports);

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

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

package/lib/util/config-defaults.js

@@ -1,71 +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(',');
-        }
-        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 {
-            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();
-            return config ? config : {};
-        }
-        catch (e) {
-            console.log('Error getting config file: ' + fileId + '- ' + e.message);
-            return {};
-        }
-    }
-}
-exports.ConfigDefaults = ConfigDefaults;
-ConfigDefaults.NEED_CONFIG_VALUES = 'To connect to FlexPLM all these APP values need to be set apiHost, userName, and password';

package/lib/util/data-converter.d.ts

@@ -1,22 +0,0 @@
-import { FCConfig } from './interfaces';
-import { MapFileUtil } from '@contrail/transform-data';
-export declare class DataConverter {
-    private config;
-    private mapFileUtil;
-    private typeUtils;
-    private transformMapFile;
-    private useDisplayForEnumerationMatching;
-    private objRefCache;
-    constructor(config: FCConfig, mapFileUtil: MapFileUtil);
-    getFlexPLMObjectDataFromEvent(event: any, dataToSkip: string[]): Promise<{}>;
-    getFlexPLMObjectData(newData: any, dataToSkip: string[], expandObjRef: boolean): Promise<{}>;
-    getFlexPLMValue(prop: any, newData: any, expandObjRef: boolean): Promise<any>;
-    getEnumerationValue(prop: any, nd: any): any;
-    getObjectReferenceValue(prop: any, newData: any, expandObjRef?: boolean): Promise<any>;
-    getMappingClass(entity: object, mapping: any): string;
-    setEntityValues(entity: any, data: any, keysToSkip?: string[]): Promise<any>;
-    getEntityValues(objectClass: string, data: any, keysToSkip?: string[]): Promise<{}>;
-    getEntityValue(prop: any, data: any): Promise<any>;
-    setEnumerationKeys(prop: any, nd: any, matchByDisplay: any): any;
-    getPersistableChanges(entity: object, changes: object): object;
-}

package/lib/util/data-converter.js

@@ -1,318 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataConverter = void 0;
-const sdk_1 = require("@contrail/sdk");
-const type_utils_1 = require("./type-utils");
-const transform_data_1 = require("@contrail/transform-data");
-const app_framework_1 = require("@contrail/app-framework");
-const util_1 = require("@contrail/util");
-class DataConverter {
-    constructor(config, mapFileUtil) {
-        this.config = config;
-        this.mapFileUtil = mapFileUtil;
-        this.useDisplayForEnumerationMatching = false;
-        this.objRefCache = {};
-        this.typeUtils = new type_utils_1.TypeUtils();
-        this.transformMapFile = this.config['transformMapFile'];
-        this.useDisplayForEnumerationMatching = this.config['dataConverter']
-            && this.config['dataConverter']['useDisplayForEnumerationMatching'];
-    }
-    async getFlexPLMObjectDataFromEvent(event, dataToSkip) {
-        return this.getFlexPLMObjectData(event.newData, dataToSkip, true);
-    }
-    async getFlexPLMObjectData(newData, dataToSkip, expandObjRef) {
-        if (app_framework_1.Logger.isDebugOn()) {
-            console.debug('newData: ' + JSON.stringify(newData));
-        }
-        dataToSkip = dataToSkip.concat(['updatedOn', 'updatedById', 'createdOn', 'createdById', 'modifiedAt', 'orgId', 'createdAt', 'id', 'typeId', 'workspaceId']);
-        const data = {};
-        const typeId = newData?.typeId;
-        if (!typeId) {
-            return;
-        }
-        data['typePath'] = newData['typePath'];
-        const type = await this.typeUtils.getTypeById(typeId);
-        const typeProps = this.typeUtils.filterTypeProperties(type, newData);
-        for (const prop of typeProps) {
-            const slug = prop['slug'];
-            if (dataToSkip.includes(slug)) {
-                continue;
-            }
-            data[slug] = await this.getFlexPLMValue(prop, newData, expandObjRef);
-        }
-        if (app_framework_1.Logger.isDebugOn()) {
-            console.debug('getFlexPLMObjectData-data:  ' + JSON.stringify(data));
-        }
-        return data;
-    }
-    async getFlexPLMValue(prop, newData, expandObjRef) {
-        const propertyType = prop['propertyType'];
-        const slug = prop['slug'];
-        const nd = newData[slug];
-        let value;
-        if (['string', 'text'].includes(propertyType)) {
-            value = nd || '';
-        }
-        else if (['number', 'currency', 'percent', 'sequence'].includes(propertyType)) {
-            value = nd || 0;
-        }
-        else if ('date' === propertyType) {
-            if (nd) {
-                value = nd;
-            }
-            else {
-                value = null;
-            }
-        }
-        else if ('boolean' === propertyType) {
-            value = (nd) ? true : false;
-        }
-        else if ('choice' === propertyType) {
-            value = this.getEnumerationValue(prop, nd);
-        }
-        else if ('multi_select' === propertyType) {
-            value = this.getEnumerationValue(prop, nd);
-        }
-        else if ('object_reference' === propertyType) {
-            value = await this.getObjectReferenceValue(prop, newData, expandObjRef);
-            if (app_framework_1.Logger.isDebugOn()) {
-                console.debug('object_reference: ' + JSON.stringify(value));
-            }
-        }
-        else if ('image' === propertyType) {
-        }
-        else if ('formula' === propertyType) {
-            value = nd;
-        }
-        else if ('json' === propertyType) {
-            value = nd;
-        }
-        return value;
-    }
-    getEnumerationValue(prop, nd) {
-        const propertyType = prop['propertyType'];
-        let value;
-        if (['choice', 'multi_select'].includes(propertyType)) {
-            const options = prop['options'];
-            if ('choice' === propertyType) {
-                if (nd) {
-                    const option = options.find(option => option.value == nd);
-                    if (option) {
-                        value = Object.assign({}, option);
-                    }
-                }
-                else {
-                    value = {};
-                }
-            }
-            else if ('multi_select' === propertyType) {
-                value = [];
-                if (nd instanceof Array) {
-                    nd.forEach(key => {
-                        const optionObject = options.find(option => option.value == key);
-                        if (optionObject) {
-                            const option = Object.assign({}, optionObject);
-                            value.push(option);
-                        }
-                    });
-                }
-                else if (typeof nd === 'string' && '' !== nd) {
-                    const optionObject = options.find(option => option.value == nd);
-                    if (optionObject) {
-                        const option = Object.assign({}, optionObject);
-                        value.push(option);
-                    }
-                }
-            }
-        }
-        return value;
-    }
-    async getObjectReferenceValue(prop, newData, expandObjRef = false) {
-        const slug = prop['slug'];
-        console.debug('getObjectReferenceValue-prop: ' + slug);
-        let value = newData[slug];
-        const entityType = prop['referencedTypeRootSlug'];
-        const entityId = newData[slug + 'Id'];
-        if (!value && expandObjRef) {
-            if (entityId) {
-                if (this.objRefCache[entityId]) {
-                    console.log('cache hit: ' + entityId);
-                    return this.objRefCache[entityId];
-                }
-                const criteria = {
-                    id: entityId
-                };
-                const entities = await new sdk_1.Entities().get({
-                    entityName: entityType,
-                    criteria
-                });
-                value = (entities && entities[0]) ? entities[0] : undefined;
-            }
-        }
-        if (value) {
-            const unprocessedValue = value;
-            const objectClass = this.typeUtils.getEventObjectClass(entityType, newData);
-            value = await this.getFlexPLMObjectData(value, [], false);
-            value['entityReference'] = entityType + ':' + entityId;
-            value['objectClass'] = objectClass;
-            value['typePath'] = unprocessedValue['typePath'];
-            if (this.transformMapFile) {
-                const wholeMap = await this.mapFileUtil.getMapFile(this.transformMapFile);
-                const objClass = this.getMappingClass(unprocessedValue, wholeMap);
-                const mapping = await this.mapFileUtil.getMappingSection(this.transformMapFile, objClass, 'vibe2flex');
-                if (mapping) {
-                    const tasks = transform_data_1.MapFileUtil.getTransformTasks(mapping);
-                    if (tasks.length > 0) {
-                        const convertedArray = transform_data_1.TransformProcessor.transformData([value], tasks);
-                        value = convertedArray[0];
-                    }
-                }
-            }
-        }
-        else {
-            value = {};
-        }
-        this.objRefCache[entityId] = value;
-        return value;
-    }
-    getMappingClass(entity, mapping) {
-        const entityTypePath = entity['typePath'];
-        const typeMapKey = mapping['typeMapKey'];
-        let objClass = typeMapKey[entityTypePath];
-        const entityType = entity['entityType'];
-        if (!objClass) {
-            objClass = this.typeUtils.getEventObjectClass(entityType, entity);
-        }
-        if (!objClass) {
-            objClass = entityType;
-        }
-        return objClass;
-    }
-    async setEntityValues(entity, data, keysToSkip = []) {
-        const type = await this.typeUtils.getTypeById(entity.typeId);
-        keysToSkip = keysToSkip.concat(['updatedOn', 'updatedById', 'createdOn', 'createdById', 'modifiedAt', 'orgId', 'createdAt', 'id', 'typeId', 'workspaceId']);
-        let typeProps = this.typeUtils.filterTypeProperties(type, entity);
-        typeProps = typeProps.filter(prop => !keysToSkip.includes(prop['slug']));
-        const dataKeys = Object.getOwnPropertyNames(data);
-        typeProps = typeProps.filter(prop => dataKeys.includes(prop['slug']));
-        for (const prop of typeProps) {
-            const slug = prop['slug'];
-            entity[slug] = await this.getEntityValue(prop, data);
-        }
-        return entity;
-    }
-    async getEntityValues(objectClass, data, keysToSkip = []) {
-        const entityValues = {};
-        const tco = this.typeUtils.getEntityTypeClientOptions(objectClass, data);
-        const type = await this.typeUtils.getByRootAndPath(tco);
-        const typePath = type['typePath'];
-        if (typePath && (typePath.startsWith('item') || typePath.startsWith('project-item'))) {
-            if (['LCSProduct', 'LCSProductSeasonLink'].includes(objectClass)) {
-                entityValues['roles'] = ['family'];
-            }
-            else {
-                entityValues['roles'] = ['color', 'option'];
-            }
-        }
-        let typeProps = this.typeUtils.filterTypeProperties(type, entityValues);
-        typeProps = typeProps.filter(prop => !keysToSkip.includes(prop['slug']));
-        for (const prop of typeProps) {
-            const slug = prop['slug'];
-            const value = await this.getEntityValue(prop, data);
-            if (value) {
-                entityValues[slug] = value;
-            }
-        }
-        return entityValues;
-    }
-    async getEntityValue(prop, data) {
-        const propertyType = prop['propertyType'];
-        const slug = prop['slug'];
-        const nd = data[slug];
-        let value;
-        if (['string', 'text'].includes(propertyType)) {
-            value = nd;
-        }
-        else if (['number', 'currency', 'percent', 'sequence'].includes(propertyType)) {
-            value = (null === nd) ? 0 : nd;
-        }
-        else if ('date' === propertyType) {
-            if (nd) {
-                const d = new Date(nd);
-                value = d.toISOString();
-            }
-            else {
-                value = null;
-            }
-        }
-        else if ('boolean' === propertyType) {
-            value = (nd) ? true : false;
-        }
-        else if ('choice' === propertyType) {
-            value = this.setEnumerationKeys(prop, nd, this.useDisplayForEnumerationMatching);
-        }
-        else if ('multi_select' === propertyType) {
-            value = this.setEnumerationKeys(prop, nd, this.useDisplayForEnumerationMatching);
-        }
-        else if ('object_reference' === propertyType) {
-        }
-        else if ('image' === propertyType) {
-            console.log('TODO');
-        }
-        else if ('formula' === propertyType) {
-            console.log('TODO');
-        }
-        else if ('json' === propertyType) {
-            console.log('TODO');
-        }
-        return value;
-    }
-    setEnumerationKeys(prop, nd, matchByDisplay) {
-        const propertyType = prop['propertyType'];
-        let value;
-        if (['choice', 'multi_select'].includes(propertyType)) {
-            const options = prop['options'];
-            if ('choice' === propertyType) {
-                if (nd) {
-                    const matchKey = (matchByDisplay) ? 'display' : 'value';
-                    const option = options.find(option => option[matchKey] == nd[matchKey]);
-                    if (option) {
-                        value = option.value;
-                    }
-                }
-                else {
-                    value = undefined;
-                }
-            }
-            else if ('multi_select' === propertyType) {
-                value = [];
-                const matchKey = (matchByDisplay) ? 'display' : 'value';
-                if (nd instanceof Array) {
-                    nd.forEach(selectedOpt => {
-                        const optionObject = options.find(option => option[matchKey] == selectedOpt[matchKey]);
-                        if (optionObject) {
-                            const option = optionObject.value;
-                            value.push(option);
-                        }
-                    });
-                }
-            }
-        }
-        return value;
-    }
-    getPersistableChanges(entity, changes) {
-        const entityCompareValues = {};
-        for (const key of (Object.getOwnPropertyNames(changes))) {
-            entityCompareValues[key] = entity[key];
-        }
-        const diffs = util_1.ObjectUtil.compareDeep(entityCompareValues, changes, '');
-        const diffValues = {};
-        if (diffs && diffs.length > 0) {
-            for (const diff of diffs) {
-                diffValues[diff.propertyName] = diff.newValue;
-            }
-        }
-        return diffValues;
-    }
-}
-exports.DataConverter = DataConverter;

package/lib/util/federation.d.ts

@@ -1,15 +0,0 @@
-import { FederationRecord } from './interfaces';
-export declare class Federation {
-    private CHUNK_SIZE;
-    getFederatedMappedRefId(entityType: string, entityId: string): Promise<string>;
-    createFederatedRecord(eventBody: any): Promise<any>;
-    getFederationRecordFromMappedRefId(mappedRefId: string): Promise<FederationRecord>;
-    static getEntityId(fedRecord: FederationRecord): {
-        entityType: string;
-        entityId: string;
-    };
-    getEntityFromMappedRefId(mappedRefId: string): Promise<any>;
-    getFederationRecordsFromIds(ids: string[]): Promise<FederationRecord[]>;
-    getFederationRecordsFromIdsBulk(ids: string[]): Promise<FederationRecord[]>;
-    splitIntoChunksByLen(arr: any, len: any): any[];
-}