npm - @unito/integration-cli - Versions diffs - 0.57.2 → 0.58.0 - Mend

@unito/integration-cli 0.57.2 → 0.58.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (88) hide show

package/dist/src/services/oauth2Helper.d.ts CHANGED Viewed

@@ -1,4 +1,78 @@
-import { Oauth2Response, Oauth2Payload } from '../oauth2Helper/types';
+import * as openUrl from 'openurl';
+import { Oauth2 } from '../configurationTypes';
 import { Environment } from '../resources/globalConfiguration';
-export declare function performOAuth2Flow(applicationCredentials: Oauth2Payload, environment?: Environment): Promise<Oauth2Response>;
-export declare function updateToken(applicationCredentials: Oauth2Payload): Promise<Oauth2Response>;
+export declare const open: typeof openUrl;
+export declare const HTML_ERROR_MSG = "<!doctype html><head><title>Unito</title></head><body style=\"text-align:center\"> An unknown error occured </body>";
+export declare const HTML_SUCCESS_MSG = "<!doctype html><head><title>Unito</title></head><body style=\"text-align:center\"> Redirected to the CLI successfully </body>";
+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;
+declare class OAuth2Helper {
+    private environment;
+    private server;
+    private clientId;
+    private clientSecret;
+    private providerAuthorizationUrl;
+    private tokenUrl;
+    private scopes;
+    private grantType;
+    private requestContentType;
+    private oauth2Response;
+    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);
+    /**
+     * Initiate the authorization flow and redirects the user to the provider's authorization page.
+     */
+    authorize(): Promise<void>;
+    /**
+     * 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;
+    /**
+     * Waits for the authorization code to be set.
+     * @returns A promise that resolves when the code is set.
+     */
+    callbackIsDone(): Promise<Oauth2Response>;
+    private encodeBody;
+    updateToken(refreshToken: string): Promise<Oauth2Response>;
+    /**
+     * Starts the Express server for handling OAuth callbacks.
+     * @returns The URL of the server.
+     */
+    startServer(): Promise<string>;
+    /**
+     * Stops the Express server.
+     */
+    stopServer(): Promise<void>;
+}
+export default OAuth2Helper;

package/dist/src/services/oauth2Helper.js CHANGED Viewed

@@ -1,35 +1,234 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateToken = exports.performOAuth2Flow = void 0;
+exports.HTML_SUCCESS_MSG = exports.HTML_ERROR_MSG = exports.open = void 0;
 const tslib_1 = require("tslib");
-const oauth2Helper_1 = tslib_1.__importDefault(require("../oauth2Helper/oauth2Helper"));
+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("./integrationsPlatform"));
+const configurationTypes_1 = require("../configurationTypes");
 const errors_1 = require("../errors");
 const globalConfiguration_1 = require("../resources/globalConfiguration");
-async function performOAuth2Flow(applicationCredentials, environment = globalConfiguration_1.Environment.Production) {
-    const oauthHelper = new oauth2Helper_1.default(applicationCredentials, environment);
-    const serverUrl = await oauthHelper.startServer();
-    const healthCheck = await fetch(`${serverUrl}/health`);
-    if (healthCheck.status !== 200) {
-        throw new Error('OAuthServer did not start');
-    }
-    await fetch(`${serverUrl}/credentials/new/oauth2/authorize`);
-    await oauthHelper.callbackIsDone();
-    const response = await fetch(`${serverUrl}/credentials/new/oauth2/token`);
-    if (response.status !== 200) {
-        throw new errors_1.FailedToRetrieveAccessTokenError(await response.text());
-    }
-    const credentials = await response.json();
-    oauthHelper.stopServer();
-    if (!credentials.accessToken) {
-        throw new errors_1.FailedToRetrieveAccessTokenError('Access token was not returned');
-    }
-    return credentials;
-}
-exports.performOAuth2Flow = performOAuth2Flow;
-/* istanbul ignore next */
-// No point to test this function as it is just a wrapper around OAuth2Helper
-async function updateToken(applicationCredentials) {
-    const oauthHelper = new oauth2Helper_1.default(applicationCredentials);
-    return oauthHelper.updateToken();
+// It allows to stub openUrl library in the test
+exports.open = openUrl;
+exports.HTML_ERROR_MSG = `<!doctype html><head><title>Unito</title></head><body style="text-align:center"> An unknown error occured </body>`;
+exports.HTML_SUCCESS_MSG = `<!doctype html><head><title>Unito</title></head><body style="text-align:center"> Redirected to the CLI successfully </body>`;
+class OAuth2Helper {
+    environment;
+    server = null;
+    clientId;
+    clientSecret;
+    providerAuthorizationUrl;
+    tokenUrl;
+    scopes;
+    grantType;
+    requestContentType;
+    oauth2Response;
+    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, refreshRequestParameters, tokenRequestParameters, } = authorizationInfo;
+        this.startServer = this.startServer.bind(this);
+        this.stopServer = this.stopServer.bind(this);
+        this.handleCallback = this.handleCallback.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.tokenRequestParameters = tokenRequestParameters;
+        this.refreshRequestParameters = refreshRequestParameters;
+        this.environment = environment;
+        if (!Object.values(configurationTypes_1.RequestContentType).includes(this.requestContentType)) {
+            throw new errors_1.UnsupportedContentTypeError(`Request content type not supported: ${this.requestContentType}`);
+        }
+    }
+    /**
+     * Initiate the authorization flow and redirects the user to the provider's authorization page.
+     */
+    async authorize() {
+        if (!this.providerAuthorizationUrl) {
+            throw new errors_1.InvalidRequestContentTypeError('authorizationUrl must be defined in .unito.json');
+        }
+        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}/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());
+    }
+    /**
+     * 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) {
+        // Authorization Response: https://www.rfc-editor.org/rfc/rfc6749#section-4.1.2
+        // const state = req.state as string;
+        // Error response: https://www.rfc-editor.org/rfc/rfc6749#section-4.1.2.1
+        const error = req.query.error;
+        if (error) {
+            res.setHeader('Content-Type', 'text/html').send(exports.HTML_ERROR_MSG);
+            return;
+        }
+        const code = req.query.code;
+        const bodyData = {
+            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 fetchOptions = {
+            headers: {
+                'Content-type': this.requestContentType,
+                ...(this.tokenRequestParameters?.header ?? {}),
+            },
+            body: this.encodeBody(bodyData, this.requestContentType),
+            method: 'POST',
+        };
+        try {
+            const fetchResult = await fetch(this.tokenUrl, fetchOptions);
+            if (fetchResult.status !== 200) {
+                res.setHeader('Content-Type', 'text/html');
+                res.send(exports.HTML_ERROR_MSG);
+            }
+            const response = await fetchResult.json();
+            this.oauth2Response = {
+                accessToken: response.access_token,
+                refreshToken: response.refresh_token,
+            };
+            res.setHeader('Content-Type', 'text/html');
+            res.send(exports.HTML_SUCCESS_MSG);
+        }
+        catch (error) {
+            res.setHeader('Content-Type', 'text/html');
+            res.send(exports.HTML_ERROR_MSG);
+        }
+    }
+    /**
+     * 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.oauth2Response) {
+            return this.oauth2Response;
+        }
+        else {
+            return new Promise(resolve => {
+                const interval = setInterval(() => {
+                    if (this.oauth2Response) {
+                        clearInterval(interval);
+                        resolve(this.oauth2Response);
+                    }
+                }, 100);
+            });
+        }
+    }
+    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);
+        }
+    }
+    async updateToken(refreshToken) {
+        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: 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('/oauth2/callback', this.handleCallback);
+        this.server = app.listen(PORT, () => {
+            console.log(`Listening at port ${PORT}`);
+        });
+        return this.serverUrl;
+    }
+    /**
+     * Stops the Express server.
+     */
+    /* istanbul ignore next */
+    async stopServer() {
+        if (this.server) {
+            await ngrok_1.default.kill();
+            this.server.close(() => {
+                console.log('Server has stopped');
+            });
+        }
+    }
 }
-exports.updateToken = updateToken;
+exports.default = OAuth2Helper;

package/dist/test/commands/dev.test.js CHANGED Viewed

@@ -9,6 +9,7 @@ const IntegrationsPlatform = tslib_1.__importStar(require("../../src/services/in
 const IntegrationsPlatformResource = tslib_1.__importStar(require("../../src/resources/integrationsPlatform"));
 const ConfigurationResource = tslib_1.__importStar(require("../../src/resources/configuration"));
 const IntegrationResource = tslib_1.__importStar(require("../../src/resources/integrations"));
+const CredentialResource = tslib_1.__importStar(require("../../src/resources/credentials"));
 describe('Dev', () => {
     const debuggerConfiguration = {
         ...IntegrationDebugger.getDefaultConfiguration(),
@@ -164,4 +165,24 @@ describe('Dev', () => {
         .it('overrides --webhook-acknowledge-relative-url', () => {
         (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.include('--webhook-acknowledge-relative-url=bar');
     });
+    test_1.test
+        .stdout()
+        .stub(ConfigurationResource, 'getConfiguration', stub => stub.returns({}))
+        .stub(IntegrationResource, 'validateIsIntegrationDirectory', stub => stub.returns(true))
+        .stub(CredentialResource, 'fetchCredential', stub => stub.resolves({ payload: { from: 'credential' } }))
+        .command(['dev', '--credential-id=123'])
+        .it('credential-id', () => {
+        (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.include('--credential-payload={"from":"credential"}');
+        (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.include('--read-only');
+    });
+    test_1.test
+        .stdout()
+        .stub(ConfigurationResource, 'getConfiguration', stub => stub.returns({}))
+        .stub(IntegrationResource, 'validateIsIntegrationDirectory', stub => stub.returns(true))
+        .stub(CredentialResource, 'fetchCredential', stub => stub.resolves({ payload: { from: 'credential' } }))
+        .command(['dev', '--credential-id=123', '--no-read-only'])
+        .it('credential-id && read-only', () => {
+        (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.include('--credential-payload={"from":"credential"}');
+        (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.not.include('--read-only');
+    });
 });

package/dist/test/commands/init.test.js CHANGED Viewed

@@ -4,7 +4,7 @@ const tslib_1 = require("tslib");
 const test_1 = require("@oclif/test");
 const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const sinon = tslib_1.__importStar(require("sinon"));
-const integrationGenerator_1 = require("../../integrationGenerator");
+const IntegrationResource = tslib_1.__importStar(require("../../src/resources/integrations"));
 const Configuration = tslib_1.__importStar(require("../../src/resources/configuration"));
 describe('init', () => {
     beforeEach(() => {
@@ -17,7 +17,7 @@ describe('init', () => {
     });
     test_1.test
         .stub(inquirer_1.default, 'prompt', stub => stub.resolves({ name: 'myIntegration' }))
-        .stub(integrationGenerator_1.Resources.Integration, 'generateIntegrationSkeleton', stub => stub.returns('/my/super/path/myIntegration'))
+        .stub(IntegrationResource, 'copyBoilerplate', stub => stub.returns('/my/super/path/myIntegration'))
         .stub(process, 'chdir', stub => stub.returns(''))
         .stdout()
         .command(['init'])
@@ -25,7 +25,7 @@ describe('init', () => {
         (0, test_1.expect)(ctx.stdout).to.contain('Your integration is available at');
     });
     test_1.test
-        .stub(integrationGenerator_1.Resources.Integration, 'generateIntegrationSkeleton', stub => stub.returns('/my/super/path/myIntegration'))
+        .stub(IntegrationResource, 'copyBoilerplate', stub => stub.returns('/my/super/path/myIntegration'))
         .stub(process, 'chdir', stub => stub.returns(''))
         .stdout()
         .command(['init', '-n', 'myIntegration'])
@@ -33,7 +33,7 @@ describe('init', () => {
         (0, test_1.expect)(ctx.stdout).to.contain('Your integration is available at');
     });
     test_1.test
-        .stub(integrationGenerator_1.Resources.Integration, 'generateIntegrationSkeleton', stub => stub.throws(new Error('boom!')))
+        .stub(IntegrationResource, 'copyBoilerplate', stub => stub.throws(new Error('boom!')))
         .stdout()
         .command(['init', '-n', 'myIntegration'])
         .catch(ctx => {

package/dist/test/commands/login.test.js CHANGED Viewed

@@ -79,6 +79,7 @@ describe('Login', () => {
         .it('handles platform error');
     test_1.test
         .stdout()
+        .stderr()
         .stub(GlobalConfiguration, 'read', stub => stub.throws(new errors_1.ConfigurationMalformed()))
         .command(['login'])
         .exit(-1)

package/dist/test/commands/oauth2.test.js CHANGED Viewed

@@ -6,7 +6,7 @@ const core_1 = require("@oclif/core");
 const sinon = tslib_1.__importStar(require("sinon"));
 const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const Configuration = tslib_1.__importStar(require("../../src/resources/configuration"));
-const oauth2Service = tslib_1.__importStar(require("../../src/services/oauth2Helper"));
+const oauth2Service = tslib_1.__importStar(require("../../src/resources/oauth2Helper"));
 const IntegrationsPlatform = tslib_1.__importStar(require("../../src/services/integrationsPlatform"));
 const decryptionResource = tslib_1.__importStar(require("../../src/resources/decryption"));
 const configurationTypes_1 = require("../../src/configurationTypes");
@@ -59,6 +59,7 @@ describe('oauth2', () => {
     });
     test_1.test
         .stdout()
+        .stderr()
         .do(() => getConfigurationsStub.returns({
         ...baseConfiguration,
         authorizations: [],

package/dist/test/commands/publish.test.js CHANGED Viewed

@@ -258,6 +258,7 @@ describe('Publish', () => {
     });
     test_1.test
         .stdout()
+        .stderr()
         .stub(GlobalConfiguration, 'read', stub => stub.throws(new errors_1.NoConfigurationFileError()))
         .stub(FileSystem, 'getFileBuffer', stub => stub.resolves(Buffer.from('')))
         .command(['publish'])

package/dist/test/commands/test.test.js CHANGED Viewed

@@ -8,6 +8,7 @@ const IntegrationsPlatform = tslib_1.__importStar(require("../../src/services/in
 const IntegrationsPlatformResource = tslib_1.__importStar(require("../../src/resources/integrationsPlatform"));
 const ConfigurationResource = tslib_1.__importStar(require("../../src/resources/configuration"));
 const IntegrationResource = tslib_1.__importStar(require("../../src/resources/integrations"));
+const CredentialResource = tslib_1.__importStar(require("../../src/resources/credentials"));
 const errors_1 = require("../../src/errors");
 describe('Test', () => {
     const cliConfiguration = {
@@ -50,6 +51,7 @@ describe('Test', () => {
     });
     test_1.test
         .stdout()
+        .stderr()
         .stub(ConfigurationResource, 'getConfiguration', stub => stub.resolves(cliConfiguration))
         .stub(IntegrationResource, 'validateIsIntegrationDirectory', stub => stub.throws(new Error('boom!')))
         .command(['test'])
@@ -187,4 +189,24 @@ describe('Test', () => {
         .it('overrides --webhook-acknowledge-relative-url', () => {
         (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.include('--webhook-acknowledge-relative-url=bar');
     });
+    test_1.test
+        .stdout()
+        .stub(ConfigurationResource, 'getConfiguration', stub => stub.resolves(cliConfiguration))
+        .stub(IntegrationResource, 'validateIsIntegrationDirectory', stub => stub.returns(true))
+        .stub(CredentialResource, 'fetchCredential', stub => stub.resolves({ payload: { from: 'credential' } }))
+        .command(['test', '--credential-id=123'])
+        .it('credential-id', () => {
+        (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.include('--credential-payload={"from":"credential"}');
+        (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.include('--read-only');
+    });
+    test_1.test
+        .stdout()
+        .stub(ConfigurationResource, 'getConfiguration', stub => stub.resolves(cliConfiguration))
+        .stub(IntegrationResource, 'validateIsIntegrationDirectory', stub => stub.returns(true))
+        .stub(CredentialResource, 'fetchCredential', stub => stub.resolves({ payload: { from: 'credential' } }))
+        .command(['test', '--credential-id=123', '--no-read-only'])
+        .it('credential-id && read-only', () => {
+        (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.include('--credential-payload={"from":"credential"}');
+        (0, test_1.expect)(spawnStub.getCall(0).args.at(1)).to.not.include('--read-only');
+    });
 });

package/dist/test/commands/upgrade.test.js CHANGED Viewed

@@ -37,6 +37,7 @@ describe('Upgrade', () => {
     });
     test_1.test
         .stdout()
+        .stderr()
         .stub(child_process_1.default, 'execSync', stub => stub.throws(new errors_1.ConfigurationMalformed()))
         .command(['upgrade'])
         .exit(-1)