@contrail/flexplm 1.5.0-alpha.6fc44c4 → 1.5.0-alpha.aaef470

package/lib/util/type-defaults.js

@@ -4,6 +4,12 @@ exports.TypeDefaults = void 0;
 class TypeDefaults {
     constructor() {
     }
+    static applyConfig(config) {
+        TypeDefaults.processLCSMaterialAsItem = TypeDefaults.isPropertyTrue(config?.LCSMaterial?.processAsItem);
+    }
+    static isPropertyTrue(value) {
+        return value === true || (typeof value === 'string' && value.toLowerCase() === 'true');
+    }
     static getDefaultObjectClass(entity) {
         const entityType = this.getEntityType(entity);
         let objectClass = '';
@@ -130,7 +136,13 @@ class TypeDefaults {
     static getDefaultEntityClass(object) {
         let entityClass = '';
         let objectClass = TypeDefaults.getObjectClass(object);
-        if (['LCSProduct', 'LCSSKU', 'LCSMaterial'].includes(objectClass)) {
+        const itemClasses = TypeDefaults.processLCSMaterialAsItem
+            ? ['LCSProduct', 'LCSSKU', 'LCSMaterial']
+            : ['LCSProduct', 'LCSSKU'];
+        const customEntityClasses = TypeDefaults.processLCSMaterialAsItem
+            ? ['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast']
+            : ['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast', 'LCSMaterial'];
+        if (itemClasses.includes(objectClass)) {
             entityClass = 'item';
         }
         else if (['LCSProductSeasonLink', 'LCSSKUSeasonLink'].includes(objectClass)) {
@@ -142,7 +154,7 @@ class TypeDefaults {
         else if (['LCSSeason', 'SeasonGroup'].includes(objectClass)) {
             entityClass = 'assortment';
         }
-        else if (['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast'].includes(objectClass)) {
+        else if (customEntityClasses.includes(objectClass)) {
             entityClass = 'custom-entity';
         }
         if (entityClass === '')
@@ -158,7 +170,9 @@ class TypeDefaults {
                 typePath = 'item';
                 break;
             case 'LCSMaterial':
-                typePath = 'item:material';
+                if (TypeDefaults.processLCSMaterialAsItem) {
+                    typePath = 'item:material';
+                }
                 break;
             case 'LCSProductSeasonLink':
             case 'LCSSKUSeasonLink':
@@ -182,9 +196,16 @@ class TypeDefaults {
         switch (objectClass) {
             case 'LCSProduct':
             case 'LCSSKU':
-            case 'LCSMaterial':
                 identifierProps.push('itemNumber');
                 break;
+            case 'LCSMaterial':
+                if (TypeDefaults.processLCSMaterialAsItem) {
+                    identifierProps.push('itemNumber');
+                }
+                else {
+                    identifierProps.push('name');
+                }
+                break;
             case 'LCSSeason':
                 identifierProps.push('flexPLMSeasonName');
                 break;
@@ -203,7 +224,10 @@ class TypeDefaults {
     static getDefaultInformationalPropertiesFromObject(object) {
         const objectClass = TypeDefaults.getObjectClass(object);
         let properties = [];
-        if (['LCSProduct', 'LCSMaterial'].includes(objectClass)) {
+        const itemClasses = TypeDefaults.processLCSMaterialAsItem
+            ? ['LCSProduct', 'LCSMaterial']
+            : ['LCSProduct'];
+        if (itemClasses.includes(objectClass)) {
             properties.push('name');
         }
         else if ('LCSSKU' === objectClass) {
@@ -222,3 +246,4 @@ exports.TypeDefaults = TypeDefaults;
 TypeDefaults.NO_ENTITY_TYPE = 'Not able to determine the entity type of the entity object';
 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;

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

@@ -369,12 +369,25 @@ describe('Type Defaults', () => {
             const entityClass = type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
             expect(entityClass).toBe('custom-entity');
         });
-        it('item - LCSMaterial', () => {
+        it('item - LCSMaterial - processAsItem=true', () => {
+            const object = {
+                flexPLMObjectClass: 'LCSMaterial'
+            };
+            type_defaults_1.TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: true } });
+            try {
+                const entityClass = type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
+                expect(entityClass).toBe('item');
+            }
+            finally {
+                type_defaults_1.TypeDefaults.applyConfig({});
+            }
+        });
+        it('custom-entity - LCSMaterial - processAsItem=false (default)', () => {
             const object = {
                 flexPLMObjectClass: 'LCSMaterial'
             };
             const entityClass = type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
-            expect(entityClass).toBe('item');
+            expect(entityClass).toBe('custom-entity');
         });
     });
     describe('getDefaultEntityTypePath', () => {
@@ -427,12 +440,24 @@ describe('Type Defaults', () => {
             const typePath = type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object);
             expect(typePath).toBe('assortment');
         });
-        it('LCSMaterial', () => {
+        it('LCSMaterial - processAsItem=true', () => {
             const object = {
                 flexPLMObjectClass: 'LCSMaterial'
             };
-            const typePath = type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object);
-            expect(typePath).toBe('item:material');
+            type_defaults_1.TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: true } });
+            try {
+                const typePath = type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object);
+                expect(typePath).toBe('item:material');
+            }
+            finally {
+                type_defaults_1.TypeDefaults.applyConfig({});
+            }
+        });
+        it('LCSMaterial - processAsItem=false (default) throws', () => {
+            const object = {
+                flexPLMObjectClass: 'LCSMaterial'
+            };
+            expect(() => type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object)).toThrowError(type_defaults_1.TypeDefaults.NO_TYPE_PATH);
         });
     });
     describe('getDefaultIdentifierPropertiesFromObject', () => {
@@ -492,12 +517,26 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-        it('LCSMaterial', () => {
+        it('LCSMaterial - processAsItem=true', () => {
+            const object = {
+                flexPLMObjectClass: 'LCSMaterial'
+            };
+            type_defaults_1.TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: true } });
+            try {
+                const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultIdentifierPropertiesFromObject(object);
+                expect(defaultIdentifiers).toContain('itemNumber');
+                expect(defaultIdentifiers).toHaveLength(1);
+            }
+            finally {
+                type_defaults_1.TypeDefaults.applyConfig({});
+            }
+        });
+        it('LCSMaterial - processAsItem=false (default)', () => {
             const object = {
                 flexPLMObjectClass: 'LCSMaterial'
             };
             const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultIdentifierPropertiesFromObject(object);
-            expect(defaultIdentifiers).toContain('itemNumber');
+            expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
     });
@@ -534,13 +573,54 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-        it('LCSMaterial', () => {
+        it('LCSMaterial - processAsItem=true', () => {
+            const object = {
+                flexPLMObjectClass: 'LCSMaterial'
+            };
+            type_defaults_1.TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: true } });
+            try {
+                const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultInformationalPropertiesFromObject(object);
+                expect(defaultIdentifiers).toContain('name');
+                expect(defaultIdentifiers).toHaveLength(1);
+            }
+            finally {
+                type_defaults_1.TypeDefaults.applyConfig({});
+            }
+        });
+        it('LCSMaterial - processAsItem=false (default) yields no informational props', () => {
             const object = {
                 flexPLMObjectClass: 'LCSMaterial'
             };
             const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultInformationalPropertiesFromObject(object);
-            expect(defaultIdentifiers).toContain('name');
-            expect(defaultIdentifiers).toHaveLength(1);
+            expect(defaultIdentifiers).toHaveLength(0);
+        });
+    });
+    describe('applyConfig', () => {
+        afterEach(() => {
+            type_defaults_1.TypeDefaults.applyConfig({});
+        });
+        it('sets processLCSMaterialAsItem=true when processAsItem=true', () => {
+            type_defaults_1.TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: true } });
+            expect(type_defaults_1.TypeDefaults.processLCSMaterialAsItem).toBe(true);
+        });
+        it('sets processLCSMaterialAsItem=true when processAsItem=\"true\" (string)', () => {
+            type_defaults_1.TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: 'true' } });
+            expect(type_defaults_1.TypeDefaults.processLCSMaterialAsItem).toBe(true);
+        });
+        it('sets processLCSMaterialAsItem=false when processAsItem=false', () => {
+            type_defaults_1.TypeDefaults.processLCSMaterialAsItem = true;
+            type_defaults_1.TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: false } });
+            expect(type_defaults_1.TypeDefaults.processLCSMaterialAsItem).toBe(false);
+        });
+        it('sets processLCSMaterialAsItem=false when LCSMaterial missing', () => {
+            type_defaults_1.TypeDefaults.processLCSMaterialAsItem = true;
+            type_defaults_1.TypeDefaults.applyConfig({});
+            expect(type_defaults_1.TypeDefaults.processLCSMaterialAsItem).toBe(false);
+        });
+        it('sets processLCSMaterialAsItem=false when config is null/undefined', () => {
+            type_defaults_1.TypeDefaults.processLCSMaterialAsItem = true;
+            type_defaults_1.TypeDefaults.applyConfig(undefined);
+            expect(type_defaults_1.TypeDefaults.processLCSMaterialAsItem).toBe(false);
         });
     });
 });

package/package.json

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

package/src/transform/identifier-conversion.spec.ts

@@ -3,6 +3,7 @@ import { IdentifierConversion } from "./identifier-conversion";
 import { DataConverter } from "../util/data-converter";
 import { FCConfig } from "../interfaces/interfaces";
 import { Entities } from "@contrail/sdk";
+import { TypeDefaults } from "../util/type-defaults";
 
 const mapFile1Data = require('./identifier-conversion-spec-mockData');
 const mapFile1Mappings = mapFile1Data?.mapping;
@@ -325,6 +326,7 @@ describe('getItemCriteriaFromObject', () => {
       itemNumber: 'MAT-100'
     };
     let getEntityValuesSpyOn = undefined
+    TypeDefaults.applyConfig({ LCSMaterial: { processAsItem: true } });
     try {
 
       getEntityValuesSpyOn = jest.spyOn(dc, 'getEntityValues');
@@ -335,6 +337,7 @@ describe('getItemCriteriaFromObject', () => {
       if (getEntityValuesSpyOn) {
         getEntityValuesSpyOn.mockRestore();
       }
+      TypeDefaults.applyConfig({});
     }
   });
 

package/src/util/config-defaults.spec.ts

@@ -1,5 +1,6 @@
 import { ConfigDefaults } from './config-defaults';
 import { FCConfig } from '../interfaces/interfaces';
+import { TypeDefaults } from './type-defaults';
 
 let entityObject = {};
 jest.mock('@contrail/sdk', () => {
@@ -392,6 +393,20 @@ describe('all tests', () => {
       const fcConfig: any = await ConfigDefaults.setConfigDefaults(startConfig);
       expect(fcConfig.LCSMaterial.processAsItem).toBe(true);
     });
+
+    it('applies LCSMaterial.processAsItem to TypeDefaults', async () => {
+      try {
+        const startConfig: any = Object.assign({}, config, { LCSMaterial: { processAsItem: true } });
+        await ConfigDefaults.setConfigDefaults(startConfig);
+        expect(TypeDefaults.processLCSMaterialAsItem).toBe(true);
+
+        const defaultStart: any = Object.assign({}, config);
+        await ConfigDefaults.setConfigDefaults(defaultStart);
+        expect(TypeDefaults.processLCSMaterialAsItem).toBe(false);
+      } finally {
+        TypeDefaults.applyConfig({});
+      }
+    });
   });
 
   describe('getConfigFile', () => {

package/src/util/config-defaults.ts

@@ -1,6 +1,7 @@
 import { Entities } from '@contrail/sdk';
 import { FCConfig } from '../interfaces/interfaces';
 import { ObjectUtil } from '@contrail/util';
+import { TypeDefaults } from './type-defaults';
 
 export class ConfigDefaults {
   static NEED_CONFIG_VALUES = 'To connect to FlexPLM all these APP values need to be set apiHost, userName, and password';
@@ -34,6 +35,8 @@ export class ConfigDefaults {
     //Don't allow overwriting this.
     outputConfig['OOBvibeEventEndpoint'] = '/rfa/vibeiq/vibeEvents';
 
+    TypeDefaults.applyConfig(outputConfig);
+
     console.log('outputConfig: ' + JSON.stringify(outputConfig));
     return outputConfig as FCConfig;
   }