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

package/lib/interfaces/interfaces.d.ts

@@ -0,0 +1,105 @@
+export interface FCConfig {
+    apiKey?: string;
+    orgSlug?: string;
+    action?: string;
+    configFile?: string;
+    eventObjectClassParam?: string;
+    eventFlexTypePathParam?: string;
+    flexplmConnect?: any;
+    taskId?: string;
+    apiHost: string;
+    userName(): string;
+    password(): string;
+    plmEnviornment?: string;
+    urlContext: string;
+    vibeEventEndpoint: string;
+    csrfEndpoint: string;
+    itemPreDevelopmentLifecycleStages: string[];
+    identifierAtts?: {
+        [key: string]: string[];
+    };
+    propertyMapping?: object;
+    [key: string]: any;
+}
+export interface ProductFederation {
+    entityReference: string;
+    objectClass: 'LCSProduct';
+    federatedId?: string;
+    flexPLMTypePath?: string;
+    vibeIQIdentifier?: string;
+}
+export interface ProductData extends ProductFederation {
+    data: object;
+    productSeason: {
+        data: object;
+    };
+}
+export interface SeasonFederation {
+    entityReference: string;
+    objectClass: 'LCSSeason';
+    flexPLMSeasonName?: string;
+    federationId?: string;
+    flexPLMTypePath?: string;
+}
+export interface SeasonGroupFederation {
+    entityReference: string;
+    objectClass: 'SeasonGroup';
+    seasonGroupName?: string;
+    federationId?: string;
+    flexPLMTypePath?: string;
+}
+export interface SkuFederation {
+    entityReference: string;
+    objectClass: 'LCSSKU';
+    LCSProduct?: ProductFederation;
+    federatedId?: string;
+    flexPLMTypePath?: 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;
+    eventsAdminDownloadLink?: 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' | 'UPDATE_ON_SEASON' | 'REMOVE_FROM_SEASON';
+    objectClass: 'LCSProductSeasonLink' | 'LCSSKUSeasonLink';
+    LCSSeason: SeasonFederation;
+    LCSProduct?: ProductFederation;
+    LCSSKU?: SkuFederation;
+    carriedFromSeason?: object;
+}
+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/interfaces/interfaces.js

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

package/lib/interfaces/item-family-changes.d.ts

@@ -0,0 +1,20 @@
+export declare class ItemFamilyChanges {
+    private _itemFamilyId;
+    get itemFamilyId(): string;
+    private _sinceDate;
+    get sinceDate(): Date;
+    familyAdd: boolean;
+    familyDelete: boolean;
+    familyUpdate: boolean;
+    familyItemRemoved: boolean;
+    itemFamilyObject: any;
+    colorAdds: string[];
+    colorDeletes: string[];
+    colorUpdates: string[];
+    colorUnchanged: string[];
+    assortmentItemFullChangeMap: Map<string, any>;
+    assortmentItemDeleteMap: Map<string, any>;
+    itemToFederatedIdMapping: Map<string, string>;
+    constructor(itemFamilyId: string, sinceDate: Date);
+    toString(): string;
+}

package/lib/interfaces/item-family-changes.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemFamilyChanges = void 0;
+class ItemFamilyChanges {
+    get itemFamilyId() { return this._itemFamilyId; }
+    get sinceDate() { return this._sinceDate; }
+    constructor(itemFamilyId, sinceDate) {
+        this.familyAdd = false;
+        this.familyDelete = false;
+        this.familyUpdate = false;
+        this.familyItemRemoved = false;
+        this.itemFamilyObject = undefined;
+        this.colorAdds = [];
+        this.colorDeletes = [];
+        this.colorUpdates = [];
+        this.colorUnchanged = [];
+        this.assortmentItemFullChangeMap = new Map();
+        this.assortmentItemDeleteMap = new Map();
+        this.itemToFederatedIdMapping = new Map();
+        this._itemFamilyId = itemFamilyId;
+        this._sinceDate = sinceDate;
+    }
+    toString() {
+        let s = 'ItemFamilyChanges\n'
+            + ' itemFamilyId: ' + this._itemFamilyId + '\n'
+            + ' sinceDate: ' + this._sinceDate + '\n'
+            + ' familyAdd: ' + this.familyAdd + '\n'
+            + ' familyDelete: ' + this.familyDelete + '\n'
+            + ' familyUpdate: ' + this.familyUpdate + '\n'
+            + ' familyItemRemoved: ' + this.familyItemRemoved + '\n';
+        s += ' colorAdds: [' + this.colorAdds + ']\n';
+        s += ' colorDeletes: [' + this.colorDeletes + ']\n';
+        s += ' colorUpdates: [' + this.colorUpdates + ']\n';
+        s += ' colorUnchanged: [' + this.colorUnchanged + ']\n';
+        s += 'assortmentItemFullChangeMap:\n';
+        s += 'size: ' + this.assortmentItemFullChangeMap.size + '\n[';
+        for (const key of this.assortmentItemFullChangeMap.keys()) {
+            s += key + ', ';
+        }
+        s += ']\n';
+        s += 'assortmentItemDeleteMap:\n';
+        s += 'size: ' + this.assortmentItemDeleteMap.size + '\n[';
+        for (const key of this.assortmentItemDeleteMap.keys()) {
+            s += key + ', ';
+        }
+        s += ']\n';
+        s += 'itemToFederatedIdMapping:\n';
+        s += 'size: ' + this.itemToFederatedIdMapping.size + '\n[';
+        for (const key of this.itemToFederatedIdMapping.keys()) {
+            s += key + ', ';
+        }
+        s += ']\n';
+        return s;
+    }
+}
+exports.ItemFamilyChanges = ItemFamilyChanges;

package/lib/interfaces/publish-change-data.d.ts

@@ -0,0 +1,19 @@
+import { SeasonFederation } from './interfaces';
+import { ItemFamilyChanges } from './item-family-changes';
+export declare class PublishChangeData {
+    private _assortmentId;
+    get assortmentId(): string;
+    private _seasonFed;
+    get seasonFed(): SeasonFederation;
+    private _assortmentPublishChangeId;
+    get assortmentPublishChangeId(): string;
+    private _sinceDate;
+    get sinceDate(): Date;
+    private _publisher;
+    get publisher(): object;
+    itemToFederatedIdMapping: Map<string, string>;
+    releasedForDevelopmentItemIds: string[];
+    itemFamilyChanges: Map<string, ItemFamilyChanges>;
+    constructor(_assortmentId: string, _seasonFed: SeasonFederation, _assortmentPublishChangeId: string, _sinceDate: Date, _publisher?: {});
+    toString(): string;
+}

package/lib/interfaces/publish-change-data.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublishChangeData = void 0;
+class PublishChangeData {
+    get assortmentId() { return this._assortmentId; }
+    get seasonFed() { return Object.assign({}, this._seasonFed); }
+    get assortmentPublishChangeId() { return this._assortmentPublishChangeId; }
+    get sinceDate() { return this._sinceDate; }
+    get publisher() { return this._publisher; }
+    constructor(_assortmentId, _seasonFed, _assortmentPublishChangeId, _sinceDate, _publisher = {}) {
+        this.releasedForDevelopmentItemIds = [];
+        this.itemFamilyChanges = new Map();
+        this._assortmentId = _assortmentId;
+        this._seasonFed = _seasonFed;
+        this._assortmentPublishChangeId = _assortmentPublishChangeId;
+        this._sinceDate = _sinceDate;
+        this._publisher = _publisher;
+    }
+    toString() {
+        let s = 'PublishChangeData\n'
+            + 'assortmentId: ' + this._assortmentId + '\n'
+            + 'seasonFed: ' + JSON.stringify(this._seasonFed) + '\n'
+            + 'assortmentPublishChangeId: ' + this._assortmentPublishChangeId + '\n';
+        s += ' itemToFederatedIdMapping: ' + JSON.stringify(Object.fromEntries(this.itemToFederatedIdMapping)) + '\n';
+        s += 'itemFamilyChanges:\n';
+        for (const [key, value] of this.itemFamilyChanges) {
+            s += ' ' + key + ' => ' + value.toString();
+        }
+        return s;
+    }
+}
+exports.PublishChangeData = PublishChangeData;

package/lib/publish/base-process-publish-assortment-callback.d.ts

@@ -0,0 +1,9 @@
+import { FCConfig } from "../interfaces/interfaces";
+export declare class BaseProcessPublishAssortmentCallback {
+    private config;
+    constructor(_config: FCConfig);
+    process(event: any): Promise<{
+        message: string;
+    }>;
+    private checkFailuresAndSendNotification;
+}

package/lib/publish/base-process-publish-assortment-callback.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseProcessPublishAssortmentCallback = void 0;
+const sdk_1 = require("@contrail/sdk");
+class BaseProcessPublishAssortmentCallback {
+    constructor(_config) {
+        this.config = _config;
+    }
+    async process(event) {
+        console.log("ProcessPublishAssortmentCallback-process()");
+        console.log("ProcessPublishAssortmentCallback-event: " + JSON.stringify(event));
+        console.log("ProcessPublishAssortmentCallback-config: " + JSON.stringify(this.config));
+        const statusCounts = this.config["statusCounts"];
+        console.log("statusCounts: " + JSON.stringify(statusCounts));
+        const statMessage = (statusCounts && 'undefined' !== statusCounts)
+            ? await this.checkFailuresAndSendNotification(event)
+            : 'no statusCount';
+        return {
+            message: "Done ProcessPublishAssortmentCallback-process(): " + statMessage,
+        };
+    }
+    async checkFailuresAndSendNotification(event) {
+        const statusCounts = JSON.parse(this.config["statusCounts"]);
+        if (statusCounts["INVALID"] > 0 || statusCounts["FAILURE"] > 0) {
+            await new sdk_1.Notification().Dispatch({
+                message: `There were errors when publishing the season data. Please review the event and config information from context.`,
+                level: sdk_1.LogLevel.WARN,
+                context: {
+                    event,
+                    config: this.config,
+                },
+            });
+            return 'sent notification';
+        }
+        return 'no notification needed';
+    }
+}
+exports.BaseProcessPublishAssortmentCallback = BaseProcessPublishAssortmentCallback;

package/lib/publish/base-process-publish-assortment.d.ts

@@ -0,0 +1,93 @@
+import { FCConfig, ProductFederation, SeasonalPayload, SeasonFederation, SkuFederation } from '../interfaces/interfaces';
+import { DataConverter } from '../util/data-converter';
+import { ItemFamilyChanges } from '../interfaces/item-family-changes';
+import { PublishChangeData } from '../interfaces/publish-change-data';
+import { MapFileUtil } from '@contrail/transform-data';
+export declare class BaseProcessPublishAssortment {
+    private TTL;
+    static ASSORTMENT_NOT_PUBLISHABLE: string;
+    static ASSORTMENT_NO_FED_INFO: string;
+    static NOT_ABLE_TO_PROCESS_DELETE_CHANGES: string;
+    private dc;
+    private config;
+    private mapFileUtil;
+    private transformMapFile;
+    protected orgSlug: string;
+    private cache;
+    private assortment;
+    constructor(_config: FCConfig, _dc: DataConverter, _mapFileUtil: MapFileUtil);
+    process(event: any): Promise<{
+        results: {
+            message: any;
+            event: any;
+        };
+        skip_await: boolean;
+    } | {
+        results: any;
+        event: {
+            assortmentId: string;
+            assortmentPublishChangeId: string;
+        };
+        resultsCount: any;
+        skip_await?: undefined;
+    }>;
+    getPublishInfo(assortmentId: string, assortmentPublishChangeId: string, apcHistory: any, publisher: any): Promise<any>;
+    getSnapshotVersion(assortment: any, apc: any): Promise<number | string>;
+    getSeasonFederation(assortmentId: any): Promise<SeasonFederation>;
+    getAssortment(assortmentId: any): Promise<any>;
+    getSinceDate(assortmentId: any, assortmentPublishChangeId: any, apcHistory: object[]): Promise<Date>;
+    getApcHistory(assortmentId: any): Promise<any>;
+    protected updatedSinceDate(entity: any, sinceDate: Date): boolean;
+    getSinceDateFromAPCSpecificDate(apcHistory: any[], assortmentPublishChangeId: string, specificDate: Date): Date;
+    getSinceDateDaysPrevious(apcHistory: any[], assortmentPublishChangeId: string, daysBack: any): Date;
+    getSinceDateFromAPCs(apcHistory: any[], assortmentPublishChangeId: string, pastPublishCount?: number): Date;
+    protected getPublisher(assortmentPublishChange: any): {};
+    downloadAssortmentPublishChange(assortmentId: string, assortmentPublishChangeId: string): Promise<any>;
+    downloadHydratedChangeDetail(assortmentPublishChange: any): Promise<any>;
+    downloadAssortmentBaseline(assortmentPublishChange: any): Promise<any>;
+    getDeleteChanges(assortmentPublishChange: any, apcHistory: any[], assortmentBaseline: any, sinceDate: Date): Promise<[]>;
+    getBaselineItemIds(assortmentBaseline: any): string[];
+    downloadDeleteChanges(apc: any): Promise<any>;
+    buildDeleteChanges(apc: any, previousApc: any): Promise<any>;
+    getItemFederatedIds(): Promise<Map<string, string>>;
+    getFullChangeAssortmentMap(fullChange: any): Map<string, object>;
+    getDeleteChangesAssortmentMap(deleteChanges: any[]): Map<string, object>;
+    getReleasedForDevelopmentItemAndFamilyIds(fullChange: any, deleteChanges: any): string[];
+    meetsCriteria(aItem: any): boolean;
+    processPublish(pcd: PublishChangeData, changeDetail: any, fullChange: any, deleteChanges: any): Promise<{
+        results: {
+            message: string;
+            event: {
+                assortmentId: string;
+                assortmentPublishChangeId: string;
+            };
+        };
+        skip_await: boolean;
+        event?: undefined;
+        resultsCount?: undefined;
+    } | {
+        results: any;
+        event: {
+            assortmentId: string;
+            assortmentPublishChangeId: string;
+        };
+        resultsCount: any;
+        skip_await?: undefined;
+    }>;
+    getResultsCount(events: any): any;
+    private sendEvents;
+    private sendToFlexPLM;
+    private saveToLocalFile;
+    private handleVibeIQFile;
+    private getCurrentDateString;
+    getItemFamilyChanges(pcd: PublishChangeData, changeDetail: any, assortmentItemFullChangeMap: Map<string, any>, assortmentItemDeleteMap: Map<string, any>): Map<string, ItemFamilyChanges>;
+    getEventsForPublishChangeData(publishChangeData: PublishChangeData): Promise<SeasonalPayload[]>;
+    getEventsForItemFamilyChanges(itemFamilyChanges: ItemFamilyChanges, assortmentId: string, seasonFed: SeasonFederation, itemToFederatedIdMapping: Map<string, string>): Promise<SeasonalPayload[]>;
+    getProjectItem(itemFamilyChanges: ItemFamilyChanges, id: string): any;
+    getSeasonalData(projectItem: any): Promise<object>;
+    protected getProductFederation(entityReference: string, itemToFederatedIdMapping: Map<string, string>, itemFamilyObject: any): Promise<ProductFederation>;
+    protected getSKUFederation(entityReference: string, itemToFederatedIdMapping: Map<string, string>, itemObject: any): Promise<SkuFederation>;
+    getCarriedFromSeason(projectItem: any): Promise<SeasonFederation>;
+    getAssormentEntityFromId(assortmentId: any): Promise<any>;
+    getSeasonFederationFromAssortment(assortment: any): Promise<SeasonFederation>;
+}