@contrail/flexplm 1.1.63 → 1.1.65

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

@@ -758,6 +758,51 @@ describe('checkKeysAndValues', () =>{
   });
 });
 
+describe('filterOutArchivedAndTrashedEntities', () =>{
+    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);
+
+  it('filter out isArchived and isTrashed entities', () =>{
+    const entities = [
+      {id: '1', name: 'Entity 1', isArchived: false, isTrashed: false},
+      {id: '2', name: 'Entity 2', isArchived: true, isTrashed: false},
+      {id: '3', name: 'Entity 3', isArchived: false, isTrashed: true},
+      {id: '4', name: 'Entity 4', isArchived: false, isTrashed: false}
+    ];
+
+    const filteredEntities = dc.filterOutArchivedAndTrashedEntities(entities);
+    expect(filteredEntities.length).toBe(2);
+    expect(filteredEntities).toEqual([
+      {id: '1', name: 'Entity 1', isArchived: false, isTrashed: false},
+      {id: '4', name: 'Entity 4', isArchived: false, isTrashed: false}
+    ]);
+  });
+  it('no entities to filter', () =>{
+    const entities = [];
+    const filteredEntities = dc.filterOutArchivedAndTrashedEntities(entities);
+    expect(filteredEntities.length).toBe(0);
+  });
+  it('all entities are archived or trashed', () =>{
+    const entities = [
+      {id: '1', name: 'Entity 1', isArchived: true, isTrashed: false},
+      {id: '2', name: 'Entity 2', isArchived: false, isTrashed: true}
+    ];
+
+    const filteredEntities = dc.filterOutArchivedAndTrashedEntities(entities);
+    expect(filteredEntities.length).toBe(0);
+  });
+});
+
 describe('setUserListValue', () =>{
   const config: FCConfig = {
     apiHost: 'host',

package/src/util/data-converter.ts

@@ -512,7 +512,7 @@ export class DataConverter {
       nextPageKey = loadPage?.nextPageKey;
       if (Object.keys(loadPage).includes('results')) {
         usedV2 = true;
-        let postProcessedResults = loadPage.results;
+        let postProcessedResults = this.filterOutArchivedAndTrashedEntities(loadPage?.results);
         if(postProcessedResults?.length > 0 && postProcessCriteria && Object.keys(postProcessCriteria).length !== 0) {
           const subEntityTypePath = rootTypeCriteria.typePath || entityType;
           postProcessedResults = this.checkKeysAndValues(postProcessCriteria, postProcessedResults, subEntityTypePath);
@@ -534,7 +534,7 @@ export class DataConverter {
           take,
           skip,
         });
-        let postProcessedResults = loadPage;
+        let postProcessedResults = this.filterOutArchivedAndTrashedEntities(loadPage);
         if(postProcessCriteria && Object.keys(postProcessCriteria).length !== 0) {
           const subEntityTypePath = rootTypeCriteria.typePath || entityType;
           postProcessedResults = this.checkKeysAndValues(postProcessCriteria, postProcessedResults, subEntityTypePath);
@@ -587,6 +587,23 @@ export class DataConverter {
     return arrOfMatchObjects;
   }
 
+  /** Filters out archived and trashed entities from the provided array of entities.
+   *
+   * @param entities
+   * @returns
+   */
+
+  filterOutArchivedAndTrashedEntities(entities: any[]) {
+    if(!entities || !Array.isArray(entities) || entities.length === 0){
+      return [];
+    }
+    return entities.filter(entity => {
+      const isArchived = entity?.isArchived;
+      const isTrashed = entity?.isTrashed;
+      return !isArchived && !isTrashed;
+    });
+  }
+
   /** Sets userListId value from FlexPLM data passed in
    * 
    * @param prop the VibeIQ property

package/src/util/flexplm-connect.ts

@@ -1,199 +1,199 @@
-import { Logger } from '@contrail/app-framework';
-import { FCConfig, FlexPLMResponseData, PayloadType } from '../interfaces/interfaces';
-
-export class FlexPLMConnect {
-  private config: FCConfig;
-  private vibeEventEndpoint = '';
-  private staticHeaders = undefined;
-  public payloadSendAsArray = true;
-  constructor(_config: FCConfig, endPoint = undefined, payloadAsArray = undefined) {
-    this.config = _config;
-    this.vibeEventEndpoint = (endPoint)
-      ? endPoint
-      : this.config.vibeEventEndpoint;
-    this.payloadSendAsArray = (payloadAsArray != undefined)
-      ? payloadAsArray
-      : this.config['payloadDefaultAsArray'];
-    if(this.config?.flexplmConnect?.staticHeaders){
-      this.staticHeaders = this.config?.flexplmConnect?.staticHeaders;
-    }
-  }
-
-  /////////////////////////////////////////////////////////////////////////////
-  ///////// Custom getRequestOptions: start
-  /////////////////////////////////////////////////////////////////////////////
-  private getRequestOptions(method: string) {
-    const csrfOptions = {
-      method,
-      headers: {
-        'Content-Type': 'application/json',
-        PLM_ENV: this.config.plmEnviornment,
-        Authorization: 'Basic ' + Buffer.from(`${this.config.userName()}:${this.config.password()}`, 'binary').toString('base64')
-      }
-    };
-    if(this.staticHeaders){
-      Object.assign(csrfOptions.headers, this.staticHeaders);
-    }
-    if(Logger.isInfoOn()){
-      const logOptions = JSON.parse(JSON.stringify(csrfOptions));
-      logOptions['headers']['Authorization'] = logOptions?.headers?.Authorization.substring(0, 9);
-      console.info('csrfOptions: ' + JSON.stringify(logOptions));
-    }
-    return csrfOptions;
-  }
-  /////////////////////////////////////////////////////////////////////////////
-  ///////// Custom getRequestOptions: end
-  /////////////////////////////////////////////////////////////////////////////
-
-  async getCSRF() {
-    const urlContext = this.config.urlContext;
-    const csrfEndpoint = this.config.csrfEndpoint;
-    const csrfURL: string = this.config.apiHost + urlContext + csrfEndpoint;
-    console.info('csrfURL: ' + csrfURL);
-
-    const csrfOptions = this.getRequestOptions('GET');
-
-    const response = await fetch(csrfURL, csrfOptions);
-    if(response.status >= 300){
-      const message = 'Error connecting to FlexPLM:status: ' + response.status;
-      console.error(message);
-      console.error(await response.text());
-      const e = new Error(message);
-      e['httpResponseStatus'] = response.status;
-      throw e;
-}
-
-    try{
-
-      const body = await response.json();
-
-      const nonce_key = body.items[0].attributes.nonce_key;
-      const nonce = body.items[0].attributes.nonce;
-      console.info('nonce_key: ' + nonce_key);
-      console.info('nonce: ' + nonce);
-      return {
-        nonce_key,
-        nonce
-      };
-    }catch(e){
-      const message = 'Error connecting to FlexPLM: ' + e.message;
-      console.error(message);
-      console.error(await response.text());
-      throw new Error(message);
-    }
-  }
-
-  async sendRequest(csrf, payload) {
-
-    if(this.payloadSendAsArray && !Array.isArray(payload)){
-      payload = [payload];
-    }
-
-    const xferOptions = this.getRequestOptions('POST');
-
-    xferOptions['body'] =  JSON.stringify(payload);
-    xferOptions.headers[csrf.nonce_key] = csrf.nonce;
-
-    const urlContext = this.config.urlContext;
-    const vibeEventsURL: string = this.config.apiHost + urlContext + '/servlet/rest' + this.vibeEventEndpoint;
-
-    if(Logger.isInfoOn()){
-      console.info('Request:');
-      console.info('vibeEventsURL: ' + vibeEventsURL);
-      const logOptions = JSON.parse(JSON.stringify(xferOptions));
-      logOptions['headers']['Authorization'] = logOptions?.headers?.Authorization.substring(0, 9);
-      console.info('csrfOptions: ' + JSON.stringify(logOptions));
-      console.info('Making call to xfer data to FlexPLM');
-    }
-    const eventResponse = await fetch(vibeEventsURL, xferOptions);
-    return eventResponse;
-  }
-
-  protected async processRequest(payload:any){
-    if(!payload){
-      const message = 'No payload to send to FlexPLM';
-      console.error(message);
-      throw new Error(message);
-    }
-    if(Logger.isInfoOn()){
-      console.info('payload: ' + JSON.stringify(payload));
-    }
-
-    const csrf = await this.getCSRF();
-    if(!csrf){
-      const message = 'Failed to get CSRF nonce';
-      console.error(message);
-      throw new Error(message);
-    }
-
-    const response = await this.sendRequest(csrf, payload);
-    const status = response.status;
-    if(status >= 300){
-      const message = 'Error sending data to FlexPLM:status: ' + response.status;
-      console.error(message);
-      console.error(await response.text());
-      const e = new Error(message);
-      e['httpResponseStatus'] = status;
-      throw e;
-    }
-
-    try{
-      const res: FlexPLMResponseData = {
-        status,
-      };
-      if(![204, 205].includes(status)){
-        try{
-          const data = await response.json();
-          res.data = data;
-        } catch(e){
-          console.error('Error getting response body. Setting {} body: ' + e);
-          res.data = {};
-        }
-      }
-
-      console.log('eventResponse.status: ' + status);
-      // console.log('eventBody: ', JSON.stringify(data));
-      return res;
-
-    }catch(e){
-      const message = 'Error getting json data from FlexPLM: ' + e.message;
-      console.error(message);
-      console.error(await response.text());
-      throw new Error(message);
-    }
-
-  }
-  async sendToFlexPLM( payload: PayloadType){
-    return await this.processRequest(payload);
-  }
-
-  async sendMultipleToFlexPLM(payload: PayloadType[]){
-    return await this.processRequest(payload);
-  }
-
-  /** Runs a get request to FlexPLM using the endpoint provided in the constructor
-   * 
-   */
-  async getRequest(){
-    const urlContext = this.config.urlContext;
-    const vibeEventsURL: string = this.config.apiHost + urlContext + '/servlet/rest' + this.vibeEventEndpoint;
-    const csrfOptions = this.getRequestOptions('GET');
-    const response = await fetch(vibeEventsURL, csrfOptions);
-
-    if(response.status >= 300){
-      const message = 'Error connecting to FlexPLM:status: ' + response.status;
-      console.error(message);
-      console.error(await response.text());
-      throw new Error(message);
-    }
-    try {
-      const data = await response.json();
-      return data;
-    } catch(e){
-      const message = 'Error getting json data from FlexPLM: ' + e.message;
-      console.error(message);
-      console.error(await response.text());
-      throw new Error(message);
-    }
-  }
-}
+import { Logger } from '@contrail/app-framework';
+import { FCConfig, FlexPLMResponseData, PayloadType } from '../interfaces/interfaces';
+
+export class FlexPLMConnect {
+  private config: FCConfig;
+  private vibeEventEndpoint = '';
+  private staticHeaders = undefined;
+  public payloadSendAsArray = true;
+  constructor(_config: FCConfig, endPoint = undefined, payloadAsArray = undefined) {
+    this.config = _config;
+    this.vibeEventEndpoint = (endPoint)
+      ? endPoint
+      : this.config.vibeEventEndpoint;
+    this.payloadSendAsArray = (payloadAsArray != undefined)
+      ? payloadAsArray
+      : this.config['payloadDefaultAsArray'];
+    if(this.config?.flexplmConnect?.staticHeaders){
+      this.staticHeaders = this.config?.flexplmConnect?.staticHeaders;
+    }
+  }
+
+  /////////////////////////////////////////////////////////////////////////////
+  ///////// Custom getRequestOptions: start
+  /////////////////////////////////////////////////////////////////////////////
+  private getRequestOptions(method: string) {
+    const csrfOptions = {
+      method,
+      headers: {
+        'Content-Type': 'application/json',
+        PLM_ENV: this.config.plmEnviornment,
+        Authorization: 'Basic ' + Buffer.from(`${this.config.userName()}:${this.config.password()}`, 'binary').toString('base64')
+      }
+    };
+    if(this.staticHeaders){
+      Object.assign(csrfOptions.headers, this.staticHeaders);
+    }
+    if(Logger.isInfoOn()){
+      const logOptions = JSON.parse(JSON.stringify(csrfOptions));
+      logOptions['headers']['Authorization'] = logOptions?.headers?.Authorization.substring(0, 9);
+      console.info('csrfOptions: ' + JSON.stringify(logOptions));
+    }
+    return csrfOptions;
+  }
+  /////////////////////////////////////////////////////////////////////////////
+  ///////// Custom getRequestOptions: end
+  /////////////////////////////////////////////////////////////////////////////
+
+  async getCSRF() {
+    const urlContext = this.config.urlContext;
+    const csrfEndpoint = this.config.csrfEndpoint;
+    const csrfURL: string = this.config.apiHost + urlContext + csrfEndpoint;
+    console.info('csrfURL: ' + csrfURL);
+
+    const csrfOptions = this.getRequestOptions('GET');
+
+    const response = await fetch(csrfURL, csrfOptions);
+    if(response.status >= 300){
+      const message = 'Error connecting to FlexPLM:status: ' + response.status;
+      console.error(message);
+      console.error(await response.text());
+      const e = new Error(message);
+      e['httpResponseStatus'] = response.status;
+      throw e;
+}
+
+    try{
+
+      const body = await response.json();
+
+      const nonce_key = body.items[0].attributes.nonce_key;
+      const nonce = body.items[0].attributes.nonce;
+      console.info('nonce_key: ' + nonce_key);
+      console.info('nonce: ' + nonce);
+      return {
+        nonce_key,
+        nonce
+      };
+    }catch(e){
+      const message = 'Error connecting to FlexPLM: ' + e.message;
+      console.error(message);
+      console.error(await response.text());
+      throw new Error(message);
+    }
+  }
+
+  async sendRequest(csrf, payload) {
+
+    if(this.payloadSendAsArray && !Array.isArray(payload)){
+      payload = [payload];
+    }
+
+    const xferOptions = this.getRequestOptions('POST');
+
+    xferOptions['body'] =  JSON.stringify(payload);
+    xferOptions.headers[csrf.nonce_key] = csrf.nonce;
+
+    const urlContext = this.config.urlContext;
+    const vibeEventsURL: string = this.config.apiHost + urlContext + '/servlet/rest' + this.vibeEventEndpoint;
+
+    if(Logger.isInfoOn()){
+      console.info('Request:');
+      console.info('vibeEventsURL: ' + vibeEventsURL);
+      const logOptions = JSON.parse(JSON.stringify(xferOptions));
+      logOptions['headers']['Authorization'] = logOptions?.headers?.Authorization.substring(0, 9);
+      console.info('csrfOptions: ' + JSON.stringify(logOptions));
+      console.info('Making call to xfer data to FlexPLM');
+    }
+    const eventResponse = await fetch(vibeEventsURL, xferOptions);
+    return eventResponse;
+  }
+
+  protected async processRequest(payload:any){
+    if(!payload){
+      const message = 'No payload to send to FlexPLM';
+      console.error(message);
+      throw new Error(message);
+    }
+    if(Logger.isInfoOn()){
+      console.info('payload: ' + JSON.stringify(payload));
+    }
+
+    const csrf = await this.getCSRF();
+    if(!csrf){
+      const message = 'Failed to get CSRF nonce';
+      console.error(message);
+      throw new Error(message);
+    }
+
+    const response = await this.sendRequest(csrf, payload);
+    const status = response.status;
+    if(status >= 300){
+      const message = 'Error sending data to FlexPLM:status: ' + response.status;
+      console.error(message);
+      console.error(await response.text());
+      const e = new Error(message);
+      e['httpResponseStatus'] = status;
+      throw e;
+    }
+
+    try{
+      const res: FlexPLMResponseData = {
+        status,
+      };
+      if(![204, 205].includes(status)){
+        try{
+          const data = await response.json();
+          res.data = data;
+        } catch(e){
+          console.error('Error getting response body. Setting {} body: ' + e);
+          res.data = {};
+        }
+      }
+
+      console.log('eventResponse.status: ' + status);
+      // console.log('eventBody: ', JSON.stringify(data));
+      return res;
+
+    }catch(e){
+      const message = 'Error getting json data from FlexPLM: ' + e.message;
+      console.error(message);
+      console.error(await response.text());
+      throw new Error(message);
+    }
+
+  }
+  async sendToFlexPLM( payload: PayloadType){
+    return await this.processRequest(payload);
+  }
+
+  async sendMultipleToFlexPLM(payload: PayloadType[]){
+    return await this.processRequest(payload);
+  }
+
+  /** Runs a get request to FlexPLM using the endpoint provided in the constructor
+   * 
+   */
+  async getRequest(){
+    const urlContext = this.config.urlContext;
+    const vibeEventsURL: string = this.config.apiHost + urlContext + '/servlet/rest' + this.vibeEventEndpoint;
+    const csrfOptions = this.getRequestOptions('GET');
+    const response = await fetch(vibeEventsURL, csrfOptions);
+
+    if(response.status >= 300){
+      const message = 'Error connecting to FlexPLM:status: ' + response.status;
+      console.error(message);
+      console.error(await response.text());
+      throw new Error(message);
+    }
+    try {
+      const data = await response.json();
+      return data;
+    } catch(e){
+      const message = 'Error getting json data from FlexPLM: ' + e.message;
+      console.error(message);
+      console.error(await response.text());
+      throw new Error(message);
+    }
+  }
+}