@contrail/flexplm 1.2.1 → 1.3.0-alpha.04c91a9

package/lib/util/flexplm-connect.js

@@ -1,171 +1,176 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlexPLMConnect = void 0;
-const app_framework_1 = require("@contrail/app-framework");
-class FlexPLMConnect {
-    constructor(_config, endPoint = undefined, payloadAsArray = undefined) {
-        this.vibeEventEndpoint = '';
-        this.staticHeaders = undefined;
-        this.payloadSendAsArray = true;
-        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;
-        }
-    }
-    getRequestOptions(method) {
-        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 (app_framework_1.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;
-    }
-    async getCSRF() {
-        const urlContext = this.config.urlContext;
-        const csrfEndpoint = this.config.csrfEndpoint;
-        const csrfURL = 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 = this.config.apiHost + urlContext + '/servlet/rest' + this.vibeEventEndpoint;
-        if (app_framework_1.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;
-    }
-    async processRequest(payload) {
-        if (!payload) {
-            const message = 'No payload to send to FlexPLM';
-            console.error(message);
-            throw new Error(message);
-        }
-        if (app_framework_1.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 = {
-                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);
-            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) {
-        return await this.processRequest(payload);
-    }
-    async sendMultipleToFlexPLM(payload) {
-        return await this.processRequest(payload);
-    }
-    async getRequest() {
-        const urlContext = this.config.urlContext;
-        const vibeEventsURL = 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);
-        }
-    }
-}
-exports.FlexPLMConnect = FlexPLMConnect;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlexPLMConnect = void 0;
+const app_framework_1 = require("@contrail/app-framework");
+class FlexPLMConnect {
+    constructor(_config, endPoint = undefined, payloadAsArray = undefined) {
+        this.vibeEventEndpoint = '';
+        this.staticHeaders = undefined;
+        this.payloadSendAsArray = true;
+        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;
+        }
+    }
+    getRequestOptions(method) {
+        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 (app_framework_1.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;
+    }
+    async getCSRF() {
+        const urlContext = this.config.urlContext;
+        const csrfEndpoint = this.config.csrfEndpoint;
+        const csrfURL = 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 = this.config.apiHost + urlContext + '/servlet/rest' + this.vibeEventEndpoint;
+        if (app_framework_1.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;
+    }
+    async processRequest(payload) {
+        if (!payload) {
+            const message = 'No payload to send to FlexPLM';
+            console.error(message);
+            throw new Error(message);
+        }
+        if (app_framework_1.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 = {
+                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);
+            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) {
+        return await this.processRequest(payload);
+    }
+    async sendMultipleToFlexPLM(payload) {
+        return await this.processRequest(payload);
+    }
+    async getRequest(params) {
+        const { urlPath, includeUrlContext = true, returnFullResponse = false } = params || {};
+        const urlContext = includeUrlContext ? this.config.urlContext : '';
+        const path = urlPath || ('/servlet/rest' + this.vibeEventEndpoint);
+        const vibeEventsURL = 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);
+        }
+    }
+}
+exports.FlexPLMConnect = FlexPLMConnect;

package/lib/util/flexplm-connect.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/flexplm-connect.spec.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const flexplm_connect_1 = require("./flexplm-connect");
+const mockJsonData = { items: [{ id: '123', name: 'test' }] };
+const mockResponse = (status, 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) => ({
+    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 flexplm_connect_1.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 flexplm_connect_1.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 flexplm_connect_1.FlexPLMConnect(createConfig());
+        const result = await connect.getRequest();
+        expect(result).toEqual(mockJsonData);
+    });
+    it('should use urlPath when provided', async () => {
+        const connect = new flexplm_connect_1.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 flexplm_connect_1.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 flexplm_connect_1.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.mockResolvedValue(rawResponse);
+        const connect = new flexplm_connect_1.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.mockResolvedValue(mockResponse(404));
+        const connect = new flexplm_connect_1.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.mockResolvedValue(mockResponse(500));
+        const connect = new flexplm_connect_1.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.mockResolvedValue(badResponse);
+        const connect = new flexplm_connect_1.FlexPLMConnect(createConfig());
+        await expect(connect.getRequest()).rejects.toThrow('Error getting json data from FlexPLM: Invalid JSON');
+    });
+});

package/lib/util/logger-config.d.ts

@@ -1 +1 @@
-export declare function setLoggerConfig(appConfig: any): Promise<void>;
+export declare function setLoggerConfig(appConfig: any): Promise<void>;

package/lib/util/logger-config.js

@@ -1,26 +1,26 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLoggerConfig = void 0;
-const app_framework_1 = require("@contrail/app-framework");
-async function setLoggerConfig(appConfig) {
-    let logLevel = app_framework_1.LogLevel.INFO;
-    if (!appConfig.logLevel) {
-    }
-    else if (appConfig.logLevel === 'error') {
-        logLevel = app_framework_1.LogLevel.ERROR;
-    }
-    else if (appConfig.logLevel === 'warn') {
-        logLevel = app_framework_1.LogLevel.WARN;
-    }
-    else if (appConfig.logLevel === 'info') {
-        logLevel = app_framework_1.LogLevel.INFO;
-    }
-    else if (appConfig.logLevel === 'debug') {
-        logLevel = app_framework_1.LogLevel.DEBUG;
-    }
-    else {
-        console.log('could not parse log level:', appConfig);
-    }
-    app_framework_1.Logger.setConfig({ logLevel: logLevel });
-}
-exports.setLoggerConfig = setLoggerConfig;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setLoggerConfig = void 0;
+const app_framework_1 = require("@contrail/app-framework");
+async function setLoggerConfig(appConfig) {
+    let logLevel = app_framework_1.LogLevel.INFO;
+    if (!appConfig.logLevel) {
+    }
+    else if (appConfig.logLevel === 'error') {
+        logLevel = app_framework_1.LogLevel.ERROR;
+    }
+    else if (appConfig.logLevel === 'warn') {
+        logLevel = app_framework_1.LogLevel.WARN;
+    }
+    else if (appConfig.logLevel === 'info') {
+        logLevel = app_framework_1.LogLevel.INFO;
+    }
+    else if (appConfig.logLevel === 'debug') {
+        logLevel = app_framework_1.LogLevel.DEBUG;
+    }
+    else {
+        console.log('could not parse log level:', appConfig);
+    }
+    app_framework_1.Logger.setConfig({ logLevel: logLevel });
+}
+exports.setLoggerConfig = setLoggerConfig;