@contrail/flexplm 1.0.11 → 1.0.13

package/lib/util/interfaces.d.ts

@@ -0,0 +1,91 @@
+export interface FCConfig {
+    apiKey?: string;
+    orgSlug?: string;
+    action?: string;
+    configFile?: string;
+    eventObjectClassParam?: string;
+    eventFlexTypePathParam?: string;
+    taskId?: string;
+    apiHost: string;
+    userName(): string;
+    password(): string;
+    plmEnviornment?: string;
+    urlContext: string;
+    vibeEventEndpoint: string;
+    csrfEndpoint: string;
+    itemPreDevelopmentLifecycleStages: string[];
+    identifierAtts?: {
+        [key: string]: string[];
+    };
+    propertyMapping?: object;
+}
+export interface ProductFederation {
+    entityReference: string;
+    objectClass: 'LCSProduct';
+    federatedId?: string;
+    vibeIQIdentifier?: string;
+}
+export interface ProductData extends ProductFederation {
+    data: object;
+    productSeason: {
+        data: object;
+    };
+}
+export interface SeasonFederation {
+    entityReference: string;
+    objectClass: 'LCSSeason';
+    flexPLMSeasonName?: string;
+    federationId?: string;
+}
+export interface SkuFederation {
+    entityReference: string;
+    objectClass: 'LCSSKU';
+    LCSProduct?: ProductFederation;
+    federatedId?: string;
+    vibeIQIdentifier?: string;
+}
+export interface SkuData extends SkuFederation {
+    data: object;
+}
+export interface PayloadType {
+    eventType: string;
+    objectClass: string;
+}
+export interface AsyncPayloadType extends PayloadType {
+    taskId: string;
+}
+export interface AsyncEventsPayloadType extends AsyncPayloadType {
+    events?: PayloadType[];
+    eventsFileId?: string;
+    eventsDownloadLink?: string;
+}
+export interface EntityPayloadType extends PayloadType {
+    entityReference: string;
+    federatedId?: string;
+    flexPLMTypePath?: string;
+    data: object;
+}
+export interface ItemPayloadType extends EntityPayloadType {
+    LCSProduct?: ProductFederation;
+}
+export interface SeasonalPayload extends EntityPayloadType {
+    eventType: 'UPSERT_ON_SEASON' | 'REMOVE_FROM_SEASON';
+    objectClass: 'LCSProductSeasonLink' | 'LCSSKUSeasonLink';
+    LCSSeason: SeasonFederation;
+    LCSProduct?: ProductFederation;
+    LCSSKU?: SkuFederation;
+}
+export interface ExportPayloadType extends AsyncPayloadType {
+    flexPLMTypePath: string;
+}
+export interface FederationRecord {
+    reference: string;
+    mappedReference: string;
+    appIdentifier: string;
+    federationSchema: string;
+}
+export interface FlexPLMResponseData {
+    status: number;
+    data?: object;
+    error?: string;
+}

package/lib/util/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1 @@
+export declare function setLoggerConfig(appConfig: any): Promise<void>;

package/lib/util/logger-config.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setLoggerConfig = void 0;
+const app_framework_1 = require("@contrail/app-framework");
+async function setLoggerConfig(appConfig) {
+    let logLevel = app_framework_1.LogLevel.INFO;
+    if (!appConfig.logLevel) {
+    }
+    else if (appConfig.logLevel === 'error') {
+        logLevel = app_framework_1.LogLevel.ERROR;
+    }
+    else if (appConfig.logLevel === 'warn') {
+        logLevel = app_framework_1.LogLevel.WARN;
+    }
+    else if (appConfig.logLevel === 'info') {
+        logLevel = app_framework_1.LogLevel.INFO;
+    }
+    else if (appConfig.logLevel === 'debug') {
+        logLevel = app_framework_1.LogLevel.DEBUG;
+    }
+    else {
+        console.log('could not parse log level:', appConfig);
+    }
+    app_framework_1.Logger.setConfig({ logLevel: logLevel });
+}
+exports.setLoggerConfig = setLoggerConfig;

package/lib/util/map-utils.d.ts

@@ -0,0 +1,3 @@
+export declare class MapUtil {
+    static applyTransformMap(transformMapFile: any, mapFileUtil: any, data: any, type: string, direction: string): Promise<any>;
+}

package/lib/util/map-utils.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapUtil = void 0;
+const transform_data_1 = require("@contrail/transform-data");
+class MapUtil {
+    static async applyTransformMap(transformMapFile, mapFileUtil, data, type, direction) {
+        if (transformMapFile) {
+            const mapping = await mapFileUtil.getMappingSection(transformMapFile, type, direction);
+            if (mapping) {
+                const tasks = transform_data_1.MapFileUtil.getTransformTasks(mapping);
+                if (tasks.length > 0) {
+                    const convertedArray = transform_data_1.TransformProcessor.transformData([data], tasks);
+                    data = convertedArray[0];
+                }
+            }
+        }
+        return data;
+    }
+}
+exports.MapUtil = MapUtil;

package/lib/util/mockData.d.ts

@@ -0,0 +1,39 @@
+export declare const empty_custom_sizes: any[];
+export declare const four_custom_sizes: {
+    size: number;
+    id: string;
+    slug: string;
+}[];
+export declare const thumbnail_content_entity: {
+    fileName: string;
+    primaryFileId: string;
+    primaryFileUrl: string;
+    tinyViewableId: string;
+    tinyViewableUrl: string;
+    smallViewableId: string;
+    smallViewableUrl: string;
+    mediumViewableId: string;
+    mediumViewableUrl: string;
+    largeViewableId: string;
+    largeViewableUrl: string;
+    CS_300Id: string;
+    CS_300Url: string;
+    CS_500Id: string;
+    CS_500Url: string;
+    CS_800Id: string;
+    CS_800Url: string;
+    CS_1000Id: string;
+    CS_1000Url: string;
+    createdOn: string;
+    orgId: string;
+    id: string;
+    contentType: string;
+    createdById: string;
+    updatedById: string;
+    fileSize: number;
+};
+export declare const cuRficeyoStwTF_f_fileEntities: {
+    fileName: string;
+    id: string;
+    size: number;
+}[];

package/lib/util/mockData.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cuRficeyoStwTF_f_fileEntities = exports.thumbnail_content_entity = exports.four_custom_sizes = exports.empty_custom_sizes = void 0;
+exports.empty_custom_sizes = [];
+exports.four_custom_sizes = [
+    {
+        size: 1000,
+        id: '-QwFOWnCs0Gb5jkA',
+        slug: 'CS_1000'
+    },
+    {
+        size: 300,
+        id: 'AKXOowvhJRnkerG8',
+        slug: 'CS_300'
+    },
+    {
+        size: 500,
+        id: '9asQ65N188RIYgnh',
+        slug: 'CS_500'
+    },
+    {
+        size: 800,
+        id: 'xkzhwE4nJ6iRwfvP',
+        slug: 'CS_800'
+    }
+];
+exports.thumbnail_content_entity = {
+    fileName: 'JACKET 300_SOLDIER OLIVE.png',
+    primaryFileId: 'yn2d5oHD4rXHRzyB',
+    primaryFileUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Ff646d3cd-e23a-4689-bd16-0301d2036720.png',
+    tinyViewableId: '6HWzJrQ-Jx1iefmj',
+    tinyViewableUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Fb68f8652-f33f-452f-ae34-25397b4521eb.png',
+    smallViewableId: 'D3WRW4iRmjLzp5VX',
+    smallViewableUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2F541c53f8-fd85-418e-ae28-ad7410658b90.png',
+    mediumViewableId: 'AsRvJenpeqxksUNW',
+    mediumViewableUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Fe803c2d3-3e1b-4d9c-9bb9-2c488f1f295b.png',
+    largeViewableId: 'vo4N4mCd-tFrw101',
+    largeViewableUrl: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Fb1b7a55c-b8ba-4857-be4e-e1c3f11d8e9a.png',
+    CS_300Id: '6A5AG33nVu3Z6ogO',
+    CS_300Url: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2F3f2ea306-a77f-4cc3-a49a-75fb5d8b113c.png',
+    CS_500Id: 'rBaHc1J2xdOWdbhI',
+    CS_500Url: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2F979c8c65-b63f-4220-aa2e-11520f2f68bf.png',
+    CS_800Id: 'ZPAeYI3JiqjQ7unY',
+    CS_800Url: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2Fc58eeffa-2592-4698-a058-19281cda447c.png',
+    CS_1000Id: 'Hg_CthwsD4ozopCb',
+    CS_1000Url: 'https://api.vibeiq.com/prod/api/files/downloadUrl/5LZnKVTNxvwMqufy%2Fcontent:cuRficeyoStwTF-f%2F2c827c7b-361b-4e05-b77d-4280294f9d9c.png',
+    createdOn: '2023-07-05T15:02:13.950Z',
+    orgId: '5LZnKVTNxvwMqufy',
+    id: 'cuRficeyoStwTF-f',
+    contentType: 'image/png',
+    createdById: 'SWIFPZeZzkBvrSLD',
+    updatedById: 'SWIFPZeZzkBvrSLD',
+    fileSize: 1757973
+};
+exports.cuRficeyoStwTF_f_fileEntities = [
+    {
+        fileName: 'JACKET 300_SOLDIER OLIVE.png',
+        id: 'yn2d5oHD4rXHRzyB',
+        size: 1757973
+    },
+    {
+        fileName: 'JACKET 300_SOLDIER OLIVE_tiny.png',
+        id: '6HWzJrQ-Jx1iefmj',
+        size: 1784
+    },
+    {
+        fileName: 'JACKET 300_SOLDIER OLIVE_small.png',
+        id: 'D3WRW4iRmjLzp5VX',
+        size: 8699
+    },
+    {
+        fileName: 'JACKET 300_SOLDIER OLIVE_medium.png',
+        id: 'AsRvJenpeqxksUNW',
+        size: 77558
+    },
+    {
+        fileName: 'JACKET 300_SOLDIER OLIVE_large.png',
+        id: 'vo4N4mCd-tFrw101',
+        size: 1781538
+    },
+    {
+        fileName: 'JACKET 300_SOLDIER OLIVE_CS_300.png',
+        id: '6A5AG33nVu3Z6ogO',
+        size: 141153
+    },
+    {
+        fileName: 'JACKET 300_SOLDIER OLIVE_CS_500.png',
+        id: 'rBaHc1J2xdOWdbhI',
+        size: 382057
+    },
+    {
+        fileName: 'JACKET 300_SOLDIER OLIVE_CS_800.png',
+        id: 'ZPAeYI3JiqjQ7unY',
+        size: 1008702
+    }, {
+        fileName: 'JACKET 300_SOLDIER OLIVE_CS_1000.png',
+        id: 'Hg_CthwsD4ozopCb',
+        size: 1605889
+    }
+];

package/lib/util/thumbnail-util.d.ts

@@ -0,0 +1,15 @@
+import { FCConfig } from './interfaces';
+export declare class ThumbnailUtil {
+    private config;
+    private max_thumbnail_size;
+    private entities;
+    static NEW_THUMBNAIL_ID: string;
+    static EXISTING_THUMBNAIL_ID: string;
+    static REMOVE_THUMBNAIL: string;
+    constructor(config: FCConfig);
+    setOutboundThumbnail(data: any, event: any): Promise<any>;
+    getFileId(primaryViewableId: string): Promise<string>;
+    getCustomSizes(): Promise<any[]>;
+    getContentEntity(primaryViewableId: any): Promise<any>;
+    getFileEntities(fileEntityIds: any[]): Promise<any>;
+}

package/lib/util/thumbnail-util.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThumbnailUtil = void 0;
+const app_framework_1 = require("@contrail/app-framework");
+const sdk_1 = require("@contrail/sdk");
+class ThumbnailUtil {
+    constructor(config) {
+        this.config = config;
+        this.max_thumbnail_size = 5 * 1024 * 1024;
+        this.entities = new sdk_1.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;
+            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;
+    }
+    async getFileId(primaryViewableId) {
+        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));
+        const content = await this.getContentEntity(primaryViewableId);
+        if (app_framework_1.Logger.isDebugOn()) {
+            console.debug('content: ' + JSON.stringify(content));
+        }
+        if (!content) {
+            return undefined;
+        }
+        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 (app_framework_1.Logger.isDebugOn()) {
+            console.debug('fileResults: ' + JSON.stringify(fileResults));
+        }
+        let fileId = undefined;
+        let tempFileSize = 0;
+        const isDebugOn = app_framework_1.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) {
+        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) {
+        const criteria = {
+            ids: fileEntityIds
+        };
+        const fileResults = await this.entities.get({
+            entityName: 'file',
+            criteria
+        });
+        return fileResults;
+    }
+}
+exports.ThumbnailUtil = ThumbnailUtil;
+ThumbnailUtil.NEW_THUMBNAIL_ID = 'NEW_THUMBNAIL_ID';
+ThumbnailUtil.EXISTING_THUMBNAIL_ID = 'EXISTING_THUMBNAIL_ID';
+ThumbnailUtil.REMOVE_THUMBNAIL = 'REMOVE_THUMBNAIL';

package/lib/util/type-utils.d.ts

@@ -0,0 +1,12 @@
+import { TypeClientOptions } from '@contrail/sdk';
+import { TypeProperty } from '@contrail/types';
+export declare class TypeUtils {
+    private typesObj;
+    constructor();
+    getTypeById(id: any): Promise<import("@contrail/types").Type>;
+    getByRootAndPath(options: TypeClientOptions): Promise<import("@contrail/types").Type>;
+    static getFlexPLMTypePath(entity: any): any;
+    getEventObjectClass(entityType: string, newData: any): string;
+    getEntityTypeClientOptions(objectClass: string, data: any): TypeClientOptions;
+    filterTypeProperties(type: any, newData: any): TypeProperty[];
+}

package/lib/util/type-utils.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeUtils = void 0;
+const app_framework_1 = require("@contrail/app-framework");
+const sdk_1 = require("@contrail/sdk");
+class TypeUtils {
+    constructor() {
+        this.typesObj = new sdk_1.Types();
+    }
+    async getTypeById(id) {
+        const type = await this.typesObj.getType({
+            id,
+            relations: ['typeProperties', 'typeInterfaces']
+        });
+        return type;
+    }
+    async getByRootAndPath(options) {
+        const type = await this.typesObj.getByRootAndPath(options);
+        return type;
+    }
+    static getFlexPLMTypePath(entity) {
+        return entity['flexPLMTypePath'] || entity['flexTypePath'] || '';
+    }
+    getEventObjectClass(entityType, newData) {
+        let objectClass = '';
+        if ('item' === entityType) {
+            if (newData.roles.includes('family')) {
+                objectClass = 'LCSProduct';
+            }
+            else if (newData.roles.includes('color')) {
+                objectClass = 'LCSSKU';
+            }
+        }
+        else if ('project-item' === entityType) {
+            if (newData.roles.includes('family')) {
+                objectClass = 'LCSProductSeasonLink';
+            }
+            else if (newData.roles.includes('color')) {
+                objectClass = 'LCSSKUSeasonLink';
+            }
+        }
+        else if ('color' === entityType) {
+            objectClass = 'LCSColor';
+        }
+        else if ('custom-entity' === entityType) {
+            objectClass = 'LCSRevisableEntity';
+        }
+        return objectClass;
+    }
+    getEntityTypeClientOptions(objectClass, data) {
+        let tco;
+        if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
+            tco = {
+                root: 'item'
+            };
+        }
+        else if ('LCSSeason' === objectClass) {
+            tco = {
+                root: 'assortment'
+            };
+        }
+        else if ('LCSColor' === objectClass) {
+            tco = {
+                root: 'color'
+            };
+        }
+        else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
+            tco = {
+                root: 'custom-entity'
+            };
+            console.log('data: ' + data);
+        }
+        return tco;
+    }
+    filterTypeProperties(type, newData) {
+        let filteredProps = type['typeProperties'];
+        const typePath = type['typePath'];
+        if (typePath && (typePath.startsWith('item') || typePath.startsWith('project-item'))) {
+            if (app_framework_1.Logger.isDebugOn()) {
+                console.debug('typePath: ' + typePath);
+                console.debug('newData: ' + JSON.stringify(newData));
+            }
+            const roles = newData['roles'];
+            if (roles) {
+                const isFamily = roles.includes('family');
+                console.debug('isFamily: ' + isFamily);
+                filteredProps = filteredProps.filter(prop => {
+                    const propertyLevel = prop.propertyLevel;
+                    const applies = (isFamily && 'option' != propertyLevel) ||
+                        (!isFamily && 'family' != propertyLevel);
+                    return applies;
+                });
+            }
+            else {
+                console.error('filterTypeProperties():Entity missing role-id: ' + newData['id']);
+            }
+        }
+        return filteredProps;
+    }
+}
+exports.TypeUtils = TypeUtils;

package/package.json

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

package/lib/package.json

@@ -1,46 +0,0 @@
-{
-    "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"
-    }
-}