@contrail/flexplm 1.1.67-alpha.0 → 1.1.67-alpha.2

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to `@contrail/flexplm` are documented here.
+
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.67] - 2026-xx-xx
+
+### Added
+- Added EventShortMessageStatus status values for adding items to projects functionality.
+
+### Changed
+- Added optional `context` parameter to `TypeConversionUtils.isInboundCreatableFromObject` method to allow passing context data to map file `isInboundCreatable` functions.
+
+## [1.1.66] - (initial changelog entry)
+
+- Initial changelog. Prior releases did not include a changelog.
+  See git history for changes predating this entry.

package/lib/util/event-short-message-status.d.ts

@@ -3,6 +3,7 @@ export declare enum EventShortMessageStatus {
     FAILURE = "Failure",
     CREATED = "Created",
     ITEM_FAMILY_ID_MISSING = "Item_family_id_missing",
+    ITEM_FAMILY_NOT_FOUND = "Item_family_not_found",
     PROJECT_ITEM_NOT_FOUND = "Project_item_not_found",
     MISSING_IDENTIFIER_PROPERTIES = "Missing_identifier_properties",
     MISSING_INPUT = "Missing_input",

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

@@ -7,6 +7,7 @@ var EventShortMessageStatus;
     EventShortMessageStatus["FAILURE"] = "Failure";
     EventShortMessageStatus["CREATED"] = "Created";
     EventShortMessageStatus["ITEM_FAMILY_ID_MISSING"] = "Item_family_id_missing";
+    EventShortMessageStatus["ITEM_FAMILY_NOT_FOUND"] = "Item_family_not_found";
     EventShortMessageStatus["PROJECT_ITEM_NOT_FOUND"] = "Project_item_not_found";
     EventShortMessageStatus["MISSING_IDENTIFIER_PROPERTIES"] = "Missing_identifier_properties";
     EventShortMessageStatus["MISSING_INPUT"] = "Missing_input";

package/lib/util/type-conversion-utils-spec-mockData.js

@@ -154,7 +154,12 @@ exports.mapping = {
         }
     },
     prefix: {
-        isInboundCreatable: () => true,
+        isInboundCreatable: (object, context) => {
+            if (context && context.skipPrefix) {
+                return false;
+            }
+            return true;
+        },
         vibe2flex: {
             transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
             rekey: {

package/lib/util/type-conversion-utils.d.ts

@@ -15,6 +15,6 @@ export declare class TypeConversionUtils {
     static getIdentifierPropertiesFromObject(fileId: any, mapFileUtil: MapFileUtil, object: any): Promise<string[]>;
     static getInformationalPropertiesFromObject(fileId: any, mapFileUtil: MapFileUtil, object: any): Promise<string[]>;
     static getMapKeyFromObject(fileId: any, mapFileUtil: MapFileUtil, object: any, direction: string): Promise<string>;
-    static isInboundCreatableFromObject(fileId: string, mapFileUtil: MapFileUtil, object: any): Promise<boolean>;
+    static isInboundCreatableFromObject(fileId: string, mapFileUtil: MapFileUtil, object: any, context?: any): Promise<boolean>;
     static getObjectType(object: any): any;
 }

package/lib/util/type-conversion-utils.js

@@ -180,13 +180,13 @@ class TypeConversionUtils {
             return type;
         }
     }
-    static async isInboundCreatableFromObject(fileId, mapFileUtil, object) {
+    static async isInboundCreatableFromObject(fileId, mapFileUtil, object, context) {
         let isInboundCreatable = false;
         if (fileId) {
             const mapKey = await this.getMapKeyFromObject(fileId, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
             const mapData = await map_utils_1.MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
             if (mapData && mapData['isInboundCreatable']) {
-                isInboundCreatable = await mapData['isInboundCreatable'](object);
+                isInboundCreatable = await mapData['isInboundCreatable'](object, context);
             }
         }
         return isInboundCreatable;

package/lib/util/type-conversion-utils.spec.js

@@ -580,5 +580,40 @@ describe('conversion-utils', () => {
                 spy.mockRestore();
             }
         });
+        it('should pass context to isInboundCreatable function', async () => {
+            const spy = jest.spyOn(mapFileUtil, 'getMapFile')
+                .mockImplementation(async () => {
+                return mapping;
+            });
+            const object = {
+                flexPLMObjectClass: 'LCSRevisableEntity',
+                flexPLMTypePath: 'Revisable Entity\\prefix'
+            };
+            const context = { skipPrefix: true };
+            try {
+                const results = await type_conversion_utils_1.TypeConversionUtils.isInboundCreatableFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object, context);
+                expect(results).toBeFalsy();
+            }
+            finally {
+                spy.mockRestore();
+            }
+        });
+        it('should work without context parameter', async () => {
+            const spy = jest.spyOn(mapFileUtil, 'getMapFile')
+                .mockImplementation(async () => {
+                return mapping;
+            });
+            const object = {
+                flexPLMObjectClass: 'LCSRevisableEntity',
+                flexPLMTypePath: 'Revisable Entity\\prefix'
+            };
+            try {
+                const results = await type_conversion_utils_1.TypeConversionUtils.isInboundCreatableFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object);
+                expect(results).toBeTruthy();
+            }
+            finally {
+                spy.mockRestore();
+            }
+        });
     });
 });

package/package.json

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

package/src/util/event-short-message-status.ts

@@ -3,6 +3,7 @@ export enum EventShortMessageStatus {
   FAILURE = 'Failure',
   CREATED = 'Created',
   ITEM_FAMILY_ID_MISSING = "Item_family_id_missing",
+  ITEM_FAMILY_NOT_FOUND = "Item_family_not_found",
   PROJECT_ITEM_NOT_FOUND = "Project_item_not_found",
   MISSING_IDENTIFIER_PROPERTIES = 'Missing_identifier_properties',
   MISSING_INPUT = 'Missing_input',

package/src/util/type-conversion-utils-spec-mockData.ts

@@ -1,239 +1,244 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.mapping = {
-  typeConversion: {
-    vibe2flex: {
-      'custom-entity': {
-        getMapKey: (entity) =>{
-          const typePath = entity['typePath'];
-          let mapKey = '';
-          switch (typePath) {
-          case 'custom-entity:pack':
-            mapKey = 'packaging';
-            break;
-          case 'custom-entity:prefix':
-            mapKey = 'prefix';
-            break;
-          case 'custom-entity:catName':
-            mapKey = 'catName';
-            break;
-          case 'custom-entity:partnerOrg':
-            mapKey = 'partnerOrg';
-            break;
-          case 'custom-entity:catFamily':
-            mapKey = 'catFamily';
-            break;
-          case 'custom-entity:formName':
-            mapKey = 'formName';
-            break;
-          }
-
-          return mapKey;
-        }
-      }
-    },
-    flex2vibe: {
-      LCSLast: {
-        getMapKey: (object) =>{ return 'catName';}
-      },
-      LCSRevisableEntity : {
-        getMapKey: (object) =>{
-          const typePath = object['flexPLMTypePath'];
-          let mapKey = '';
-          switch (typePath) {
-            case 'Revisable Entity\\packaging':
-              mapKey = 'packaging';
-              break
-            case 'Revisable Entity\\prefix':
-              mapKey = 'prefix';
-              break
-          };
-          return mapKey;
-        }
-      }
-    }
-
-  },
-  LCSProduct: {
-    vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
-    vibe2flex: {
-      getClass: () => 'LCSProduct',
-      getSoftType: (entity /*, dependencies*/) =>{
-        const prodType = entity['prodType'];
-        let val = '';
-        switch (prodType) {
-        case 'acc':
-          val = 'Product\\Accesories';
-          break;
-        case 'app':
-          val = 'Product\\Apparel';
-          break;
-        case 'eqp':
-          val = 'Product\\Equipment';
-          break;
-        case 'foot':
-          val = 'Product\\Footwear';
-          break;
-        }
-
-        return val;
-      },
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }, { processor: 'VALUE_TRANSFORM', functionTransformersKey: 'valueTransform' }],
-      rekey: {
-        productName: 'name',
-        vibeIQIdentifier: 'itemNumber'
-      },
-      valueTransform: {
-        transformEx: (row/*, dependencies*/) => {
-          return row['otherProp'] + 'xxx';
-        }
-      }
-
-    },
-    flex2vibe: {
-      getClass: () => 'item',
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        itemNumber: 'vibeIQIdentifier',
-        name: 'productName',
-      }
-    }
-  },
-  LCSSKU: {
-    vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
-    vibe2flex: {
-      getClass: () => 'LCSSKU',
-      getSoftType: (entity /*, dependencies*/) =>{
-        const prodType = entity['prodType'];
-        let val = '';
-        switch (prodType) {
-        case 'acc':
-          val = 'Product\\Accesories';
-          break;
-        case 'app':
-          val = 'Product\\Apparel';
-          break;
-        case 'eqp':
-          val = 'Product\\Equipment';
-          break;
-        case 'foot':
-          val = 'Product\\Footwear';
-          break;
-        }
-
-        return val;
-      },
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        skuName: 'optionName',
-        vibeIQIdentifier: 'itemNumber'
-      }
-    },
-    flex2vibe: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        itemNumber: 'vibeIQIdentifier',
-        optionName: 'skuName',
-      }
-    }
-  },
-
-  packaging: {
-    vibe2flex: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        retailPackType: 'packType',
-        retailIntroDate: 'introDate'
-      },
-      getSoftType: () => 'Revisable Entity\\packaging',
-      getClass: () => 'LCSRevisableEntity'
-    },
-    flex2vibe: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        packType: 'retailPackType',
-        introDate: 'retailIntroDate'
-      },
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:pack',
-
-    }
-  },
-  prefix: {
-    isInboundCreatable: () => true,
-    vibe2flex: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        retailOwner: 'owner',
-        retailIntroDate: 'introDate'
-      },
-      getSoftType: () => 'Revisable Entity\\prefix',
-      getClass: () => 'LCSRevisableEntity'
-    },
-    flex2vibe: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        owner: 'retailOwner',
-        introDate: 'retailIntroDate'
-      },
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:prefix',
-
-    }
-  },
-  catName: {
-  getIdentifierProperties: () => ['catName', 'catNumber'],
-  getInformationalProperties: () => ['longName'],
-  vibe2flex: {
-      transformOrder: [],
-      getSoftType: () => 'Last\\catName',
-      getClass: () => 'LCSLast'
-    },
-    flex2vibe: {
-      transformOrder: [],
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:catName',
-
-    }
-  },
-  partnerOrg: {
-    vibe2flex: {
-      transformOrder: [],
-      getSoftType: () => 'Business Object\\partnerOrg',
-      getClass: () => 'LCSLifecycleManaged'
-    },
-    flex2vibe: {
-      transformOrder: [],
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:partnerOrg',
-
-    }
-  },
-  catFamily: {
-    vibe2flex: {
-      transformOrder: [],
-      getSoftType: () => 'Revisable Entity\\catFamily',
-      getClass: () => 'LCSRevisableEntity'
-    },
-    flex2vibe: {
-      transformOrder: [],
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:catFamily',
-
-    }
-  },
-  formName: {
-    vibe2flex: {
-      transformOrder: [],
-      getSoftType: () => 'Material\\form',
-      getClass: () => 'LCSMaterial'
-    },
-    flex2vibe: {
-      transformOrder: [],
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:formName',
-
-    }
-  },
-
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.mapping = {
+  typeConversion: {
+    vibe2flex: {
+      'custom-entity': {
+        getMapKey: (entity) =>{
+          const typePath = entity['typePath'];
+          let mapKey = '';
+          switch (typePath) {
+          case 'custom-entity:pack':
+            mapKey = 'packaging';
+            break;
+          case 'custom-entity:prefix':
+            mapKey = 'prefix';
+            break;
+          case 'custom-entity:catName':
+            mapKey = 'catName';
+            break;
+          case 'custom-entity:partnerOrg':
+            mapKey = 'partnerOrg';
+            break;
+          case 'custom-entity:catFamily':
+            mapKey = 'catFamily';
+            break;
+          case 'custom-entity:formName':
+            mapKey = 'formName';
+            break;
+          }
+
+          return mapKey;
+        }
+      }
+    },
+    flex2vibe: {
+      LCSLast: {
+        getMapKey: (object) =>{ return 'catName';}
+      },
+      LCSRevisableEntity : {
+        getMapKey: (object) =>{
+          const typePath = object['flexPLMTypePath'];
+          let mapKey = '';
+          switch (typePath) {
+            case 'Revisable Entity\\packaging':
+              mapKey = 'packaging';
+              break
+            case 'Revisable Entity\\prefix':
+              mapKey = 'prefix';
+              break
+          };
+          return mapKey;
+        }
+      }
+    }
+
+  },
+  LCSProduct: {
+    vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
+    vibe2flex: {
+      getClass: () => 'LCSProduct',
+      getSoftType: (entity /*, dependencies*/) =>{
+        const prodType = entity['prodType'];
+        let val = '';
+        switch (prodType) {
+        case 'acc':
+          val = 'Product\\Accesories';
+          break;
+        case 'app':
+          val = 'Product\\Apparel';
+          break;
+        case 'eqp':
+          val = 'Product\\Equipment';
+          break;
+        case 'foot':
+          val = 'Product\\Footwear';
+          break;
+        }
+
+        return val;
+      },
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }, { processor: 'VALUE_TRANSFORM', functionTransformersKey: 'valueTransform' }],
+      rekey: {
+        productName: 'name',
+        vibeIQIdentifier: 'itemNumber'
+      },
+      valueTransform: {
+        transformEx: (row/*, dependencies*/) => {
+          return row['otherProp'] + 'xxx';
+        }
+      }
+
+    },
+    flex2vibe: {
+      getClass: () => 'item',
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        itemNumber: 'vibeIQIdentifier',
+        name: 'productName',
+      }
+    }
+  },
+  LCSSKU: {
+    vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
+    vibe2flex: {
+      getClass: () => 'LCSSKU',
+      getSoftType: (entity /*, dependencies*/) =>{
+        const prodType = entity['prodType'];
+        let val = '';
+        switch (prodType) {
+        case 'acc':
+          val = 'Product\\Accesories';
+          break;
+        case 'app':
+          val = 'Product\\Apparel';
+          break;
+        case 'eqp':
+          val = 'Product\\Equipment';
+          break;
+        case 'foot':
+          val = 'Product\\Footwear';
+          break;
+        }
+
+        return val;
+      },
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        skuName: 'optionName',
+        vibeIQIdentifier: 'itemNumber'
+      }
+    },
+    flex2vibe: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        itemNumber: 'vibeIQIdentifier',
+        optionName: 'skuName',
+      }
+    }
+  },
+
+  packaging: {
+    vibe2flex: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        retailPackType: 'packType',
+        retailIntroDate: 'introDate'
+      },
+      getSoftType: () => 'Revisable Entity\\packaging',
+      getClass: () => 'LCSRevisableEntity'
+    },
+    flex2vibe: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        packType: 'retailPackType',
+        introDate: 'retailIntroDate'
+      },
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:pack',
+
+    }
+  },
+  prefix: {
+    isInboundCreatable: (object, context) => {
+      if (context && context.skipPrefix) {
+        return false;
+      }
+      return true;
+    },
+    vibe2flex: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        retailOwner: 'owner',
+        retailIntroDate: 'introDate'
+      },
+      getSoftType: () => 'Revisable Entity\\prefix',
+      getClass: () => 'LCSRevisableEntity'
+    },
+    flex2vibe: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        owner: 'retailOwner',
+        introDate: 'retailIntroDate'
+      },
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:prefix',
+
+    }
+  },
+  catName: {
+  getIdentifierProperties: () => ['catName', 'catNumber'],
+  getInformationalProperties: () => ['longName'],
+  vibe2flex: {
+      transformOrder: [],
+      getSoftType: () => 'Last\\catName',
+      getClass: () => 'LCSLast'
+    },
+    flex2vibe: {
+      transformOrder: [],
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:catName',
+
+    }
+  },
+  partnerOrg: {
+    vibe2flex: {
+      transformOrder: [],
+      getSoftType: () => 'Business Object\\partnerOrg',
+      getClass: () => 'LCSLifecycleManaged'
+    },
+    flex2vibe: {
+      transformOrder: [],
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:partnerOrg',
+
+    }
+  },
+  catFamily: {
+    vibe2flex: {
+      transformOrder: [],
+      getSoftType: () => 'Revisable Entity\\catFamily',
+      getClass: () => 'LCSRevisableEntity'
+    },
+    flex2vibe: {
+      transformOrder: [],
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:catFamily',
+
+    }
+  },
+  formName: {
+    vibe2flex: {
+      transformOrder: [],
+      getSoftType: () => 'Material\\form',
+      getClass: () => 'LCSMaterial'
+    },
+    flex2vibe: {
+      transformOrder: [],
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:formName',
+
+    }
+  },
+
 };

package/src/util/type-conversion-utils.spec.ts

@@ -640,5 +640,44 @@ describe('conversion-utils', () => {
       }
     });
 
+    it('should pass context to isInboundCreatable function', async () =>{
+      const spy = jest.spyOn(mapFileUtil, 'getMapFile')
+        .mockImplementation(async () =>{
+          return mapping;
+        });
+      const object = {
+        flexPLMObjectClass: 'LCSRevisableEntity',
+        flexPLMTypePath: 'Revisable Entity\\prefix'
+      }
+      const context = { skipPrefix: true };
+
+      try{
+        const results = await TypeConversionUtils.isInboundCreatableFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object, context);
+        expect(results).toBeFalsy();
+
+      } finally {
+        spy.mockRestore();
+      }
+    });
+
+    it('should work without context parameter', async () =>{
+      const spy = jest.spyOn(mapFileUtil, 'getMapFile')
+        .mockImplementation(async () =>{
+          return mapping;
+        });
+      const object = {
+        flexPLMObjectClass: 'LCSRevisableEntity',
+        flexPLMTypePath: 'Revisable Entity\\prefix'
+      }
+
+      try{
+        const results = await TypeConversionUtils.isInboundCreatableFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object);
+        expect(results).toBeTruthy();
+
+      } finally {
+        spy.mockRestore();
+      }
+    });
+
   });
 });