@contrail/flexplm 1.7.8 → 1.8.0-alpha.4767312

package/README.md

@@ -1 +1,14 @@
-Core model for contrail, which establishes the base peristence services (without dependency on a persistence implementaiton) and core NestJS elements such as the InvocationContext.
+Core model for contrail, which establishes the base peristence services (without dependency on a persistence implementaiton) and core NestJS elements such as the InvocationContext.
+
+## LCSCountry defaults
+`LCSCountry` <-> VibeIQ `custom-entity:country` works with built-in defaults for the type mapping. The built-in conventions are:
+
+| Item | Default |
+|---|---|
+| VibeIQ type path | `custom-entity:country` (exact, lowercase; matched case-sensitively in both directions) |
+| FlexPLM class / type path | `LCSCountry` / `Country` |
+| Identifier property | `vibeIQIdentifier` (same key in both systems; no rekey runs without a mapping) |
+| Informational property | `name` |
+
+A mapping section for `LCSCountry` overrides these defaults when selected by the type-conversion routing. If your mapping defines `typeConversion.vibe2flex['custom-entity'].getMapKey`, make it return `'LCSCountry'` for Country entities to apply that section's outbound overrides; an empty key bypasses the section.
+

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

@@ -362,6 +362,10 @@ export interface MappingSection {
      * }
      *
      * @example
+     * // FlexPLM creates Countries (VibeIQ creates them by default).
+     * LCSCountry: { isInboundCreatable: () => true }
+     *
+     * @example
      * // add-to-project flow — Flex drives project-item creation.
      * // Paired with isOutboundCreatable: () => false to make
      * // outbound update-only.
@@ -707,6 +711,7 @@ interface MappingFileBase {
  * | `item`               | `LCSProduct` / `LCSSKU`          | Syncs once `lifecycleStage` is out of `concept`. Sends Primary Viewable as the thumbnail (no other images). Creates `LCSProduct` / `LCSSKU` if missing; auto-retries `LCSSKU` creation when the parent `LCSProduct` isn't ready yet. |
  * | `color`              | `LCSColor`                       | Syncs on create / update. Sends Primary Viewable as the thumbnail. Creates `LCSColor` if missing.          |
  * | `custom-entity`      | `LCSRevisableEntity`             | Syncs on create / update. Creates `LCSRevisableEntity` if missing. Workflows should gate on the custom-entity subtype so only the intended subtypes publish. |
+ * | `custom-entity` (`custom-entity:country`) | `LCSCountry` | Built-in defaults for type path (`Country`), identifier (`vibeIQIdentifier`, same key in both systems) and name; the mapping section overrides each default. Syncs on create / update. Creates `LCSCountry` if missing. Workflows should gate on the custom-entity subtype so only the intended subtypes publish. |
  * | `project-item`       | `LCSProductSeasonLink` / `LCSSKUSeasonLink` | Syncs on plan publish. Requires the assortment to have `publishToFlexPLM=true` and `flexPLMSeasonName` set. Adds the Product / SKU to the `LCSSeason` if not already linked. Only project-items changed since the last publish are sent (configurable to reach further back). Processing on the FlexPLM side is async via a Windchill Queue. |
  * | `item:material`      | `LCSMaterial`                    | Supported via custom mapping section + `typeConversion`. Route `item:material` typePath to a mapping section that declares `getClass: () => 'LCSMaterial'` and `getSoftType: () => 'Material'`. See {@link TypeConversion} for the `LCSMaterial.processAsItem` config flag that pairs with this. |
  * | `custom-entity`      | `LCSLast` / `LCSLifecycleManaged` | **Not yet supported.**                                                                                     |
@@ -724,6 +729,7 @@ interface MappingFileBase {
  * | `LCSLifecycleManaged`   | `custom-entity`            | Configurable to create new custom-entities; updates existing.                                              |
  * | `LCSMaterial`           | `custom-entity` (default) or `item:material` | Default: custom-entity. To route to `item:material` instead, set `{ "LCSMaterial": { "processAsItem": true } }` in the connector app config and write a mapping section with `getClass: () => 'item'` + `getSoftType: () => 'item:material'`. Wire it via `flex2vibe.LCSMaterial.getMapKey` returning that section's name. |
  * | `LCSRevisableEntity`    | `custom-entity`            | Configurable to create new custom-entities; updates existing.                                              |
+ * | `LCSCountry`            | `custom-entity` (`custom-entity:country`) | Built-in defaults for type path and identifier (`vibeIQIdentifier`, same key in both systems). Updates existing Countries; configurable to create new ones with `isInboundCreatable` (for example `LCSCountry: { isInboundCreatable: () => true }`). |
  * | (any)                   | `item` (direct, no link)   | **Not yet supported.**                                                                                     |
  *
  * @example

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

@@ -924,4 +924,61 @@ describe('conversion-utils', () => {
             expect(results).toBeTruthy();
         });
     });
+    describe('Country with no mapping section (SDK defaults)', () => {
+        const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
+        const mapWithoutCountry = {
+            typeConversion: {
+                vibe2flex: { 'custom-entity': { getMapKey: () => '' } },
+                flex2vibe: {}
+            }
+        };
+        let spy;
+        beforeEach(() => {
+            spy = jest.spyOn(mapFileUtil, 'getMapFile').mockImplementation(async () => mapWithoutCountry);
+        });
+        afterEach(() => {
+            spy.mockRestore();
+        });
+        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('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');
+            expect(await type_conversion_utils_1.TypeConversionUtils.getEntityTypePathFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object)).toEqual('custom-entity:country');
+            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('should let a mapping section override the Country defaults', async () => {
+            const overriding = {
+                typeConversion: { vibe2flex: { 'custom-entity': { getMapKey: () => 'LCSCountry' } }, flex2vibe: {} },
+                LCSCountry: { getIdentifierProperties: () => ['isoCode'] }
+            };
+            spy.mockImplementation(async () => overriding);
+            const entity = { entityType: 'custom-entity', typePath: 'custom-entity:country' };
+            expect(await type_conversion_utils_1.TypeConversionUtils.getIdentifierProperties(TRANSFORM_MAP_FILE, mapFileUtil, entity)).toEqual(['isoCode']);
+        });
+        it('should leave the section key of a Country unchanged when the org custom entity routing returns an empty key', async () => {
+            const country = { entityType: 'custom-entity', typePath: 'custom-entity:country' };
+            expect(await type_conversion_utils_1.TypeConversionUtils.getMapKey(TRANSFORM_MAP_FILE, mapFileUtil, country, type_conversion_utils_1.TypeConversionUtils.VIBE2FLEX_DIRECTION)).toEqual('');
+        });
+        it('should not allow inbound creation of a Country when the mapping has no isInboundCreatable gate', async () => {
+            const object = { flexPLMObjectClass: 'LCSCountry', flexPLMTypePath: 'Country' };
+            expect(await type_conversion_utils_1.TypeConversionUtils.isInboundCreatableFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object)).toBe(false);
+        });
+        it('should allow inbound creation of a Country when the LCSCountry section sets isInboundCreatable', async () => {
+            spy.mockImplementation(async () => ({ ...mapWithoutCountry, LCSCountry: { isInboundCreatable: () => true } }));
+            const object = { flexPLMObjectClass: 'LCSCountry', flexPLMTypePath: 'Country' };
+            expect(await type_conversion_utils_1.TypeConversionUtils.isInboundCreatableFromObject(TRANSFORM_MAP_FILE, mapFileUtil, object)).toBe(true);
+        });
+        it('should allow outbound creation of a Country by default', async () => {
+            const entity = { entityType: 'custom-entity', typePath: 'custom-entity:country' };
+            expect(await type_conversion_utils_1.TypeConversionUtils.isOutboundCreatableFromEntity(TRANSFORM_MAP_FILE, mapFileUtil, entity)).toBe(true);
+        });
+    });
 });

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

@@ -3,6 +3,11 @@ export declare class TypeDefaults {
     static NO_OBJECT_CLASS: string;
     static NO_TYPE_PATH: string;
     static processLCSMaterialAsItem: boolean;
+    static COUNTRY_OBJECT_CLASS: string;
+    static COUNTRY_VIBE_TYPE_PATH: string;
+    static COUNTRY_FLEX_TYPE_PATH: string;
+    static COUNTRY_IDENTIFIER_PROPERTY: string;
+    static COUNTRY_INFORMATIONAL_PROPERTY: string;
     constructor();
     /** Applies values from the resolved config to TypeDefaults static state.
      *  Currently toggles whether LCSMaterial is treated as an item (new) or a
@@ -14,6 +19,13 @@ export declare class TypeDefaults {
      */
     static applyConfig(config: any): void;
     static isPropertyTrue(value: any): boolean;
+    /** True when the VibeIQ entity is a Country: a custom-entity whose typePath is
+     *  exactly 'custom-entity:country' (compared case-sensitively, as on inbound).
+     *
+     * @param entity VibeIQ entity
+     * @returns boolean
+     */
+    static isCountryEntity(entity: any): boolean;
     /**Takes in full entity and returs the default FlexPLM
      * object class.
      *

package/lib/util/type-defaults.js

@@ -18,6 +18,16 @@ class TypeDefaults {
     static isPropertyTrue(value) {
         return value === true || (typeof value === 'string' && value.toLowerCase() === 'true');
     }
+    /** True when the VibeIQ entity is a Country: a custom-entity whose typePath is
+     *  exactly 'custom-entity:country' (compared case-sensitively, as on inbound).
+     *
+     * @param entity VibeIQ entity
+     * @returns boolean
+     */
+    static isCountryEntity(entity) {
+        const typePath = entity?.['typePath'];
+        return typeof typePath === 'string' && typePath === TypeDefaults.COUNTRY_VIBE_TYPE_PATH;
+    }
     /**Takes in full entity and returs the default FlexPLM
      * object class.
      *
@@ -47,7 +57,7 @@ class TypeDefaults {
             objectClass = 'LCSColor';
         }
         else if ('custom-entity' === entityType) {
-            objectClass = 'LCSRevisableEntity';
+            objectClass = TypeDefaults.isCountryEntity(entity) ? TypeDefaults.COUNTRY_OBJECT_CLASS : 'LCSRevisableEntity';
         }
         else if ('project' === entityType) {
             objectClass = 'LCSSeason';
@@ -80,7 +90,7 @@ class TypeDefaults {
                 typePath = 'Color';
                 break;
             case 'custom-entity':
-                typePath = 'Revisable Entity';
+                typePath = TypeDefaults.isCountryEntity(entity) ? TypeDefaults.COUNTRY_FLEX_TYPE_PATH : 'Revisable Entity';
                 break;
             case 'project':
                 typePath = 'Season';
@@ -122,9 +132,11 @@ class TypeDefaults {
                 }
                 break;
             case 'color':
-            case 'custom-entity':
                 identifierProps.push('name');
                 break;
+            case 'custom-entity':
+                identifierProps.push(TypeDefaults.isCountryEntity(entity) ? TypeDefaults.COUNTRY_IDENTIFIER_PROPERTY : 'name');
+                break;
         }
         return identifierProps;
     }
@@ -149,6 +161,9 @@ class TypeDefaults {
         else if (['project', 'assortment'].includes(entityType)) {
             properties.push('name');
         }
+        else if (TypeDefaults.isCountryEntity(entity)) {
+            properties.push(TypeDefaults.COUNTRY_INFORMATIONAL_PROPERTY);
+        }
         return properties;
     }
     /** Returns the VibeIQ entity type from an entity.
@@ -186,8 +201,8 @@ class TypeDefaults {
             ? ['LCSProduct', 'LCSSKU', 'LCSMaterial']
             : ['LCSProduct', 'LCSSKU'];
         const customEntityClasses = TypeDefaults.processLCSMaterialAsItem
-            ? ['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast']
-            : ['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast', 'LCSMaterial'];
+            ? ['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast', TypeDefaults.COUNTRY_OBJECT_CLASS]
+            : ['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast', 'LCSMaterial', TypeDefaults.COUNTRY_OBJECT_CLASS];
         if (itemClasses.includes(objectClass)) {
             entityClass = 'item';
         }
@@ -237,6 +252,9 @@ class TypeDefaults {
             case 'SeasonGroup':
                 typePath = 'assortment';
                 break;
+            case 'LCSCountry':
+                typePath = TypeDefaults.COUNTRY_VIBE_TYPE_PATH;
+                break;
         }
         if (typePath === '')
             throw Error(TypeDefaults.NO_TYPE_PATH);
@@ -271,6 +289,9 @@ class TypeDefaults {
             case 'SeasonGroup':
                 identifierProps.push('seasonGroupName');
                 break;
+            case 'LCSCountry':
+                identifierProps.push(TypeDefaults.COUNTRY_IDENTIFIER_PROPERTY);
+                break;
             case 'LCSColor':
             case 'LCSRevisableEntity':
             case 'LCSLifecycleManaged':
@@ -302,6 +323,9 @@ class TypeDefaults {
         else if (['LCSSeason', 'SeasonGroup'].includes(objectClass)) {
             properties.push('name');
         }
+        else if (TypeDefaults.COUNTRY_OBJECT_CLASS === objectClass) {
+            properties.push(TypeDefaults.COUNTRY_INFORMATIONAL_PROPERTY);
+        }
         return properties;
     }
     static getObjectClass(object) {
@@ -313,3 +337,8 @@ TypeDefaults.NO_ENTITY_TYPE = 'Not able to determine the entity type of the enti
 TypeDefaults.NO_OBJECT_CLASS = 'Please ensure that the flexPLMObjectClass property is provided.';
 TypeDefaults.NO_TYPE_PATH = 'Please ensure that the flexPLMTypePath property is provided.';
 TypeDefaults.processLCSMaterialAsItem = false;
+TypeDefaults.COUNTRY_OBJECT_CLASS = 'LCSCountry';
+TypeDefaults.COUNTRY_VIBE_TYPE_PATH = 'custom-entity:country';
+TypeDefaults.COUNTRY_FLEX_TYPE_PATH = 'Country';
+TypeDefaults.COUNTRY_IDENTIFIER_PROPERTY = 'vibeIQIdentifier';
+TypeDefaults.COUNTRY_INFORMATIONAL_PROPERTY = 'name';

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

@@ -42,6 +42,28 @@ describe('Type Defaults', () => {
             const objectClass = type_defaults_1.TypeDefaults.getDefaultObjectClass(newData);
             expect(objectClass).toEqual('LCSColor');
         });
+        it('should return LCSCountry for a Country custom entity', () => {
+            const newData = {
+                entityType: 'custom-entity',
+                typePath: 'custom-entity:country'
+            };
+            const objectClass = type_defaults_1.TypeDefaults.getDefaultObjectClass(newData);
+            expect(objectClass).toEqual('LCSCountry');
+        });
+        it('should return LCSRevisableEntity when the Country typePath uses different casing', () => {
+            const newData = {
+                entityType: 'custom-entity',
+                typePath: 'custom-entity:Country'
+            };
+            expect(type_defaults_1.TypeDefaults.getDefaultObjectClass(newData)).toEqual('LCSRevisableEntity');
+        });
+        it('should return LCSRevisableEntity for a custom entity that is not a Country', () => {
+            const newData = {
+                entityType: 'custom-entity',
+                typePath: 'custom-entity:exchangeRate'
+            };
+            expect(type_defaults_1.TypeDefaults.getDefaultObjectClass(newData)).toEqual('LCSRevisableEntity');
+        });
         it('LCSRevisableEntity', () => {
             const newData = {
                 entityType: 'custom-entity'
@@ -120,6 +142,20 @@ describe('Type Defaults', () => {
             const typePath = type_defaults_1.TypeDefaults.getDefaultObjectTypePath(newData);
             expect(typePath).toEqual('Color');
         });
+        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('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'
+            };
+            expect(type_defaults_1.TypeDefaults.getDefaultObjectTypePath(newData)).toEqual('Revisable Entity');
+        });
         it('custom-entity', () => {
             const newData = {
                 entityType: 'custom-entity'
@@ -219,6 +255,21 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
+        it('should return vibeIQIdentifier as the identifier for a Country custom entity', () => {
+            const newData = {
+                entityType: 'custom-entity',
+                typePath: 'custom-entity:country'
+            };
+            const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultIdentifierProperties(newData);
+            expect(defaultIdentifiers).toEqual(['vibeIQIdentifier']);
+        });
+        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'
+            };
+            expect(type_defaults_1.TypeDefaults.getDefaultIdentifierProperties(newData)).toEqual(['name']);
+        });
         it('custom-entity', () => {
             const newData = {
                 entityType: 'custom-entity'
@@ -270,6 +321,20 @@ describe('Type Defaults', () => {
             const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultInformationalProperties(newData);
             expect(defaultIdentifiers).toHaveLength(0);
         });
+        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('should return no informational properties for a custom entity that is not a Country', () => {
+            const newData = {
+                entityType: 'custom-entity',
+                typePath: 'custom-entity:exchangeRate'
+            };
+            expect(type_defaults_1.TypeDefaults.getDefaultInformationalProperties(newData)).toEqual([]);
+        });
         it('custom-entity', () => {
             const newData = {
                 entityType: 'custom-entity'
@@ -278,6 +343,19 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toHaveLength(0);
         });
     });
+    describe('isCountryEntity', () => {
+        it('should return true for the custom-entity:country type path', () => {
+            expect(type_defaults_1.TypeDefaults.isCountryEntity({ typePath: 'custom-entity:country' })).toBe(true);
+        });
+        it('should return false when the typePath differs only in casing', () => {
+            expect(type_defaults_1.TypeDefaults.isCountryEntity({ typePath: 'custom-entity:Country' })).toBe(false);
+        });
+        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);
+        });
+    });
     describe('getEntityType', () => {
         it('entityType', () => {
             const entityType = 'item';
@@ -355,6 +433,24 @@ describe('Type Defaults', () => {
             const entityClass = type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
             expect(entityClass).toBe('assortment');
         });
+        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('should return custom-entity for LCSCountry when LCSMaterial processAsItem is true', () => {
+            const object = {
+                flexPLMObjectClass: 'LCSCountry'
+            };
+            type_defaults_1.TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: true } });
+            try {
+                expect(type_defaults_1.TypeDefaults.getDefaultEntityClass(object)).toBe('custom-entity');
+            }
+            finally {
+                type_defaults_1.TypeDefaults.applyConfig({});
+            }
+        });
         it('custom-entity - LCSRevisableEntity', () => {
             const object = {
                 flexPLMObjectClass: 'LCSRevisableEntity'
@@ -419,6 +515,12 @@ describe('Type Defaults', () => {
             const typePath = type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object);
             expect(typePath).toBe('project-item');
         });
+        it('should return custom-entity:country as the VibeIQ type path for LCSCountry', () => {
+            const object = {
+                flexPLMObjectClass: 'LCSCountry'
+            };
+            expect(type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object)).toBe('custom-entity:country');
+        });
         it('LCSColor', () => {
             const object = {
                 flexPLMObjectClass: 'LCSColor'
@@ -501,6 +603,12 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
+        it('should return vibeIQIdentifier as the identifier for an LCSCountry object', () => {
+            const object = {
+                flexPLMObjectClass: 'LCSCountry'
+            };
+            expect(type_defaults_1.TypeDefaults.getDefaultIdentifierPropertiesFromObject(object)).toEqual(['vibeIQIdentifier']);
+        });
         it('LCSRevisableEntity', () => {
             const object = {
                 flexPLMObjectClass: 'LCSRevisableEntity'
@@ -541,6 +649,12 @@ describe('Type Defaults', () => {
         });
     }); //getDefaultIdentifierPropertiesFromObject
     describe('getDefaultInformationalPropertiesFromObject', () => {
+        it('should return name as the informational property for an LCSCountry object', () => {
+            const object = {
+                flexPLMObjectClass: 'LCSCountry'
+            };
+            expect(type_defaults_1.TypeDefaults.getDefaultInformationalPropertiesFromObject(object)).toEqual(['name']);
+        });
         it('LCSProduct', () => {
             const object = {
                 flexPLMObjectClass: 'LCSProduct'

package/lib/util/type-utils.js

@@ -4,6 +4,7 @@ exports.TypeUtils = void 0;
 const app_framework_1 = require("@contrail/app-framework");
 const sdk_1 = require("@contrail/sdk");
 const type_conversion_utils_1 = require("./type-conversion-utils");
+const type_defaults_1 = require("./type-defaults");
 class TypeUtils {
     constructor() {
         this.typesObj = new sdk_1.Types();
@@ -14,6 +15,11 @@ class TypeUtils {
             id,
             relations: ['typeProperties', 'typeInterfaces']
         });
+        // The API answers 200 with an empty body for a missing/deleted type, which the SDK returns as null.
+        if (!type) {
+            throw new Error('getTypeById: type not found for typeId: ' + id
+                + '. The entity references a type that no longer exists.');
+        }
         return type;
     }
     async getByRootAndPath(options) {
@@ -52,7 +58,7 @@ class TypeUtils {
             objectClass = 'LCSColor';
         }
         else if ('custom-entity' === entityType) {
-            objectClass = 'LCSRevisableEntity';
+            objectClass = type_defaults_1.TypeDefaults.isCountryEntity(newData) ? type_defaults_1.TypeDefaults.COUNTRY_OBJECT_CLASS : 'LCSRevisableEntity';
         }
         return objectClass;
     }
@@ -89,7 +95,7 @@ class TypeUtils {
                 root: 'color'
             };
         }
-        else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
+        else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast', type_defaults_1.TypeDefaults.COUNTRY_OBJECT_CLASS].includes(objectClass)) {
             //TODO need to write logic using mapping file
             tco = {
                 root: 'custom-entity'

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 LCSRevisableEntity when the Country typePath uses different casing', () => {
+        const objectClass = tu.getEventObjectClass('custom-entity', { typePath: 'custom-entity:Country' });
+        expect(objectClass).toEqual('LCSRevisableEntity');
+    });
+    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 = {
@@ -190,3 +215,16 @@ describe('filterProperties-color', () => {
         expect(filteredProps.length).toEqual(len);
     });
 });
+describe('TypeUtils.getTypeById() tests', () => {
+    it('should throw an error containing the missing type id when the type does not exist', async () => {
+        const typeUtils = new type_utils_1.TypeUtils();
+        typeUtils['typesObj'] = { getType: jest.fn().mockResolvedValue(null) };
+        await expect(typeUtils.getTypeById('missingTypeId')).rejects.toThrow('type not found for typeId: missingTypeId');
+    });
+    it('should return the same type object when the type exists', async () => {
+        const typeUtils = new type_utils_1.TypeUtils();
+        const type = { id: 'typeId', typeProperties: [] };
+        typeUtils['typesObj'] = { getType: jest.fn().mockResolvedValue(type) };
+        expect(await typeUtils.getTypeById('typeId')).toBe(type);
+    });
+});

package/package.json

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