@contrail/flexplm 1.3.1-alpha.763fca8 → 1.3.1-alpha.8bc920d

package/lib/util/type-defaults.js

@@ -4,12 +4,6 @@ exports.TypeDefaults = void 0;
 class TypeDefaults {
     constructor() {
     }
-    /**Takes in full entity and returs the default FlexPLM
-     * object class.
-     *
-     * @param entity
-     * @returns string
-     */
     static getDefaultObjectClass(entity) {
         const entityType = this.getEntityType(entity);
         let objectClass = '';
@@ -48,12 +42,6 @@ class TypeDefaults {
         }
         return objectClass;
     }
-    /**Takes in full entity and returns the default FlexPLM type path
-     * object class.
-     *
-     * @param entity
-     * @returns string
-     */
     static getDefaultObjectTypePath(entity) {
         let typePath = '';
         const entityType = this.getEntityType(entity);
@@ -82,13 +70,6 @@ class TypeDefaults {
         }
         return typePath;
     }
-    /**Takes in full entity and returns the slugs for the default identifier
-     *  properties. These properties are used when searching for an entity
-     * object class.
-     *
-     * @param entity
-     * @returns string[]
-     */
     static getDefaultIdentifierProperties(entity) {
         const identifierProps = [];
         const entityType = this.getEntityType(entity);
@@ -114,13 +95,6 @@ class TypeDefaults {
         }
         return identifierProps;
     }
-    /** Takes in full entity and returns the slugs for informational
-     * properties.  These properties are helpful when debugging issues
-     * where the identifier properties don't find a match.
-     *
-     * @param entity
-     * @returns string[]
-     */
     static getDefaultInformationalProperties(entity) {
         const entityType = this.getEntityType(entity);
         let properties = [];
@@ -137,12 +111,6 @@ class TypeDefaults {
         }
         return properties;
     }
-    /** 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) {
         let entityType = entity['entityType'];
         if (!entityType) {
@@ -159,12 +127,6 @@ class TypeDefaults {
         }
         return entityType;
     }
-    /**Takes in full object and returns the default VibeIQ
-   * entity class.
-   *
-   * @param entity
-   * @returns string
-   */
     static getDefaultEntityClass(object) {
         let entityClass = '';
         let objectClass = TypeDefaults.getObjectClass(object);
@@ -187,12 +149,6 @@ class TypeDefaults {
             throw Error(TypeDefaults.NO_OBJECT_CLASS);
         return entityClass;
     }
-    /**Takes in full object and returns the default VibeIQ type path
-   * object class.
-   *
-   * @param object
-   * @returns string
-   */
     static getDefaultEntityTypePath(object) {
         let typePath = '';
         const objectClass = TypeDefaults.getObjectClass(object);
@@ -217,13 +173,6 @@ class TypeDefaults {
             throw Error(TypeDefaults.NO_TYPE_PATH);
         return typePath;
     }
-    /**Takes in full entity and returns the slugs for the default identifier
- *  properties. These properties are used when searching for an entity
- * object class.
- *
- * @param entity
- * @returns string[]
- */
     static getDefaultIdentifierPropertiesFromObject(object) {
         const identifierProps = [];
         const objectClass = TypeDefaults.getObjectClass(object);
@@ -248,13 +197,6 @@ class TypeDefaults {
         }
         return identifierProps;
     }
-    /** Takes in full object and returns the slugs for informational
-   * properties.  These properties are helpful when debugging issues
-   * where the identifier properties don't find a match.
-   *
-   * @param object
-   * @returns string[]
-   */
     static getDefaultInformationalPropertiesFromObject(object) {
         const objectClass = TypeDefaults.getObjectClass(object);
         let properties = [];

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

@@ -304,7 +304,7 @@ describe('Type Defaults', () => {
             expect(() => type_defaults_1.TypeDefaults.getEntityType(entity)).toThrowError();
             expect(() => type_defaults_1.TypeDefaults.getEntityType(entity)).toThrow(type_defaults_1.TypeDefaults.NO_ENTITY_TYPE);
         });
-    }); //getEntityType
+    });
     describe('getDefaultEntityClass', () => {
         it('item - LCSProduct', () => {
             const object = {
@@ -369,7 +369,7 @@ describe('Type Defaults', () => {
             const entityClass = type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
             expect(entityClass).toBe('custom-entity');
         });
-    }); //getDefaultEntityClass
+    });
     describe('getDefaultEntityTypePath', () => {
         it('LCSProduct', () => {
             const object = {
@@ -420,7 +420,7 @@ describe('Type Defaults', () => {
             const typePath = type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object);
             expect(typePath).toBe('assortment');
         });
-    }); //getDefaultEntityTypePath
+    });
     describe('getDefaultIdentifierPropertiesFromObject', () => {
         it('LCSProduct', () => {
             const object = {
@@ -478,7 +478,7 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-    }); //getDefaultIdentifierPropertiesFromObject
+    });
     describe('getDefaultInformationalPropertiesFromObject', () => {
         it('LCSProduct', () => {
             const object = {
@@ -512,5 +512,5 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-    }); //getDefaultInformationalPropertiesFromObject
+    });
 });

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

@@ -5,30 +5,9 @@ export declare class TypeUtils {
     constructor();
     getTypeById(id: any): Promise<import("@contrail/types").Type>;
     getByRootAndPath(options: TypeClientOptions): Promise<import("@contrail/types").Type>;
-    /** Deprecated: use TypeConversionUtils.getObjectTypePath() */
     static getFlexPLMTypePath(entity: any): any;
-    /**  Deprecated: use TypeConversionUtils.getObjectClass()
-     *
-     * @param entityType
-     * @param newData
-     * @returns
-     */
     getEventObjectClass(entityType: string, newData: any): string;
-    /** Gets the VibeIQ entity type for the object data
-     * @param data: object data
-     */
     getEntityTypeClientOptionsUsingMapping(transformMapFile: any, mapFileUtil: any, data: any): Promise<TypeClientOptions>;
-    /** Gets the VibeIQ entity type for the object data
-     * @param objectClass: string object class
-     * @param data: object data
-     */
     getEntityTypeClientOptions(objectClass: string, data: any): TypeClientOptions;
-    /** This will filter the properties based the newData entity.
-     * It is assumed the type is correct for the entity
-     *
-     * @param type entire type object
-     * @param newData the entity being processed
-     * @returns TypeProperty[] of applicable properties
-     */
     filterTypeProperties(type: any, newData: any): TypeProperty[];
 }

package/lib/util/type-utils.js

@@ -9,7 +9,6 @@ class TypeUtils {
         this.typesObj = new sdk_1.Types();
     }
     async getTypeById(id) {
-        // this.logger.log('!-getTypeById: ' + id);
         const type = await this.typesObj.getType({
             id,
             relations: ['typeProperties', 'typeInterfaces']
@@ -20,16 +19,9 @@ class TypeUtils {
         const type = await this.typesObj.getByRootAndPath(options);
         return type;
     }
-    /** Deprecated: use TypeConversionUtils.getObjectTypePath() */
     static getFlexPLMTypePath(entity) {
         return entity['flexPLMTypePath'] || entity['flexTypePath'] || '';
     }
-    /**  Deprecated: use TypeConversionUtils.getObjectClass()
-     *
-     * @param entityType
-     * @param newData
-     * @returns
-     */
     getEventObjectClass(entityType, newData) {
         let objectClass = '';
         if ('item' === entityType) {
@@ -56,9 +48,6 @@ class TypeUtils {
         }
         return objectClass;
     }
-    /** Gets the VibeIQ entity type for the object data
-     * @param data: object data
-     */
     async getEntityTypeClientOptionsUsingMapping(transformMapFile, mapFileUtil, data) {
         const root = await type_conversion_utils_1.TypeConversionUtils.getEntityClassFromObject(transformMapFile, mapFileUtil, data);
         const path = await type_conversion_utils_1.TypeConversionUtils.getEntityTypePathFromOjbect(transformMapFile, mapFileUtil, data);
@@ -68,10 +57,6 @@ class TypeUtils {
         };
         return tco;
     }
-    /** Gets the VibeIQ entity type for the object data
-     * @param objectClass: string object class
-     * @param data: object data
-     */
     getEntityTypeClientOptions(objectClass, data) {
         let tco;
         if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
@@ -90,7 +75,6 @@ class TypeUtils {
             };
         }
         else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
-            //TODO need to write logic using mapping file
             tco = {
                 root: 'custom-entity'
             };
@@ -98,13 +82,6 @@ class TypeUtils {
         }
         return tco;
     }
-    /** This will filter the properties based the newData entity.
-     * It is assumed the type is correct for the entity
-     *
-     * @param type entire type object
-     * @param newData the entity being processed
-     * @returns TypeProperty[] of applicable properties
-     */
     filterTypeProperties(type, newData) {
         let filteredProps = type['typeProperties'];
         const typePath = type['typePath'];

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

@@ -103,7 +103,6 @@ describe('filterProperties-item', () => {
         expect(filteredProps.length).toEqual(len);
     });
 });
-//project-item
 describe('filterProperties-project-item', () => {
     const projectItemType = {
         typePath: 'project-item'
@@ -153,7 +152,6 @@ describe('filterProperties-project-item', () => {
         expect(filteredProps.length).toEqual(len);
     });
 });
-//color
 describe('filterProperties-color', () => {
     const colorType = {
         typePath: 'color'

package/package.json

@@ -1,18 +1,11 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.3.1-alpha.763fca8",
+  "version": "1.3.1-alpha.8bc920d",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
-  "bin": {
-    "flexplm-mapping": "lib/cli/index.js"
-  },
-  "files": [
-    "lib/**/*",
-    "scripts/copy-template.js"
-  ],
   "scripts": {
-    "build": "tsc && node scripts/copy-template.js",
+    "build": "tsc",
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "tslint -p tsconfig.json",
     "test": "jest",
@@ -32,14 +25,6 @@
     "tslint-config-prettier": "^1.18.0",
     "typescript": "^4.0.0"
   },
-  "peerDependencies": {
-    "typescript": ">=4.0.0"
-  },
-  "peerDependenciesMeta": {
-    "typescript": {
-      "optional": true
-    }
-  },
   "jest": {
     "moduleFileExtensions": [
       "js",
@@ -55,10 +40,10 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "@contrail/app-framework": "^2.0.0",
-    "@contrail/sdk": "^1.5.10",
-    "@contrail/transform-data": "^1.3.2-alpha.fd132c3",
-    "@contrail/util": "^1.3.1",
+    "@contrail/app-framework": "^1.3.4",
+    "@contrail/sdk": "^1.4.3",
+    "@contrail/transform-data": "^1.1.3",
+    "@contrail/util": "^1.0.48",
     "axios": "^1.4.0",
     "p-limit": "^3.1.0"
   }

package/publish.bat

@@ -0,0 +1,5 @@
+rd /s /q lib
+call npm install
+call npm run build
+call npm version patch
+call npm publish

package/publish.sh

@@ -0,0 +1,5 @@
+rm -rf lib;
+npm install;
+npm run build;
+npm version patch;
+npm publish;