@contrail/flexplm 1.2.1 → 1.3.0-alpha.3

package/src/util/flexplm-connect.spec.ts

@@ -0,0 +1,132 @@
+
+import { FlexPLMConnect } from './flexplm-connect';
+import { FCConfig } from '../interfaces/interfaces';
+
+const mockJsonData = { items: [{ id: '123', name: 'test' }] };
+
+const mockResponse = (status: number, json = mockJsonData) => ({
+  status,
+  json: jest.fn().mockResolvedValue(json),
+  text: jest.fn().mockResolvedValue('error text'),
+});
+
+const globalFetch = global.fetch;
+
+beforeEach(() => {
+  global.fetch = jest.fn().mockResolvedValue(mockResponse(200));
+});
+
+afterAll(() => {
+  global.fetch = globalFetch;
+});
+
+const createConfig = (overrides?: Partial<FCConfig>): FCConfig => ({
+  apiHost: 'https://flexplm.example.com',
+  urlContext: '/FlexPLM',
+  vibeEventEndpoint: '/api/events',
+  csrfEndpoint: '/csrf',
+  plmEnviornment: 'test',
+  userName: () => 'user',
+  password: () => 'pass',
+  itemPreDevelopmentLifecycleStages: [],
+  payloadDefaultAsArray: true,
+  ...overrides,
+});
+
+describe('FlexPLMConnect.getRequest', () => {
+
+  it('should call default URL with urlContext when no params provided', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    await connect.getRequest();
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/FlexPLM/servlet/rest/api/events',
+      expect.objectContaining({ method: 'GET' }),
+    );
+  });
+
+  it('should use the constructor endpoint in the default URL', async () => {
+    const connect = new FlexPLMConnect(createConfig(), '/custom/endpoint');
+    await connect.getRequest();
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/FlexPLM/servlet/rest/custom/endpoint',
+      expect.any(Object),
+    );
+  });
+
+  it('should return parsed JSON by default', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    const result = await connect.getRequest();
+    expect(result).toEqual(mockJsonData);
+  });
+
+  it('should use urlPath when provided', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    await connect.getRequest({ urlPath: '/custom/path' });
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/FlexPLM/custom/path',
+      expect.any(Object),
+    );
+  });
+
+  it('should exclude urlContext when includeUrlContext is false', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    await connect.getRequest({ includeUrlContext: false });
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/servlet/rest/api/events',
+      expect.any(Object),
+    );
+  });
+
+  it('should exclude urlContext with custom urlPath', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    await connect.getRequest({ urlPath: '/custom/path', includeUrlContext: false });
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/custom/path',
+      expect.any(Object),
+    );
+  });
+
+  it('should return full response when returnFullResponse is true', async () => {
+    const rawResponse = mockResponse(200);
+    (global.fetch as jest.Mock).mockResolvedValue(rawResponse);
+
+    const connect = new FlexPLMConnect(createConfig());
+    const result = await connect.getRequest({ returnFullResponse: true });
+
+    expect(result).toBe(rawResponse);
+    expect(rawResponse.json).not.toHaveBeenCalled();
+  });
+
+  it('should throw on status >= 300', async () => {
+    (global.fetch as jest.Mock).mockResolvedValue(mockResponse(404));
+
+    const connect = new FlexPLMConnect(createConfig());
+    await expect(connect.getRequest()).rejects.toThrow('Error connecting to FlexPLM:status: 404');
+  });
+
+  it('should throw on status >= 300 even with returnFullResponse', async () => {
+    (global.fetch as jest.Mock).mockResolvedValue(mockResponse(500));
+
+    const connect = new FlexPLMConnect(createConfig());
+    await expect(connect.getRequest({ returnFullResponse: true })).rejects.toThrow(
+      'Error connecting to FlexPLM:status: 500',
+    );
+  });
+
+  it('should throw when response.json() fails', async () => {
+    const badResponse = {
+      status: 200,
+      json: jest.fn().mockRejectedValue(new Error('Invalid JSON')),
+      text: jest.fn().mockResolvedValue('not json'),
+    };
+    (global.fetch as jest.Mock).mockResolvedValue(badResponse);
+
+    const connect = new FlexPLMConnect(createConfig());
+    await expect(connect.getRequest()).rejects.toThrow('Error getting json data from FlexPLM: Invalid JSON');
+  });
+});

package/src/util/flexplm-connect.ts

@@ -171,12 +171,18 @@ export class FlexPLMConnect {
     return await this.processRequest(payload);
   }
 
-  /** Runs a get request to FlexPLM using the endpoint provided in the constructor
-   * 
+  /** 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(){
-    const urlContext = this.config.urlContext;
-    const vibeEventsURL: string = this.config.apiHost + urlContext + '/servlet/rest' + this.vibeEventEndpoint;
+  async getRequest(params?: { urlPath?: string; includeUrlContext?: boolean; returnFullResponse?: boolean }): Promise<Response | unknown>{
+    const { urlPath, includeUrlContext = true, returnFullResponse = false } = params || {};
+    const urlContext = includeUrlContext ? this.config.urlContext : '';
+    const path = urlPath || ('/servlet/rest' + this.vibeEventEndpoint);
+    const vibeEventsURL: string = this.config.apiHost + urlContext + path;
     const csrfOptions = this.getRequestOptions('GET');
     const response = await fetch(vibeEventsURL, csrfOptions);
 
@@ -186,6 +192,9 @@ export class FlexPLMConnect {
       console.error(await response.text());
       throw new Error(message);
     }
+    if(returnFullResponse){
+      return response;
+    }
     try {
       const data = await response.json();
       return data;

package/src/util/logger-config.ts

@@ -1,20 +1,20 @@
-import { LogLevel, Logger } from '@contrail/app-framework';
-
-export async function setLoggerConfig(appConfig) {
-  let logLevel: LogLevel = LogLevel.INFO;
-  if(!appConfig.logLevel) {
-    //pass
-  } else if (appConfig.logLevel === 'error') {
-    logLevel = LogLevel.ERROR;
-  } else if (appConfig.logLevel === 'warn') {
-    logLevel = LogLevel.WARN;
-  } else if (appConfig.logLevel === 'info') {
-    logLevel = LogLevel.INFO;
-  } else if (appConfig.logLevel === 'debug') {
-    logLevel = LogLevel.DEBUG;
-  } else {
-    console.log('could not parse log level:', appConfig);
-  }
-
-  Logger.setConfig({logLevel: logLevel});
+import { LogLevel, Logger } from '@contrail/app-framework';
+
+export async function setLoggerConfig(appConfig) {
+  let logLevel: LogLevel = LogLevel.INFO;
+  if(!appConfig.logLevel) {
+    //pass
+  } else if (appConfig.logLevel === 'error') {
+    logLevel = LogLevel.ERROR;
+  } else if (appConfig.logLevel === 'warn') {
+    logLevel = LogLevel.WARN;
+  } else if (appConfig.logLevel === 'info') {
+    logLevel = LogLevel.INFO;
+  } else if (appConfig.logLevel === 'debug') {
+    logLevel = LogLevel.DEBUG;
+  } else {
+    console.log('could not parse log level:', appConfig);
+  }
+
+  Logger.setConfig({logLevel: logLevel});
 }

package/src/util/map-util-spec-mockData.ts

@@ -1,231 +1,231 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.mapping = {
-  typeConversion: {
-    vibe2flex: {
-      'custom-entity': {
-        getMapKey: (entity) =>{
-          const typePath = entity['typePath'];
-          let mapKey = '';
-          switch (typePath) {
-          case 'custom-entity:pack':
-            mapKey = 'packaging';
-            break;
-          case 'custom-entity:prefix':
-            mapKey = 'prefix';
-            break;
-          case 'custom-entity:catName':
-            mapKey = 'catName';
-            break;
-          case 'custom-entity:partnerOrg':
-            mapKey = 'partnerOrg';
-            break;
-          case 'custom-entity:catFamily':
-            mapKey = 'catFamily';
-            break;
-          case 'custom-entity:formName':
-            mapKey = 'formName';
-            break;
-          }
-
-          return mapKey;
-        }
-      }
-    }
-    // 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 /*, dependencies*/) =>{
-        const prodType = entity['prodType'];
-        let val = '';
-        switch (prodType) {
-        case 'acc':
-          val = 'Product\\Accesories';
-          break;
-        case 'app':
-          val = 'Product\\Apparel';
-          break;
-        case 'eqp':
-          val = 'Product\\Equipment';
-          break;
-        case 'foot':
-          val = 'Product\\Footwear';
-          break;
-        }
-
-        return val;
-      },
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }, { processor: 'VALUE_TRANSFORM', functionTransformersKey: 'valueTransform' }],
-      rekey: {
-        productName: 'name',
-        vibeIQIdentifier: 'itemNumber'
-      },
-      valueTransform: {
-        transformEx: (row/*, dependencies*/) => {
-          return row['otherProp'] + 'xxx';
-        }
-      }
-
-    },
-    flex2vibe: {
-      getClass: () => 'item',
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        itemNumber: 'vibeIQIdentifier',
-        name: 'productName',
-      }
-    }
-  },
-  LCSSKU: {
-    vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
-    vibe2flex: {
-      getClass: () => 'LCSSKU',
-      getSoftType: (entity /*, dependencies*/) =>{
-        const prodType = entity['prodType'];
-        let val = '';
-        switch (prodType) {
-        case 'acc':
-          val = 'Product\\Accesories';
-          break;
-        case 'app':
-          val = 'Product\\Apparel';
-          break;
-        case 'eqp':
-          val = 'Product\\Equipment';
-          break;
-        case 'foot':
-          val = 'Product\\Footwear';
-          break;
-        }
-
-        return val;
-      },
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        skuName: 'optionName',
-        vibeIQIdentifier: 'itemNumber'
-      }
-    },
-    flex2vibe: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        itemNumber: 'vibeIQIdentifier',
-        optionName: 'skuName',
-      }
-    }
-  },
-
-  packaging: {
-    vibe2flex: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        retailPackType: 'packType',
-        retailIntroDate: 'introDate'
-      },
-      getSoftType: () => 'Revisable Entity\\packaging',
-      getClass: () => 'LCSRevisableEntity'
-    },
-    flex2vibe: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        packType: 'retailPackType',
-        introDate: 'retailIntroDate'
-      },
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:pack',
-
-    }
-  },
-  prefix: {
-    vibe2flex: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        retailOwner: 'owner',
-        retailIntroDate: 'introDate'
-      },
-      getSoftType: () => 'Revisable Entity\\prefix',
-      getClass: () => 'LCSRevisableEntity'
-    },
-    flex2vibe: {
-      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
-      rekey: {
-        owner: 'retailOwner',
-        introDate: 'retailIntroDate'
-      },
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:prefix',
-
-    }
-  },
-  catName: {
-    getIdentifierProperties: () => ['catName', 'catNumber'],
-    getInformationalProperties: () => ['longName'],
-    vibe2flex: {
-      transformOrder: [],
-      getSoftType: () => 'Revisable Entity\\catName',
-      getClass: () => 'LCSLast'
-    },
-    flex2vibe: {
-      transformOrder: [],
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:catName',
-
-    }
-  },
-  partnerOrg: {
-    vibe2flex: {
-      transformOrder: [],
-      getSoftType: () => 'Business Object\\partnerOrg',
-      getClass: () => 'LCSLifecycleManaged'
-    },
-    flex2vibe: {
-      transformOrder: [],
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:partnerOrg',
-
-    }
-  },
-  catFamily: {
-    vibe2flex: {
-      transformOrder: [],
-      getSoftType: () => 'Revisable Entity\\catFamily',
-      getClass: () => 'LCSRevisableEntity'
-    },
-    flex2vibe: {
-      transformOrder: [],
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:catFamily',
-
-    }
-  },
-  formName: {
-    vibe2flex: {
-      transformOrder: [],
-      getSoftType: () => 'Material\\form',
-      getClass: () => 'LCSMaterial'
-    },
-    flex2vibe: {
-      transformOrder: [],
-      getClass: () => 'custom-entity',
-      getSoftType: () => 'custom-entity:formName',
-
-    }
-  },
-
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.mapping = {
+  typeConversion: {
+    vibe2flex: {
+      'custom-entity': {
+        getMapKey: (entity) =>{
+          const typePath = entity['typePath'];
+          let mapKey = '';
+          switch (typePath) {
+          case 'custom-entity:pack':
+            mapKey = 'packaging';
+            break;
+          case 'custom-entity:prefix':
+            mapKey = 'prefix';
+            break;
+          case 'custom-entity:catName':
+            mapKey = 'catName';
+            break;
+          case 'custom-entity:partnerOrg':
+            mapKey = 'partnerOrg';
+            break;
+          case 'custom-entity:catFamily':
+            mapKey = 'catFamily';
+            break;
+          case 'custom-entity:formName':
+            mapKey = 'formName';
+            break;
+          }
+
+          return mapKey;
+        }
+      }
+    }
+    // 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 /*, dependencies*/) =>{
+        const prodType = entity['prodType'];
+        let val = '';
+        switch (prodType) {
+        case 'acc':
+          val = 'Product\\Accesories';
+          break;
+        case 'app':
+          val = 'Product\\Apparel';
+          break;
+        case 'eqp':
+          val = 'Product\\Equipment';
+          break;
+        case 'foot':
+          val = 'Product\\Footwear';
+          break;
+        }
+
+        return val;
+      },
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }, { processor: 'VALUE_TRANSFORM', functionTransformersKey: 'valueTransform' }],
+      rekey: {
+        productName: 'name',
+        vibeIQIdentifier: 'itemNumber'
+      },
+      valueTransform: {
+        transformEx: (row/*, dependencies*/) => {
+          return row['otherProp'] + 'xxx';
+        }
+      }
+
+    },
+    flex2vibe: {
+      getClass: () => 'item',
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        itemNumber: 'vibeIQIdentifier',
+        name: 'productName',
+      }
+    }
+  },
+  LCSSKU: {
+    vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
+    vibe2flex: {
+      getClass: () => 'LCSSKU',
+      getSoftType: (entity /*, dependencies*/) =>{
+        const prodType = entity['prodType'];
+        let val = '';
+        switch (prodType) {
+        case 'acc':
+          val = 'Product\\Accesories';
+          break;
+        case 'app':
+          val = 'Product\\Apparel';
+          break;
+        case 'eqp':
+          val = 'Product\\Equipment';
+          break;
+        case 'foot':
+          val = 'Product\\Footwear';
+          break;
+        }
+
+        return val;
+      },
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        skuName: 'optionName',
+        vibeIQIdentifier: 'itemNumber'
+      }
+    },
+    flex2vibe: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        itemNumber: 'vibeIQIdentifier',
+        optionName: 'skuName',
+      }
+    }
+  },
+
+  packaging: {
+    vibe2flex: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        retailPackType: 'packType',
+        retailIntroDate: 'introDate'
+      },
+      getSoftType: () => 'Revisable Entity\\packaging',
+      getClass: () => 'LCSRevisableEntity'
+    },
+    flex2vibe: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        packType: 'retailPackType',
+        introDate: 'retailIntroDate'
+      },
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:pack',
+
+    }
+  },
+  prefix: {
+    vibe2flex: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        retailOwner: 'owner',
+        retailIntroDate: 'introDate'
+      },
+      getSoftType: () => 'Revisable Entity\\prefix',
+      getClass: () => 'LCSRevisableEntity'
+    },
+    flex2vibe: {
+      transformOrder: [{ processor: 'REKEY', rekeyDelete: true, rekeyTransformersKey: 'rekey' }],
+      rekey: {
+        owner: 'retailOwner',
+        introDate: 'retailIntroDate'
+      },
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:prefix',
+
+    }
+  },
+  catName: {
+    getIdentifierProperties: () => ['catName', 'catNumber'],
+    getInformationalProperties: () => ['longName'],
+    vibe2flex: {
+      transformOrder: [],
+      getSoftType: () => 'Revisable Entity\\catName',
+      getClass: () => 'LCSLast'
+    },
+    flex2vibe: {
+      transformOrder: [],
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:catName',
+
+    }
+  },
+  partnerOrg: {
+    vibe2flex: {
+      transformOrder: [],
+      getSoftType: () => 'Business Object\\partnerOrg',
+      getClass: () => 'LCSLifecycleManaged'
+    },
+    flex2vibe: {
+      transformOrder: [],
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:partnerOrg',
+
+    }
+  },
+  catFamily: {
+    vibe2flex: {
+      transformOrder: [],
+      getSoftType: () => 'Revisable Entity\\catFamily',
+      getClass: () => 'LCSRevisableEntity'
+    },
+    flex2vibe: {
+      transformOrder: [],
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:catFamily',
+
+    }
+  },
+  formName: {
+    vibe2flex: {
+      transformOrder: [],
+      getSoftType: () => 'Material\\form',
+      getClass: () => 'LCSMaterial'
+    },
+    flex2vibe: {
+      transformOrder: [],
+      getClass: () => 'custom-entity',
+      getSoftType: () => 'custom-entity:formName',
+
+    }
+  },
+
 };