@unito/integration-cli 0.57.1 → 0.58.0

package/dist/src/oauth2Helper/oauth2Helper.js

@@ -1,235 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.open = void 0;
-const tslib_1 = require("tslib");
-const express_1 = tslib_1.__importDefault(require("express"));
-const cors_1 = tslib_1.__importDefault(require("cors"));
-const openUrl = tslib_1.__importStar(require("openurl"));
-const configurationTypes_1 = require("../configurationTypes");
-const errors_1 = require("../errors");
-// It allows to stub openUrl library in the test
-exports.open = openUrl;
-class OAuth2Helper {
-    server = null;
-    clientId;
-    clientSecret;
-    providerAuthorizationUrl;
-    tokenUrl;
-    scopes;
-    grantType;
-    requestContentType;
-    responseContentType;
-    refreshToken;
-    code = '';
-    serverUrl = '';
-    tokenRequestParameters;
-    refreshRequestParameters;
-    /**
-     * Constructs an instance of OAuthHelper.
-     * @param clientId The client ID for your OAuth application.
-     * @param clientSecret The client secret for your OAuth application.
-     * @param authorizationUrl The URL for the authorization endpoint of the provider.
-     * @param scopes The scopes required for the OAuth authorization.
-     * @param providerTokenUrl The URL for the token endpoint of the provider.
-     */
-    constructor(authorizationInfo) {
-        const { clientId, clientSecret, authorizationUrl, scopes, tokenUrl, grantType, requestContentType, responseContentType, refreshToken, refreshRequestParameters, tokenRequestParameters, } = authorizationInfo;
-        this.startServer = this.startServer.bind(this);
-        this.stopServer = this.stopServer.bind(this);
-        this.handleAuthorize = this.handleAuthorize.bind(this);
-        this.handleCallback = this.handleCallback.bind(this);
-        this.handleToken = this.handleToken.bind(this);
-        this.clientId = clientId;
-        this.clientSecret = clientSecret;
-        this.providerAuthorizationUrl = authorizationUrl;
-        this.scopes = scopes.map(scope => scope.name);
-        this.tokenUrl = tokenUrl;
-        this.grantType = grantType ?? configurationTypes_1.GrantType.AUTHORIZATION_CODE;
-        this.requestContentType = requestContentType ?? configurationTypes_1.RequestContentType.URL_ENCODED;
-        this.responseContentType = responseContentType ?? configurationTypes_1.RequestContentType.JSON;
-        this.refreshToken = refreshToken;
-        this.tokenRequestParameters = tokenRequestParameters;
-        this.refreshRequestParameters = refreshRequestParameters;
-    }
-    /**
-     * Handles the authorization request and redirects the user to the provider's authorization page.
-     * @param req The express Request object.
-     * @param res The express Response object.
-     */
-    async handleAuthorize(_req, res) {
-        if (!this.providerAuthorizationUrl) {
-            res.status(422).send({ message: 'providerAuthorizationUrl must be defined in .unito.json' });
-            return;
-        }
-        const authUrl = new URL(this.providerAuthorizationUrl);
-        const params = new URLSearchParams(authUrl.search);
-        if (this.clientId) {
-            params.set('client_id', this.clientId);
-        }
-        params.set('redirect_uri', `${this.serverUrl}/credentials/new/oauth2/callback`);
-        if (this.scopes) {
-            params.set('scope', this.scopes.join(' '));
-        }
-        params.set('response_type', 'code');
-        authUrl.search = params.toString();
-        exports.open.open(authUrl.toString());
-        res.json();
-    }
-    /**
-     * Handles the callback request from the provider and stores the authorization code.
-     * @param req The express Request object.
-     * @param res The express Response object.
-     */
-    async handleCallback(req, res) {
-        const { code } = req.query;
-        this.code = code;
-        res.json();
-    }
-    encodeBody(bodyData, contentType) {
-        switch (contentType) {
-            case configurationTypes_1.RequestContentType.URL_ENCODED:
-                return new URLSearchParams(bodyData).toString();
-            case configurationTypes_1.RequestContentType.JSON:
-                return JSON.stringify(bodyData);
-        }
-    }
-    /**
-     * Handles the token request to exchange the authorization code for an access token.
-     * @param req The express Request object.
-     * @param res The express Response object.
-     */
-    async handleToken(_req, res) {
-        if (!Object.values(configurationTypes_1.RequestContentType).includes(this.requestContentType)) {
-            res.status(400).json({ error: `Request content type not supported: ${this.requestContentType}` });
-        }
-        const bodyData = {
-            code: this.code,
-            grant_type: this.grantType,
-            redirect_uri: `${this.serverUrl}/credentials/new/oauth2/callback`,
-        };
-        if (this.clientId) {
-            bodyData.client_id = this.clientId;
-        }
-        if (this.clientSecret) {
-            bodyData.client_secret = this.clientSecret;
-        }
-        const body = this.encodeBody(bodyData, this.requestContentType);
-        const fetchOptions = {
-            headers: {
-                'Content-type': this.requestContentType,
-                ...(this.tokenRequestParameters?.header ?? {}),
-            },
-            body,
-            method: 'POST',
-        };
-        try {
-            const fetchResult = await fetch(this.tokenUrl, fetchOptions);
-            if (fetchResult.status !== 200) {
-                res.status(500).json({ error: `Error fetching token: ${await fetchResult.text()}` });
-            }
-            const response = await fetchResult.json();
-            const credentialsInfo = {
-                accessToken: response.access_token,
-                refreshToken: response.refresh_token,
-            };
-            res.json(credentialsInfo);
-        }
-        catch (error) {
-            res.status(500).json({ error: 'Failed to retrieve access token' });
-        }
-    }
-    async updateToken() {
-        if (!this.refreshToken) {
-            throw new errors_1.NoRefreshTokenError();
-        }
-        if (!Object.values(configurationTypes_1.RequestContentType).includes(this.requestContentType)) {
-            throw new errors_1.InvalidRequestContentTypeError(`Request content type not supported: ${this.requestContentType}`);
-        }
-        const bodyData = {
-            grant_type: 'refresh_token',
-            refresh_token: this.refreshToken,
-        };
-        if (this.clientId) {
-            bodyData.client_id = this.clientId;
-        }
-        if (this.clientSecret) {
-            bodyData.client_secret = this.clientSecret;
-        }
-        const fetchOptions = {
-            headers: {
-                'Content-type': this.requestContentType,
-                ...(this.refreshRequestParameters?.header ?? {}),
-            },
-            body: this.encodeBody(bodyData, this.requestContentType),
-            method: 'POST',
-        };
-        try {
-            const fetchResult = await fetch(this.tokenUrl, fetchOptions);
-            if (fetchResult.status !== 200) {
-                throw new errors_1.FailedToRetrieveAccessTokenError(await fetchResult.text());
-            }
-            const response = await fetchResult.json();
-            const credentialsInfo = {
-                accessToken: response.access_token,
-                refreshToken: response.refresh_token,
-            };
-            return credentialsInfo;
-        }
-        catch (error) {
-            throw new errors_1.FailedToRetrieveAccessTokenError(JSON.stringify(error));
-        }
-    }
-    /**
-     * Starts the Express server for handling OAuth callbacks.
-     * @returns The URL of the server.
-     */
-    /* istanbul ignore next */
-    startServer() {
-        const app = (0, express_1.default)();
-        const PORT = process.env.OAUTH2_PORT ?? 9002;
-        app.use((0, cors_1.default)({ credentials: true, origin: true }));
-        app.get('/health', (req, res) => {
-            res.send('pong');
-        });
-        app.get('/credentials/new/oauth2/authorize', this.handleAuthorize);
-        app.get('/credentials/new/oauth2/callback', this.handleCallback);
-        app.get('/credentials/new/oauth2/token', this.handleToken);
-        this.server = app.listen(PORT, () => {
-            console.log(`Listening at port ${PORT}`);
-        });
-        this.serverUrl = `http://localhost:${PORT}`;
-        return this.serverUrl;
-    }
-    /**
-     * Stops the Express server.
-     */
-    /* istanbul ignore next */
-    stopServer() {
-        if (this.server) {
-            this.server.close(() => {
-                console.log('Server has stopped');
-            });
-        }
-    }
-    /**
-     * Waits for the authorization code to be set.
-     * @returns A promise that resolves when the code is set.
-     */
-    /* istanbul ignore next */
-    async callbackIsDone() {
-        if (this.code) {
-            return true;
-        }
-        else {
-            return new Promise(resolve => {
-                const interval = setInterval(() => {
-                    if (this.code) {
-                        clearInterval(interval);
-                        resolve(true);
-                    }
-                }, 100);
-            });
-        }
-    }
-}
-exports.default = OAuth2Helper;

package/dist/src/oauth2Helper/types.d.ts

@@ -1,22 +0,0 @@
-import { Oauth2 } from '../configurationTypes';
-export interface Oauth2Credentials {
-    clientId: string;
-    clientSecret: string;
-}
-export interface AuthorizePayload extends Oauth2Credentials {
-    providerAuthorizationUrl: string;
-    scopes?: string;
-    providerAccessTokenUrl: string;
-}
-export interface CallbackPayload {
-    code: string;
-}
-export interface Oauth2Response {
-    accessToken: string;
-    refreshToken?: string;
-}
-export interface TokenPayload extends Oauth2Credentials {
-    providerTokenUrl: string;
-    code: string;
-}
-export type Oauth2Payload = Oauth2 & Omit<Oauth2Response, 'accessToken'>;

package/dist/src/oauth2Helper/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/test/mocha.hooks.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="mocha" />
-export declare const mochaHooks: () => Mocha.RootHookObject;

package/dist/test/mocha.hooks.js

@@ -1,37 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mochaHooks = void 0;
-const mochaHooks = () => {
-    return {
-        async beforeAll() {
-            // Allow using `chai-as-promised` in all tests.
-            const chai = await Promise.resolve().then(() => __importStar(require('chai')));
-            const chaiAsPromised = await Promise.resolve().then(() => __importStar(require('chai-as-promised')));
-            chai.use(chaiAsPromised.default);
-        },
-    };
-};
-exports.mochaHooks = mochaHooks;

package/dist/test/services/oauth2Helper.test.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const chai_1 = require("chai");
-const sinon_1 = tslib_1.__importDefault(require("sinon"));
-const oauth2Helper_1 = tslib_1.__importDefault(require("../../src/oauth2Helper/oauth2Helper"));
-const configurationTypes_1 = require("../../src/configurationTypes");
-const oauth2HelperService = tslib_1.__importStar(require("../../src/services/oauth2Helper"));
-const errors_1 = require("../../src/errors");
-const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
-describe('OAuth2Helper', () => {
-    let fetchStub;
-    const authorizationInfo = {
-        clientId: 'your-client-id',
-        clientSecret: 'your-client-secret',
-        authorizationUrl: 'https://provider.com/oauth/authorize',
-        scopes: [{ name: 'scope1' }, { name: 'scope2' }],
-        tokenUrl: 'https://provider.com/oauth/token',
-        grantType: configurationTypes_1.GrantType.AUTHORIZATION_CODE,
-        requestContentType: configurationTypes_1.RequestContentType.URL_ENCODED,
-        responseContentType: configurationTypes_1.RequestContentType.JSON,
-    };
-    beforeEach(() => {
-        sinon_1.default.stub(oauth2Helper_1.default.prototype, 'startServer').returns('http://localhost:5050');
-        sinon_1.default.stub(oauth2Helper_1.default.prototype, 'stopServer');
-        sinon_1.default.stub(oauth2Helper_1.default.prototype, 'callbackIsDone');
-        sinon_1.default.stub(inquirer_1.default, 'prompt');
-    });
-    afterEach(() => {
-        sinon_1.default.restore();
-    });
-    describe('performOAuth2Flow', () => {
-        it('should perform the oauth flow', async () => {
-            fetchStub = sinon_1.default
-                .stub()
-                .onFirstCall()
-                .resolves({ status: 200 })
-                .onSecondCall()
-                .resolves({ status: 200 })
-                .onThirdCall()
-                .resolves({
-                status: 200,
-                json: () => {
-                    return { accessToken: 'token', refresToken: 'refreshToken' };
-                },
-            });
-            sinon_1.default.replace(global, 'fetch', fetchStub);
-            await oauth2HelperService.performOAuth2Flow(authorizationInfo);
-            (0, chai_1.expect)(fetchStub.getCall(0).args.at(0)).to.eq('http://localhost:5050/health');
-            (0, chai_1.expect)(fetchStub.getCall(1).args.at(0)).to.eq('http://localhost:5050/credentials/new/oauth2/authorize');
-            (0, chai_1.expect)(fetchStub.getCall(2).args.at(0)).to.eq('http://localhost:5050/credentials/new/oauth2/token');
-        });
-        it('raises a FailedToRetrieveAccessTokenError', async () => {
-            fetchStub = sinon_1.default
-                .stub()
-                .onFirstCall()
-                .resolves({ status: 200 })
-                .onSecondCall()
-                .resolves({ status: 200 })
-                .onThirdCall()
-                .resolves({ status: 500, text: () => 'error' });
-            sinon_1.default.replace(global, 'fetch', fetchStub);
-            const response = oauth2HelperService.performOAuth2Flow(authorizationInfo);
-            await (0, chai_1.expect)(response).to.be.rejectedWith(errors_1.FailedToRetrieveAccessTokenError);
-        });
-        it('raises a FailedToRetrieveAccessTokenError when the accessToken is not returned', async () => {
-            fetchStub = sinon_1.default
-                .stub()
-                .onFirstCall()
-                .resolves({ status: 200 })
-                .onSecondCall()
-                .resolves({ status: 200 })
-                .onThirdCall()
-                .resolves({
-                status: 200,
-                json: () => {
-                    return {};
-                },
-            });
-            sinon_1.default.replace(global, 'fetch', fetchStub);
-            const response = oauth2HelperService.performOAuth2Flow(authorizationInfo);
-            await (0, chai_1.expect)(response).to.be.rejectedWith(errors_1.FailedToRetrieveAccessTokenError);
-        });
-    });
-});