@contrail/flexplm 1.8.0-alpha.0261c7e → 1.8.0-alpha.562c8dd

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

@@ -939,14 +939,14 @@ describe('conversion-utils', () => {
         afterEach(() => {
             spy.mockRestore();
         });
-        it('VibeIQ -> FlexPLM uses defaults', async () => {
+        it('should use the defaults when sending a Country from VibeIQ to FlexPLM', async () => {
             const entity = { entityType: 'custom-entity', typePath: 'custom-entity:country' };
             expect(await type_conversion_utils_1.TypeConversionUtils.getObjectClass(TRANSFORM_MAP_FILE, mapFileUtil, entity)).toEqual('LCSCountry');
             expect(await type_conversion_utils_1.TypeConversionUtils.getObjectTypePath(TRANSFORM_MAP_FILE, mapFileUtil, entity)).toEqual('Country');
             expect(await type_conversion_utils_1.TypeConversionUtils.getIdentifierProperties(TRANSFORM_MAP_FILE, mapFileUtil, entity)).toEqual(['vibeIQIdentifier']);
             expect(await type_conversion_utils_1.TypeConversionUtils.getInformationalProperties(TRANSFORM_MAP_FILE, mapFileUtil, entity)).toEqual(['name']);
         });
-        it('FlexPLM -> VibeIQ uses defaults', async () => {
+        it('should use the defaults when receiving a Country from FlexPLM into VibeIQ', async () => {
             const object = { flexPLMObjectClass: 'LCSCountry', flexPLMTypePath: 'Country' };
             expect(await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toEqual('LCSCountry');
             expect(await type_conversion_utils_1.TypeConversionUtils.getEntityClassFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object)).toEqual('custom-entity');
@@ -954,7 +954,7 @@ describe('conversion-utils', () => {
             expect(await type_conversion_utils_1.TypeConversionUtils.getIdentifierPropertiesFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object)).toEqual(['vibeIQIdentifier']);
             expect(await type_conversion_utils_1.TypeConversionUtils.getInformationalPropertiesFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object)).toEqual(['name']);
         });
-        it('a mapping section still overrides the defaults', async () => {
+        it('should let a mapping section override the Country defaults', async () => {
             const overriding = {
                 typeConversion: { vibe2flex: { 'custom-entity': { getMapKey: () => 'LCSCountry' } }, flex2vibe: {} },
                 LCSCountry: { getIdentifierProperties: () => ['isoCode'] }
@@ -987,45 +987,45 @@ describe('conversion-utils', () => {
         afterEach(() => {
             spy.mockRestore();
         });
-        it("is 'flexplm' when inbound is creatable and outbound is not (both directions)", async () => {
+        it('should return flexplm when inbound is creatable and outbound is not, in both directions', async () => {
             useMap({ isInboundCreatable: () => true, isOutboundCreatable: () => false });
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryEntity, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION)).toBe('flexplm');
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryObject, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBe('flexplm');
         });
-        it("is 'vibeiq' when outbound is creatable and inbound is not (both directions)", async () => {
+        it('should return vibeiq when outbound is creatable and inbound is not, in both directions', async () => {
             useMap({ isInboundCreatable: () => false, isOutboundCreatable: () => true });
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryEntity, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION)).toBe('vibeiq');
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryObject, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBe('vibeiq');
         });
-        it('supports async mapping functions', async () => {
+        it('should support async mapping functions', async () => {
             useMap({ isInboundCreatable: async () => true, isOutboundCreatable: async () => false });
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryObject, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBe('flexplm');
         });
-        it('is undefined when both are true', async () => {
+        it('should return undefined when both gates are true', async () => {
             useMap({ isInboundCreatable: () => true, isOutboundCreatable: () => true });
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryObject, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBeUndefined();
         });
-        it('is undefined when both are false', async () => {
+        it('should return undefined when both gates are false', async () => {
             useMap({ isInboundCreatable: () => false, isOutboundCreatable: () => false });
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryEntity, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION)).toBeUndefined();
         });
-        it('is undefined when either function is missing (no defaults)', async () => {
+        it('should return undefined when either gate function is missing', async () => {
             useMap({ isInboundCreatable: () => true });
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryObject, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBeUndefined();
             useMap({ isOutboundCreatable: () => true });
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryEntity, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION)).toBeUndefined();
         });
-        it('is undefined when there is no LCSCountry section', async () => {
+        it('should return undefined when there is no LCSCountry section', async () => {
             useMap();
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryEntity, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION)).toBeUndefined();
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryObject, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBeUndefined();
         });
-        it('is undefined when there is no mapping file id or no entity', async () => {
+        it('should return undefined when there is no mapping file id or no entity', async () => {
             useMap({ isInboundCreatable: () => true, isOutboundCreatable: () => false });
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem('', mapFileUtil, countryObject, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBeUndefined();
             expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, undefined, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBeUndefined();
         });
-        it('is undefined (and logs) when a mapping function throws', async () => {
+        it('should return undefined and log when a mapping function throws', async () => {
             useMap({ isInboundCreatable: () => { throw new Error('boom'); }, isOutboundCreatable: () => false });
             const errorSpy = jest.spyOn(console, 'error').mockImplementation(() => undefined);
             try {
@@ -1036,12 +1036,12 @@ describe('conversion-utils', () => {
                 errorSpy.mockRestore();
             }
         });
-        it('does not change the creatable defaults of other types', async () => {
+        it('should not change the section key of other custom entity subtypes', async () => {
             useMap({ isInboundCreatable: () => true, isOutboundCreatable: () => false });
             const other = { entityType: 'custom-entity', typePath: 'custom-entity:exchangeRate' };
             expect(await type_conversion_utils_1.TypeConversionUtils.getMapKey(TRANSFORM_MAP_FILE, mapFileUtil, other, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION)).toEqual('');
         });
-        it('finds the Country section even when the org custom-entity routing returns an empty key', async () => {
+        it('should return the LCSCountry section key when the org custom entity routing returns an empty key', async () => {
             useMap({ isInboundCreatable: () => true, isOutboundCreatable: () => false });
             expect(await type_conversion_utils_1.TypeConversionUtils.getMapKey(TRANSFORM_MAP_FILE, mapFileUtil, countryEntity, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION)).toEqual('LCSCountry');
         });

package/lib/util/type-defaults.spec.js

@@ -42,7 +42,7 @@ describe('Type Defaults', () => {
             const objectClass = type_defaults_1.TypeDefaults.getDefaultObjectClass(newData);
             expect(objectClass).toEqual('LCSColor');
         });
-        it('LCSCountry', () => {
+        it('should return LCSCountry for a Country custom entity', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:country'
@@ -50,14 +50,14 @@ describe('Type Defaults', () => {
             const objectClass = type_defaults_1.TypeDefaults.getDefaultObjectClass(newData);
             expect(objectClass).toEqual('LCSCountry');
         });
-        it('LCSCountry - typePath is case-insensitive', () => {
+        it('should return LCSCountry when the Country typePath uses different casing', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:Country'
             };
             expect(type_defaults_1.TypeDefaults.getDefaultObjectClass(newData)).toEqual('LCSCountry');
         });
-        it('other custom-entity subtype is still LCSRevisableEntity', () => {
+        it('should return LCSRevisableEntity for a custom entity that is not a Country', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:exchangeRate'
@@ -142,14 +142,14 @@ describe('Type Defaults', () => {
             const typePath = type_defaults_1.TypeDefaults.getDefaultObjectTypePath(newData);
             expect(typePath).toEqual('Color');
         });
-        it('custom-entity - country', () => {
+        it('should return Country as the FlexPLM type path for a Country custom entity', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:country'
             };
             expect(type_defaults_1.TypeDefaults.getDefaultObjectTypePath(newData)).toEqual('Country');
         });
-        it('custom-entity - other subtype stays Revisable Entity', () => {
+        it('should return Revisable Entity as the type path for a custom entity that is not a Country', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:exchangeRate'
@@ -255,7 +255,7 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-        it('custom-entity - country', () => {
+        it('should return vibeIQIdentifier as the identifier for a Country custom entity', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:country'
@@ -263,7 +263,7 @@ describe('Type Defaults', () => {
             const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultIdentifierProperties(newData);
             expect(defaultIdentifiers).toEqual(['vibeIQIdentifier']);
         });
-        it('custom-entity - other subtype stays name', () => {
+        it('should return name as the identifier for a custom entity that is not a Country', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:exchangeRate'
@@ -321,14 +321,14 @@ describe('Type Defaults', () => {
             const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultInformationalProperties(newData);
             expect(defaultIdentifiers).toHaveLength(0);
         });
-        it('custom-entity - country', () => {
+        it('should return name as the informational property for a Country custom entity', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:country'
             };
             expect(type_defaults_1.TypeDefaults.getDefaultInformationalProperties(newData)).toEqual(['name']);
         });
-        it('custom-entity - other subtype has none', () => {
+        it('should return no informational properties for a custom entity that is not a Country', () => {
             const newData = {
                 entityType: 'custom-entity',
                 typePath: 'custom-entity:exchangeRate'
@@ -344,10 +344,10 @@ describe('Type Defaults', () => {
         });
     });
     describe('isCountryEntity', () => {
-        it('true for custom-entity:country', () => {
+        it('should return true for the custom-entity:country type path', () => {
             expect(type_defaults_1.TypeDefaults.isCountryEntity({ typePath: 'custom-entity:country' })).toBe(true);
         });
-        it('false for another subtype, a missing typePath, or undefined', () => {
+        it('should return false for another subtype, a missing typePath, or an undefined entity', () => {
             expect(type_defaults_1.TypeDefaults.isCountryEntity({ typePath: 'custom-entity:other' })).toBe(false);
             expect(type_defaults_1.TypeDefaults.isCountryEntity({})).toBe(false);
             expect(type_defaults_1.TypeDefaults.isCountryEntity(undefined)).toBe(false);
@@ -430,13 +430,13 @@ describe('Type Defaults', () => {
             const entityClass = type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
             expect(entityClass).toBe('assortment');
         });
-        it('custom-entity - LCSCountry', () => {
+        it('should return custom-entity as the entity class for LCSCountry', () => {
             const object = {
                 flexPLMObjectClass: 'LCSCountry'
             };
             expect(type_defaults_1.TypeDefaults.getDefaultEntityClass(object)).toBe('custom-entity');
         });
-        it('custom-entity - LCSCountry - processAsItem=true', () => {
+        it('should return custom-entity for LCSCountry when LCSMaterial processAsItem is true', () => {
             const object = {
                 flexPLMObjectClass: 'LCSCountry'
             };
@@ -512,7 +512,7 @@ describe('Type Defaults', () => {
             const typePath = type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object);
             expect(typePath).toBe('project-item');
         });
-        it('LCSCountry', () => {
+        it('should return custom-entity:country as the VibeIQ type path for LCSCountry', () => {
             const object = {
                 flexPLMObjectClass: 'LCSCountry'
             };
@@ -600,7 +600,7 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-        it('LCSCountry', () => {
+        it('should return vibeIQIdentifier as the identifier for an LCSCountry object', () => {
             const object = {
                 flexPLMObjectClass: 'LCSCountry'
             };
@@ -646,7 +646,7 @@ describe('Type Defaults', () => {
         });
     }); //getDefaultIdentifierPropertiesFromObject
     describe('getDefaultInformationalPropertiesFromObject', () => {
-        it('LCSCountry', () => {
+        it('should return name as the informational property for an LCSCountry object', () => {
             const object = {
                 flexPLMObjectClass: 'LCSCountry'
             };

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

@@ -47,6 +47,31 @@ describe('TypeUtils.getEventObjectClass() tests', () => {
         const objectClass = tu.getEventObjectClass(entityType, newData);
         expect(objectClass).toEqual('LCSRevisableEntity');
     });
+    it('should return LCSCountry for a custom entity with the custom-entity:country typePath', () => {
+        const entityType = 'custom-entity';
+        const newData = { typePath: 'custom-entity:country' };
+        const objectClass = tu.getEventObjectClass(entityType, newData);
+        expect(objectClass).toEqual('LCSCountry');
+    });
+    it('should return LCSCountry when the Country typePath uses different casing', () => {
+        const objectClass = tu.getEventObjectClass('custom-entity', { typePath: 'custom-entity:Country' });
+        expect(objectClass).toEqual('LCSCountry');
+    });
+    it('should return LCSRevisableEntity for a custom entity that is not a Country', () => {
+        const objectClass = tu.getEventObjectClass('custom-entity', { typePath: 'custom-entity:exchangeRate' });
+        expect(objectClass).toEqual('LCSRevisableEntity');
+    });
+});
+describe('TypeUtils.getEntityTypeClientOptions() tests', () => {
+    const tu = new type_utils_1.TypeUtils();
+    it('should resolve LCSCountry to the custom-entity root type', () => {
+        const options = tu.getEntityTypeClientOptions('LCSCountry', {});
+        expect(options).toEqual({ root: 'custom-entity' });
+    });
+    it('should keep resolving LCSRevisableEntity to the custom-entity root type', () => {
+        const options = tu.getEntityTypeClientOptions('LCSRevisableEntity', {});
+        expect(options).toEqual({ root: 'custom-entity' });
+    });
 });
 describe('filterProperties-item', () => {
     const itemType = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.8.0-alpha.0261c7e",
+  "version": "1.8.0-alpha.562c8dd",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",