@contrail/flexplm 1.3.0 → 1.3.1-alpha.585afc1

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

@@ -1,38 +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;
+"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

@@ -1,93 +1,118 @@
-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>;
-}
+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>;
+    /** Gets the version number of the snapshot that was created for the publish change.
+     * But if no snapshot was found for the publish change, and the last snapshot was
+     * created before the publish change, then it returns 'after: versionNumber' where
+     * versionNumber is the version number of the last snapshot.
+     * If no snapshot was found for the publish change, and the last snapshot was
+     * created after the publish change, then it returns 'unknown'.
+     *
+     * @returns versionNumber or 'unknown' or 'after: versionNumber'
+     */
+    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[]>;
+    /**Returns the events for a given ItemFamilyChanges object
+     *
+     * Cases:
+     * Add just family:
+     * Add option to family (with existing option):
+     * Add option to family (no options on assortment):
+     * Remove family and option:
+     * Remove only option and leave family:
+     * Remove one option of multiple for family:
+     *
+     * @param itemFamilyChanges
+     * @param assortmentId
+     * @param assortmentFederationId
+     * @param itemToFederatedIdMapping
+     * @returns
+     */
+    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>;
+}