@contrail/flexplm 1.7.8 → 1.8.0-alpha.562c8dd

package/README.md

@@ -1 +1,19 @@
-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` (case-insensitive) |
+| 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 any of these. The mapping section must also declare which system creates Countries, with the existing creation gates (there is no default; if it is not declared, the app treats Country as read-only):
+
+```ts
+LCSCountry: { isInboundCreatable: () => true,  isOutboundCreatable: () => false }, // FlexPLM creates
+LCSCountry: { isInboundCreatable: () => false, isOutboundCreatable: () => true  }, // VibeIQ creates
+```
+Read the declared origin with `TypeConversionUtils.getOriginSystem(...)`.

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

@@ -340,6 +340,13 @@ export interface MappingSection {
      *    update existing entities.
      *  - Conditional — inspect the row and allow / disallow per record.
      *
+     * On the **`LCSCountry`** section this pair declares which system creates
+     * Countries: `isInboundCreatable: () => true` together with
+     * `isOutboundCreatable: () => false` means FlexPLM creates them (the
+     * reverse pair means VibeIQ creates them). Both functions must be present
+     * and opposite; otherwise the origin is undeclared and the connector treats
+     * Country as read-only. See `TypeConversionUtils.getOriginSystem`.
+     *
      * On the **season-link** sections (`LCSProductSeasonLink` /
      * `LCSSKUSeasonLink`), `() => true` enables the add-to-project
      * flow: FlexPLM-driven inbound events can add an item to a Vibe
@@ -707,6 +714,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 and **must** declare the origin. Which system creates Countries is declared in the `LCSCountry` mapping section with the `isInboundCreatable` / `isOutboundCreatable` pair: `(true, false)` = FlexPLM creates, `(false, true)` = VibeIQ creates; anything else is undeclared. See `TypeConversionUtils.getOriginSystem`. |
  * | `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 +732,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; the mapping section must declare the origin. Identifier `vibeIQIdentifier` (same key in both systems). Creation is allowed only when the `LCSCountry` section declares FlexPLM as the origin: `isInboundCreatable: () => true` and `isOutboundCreatable: () => false`. |
  * | (any)                   | `item` (direct, no link)   | **Not yet supported.**                                                                                     |
  *
  * @example

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

@@ -1,4 +1,6 @@
 import { MapFileUtil } from '@contrail/transform-data';
+/** The system that originates (creates) an entity type: 'flexplm' or 'vibeiq'. */
+export type OriginSystem = 'flexplm' | 'vibeiq';
 /** This class is helper functions to get the data for converting
  * VibeIQ entities to / from FlexPLM Objects
 */
@@ -147,6 +149,23 @@ export declare class TypeConversionUtils {
     static getMapKeyFromObject(fileId: any, mapFileUtil: MapFileUtil, object: any, direction: string): Promise<string | undefined>;
     static isInboundCreatableFromObject(fileId: string, mapFileUtil: MapFileUtil, object: any, context?: any): Promise<boolean>;
     static isOutboundCreatableFromEntity(fileId: string, mapFileUtil: MapFileUtil, entity: any, context?: any): Promise<boolean>;
+    /** Returns which system originates (creates) an entity type, declared in its mapping section
+     * with the isInboundCreatable / isOutboundCreatable pair:
+     *  - isInboundCreatable true  and isOutboundCreatable false -> 'flexplm' (FlexPLM creates)
+     *  - isInboundCreatable false and isOutboundCreatable true  -> 'vibeiq'  (VibeIQ creates)
+     * Anything else is undeclared and returns undefined: no mapping file, no section, either function
+     * missing, both true, both false, or an error while resolving. Unlike isInboundCreatableFromObject /
+     * isOutboundCreatableFromEntity, there are NO defaults: the origin must be stated explicitly,
+     * so callers can fail safe (treat the entity as read-only) when it is not.
+     *
+     * @param fileId id for mapFile
+     * @param mapFileUtil class to get mapfile
+     * @param entityOrObject VibeIQ entity (vibe2flex) or FlexPLM object (flex2vibe)
+     * @param direction VIBE2FLEX_DIRECTION or FLEX2VIBE_DIRECTION; selects how the map section key is resolved
+     * @param context optional context object passed to the mapping functions
+     * @returns Promise<'flexplm' | 'vibeiq' | undefined>
+     */
+    static getOriginSystem(fileId: string, mapFileUtil: MapFileUtil, entityOrObject: any, direction: string, context?: any): Promise<OriginSystem | undefined>;
     /** Takes in a FlexPLM object and determines whether inbound
      * images should be synced. In most cases, the creation owning system
      * will also control image syncing. Defaults to false if no mapping exists.

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

@@ -143,6 +143,11 @@ class TypeConversionUtils {
             const mappingData = await mapFileUtil.getMappingSection(transformMapFile, 'typeConversion', direction);
             if (mappingData && mappingData[type] && mappingData[type]['getMapKey']) {
                 const mapKey = await mappingData[type]['getMapKey'](entity);
+                // An org's custom-entity routing usually returns '' for the subtypes it does not list.
+                // Country has a built-in section key, so its section is found without a typeConversion entry.
+                if (!mapKey && type_defaults_1.TypeDefaults.isCountryEntity(entity)) {
+                    return type_defaults_1.TypeDefaults.COUNTRY_OBJECT_CLASS;
+                }
                 return mapKey;
             }
         }
@@ -360,6 +365,51 @@ class TypeConversionUtils {
         }
         return isOutboundCreatable;
     }
+    /** Returns which system originates (creates) an entity type, declared in its mapping section
+     * with the isInboundCreatable / isOutboundCreatable pair:
+     *  - isInboundCreatable true  and isOutboundCreatable false -> 'flexplm' (FlexPLM creates)
+     *  - isInboundCreatable false and isOutboundCreatable true  -> 'vibeiq'  (VibeIQ creates)
+     * Anything else is undeclared and returns undefined: no mapping file, no section, either function
+     * missing, both true, both false, or an error while resolving. Unlike isInboundCreatableFromObject /
+     * isOutboundCreatableFromEntity, there are NO defaults: the origin must be stated explicitly,
+     * so callers can fail safe (treat the entity as read-only) when it is not.
+     *
+     * @param fileId id for mapFile
+     * @param mapFileUtil class to get mapfile
+     * @param entityOrObject VibeIQ entity (vibe2flex) or FlexPLM object (flex2vibe)
+     * @param direction VIBE2FLEX_DIRECTION or FLEX2VIBE_DIRECTION; selects how the map section key is resolved
+     * @param context optional context object passed to the mapping functions
+     * @returns Promise<'flexplm' | 'vibeiq' | undefined>
+     */
+    static async getOriginSystem(fileId, mapFileUtil, entityOrObject, direction, context) {
+        if (!fileId || !entityOrObject) {
+            return undefined;
+        }
+        try {
+            const mapKey = (TypeConversionUtils.VIBE2FLEX_DIRECTION === direction)
+                ? await this.getMapKey(fileId, mapFileUtil, entityOrObject, direction)
+                : await this.getMapKeyFromObject(fileId, mapFileUtil, entityOrObject, direction);
+            if (!mapKey) {
+                return undefined;
+            }
+            const mapData = await map_utils_1.MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
+            if (!mapData || typeof mapData['isInboundCreatable'] !== 'function' || typeof mapData['isOutboundCreatable'] !== 'function') {
+                return undefined;
+            }
+            const inbound = !!(await mapData['isInboundCreatable'](entityOrObject, context));
+            const outbound = !!(await mapData['isOutboundCreatable'](entityOrObject, context));
+            if (inbound && !outbound) {
+                return 'flexplm';
+            }
+            if (!inbound && outbound) {
+                return 'vibeiq';
+            }
+        }
+        catch (e) {
+            console.error('TypeConversionUtils.getOriginSystem: unable to read the origin from the mapping file: ' + e?.message);
+        }
+        return undefined;
+    }
     /** Takes in a FlexPLM object and determines whether inbound
      * images should be synced. In most cases, the creation owning system
      * will also control image syncing. Defaults to false if no mapping exists.

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

@@ -924,4 +924,126 @@ 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']);
+        });
+    });
+    describe('getOriginSystem (isInboundCreatable / isOutboundCreatable pair)', () => {
+        const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
+        const countryEntity = { entityType: 'custom-entity', typePath: 'custom-entity:country' };
+        const countryObject = { flexPLMObjectClass: 'LCSCountry', flexPLMTypePath: 'Country' };
+        let spy;
+        // Org-style routing: custom-entity subtypes that are not listed return ''
+        const typeConversion = {
+            vibe2flex: { 'custom-entity': { getMapKey: () => '' } },
+            flex2vibe: {},
+        };
+        function useMap(countrySection) {
+            const map = { typeConversion };
+            if (countrySection) {
+                map.LCSCountry = countrySection;
+            }
+            spy.mockImplementation(async () => map);
+        }
+        beforeEach(() => {
+            spy = jest.spyOn(mapFileUtil, 'getMapFile');
+        });
+        afterEach(() => {
+            spy.mockRestore();
+        });
+        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('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('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('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('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('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('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('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('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 {
+                expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, countryObject, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION)).toBeUndefined();
+                expect(errorSpy).toHaveBeenCalled();
+            }
+            finally {
+                errorSpy.mockRestore();
+            }
+        });
+        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('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.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
+     *  'custom-entity:country' (compared case-insensitively).
+     *
+     * @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
+     *  'custom-entity:country' (compared case-insensitively).
+     *
+     * @param entity VibeIQ entity
+     * @returns boolean
+     */
+    static isCountryEntity(entity) {
+        const typePath = entity?.['typePath'];
+        return typeof typePath === 'string' && typePath.toLowerCase() === 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 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('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,16 @@ 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 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 +430,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 +512,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 +600,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 +646,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();
@@ -52,7 +53,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 +90,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 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.7.8",
+  "version": "1.8.0-alpha.562c8dd",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",