@unito/integration-cli 0.57.2 → 0.58.0

package/dist/integrationGenerator/test/resources/integration.test.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const strict_1 = tslib_1.__importDefault(require("node:assert/strict"));
-const path = tslib_1.__importStar(require("path"));
-const sinon = tslib_1.__importStar(require("sinon"));
-const tmp_1 = tslib_1.__importDefault(require("tmp"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const Integration = tslib_1.__importStar(require("../../src/resources/integration"));
-describe('Integration Resource Generation', () => {
-    let tempDir;
-    const boilerplatePath = path.join(__dirname, '../../integrationBoilerplate');
-    afterEach(() => {
-        sinon.restore();
-    });
-    describe('generateIntegrationSkeleton', () => {
-        beforeEach(() => {
-            tempDir = tmp_1.default.dirSync({ prefix: 'outputIntegrations-' }).name;
-        });
-        afterEach(async () => {
-            await fs_1.default.promises.rm(tempDir, { recursive: true });
-        });
-        it('should not create a new integration directory if it already exists', async () => {
-            const existingIntegrationName = 'existingIntegration';
-            await Integration.generateIntegrationSkeleton(existingIntegrationName, tempDir);
-            try {
-                await Integration.generateIntegrationSkeleton(existingIntegrationName, tempDir);
-            }
-            catch (e) {
-                (0, strict_1.default)(e.message.includes('already exists with this name'));
-            }
-        });
-        it('should create a new integration directory if it does not exist', async () => {
-            const integrationName = 'NewIntegration';
-            const result = await Integration.generateIntegrationSkeleton(integrationName, tempDir);
-            strict_1.default.equal(result, path.join(tempDir, integrationName.toLowerCase()));
-            (0, strict_1.default)(fs_1.default.existsSync(result));
-            const expectedFiles = await fs_1.default.promises.readdir(boilerplatePath);
-            expectedFiles.push('.npmrc');
-            const createdFiles = await fs_1.default.promises.readdir(result);
-            strict_1.default.deepEqual(createdFiles, expectedFiles.sort());
-            createdFiles.forEach(createdField => (0, strict_1.default)(expectedFiles.includes(createdField)));
-        });
-        it('generates an .npmrc file', async () => {
-            const result = await Integration.generateIntegrationSkeleton('foo', tempDir);
-            const npmrc = await fs_1.default.promises.readFile(`${result}/.npmrc`, 'utf-8');
-            (0, strict_1.default)(npmrc.includes('//npm.pkg.github.com/:_authToken=${UNITO_GITHUB_PKG_TOKEN}'));
-        });
-    });
-});

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

@@ -1,65 +0,0 @@
-import * as openUrl from 'openurl';
-import { Oauth2Response, Oauth2Payload } from './types';
-import { Environment } from '../resources/globalConfiguration';
-export declare const open: typeof openUrl;
-declare class OAuth2Helper {
-    private environment;
-    private server;
-    private clientId;
-    private clientSecret;
-    private providerAuthorizationUrl;
-    private tokenUrl;
-    private scopes;
-    private grantType;
-    private requestContentType;
-    private responseContentType;
-    private refreshToken?;
-    private code;
-    private serverUrl;
-    private tokenRequestParameters;
-    private 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: Oauth2Payload, environment?: Environment);
-    /**
-     * 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.
-     */
-    private handleAuthorize;
-    /**
-     * Handles the callback request from the provider and stores the authorization code.
-     * @param req The express Request object.
-     * @param res The express Response object.
-     */
-    private handleCallback;
-    private encodeBody;
-    /**
-     * 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.
-     */
-    private handleToken;
-    updateToken(): Promise<Oauth2Response>;
-    /**
-     * Starts the Express server for handling OAuth callbacks.
-     * @returns The URL of the server.
-     */
-    startServer(): Promise<string>;
-    /**
-     * Stops the Express server.
-     */
-    stopServer(): void;
-    /**
-     * Waits for the authorization code to be set.
-     * @returns A promise that resolves when the code is set.
-     */
-    callbackIsDone(): Promise<boolean>;
-}
-export default OAuth2Helper;

package/dist/src/oauth2Helper/oauth2Helper.js

@@ -1,255 +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 ngrok_1 = tslib_1.__importDefault(require("ngrok"));
-const IntegrationsPlatformClient = tslib_1.__importStar(require("../services/integrationsPlatform"));
-const configurationTypes_1 = require("../configurationTypes");
-const errors_1 = require("../errors");
-const globalConfiguration_1 = require("../resources/globalConfiguration");
-// It allows to stub openUrl library in the test
-exports.open = openUrl;
-class OAuth2Helper {
-    environment;
-    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, environment = globalConfiguration_1.Environment.Production) {
-        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;
-        this.environment = environment;
-    }
-    /**
-     * 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', `${IntegrationsPlatformClient.Servers[this.environment]}/credentials/new/oauth2/callback-cli`);
-        const state = Buffer.from(JSON.stringify({
-            cliCallbackUrl: `${this.serverUrl}/credentials/new/oauth2/callback`,
-        })).toString('base64');
-        params.set('state', state);
-        if (this.scopes) {
-            params.set('scope', this.scopes.join(' '));
-        }
-        params.set('response_type', 'code');
-        authUrl.search = params.toString();
-        exports.open.open(authUrl.toString());
-        res.sendStatus(200);
-    }
-    /**
-     * 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) {
-        try {
-            const { code } = req.body.query;
-            this.code = code;
-        }
-        catch (error) {
-            // If we do not receive a code, set it 'error' to let the command know that the callback failed
-            console.error('Error during OAuth2 callback', error);
-            this.code = 'error';
-        }
-        res.sendStatus(200);
-    }
-    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}` });
-        }
-        if (this.code === 'error') {
-            throw new errors_1.FailedToRetrieveAccessTokenError('Error during OAuth2 callback - aborting');
-        }
-        const bodyData = {
-            code: this.code,
-            grant_type: this.grantType,
-            redirect_uri: `${IntegrationsPlatformClient.Servers[this.environment]}/credentials/new/oauth2/callback-cli`,
-        };
-        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 */
-    async startServer() {
-        const app = (0, express_1.default)();
-        const PORT = process.env.OAUTH2_PORT ?? 9002;
-        this.serverUrl = await ngrok_1.default.connect(Number(PORT));
-        app.use((0, cors_1.default)({ credentials: true, origin: true }));
-        app.use(express_1.default.json());
-        app.get('/health', (_req, res) => {
-            res.send('pong');
-        });
-        app.get('/credentials/new/oauth2/authorize', this.handleAuthorize);
-        app.post('/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}`);
-        });
-        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 });