@contrail/flexplm 1.7.1 → 1.7.2-alpha.855d28b

package/lib/entity-processor/base-entity-processor.d.ts

@@ -80,7 +80,15 @@ export declare abstract class BaseEntityProcessor {
     getRootTypePropertyKeys(rootType: any, propertyCriteria?: any): string[];
     handleIncomingDelete(event: any): Promise<void>;
     getTransformedData(event: any): Promise<any>;
-    getUpdatesForEntity(entity: any, inboundData: any): Promise<object>;
+    /** Builds the updates that should be applied to the vibe entity based on the
+     *  inbound data and the original event data.
+     *
+     * @param entity: the vibe entity that is being updated
+     * @param inboundData: the data that was transformed from the flexplm event
+     * @param eventData: the original event data from flexplm
+     * @returns: the updates that should be applied to the vibe entity
+     */
+    getUpdatesForEntity(entity: any, inboundData: any, eventData?: any): Promise<object>;
     getVibeOwningKeys(entity: any): Promise<any[]>;
     getVibeOwningKeysFromInbound(entity: any): Promise<any[]>;
     createEntity(entityName: any, changes: any): Promise<any>;

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

@@ -85,7 +85,7 @@ class BaseEntityProcessor {
             console.log(statusMsg);
             return createdEntity;
         }
-        const diffs = await this.getUpdatesForEntity(entity, inboundData);
+        const diffs = await this.getUpdatesForEntity(entity, inboundData, event.data);
         const shouldSyncThumbnail = await type_conversion_utils_1.TypeConversionUtils.syncInboundImages(this.transformMapFile, this.mapFileUtil, event.data);
         let thumbnailEntity;
         if (shouldSyncThumbnail) {
@@ -278,7 +278,15 @@ class BaseEntityProcessor {
         console.debug('Transformed-inboundData: ' + JSON.stringify(inboundData));
         return inboundData;
     }
-    async getUpdatesForEntity(entity, inboundData) {
+    /** Builds the updates that should be applied to the vibe entity based on the
+     *  inbound data and the original event data.
+     *
+     * @param entity: the vibe entity that is being updated
+     * @param inboundData: the data that was transformed from the flexplm event
+     * @param eventData: the original event data from flexplm
+     * @returns: the updates that should be applied to the vibe entity
+     */
+    async getUpdatesForEntity(entity, inboundData, eventData = null) {
         const vibeOwningKeys = await this.getVibeOwningKeys(entity);
         let updates = {
             typeId: entity.typeId,

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

@@ -9,6 +9,7 @@ export declare class ThumbnailUtil {
     /** The max_thumbnail_size is for limiting the size of the thumbnail being sent to FlexPLM.  It is used when checking the size of the auto generated thumbnails (smallViewable, tinyViewable, etc.). */
     private max_thumbnail_size;
     private entities;
+    static THUMBNAIL: string;
     static NEW_THUMBNAIL_ID: string;
     static EXISTING_THUMBNAIL_ID: string;
     static REMOVE_THUMBNAIL: string;

package/lib/util/thumbnail-util.js

@@ -136,9 +136,10 @@ class ThumbnailUtil {
         const eventData = event.data || {};
         const newThumbnailId = eventData[ThumbnailUtil.NEW_THUMBNAIL_ID];
         const existingThumbnailId = eventData[ThumbnailUtil.EXISTING_THUMBNAIL_ID];
-        const thumbnailUrl = newThumbnailId || existingThumbnailId;
+        const iteratedThumbnailId = eventData[ThumbnailUtil.THUMBNAIL];
+        const thumbnailUrl = iteratedThumbnailId || newThumbnailId || existingThumbnailId;
         // Case 1: REMOVE_THUMBNAIL
-        if (newThumbnailId === ThumbnailUtil.REMOVE_THUMBNAIL) {
+        if (thumbnailUrl === ThumbnailUtil.REMOVE_THUMBNAIL) {
             if (primaryViewableId) {
                 await this.entities.delete({ entityName: 'content', id: primaryViewableId });
             }
@@ -236,6 +237,8 @@ class ThumbnailUtil {
     }
 }
 exports.ThumbnailUtil = ThumbnailUtil;
+// Adding Thumbnail property
+ThumbnailUtil.THUMBNAIL = 'THUMBNAIL';
 ThumbnailUtil.NEW_THUMBNAIL_ID = 'NEW_THUMBNAIL_ID';
 ThumbnailUtil.EXISTING_THUMBNAIL_ID = 'EXISTING_THUMBNAIL_ID';
 ThumbnailUtil.REMOVE_THUMBNAIL = 'REMOVE_THUMBNAIL';

package/lib/util/thumbnail-util.spec.js

@@ -437,4 +437,94 @@ describe('ThumbnailUtil Tests', () => {
             expect(mockEntitiesDelete).not.toHaveBeenCalled();
         });
     });
+    describe('ThumbnailUtil - iteratedThumbnailId (THUMBNAIL key)', () => {
+        const config = {};
+        let tu;
+        beforeEach(() => {
+            jest.clearAllMocks();
+            tu = new thumbnail_util_1.ThumbnailUtil(config);
+            mockEntitiesGet.mockImplementation((opts) => {
+                if (opts.entityName === 'content-custom-size')
+                    return Promise.resolve([]);
+                return Promise.resolve({});
+            });
+            mockEntitiesUpdate.mockImplementation((opts) => Promise.resolve({ id: opts.id }));
+            mockEntitiesDelete.mockImplementation((opts) => Promise.resolve({ id: opts.id }));
+        });
+        it('does not break when THUMBNAIL value is not available in the event', async () => {
+            // No THUMBNAIL key (and no other thumbnail keys) -> iteratedThumbnailId is undefined
+            const event = { data: {} };
+            let result;
+            await expect((async () => {
+                result = await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', event, entityName: 'color' });
+            })()).resolves.not.toThrow();
+            // Falls through to the "no thumbnail URL" early return
+            expect(result).toBeUndefined();
+            expect(mockContentCreate).not.toHaveBeenCalled();
+            expect(mockEntitiesUpdate).not.toHaveBeenCalled();
+            expect(mockEntitiesDelete).not.toHaveBeenCalled();
+        });
+        it('does not break when THUMBNAIL key is present but explicitly empty/falsy', async () => {
+            // THUMBNAIL present but falsy -> iteratedThumbnailId is falsy, no crash
+            const event = { data: { [thumbnail_util_1.ThumbnailUtil.THUMBNAIL]: '' } };
+            let result;
+            await expect((async () => {
+                result = await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', event, entityName: 'item' });
+            })()).resolves.not.toThrow();
+            expect(result).toBeUndefined();
+            expect(mockContentCreate).not.toHaveBeenCalled();
+            expect(mockEntitiesUpdate).not.toHaveBeenCalled();
+            expect(mockEntitiesDelete).not.toHaveBeenCalled();
+        });
+        it('syncs using iteratedThumbnailId when a THUMBNAIL value is available (no existing primaryViewable)', async () => {
+            const mockResponse = {
+                arrayBuffer: jest.fn().mockResolvedValue(new ArrayBuffer(8)),
+                headers: { get: jest.fn().mockReturnValue('image/png') },
+            };
+            mockGetRequest.mockResolvedValue(mockResponse);
+            const createdContent = {
+                id: 'iteratedContent1',
+                contentType: 'image/png',
+                fileName: 'iterated.png',
+                primaryFileUrl: 'https://files/primary.png',
+                largeViewableUrl: 'https://files/large.png',
+                mediumLargeViewableUrl: null,
+                mediumViewableUrl: null,
+                smallViewableUrl: null,
+                tinyViewableUrl: null,
+            };
+            mockContentCreate.mockResolvedValue(createdContent);
+            const thumbnailUrl = '/rest/thumbnail/iterated.png';
+            const event = { data: { [thumbnail_util_1.ThumbnailUtil.THUMBNAIL]: thumbnailUrl } };
+            await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', event, entityName: 'color' });
+            // Uses the THUMBNAIL value to fetch + create the content
+            expect(mockGetRequest).toHaveBeenCalledWith({
+                urlPath: thumbnailUrl,
+                includeUrlContext: false,
+                returnFullResponse: true,
+            });
+            expect(mockContentCreate).toHaveBeenCalledWith(expect.objectContaining({
+                fileName: 'iterated.png',
+                contentType: 'image/png',
+                contentHolderReference: 'color:entity1',
+            }));
+            // Stamps the content with the THUMBNAIL url
+            expect(mockEntitiesUpdate).toHaveBeenCalledWith(expect.objectContaining({
+                entityName: 'content',
+                id: 'iteratedContent1',
+                object: { flexplmThumbnailUrl: thumbnailUrl },
+            }));
+            // Updates the main entity
+            expect(mockEntitiesUpdate).toHaveBeenCalledWith(expect.objectContaining({ entityName: 'color', id: 'entity1' }));
+        });
+        it('REMOVE_THUMBNAIL via the THUMBNAIL key deletes content and clears the entity', async () => {
+            const event = { data: { [thumbnail_util_1.ThumbnailUtil.THUMBNAIL]: thumbnail_util_1.ThumbnailUtil.REMOVE_THUMBNAIL } };
+            await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', primaryViewableId: 'pv1', event, entityName: 'color' });
+            // Resolves REMOVE_THUMBNAIL from the THUMBNAIL key and removes the existing content
+            expect(mockEntitiesDelete).toHaveBeenCalledWith({ entityName: 'content', id: 'pv1' });
+            expect(mockEntitiesUpdate).toHaveBeenCalledWith(expect.objectContaining({ entityName: 'color', id: 'entity1' }));
+            // Does not create replacement content
+            expect(mockContentCreate).not.toHaveBeenCalled();
+        });
+    });
 });

package/package.json

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