@contrail/flexplm 1.8.0-alpha.0261c7e → 1.8.0-alpha.f09632d

package/README.md

@@ -10,10 +10,10 @@ Core model for contrail, which establishes the base peristence services (without
 | 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):
+A mapping section for `LCSCountry` overrides any of these. The section must also declare which system creates Countries, with one field (there is no default; if it is missing or invalid, the app treats Country as read-only):
 
 ```ts
-LCSCountry: { isInboundCreatable: () => true,  isOutboundCreatable: () => false }, // FlexPLM creates
-LCSCountry: { isInboundCreatable: () => false, isOutboundCreatable: () => true  }, // VibeIQ creates
+LCSCountry: { originSystem: 'flexplm' }, // FlexPLM creates Countries
+LCSCountry: { originSystem: 'vibeiq' },  // VibeIQ creates Countries
 ```
-Read the declared origin with `TypeConversionUtils.getOriginSystem(...)`.
+Read the declared origin with `TypeConversionUtils.getOriginSystem(fileId, mapFileUtil, 'LCSCountry')`.

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

@@ -1,4 +1,6 @@
 import { FunctionTransformers, RekeyTransformers, TransformDefinition, TransformTask } from "@contrail/transform-data";
+/** The system that originates (creates) an entity type: 'flexplm' or 'vibeiq'. */
+export type OriginSystem = 'flexplm' | 'vibeiq';
 /**
  * One direction of a {@link MappingSection} (either `vibe2flex` or `flex2vibe`).
  *
@@ -340,13 +342,6 @@ 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
@@ -522,6 +517,28 @@ export interface MappingSection {
      * getInformationalProperties: () => ['itemNumber', 'skuName']
      */
     getInformationalProperties?: (entity: Record<string, unknown>) => string[];
+    /**
+     * Which system originates (creates) this entity type: `'flexplm'` or `'vibeiq'`.
+     *
+     * Currently read only for the **`LCSCountry`** section, where it is
+     * **required**: the connector creates Countries in one direction only
+     * (`'flexplm'`: FlexPLM creates them and VibeIQ never sends them to
+     * FlexPLM; `'vibeiq'`: VibeIQ creates them and inbound events only update
+     * existing Countries). There is no default. When it is missing, or is not
+     * one of those two values (case and surrounding whitespace are ignored),
+     * the origin is undeclared and Country is read-only on both sides, with an
+     * error logged. See `TypeConversionUtils.getOriginSystem`.
+     *
+     * It is a static, type-level value. It does not read the record, and it is
+     * independent of {@link MappingSection.isInboundCreatable} and
+     * {@link MappingSection.isOutboundCreatable}, which the Country origin
+     * check does not consult.
+     *
+     * @example
+     * // FlexPLM creates Countries.
+     * LCSCountry: { originSystem: 'flexplm' }
+     */
+    originSystem?: OriginSystem;
     /**
      * Transform configuration applied when sending data from VibeIQ to FlexPLM.
      * Pipeline runs on rows in their VibeIQ shape and produces rows in their
@@ -714,7 +731,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`. |
+ * | `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 with `originSystem: 'flexplm' \| 'vibeiq'` (see {@link MappingSection.originSystem}); without it Country is read-only. |
  * | `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.**                                                                                     |
@@ -732,7 +749,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`. |
+ * | `LCSCountry`            | `custom-entity` (`custom-entity:country`) | Built-in defaults for type path and identifier; the mapping section must declare `originSystem`. Identifier `vibeIQIdentifier` (same key in both systems). Creation is allowed only when `originSystem` is `'flexplm'`. |
  * | (any)                   | `item` (direct, no link)   | **Not yet supported.**                                                                                     |
  *
  * @example

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

@@ -1,6 +1,5 @@
 import { MapFileUtil } from '@contrail/transform-data';
-/** The system that originates (creates) an entity type: 'flexplm' or 'vibeiq'. */
-export type OriginSystem = 'flexplm' | 'vibeiq';
+import { OriginSystem } from '../interfaces/mapping-file';
 /** This class is helper functions to get the data for converting
  * VibeIQ entities to / from FlexPLM Objects
 */
@@ -150,22 +149,20 @@ export declare class TypeConversionUtils {
     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.
+     * with the `originSystem` field: 'flexplm' (FlexPLM creates) or 'vibeiq' (VibeIQ creates).
+     * Case and surrounding whitespace are ignored. Anything else is undeclared and returns undefined:
+     * no mapping file, no section, no field, or a value that is not 'flexplm' / 'vibeiq'. There is no
+     * default, so callers can fail safe (treat the entity as read-only) when it is not declared.
+     *
+     * The value is static and type-level: it does not read the record, and it does not consult the
+     * isInboundCreatable / isOutboundCreatable gates.
      *
      * @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
+     * @param mapSectionKey key of the map section that declares the origin. Ex: 'LCSCountry'
      * @returns Promise<'flexplm' | 'vibeiq' | undefined>
      */
-    static getOriginSystem(fileId: string, mapFileUtil: MapFileUtil, entityOrObject: any, direction: string, context?: any): Promise<OriginSystem | undefined>;
+    static getOriginSystem(fileId: string, mapFileUtil: MapFileUtil, mapSectionKey: string): 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,11 +143,6 @@ 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;
             }
         }
@@ -366,43 +361,29 @@ 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.
+     * with the `originSystem` field: 'flexplm' (FlexPLM creates) or 'vibeiq' (VibeIQ creates).
+     * Case and surrounding whitespace are ignored. Anything else is undeclared and returns undefined:
+     * no mapping file, no section, no field, or a value that is not 'flexplm' / 'vibeiq'. There is no
+     * default, so callers can fail safe (treat the entity as read-only) when it is not declared.
+     *
+     * The value is static and type-level: it does not read the record, and it does not consult the
+     * isInboundCreatable / isOutboundCreatable gates.
      *
      * @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
+     * @param mapSectionKey key of the map section that declares the origin. Ex: 'LCSCountry'
      * @returns Promise<'flexplm' | 'vibeiq' | undefined>
      */
-    static async getOriginSystem(fileId, mapFileUtil, entityOrObject, direction, context) {
-        if (!fileId || !entityOrObject) {
+    static async getOriginSystem(fileId, mapFileUtil, mapSectionKey) {
+        if (!fileId || !mapSectionKey) {
             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';
+            const mapData = await map_utils_1.MapUtil.getFullMapSection(fileId, mapFileUtil, mapSectionKey);
+            const value = mapData?.['originSystem'];
+            const normalized = typeof value === 'string' ? value.trim().toLowerCase() : '';
+            if (normalized === 'flexplm' || normalized === 'vibeiq') {
+                return normalized;
             }
         }
         catch (e) {

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'] }
@@ -964,18 +964,11 @@ describe('conversion-utils', () => {
             expect(await type_conversion_utils_1.TypeConversionUtils.getIdentifierProperties(TRANSFORM_MAP_FILE, mapFileUtil, entity)).toEqual(['isoCode']);
         });
     });
-    describe('getOriginSystem (isInboundCreatable / isOutboundCreatable pair)', () => {
+    describe('getOriginSystem (originSystem field on the LCSCountry mapping section)', () => {
         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 };
+            const map = { typeConversion: { vibe2flex: { 'custom-entity': { getMapKey: () => '' } }, flex2vibe: {} } };
             if (countrySection) {
                 map.LCSCountry = countrySection;
             }
@@ -987,63 +980,67 @@ describe('conversion-utils', () => {
         afterEach(() => {
             spy.mockRestore();
         });
-        it("is 'flexplm' when inbound is creatable and outbound is not (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 () => {
-            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 return flexplm when the section declares originSystem flexplm', async () => {
+            useMap({ originSystem: 'flexplm' });
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBe('flexplm');
         });
-        it('supports 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 vibeiq when the section declares originSystem vibeiq', async () => {
+            useMap({ originSystem: 'vibeiq' });
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBe('vibeiq');
         });
-        it('is undefined when both 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 ignore case and surrounding whitespace in the declared value', async () => {
+            useMap({ originSystem: ' FlexPLM ' });
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBe('flexplm');
+            useMap({ originSystem: 'VibeIQ' });
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBe('vibeiq');
         });
-        it('is undefined when both 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 the value is not flexplm or vibeiq', async () => {
+            for (const value of ['sap', '', '  ', 5, null, {}, ['flexplm']]) {
+                useMap({ originSystem: value });
+                expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBeUndefined();
+            }
         });
-        it('is undefined when either function is missing (no defaults)', 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 the section does not declare originSystem', async () => {
+            useMap({ getIdentifierProperties: () => ['vibeIQIdentifier'] });
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).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();
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBeUndefined();
+        });
+        it('should return undefined when there is no mapping file id or section key', async () => {
+            useMap({ originSystem: 'flexplm' });
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem('', mapFileUtil, 'LCSCountry')).toBeUndefined();
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, '')).toBeUndefined();
         });
-        it('is undefined when there is no mapping file id or no entity', async () => {
+        it('should not consult the creation gates, only the originSystem field', 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();
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBeUndefined();
+            useMap({ originSystem: 'vibeiq', isInboundCreatable: () => true, isOutboundCreatable: () => false });
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBe('vibeiq');
         });
-        it('is undefined (and logs) when a mapping function throws', async () => {
-            useMap({ isInboundCreatable: () => { throw new Error('boom'); }, isOutboundCreatable: () => false });
+        it('should read the section named by the key argument', async () => {
+            const map = { typeConversion: {}, countryMapping: { originSystem: 'vibeiq' } };
+            spy.mockImplementation(async () => map);
+            expect(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'countryMapping')).toBe('vibeiq');
+        });
+        it('should return undefined and log when the mapping file cannot be read', async () => {
+            spy.mockImplementation(async () => {
+                throw new Error('boom');
+            });
             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(await type_conversion_utils_1.TypeConversionUtils.getOriginSystem(TRANSFORM_MAP_FILE, mapFileUtil, 'LCSCountry')).toBeUndefined();
                 expect(errorSpy).toHaveBeenCalled();
             }
             finally {
                 errorSpy.mockRestore();
             }
         });
-        it('does not change the creatable defaults of other types', 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 () => {
-            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');
+        it('should leave the section key of a Country unchanged when the org custom entity routing returns an empty key', async () => {
+            useMap({ originSystem: 'flexplm' });
+            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('');
         });
     });
 });

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.f09632d",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",