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

package/src/util/error-response-object.spec.ts

@@ -1,116 +0,0 @@
-import { AppActionCallbackStatus } from "@contrail/app-framework";
-import { ErrorResponseObject } from "./error-response-object";
-
-describe('getResponse() Tests', () =>{
-  it('no error provided', () => {
-    const e = undefined;
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-    expect(response?.output?.message).toMatch('No error provided');
-  });
-  it('error with message', () => {
-    const e = {
-      message: 'Test'
-    };
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-    expect(response?.output?.message).toMatch('Test');
-  });
-
-  it('error with details', () => {
-    const details = {
-      message: 'Detail Message',
-      itemType: [
-        {
-            message: "Type 'item:product:newBalance:apparel' cannot be assigned to a property with type 'item'."
-        }]
-    };
-    const e = {
-      message: 'Test',
-      details
-
-    };
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response).toBeTruthy();
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-    expect(response.output.message).toMatch('Test');
-
-    const errorDetails = response.output.errorDetails;
-    expect(errorDetails).toBeTruthy();
-    expect(errorDetails.message).toMatch('Detail Message');
-    expect(errorDetails).toHaveProperty('itemType');
-  });
-
-  it('error with cause', () => {
-    const cause = {
-      code: 401,
-      message: 'cause message'
-    };
-    const e = {
-      message: 'Test',
-      cause
-    };
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-    expect(response?.output?.message).toMatch('Test');
-    const resCause = response.output.cause;
-
-    expect(resCause).toBeTruthy();
-    expect(resCause.code).toBe(401);
-    expect(resCause.message).toMatch('cause message');
-
-  });
-
-  it('error with code', () => {
-    const e = {
-      message: 'Test',
-      code: 404
-    };
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-    expect(response?.output?.message).toMatch('Test');
-    expect(response.output.code).toBe(404);
-  });
-
-  it('error with code', () => {
-    const e = {
-      message: 'Test',
-      name: 'Error'
-    };
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-    expect(response?.output?.message).toMatch('Test');
-    expect(response.output.errorName).toMatch('Error');
-  });
-
-  it('error with errno', () => {
-    const e = {
-      message: 'Test',
-      errno: 500
-    };
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-    expect(response?.output?.message).toMatch('Test');
-    expect(response.output.errno).toBe(500);
-  });
-
-  it('error with type', () => {
-    const e = {
-      message: 'Test',
-      type: 'system'
-    };
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-    expect(response?.output?.message).toMatch('Test');
-    expect(response.output.type).toMatch('system');
-  });
-
-});

package/src/util/error-response-object.ts

@@ -1,50 +0,0 @@
-import { AppActionCallBack, AppActionCallbackStatus } from "@contrail/app-framework";
-
-export class ErrorResponseObject {
-
-  /** Returns a response, checking for multiple possible error details
-   *
-   * @param e
-   * @returns
-   */
-  public static getResponse(e): AppActionCallBack {
-    if(!e){
-      const response: AppActionCallBack = {
-        status: AppActionCallbackStatus.FAILURE,
-        output: {
-          message: 'No error provided.'
-        }
-      };
-        return response;
-    }
-
-    const response: AppActionCallBack = {
-      status: AppActionCallbackStatus.FAILURE,
-      output: {
-        message: e.message
-      }
-    };
-    const output = response.output;
-
-    //Errors when persisting in VibeIQ
-    if(e.details) output.errorDetails = e.details;
-
-    if(e.code) output.code = e.code;
-    if(e.errno) output.errno = e.errno;
-    if(e.type) output.type = e.type;
-    if(e.name) output.errorName = e.name;
-
-    //Has original cause
-    if(e.cause){
-      output.cause = {};
-      const cause = output.cause;
-      if(e.cause.code) cause.code = e.cause.code;
-      if(e.cause.message) cause.message = e.cause.message;
-    }
-
-    if(e.stack){
-      console.log('ErrorResponseObject.getResponse stack: ' + e.stack);
-    }
-    return response;
-  }
-}

package/src/util/event-short-message-status.ts

@@ -1,22 +0,0 @@
-export enum EventShortMessageStatus {
-  SUCCESS = 'Success',
-  FAILURE = 'Failure',
-  CREATED = 'Created',
-  ITEM_FAMILY_ID_MISSING = 'Item_family_id_missing',
-  ITEM_FAMILY_NOT_FOUND = 'Item_family_not_found',
-  PROJECT_ITEM_NOT_FOUND = 'Project_item_not_found',
-  MISSING_IDENTIFIER_PROPERTIES = 'Missing_identifier_properties',
-  MISSING_INPUT = 'Missing_input',
-  NOT_CREATABLE = 'Not_creatable',
-  NO_CHANGES = 'No_Changes',
-  PRIMARY_CONTENT_UPDATED = 'Primary_Content_Updated',
-  TOO_MANY_ENTITIES_FOUND = 'Too_Many_Entities_Found',
-  UPDATED = 'Updated',
-
-  //Publish
-  NOT_PUBLISHABLE = 'Not_Publishable',
-  NO_FEDERATION_INFO = 'No_Federation_Information',
-  NO_EVENTS_TO_SEND = 'No_Events_to_Send',
-  SENDING_EVENTS = 'Sending_Events',
-
-}

package/src/util/federation.ts

@@ -1,172 +0,0 @@
-import { Entities } from '@contrail/sdk';
-
-import { FederationRecord } from '../interfaces/interfaces';
-import pLimit from 'p-limit';
-const limit = pLimit(30);
-
-interface fedConfigDef {
-  appIdentifier: string,
-  federationSchema: string
-}
-const FED_CONFIG: fedConfigDef = {
-  appIdentifier: '@vibeiq/flexplm-connector',
-  federationSchema: 'DEFAULT'
-};
-export class Federation {
-
-  private CHUNK_SIZE = 50;
-
-  async getFederatedMappedRefId(entityType: string, entityId: string) {
-    const criteria = {
-      reference: entityType + ':' + entityId,
-      appIdentifier: FED_CONFIG.appIdentifier,
-      federationSchema: FED_CONFIG.federationSchema
-    };
-    console.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
-    const fedRecords: FederationRecord[] = await new Entities().get({
-      entityName: 'federation',
-      criteria
-    });
-
-    const federatedId = (fedRecords[0])
-      ? fedRecords[0]['mappedReference']
-      : '';
-
-    return federatedId;
-  }
-
-  async createFederatedRecord(eventBody) {
-    const itemResults = eventBody.payload;
-    for (let i = 0; i < itemResults.length; i++) {
-      if (!itemResults[i].federatedId) {
-        continue;
-      }
-      const payload: FederationRecord = {
-        appIdentifier: FED_CONFIG.appIdentifier,
-        reference: itemResults[i].entityReference,
-        mappedReference: itemResults[i].federatedId,
-        federationSchema: FED_CONFIG.federationSchema
-      };
-      // console.log('createFederatedRecord: ' + JSON.stringify(payload));
-
-      try {
-        const results = await new Entities().create({ entityName: 'federation', object: payload });
-        return results;
-        // console.log(JSON.stringify(results));
-      } catch (error) {
-        console.log('createFederatedRecord-error: ', error);
-        throw new Error('Error creating federation record: ' + error.message);
-      }
-    }
-  }
-
-  async getFederationRecordFromMappedRefId(mappedRefId: string) {
-    const criteria = {
-      appIdentifier: FED_CONFIG.appIdentifier,
-      mappedReference: mappedRefId,
-      federationSchema: FED_CONFIG.federationSchema
-    };
-    try {
-      const fedRecords: FederationRecord[] = await new Entities().get({
-        entityName: 'federation',
-        criteria
-      });
-      return (fedRecords && fedRecords[0]) ? fedRecords[0] : undefined;
-    } catch (e) {
-      console.log('getFederationData-error: ' + e.message);
-    }
-    return undefined;
-  }
-
-  static getEntityId(fedRecord: FederationRecord) {
-    const entityString = fedRecord['reference'];
-    const entitySplit = entityString.split(':');
-    const entityType = entitySplit[0];
-    const entityId = entitySplit[1];
-
-    return { entityType, entityId };
-
-  }
-
-  async getEntityFromMappedRefId(mappedRefId: string) {
-    // console.log('!---getEntityFromMappedRefId: ' + mappedRefId);
-    const fedRecord = await this.getFederationRecordFromMappedRefId(mappedRefId);
-    console.log('fedRecord: ' + JSON.stringify(fedRecord));
-    if (!fedRecord) {
-      //Not creating from FlexPLM at this time.
-      console.log('Federation Record doesnt exist. Cant get entity!');
-      return;
-    }
-
-    const { entityType, entityId } = Federation.getEntityId(fedRecord);
-    // console.log(entityType + ':' + entityId);
-    const criteria = {
-      id: entityId
-    };
-    const entities = await new Entities().get({
-      entityName: entityType,
-      criteria
-    });
-    const entity = (entities && entities[0]) ? entities[0] : undefined;
-    // console.log(' entities: ' +JSON.stringify(entities));
-    return entity;
-  }
-
-  async getFederationRecordsFromIds(ids: string[]): Promise<FederationRecord[]> {
-    const fedRecords = [];
-    for (let i = 0; i < ids.length; i++) {
-      const criteria = {
-        reference: ids[i],
-        appIdentifier: FED_CONFIG.appIdentifier,
-        federationSchema: FED_CONFIG.federationSchema
-      };
-      // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
-      const recs: FederationRecord[] = await new Entities().get({
-        entityName: 'federation',
-        criteria
-      });
-      if (recs[0]) {
-        fedRecords.push(recs[0]);
-      }
-    }
-
-    return fedRecords;
-  }
-
-  async getFederationRecordsFromIdsBulk(ids: string[]): Promise<FederationRecord[]> {
-
-    const chunks: string[][] = this.splitIntoChunksByLen(ids, this.CHUNK_SIZE);
-    const fedRecords = [];
-    const federatedPromises = [];
-    const entities: Entities = new Entities();
-    for (const chunk of chunks) {
-      const fedPromise = limit(async () => {
-        const criteria = {
-          references: chunk,
-          appIdentifier: FED_CONFIG.appIdentifier,
-          federationSchema: FED_CONFIG.federationSchema
-        };
-        // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
-        const records: FederationRecord[] = await entities.get({
-          entityName: 'federation',
-          criteria
-        });
-        fedRecords.push(...records);
-
-      });
-      federatedPromises.push(fedPromise);
-    }
-    await Promise.all(federatedPromises);
-
-    return fedRecords;
-  }
-
-  splitIntoChunksByLen(arr, len) {
-    const chunks = [], n = arr?.length;
-    let i = 0;
-    while (i < n) {
-      chunks.push(arr.slice(i, i += len));
-    }
-    return chunks;
-  }
-}

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

@@ -1,132 +0,0 @@
-
-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

@@ -1,208 +0,0 @@
-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.
-   * @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(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);
-
-    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);
-    }
-    if(returnFullResponse){
-      return response;
-    }
-    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);
-    }
-  }
-}