@contrail/flexplm 1.5.0-alpha.6fc44c4 → 1.5.0-alpha.98b8b06

package/lib/util/data-converter.spec.js

@@ -454,6 +454,393 @@ describe('getObjectReferenceValue bad value', () => {
         }
     });
 });
+describe('setObjectReferenceValue - identity service', () => {
+    const baseConfig = () => ({
+        apiHost: 'host',
+        userName: () => 'user',
+        password: () => 'pass',
+        urlContext: 'xxx',
+        vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
+        csrfEndpoint: '/servlet/rest/security/csrf',
+        itemPreDevelopmentLifecycleStages: ['concept']
+    });
+    const refProp = {
+        id: 'cJoZQvoj7dkfCBJq',
+        propertyType: 'object_reference',
+        slug: 'material',
+        label: 'Material',
+        referencedTypeRootSlug: 'item',
+        referencedTypePath: 'item:material'
+    };
+    let identifierSpy;
+    let poolKeySpy;
+    let getByRootAndPathSpy;
+    let filterTypePropertiesSpy;
+    const setupTypeUtilsSpies = (dc, rootPropSlugs = ['itemNumber']) => {
+        getByRootAndPathSpy = jest.spyOn(dc['typeUtils'], 'getByRootAndPath')
+            .mockImplementation(async () => ({ typePath: 'item', typeProperties: [] }));
+        filterTypePropertiesSpy = jest.spyOn(dc['typeUtils'], 'filterTypeProperties')
+            .mockImplementation(() => rootPropSlugs.map(slug => ({ slug })));
+    };
+    afterEach(() => {
+        identifierSpy?.mockRestore();
+        poolKeySpy?.mockRestore();
+        getByRootAndPathSpy?.mockRestore();
+        filterTypePropertiesSpy?.mockRestore();
+        mockGetFunction.mockReset();
+        mockGetFunction.mockImplementation((options) => ((options?.criteria?.id === 1234) ? [mockObj1234] : [mockObj2222]));
+    });
+    it('flag off - uses getAllObjectReferences path', async () => {
+        const dc = new data_converter_1.DataConverter(baseConfig(), new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['itemNumber', 'roles']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'item:material');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ id: 'abc123', typePath: 'item:material' }]);
+        const nd = { itemNumber: 'MAT-100', roles: ['family'] };
+        const result = await dc.setObjectReferenceValue(refProp, nd);
+        expect(mockGetFunction).toHaveBeenCalled();
+        const callArg = mockGetFunction.mock.calls[0][0];
+        expect(callArg.entityName).toEqual('item');
+        expect(callArg.entityName).not.toEqual('identity');
+        expect(result).toEqual('abc123');
+        expect(poolKeySpy).not.toHaveBeenCalled();
+    });
+    it('flag on, single identity match - returns parsed id', async () => {
+        const config = baseConfig();
+        config.search = { item: { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'item:material');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ entityReference: 'item:abc123' }]);
+        const nd = { itemNumber: 'MAT-100', roles: ['family'] };
+        const result = await dc.setObjectReferenceValue(refProp, nd);
+        expect(mockGetFunction).toHaveBeenCalledTimes(1);
+        const callArg = mockGetFunction.mock.calls[0][0];
+        expect(callArg.entityName).toEqual('identity');
+        expect(callArg.criteria).toEqual({
+            poolKey: 'item:material',
+            propertyName: 'itemNumber',
+            propertyValue: 'MAT-100'
+        });
+        expect(result).toEqual('abc123');
+    });
+    it('flag on, no identity match - returns empty and warns', async () => {
+        const config = baseConfig();
+        config.search = { item: { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'item:material');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => []);
+        const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
+        const getAllSpy = jest.spyOn(dc, 'getAllObjectReferences');
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100', roles: ['family'] });
+            expect(result).toEqual('');
+            expect(warnSpy).toHaveBeenCalled();
+            expect(getAllSpy).not.toHaveBeenCalled();
+        }
+        finally {
+            warnSpy.mockRestore();
+            getAllSpy.mockRestore();
+        }
+    });
+    it('flag on, multiple identity matches - returns empty and does not throw', async () => {
+        const config = baseConfig();
+        config.search = { item: { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'item:material');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [
+            { entityReference: 'item:abc123' },
+            { entityReference: 'item:def456' }
+        ]);
+        const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100', roles: ['family'] });
+            expect(result).toEqual('');
+            expect(warnSpy).toHaveBeenCalled();
+        }
+        finally {
+            warnSpy.mockRestore();
+        }
+    });
+    it('flag on, ambiguous identifier set - falls back to getAllObjectReferences', async () => {
+        const config = baseConfig();
+        config.search = { item: { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['itemNumber', 'season', 'roles']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'season', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'item:material');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ id: 'abc123', typePath: 'item:material' }]);
+        const nd = { itemNumber: 'MAT-100', season: 'SS24', roles: ['family'] };
+        const result = await dc.setObjectReferenceValue(refProp, nd);
+        expect(mockGetFunction).toHaveBeenCalled();
+        const callArg = mockGetFunction.mock.calls[0][0];
+        expect(callArg.entityName).toEqual('item');
+        expect(callArg.entityName).not.toEqual('identity');
+        expect(result).toEqual('abc123');
+        expect(poolKeySpy).not.toHaveBeenCalled();
+    });
+    it('flag on, cache hit - second call short-circuits', async () => {
+        const config = baseConfig();
+        config.search = { item: { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'item:material');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ entityReference: 'item:abc123' }]);
+        const nd = { itemNumber: 'MAT-100', roles: ['family'] };
+        const r1 = await dc.setObjectReferenceValue(refProp, nd);
+        const r2 = await dc.setObjectReferenceValue(refProp, nd);
+        expect(r1).toEqual('abc123');
+        expect(r2).toEqual('abc123');
+        expect(mockGetFunction).toHaveBeenCalledTimes(1);
+    });
+    it('flag on, project-item entityType - roles is filtered, identity path used', async () => {
+        const projectItemProp = {
+            ...refProp,
+            referencedTypeRootSlug: 'project-item',
+            referencedTypePath: 'project-item'
+        };
+        const config = baseConfig();
+        config.search = { 'project-item': { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['itemNumber', 'roles']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'project-item');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ entityReference: 'project-item:pi-789' }]);
+        const result = await dc.setObjectReferenceValue(projectItemProp, { itemNumber: 'X1', roles: ['family'] });
+        expect(mockGetFunction).toHaveBeenCalledTimes(1);
+        const callArg = mockGetFunction.mock.calls[0][0];
+        expect(callArg.entityName).toEqual('identity');
+        expect(callArg.criteria.propertyName).toEqual('itemNumber');
+        expect(result).toEqual('pi-789');
+    });
+    it('flag on, non-item entityType - roles is NOT filtered, falls back to query path', async () => {
+        const colorProp = {
+            ...refProp,
+            referencedTypeRootSlug: 'color',
+            referencedTypePath: 'color'
+        };
+        const config = baseConfig();
+        config.search = { color: { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['colorNumber', 'roles']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['colorNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'color');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ id: 'col-1', typePath: 'color' }]);
+        const result = await dc.setObjectReferenceValue(colorProp, { colorNumber: 'C1', roles: ['family'] });
+        expect(mockGetFunction).toHaveBeenCalled();
+        const callArg = mockGetFunction.mock.calls[0][0];
+        expect(callArg.entityName).toEqual('color');
+        expect(callArg.entityName).not.toEqual('identity');
+        expect(result).toEqual('col-1');
+        expect(poolKeySpy).not.toHaveBeenCalled();
+    });
+    it('query path, multiple matches - returns empty with single warn (no double warn)', async () => {
+        const dc = new data_converter_1.DataConverter(baseConfig(), new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['itemNumber']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber']);
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [
+            { id: 'a1', typePath: 'item:material' },
+            { id: 'a2', typePath: 'item:material' }
+        ]);
+        const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100' });
+            expect(result).toEqual('');
+            expect(warnSpy).toHaveBeenCalledTimes(1);
+            expect(warnSpy.mock.calls[0][0]).toMatch(/duplicate records/);
+        }
+        finally {
+            warnSpy.mockRestore();
+        }
+    });
+    it('flag on, identity returns null - normalized to empty array, returns empty', async () => {
+        const config = baseConfig();
+        config.search = { item: { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'item:material');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => null);
+        const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100', roles: ['family'] });
+            expect(result).toEqual('');
+            expect(warnSpy).toHaveBeenCalled();
+        }
+        finally {
+            warnSpy.mockRestore();
+        }
+    });
+    it('null nd - returns empty string and does not query', async () => {
+        const dc = new data_converter_1.DataConverter(baseConfig(), new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        mockGetFunction.mockClear();
+        const result = await dc.setObjectReferenceValue(refProp, null);
+        expect(result).toEqual('');
+        expect(mockGetFunction).not.toHaveBeenCalled();
+    });
+    it('zero identifier keys - warns and returns empty string', async () => {
+        const dc = new data_converter_1.DataConverter(baseConfig(), new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => []);
+        mockGetFunction.mockClear();
+        const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100' });
+            expect(result).toEqual('');
+            expect(warnSpy).toHaveBeenCalledWith(expect.stringMatching(/doesnt have all "identifier" properties/));
+            expect(mockGetFunction).not.toHaveBeenCalled();
+        }
+        finally {
+            warnSpy.mockRestore();
+        }
+    });
+    it('missing identifier keys on nd - warns and returns empty string', async () => {
+        const dc = new data_converter_1.DataConverter(baseConfig(), new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'season']);
+        mockGetFunction.mockClear();
+        const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100' });
+            expect(result).toEqual('');
+            expect(warnSpy).toHaveBeenCalledWith(expect.stringMatching(/doesnt have all "identifier" properties/));
+            expect(mockGetFunction).not.toHaveBeenCalled();
+        }
+        finally {
+            warnSpy.mockRestore();
+        }
+    });
+    it('transformMapFile set - applyInboundTransformMap is invoked before context build', async () => {
+        const config = baseConfig();
+        config['transformMapFile'] = 'file1';
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['itemNumber', 'roles']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        const mapKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getMapKeyFromObject')
+            .mockImplementation(async () => 'LCSMaterial');
+        const applyMapSpy = jest.spyOn(map_utils_1.MapUtil, 'applyTransformMap')
+            .mockImplementation(async (...args) => args[2]);
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ id: 'q-1', typePath: 'item:material' }]);
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100', roles: ['family'] });
+            expect(mapKeySpy).toHaveBeenCalledTimes(1);
+            expect(applyMapSpy).toHaveBeenCalledTimes(1);
+            expect(applyMapSpy.mock.calls[0][3]).toEqual('LCSMaterial');
+            expect(result).toEqual('q-1');
+        }
+        finally {
+            mapKeySpy.mockRestore();
+            applyMapSpy.mockRestore();
+        }
+    });
+    it('transformMapFile unset - applyInboundTransformMap does not invoke map utilities', async () => {
+        const dc = new data_converter_1.DataConverter(baseConfig(), new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['itemNumber', 'roles']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        const mapKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getMapKeyFromObject');
+        const applyMapSpy = jest.spyOn(map_utils_1.MapUtil, 'applyTransformMap');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ id: 'q-2', typePath: 'item:material' }]);
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100', roles: ['family'] });
+            expect(mapKeySpy).not.toHaveBeenCalled();
+            expect(applyMapSpy).not.toHaveBeenCalled();
+            expect(result).toEqual('q-2');
+        }
+        finally {
+            mapKeySpy.mockRestore();
+            applyMapSpy.mockRestore();
+        }
+    });
+    it('query path success - writes id to cache (second call short-circuits)', async () => {
+        const dc = new data_converter_1.DataConverter(baseConfig(), new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['itemNumber', 'roles']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ id: 'cached-q', typePath: 'item:material' }]);
+        const nd = { itemNumber: 'MAT-100', roles: ['family'] };
+        const r1 = await dc.setObjectReferenceValue(refProp, nd);
+        const callsAfterFirst = mockGetFunction.mock.calls.length;
+        const r2 = await dc.setObjectReferenceValue(refProp, nd);
+        expect(r1).toEqual('cached-q');
+        expect(r2).toEqual('cached-q');
+        expect(mockGetFunction.mock.calls.length).toEqual(callsAfterFirst);
+    });
+    it('query path with subtype filter - applies checkKeysAndValues when entityType !== entityTypePath', async () => {
+        const dc = new data_converter_1.DataConverter(baseConfig(), new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc, ['itemNumber']);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'season']);
+        const checkSpy = jest.spyOn(dc, 'checkKeysAndValues')
+            .mockImplementation((_criteria, arr) => arr);
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ id: 'sub-1', typePath: 'item:material' }]);
+        try {
+            const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100', season: 'SS24' });
+            expect(checkSpy).toHaveBeenCalledTimes(1);
+            expect(checkSpy.mock.calls[0][2]).toEqual('item:material');
+            expect(result).toEqual('sub-1');
+        }
+        finally {
+            checkSpy.mockRestore();
+        }
+    });
+    it('pickSingleResult single result - identity branch parses id from entityReference', async () => {
+        const config = baseConfig();
+        config.search = { item: { useIdentityServiceForInboundData: true } };
+        const dc = new data_converter_1.DataConverter(config, new transform_data_1.MapFileUtil(new sdk_1.Entities()));
+        setupTypeUtilsSpies(dc);
+        identifierSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getIdentifierPropertiesFromObject')
+            .mockImplementation(async () => ['itemNumber', 'roles']);
+        poolKeySpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'getUniquenessPoolKeyFromObject')
+            .mockImplementation(async () => 'item:material');
+        mockGetFunction.mockClear();
+        mockGetFunction.mockImplementation(() => [{ entityReference: 'item:parsed-id-from-ref' }]);
+        const result = await dc.setObjectReferenceValue(refProp, { itemNumber: 'MAT-100', roles: ['family'] });
+        expect(result).toEqual('parsed-id-from-ref');
+    });
+});
 describe('getObjectReferenceValue - use mapping', () => {
     const maps = require('./data-converter-spec-mockData');
     const mapping = maps['mapping'];
@@ -650,6 +1037,7 @@ describe('checkKeysAndValues', () => {
         { name: 'Group 4', typePath: 'custom-entity:grouping:sub' },
         { name: 'Group 5', typePath: 'custom-entity:grouping:sub' }
     ];
+    //item:product:newBalance:accessories, item:product:newBalance:apparel
     it('Group 1', () => {
         const criteria = {
             name: 'Group 1'
@@ -871,6 +1259,7 @@ describe('getUserListValue', () => {
     ];
     const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
     const dc = new data_converter_1.DataConverter(config, mapFileUtil);
+    //getUserById
     let spyGetUserById = jest.spyOn(dc, 'getUserById')
         .mockImplementation(async (nd) => {
         return userEmailMapping.find((user) => user.id === nd);

package/lib/util/error-response-object.d.ts

@@ -1,4 +1,9 @@
 import { AppActionCallBack } from "@contrail/app-framework";
 export declare class ErrorResponseObject {
+    /** Returns a response, checking for multiple possible error details
+     *
+     * @param e
+     * @returns
+     */
     static getResponse(e: any): AppActionCallBack;
 }

package/lib/util/error-response-object.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorResponseObject = void 0;
 const app_framework_1 = require("@contrail/app-framework");
 class ErrorResponseObject {
+    /** Returns a response, checking for multiple possible error details
+     *
+     * @param e
+     * @returns
+     */
     static getResponse(e) {
         if (!e) {
             const response = {
@@ -20,6 +25,7 @@ class ErrorResponseObject {
             }
         };
         const output = response.output;
+        //Errors when persisting in VibeIQ
         if (e.details)
             output.errorDetails = e.details;
         if (e.code)
@@ -30,6 +36,7 @@ class ErrorResponseObject {
             output.type = e.type;
         if (e.name)
             output.errorName = e.name;
+        //Has original cause
         if (e.cause) {
             output.cause = {};
             const cause = output.cause;

package/lib/util/event-short-message-status.js

@@ -16,6 +16,7 @@ var EventShortMessageStatus;
     EventShortMessageStatus["PRIMARY_CONTENT_UPDATED"] = "Primary_Content_Updated";
     EventShortMessageStatus["TOO_MANY_ENTITIES_FOUND"] = "Too_Many_Entities_Found";
     EventShortMessageStatus["UPDATED"] = "Updated";
+    //Publish
     EventShortMessageStatus["NOT_PUBLISHABLE"] = "Not_Publishable";
     EventShortMessageStatus["NO_FEDERATION_INFO"] = "No_Federation_Information";
     EventShortMessageStatus["NO_EVENTS_TO_SEND"] = "No_Events_to_Send";

package/lib/util/federation.js

@@ -43,9 +43,11 @@ class Federation {
                 mappedReference: itemResults[i].federatedId,
                 federationSchema: FED_CONFIG.federationSchema
             };
+            // console.log('createFederatedRecord: ' + JSON.stringify(payload));
             try {
                 const results = await new sdk_1.Entities().create({ entityName: 'federation', object: payload });
                 return results;
+                // console.log(JSON.stringify(results));
             }
             catch (error) {
                 console.log('createFederatedRecord-error: ', error);
@@ -79,13 +81,16 @@ class Federation {
         return { entityType, entityId };
     }
     async getEntityFromMappedRefId(mappedRefId) {
+        // console.log('!---getEntityFromMappedRefId: ' + mappedRefId);
         const fedRecord = await this.getFederationRecordFromMappedRefId(mappedRefId);
         console.log('fedRecord: ' + JSON.stringify(fedRecord));
         if (!fedRecord) {
+            //Not creating from FlexPLM at this time.
             console.log('Federation Record doesnt exist. Cant get entity!');
             return;
         }
         const { entityType, entityId } = Federation.getEntityId(fedRecord);
+        // console.log(entityType + ':' + entityId);
         const criteria = {
             id: entityId
         };
@@ -94,6 +99,7 @@ class Federation {
             criteria
         });
         const entity = (entities && entities[0]) ? entities[0] : undefined;
+        // console.log(' entities: ' +JSON.stringify(entities));
         return entity;
     }
     async getFederationRecordsFromIds(ids) {
@@ -104,6 +110,7 @@ class Federation {
                 appIdentifier: FED_CONFIG.appIdentifier,
                 federationSchema: FED_CONFIG.federationSchema
             };
+            // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
             const recs = await new sdk_1.Entities().get({
                 entityName: 'federation',
                 criteria
@@ -126,6 +133,7 @@ class Federation {
                     appIdentifier: FED_CONFIG.appIdentifier,
                     federationSchema: FED_CONFIG.federationSchema
                 };
+                // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
                 const records = await entities.get({
                     entityName: 'federation',
                     criteria

package/lib/util/flexplm-connect.d.ts

@@ -14,6 +14,13 @@ export declare class FlexPLMConnect {
     protected processRequest(payload: any): Promise<FlexPLMResponseData>;
     sendToFlexPLM(payload: PayloadType): Promise<FlexPLMResponseData>;
     sendMultipleToFlexPLM(payload: PayloadType[]): Promise<FlexPLMResponseData>;
+    /** Runs a GET request to FlexPLM.
+     * @param params - Optional configuration for the request.
+     * @param params.urlPath - Custom URL path to use instead of the default `/servlet/rest` + endpoint.
+     * @param params.includeUrlContext - Whether to include the urlContext in the URL. Defaults to `true`.
+     * @param params.returnFullResponse - If `true`, returns the raw `Response` object instead of parsed JSON. Defaults to `false`.
+     * @returns The parsed JSON response body, or the raw `Response` object if `returnFullResponse` is `true`.
+     */
     getRequest(params?: {
         urlPath?: string;
         includeUrlContext?: boolean;

package/lib/util/flexplm-connect.js

@@ -18,6 +18,9 @@ class FlexPLMConnect {
             this.staticHeaders = this.config?.flexplmConnect?.staticHeaders;
         }
     }
+    /////////////////////////////////////////////////////////////////////////////
+    ///////// Custom getRequestOptions: start
+    /////////////////////////////////////////////////////////////////////////////
     getRequestOptions(method) {
         const csrfOptions = {
             method,
@@ -37,6 +40,9 @@ class FlexPLMConnect {
         }
         return csrfOptions;
     }
+    /////////////////////////////////////////////////////////////////////////////
+    ///////// Custom getRequestOptions: end
+    /////////////////////////////////////////////////////////////////////////////
     async getCSRF() {
         const urlContext = this.config.urlContext;
         const csrfEndpoint = this.config.csrfEndpoint;
@@ -130,6 +136,7 @@ class FlexPLMConnect {
                 }
             }
             console.log('eventResponse.status: ' + status);
+            // console.log('eventBody: ', JSON.stringify(data));
             return res;
         }
         catch (e) {
@@ -145,6 +152,13 @@ class FlexPLMConnect {
     async sendMultipleToFlexPLM(payload) {
         return await this.processRequest(payload);
     }
+    /** Runs a GET request to FlexPLM.
+     * @param params - Optional configuration for the request.
+     * @param params.urlPath - Custom URL path to use instead of the default `/servlet/rest` + endpoint.
+     * @param params.includeUrlContext - Whether to include the urlContext in the URL. Defaults to `true`.
+     * @param params.returnFullResponse - If `true`, returns the raw `Response` object instead of parsed JSON. Defaults to `false`.
+     * @returns The parsed JSON response body, or the raw `Response` object if `returnFullResponse` is `true`.
+     */
     async getRequest(params) {
         const { urlPath, includeUrlContext = true, returnFullResponse = false } = params || {};
         const urlContext = includeUrlContext ? this.config.urlContext : '';

package/lib/util/logger-config.js

@@ -5,6 +5,7 @@ const app_framework_1 = require("@contrail/app-framework");
 async function setLoggerConfig(appConfig) {
     let logLevel = app_framework_1.LogLevel.INFO;
     if (!appConfig.logLevel) {
+        //pass
     }
     else if (appConfig.logLevel === 'error') {
         logLevel = app_framework_1.LogLevel.ERROR;

package/lib/util/map-util-spec-mockData.js

@@ -31,12 +31,26 @@ exports.mapping = {
                 }
             }
         }
+        // flex2vibe: {
+        //   LCSRevisableEntity: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSLast: {
+        //     getMapKey: (object) => {return object;}
+        //   },
+        //   LCSMaterial: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSBusinessObject: {
+        //     getMapKey: (object) => {return object;}
+        //   }
+        // },
     },
     LCSProduct: {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSProduct',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {
@@ -61,7 +75,7 @@ exports.mapping = {
                 vibeIQIdentifier: 'itemNumber'
             },
             valueTransform: {
-                transformEx: (row) => {
+                transformEx: (row /*, dependencies*/) => {
                     return row['otherProp'] + 'xxx';
                 }
             }
@@ -79,7 +93,7 @@ exports.mapping = {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSSKU',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {

package/lib/util/map-utils.d.ts

@@ -1,6 +1,33 @@
 import { MapFileUtil } from '@contrail/transform-data';
 export declare class MapUtil {
+    /** Transforms the data, assumes mapSectionKey has been correctly determined.
+     *
+     * @param transformMapFile id of map file
+     * @param mapFileUtil
+     * @param data
+     * @param mapSectionKey key for section of map file
+     * @param direction vibe2flex or flex2vibe
+     * @param transformTaskOrderKey key for the list of tasks to be processed. default is 'transformOrder'
+     * @returns The converted data
+     */
     static applyTransformMap(transformMapFile: any, mapFileUtil: any, data: any, mapSectionKey: string, direction: string, transformTaskOrderKey?: string): Promise<any>;
+    /** Returns the mapKey based on the 'typeConversion' section of the map file.
+     * If the map file doesn't have a section for the type in question, 'undefined' is returned.
+     *
+     * @param fileId
+     * @param mapFileUtil
+     * @param data The full object
+     * @param type The entity or object class of the object.  The functions are keyed based on this.
+     * @param direction
+     * @returns
+     */
     static getMapKey(transformMapFile: any, mapFileUtil: MapFileUtil, data: any, type: string, direction: string): Promise<string>;
+    /** Returns the full map section with both directions; identifier and informational properties; etc.
+     *
+     * @param transformMapFile id if map file
+     * @param mapFileUtil
+     * @param mapSectionKey key of the map section
+     * @returns
+     */
     static getFullMapSection(transformMapFile: string, mapFileUtil: MapFileUtil, mapSectionKey: string): Promise<any>;
 }