@contrail/flexplm 1.3.0 → 1.3.1-alpha.3507ab6

package/lib/util/thumbnail-util.js

@@ -1,215 +1,242 @@
-"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");
-const flexplm_connect_1 = require("./flexplm-connect");
-;
-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 customSizes = await this.getCustomSizes();
-                const key = (this.isThumbnailNew(event, customSizes))
-                    ? 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;
-    }
-    isThumbnailNew(event, customSizes) {
-        const propertyDiffs = event?.propertyDiffs;
-        if (propertyDiffs) {
-            const diffKeys = Object.keys(propertyDiffs);
-            const sizeKeys = ThumbnailUtil.OOB_SIZES.map(s => s.slug + 'DownloadUrl');
-            if (customSizes) {
-                sizeKeys.push(...customSizes.map(s => s.slug + 'Url'));
-            }
-            sizeKeys.push('primaryFileUrl');
-            console.info('diffKeys: ' + JSON.stringify(diffKeys));
-            console.info('sizeKeys: ' + JSON.stringify(sizeKeys));
-            return diffKeys.some(s => sizeKeys.includes(s));
-        }
-        return false;
-    }
-    async getFileId(primaryViewableId) {
-        console.info('ThumbnailUtil.getFileId()-' + primaryViewableId);
-        const sizes = await this.getCustomSizes();
-        const OOBSizes = JSON.parse(JSON.stringify(ThumbnailUtil.OOB_SIZES));
-        sizes.push(...OOBSizes);
-        console.info('sizes: ' + JSON.stringify(sizes));
-        const content = await this.getContentEntity(primaryViewableId, sizes);
-        if (!content) {
-            return undefined;
-        }
-        const contentKeys = Object.getOwnPropertyNames(content);
-        const isDebugOn = app_framework_1.Logger.isDebugOn();
-        let fileId = undefined;
-        let tempFileSize = 0;
-        for (const size of sizes) {
-            const slug = size?.slug;
-            if (contentKeys.includes(slug)) {
-                const file = content[slug];
-                if (isDebugOn) {
-                    console.debug('size: ' + slug);
-                    console.debug('fileId: ' + file['id']);
-                }
-                if (file && file['size'] > tempFileSize && file['size'] < this.max_thumbnail_size) {
-                    tempFileSize = file['size'];
-                    fileId = file['id'];
-                    if (isDebugOn) {
-                        console.debug('fileId: ' + fileId);
-                    }
-                }
-            }
-        }
-        console.info('ThumbnailUtil.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, sizes) {
-        const relations = sizes.map(s => s.slug);
-        relations.push('primaryFile');
-        const content = await this.entities.get({
-            entityName: 'content',
-            id: primaryViewableId,
-            relations
-        });
-        this.logContentResults(content, relations);
-        return content;
-    }
-    logContentResults(content, relations) {
-        if (app_framework_1.Logger.isDebugOn() && content && relations) {
-            const contentCopy = JSON.parse(JSON.stringify(content));
-            relations.forEach(r => {
-                delete contentCopy[r];
-            });
-            console.debug('content: ' + JSON.stringify(contentCopy));
-        }
-    }
-    async syncThumbnailToVibeIQ({ entityId, primaryViewableId, event, entityName }) {
-        console.debug(`syncThumbnailToVibeIQ: entityId=${entityId}, primaryViewableId=${primaryViewableId}, entityName=${entityName}`);
-        const eventData = event.data || {};
-        const newThumbnailId = eventData[ThumbnailUtil.NEW_THUMBNAIL_ID];
-        const existingThumbnailId = eventData[ThumbnailUtil.EXISTING_THUMBNAIL_ID];
-        const thumbnailUrl = newThumbnailId || existingThumbnailId;
-        if (newThumbnailId === ThumbnailUtil.REMOVE_THUMBNAIL) {
-            if (primaryViewableId) {
-                await this.entities.delete({ entityName: 'content', id: primaryViewableId });
-            }
-            const clearUpdates = await this.getClearPrimaryViewableUpdates();
-            const updatedEntity = await this.entities.update({ entityName, id: entityId, object: clearUpdates });
-            console.debug(`syncThumbnailToVibeIQ: applied clear updates for entityId=${entityId}`);
-            return updatedEntity;
-        }
-        if (!thumbnailUrl) {
-            console.debug(`syncThumbnailToVibeIQ: no thumbnail URL for entityId=${entityId}`);
-            return undefined;
-        }
-        if (!primaryViewableId) {
-            const content = await this.createContentFromFlexPLM(thumbnailUrl, entityId, entityName);
-            await this.entities.update({ entityName: 'content', id: content.id, object: { flexplmThumbnailUrl: thumbnailUrl } });
-            const primaryUpdates = await this.getPrimaryViewableUpdates(content);
-            const updatedEntity = await this.entities.update({ entityName, id: entityId, object: primaryUpdates });
-            console.debug(`syncThumbnailToVibeIQ: created new content ${content.id} for entityId=${entityId}`);
-            return updatedEntity;
-        }
-        const primaryViewable = await this.entities.get({ entityName: 'content', id: primaryViewableId });
-        if (primaryViewable?.flexplmThumbnailUrl === thumbnailUrl) {
-            console.debug(`syncThumbnailToVibeIQ: thumbnail already synced for entityId=${entityId}`);
-            return undefined;
-        }
-        const content = await this.createContentFromFlexPLM(thumbnailUrl, entityId, entityName);
-        await this.entities.update({ entityName: 'content', id: content.id, object: { flexplmThumbnailUrl: thumbnailUrl } });
-        const primaryUpdates = await this.getPrimaryViewableUpdates(content);
-        const updatedEntity = await this.entities.update({ entityName, id: entityId, object: primaryUpdates });
-        await this.entities.delete({ entityName: 'content', id: primaryViewableId });
-        console.debug(`syncThumbnailToVibeIQ: replaced content ${primaryViewableId} with ${content.id} for entityId=${entityId}`);
-        return updatedEntity;
-    }
-    async createContentFromFlexPLM(thumbnailUrl, entityId, entityName) {
-        const urlParts = thumbnailUrl.split('/');
-        const fileName = urlParts[urlParts.length - 1] || 'thumbnail';
-        const encodedUrl = urlParts.map(part => encodeURIComponent(part)).join('/');
-        const flexPLMConnect = new flexplm_connect_1.FlexPLMConnect(this.config);
-        const response = await flexPLMConnect.getRequest({
-            urlPath: encodedUrl,
-            includeUrlContext: false,
-            returnFullResponse: true,
-        });
-        const fileBuffer = await response.arrayBuffer();
-        const buffer = Buffer.from(fileBuffer);
-        const contentTypeHeader = response.headers.get('content-type');
-        const contentType = contentTypeHeader ? contentTypeHeader.split(';')[0] : 'application/octet-stream';
-        const contentHolderReference = `${entityName}:${entityId}`;
-        const content = await new sdk_1.Content().create({
-            fileBuffer: buffer,
-            fileName,
-            contentType,
-            contentHolderReference,
-        });
-        return content;
-    }
-    async getPrimaryViewableUpdates(content) {
-        const updates = {
-            primaryViewableId: content.id,
-            contentType: content.contentType,
-            fileName: content.fileName,
-            primaryFileUrl: content.primaryFileUrl,
-            largeViewableDownloadUrl: content.largeViewableUrl || content.primaryFileUrl,
-            mediumLargeViewableDownloadUrl: content.mediumLargeViewableUrl || content.primaryFileUrl,
-            mediumViewableDownloadUrl: content.mediumViewableUrl || content.primaryFileUrl,
-            smallViewableDownloadUrl: content.smallViewableUrl || content.primaryFileUrl,
-            tinyViewableDownloadUrl: content.tinyViewableUrl || content.primaryFileUrl,
-        };
-        const customSizes = await this.getCustomSizes();
-        for (const size of customSizes) {
-            updates[`${size.slug}DownloadUrl`] = content[`${size.slug}Url`] || content.primaryFileUrl;
-        }
-        return updates;
-    }
-    async getClearPrimaryViewableUpdates() {
-        const updates = {
-            primaryViewableId: null,
-            contentType: null,
-            fileName: null,
-            primaryFileUrl: null,
-            largeViewableDownloadUrl: null,
-            mediumLargeViewableDownloadUrl: null,
-            mediumViewableDownloadUrl: null,
-            smallViewableDownloadUrl: null,
-            tinyViewableDownloadUrl: null,
-        };
-        const customSizes = await this.getCustomSizes();
-        for (const size of customSizes) {
-            updates[`${size.slug}DownloadUrl`] = null;
-        }
-        return updates;
-    }
-}
-exports.ThumbnailUtil = ThumbnailUtil;
-ThumbnailUtil.NEW_THUMBNAIL_ID = 'NEW_THUMBNAIL_ID';
-ThumbnailUtil.EXISTING_THUMBNAIL_ID = 'EXISTING_THUMBNAIL_ID';
-ThumbnailUtil.REMOVE_THUMBNAIL = 'REMOVE_THUMBNAIL';
-ThumbnailUtil.OOB_SIZES = [{ slug: 'largeViewable' }, { slug: 'mediumLargeViewable' }, { slug: 'mediumViewable' }, { slug: 'smallViewable' }, { slug: 'tinyViewable' }];
+"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");
+const flexplm_connect_1 = require("./flexplm-connect");
+;
+class ThumbnailUtil {
+    constructor(config) {
+        this.config = config;
+        /** 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.). */
+        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;
+            //get custom sizes
+            const fileId = await this.getFileId(primaryViewableId);
+            if (fileId) {
+                const customSizes = await this.getCustomSizes();
+                const key = (this.isThumbnailNew(event, customSizes))
+                    ? 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;
+    }
+    /** Determines if a new image has been generated.  If any viewable is new, there might be a better
+   * sized image.  So send the fileId as new.
+   */
+    isThumbnailNew(event, customSizes) {
+        const propertyDiffs = event?.propertyDiffs;
+        if (propertyDiffs) {
+            const diffKeys = Object.keys(propertyDiffs);
+            const sizeKeys = ThumbnailUtil.OOB_SIZES.map(s => s.slug + 'DownloadUrl');
+            if (customSizes) {
+                sizeKeys.push(...customSizes.map(s => s.slug + 'Url'));
+            }
+            sizeKeys.push('primaryFileUrl');
+            console.info('diffKeys: ' + JSON.stringify(diffKeys));
+            console.info('sizeKeys: ' + JSON.stringify(sizeKeys));
+            return diffKeys.some(s => sizeKeys.includes(s));
+        }
+        return false;
+    }
+    async getFileId(primaryViewableId) {
+        console.info('ThumbnailUtil.getFileId()-' + primaryViewableId);
+        const sizes = await this.getCustomSizes();
+        const OOBSizes = JSON.parse(JSON.stringify(ThumbnailUtil.OOB_SIZES));
+        sizes.push(...OOBSizes);
+        console.info('sizes: ' + JSON.stringify(sizes));
+        //get Content
+        const content = await this.getContentEntity(primaryViewableId, sizes);
+        if (!content) {
+            return undefined;
+        }
+        const contentKeys = Object.getOwnPropertyNames(content);
+        const isDebugOn = app_framework_1.Logger.isDebugOn();
+        let fileId = undefined;
+        let tempFileSize = 0;
+        for (const size of sizes) {
+            const slug = size?.slug;
+            if (contentKeys.includes(slug)) {
+                const file = content[slug];
+                if (isDebugOn) {
+                    console.debug('size: ' + slug);
+                    console.debug('fileId: ' + file['id']);
+                }
+                if (file && file['size'] > tempFileSize && file['size'] < this.max_thumbnail_size) {
+                    tempFileSize = file['size'];
+                    fileId = file['id'];
+                    if (isDebugOn) {
+                        console.debug('fileId: ' + fileId);
+                    }
+                }
+            }
+        }
+        console.info('ThumbnailUtil.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, sizes) {
+        const relations = sizes.map(s => s.slug);
+        relations.push('primaryFile');
+        const content = await this.entities.get({
+            entityName: 'content',
+            id: primaryViewableId,
+            relations
+        });
+        this.logContentResults(content, relations);
+        return content;
+    }
+    /** This outputs the content entity, without the inflated file entities.
+   * To help debugging issues with sending the thumbnail info.
+   * The inflated entities are removed, because are large and cause
+   * problems with log file size limits.
+   *
+   * @param content: the content with inflated objects
+   * @param relations: string[] of the slugs for inflated objects
+   */
+    logContentResults(content, relations) {
+        if (app_framework_1.Logger.isDebugOn() && content && relations) {
+            const contentCopy = JSON.parse(JSON.stringify(content));
+            relations.forEach(r => {
+                delete contentCopy[r];
+            });
+            console.debug('content: ' + JSON.stringify(contentCopy));
+        }
+    }
+    /** Syncs the thumbnail from FlexPLM to VibeIQ. Handles creating, replacing, or removing
+     * the primary viewable content and persists the updates directly to the entity.
+     *
+     * @param entityId - The ID of the entity to update with thumbnail properties.
+     * @param primaryViewableId - The existing primary viewable content ID, if any.
+     * @param event - The inbound event containing thumbnail data (NEW_THUMBNAIL_ID / EXISTING_THUMBNAIL_ID).
+     * @param entityName - The entity type name (e.g. 'item', 'color') used for API calls.
+     * @returns The updated entity, or undefined if no thumbnail changes were needed.
+     */
+    async syncThumbnailToVibeIQ({ entityId, primaryViewableId, event, entityName }) {
+        console.debug(`syncThumbnailToVibeIQ: entityId=${entityId}, primaryViewableId=${primaryViewableId}, entityName=${entityName}`);
+        const eventData = event.data || {};
+        const newThumbnailId = eventData[ThumbnailUtil.NEW_THUMBNAIL_ID];
+        const existingThumbnailId = eventData[ThumbnailUtil.EXISTING_THUMBNAIL_ID];
+        const thumbnailUrl = newThumbnailId || existingThumbnailId;
+        // Case 1: REMOVE_THUMBNAIL
+        if (newThumbnailId === ThumbnailUtil.REMOVE_THUMBNAIL) {
+            if (primaryViewableId) {
+                await this.entities.delete({ entityName: 'content', id: primaryViewableId });
+            }
+            const clearUpdates = await this.getClearPrimaryViewableUpdates();
+            const updatedEntity = await this.entities.update({ entityName, id: entityId, object: clearUpdates });
+            console.debug(`syncThumbnailToVibeIQ: applied clear updates for entityId=${entityId}`);
+            return updatedEntity;
+        }
+        // Early return if no thumbnail URL
+        if (!thumbnailUrl) {
+            console.debug(`syncThumbnailToVibeIQ: no thumbnail URL for entityId=${entityId}`);
+            return undefined;
+        }
+        // Case 2: No existing primaryViewableId — create new content
+        if (!primaryViewableId) {
+            const content = await this.createContentFromFlexPLM(thumbnailUrl, entityId, entityName);
+            await this.entities.update({ entityName: 'content', id: content.id, object: { flexplmThumbnailUrl: thumbnailUrl } });
+            const primaryUpdates = await this.getPrimaryViewableUpdates(content);
+            const updatedEntity = await this.entities.update({ entityName, id: entityId, object: primaryUpdates });
+            console.debug(`syncThumbnailToVibeIQ: created new content ${content.id} for entityId=${entityId}`);
+            return updatedEntity;
+        }
+        // Case 3: Has primaryViewableId — check if thumbnail changed
+        const primaryViewable = await this.entities.get({ entityName: 'content', id: primaryViewableId });
+        if (primaryViewable?.flexplmThumbnailUrl === thumbnailUrl) {
+            console.debug(`syncThumbnailToVibeIQ: thumbnail already synced for entityId=${entityId}`);
+            return undefined; // Already synced
+        }
+        const content = await this.createContentFromFlexPLM(thumbnailUrl, entityId, entityName);
+        await this.entities.update({ entityName: 'content', id: content.id, object: { flexplmThumbnailUrl: thumbnailUrl } });
+        const primaryUpdates = await this.getPrimaryViewableUpdates(content);
+        const updatedEntity = await this.entities.update({ entityName, id: entityId, object: primaryUpdates });
+        await this.entities.delete({ entityName: 'content', id: primaryViewableId });
+        console.debug(`syncThumbnailToVibeIQ: replaced content ${primaryViewableId} with ${content.id} for entityId=${entityId}`);
+        return updatedEntity;
+    }
+    async createContentFromFlexPLM(thumbnailUrl, entityId, entityName) {
+        const urlParts = thumbnailUrl.split('/');
+        const fileName = urlParts[urlParts.length - 1] || 'thumbnail';
+        const encodedUrl = urlParts.map(part => encodeURIComponent(part)).join('/');
+        const flexPLMConnect = new flexplm_connect_1.FlexPLMConnect(this.config);
+        const response = await flexPLMConnect.getRequest({
+            urlPath: encodedUrl,
+            includeUrlContext: false,
+            returnFullResponse: true,
+        });
+        const fileBuffer = await response.arrayBuffer();
+        const buffer = Buffer.from(fileBuffer);
+        const contentTypeHeader = response.headers.get('content-type');
+        const contentType = contentTypeHeader ? contentTypeHeader.split(';')[0] : 'application/octet-stream';
+        const contentHolderReference = `${entityName}:${entityId}`;
+        const content = await new sdk_1.Content().create({
+            fileBuffer: buffer,
+            fileName,
+            contentType,
+            contentHolderReference,
+        });
+        return content;
+    }
+    async getPrimaryViewableUpdates(content) {
+        const updates = {
+            primaryViewableId: content.id,
+            contentType: content.contentType,
+            fileName: content.fileName,
+            primaryFileUrl: content.primaryFileUrl,
+            largeViewableDownloadUrl: content.largeViewableUrl || content.primaryFileUrl,
+            mediumLargeViewableDownloadUrl: content.mediumLargeViewableUrl || content.primaryFileUrl,
+            mediumViewableDownloadUrl: content.mediumViewableUrl || content.primaryFileUrl,
+            smallViewableDownloadUrl: content.smallViewableUrl || content.primaryFileUrl,
+            tinyViewableDownloadUrl: content.tinyViewableUrl || content.primaryFileUrl,
+        };
+        const customSizes = await this.getCustomSizes();
+        for (const size of customSizes) {
+            updates[`${size.slug}DownloadUrl`] = content[`${size.slug}Url`] || content.primaryFileUrl;
+        }
+        return updates;
+    }
+    async getClearPrimaryViewableUpdates() {
+        const updates = {
+            primaryViewableId: null,
+            contentType: null,
+            fileName: null,
+            primaryFileUrl: null,
+            largeViewableDownloadUrl: null,
+            mediumLargeViewableDownloadUrl: null,
+            mediumViewableDownloadUrl: null,
+            smallViewableDownloadUrl: null,
+            tinyViewableDownloadUrl: null,
+        };
+        const customSizes = await this.getCustomSizes();
+        for (const size of customSizes) {
+            updates[`${size.slug}DownloadUrl`] = null;
+        }
+        return updates;
+    }
+}
+exports.ThumbnailUtil = ThumbnailUtil;
+ThumbnailUtil.NEW_THUMBNAIL_ID = 'NEW_THUMBNAIL_ID';
+ThumbnailUtil.EXISTING_THUMBNAIL_ID = 'EXISTING_THUMBNAIL_ID';
+ThumbnailUtil.REMOVE_THUMBNAIL = 'REMOVE_THUMBNAIL';
+ThumbnailUtil.OOB_SIZES = [{ slug: 'largeViewable' }, { slug: 'mediumLargeViewable' }, { slug: 'mediumViewable' }, { slug: 'smallViewable' }, { slug: 'tinyViewable' }];

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

@@ -1 +1 @@
-export {};
+export {};