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

package/lib/entity-processor/base-entity-processor.js

@@ -1,385 +1,438 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseEntityProcessor = exports.IncomingEntityResponse = void 0;
-const type_utils_1 = require("../util/type-utils");
-const flexplm_connect_1 = require("../util/flexplm-connect");
-const map_utils_1 = require("../util/map-utils");
-const sdk_1 = require("@contrail/sdk");
-const type_conversion_utils_1 = require("../util/type-conversion-utils");
-const thumbnail_util_1 = require("../util/thumbnail-util");
-const event_short_message_status_1 = require("../util/event-short-message-status");
-const UNSUPPORTED_TYPE = 'Unsupported eventType.';
-class IncomingEntityResponse {
-}
-exports.IncomingEntityResponse = IncomingEntityResponse;
-class BaseEntityProcessor {
-    constructor(config, dc, mapFileUtil, baseType) {
-        this.config = config;
-        this.dc = dc;
-        this.mapFileUtil = mapFileUtil;
-        this.baseType = baseType;
-        this.typeUtil = new type_utils_1.TypeUtils();
-        this.transformMapFile = this.config?.transformMapFile;
-        this.entities = new sdk_1.Entities();
-        this.orgSlug = this.config?.orgSlug || 'unset-orgSlug';
-    }
-    async inbound(event) {
-        const eventType = event.eventType;
-        console.log(`inbound entity: ${eventType}:${event.objectClass}`);
-        switch (eventType) {
-            case 'PERSIST':
-                return await this.handleIncomingUpsert(event);
-            case 'DELETE':
-                return await this.handleIncomingDelete(event);
-            default:
-                console.error(UNSUPPORTED_TYPE);
-                return {
-                    status: 500,
-                    data: { UNSUPPORTED_TYPE }
-                };
-        }
-    }
-    async handleIncomingUpsert(event) {
-        const inboundData = await this.getTransformedData(event);
-        const incomingEntityResponse = await this.getIncomingEntity(event, inboundData);
-        if (incomingEntityResponse.earlyReturn) {
-            const statusMsg = this.getInboundStatusMessage({
-                status: event_short_message_status_1.EventShortMessageStatus.FAILURE,
-                statusMessage: incomingEntityResponse.earlyReturn.shortStatusMessage || '',
-                objectClass: event.objectClass,
-                federatedId: event.federatedId
-            });
-            console.log(statusMsg);
-            return incomingEntityResponse.earlyReturn;
-        }
-        const entity = incomingEntityResponse.entity;
-        if (!entity) {
-            const createEntityResponse = await this.getCreateEntity(inboundData);
-            if (createEntityResponse.earlyReturn) {
-                const status = (createEntityResponse.earlyReturn.shortStatusMessage === event_short_message_status_1.EventShortMessageStatus.NOT_CREATABLE)
-                    ? event_short_message_status_1.EventShortMessageStatus.SUCCESS
-                    : event_short_message_status_1.EventShortMessageStatus.FAILURE;
-                const statusMsg = this.getInboundStatusMessage({
-                    status,
-                    statusMessage: createEntityResponse.earlyReturn.shortStatusMessage || '',
-                    objectClass: event.objectClass,
-                    federatedId: event.federatedId
-                });
-                console.log(statusMsg);
-                return createEntityResponse.earlyReturn;
-            }
-            let createdEntity = await this.createEntity(this.baseType, createEntityResponse.entity);
-            const shouldSyncThumbnail = await type_conversion_utils_1.TypeConversionUtils.syncInboundImages(this.transformMapFile, this.mapFileUtil, event.data);
-            if (shouldSyncThumbnail) {
-                createdEntity = await new thumbnail_util_1.ThumbnailUtil(this.config).syncThumbnailToVibeIQ({ entityId: createdEntity.id, primaryViewableId: createdEntity.primaryViewableId, event, entityName: this.baseType }) || createdEntity;
-            }
-            const statusMsg = this.getInboundStatusMessage({
-                status: event_short_message_status_1.EventShortMessageStatus.SUCCESS,
-                statusMessage: event_short_message_status_1.EventShortMessageStatus.CREATED,
-                objectClass: event.objectClass,
-                entityId: 'id',
-                federatedId: event.federatedId
-            });
-            console.log(statusMsg);
-            return createdEntity;
-        }
-        const diffs = await this.getUpdatesForEntity(entity, inboundData);
-        const shouldSyncThumbnail = await type_conversion_utils_1.TypeConversionUtils.syncInboundImages(this.transformMapFile, this.mapFileUtil, event.data);
-        let thumbnailEntity;
-        if (shouldSyncThumbnail) {
-            thumbnailEntity = await new thumbnail_util_1.ThumbnailUtil(this.config).syncThumbnailToVibeIQ({ entityId: entity.id, primaryViewableId: entity.primaryViewableId, event, entityName: this.baseType });
-        }
-        const hasPropertyChanges = Object.getOwnPropertyNames(diffs).length > 0;
-        if (!hasPropertyChanges && thumbnailEntity) {
-            const statusMsg = this.getInboundStatusMessage({
-                status: event_short_message_status_1.EventShortMessageStatus.SUCCESS,
-                statusMessage: event_short_message_status_1.EventShortMessageStatus.PRIMARY_CONTENT_UPDATED,
-                objectClass: event.objectClass,
-                entityId: entity.id,
-                federatedId: event.federatedId
-            });
-            console.log(statusMsg);
-            return thumbnailEntity;
-        }
-        if (!hasPropertyChanges) {
-            const statusMsg = this.getInboundStatusMessage({
-                status: event_short_message_status_1.EventShortMessageStatus.SUCCESS,
-                statusMessage: event_short_message_status_1.EventShortMessageStatus.NO_CHANGES,
-                objectClass: event.objectClass,
-                entityId: entity.id,
-                federatedId: event.federatedId
-            });
-            console.log(statusMsg);
-            const message = 'No Changes to persist for entity: ' + entity.id;
-            return {
-                status: 200,
-                data: { message }
-            };
-        }
-        const updatedEntity = await this.updateEntity(this.baseType, entity, diffs);
-        const statusMsg = this.getInboundStatusMessage({
-            status: event_short_message_status_1.EventShortMessageStatus.SUCCESS,
-            statusMessage: event_short_message_status_1.EventShortMessageStatus.UPDATED,
-            objectClass: event.objectClass,
-            entityId: entity.id,
-            federatedId: event.federatedId
-        });
-        console.log(statusMsg);
-        return updatedEntity;
-    }
-    getInboundStatusMessage(statusObject) {
-        return 'BaseEntityProcessor: inbound: status: ' + statusObject.status
-            + ', statusMessage: ' + statusObject.statusMessage
-            + ', entityType: ' + this.baseType
-            + ', entityId: ' + statusObject.entityId
-            + ', objectClass: ' + statusObject.objectClass
-            + ', federatedId: ' + statusObject.federatedId
-            + ', orgSlug: ' + this.orgSlug;
-    }
-    async queryEntityWithSubTypeCriteria(entityType, entityTypePath, propertyCriteria) {
-        if (!entityType || !entityTypePath) {
-            throw new Error('type and entityTypePath must be defined');
-        }
-        if (!propertyCriteria || Object.getOwnPropertyNames(propertyCriteria).length == 0) {
-            throw new Error('propertyCriteria must be defined and have at least one property');
-        }
-        const { rootTypeCriteria, subTypeCriteria } = await this.getCriteriaForEntity(entityType, entityTypePath, propertyCriteria);
-        const returnedEntities = await this.dc.getAllObjectReferences(entityType, rootTypeCriteria, subTypeCriteria);
-        return returnedEntities;
-    }
-    async getCriteriaForEntity(entityType, entityTypePath, propertyCriteria) {
-        if (!entityType || !entityTypePath) {
-            throw new Error('type and entityTypePath must be defined');
-        }
-        if (!propertyCriteria || Object.getOwnPropertyNames(propertyCriteria).length == 0) {
-            throw new Error('propertyCriteria must be defined and have at least one property');
-        }
-        const rootType = await this.typeUtil.getByRootAndPath({ root: entityType });
-        const rootTypePropertyKeys = await this.getRootTypePropertyKeys(rootType, propertyCriteria);
-        const rootTypeCriteria = {};
-        const subTypeCriteria = {};
-        if (entityType !== entityTypePath) {
-            subTypeCriteria['typePath'] = entityTypePath;
-        }
-        for (const key in propertyCriteria) {
-            if (rootTypePropertyKeys.includes(key)) {
-                rootTypeCriteria[key] = propertyCriteria[key];
-            }
-            else {
-                subTypeCriteria[key] = propertyCriteria[key];
-            }
-        }
-        return { rootTypeCriteria, subTypeCriteria };
-    }
-    getRootTypePropertyKeys(rootType, propertyCriteria = null) {
-        const props = rootType['typeProperties'];
-        const rootTypePropertyKeys = props.map(prop => prop.slug);
-        return rootTypePropertyKeys;
-    }
-    async handleIncomingDelete(event) {
-        console.warn('delete is not configured', event);
-    }
-    async getTransformedData(event) {
-        let inboundData = event.data;
-        console.debug('inboundData: ' + JSON.stringify(inboundData));
-        const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(this.transformMapFile, this.mapFileUtil, inboundData, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
-        inboundData = await map_utils_1.MapUtil.applyTransformMap(this.transformMapFile, this.mapFileUtil, inboundData, mapKey, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
-        console.debug('Transformed-inboundData: ' + JSON.stringify(inboundData));
-        return inboundData;
-    }
-    async getUpdatesForEntity(entity, inboundData) {
-        const vibeOwningKeys = await this.getVibeOwningKeys(entity);
-        let updates = {
-            typeId: entity.typeId,
-            roles: entity.roles,
-            id: entity.id,
-        };
-        updates = await this.dc.setEntityValues(updates, inboundData, vibeOwningKeys);
-        for (const prop of ['typeId', 'roles', 'id']) {
-            delete updates[prop];
-        }
-        return this.dc.getPersistableChanges(entity, updates);
-    }
-    async getVibeOwningKeys(entity) {
-        let vibeOwningKeys = [];
-        if (this.transformMapFile && entity) {
-            const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKey(this.transformMapFile, this.mapFileUtil, entity, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
-            const mapSection = await map_utils_1.MapUtil.getFullMapSection(this.transformMapFile, this.mapFileUtil, mapKey);
-            vibeOwningKeys = mapSection?.vibeOwningKeys || [];
-        }
-        console.debug('vibeOwningKeys: ' + vibeOwningKeys);
-        return vibeOwningKeys;
-    }
-    async getVibeOwningKeysFromInbound(entity) {
-        let vibeOwningKeys = [];
-        if (this.transformMapFile && entity) {
-            const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(this.transformMapFile, this.mapFileUtil, entity, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
-            const mapSection = await map_utils_1.MapUtil.getFullMapSection(this.transformMapFile, this.mapFileUtil, mapKey);
-            vibeOwningKeys = mapSection?.vibeOwningKeys || [];
-        }
-        console.debug('vibeOwningKeys: ' + vibeOwningKeys);
-        return vibeOwningKeys;
-    }
-    async createEntity(entityName, changes) {
-        const options = {
-            entityName: entityName,
-            object: changes,
-        };
-        console.log("createEntity: " + JSON.stringify(options));
-        return await new sdk_1.Entities().create(options);
-    }
-    async updateEntity(entityName, entity, diffs) {
-        const options = {
-            entityName: entityName,
-            id: entity['id'],
-            object: diffs
-        };
-        console.log('updateEntity: ' + JSON.stringify(options));
-        return await new sdk_1.Entities().update(options);
-    }
-    async outbound(event) {
-        const entityType = event.entityType;
-        const eventType = event.eventType;
-        const entityId = event.id;
-        console.log(`outbound: ${entityType}:${entityId}`);
-        switch (eventType) {
-            case 'update':
-            case 'create':
-                return await this.handleOutgoingUpsert(entityType, event);
-            case 'delete':
-                return await this.handleOutgoingDelete(entityType, event);
-            case 'sendUpsertToFlexPLM':
-                return await this.sendUpsertToFlexPLM(event);
-            default:
-                console.log(UNSUPPORTED_TYPE);
-                return {
-                    status: 500,
-                    data: { UNSUPPORTED_TYPE }
-                };
-        }
-    }
-    async handleOutgoingUpsert(entityType, event) {
-        const objectClass = await type_conversion_utils_1.TypeConversionUtils.getObjectClass(this.transformMapFile, this.mapFileUtil, event.newData);
-        if (!objectClass) {
-            const message = 'ObjectClass must have a value.';
-            console.log(message);
-            return {
-                status: 500,
-                data: { message }
-            };
-        }
-        try {
-            const payload = await this.getOutgoingUpsertPayload(entityType, event);
-            const flexResponse = await new flexplm_connect_1.FlexPLMConnect(this.config).sendToFlexPLM(payload);
-            const outboundEntityUpdates = await this.getOutboundEntityUpdates(event, flexResponse);
-            if (outboundEntityUpdates) {
-                flexResponse['outboundEntityUpdates'] = outboundEntityUpdates;
-            }
-            const statusMsg = 'BaseEntityProcessor: outbound: status: ' + event_short_message_status_1.EventShortMessageStatus.SUCCESS
-                + ', statusMessage: ' + flexResponse.status
-                + ', entityType: ' + this.baseType
-                + ', entityId: ' + event.id
-                + ', objectClass: ' + payload.objectClass
-                + ', updateFromResponse: ' + ((outboundEntityUpdates && Object.keys(outboundEntityUpdates).length > 0) ? 'true' : 'false')
-                + ', orgSlug: ' + this.orgSlug;
-            console.log(statusMsg);
-            return flexResponse;
-        }
-        catch (e) {
-            const statusMsg = 'BaseEntityProcessor: outbound: status: ' + event_short_message_status_1.EventShortMessageStatus.FAILURE
-                + ', statusMessage: ' + e.httpResponseStatus
-                + ', entityType: ' + this.baseType
-                + ', entityId: ' + event.id
-                + ', objectClass: ' + objectClass
-                + ', updateFromResponse: ' + 'false'
-                + ', orgSlug: ' + this.orgSlug;
-            console.log(statusMsg);
-            throw e;
-        }
-    }
-    async getOutboundEntityUpdates(event, flexResponse) {
-        const payload = flexResponse?.data?.payload;
-        const flexPayload = (payload) ? payload[0] : undefined;
-        let outboundEntityUpdates = undefined;
-        if (flexPayload && 'OK' === flexPayload.status) {
-            if (flexPayload.data && !flexPayload.data?.flexPLMObjectClass) {
-                flexPayload.data.flexPLMObjectClass = flexPayload.objectClass;
-            }
-            const inboundData = await this.getTransformedData(flexPayload);
-            outboundEntityUpdates = await this.getUpdatesForEntity(event.newData, inboundData);
-        }
-        return outboundEntityUpdates;
-    }
-    async handleOutgoingDelete(entityType, event) {
-        console.warn('delete is not configured', entityType, event.oldData);
-    }
-    async triggerNewEvent(triggerKey, event) {
-        const newEvent = {
-            entityName: 'event-workflow-request',
-            object: {
-                triggerKey,
-                event
-            }
-        };
-        const response = await this.entities.create(newEvent);
-        return response;
-    }
-    async sendUpsertToFlexPLM(event) {
-        const payload = await this.getEntityCurrentStateUpsertPayload(event);
-        if (!payload) {
-            const message = 'No payload to send to FlexPLM';
-            console.log(message);
-            return {
-                status: 500,
-                data: { message }
-            };
-        }
-        ;
-        let objectClass = payload.objectClass;
-        try {
-            const flexResponse = await new flexplm_connect_1.FlexPLMConnect(this.config).sendToFlexPLM(payload);
-            const outboundEntityUpdates = await this.getOutboundEntityUpdates(event, flexResponse);
-            if (outboundEntityUpdates) {
-                flexResponse['outboundEntityUpdates'] = outboundEntityUpdates;
-            }
-            const statusMsg = 'BaseEntityProcessor: outbound: status: ' + event_short_message_status_1.EventShortMessageStatus.SUCCESS
-                + ', statusMessage: ' + flexResponse.status
-                + ', entityType: ' + this.baseType
-                + ', entityId: ' + event.id
-                + ', objectClass: ' + objectClass
-                + ', updateFromResponse: ' + ((outboundEntityUpdates && Object.keys(outboundEntityUpdates).length > 0) ? 'true' : 'false')
-                + ', orgSlug: ' + this.orgSlug;
-            console.log(statusMsg);
-            return flexResponse;
-        }
-        catch (e) {
-            const statusMsg = 'BaseEntityProcessor: outbound: status: ' + event_short_message_status_1.EventShortMessageStatus.FAILURE
-                + ', statusMessage: ' + e.httpResponseStatus
-                + ', entityType: ' + this.baseType
-                + ', entityId: ' + event.id
-                + ', objectClass: ' + objectClass
-                + ', updateFromResponse: ' + 'false'
-                + ', orgSlug: ' + this.orgSlug;
-            console.log(statusMsg);
-            throw e;
-        }
-    }
-    async getEntityCurrentStateUpsertPayload(event) {
-        const id = event.id;
-        if (!id) {
-            return undefined;
-        }
-        const entity = await this.entities.get({
-            entityName: this.baseType,
-            id
-        });
-        if (!entity) {
-            return undefined;
-        }
-        event.newData = entity;
-        event.oldData = entity;
-        const payload = await this.getOutgoingUpsertPayload(this.baseType, event);
-        return payload;
-    }
-}
-exports.BaseEntityProcessor = BaseEntityProcessor;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEntityProcessor = exports.IncomingEntityResponse = void 0;
+const type_utils_1 = require("../util/type-utils");
+const flexplm_connect_1 = require("../util/flexplm-connect");
+const map_utils_1 = require("../util/map-utils");
+const sdk_1 = require("@contrail/sdk");
+const type_conversion_utils_1 = require("../util/type-conversion-utils");
+const thumbnail_util_1 = require("../util/thumbnail-util");
+const event_short_message_status_1 = require("../util/event-short-message-status");
+const UNSUPPORTED_TYPE = 'Unsupported eventType.';
+class IncomingEntityResponse {
+}
+exports.IncomingEntityResponse = IncomingEntityResponse;
+class BaseEntityProcessor {
+    constructor(config, dc, mapFileUtil, baseType) {
+        this.config = config;
+        this.dc = dc;
+        this.mapFileUtil = mapFileUtil;
+        this.baseType = baseType;
+        this.typeUtil = new type_utils_1.TypeUtils();
+        this.transformMapFile = this.config?.transformMapFile;
+        this.entities = new sdk_1.Entities();
+        this.orgSlug = this.config?.orgSlug || 'unset-orgSlug';
+    }
+    // inbound
+    async inbound(event) {
+        const eventType = event.eventType;
+        console.log(`inbound entity: ${eventType}:${event.objectClass}`);
+        switch (eventType) {
+            case 'PERSIST':
+                return await this.handleIncomingUpsert(event);
+            case 'DELETE':
+                return await this.handleIncomingDelete(event);
+            default:
+                console.error(UNSUPPORTED_TYPE);
+                return {
+                    status: 500,
+                    data: { UNSUPPORTED_TYPE }
+                };
+        }
+    }
+    async handleIncomingUpsert(event) {
+        const inboundData = await this.getTransformedData(event);
+        const incomingEntityResponse = await this.getIncomingEntity(event, inboundData);
+        // This case means there was an early return in the getIncomingEntity method
+        if (incomingEntityResponse.earlyReturn) {
+            const statusMsg = this.getInboundStatusMessage({
+                status: event_short_message_status_1.EventShortMessageStatus.FAILURE,
+                statusMessage: incomingEntityResponse.earlyReturn.shortStatusMessage || '',
+                objectClass: event.objectClass,
+                federatedId: event.federatedId
+            });
+            console.log(statusMsg);
+            return incomingEntityResponse.earlyReturn;
+        }
+        const entity = incomingEntityResponse.entity;
+        if (!entity) {
+            const createEntityResponse = await this.getCreateEntity(inboundData);
+            if (createEntityResponse.earlyReturn) {
+                const status = (createEntityResponse.earlyReturn.shortStatusMessage === event_short_message_status_1.EventShortMessageStatus.NOT_CREATABLE)
+                    ? event_short_message_status_1.EventShortMessageStatus.SUCCESS
+                    : event_short_message_status_1.EventShortMessageStatus.FAILURE;
+                const statusMsg = this.getInboundStatusMessage({
+                    status,
+                    statusMessage: createEntityResponse.earlyReturn.shortStatusMessage || '',
+                    objectClass: event.objectClass,
+                    federatedId: event.federatedId
+                });
+                console.log(statusMsg);
+                return createEntityResponse.earlyReturn;
+            }
+            let createdEntity = await this.createEntity(this.baseType, createEntityResponse.entity);
+            const shouldSyncThumbnail = await type_conversion_utils_1.TypeConversionUtils.syncInboundImages(this.transformMapFile, this.mapFileUtil, event.data);
+            if (shouldSyncThumbnail) {
+                createdEntity = await new thumbnail_util_1.ThumbnailUtil(this.config).syncThumbnailToVibeIQ({ entityId: createdEntity.id, primaryViewableId: createdEntity.primaryViewableId, event, entityName: this.baseType }) || createdEntity;
+            }
+            const statusMsg = this.getInboundStatusMessage({
+                status: event_short_message_status_1.EventShortMessageStatus.SUCCESS,
+                statusMessage: event_short_message_status_1.EventShortMessageStatus.CREATED,
+                objectClass: event.objectClass,
+                entityId: 'id',
+                federatedId: event.federatedId
+            });
+            console.log(statusMsg);
+            return createdEntity;
+        }
+        const diffs = await this.getUpdatesForEntity(entity, inboundData);
+        const shouldSyncThumbnail = await type_conversion_utils_1.TypeConversionUtils.syncInboundImages(this.transformMapFile, this.mapFileUtil, event.data);
+        let thumbnailEntity;
+        if (shouldSyncThumbnail) {
+            thumbnailEntity = await new thumbnail_util_1.ThumbnailUtil(this.config).syncThumbnailToVibeIQ({ entityId: entity.id, primaryViewableId: entity.primaryViewableId, event, entityName: this.baseType });
+        }
+        const hasPropertyChanges = Object.getOwnPropertyNames(diffs).length > 0;
+        if (!hasPropertyChanges && thumbnailEntity) {
+            const statusMsg = this.getInboundStatusMessage({
+                status: event_short_message_status_1.EventShortMessageStatus.SUCCESS,
+                statusMessage: event_short_message_status_1.EventShortMessageStatus.PRIMARY_CONTENT_UPDATED,
+                objectClass: event.objectClass,
+                entityId: entity.id,
+                federatedId: event.federatedId
+            });
+            console.log(statusMsg);
+            return thumbnailEntity;
+        }
+        if (!hasPropertyChanges) {
+            const statusMsg = this.getInboundStatusMessage({
+                status: event_short_message_status_1.EventShortMessageStatus.SUCCESS,
+                statusMessage: event_short_message_status_1.EventShortMessageStatus.NO_CHANGES,
+                objectClass: event.objectClass,
+                entityId: entity.id,
+                federatedId: event.federatedId
+            });
+            console.log(statusMsg);
+            const message = 'No Changes to persist for entity: ' + entity.id;
+            return {
+                status: 200,
+                data: { message }
+            };
+        }
+        const updatedEntity = await this.updateEntity(this.baseType, entity, diffs);
+        const statusMsg = this.getInboundStatusMessage({
+            status: event_short_message_status_1.EventShortMessageStatus.SUCCESS,
+            statusMessage: event_short_message_status_1.EventShortMessageStatus.UPDATED,
+            objectClass: event.objectClass,
+            entityId: entity.id,
+            federatedId: event.federatedId
+        });
+        console.log(statusMsg);
+        return updatedEntity;
+    }
+    getInboundStatusMessage(statusObject) {
+        return 'BaseEntityProcessor: inbound: status: ' + statusObject.status
+            + ', statusMessage: ' + statusObject.statusMessage
+            + ', entityType: ' + this.baseType
+            + ', entityId: ' + statusObject.entityId
+            + ', objectClass: ' + statusObject.objectClass
+            + ', federatedId: ' + statusObject.federatedId
+            + ', orgSlug: ' + this.orgSlug;
+    }
+    /**This will query for the entity, and handle post-processing
+     * of any critieria that is defined at the sub-type level.
+     * Because sub-type criteria can't be used in the search done
+     * on the server. This is expected to be called by getIncomingEntity().
+     *
+     * @param entityType: the root type of the entity
+     * @param entityTypePath: the full type path of the entity. Ex: custom-entity:sample
+     * @param propertyCriteria: all the criteria to search for the entity
+     * @returns the entities that match the criteria
+     */
+    async queryEntityWithSubTypeCriteria(entityType, entityTypePath, propertyCriteria) {
+        //allCriteria; identifierKeys; entityType; entityTypePath
+        if (!entityType || !entityTypePath) {
+            throw new Error('type and entityTypePath must be defined');
+        }
+        if (!propertyCriteria || Object.getOwnPropertyNames(propertyCriteria).length == 0) {
+            throw new Error('propertyCriteria must be defined and have at least one property');
+        }
+        const { rootTypeCriteria, subTypeCriteria } = await this.getCriteriaForEntity(entityType, entityTypePath, propertyCriteria);
+        const returnedEntities = await this.dc.getAllObjectReferences(entityType, rootTypeCriteria, subTypeCriteria);
+        return returnedEntities;
+    }
+    /** This is to get the criteria for the entity that is being processed.
+     * This is to be overridden for item & project-item because of the need for
+     * setting the roles criteria.
+     *
+     * @param entityType: the root type of the entity
+     * @param entityTypePath: the full type path of the entity. Ex: custom-entity:sample
+     * @param propertyCriteria: all the criteria to search for the entity
+     * @returns the criteria for the entity
+     */
+    async getCriteriaForEntity(entityType, entityTypePath, propertyCriteria) {
+        if (!entityType || !entityTypePath) {
+            throw new Error('type and entityTypePath must be defined');
+        }
+        if (!propertyCriteria || Object.getOwnPropertyNames(propertyCriteria).length == 0) {
+            throw new Error('propertyCriteria must be defined and have at least one property');
+        }
+        const rootType = await this.typeUtil.getByRootAndPath({ root: entityType });
+        const rootTypePropertyKeys = await this.getRootTypePropertyKeys(rootType, propertyCriteria);
+        const rootTypeCriteria = {};
+        const subTypeCriteria = {};
+        if (entityType !== entityTypePath) {
+            subTypeCriteria['typePath'] = entityTypePath;
+        }
+        for (const key in propertyCriteria) {
+            if (rootTypePropertyKeys.includes(key)) {
+                rootTypeCriteria[key] = propertyCriteria[key];
+            }
+            else {
+                subTypeCriteria[key] = propertyCriteria[key];
+            }
+        }
+        return { rootTypeCriteria, subTypeCriteria };
+    }
+    /** This is to get the properties that are owned by the root type
+     * This needs to be overridded for multi-level types, such as item
+     * and project-item. And for those types, the propertyCriteria
+     * will be needed to determine the correct level.
+     *
+     * @param rootType: the full root type entity for the processed entity
+     * @param propertyCriteria: the criteria to determine the correct level (unused for single level types)
+     * @returns: string[] of the property keys
+     */
+    getRootTypePropertyKeys(rootType, propertyCriteria = null) {
+        const props = rootType['typeProperties'];
+        const rootTypePropertyKeys = props.map(prop => prop.slug);
+        return rootTypePropertyKeys;
+    }
+    async handleIncomingDelete(event) {
+        console.warn('delete is not configured', event);
+    }
+    async getTransformedData(event) {
+        let inboundData = event.data;
+        console.debug('inboundData: ' + JSON.stringify(inboundData));
+        const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(this.transformMapFile, this.mapFileUtil, inboundData, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
+        inboundData = await map_utils_1.MapUtil.applyTransformMap(this.transformMapFile, this.mapFileUtil, inboundData, mapKey, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
+        console.debug('Transformed-inboundData: ' + JSON.stringify(inboundData));
+        return inboundData;
+    }
+    async getUpdatesForEntity(entity, inboundData) {
+        const vibeOwningKeys = await this.getVibeOwningKeys(entity);
+        let updates = {
+            typeId: entity.typeId,
+            roles: entity.roles,
+            id: entity.id,
+        };
+        updates = await this.dc.setEntityValues(updates, inboundData, vibeOwningKeys);
+        for (const prop of ['typeId', 'roles', 'id']) {
+            delete updates[prop];
+        }
+        return this.dc.getPersistableChanges(entity, updates);
+    }
+    async getVibeOwningKeys(entity) {
+        let vibeOwningKeys = [];
+        if (this.transformMapFile && entity) {
+            //Technically the transform is flex->vibe.  But the vibe entity being updated was passed in,
+            // so we use VIBE2FLEX_DIRECTION to get the mapKey
+            const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKey(this.transformMapFile, this.mapFileUtil, entity, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION);
+            const mapSection = await map_utils_1.MapUtil.getFullMapSection(this.transformMapFile, this.mapFileUtil, mapKey);
+            vibeOwningKeys = mapSection?.vibeOwningKeys || [];
+        }
+        console.debug('vibeOwningKeys: ' + vibeOwningKeys);
+        return vibeOwningKeys;
+    }
+    async getVibeOwningKeysFromInbound(entity) {
+        let vibeOwningKeys = [];
+        if (this.transformMapFile && entity) {
+            const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(this.transformMapFile, this.mapFileUtil, entity, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
+            const mapSection = await map_utils_1.MapUtil.getFullMapSection(this.transformMapFile, this.mapFileUtil, mapKey);
+            vibeOwningKeys = mapSection?.vibeOwningKeys || [];
+        }
+        console.debug('vibeOwningKeys: ' + vibeOwningKeys);
+        return vibeOwningKeys;
+    }
+    async createEntity(entityName, changes) {
+        const options = {
+            entityName: entityName,
+            object: changes,
+        };
+        console.log("createEntity: " + JSON.stringify(options));
+        return await new sdk_1.Entities().create(options);
+    }
+    async updateEntity(entityName, entity, diffs) {
+        const options = {
+            entityName: entityName,
+            id: entity['id'],
+            object: diffs
+        };
+        console.log('updateEntity: ' + JSON.stringify(options));
+        return await new sdk_1.Entities().update(options);
+    }
+    // outbound
+    async outbound(event) {
+        const entityType = event.entityType;
+        const eventType = event.eventType;
+        const entityId = event.id;
+        console.log(`outbound: ${entityType}:${entityId}`);
+        switch (eventType) {
+            case 'update':
+            case 'create':
+                return await this.handleOutgoingUpsert(entityType, event);
+            case 'delete':
+                return await this.handleOutgoingDelete(entityType, event);
+            case 'sendUpsertToFlexPLM':
+                return await this.sendUpsertToFlexPLM(event);
+            default:
+                console.log(UNSUPPORTED_TYPE);
+                return {
+                    status: 500,
+                    data: { UNSUPPORTED_TYPE }
+                };
+        }
+    }
+    async handleOutgoingUpsert(entityType, event) {
+        const objectClass = await type_conversion_utils_1.TypeConversionUtils.getObjectClass(this.transformMapFile, this.mapFileUtil, event.newData);
+        if (!objectClass) {
+            const message = 'ObjectClass must have a value.';
+            console.log(message);
+            return {
+                status: 500,
+                data: { message }
+            };
+        }
+        try {
+            const payload = await this.getOutgoingUpsertPayload(entityType, event);
+            const flexResponse = await new flexplm_connect_1.FlexPLMConnect(this.config).sendToFlexPLM(payload);
+            const outboundEntityUpdates = await this.getOutboundEntityUpdates(event, flexResponse);
+            if (outboundEntityUpdates) {
+                flexResponse['outboundEntityUpdates'] = outboundEntityUpdates;
+            }
+            const statusMsg = 'BaseEntityProcessor: outbound: status: ' + event_short_message_status_1.EventShortMessageStatus.SUCCESS
+                + ', statusMessage: ' + flexResponse.status
+                + ', entityType: ' + this.baseType
+                + ', entityId: ' + event.id
+                + ', objectClass: ' + payload.objectClass
+                + ', updateFromResponse: ' + ((outboundEntityUpdates && Object.keys(outboundEntityUpdates).length > 0) ? 'true' : 'false')
+                + ', orgSlug: ' + this.orgSlug;
+            console.log(statusMsg);
+            return flexResponse;
+        }
+        catch (e) {
+            const statusMsg = 'BaseEntityProcessor: outbound: status: ' + event_short_message_status_1.EventShortMessageStatus.FAILURE
+                + ', statusMessage: ' + e.httpResponseStatus
+                + ', entityType: ' + this.baseType
+                + ', entityId: ' + event.id
+                + ', objectClass: ' + objectClass
+                + ', updateFromResponse: ' + 'false'
+                + ', orgSlug: ' + this.orgSlug;
+            console.log(statusMsg);
+            throw e;
+        }
+    }
+    async getOutboundEntityUpdates(event, flexResponse) {
+        const payload = flexResponse?.data?.payload;
+        const flexPayload = (payload) ? payload[0] : undefined;
+        let outboundEntityUpdates = undefined;
+        if (flexPayload && 'OK' === flexPayload.status) {
+            if (flexPayload.data && !flexPayload.data?.flexPLMObjectClass) {
+                flexPayload.data.flexPLMObjectClass = flexPayload.objectClass;
+            }
+            const inboundData = await this.getTransformedData(flexPayload);
+            outboundEntityUpdates = await this.getUpdatesForEntity(event.newData, inboundData);
+        }
+        return outboundEntityUpdates;
+    }
+    async handleOutgoingDelete(entityType, event) {
+        console.warn('delete is not configured', entityType, event.oldData);
+    }
+    /** Create a new event-workflow-request to rerun sending the entity to FlexPLM
+     * The event must contain any information needed to ensure it is put in the correct queue for the entity
+     *
+     * @param triggerKey Ex: event.entityType + '|sendUpsertToFlexPLM'
+     * @param event
+     * @returns
+     */
+    async triggerNewEvent(triggerKey, event) {
+        const newEvent = {
+            entityName: 'event-workflow-request',
+            object: {
+                triggerKey,
+                event
+            }
+        };
+        const response = await this.entities.create(newEvent);
+        return response;
+    }
+    /** Sends the current state of the entity to FlexPLM.
+     * So any changes made in Vibe between the event being generated and the event being processed are sent to FlexPLM.
+     *
+     * @param event must contain entityType, id; which are used to query for the entity
+     * @returns results of sending the entity to FlexPLM
+     */
+    async sendUpsertToFlexPLM(event) {
+        const payload = await this.getEntityCurrentStateUpsertPayload(event);
+        if (!payload) {
+            const message = 'No payload to send to FlexPLM';
+            console.log(message);
+            return {
+                status: 500,
+                data: { message }
+            };
+        }
+        ;
+        let objectClass = payload.objectClass;
+        try {
+            const flexResponse = await new flexplm_connect_1.FlexPLMConnect(this.config).sendToFlexPLM(payload);
+            const outboundEntityUpdates = await this.getOutboundEntityUpdates(event, flexResponse);
+            if (outboundEntityUpdates) {
+                flexResponse['outboundEntityUpdates'] = outboundEntityUpdates;
+            }
+            const statusMsg = 'BaseEntityProcessor: outbound: status: ' + event_short_message_status_1.EventShortMessageStatus.SUCCESS
+                + ', statusMessage: ' + flexResponse.status
+                + ', entityType: ' + this.baseType
+                + ', entityId: ' + event.id
+                + ', objectClass: ' + objectClass
+                + ', updateFromResponse: ' + ((outboundEntityUpdates && Object.keys(outboundEntityUpdates).length > 0) ? 'true' : 'false')
+                + ', orgSlug: ' + this.orgSlug;
+            console.log(statusMsg);
+            return flexResponse;
+        }
+        catch (e) {
+            const statusMsg = 'BaseEntityProcessor: outbound: status: ' + event_short_message_status_1.EventShortMessageStatus.FAILURE
+                + ', statusMessage: ' + e.httpResponseStatus
+                + ', entityType: ' + this.baseType
+                + ', entityId: ' + event.id
+                + ', objectClass: ' + objectClass
+                + ', updateFromResponse: ' + 'false'
+                + ', orgSlug: ' + this.orgSlug;
+            console.log(statusMsg);
+            throw e;
+        }
+    }
+    /** Generates the payload to send to FlexPLM, based on the current state of the entity.
+     * The current state of the entity are used as the newData and oldData; which is passed
+     * to getOutgoingUpsertPayload to generate the payload.
+     * @param event information about the item to send to FlexPLM
+     * @returns The payload to send to FlexPLM
+     */
+    async getEntityCurrentStateUpsertPayload(event) {
+        const id = event.id;
+        if (!id) {
+            return undefined;
+        }
+        const entity = await this.entities.get({
+            entityName: this.baseType,
+            id
+        });
+        if (!entity) {
+            return undefined;
+        }
+        event.newData = entity;
+        event.oldData = entity;
+        const payload = await this.getOutgoingUpsertPayload(this.baseType, event);
+        return payload;
+    }
+}
+exports.BaseEntityProcessor = BaseEntityProcessor;