@contrail/flexplm 1.3.0-alpha.ccc03be → 1.3.1-alpha.3e8dbdd

package/lib/util/data-converter.js

@@ -44,16 +44,22 @@ class DataConverter {
         if (this.isVerboseDebugOn()) {
             console.debug('newData: ' + JSON.stringify(newData));
         }
+        //Using event to get propertyDiffs to find emptied values
+        //Add standard atts to skip
         dataToSkip = dataToSkip.concat(['updatedOn', 'updatedById', 'createdOn', 'createdById', 'modifiedAt', 'orgId', 'createdAt', 'id', 'typeId', 'workspaceId']);
+        // const oldData = event.oldData;
         const data = {};
         const typeId = newData?.typeId;
         if (!typeId) {
-            return;
+            return; // Don't have a type; so can't process
         }
         data['typePath'] = newData['typePath'];
         const type = await this.typeUtils.getTypeById(typeId);
         const typeProps = this.typeUtils.filterTypeProperties(type, newData);
         for (const prop of typeProps) {
+            // if(this.logger.isTraceOn()){
+            //   this.logger.log('prop: ' + JSON.stringify(prop));
+            // }
             const slug = prop['slug'];
             if (dataToSkip.includes(slug)) {
                 continue;
@@ -69,6 +75,7 @@ class DataConverter {
         const propertyType = prop['propertyType'];
         const slug = prop['slug'];
         const nd = newData[slug];
+        // console.log('getFlexPLMValue: ' + propertyType + ', ' +slug + ', ' + nd + ', ' + od);
         let value;
         if (['string', 'text'].includes(propertyType)) {
             value = nd || '';
@@ -79,6 +86,10 @@ class DataConverter {
         else if ('date' === propertyType) {
             if (nd) {
                 value = nd;
+                // const d = new Date(nd);
+                // console.log('Date.getTimezoneOffset(): ' + d.getTimezoneOffset());
+                // value = d.toISOString();
+                // console.log('date: ' + nd + ' -- ' + value);
             }
             else {
                 value = null;
@@ -100,11 +111,13 @@ class DataConverter {
             }
         }
         else if ('image' === propertyType) {
+            // console.log('image-TODO');
         }
         else if ('formula' === propertyType) {
             value = nd;
         }
         else if ('json' === propertyType) {
+            // console.log('json-TODO');
             value = nd;
         }
         else if ('userList' === propertyType) {
@@ -112,6 +125,12 @@ class DataConverter {
         }
         return value;
     }
+    /** Returns the display values for list properties (choice & multi_select)
+     *
+     * @param prop
+     * @param newData
+     * @returns
+     */
     getEnumerationValue(prop, nd) {
         const propertyType = prop['propertyType'];
         let value;
@@ -195,6 +214,14 @@ class DataConverter {
         this.objRefCache[entityId] = value;
         return value;
     }
+    /** (Deprecated) Use TypeConversionUtils.getMapKey()
+     * Will return the class to use to get mapping.
+     * This is needed because mappings will be different for different sub types
+     * of custom-entity
+     *
+     * @param obj: Entity being checked
+     * @param mapping: The whole mapping file
+     */
     getMappingClass(entity, mapping) {
         const entityTypePath = entity['typePath'];
         const typeMapKey = mapping['typeMapKey'];
@@ -208,11 +235,22 @@ class DataConverter {
         }
         return objClass;
     }
+    /** Sets entity values from FlexPLM data passed in
+     * Assumes the entity has a VibeIQ typeId and 'roles' value to filter if necessary.
+     * @param entity the entity to update
+     * @param data the FlexPLM data
+     * @param keysToSkip properties to skip
+     * @returns the modified entity with VibeIQ values
+     */
     async setEntityValues(entity, data, keysToSkip = []) {
+        // this.logger.log('setEntityValues: ' + JSON.stringify(entity));
+        // this.logger.log('data: ' + JSON.stringify(data));
         const type = await this.typeUtils.getTypeById(entity.typeId);
         keysToSkip = keysToSkip.concat(['updatedOn', 'updatedById', 'createdOn', 'createdById', 'modifiedAt', 'orgId', 'createdAt', 'id', 'typeId', 'typePath', 'workspaceId']);
         let typeProps = this.typeUtils.filterTypeProperties(type, entity);
         typeProps = typeProps.filter(prop => !keysToSkip.includes(prop['slug']));
+        //Only process properties that had a value sent; to not accidentally clear out values
+        //for properties that weren't sent.
         const dataKeys = Object.getOwnPropertyNames(data);
         typeProps = typeProps.filter(prop => dataKeys.includes(prop['slug']));
         for (const prop of typeProps) {
@@ -223,9 +261,17 @@ class DataConverter {
                 keyName = slug + 'Id';
             }
             entity[keyName] = await this.getEntityValue(prop, data);
+            // console.log('entity[slug]: ' + entity[slug]);
         }
         return entity;
     }
+    /** Gets the entity values from FlexPLM data
+     * Assumes there isn't a VibeIQ typeId, so uses FlexPLM data to determine type
+     * @param objectClass FlexPLM object class
+     * @param data object data
+     * @param keysToSkip type properties to not process
+     * @returns object with VibeIQ values
+     */
     async getEntityValues(objectClass, data, keysToSkip = []) {
         const entityValues = {};
         const tco = await this.typeUtils.getEntityTypeClientOptionsUsingMapping(this.transformMapFile, this.mapFileUtil, data);
@@ -250,10 +296,17 @@ class DataConverter {
         }
         return entityValues;
     }
+    /** Gets the VibeIQ value for the property from data
+     *
+     * @param prop the VibeIQ property
+     * @param data the FlexPLM data
+     * @returns value to be set in VibeIQ
+     */
     async getEntityValue(prop, data) {
         const propertyType = prop['propertyType'];
         const slug = prop['slug'];
         const nd = data[slug];
+        // this.logger.log('getValue: ' + propertyType + ', ' +slug + ', ' + nd);
         let value;
         if (['string', 'text'].includes(propertyType)) {
             value = nd;
@@ -263,6 +316,11 @@ class DataConverter {
         }
         else if ('date' === propertyType) {
             if (nd) {
+                // const offset = new Date(nd).getTimezoneOffset() * 60 * 1_000;
+                // this.logger.log('nd: ' + nd);
+                // this.logger.log(offset);
+                // this.logger.log('No Offset: ' + new Date(nd).toISOString());
+                // const d = new Date(nd + offset);// Take system Timezone into account.
                 const d = new Date(nd);
                 value = d.toISOString();
             }
@@ -283,20 +341,25 @@ class DataConverter {
             value = await this.setObjectReferenceValue(prop, nd);
         }
         else if ('image' === propertyType) {
+            // console.log('TODO-image');
         }
         else if ('formula' === propertyType) {
+            // console.log('TODO-formula');
         }
         else if ('json' === propertyType) {
+            // console.log('TODO-json');
         }
         else if ('userList' === propertyType) {
             value = await this.setUserListValue(prop, nd);
         }
+        // console.log(value);
         return value;
     }
     setEnumerationKeys(prop, nd, matchByDisplay) {
         const propertyType = prop['propertyType'];
         let value;
         if (['choice', 'multi_select'].includes(propertyType)) {
+            //If there are no options, use empty array to not error out and don't set anything
             const options = prop['options'] || [];
             if ('choice' === propertyType) {
                 if (nd) {
@@ -326,6 +389,12 @@ class DataConverter {
         }
         return value;
     }
+    /** Compares the potential changes to the entity and returns only the actual differences.
+     *
+     * @param entity the full entity
+     * @param changes the potential changes
+     * @returns only the change values that are different from the entity's value
+     */
     getPersistableChanges(entity, changes) {
         const entityCompareValues = {};
         for (const key of (Object.getOwnPropertyNames(changes))) {
@@ -340,6 +409,12 @@ class DataConverter {
         }
         return diffValues;
     }
+    /** Sets object reference value from FlexPLM data passed in
+     *
+     * @param prop the VibeIQ property
+     * @param nd the VibeIQ data
+     * @returns the object reference id from VibeIQ
+     */
     async setObjectReferenceValue(prop, nd) {
         let objectReferenceId = "";
         if (!nd) {
@@ -398,6 +473,13 @@ class DataConverter {
         this.objRefCache[cacheKey] = objectReferenceId;
         return objectReferenceId;
     }
+    /**
+     * Retrieves all object references of a specified entity type based on the provided criteria.
+     * This function handles pagination and asynchronously fetches object references until there are no more pages.
+     * @param {string} entityType - The type of entity for which object references are to be retrieved.
+     * @param {object} rootTypeCriteria - The criteria used to filter object references.
+     * @returns {Promise<Array>} A Promise that resolves to an array containing all object references.
+     */
     async getAllObjectReferences(entityType, rootTypeCriteria, postProcessCriteria = null) {
         const entities = new sdk_1.Entities();
         let loads = [];
@@ -453,6 +535,14 @@ class DataConverter {
         }
         return loads;
     }
+    /**
+     * Checks if all keys and values of a given object are present in an array of objects.
+     * @param {Object} criteria - The object whose keys and values are to be checked in the array of objects.
+     * @param {Array<Object>} arrayOfObjects - The array of objects to be searched for matching keys and values.
+     * @param {string} entityTypePath - The type / subtype for the property; objects must be this type or a sub type of it.
+     * @returns {(Object|boolean)} Returns the array of objects that matches all keys and values of the provided object.
+     *                             If no match is found, returns empty array.
+     */
     checkKeysAndValues(criteria, arrayOfObjects, entityTypePath) {
         let arrOfMatchObjects = [];
         for (let i = 0; i < arrayOfObjects.length; i++) {
@@ -476,6 +566,11 @@ class DataConverter {
         }
         return arrOfMatchObjects;
     }
+    /** Filters out archived and trashed entities from the provided array of entities.
+     *
+     * @param entities
+     * @returns
+     */
     filterOutArchivedAndTrashedEntities(entities) {
         if (!entities || !Array.isArray(entities) || entities.length === 0) {
             return [];
@@ -486,6 +581,12 @@ class DataConverter {
             return !isArchived && !isTrashed;
         });
     }
+    /** Sets userListId value from FlexPLM data passed in
+     *
+     * @param prop the VibeIQ property
+     * @param nd the VibeIQ data
+     * @returns the modified entity with FlexPLM values
+     */
     async setUserListValue(prop, nd) {
         if (!nd?.email) {
             return "";
@@ -506,6 +607,13 @@ class DataConverter {
         }
         return userId;
     }
+    /** Makes batch calls of 1000 of user-org entities until
+     * it find one with userEmail of passed in nd.email.
+     * Maxes out after querying for 15,000 user-org entities
+     *
+     * @param nd
+     * @returns
+     */
     async getUserByEmail(nd) {
         let userOrg = undefined;
         let count = 0;
@@ -522,6 +630,11 @@ class DataConverter {
         } while (!userOrg && size == getOptionsCriteria.take && count < 15);
         return userOrg?.user;
     }
+    /** Shows warning if user email address not present in group associated to property
+     *
+     * @param prop the VibeIQ property
+     * @param userEmail user email address
+     */
     async processGroupMemberCheck(prop, userEmail) {
         let arrUserList = [];
         if (this.userRefCache[prop.typePropertyUserListId]) {
@@ -544,6 +657,12 @@ class DataConverter {
             }
         }
     }
+    /** Gets the VibeIQ value for the userList property from data
+     *
+     * @param prop the VibeIQ property
+     * @param newData the FlexPLM data
+     * @returns value to be set in VibeIQ
+     */
     async getUserListValue(prop, newData) {
         const slug = prop['slug'];
         if (app_framework_1.Logger.isDebugOn()) {
@@ -572,6 +691,13 @@ class DataConverter {
         }
         return value;
     }
+    /** Makes batch calls of 1000 of user-org entities until
+     * it find one with user.id of passed in userId.
+     * Maxes out after querying for 15,000 user-org entities
+     *
+     * @param userId
+     * @returns
+     */
     async getUserById(userId) {
         let userOrg = undefined;
         let count = 0;

package/lib/util/data-converter.spec.js

@@ -609,6 +609,7 @@ describe('checkKeysAndValues', () => {
         { name: 'Group 4', typePath: 'custom-entity:grouping:sub' },
         { name: 'Group 5', typePath: 'custom-entity:grouping:sub' }
     ];
+    //item:product:newBalance:accessories, item:product:newBalance:apparel
     it('Group 1', () => {
         const criteria = {
             name: 'Group 1'
@@ -830,6 +831,7 @@ describe('getUserListValue', () => {
     ];
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
+    //getUserById
     let spyGetUserById = jest.spyOn(dc, 'getUserById')
         .mockImplementation(async (nd) => {
         return userEmailMapping.find((user) => user.id === nd);

package/lib/util/error-response-object.d.ts

@@ -1,4 +1,9 @@
 import { AppActionCallBack } from "@contrail/app-framework";
 export declare class ErrorResponseObject {
+    /** Returns a response, checking for multiple possible error details
+     *
+     * @param e
+     * @returns
+     */
     static getResponse(e: any): AppActionCallBack;
 }

package/lib/util/error-response-object.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorResponseObject = void 0;
 const app_framework_1 = require("@contrail/app-framework");
 class ErrorResponseObject {
+    /** Returns a response, checking for multiple possible error details
+     *
+     * @param e
+     * @returns
+     */
     static getResponse(e) {
         if (!e) {
             const response = {
@@ -20,6 +25,7 @@ class ErrorResponseObject {
             }
         };
         const output = response.output;
+        //Errors when persisting in VibeIQ
         if (e.details)
             output.errorDetails = e.details;
         if (e.code)
@@ -30,6 +36,7 @@ class ErrorResponseObject {
             output.type = e.type;
         if (e.name)
             output.errorName = e.name;
+        //Has original cause
         if (e.cause) {
             output.cause = {};
             const cause = output.cause;

package/lib/util/event-short-message-status.js

@@ -16,6 +16,7 @@ var EventShortMessageStatus;
     EventShortMessageStatus["PRIMARY_CONTENT_UPDATED"] = "Primary_Content_Updated";
     EventShortMessageStatus["TOO_MANY_ENTITIES_FOUND"] = "Too_Many_Entities_Found";
     EventShortMessageStatus["UPDATED"] = "Updated";
+    //Publish
     EventShortMessageStatus["NOT_PUBLISHABLE"] = "Not_Publishable";
     EventShortMessageStatus["NO_FEDERATION_INFO"] = "No_Federation_Information";
     EventShortMessageStatus["NO_EVENTS_TO_SEND"] = "No_Events_to_Send";

package/lib/util/federation.js

@@ -43,9 +43,11 @@ class Federation {
                 mappedReference: itemResults[i].federatedId,
                 federationSchema: FED_CONFIG.federationSchema
             };
+            // console.log('createFederatedRecord: ' + JSON.stringify(payload));
             try {
                 const results = await new sdk_1.Entities().create({ entityName: 'federation', object: payload });
                 return results;
+                // console.log(JSON.stringify(results));
             }
             catch (error) {
                 console.log('createFederatedRecord-error: ', error);
@@ -79,13 +81,16 @@ class Federation {
         return { entityType, entityId };
     }
     async getEntityFromMappedRefId(mappedRefId) {
+        // console.log('!---getEntityFromMappedRefId: ' + mappedRefId);
         const fedRecord = await this.getFederationRecordFromMappedRefId(mappedRefId);
         console.log('fedRecord: ' + JSON.stringify(fedRecord));
         if (!fedRecord) {
+            //Not creating from FlexPLM at this time.
             console.log('Federation Record doesnt exist. Cant get entity!');
             return;
         }
         const { entityType, entityId } = Federation.getEntityId(fedRecord);
+        // console.log(entityType + ':' + entityId);
         const criteria = {
             id: entityId
         };
@@ -94,6 +99,7 @@ class Federation {
             criteria
         });
         const entity = (entities && entities[0]) ? entities[0] : undefined;
+        // console.log(' entities: ' +JSON.stringify(entities));
         return entity;
     }
     async getFederationRecordsFromIds(ids) {
@@ -104,6 +110,7 @@ class Federation {
                 appIdentifier: FED_CONFIG.appIdentifier,
                 federationSchema: FED_CONFIG.federationSchema
             };
+            // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
             const recs = await new sdk_1.Entities().get({
                 entityName: 'federation',
                 criteria
@@ -126,6 +133,7 @@ class Federation {
                     appIdentifier: FED_CONFIG.appIdentifier,
                     federationSchema: FED_CONFIG.federationSchema
                 };
+                // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
                 const records = await entities.get({
                     entityName: 'federation',
                     criteria

package/lib/util/flexplm-connect.d.ts

@@ -14,6 +14,13 @@ export declare class FlexPLMConnect {
     protected processRequest(payload: any): Promise<FlexPLMResponseData>;
     sendToFlexPLM(payload: PayloadType): Promise<FlexPLMResponseData>;
     sendMultipleToFlexPLM(payload: PayloadType[]): Promise<FlexPLMResponseData>;
+    /** Runs a GET request to FlexPLM.
+     * @param params - Optional configuration for the request.
+     * @param params.urlPath - Custom URL path to use instead of the default `/servlet/rest` + endpoint.
+     * @param params.includeUrlContext - Whether to include the urlContext in the URL. Defaults to `true`.
+     * @param params.returnFullResponse - If `true`, returns the raw `Response` object instead of parsed JSON. Defaults to `false`.
+     * @returns The parsed JSON response body, or the raw `Response` object if `returnFullResponse` is `true`.
+     */
     getRequest(params?: {
         urlPath?: string;
         includeUrlContext?: boolean;

package/lib/util/flexplm-connect.js

@@ -18,6 +18,9 @@ class FlexPLMConnect {
             this.staticHeaders = this.config?.flexplmConnect?.staticHeaders;
         }
     }
+    /////////////////////////////////////////////////////////////////////////////
+    ///////// Custom getRequestOptions: start
+    /////////////////////////////////////////////////////////////////////////////
     getRequestOptions(method) {
         const csrfOptions = {
             method,
@@ -37,6 +40,9 @@ class FlexPLMConnect {
         }
         return csrfOptions;
     }
+    /////////////////////////////////////////////////////////////////////////////
+    ///////// Custom getRequestOptions: end
+    /////////////////////////////////////////////////////////////////////////////
     async getCSRF() {
         const urlContext = this.config.urlContext;
         const csrfEndpoint = this.config.csrfEndpoint;
@@ -130,6 +136,7 @@ class FlexPLMConnect {
                 }
             }
             console.log('eventResponse.status: ' + status);
+            // console.log('eventBody: ', JSON.stringify(data));
             return res;
         }
         catch (e) {
@@ -145,6 +152,13 @@ class FlexPLMConnect {
     async sendMultipleToFlexPLM(payload) {
         return await this.processRequest(payload);
     }
+    /** Runs a GET request to FlexPLM.
+     * @param params - Optional configuration for the request.
+     * @param params.urlPath - Custom URL path to use instead of the default `/servlet/rest` + endpoint.
+     * @param params.includeUrlContext - Whether to include the urlContext in the URL. Defaults to `true`.
+     * @param params.returnFullResponse - If `true`, returns the raw `Response` object instead of parsed JSON. Defaults to `false`.
+     * @returns The parsed JSON response body, or the raw `Response` object if `returnFullResponse` is `true`.
+     */
     async getRequest(params) {
         const { urlPath, includeUrlContext = true, returnFullResponse = false } = params || {};
         const urlContext = includeUrlContext ? this.config.urlContext : '';

package/lib/util/logger-config.js

@@ -5,6 +5,7 @@ const app_framework_1 = require("@contrail/app-framework");
 async function setLoggerConfig(appConfig) {
     let logLevel = app_framework_1.LogLevel.INFO;
     if (!appConfig.logLevel) {
+        //pass
     }
     else if (appConfig.logLevel === 'error') {
         logLevel = app_framework_1.LogLevel.ERROR;

package/lib/util/map-util-spec-mockData.js

@@ -31,12 +31,26 @@ exports.mapping = {
                 }
             }
         }
+        // flex2vibe: {
+        //   LCSRevisableEntity: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSLast: {
+        //     getMapKey: (object) => {return object;}
+        //   },
+        //   LCSMaterial: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSBusinessObject: {
+        //     getMapKey: (object) => {return object;}
+        //   }
+        // },
     },
     LCSProduct: {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSProduct',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {
@@ -61,7 +75,7 @@ exports.mapping = {
                 vibeIQIdentifier: 'itemNumber'
             },
             valueTransform: {
-                transformEx: (row) => {
+                transformEx: (row /*, dependencies*/) => {
                     return row['otherProp'] + 'xxx';
                 }
             }
@@ -79,7 +93,7 @@ exports.mapping = {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSSKU',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {

package/lib/util/map-utils.d.ts

@@ -1,6 +1,33 @@
 import { MapFileUtil } from '@contrail/transform-data';
 export declare class MapUtil {
+    /** Transforms the data, assumes mapSectionKey has been correctly determined.
+     *
+     * @param transformMapFile id of map file
+     * @param mapFileUtil
+     * @param data
+     * @param mapSectionKey key for section of map file
+     * @param direction vibe2flex or flex2vibe
+     * @param transformTaskOrderKey key for the list of tasks to be processed. default is 'transformOrder'
+     * @returns The converted data
+     */
     static applyTransformMap(transformMapFile: any, mapFileUtil: any, data: any, mapSectionKey: string, direction: string, transformTaskOrderKey?: string): Promise<any>;
+    /** Returns the mapKey based on the 'typeConversion' section of the map file.
+     * If the map file doesn't have a section for the type in question, 'undefined' is returned.
+     *
+     * @param fileId
+     * @param mapFileUtil
+     * @param data The full object
+     * @param type The entity or object class of the object.  The functions are keyed based on this.
+     * @param direction
+     * @returns
+     */
     static getMapKey(transformMapFile: any, mapFileUtil: MapFileUtil, data: any, type: string, direction: string): Promise<string>;
+    /** Returns the full map section with both directions; identifier and informational properties; etc.
+     *
+     * @param transformMapFile id if map file
+     * @param mapFileUtil
+     * @param mapSectionKey key of the map section
+     * @returns
+     */
     static getFullMapSection(transformMapFile: string, mapFileUtil: MapFileUtil, mapSectionKey: string): Promise<any>;
 }

package/lib/util/map-utils.js

@@ -2,12 +2,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MapUtil = void 0;
 class MapUtil {
+    /** Transforms the data, assumes mapSectionKey has been correctly determined.
+     *
+     * @param transformMapFile id of map file
+     * @param mapFileUtil
+     * @param data
+     * @param mapSectionKey key for section of map file
+     * @param direction vibe2flex or flex2vibe
+     * @param transformTaskOrderKey key for the list of tasks to be processed. default is 'transformOrder'
+     * @returns The converted data
+     */
     static async applyTransformMap(transformMapFile, mapFileUtil, data, mapSectionKey, direction, transformTaskOrderKey = 'transformOrder') {
         return await mapFileUtil.applyTransformMap(transformMapFile, data, mapSectionKey, direction, transformTaskOrderKey);
     }
+    /** Returns the mapKey based on the 'typeConversion' section of the map file.
+     * If the map file doesn't have a section for the type in question, 'undefined' is returned.
+     *
+     * @param fileId
+     * @param mapFileUtil
+     * @param data The full object
+     * @param type The entity or object class of the object.  The functions are keyed based on this.
+     * @param direction
+     * @returns
+     */
     static async getMapKey(transformMapFile, mapFileUtil, data, type, direction) {
         return await mapFileUtil.getMapKey(transformMapFile, data, type, direction);
     }
+    /** Returns the full map section with both directions; identifier and informational properties; etc.
+     *
+     * @param transformMapFile id if map file
+     * @param mapFileUtil
+     * @param mapSectionKey key of the map section
+     * @returns
+     */
     static async getFullMapSection(transformMapFile, mapFileUtil, mapSectionKey) {
         return await mapFileUtil.getFullMapSection(transformMapFile, mapSectionKey);
     }

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

@@ -6,6 +6,7 @@ interface ContentCustomSize {
 }
 export declare class ThumbnailUtil {
     private 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.). */
     private max_thumbnail_size;
     private entities;
     static NEW_THUMBNAIL_ID: string;
@@ -16,11 +17,31 @@ export declare class ThumbnailUtil {
     }[];
     constructor(config: FCConfig);
     setOutboundThumbnail(data: any, event: any): Promise<any>;
+    /** 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: any, customSizes: any[]): boolean;
     getFileId(primaryViewableId: string): Promise<string | undefined>;
     getCustomSizes(): Promise<ContentCustomSize[]>;
     getContentEntity(primaryViewableId: any, sizes: ContentCustomSize[]): Promise<any>;
+    /** 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: any, relations: string[]): void;
+    /** 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.
+     */
     syncThumbnailToVibeIQ({ entityId, primaryViewableId, event, entityName }: {
         entityId: string;
         primaryViewableId?: string;