@contrail/flexplm 1.7.3-alpha.2a95cdd → 1.7.3-alpha.865f4fc

package/lib/interfaces/interfaces.d.ts

@@ -14,6 +14,7 @@ export interface FCConfig {
     urlContext: string;
     vibeEventEndpoint: string;
     csrfEndpoint: string;
+    useDistinctRestEndPointForImages: boolean;
     itemPreDevelopmentLifecycleStages: string[];
     identifierAtts?: {
         [key: string]: string[];

package/lib/interfaces/mapping-file.d.ts

@@ -776,47 +776,6 @@ interface MappingFileBase {
  *     },
  *   },
  * };
- *
- * @example
- * // Multi-Entry and Composite FlexPLM properties.
- * //
- * // FlexPLM sends both shapes as a single string whose values are joined by
- * // the separator '|~*~|' (a trailing separator follows the last value):
- * //   Cuttable Width (multi-entry): '1MM Horizontal|~*~|2MM Vertical|~*~|'
- * //   Content        (composite):   '50.0% MetalProcessing|~*~|50.0% Cable|~*~|'
- * //
- * // VibeIQ stores these raw '|~*~|'-joined strings as-is, so no split/join is
- * // needed — a plain REKEY carries the value through unchanged in both
- * // directions. If you later need to store an array or a cleaned display
- * // value instead, add a VALUE_TRANSFORM task to `transformOrder` and a
- * // matching `valueTransform` entry (see {@link DirectionalSection.valueTransform})
- * // that splits on / joins with '|~*~|'.
- * export const mapping: MappingFile = {
- *   orgInfo: { appIdentifier: '@vibeiq/flexplm-connector', orgName: 'acme' },
- *   typeConversion: { vibe2flex: {}, flex2vibe: {} },
- *   LCSProduct: {
- *     vibe2flex: {
- *       transformOrder: [
- *         { processor: 'REKEY', rekeyDelete: true, rekeyKeepEmptyValues: true, rekeyTransformersKey: 'rekey' },
- *       ],
- *       // flexField: 'vibeSlug' — raw '|~*~|' strings pass straight through.
- *       rekey: {
- *         cuttableWidth:   'cuttableWidth',    // multi-entry
- *         materialContent: 'materialContent',  // composite (Flex 'Content')
- *       },
- *     },
- *     flex2vibe: {
- *       transformOrder: [
- *         { processor: 'REKEY', rekeyDelete: true, rekeyKeepEmptyValues: true, rekeyTransformersKey: 'rekey' },
- *       ],
- *       // vibeSlug: 'flexField'
- *       rekey: {
- *         cuttableWidth:   'cuttableWidth',
- *         materialContent: 'materialContent',
- *       },
- *     },
- *   },
- * };
  */
 export type MappingFile = MappingFileBase & {
     [mapKey: string]: MappingSection | MappingFileBase[keyof MappingFileBase];

package/lib/util/config-defaults.d.ts

@@ -17,6 +17,7 @@ export declare class ConfigDefaults {
         LCSMaterial: {
             processAsItem: boolean;
         };
+        useDistinctRestEndPointForImages: boolean;
         csrfEndpoint: string;
         vibeEventEndpoint: string;
         payloadDefaultAsArray: boolean;

package/lib/util/config-defaults.js

@@ -10,6 +10,10 @@ class ConfigDefaults {
         if (!config.apiHost || !config.userName || !config.password) {
             throw new Error(ConfigDefaults.NEED_CONFIG_VALUES);
         }
+        if (config.complexConfig && typeof config.complexConfig === 'object') {
+            Object.assign(config, config.complexConfig);
+            delete config.complexConfig;
+        }
         //List will be comma separated list in UI, so convert to array
         if (config?.itemPreDevelopmentLifecycleStages && !(config?.itemPreDevelopmentLifecycleStages instanceof Array)) {
             config.itemPreDevelopmentLifecycleStages = config.itemPreDevelopmentLifecycleStages.split(',');
@@ -49,6 +53,7 @@ class ConfigDefaults {
             LCSMaterial: {
                 processAsItem: false
             },
+            useDistinctRestEndPointForImages: true,
             csrfEndpoint: '/servlet/rest/security/csrf',
             vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
             payloadDefaultAsArray: true

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

@@ -38,7 +38,8 @@ describe('getFlexPLMValue multi_select', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -96,7 +97,8 @@ describe('getEnumerationValue', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -153,7 +155,8 @@ describe('getEnumerationValue multi_select', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -213,7 +216,8 @@ describe('getPersistableChanges', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -298,7 +302,8 @@ describe('getObjectReferenceValue cache', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -356,7 +361,8 @@ describe('getObjectReferenceValue bad value', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -462,7 +468,8 @@ describe('setObjectReferenceValue - identity service', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     });
     const refProp = {
         id: 'cJoZQvoj7dkfCBJq',
@@ -920,7 +927,8 @@ describe('getEntityValues', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -961,7 +969,8 @@ describe('setEnumerationKeys', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -1025,7 +1034,8 @@ describe('checkKeysAndValues', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -1102,7 +1112,8 @@ describe('filterOutArchivedAndTrashedEntities', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -1142,7 +1153,8 @@ describe('setUserListValue', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const userListProp1 = {};
     const userEmailMapping = [
@@ -1238,7 +1250,8 @@ describe('getUserListValue', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const userListProp1 = {
         slug: 'userList1'
@@ -1340,7 +1353,8 @@ describe('getFlexPLMValue size_range', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
@@ -1373,7 +1387,8 @@ describe('getEntityValue size_range', () => {
         urlContext: 'xxx',
         vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
         csrfEndpoint: '/servlet/rest/security/csrf',
-        itemPreDevelopmentLifecycleStages: ['concept']
+        itemPreDevelopmentLifecycleStages: ['concept'],
+        useDistinctRestEndPointForImages: true
     };
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);

package/lib/util/flexplm-connect.spec.js

@@ -24,6 +24,7 @@ const createConfig = (overrides) => ({
     password: () => 'pass',
     itemPreDevelopmentLifecycleStages: [],
     payloadDefaultAsArray: true,
+    useDistinctRestEndPointForImages: true,
     ...overrides,
 });
 describe('FlexPLMConnect.getRequest', () => {

package/lib/util/thumbnail-util.js

@@ -181,11 +181,32 @@ class ThumbnailUtil {
         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,
-        });
+        console.log('the useDistinctRestEndPointForImages is --> ' + this.config.useDistinctRestEndPointForImages);
+        let response;
+        if (this.config.useDistinctRestEndPointForImages) {
+            // Route through the connector endpoint (Basic auth + VIBEIQGROUP enforced there).
+            const imageEndpoint = '/rfa/vibeiq/image';
+            const urlPath = '/servlet/rest' + imageEndpoint + '?path=' + encodeURIComponent(thumbnailUrl);
+            response = await flexPLMConnect.getRequest({
+                urlPath,
+                includeUrlContext: true,
+                returnFullResponse: true,
+            });
+        }
+        else {
+            response = await flexPLMConnect.getRequest({
+                urlPath: encodedUrl,
+                includeUrlContext: false,
+                returnFullResponse: true,
+            });
+        }
+        // Ensure we actually receive an image content type.
+        const contTypeHeader = response.headers.get('content-type');
+        const contType = contTypeHeader ? contTypeHeader.split(';')[0] : 'application/octet-stream';
+        if (!contType.startsWith('image/')) {
+            const message = `Expected image content from FlexPLM but received '${contType}' for ${thumbnailUrl}`;
+            throw new Error(message);
+        }
         const fileBuffer = await response.arrayBuffer();
         const buffer = Buffer.from(fileBuffer);
         const contentTypeHeader = response.headers.get('content-type');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.7.3-alpha.2a95cdd",
+  "version": "1.7.3-alpha.865f4fc",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",