@contrail/flexplm 1.8.0-alpha.f09632d → 1.8.0

package/README.md

@@ -1,19 +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 persistence 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) |
+| 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 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):
+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.
 
-```ts
-LCSCountry: { originSystem: 'flexplm' }, // FlexPLM creates Countries
-LCSCountry: { originSystem: 'vibeiq' },  // VibeIQ creates Countries
-```
-Read the declared origin with `TypeConversionUtils.getOriginSystem(fileId, mapFileUtil, 'LCSCountry')`.

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

@@ -1,6 +1,4 @@
 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`).
  *
@@ -364,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.
@@ -517,28 +519,6 @@ 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
@@ -731,7 +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 and **must** declare the origin with `originSystem: 'flexplm' \| 'vibeiq'` (see {@link MappingSection.originSystem}); without it Country is read-only. |
+ * | `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.**                                                                                     |
@@ -749,7 +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; the mapping section must declare `originSystem`. Identifier `vibeIQIdentifier` (same key in both systems). Creation is allowed only when `originSystem` is `'flexplm'`. |
+ * | `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.d.ts

@@ -1,5 +1,4 @@
 import { MapFileUtil } from '@contrail/transform-data';
-import { OriginSystem } from '../interfaces/mapping-file';
 /** This class is helper functions to get the data for converting
  * VibeIQ entities to / from FlexPLM Objects
 */
@@ -148,21 +147,6 @@ 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 `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 mapSectionKey key of the map section that declares the origin. Ex: 'LCSCountry'
-     * @returns Promise<'flexplm' | 'vibeiq' | 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

@@ -360,37 +360,6 @@ class TypeConversionUtils {
         }
         return isOutboundCreatable;
     }
-    /** Returns which system originates (creates) an entity type, declared in its mapping section
-     * 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 mapSectionKey key of the map section that declares the origin. Ex: 'LCSCountry'
-     * @returns Promise<'flexplm' | 'vibeiq' | undefined>
-     */
-    static async getOriginSystem(fileId, mapFileUtil, mapSectionKey) {
-        if (!fileId || !mapSectionKey) {
-            return undefined;
-        }
-        try {
-            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) {
-            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

@@ -963,84 +963,22 @@ describe('conversion-utils', () => {
             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 (originSystem field on the LCSCountry mapping section)', () => {
-        const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
-        let spy;
-        function useMap(countrySection) {
-            const map = { typeConversion: { vibe2flex: { 'custom-entity': { getMapKey: () => '' } }, flex2vibe: {} } };
-            if (countrySection) {
-                map.LCSCountry = countrySection;
-            }
-            spy.mockImplementation(async () => map);
-        }
-        beforeEach(() => {
-            spy = jest.spyOn(mapFileUtil, 'getMapFile');
-        });
-        afterEach(() => {
-            spy.mockRestore();
-        });
-        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('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('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('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('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('should return undefined when there is no LCSCountry section', async () => {
-            useMap();
-            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('should not consult the creation gates, only the originSystem field', async () => {
-            useMap({ isInboundCreatable: () => true, isOutboundCreatable: () => false });
-            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('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, 'LCSCountry')).toBeUndefined();
-                expect(errorSpy).toHaveBeenCalled();
-            }
-            finally {
-                errorSpy.mockRestore();
-            }
-        });
         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('');
         });
+        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

@@ -20,7 +20,7 @@ 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).
+     *  exactly 'custom-entity:country'.
      *
      * @param entity VibeIQ entity
      * @returns boolean

package/lib/util/type-defaults.js

@@ -19,14 +19,14 @@ class TypeDefaults {
         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).
+     *  exactly 'custom-entity:country'.
      *
      * @param entity VibeIQ entity
      * @returns boolean
      */
     static isCountryEntity(entity) {
         const typePath = entity?.['typePath'];
-        return typeof typePath === 'string' && typePath.toLowerCase() === TypeDefaults.COUNTRY_VIBE_TYPE_PATH;
+        return typeof typePath === 'string' && typePath === TypeDefaults.COUNTRY_VIBE_TYPE_PATH;
     }
     /**Takes in full entity and returs the default FlexPLM
      * object class.

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

@@ -50,12 +50,12 @@ describe('Type Defaults', () => {
             const objectClass = type_defaults_1.TypeDefaults.getDefaultObjectClass(newData);
             expect(objectClass).toEqual('LCSCountry');
         });
-        it('should return LCSCountry when the Country typePath uses different casing', () => {
+        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('LCSCountry');
+            expect(type_defaults_1.TypeDefaults.getDefaultObjectClass(newData)).toEqual('LCSRevisableEntity');
         });
         it('should return LCSRevisableEntity for a custom entity that is not a Country', () => {
             const newData = {
@@ -347,6 +347,9 @@ describe('Type Defaults', () => {
         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);

package/lib/util/type-utils.js

@@ -15,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) {

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

@@ -53,9 +53,9 @@ describe('TypeUtils.getEventObjectClass() tests', () => {
         const objectClass = tu.getEventObjectClass(entityType, newData);
         expect(objectClass).toEqual('LCSCountry');
     });
-    it('should return LCSCountry when the Country typePath uses different casing', () => {
+    it('should return LCSRevisableEntity when the Country typePath uses different casing', () => {
         const objectClass = tu.getEventObjectClass('custom-entity', { typePath: 'custom-entity:Country' });
-        expect(objectClass).toEqual('LCSCountry');
+        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' });
@@ -215,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.8.0-alpha.f09632d",
+  "version": "1.8.0",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",