@contrail/flexplm 1.2.1 → 1.3.0-alpha.3

package/src/util/type-utils.ts

@@ -1,144 +1,144 @@
-import { Logger } from '@contrail/app-framework';
-import { TypeClientOptions, Types } from '@contrail/sdk';
-import { TypeProperty } from '@contrail/types';
-import { TypeConversionUtils } from './type-conversion-utils';
-
-export class TypeUtils {
-  private typesObj: Types;
-  constructor() {
-    this.typesObj = new Types();
-  }
-
-  async getTypeById(id) {
-    // this.logger.log('!-getTypeById: ' + id);
-    const type = await this.typesObj.getType({
-      id,
-      relations: ['typeProperties', 'typeInterfaces']
-    });
-    return type;
-  }
-
-  async getByRootAndPath(options: TypeClientOptions) {
-    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: string, newData): string {
-    let objectClass = '';
-    if ('item' === entityType) {
-      if (newData.roles.includes('family')) {
-        objectClass = 'LCSProduct';
-      } else if (newData.roles.includes('color')) {
-        objectClass = 'LCSSKU';
-      }
-    } else if ('project-item' === entityType) {
-      if (newData.roles.includes('family')) {
-        objectClass = 'LCSProductSeasonLink';
-      } else if (newData.roles.includes('color')) {
-        objectClass = 'LCSSKUSeasonLink';
-      }
-    } else if ('color' === entityType) {
-      objectClass = 'LCSColor';
-    } else if ('custom-entity' === entityType) {
-      objectClass = 'LCSRevisableEntity';
-
-    }
-    return objectClass;
-  }
-
-  /** Gets the VibeIQ entity type for the object data
-   * @param data: object data
-   */
-  async getEntityTypeClientOptionsUsingMapping(transformMapFile, mapFileUtil, data): Promise<TypeClientOptions> {
-    const root = await TypeConversionUtils.getEntityClassFromObject(transformMapFile, mapFileUtil, data);
-    const path = await TypeConversionUtils.getEntityTypePathFromOjbect(transformMapFile, mapFileUtil, data);
-
-    let tco: TypeClientOptions = {
-      root,
-      path
-    };
-
-
-
-    return tco;
-  }
-
-  /** Gets the VibeIQ entity type for the object data
-   * @param objectClass: string object class
-   * @param data: object data
-   */
-  getEntityTypeClientOptions(objectClass: string, data): TypeClientOptions {
-    let tco: TypeClientOptions;
-    if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
-      tco = {
-        root: 'item'
-      };
-    } else if ('LCSSeason' === objectClass) {
-      tco = {
-        root: 'assortment'
-      };
-    } else if ('LCSColor' === objectClass) {
-      tco = {
-        root: 'color'
-      };
-    } else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
-      //TODO need to write logic using mapping file
-      tco = {
-        root: 'custom-entity'
-      };
-      console.log('data: ' + data);
-    }
-
-    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): TypeProperty[] {
-    let filteredProps: TypeProperty[] = type['typeProperties'];
-    const typePath = type['typePath'];
-    const roles = newData['roles'];
-    if (typePath && (typePath.startsWith('item') || typePath.startsWith('project-item'))) {
-      if (Logger.isDebugOn()) {
-        console.debug('filterTypeProperties():id: ' +newData?.id
-          + ', typePath: ' + typePath
-          + ', newData.roles: ' + newData?.roles);
-      }
-      if (roles) {
-        const isFamily = roles.includes('family');
-        if (Logger.isDebugOn()) {
-          console.debug('isFamily: ' + isFamily);
-        }
-
-        filteredProps = filteredProps.filter(prop => {
-          const propertyLevel = prop.propertyLevel;
-          const applies =
-            (isFamily && 'option' != propertyLevel) ||
-            (!isFamily && 'family' != propertyLevel);
-          return applies;
-        });
-
-      } else {
-        console.error('filterTypeProperties():Entity missing role-id: ' + newData['id']);
-      }
-    }
-
-    return filteredProps;
-  }
-
-}
+import { Logger } from '@contrail/app-framework';
+import { TypeClientOptions, Types } from '@contrail/sdk';
+import { TypeProperty } from '@contrail/types';
+import { TypeConversionUtils } from './type-conversion-utils';
+
+export class TypeUtils {
+  private typesObj: Types;
+  constructor() {
+    this.typesObj = new Types();
+  }
+
+  async getTypeById(id) {
+    // this.logger.log('!-getTypeById: ' + id);
+    const type = await this.typesObj.getType({
+      id,
+      relations: ['typeProperties', 'typeInterfaces']
+    });
+    return type;
+  }
+
+  async getByRootAndPath(options: TypeClientOptions) {
+    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: string, newData): string {
+    let objectClass = '';
+    if ('item' === entityType) {
+      if (newData.roles.includes('family')) {
+        objectClass = 'LCSProduct';
+      } else if (newData.roles.includes('color')) {
+        objectClass = 'LCSSKU';
+      }
+    } else if ('project-item' === entityType) {
+      if (newData.roles.includes('family')) {
+        objectClass = 'LCSProductSeasonLink';
+      } else if (newData.roles.includes('color')) {
+        objectClass = 'LCSSKUSeasonLink';
+      }
+    } else if ('color' === entityType) {
+      objectClass = 'LCSColor';
+    } else if ('custom-entity' === entityType) {
+      objectClass = 'LCSRevisableEntity';
+
+    }
+    return objectClass;
+  }
+
+  /** Gets the VibeIQ entity type for the object data
+   * @param data: object data
+   */
+  async getEntityTypeClientOptionsUsingMapping(transformMapFile, mapFileUtil, data): Promise<TypeClientOptions> {
+    const root = await TypeConversionUtils.getEntityClassFromObject(transformMapFile, mapFileUtil, data);
+    const path = await TypeConversionUtils.getEntityTypePathFromOjbect(transformMapFile, mapFileUtil, data);
+
+    let tco: TypeClientOptions = {
+      root,
+      path
+    };
+
+
+
+    return tco;
+  }
+
+  /** Gets the VibeIQ entity type for the object data
+   * @param objectClass: string object class
+   * @param data: object data
+   */
+  getEntityTypeClientOptions(objectClass: string, data): TypeClientOptions {
+    let tco: TypeClientOptions;
+    if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
+      tco = {
+        root: 'item'
+      };
+    } else if ('LCSSeason' === objectClass) {
+      tco = {
+        root: 'assortment'
+      };
+    } else if ('LCSColor' === objectClass) {
+      tco = {
+        root: 'color'
+      };
+    } else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
+      //TODO need to write logic using mapping file
+      tco = {
+        root: 'custom-entity'
+      };
+      console.log('data: ' + data);
+    }
+
+    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): TypeProperty[] {
+    let filteredProps: TypeProperty[] = type['typeProperties'];
+    const typePath = type['typePath'];
+    const roles = newData['roles'];
+    if (typePath && (typePath.startsWith('item') || typePath.startsWith('project-item'))) {
+      if (Logger.isDebugOn()) {
+        console.debug('filterTypeProperties():id: ' +newData?.id
+          + ', typePath: ' + typePath
+          + ', newData.roles: ' + newData?.roles);
+      }
+      if (roles) {
+        const isFamily = roles.includes('family');
+        if (Logger.isDebugOn()) {
+          console.debug('isFamily: ' + isFamily);
+        }
+
+        filteredProps = filteredProps.filter(prop => {
+          const propertyLevel = prop.propertyLevel;
+          const applies =
+            (isFamily && 'option' != propertyLevel) ||
+            (!isFamily && 'family' != propertyLevel);
+          return applies;
+        });
+
+      } else {
+        console.error('filterTypeProperties():Entity missing role-id: ' + newData['id']);
+      }
+    }
+
+    return filteredProps;
+  }
+
+}

package/tsconfig.json

@@ -1,27 +1,29 @@
-{
-  "compilerOptions": {
-    "target": "es2020",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./lib",
-    "experimentalDecorators": true,
-    "esModuleInterop": true,
-    "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "allowSyntheticDefaultImports": true,
-    "emitDecoratorMetadata": true,
-    "removeComments": true,
-    "skipLibCheck": true,
-    "lib": [
-      "es5",
-      "ES2015",
-      "ES2016",
-      "ES2017",
-      "ES2020",
-      "dom",
-      "esnext.asynciterable"
-    ],    
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "**/__tests__/*"]
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "declaration": true,
+    "rootDir": "./src",
+    "outDir": "./lib",
+    "types": ["jest", "node"],
+    "experimentalDecorators": true,
+    "esModuleInterop": true,
+    "strictPropertyInitialization": false,
+    "noImplicitAny": false,
+    "allowSyntheticDefaultImports": true,
+    "emitDecoratorMetadata": true,
+    "removeComments": true,
+    "skipLibCheck": true,
+    "lib": [
+      "es5",
+      "ES2015",
+      "ES2016",
+      "ES2017",
+      "ES2020",
+      "dom",
+      "esnext.asynciterable"
+    ],    
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/__tests__/*"]
 }

package/tslint.json

@@ -1,57 +1,57 @@
-{
-  "defaultSeverity": "error",
-  "extends": [
-    "tslint:recommended"
-  ],
-  "jsRules": {
-    "no-unused-expression": true
-  },
-  "rules": {
-    "eofline": false,
-    "quotemark": [
-      true,
-      "single"
-    ],
-    "no-shadowed-variable": false,
-    "indent": false,
-    "member-access": [
-      false
-    ],
-    "no-string-literal": false,
-    "ordered-imports": [
-      false
-    ],
-    "max-line-length": [
-      false,
-      150
-    ],
-    "member-ordering": [
-      false
-    ],
-    "curly": false,
-    "interface-name": [
-      false
-    ],
-    "array-type": [
-      false
-    ],
-    "no-empty-interface": false,
-    "no-empty": false,
-    "arrow-parens": false,
-    "object-literal-sort-keys": false,
-    "no-unused-expression": false,
-    "max-classes-per-file": [
-      false
-    ],
-    "variable-name": [
-      false
-    ],
-    "one-line": [
-      false
-    ],
-    "one-variable-per-declaration": [
-      false
-    ]
-  },
-  "rulesDirectory": []
-}
+{
+  "defaultSeverity": "error",
+  "extends": [
+    "tslint:recommended"
+  ],
+  "jsRules": {
+    "no-unused-expression": true
+  },
+  "rules": {
+    "eofline": false,
+    "quotemark": [
+      true,
+      "single"
+    ],
+    "no-shadowed-variable": false,
+    "indent": false,
+    "member-access": [
+      false
+    ],
+    "no-string-literal": false,
+    "ordered-imports": [
+      false
+    ],
+    "max-line-length": [
+      false,
+      150
+    ],
+    "member-ordering": [
+      false
+    ],
+    "curly": false,
+    "interface-name": [
+      false
+    ],
+    "array-type": [
+      false
+    ],
+    "no-empty-interface": false,
+    "no-empty": false,
+    "arrow-parens": false,
+    "object-literal-sort-keys": false,
+    "no-unused-expression": false,
+    "max-classes-per-file": [
+      false
+    ],
+    "variable-name": [
+      false
+    ],
+    "one-line": [
+      false
+    ],
+    "one-variable-per-declaration": [
+      false
+    ]
+  },
+  "rulesDirectory": []
+}

package/scripts/test-get-request.ts

@@ -1,35 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { FlexPLMConnect } from '../src/util/flexplm-connect';
-import { FCConfig } from '../src/interfaces/interfaces';
-
-const config: FCConfig = {
-  apiHost: 'http://windchill.archergrey.com',
-  urlContext: '',
-  vibeEventEndpoint: '',
-  csrfEndpoint: '',
-  plmEnviornment: '',
-  userName: () => '',  // fill in manually
-  password: () => '',  // fill in manually
-  itemPreDevelopmentLifecycleStages: [],
-  payloadDefaultAsArray: true,
-};
-
-async function main() {
-  const connect = new FlexPLMConnect(config);
-  const response = await connect.getRequest({
-    urlPath: '/Windchill/images/000001/000001/000001/cavkingcharlessmalldogs_medium_large-.-2965893984400.png',
-    includeUrlContext: false,
-    returnFullResponse: true,
-  }) as Response;
-
-  const buffer = Buffer.from(await response.arrayBuffer());
-  const outputPath = path.resolve(__dirname, 'output.png');
-  fs.writeFileSync(outputPath, buffer);
-  console.log(`Saved response to ${outputPath}`);
-}
-
-main().catch((err) => {
-  console.error('Error:', err.message);
-  process.exit(1);
-});