@contrail/flexplm 1.3.0 → 1.3.1-alpha.585afc1

package/src/util/type-conversion-utils.ts

@@ -1,460 +0,0 @@
-import { MapFileUtil, TransformProcessor, TransformTask } from '@contrail/transform-data';
-import { TypeDefaults } from './type-defaults';
-import { MapUtil } from './map-utils';
-
-/** This class is helper functions to get the data for converting
- * VibeIQ entities to / from FlexPLM Objects
-*/
-export class TypeConversionUtils {
-  static NO_ENTITY_TYPE = 'Not able to determine the entity type of the entity object';
-  static VIBE2FLEX_DIRECTION = 'vibe2flex';
-  static FLEX2VIBE_DIRECTION = 'flex2vibe';
-  constructor(){
-  }
-
-  /** Takes in a VibeIQ entity object and returns the correct FlexPLM
-   * object class associated to the entity. Order of precedence
-   * Property 'flexPLMObjectClass'
-   * Map file entry in 'typeConversion:vibe2flex:<value>:getObjectClass()'
-   *  for value from 'entityClass' or root from 'typePath'
-   * TypeDefaults.getDefaultObjectClass() function
-   * @param transformMapFile id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param entity
-   * @returns Promise<string>
-   */
-  static async getObjectClass(transformMapFile, mapFileUtil, entity): Promise<string> {
-    let objectClass = entity['flexPLMObjectClass'];
-
-    if(objectClass){
-      return objectClass;
-    }
-
-    if(transformMapFile){
-      const mapSectionKey = await this.getMapKey(transformMapFile, mapFileUtil, entity, TypeConversionUtils.VIBE2FLEX_DIRECTION);
-      const mapData = await mapFileUtil.getMappingSection(transformMapFile, mapSectionKey, TypeConversionUtils.VIBE2FLEX_DIRECTION);
-      if(mapData['getClass']){
-        objectClass = await mapData['getClass'](entity);
-      }
-    }
-
-    if(objectClass){
-      return objectClass;
-    }
-    return TypeDefaults.getDefaultObjectClass(entity);
-  }
-
-  /** Takes in a VibeIQ entity object and returns the correct FlexPLM
-   * FlexType associated to the entity. Order of precedence
-   * Property 'flexPLMTypePath'
-   * Map file entry in 'typeConversion:vibe2flex:<value>:getSoftType()'
-   *  for value from 'entityClass' or root from 'typePath'
-   * TypeDefaults.getDefaultObjectTypePath() function
-   *
-   * @param transformMapFile id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param entity VibeIQ entity
-   * @returns Promise<string>
-   */
-  static async getObjectTypePath(transformMapFile, mapFileUtil, entity): Promise<string> {
-    let typePath = entity['flexPLMTypePath'];
-
-    if(typePath){
-      return typePath;
-    }
-
-    if(transformMapFile){
-      const mapSectionKey = await this.getMapKey(transformMapFile, mapFileUtil, entity, TypeConversionUtils.VIBE2FLEX_DIRECTION);
-      const mapData = await mapFileUtil.getMappingSection(transformMapFile, mapSectionKey, TypeConversionUtils.VIBE2FLEX_DIRECTION);
-      if(mapData['getSoftType']){
-        typePath = await mapData['getSoftType'](entity);
-      }
-    }
-
-    if(typePath){
-      return typePath;
-    }
-
-    return TypeDefaults.getDefaultObjectTypePath(entity);
-  }
-
-  /**Takes in a VibeIQ entity object and returns the correct
-   * identifier properties.  Order of precedence
-   * Property 'flexPLMIdentifierProperties'
-   * Map file entry in 'typeConversion:vibe2flex:<value>:getIdentifierProperties()'
-   *  for value from 'entityClass' or root from 'typePath'
-   * TypeDefaults.getDefaultIdentifierProperties() function
-   *
-   * @param transformMapFile id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param entity
-   * @returns Promise<string[]>
-   */
-  static async getIdentifierProperties(transformMapFile, mapFileUtil, entity) :Promise<string[]> {
-    let identifiers = entity['flexPLMIdentifierProperties'];
-    if(identifiers){
-      return identifiers
-    }
-
-    if(transformMapFile){
-      const mapKey = await this.getMapKey(transformMapFile, mapFileUtil, entity, TypeConversionUtils.VIBE2FLEX_DIRECTION);
-
-      const mapData = await MapUtil.getFullMapSection(transformMapFile, mapFileUtil, mapKey);
-      if(mapData && mapData['getIdentifierProperties']){
-        identifiers = await mapData['getIdentifierProperties'](entity);
-      }
-    }
-    if(identifiers){
-      return identifiers
-    }
-
-    return TypeDefaults.getDefaultIdentifierProperties(entity);
-  }
-
-    /**Takes in a VibeIQ entity object and returns the correct
-   * informational properties.  Order of precedence
-   * Property 'flexPLMInformationalProperties'
-   * Map file entry in 'typeConversion:vibe2flex:<value>:getInformationalProperties()'
-   *  for value from 'entityClass' or root from 'typePath'
-   * TypeDefaults.getDefaultObjectTypePath() function
-   *
-   * @param transformMapFile id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param entity
-   * @returns string
-   */
-    static async getInformationalProperties(transformMapFile, mapFileUtil, entity) :Promise<string[]> {
-      let identifiers = entity['flexPLMInformationalProperties'];
-      if(identifiers){
-        return identifiers
-      }
-
-      if(transformMapFile){
-        const mapKey = await this.getMapKey(transformMapFile, mapFileUtil, entity, TypeConversionUtils.VIBE2FLEX_DIRECTION);
-        const mapData = await MapUtil.getFullMapSection(transformMapFile, mapFileUtil, mapKey);
-        if(mapData && mapData['getInformationalProperties']){
-          identifiers = await mapData['getInformationalProperties'](entity);
-        }
-      }
-      if(identifiers){
-        return identifiers
-      }
-
-      return TypeDefaults.getDefaultInformationalProperties(entity);
-    }
-
-    /**Takes in a VibeIQ entity object and returns the correct mapKey
-   * Order of precedence:
-   * Map file entry in 'typeConversion:<direction>:<value>:getObjectClass()'
-   *  for value from 'entityClass' or root from 'typePath'
-   * TypeDefaults.getDefaultObjectClass() function
-     *
-     * @param transformMapFile
-     * @param mapFileUtil
-     * @param entity
-     * @param type
-     * @param direction
-     * @returns
-     */
-    static async getMapKey(transformMapFile, mapFileUtil: MapFileUtil, entity: any, direction: string): Promise<string> {
-      if(transformMapFile){
-        const type = this.getEntityType(entity);
-        const mappingData = await mapFileUtil.getMappingSection(transformMapFile, 'typeConversion', direction);
-        if(mappingData && mappingData[type] && mappingData[type]['getMapKey']){
-          const mapKey = await mappingData[type]['getMapKey'](entity);
-          return mapKey;
-        }
-
-      }
-      return TypeDefaults.getDefaultObjectClass(entity);
-  }
-
-  /** Returns the VibeIQ entity type from an entity.
-   * Throws error if it can't determine the entity type
-   *
-   * @param entity
-   * @returns string
-   */
-  static getEntityType(entity: any) {
-    let entityType = entity['entityType'];
-    if (!entityType) {
-      const typePath: string = entity['typePath'];
-      if (typePath) {
-        const types = typePath.split(':');
-        if(types && types[0]){
-          entityType = types[0];
-        }
-      }
-    }
-    if (!entityType) {
-      throw Error(TypeConversionUtils.NO_ENTITY_TYPE);
-    }
-    return entityType;
-  }
-
-  /** Takes in a FlexPLM object and returns the correct VibeIQ entity
-   * class associated to the object. Order of precedence
-   * Property 'vibeIQEntityClass'
-   * Map file entry in 'typeConversion:flex2vibe:<value>:getObjectClass()'
-   *  for value from 'objectClass'
-   * TypeDefaults.getDefaultEntityClass() function
-   *
-   * @param fileId id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param object FlexPLM object
-   * @returns Promise<string>
-   */
-  static async getEntityClassFromObject(fileId, mapFileUtil, object): Promise<string>{
-    let entityClass = object['vibeIQEntityClass'];
-    if (entityClass){
-      return entityClass;
-    }
-
-    if(fileId){
-      const mapSectionKey = await this.getMapKeyFromObject(fileId, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-      const mapData = await mapFileUtil.getMappingSection(fileId, mapSectionKey, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-      if(mapData['getClass']){
-        entityClass = await mapData['getClass'](object);
-      }
-    }
-
-    if(entityClass){
-      return entityClass;
-    }
-    return TypeDefaults.getDefaultEntityClass(object);
-  }
-
-    /** Takes in a FlexPLM object and returns the correct VibeIQ
-   * type associated to the object. Order of precedence
-   * Property 'vibeIQTypePath'
-   * Map file entry in 'typeConversion:flex2vibe:<value>:getSoftType()'
-   *  for value from 'objectClass' or root from 'flexPLMTypePath'
-   * TypeDefaults.getDefaultEntityTypePath() function
-   *
-   * @param transformMapFile id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param entity VibeIQ entity
-   * @returns Promise<string>
-   */
-  static async getEntityTypePathFromOjbect(fileId, mapFileUtil, object): Promise<string>{
-    let typePath = object['vibeIQTypePath'];
-
-    if(typePath){
-      return typePath;
-    }
-
-    if(fileId){
-      const mapSectionKey = await this.getMapKeyFromObject(fileId, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-      const mapData = await mapFileUtil.getMappingSection(fileId, mapSectionKey, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-      if(mapData['getSoftType']){
-        typePath = await mapData['getSoftType'](object);
-      }
-    }
-
-    if(typePath){
-      return typePath;
-    }
-    return TypeDefaults.getDefaultEntityTypePath(object);
-  }
-
-    /**Takes in a FlexPLM object and returns the correct
-   * identifier properties.  Order of precedence
-   * Property 'vibeIQIdentifierProperties'
-   * Map file entry in 'typeConversion:flex2vibe:<value>:getIdentifierProperties()'
-   *  for value from 'objectClass'
-   * TypeDefaults.getDefaultIdentifierPropertiesFromObject() function
-   *
-   * @param transformMapFile id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param object
-   * @returns Promise<string[]>
-   */
-  static async getIdentifierPropertiesFromObject(fileId, mapFileUtil: MapFileUtil, object: any): Promise<string[]>{
-    let identifiers = object['vibeIQIdentifierProperties'];
-    if(identifiers){
-      return identifiers
-    }
-
-    if(fileId){
-      const mapKey = await this.getMapKeyFromObject(fileId, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-
-      const mapData = await MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
-      if(mapData && mapData['getIdentifierProperties']){
-        identifiers = await mapData['getIdentifierProperties'](object);
-      }
-    }
-    if(identifiers){
-      return identifiers
-    }
-
-    return TypeDefaults.getDefaultIdentifierPropertiesFromObject(object);
-  }
-
-      /**Takes in a FlexPLM object and returns the correct
-   * identifier properties.  Order of precedence
-   * Property 'vibeIQIdentifierProperties'
-   * Map file entry in 'typeConversion:flex2vibe:<value>:getInformationalProperties()'
-   *  for value from 'objectClass'
-   * TypeDefaults.getDefaultIdentifierPropertiesFromObject() function
-   *
-   * @param transformMapFile id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param object
-   * @returns Promise<string[]>
-   */
-  static async getInformationalPropertiesFromObject(fileId, mapFileUtil: MapFileUtil, object: any): Promise<string[]>{
-    let identifiers = object['vibeIQInformationalProperties'];
-    if(identifiers){
-      return identifiers
-    }
-
-    if(fileId){
-      const mapKey = await this.getMapKeyFromObject(fileId, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-
-      const mapData = await MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
-      if(mapData && mapData['getInformationalProperties']){
-        identifiers = await mapData['getInformationalProperties'](object);
-      }
-    }
-    if(identifiers){
-      return identifiers
-    }
-
-    return TypeDefaults.getDefaultInformationalPropertiesFromObject(object);
-  }
-
-  static async getMapKeyFromObject(fileId, mapFileUtil: MapFileUtil, object: any, direction:string): Promise<string | undefined> {
-    const type = this.getObjectType(object);
-    if(fileId){
-      const mappingData = await mapFileUtil.getMappingSection(fileId, 'typeConversion', direction);
-      if(mappingData && mappingData[type] && mappingData[type]['getMapKey']){
-        const mapKey = await mappingData[type]['getMapKey'](object);
-        return mapKey;
-      }
-      return type;
-    }
-    //TODO use TypeDefaults?
-  }
-
-  static async isInboundCreatableFromObject(fileId: string, mapFileUtil: MapFileUtil, object: any, context?: any): Promise<boolean> {
-
-    let isInboundCreatable = false;
-    if(fileId){
-      const mapKey = await this.getMapKeyFromObject(fileId, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-
-      const mapData = await MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
-      if(mapData && mapData['isInboundCreatable']){
-        isInboundCreatable = await mapData['isInboundCreatable'](object, context);
-      }
-    }
-
-    return isInboundCreatable;
-  }
-
-  static async isOutboundCreatableFromEntity(fileId: string, mapFileUtil: MapFileUtil, entity: any, context?: any): Promise<boolean> {
-
-    let isOutboundCreatable = true;
-
-    if (!fileId) {
-      return isOutboundCreatable;
-    }
-
-    let mapKey: string | undefined;
-    try {
-      mapKey = await this.getMapKey(fileId, mapFileUtil, entity, TypeConversionUtils.VIBE2FLEX_DIRECTION);
-    } catch {
-      return isOutboundCreatable;
-    }
-
-    if (!mapKey) {
-      return isOutboundCreatable;
-    }
-
-    const mapData = await MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
-    if (mapData && mapData['isOutboundCreatable']) {
-      isOutboundCreatable = await mapData['isOutboundCreatable'](entity, context);
-    }
-    return isOutboundCreatable;
-  }
-
-  /** 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.
-   * Map file entry in '<mapKey>:syncInboundImages()'
-   *
-   * @param fileId id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param object FlexPLM object
-   * @param context optional context object
-   * @returns Promise<boolean>
-   */
-  static async syncInboundImages(fileId: string, mapFileUtil: MapFileUtil, object: any, context?: any): Promise<boolean> {
-
-    let syncImages = false;
-
-    if (!fileId) {
-      return syncImages;
-    }
-
-    let mapKey: string | undefined;
-    try {
-      mapKey = await this.getMapKeyFromObject(fileId, mapFileUtil, object, TypeConversionUtils.FLEX2VIBE_DIRECTION);
-    } catch {
-      return syncImages;
-    }
-
-    if (!mapKey) {
-      return syncImages;
-    }
-
-    const mapData = await MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
-    if (mapData && mapData['syncInboundImages']) {
-      syncImages = await mapData['syncInboundImages'](object, context);
-    }
-    return syncImages;
-  }
-
-  /** Takes in a VibeIQ entity object and determines whether outbound
-   * images should be synced. In most cases, the creation owning system
-   * will also control image syncing. Defaults to true if no mapping exists.
-   * Map file entry in '<mapKey>:syncOutboundImages()'
-   *
-   * @param fileId id for mapFile
-   * @param mapFileUtil class to get mapfile
-   * @param entity VibeIQ entity
-   * @param context optional context object
-   * @returns Promise<boolean>
-   */
-  static async syncOutboundImages(fileId: string, mapFileUtil: MapFileUtil, entity: any, context?: any): Promise<boolean> {
-
-    let syncImages = true;
-
-    if (!fileId) {
-      return syncImages;
-    }
-
-    let mapKey: string | undefined;
-    try {
-      mapKey = await this.getMapKey(fileId, mapFileUtil, entity, TypeConversionUtils.VIBE2FLEX_DIRECTION);
-    } catch {
-      return syncImages;
-    }
-
-    if (!mapKey) {
-      return syncImages;
-    }
-
-    const mapData = await MapUtil.getFullMapSection(fileId, mapFileUtil, mapKey);
-    if (mapData && mapData['syncOutboundImages']) {
-      syncImages = await mapData['syncOutboundImages'](entity, context);
-    }
-    return syncImages;
-  }
-
-  static getObjectType(object:any) {
-    let objectType = object['flexPLMObjectClass'];
-    return objectType;
-  }
-
-
-}