@contrail/flexplm 1.1.22 → 1.1.23

package/lib/util/data-converter.d.ts

@@ -20,6 +20,9 @@ export declare class DataConverter {
     getEntityValue(prop: any, data: any): Promise<any>;
     setEnumerationKeys(prop: any, nd: any, matchByDisplay: any): any;
     getPersistableChanges(entity: object, changes: object): object;
+    setObjectReferenceValue(prop: any, nd: any): Promise<any>;
+    getAllObjectReferences(entityType: any, rootTypeCriteria: any): Promise<any[]>;
+    checkKeysAndValues(criteria: any, arrayOfObjects: any, entityTypePath: any): any[];
     setUserListValue(prop: any, nd: any): Promise<any>;
     getUserByEmail(nd: any): Promise<any>;
     processGroupMemberCheck(prop: any, userEmail: any): Promise<void>;

package/lib/util/data-converter.js

@@ -201,7 +201,7 @@ class DataConverter {
             const propertyType = prop['propertyType'];
             const slug = prop['slug'];
             let keyName = slug;
-            if (propertyType === 'userList') {
+            if (propertyType === 'userList' || propertyType === 'object_reference') {
                 keyName = slug + 'Id';
             }
             entity[keyName] = await this.getEntityValue(prop, data);
@@ -262,6 +262,7 @@ class DataConverter {
             value = this.setEnumerationKeys(prop, nd, this.useDisplayForEnumerationMatching);
         }
         else if ('object_reference' === propertyType) {
+            value = await this.setObjectReferenceValue(prop, nd);
         }
         else if ('image' === propertyType) {
         }
@@ -321,6 +322,94 @@ class DataConverter {
         }
         return diffValues;
     }
+    async setObjectReferenceValue(prop, nd) {
+        let objectReferenceId = "";
+        if (!nd) {
+            return objectReferenceId;
+        }
+        const entityType = prop['referencedTypeRootSlug'];
+        const entityTypePath = prop['referencedTypePath'];
+        const entityKeys = Object.keys(nd);
+        const identifierKeys = await type_conversion_utils_1.TypeConversionUtils.getIdentifierPropertiesFromObject(this.transformMapFile, this.mapFileUtil, nd);
+        const hasAllIdentifiers = identifierKeys.every(key => entityKeys.includes(key));
+        if (identifierKeys.length == 0 || !hasAllIdentifiers) {
+            console.warn(`The inbound ${entityType} doesnt have all "identifier properties, so there is no processing. Identifier properties: ${identifierKeys}`);
+            return objectReferenceId;
+        }
+        const rootType = await this.typeUtils.getByRootAndPath({ root: entityType });
+        const rootTypeProps = this.typeUtils.filterTypeProperties(rootType, nd);
+        let rootTypeCriteria = {};
+        let typeCriteria = {};
+        identifierKeys.forEach(keyName => {
+            const foundInObjects = rootTypeProps.some(obj => obj.slug === keyName);
+            if (foundInObjects) {
+                rootTypeCriteria[keyName] = nd[keyName];
+            }
+            else {
+                typeCriteria[keyName] = nd[keyName];
+            }
+        });
+        const combinedCriteria = { ...rootTypeCriteria, ...typeCriteria, typePath: entityTypePath };
+        const cacheKey = Object.values(combinedCriteria).join('_');
+        if (this.objRefCache[cacheKey]) {
+            if (app_framework_1.Logger.isDebugOn()) {
+                console.debug(`object reference cache hit: ${cacheKey}`);
+            }
+            return this.objRefCache[cacheKey];
+        }
+        let arrObjectReferences = await this.getAllObjectReferences(entityType, rootTypeCriteria);
+        if (entityType !== entityTypePath) {
+            arrObjectReferences = this.checkKeysAndValues(typeCriteria, arrObjectReferences, entityTypePath);
+        }
+        if (arrObjectReferences.length) {
+            if (arrObjectReferences.length === 1) {
+                objectReferenceId = arrObjectReferences[0].id;
+            }
+            else {
+                console.warn(`The passed in object reference criteria has duplicate records found ${JSON.stringify(combinedCriteria)}.`);
+            }
+        }
+        if (!objectReferenceId) {
+            console.warn(`The passed in object reference criteria ${JSON.stringify(combinedCriteria)} not found.`);
+            return objectReferenceId;
+        }
+        this.objRefCache[cacheKey] = objectReferenceId;
+        return objectReferenceId;
+    }
+    async getAllObjectReferences(entityType, rootTypeCriteria) {
+        let loads = [];
+        let nextPageKey;
+        do {
+            const loadPage = await new sdk_1.Entities().get({ entityName: entityType, criteria: rootTypeCriteria, apiVersion: sdk_1.API_VERSION.V2, nextPageKey });
+            nextPageKey = loadPage.nextPageKey;
+            loads.push(...loadPage.results);
+        } while (nextPageKey);
+        return loads;
+    }
+    checkKeysAndValues(criteria, arrayOfObjects, entityTypePath) {
+        let arrOfMatchObjects = [];
+        for (let i = 0; i < arrayOfObjects.length; i++) {
+            const currentObj = arrayOfObjects[i];
+            let found = true;
+            if (entityTypePath && currentObj['typePath']) {
+                const currentObjPath = '' + currentObj['typePath'];
+                if (!currentObjPath.startsWith(entityTypePath)) {
+                    found = false;
+                    break;
+                }
+            }
+            for (const key in criteria) {
+                if (!(key in currentObj) || currentObj[key] !== criteria[key]) {
+                    found = false;
+                    break;
+                }
+            }
+            if (found) {
+                arrOfMatchObjects.push(currentObj);
+            }
+        }
+        return arrOfMatchObjects;
+    }
     async setUserListValue(prop, nd) {
         if (!nd?.email) {
             return "";

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

@@ -589,3 +589,66 @@ describe('setEnumerationKeys', () => {
         expect(returnValue).toEqual([]);
     });
 });
+describe('checkKeysAndValues', () => {
+    const config = {
+        apiHost: 'host',
+        userName: () => 'user',
+        password: () => 'pass',
+        urlContext: 'xxx',
+        vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
+        csrfEndpoint: '/servlet/rest/security/csrf',
+        itemPreDevelopmentLifecycleStages: ['concept']
+    };
+    const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
+    const dc = new data_converter_1.DataConverter(config, mapFileUtil);
+    const groupData = [
+        { name: 'Group 1', typePath: 'custom-entity:grouping' },
+        { name: 'Group 2', typePath: 'custom-entity:grouping' },
+        { name: 'Group 2', typePath: 'custom-entity:grouping' },
+        { name: 'Group 4', typePath: 'custom-entity:grouping' },
+        { name: 'Group 4', typePath: 'custom-entity:grouping:sub' },
+        { name: 'Group 5', typePath: 'custom-entity:grouping:sub' }
+    ];
+    it('Group 1', () => {
+        const criteria = {
+            name: 'Group 1'
+        };
+        const typePath = 'custom-entity:grouping';
+        const results = dc.checkKeysAndValues(criteria, groupData, typePath);
+        expect(results.length).toBe(1);
+    });
+    it('Group 5 - sub type of typePath', () => {
+        const criteria = {
+            name: 'Group 5'
+        };
+        const typePath = 'custom-entity:grouping';
+        const results = dc.checkKeysAndValues(criteria, groupData, typePath);
+        expect(results.length).toBe(1);
+    });
+    it('Group 2 - returns the 2 matching', () => {
+        const criteria = {
+            name: 'Group 2'
+        };
+        const typePath = 'custom-entity:grouping';
+        const results = dc.checkKeysAndValues(criteria, groupData, typePath);
+        expect(results.length).toBe(2);
+    });
+    it('2 Same Name - but 1 is a sub type; returns 2', () => {
+        const criteria = {
+            name: 'Group 4'
+        };
+        const typePath = 'custom-entity:grouping';
+        const results = dc.checkKeysAndValues(criteria, groupData, typePath);
+        expect(results.length).toBe(2);
+    });
+    it('2 Same Name - but 1 wrong type', () => {
+        const criteria = {
+            name: 'Group 1'
+        };
+        const testData = [...groupData];
+        testData.push({ name: 'Group 1', typePath: 'custom-entity:label' });
+        const typePath = 'custom-entity:grouping';
+        const results = dc.checkKeysAndValues(criteria, testData, typePath);
+        expect(results.length).toBe(1);
+    });
+});

package/package.json

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

package/src/util/data-converter.spec.ts

@@ -869,4 +869,75 @@ describe('setEnumerationKeys', () =>{
     expect(returnValue).toEqual([]);
   });
 
+});
+
+describe('checkKeysAndValues', () =>{
+  const config: FCConfig = {
+    apiHost: 'host',
+    userName: () => 'user',
+    password: () => 'pass',
+    urlContext: 'xxx',
+    vibeEventEndpoint: '/rfa/vibeiq/vibeEvents',
+    csrfEndpoint: '/servlet/rest/security/csrf',
+    itemPreDevelopmentLifecycleStages: ['concept']
+  };
+
+  const mapFileUtil = new MapFileUtil(new Entities());
+  const dc = new DataConverter(config, mapFileUtil);
+  const groupData = [
+    {name: 'Group 1', typePath: 'custom-entity:grouping'},
+    {name: 'Group 2', typePath: 'custom-entity:grouping'},
+    {name: 'Group 2', typePath: 'custom-entity:grouping'},
+    {name: 'Group 4', typePath: 'custom-entity:grouping'},
+    {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'
+    }
+    const typePath = 'custom-entity:grouping';
+    const results = dc.checkKeysAndValues(criteria, groupData, typePath);
+    expect(results.length).toBe(1);
+  });
+
+  it('Group 5 - sub type of typePath', () =>{
+    const criteria = {
+      name: 'Group 5'
+    }
+    const typePath = 'custom-entity:grouping';
+    const results = dc.checkKeysAndValues(criteria, groupData, typePath);
+    expect(results.length).toBe(1);
+  });
+  it('Group 2 - returns the 2 matching', () =>{
+    const criteria = {
+      name: 'Group 2'
+    }
+    const typePath = 'custom-entity:grouping';
+    const results = dc.checkKeysAndValues(criteria, groupData, typePath);
+    expect(results.length).toBe(2);
+  });
+
+  it('2 Same Name - but 1 is a sub type; returns 2', () =>{
+    const criteria = {
+      name: 'Group 4'
+    }
+    const typePath = 'custom-entity:grouping';
+    const results = dc.checkKeysAndValues(criteria, groupData, typePath);
+    expect(results.length).toBe(2);
+  });
+
+  it('2 Same Name - but 1 wrong type', () =>{
+    const criteria = {
+      name: 'Group 1'
+    }
+    const testData =[...groupData];
+    testData.push({name: 'Group 1', typePath: 'custom-entity:label'});
+    const typePath = 'custom-entity:grouping';
+    const results = dc.checkKeysAndValues(criteria, testData, typePath);
+    expect(results.length).toBe(1);
+  });
+
 });

package/src/util/data-converter.ts

@@ -1,4 +1,4 @@
-import { Entities, TypeClientOptions } from '@contrail/sdk';
+import { API_VERSION, Entities, TypeClientOptions } from '@contrail/sdk';
 import { TypeUtils } from './type-utils';
 import { FCConfig } from '../interfaces/interfaces';
 import { MapFileUtil } from '@contrail/transform-data';
@@ -240,7 +240,7 @@ export class DataConverter {
       const propertyType = prop['propertyType'];
       const slug = prop['slug'];
       let keyName = slug;
-      if(propertyType === 'userList') {
+      if (propertyType === 'userList' || propertyType === 'object_reference') {
           keyName = slug + 'Id';
       }
       entity[keyName] = await this.getEntityValue(prop, data);
@@ -323,8 +323,7 @@ export class DataConverter {
       value = this.setEnumerationKeys(prop, nd, this.useDisplayForEnumerationMatching);
 
     } else if ('object_reference' === propertyType) {
-      //TODO write code
-      //use referencedTypeRootSlug to get the entity type
+      value = await this.setObjectReferenceValue(prop, nd);
     } else if ('image' === propertyType) {
       // console.log('TODO-image');
     } else if ('formula' === propertyType) {
@@ -395,6 +394,129 @@ export class DataConverter {
 
   }
 
+  /** Sets object reference value from FlexPLM data passed in
+   * 
+   * @param prop the VibeIQ property
+   * @param nd the VibeIQ data
+   * @returns the object reference id from VibeIQ
+   */
+  async setObjectReferenceValue(prop, nd) {
+    let objectReferenceId = "";
+    if(!nd) {
+      return objectReferenceId;
+    }
+
+    const entityType = prop['referencedTypeRootSlug'];
+    const entityTypePath = prop['referencedTypePath'];
+    const entityKeys = Object.keys(nd);
+    const identifierKeys = await TypeConversionUtils.getIdentifierPropertiesFromObject(this.transformMapFile, this.mapFileUtil, nd)
+    const hasAllIdentifiers = identifierKeys.every(key => entityKeys.includes(key));
+    if(identifierKeys.length == 0 || !hasAllIdentifiers){
+      console.warn(`The inbound ${entityType} doesnt have all "identifier properties, so there is no processing. Identifier properties: ${identifierKeys}`);
+      return objectReferenceId;
+    }
+    
+    const rootType = await this.typeUtils.getByRootAndPath({root: entityType});
+    const rootTypeProps = this.typeUtils.filterTypeProperties(rootType, nd);
+
+    let rootTypeCriteria = {};
+    let typeCriteria = { };
+    identifierKeys.forEach(keyName => {
+      const foundInObjects = rootTypeProps.some(obj => obj.slug === keyName);
+      if (foundInObjects) {
+        rootTypeCriteria[keyName] = nd[keyName];
+      } else {
+        typeCriteria[keyName] = nd[keyName];
+      }
+    });
+
+    const combinedCriteria = { ...rootTypeCriteria, ...typeCriteria, typePath: entityTypePath };
+    const cacheKey = Object.values(combinedCriteria).join('_');
+
+    if (this.objRefCache[cacheKey]) {
+      if (Logger.isDebugOn()) {
+        console.debug(`object reference cache hit: ${cacheKey}`);
+      }
+      return this.objRefCache[cacheKey];
+    }
+
+    let arrObjectReferences = await this.getAllObjectReferences(entityType, rootTypeCriteria);
+    if(entityType !== entityTypePath) {
+      arrObjectReferences = this.checkKeysAndValues(typeCriteria, arrObjectReferences, entityTypePath);
+    }
+
+    if(arrObjectReferences.length) {
+      if(arrObjectReferences.length === 1) {
+        objectReferenceId = arrObjectReferences[0].id;
+      } else {
+        console.warn(`The passed in object reference criteria has duplicate records found ${JSON.stringify(combinedCriteria)}.`);
+      }
+    }
+
+    if (!objectReferenceId) {
+      console.warn(`The passed in object reference criteria ${JSON.stringify(combinedCriteria)} not found.`);
+      return objectReferenceId;
+    }
+
+    this.objRefCache[cacheKey] = objectReferenceId;
+
+    return objectReferenceId;
+  }
+
+  /**
+   * Retrieves all object references of a specified entity type based on the provided criteria.
+   * This function handles pagination and asynchronously fetches object references until there are no more pages.
+   * @param {string} entityType - The type of entity for which object references are to be retrieved.
+   * @param {object} rootTypeCriteria - The criteria used to filter object references.
+   * @returns {Promise<Array>} A Promise that resolves to an array containing all object references.
+   */
+  async getAllObjectReferences(entityType, rootTypeCriteria) {
+    let loads = []
+    let nextPageKey;
+    do {
+      const loadPage = await new Entities().get({ entityName: entityType, criteria: rootTypeCriteria, apiVersion: API_VERSION.V2, nextPageKey })
+      nextPageKey = loadPage.nextPageKey;
+      loads.push(...loadPage.results);
+    } while (nextPageKey);
+    return loads;
+  }
+  
+  /**
+   * Checks if all keys and values of a given object are present in an array of objects.
+   * @param {Object} criteria - The object whose keys and values are to be checked in the array of objects.
+   * @param {Array<Object>} arrayOfObjects - The array of objects to be searched for matching keys and values.
+   * @param {string} entityTypePath - The type / subtype for the property; objects must be this type or a sub type of it.
+   * @returns {(Object|boolean)} Returns the array of objects that matches all keys and values of the provided object.
+   *                             If no match is found, returns empty array.
+   */
+  checkKeysAndValues(criteria, arrayOfObjects, entityTypePath) {
+    let arrOfMatchObjects = [];
+    for (let i = 0; i < arrayOfObjects.length; i++) {
+      const currentObj = arrayOfObjects[i];
+      let found = true;
+  
+      if(entityTypePath && currentObj['typePath']){
+        const currentObjPath = '' + currentObj['typePath'];
+        if(!currentObjPath.startsWith(entityTypePath)){
+          found = false;
+          break;
+        }
+      }
+      for (const key in criteria) {
+        if (!(key in currentObj) || currentObj[key] !== criteria[key]) {
+          found = false;
+          break;
+        }
+      }
+  
+      if (found) {
+        arrOfMatchObjects.push(currentObj);
+      }
+    }
+
+    return arrOfMatchObjects;
+  }
+
   /** Sets userListId value from FlexPLM data passed in
    * 
    * @param prop the VibeIQ property