@unito/integration-cli 0.56.1 → 0.57.0

package/dist/src/commands/activity.d.ts

@@ -6,7 +6,9 @@ export default class Activity extends BaseCommand<typeof Activity> {
     static flags: {
         number: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         environment: import("@oclif/core/lib/interfaces").OptionFlag<GlobalConfiguration.Environment | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        follow: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     catch(error: Error): Promise<void>;
     run(): Promise<void>;
+    private wait;
 }

package/dist/src/commands/activity.js

@@ -25,6 +25,13 @@ class Activity extends baseCommand_1.BaseCommand {
             options: Object.values(GlobalConfiguration.Environment),
             default: GlobalConfiguration.Environment.Production,
         })(),
+        follow: core_1.Flags.boolean({
+            char: 'f',
+            summary: 'follow the activity',
+            description: `Follow the activity of your integration. This will keep the command running and will show new events as they are created.
+
+      Usage: <%= config.bin %> <%= command.id %> --follow`,
+        }),
     };
     async catch(error) {
         /* istanbul ignore if */
@@ -71,14 +78,33 @@ class Activity extends baseCommand_1.BaseCommand {
         }
         core_1.ux.action.stop();
         core_1.ux.action.start('Retrieving activity');
-        const events = await IntegrationsPlatform.getIntegrationEvents(integration.id);
-        core_1.ux.action.stop();
-        for (const event of events.slice(0, flags.number ?? 1000)) {
-            core_1.ux.log();
-            core_1.ux.log(chalk_1.default.bold(`  ${event.date} - ${event.title}`));
-            core_1.ux.log(`  ${event.text}`);
-            core_1.ux.log(chalk_1.default.dim(chalk_1.default.italic(`  ${event.tags.join(', ')}`)));
+        let lastEventDate;
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            const getEventsOptions = {
+                $from: lastEventDate,
+                limit: flags.number,
+            };
+            const events = (await IntegrationsPlatform.getIntegrationEvents(integration.id, getEventsOptions)).reverse();
+            for (const event of events) {
+                core_1.ux.log();
+                core_1.ux.log(chalk_1.default.bold(`  ${event.date} - ${event.title}`));
+                core_1.ux.log(`  ${event.text}`);
+                core_1.ux.log(chalk_1.default.dim(chalk_1.default.italic(`  ${event.tags.join(', ')}`)));
+            }
+            if (process.env.NODE_ENV === 'test' || !flags.follow) {
+                break;
+            }
+            const mostRecentEvent = events.at(-1);
+            const mostRecentEventTimestamp = Date.parse(mostRecentEvent?.date ?? '');
+            lastEventDate = isNaN(mostRecentEventTimestamp) ? Date.now() : mostRecentEventTimestamp + 1;
+            // Wait 5 seconds before checking for new events.
+            await this.wait(5000);
         }
+        core_1.ux.action.stop();
+    }
+    async wait(ms) {
+        return new Promise(resolve => setTimeout(resolve, ms));
     }
 }
 exports.default = Activity;

package/dist/src/commands/dev.js

@@ -54,7 +54,7 @@ class Dev extends baseCommand_1.BaseCommand {
         (0, integrations_1.validateIsIntegrationDirectory)();
         const { flags } = await this.parse(Dev);
         // Install NPM dependencies.
-        core_1.ux.action.start('Installing NPM dependencies');
+        core_1.ux.action.start('Installing NPM dependencies', undefined, { stdout: true });
         child_process_1.default.execSync('npm install', {
             env: { ...process.env, NODE_ENV: 'development' },
             stdio: ['ignore', 'ignore', 'inherit'],

package/dist/src/commands/publish.js

@@ -238,6 +238,7 @@ class Publish extends baseCommand_1.BaseCommand {
         core_1.ux.log('');
         core_1.ux.log(['Your integration', gradient.fruit(integrationConfiguration.name), 'is being published.'].join(' '));
         core_1.ux.log(chalk_1.default.yellowBright("Note that if the code of your integration did not change, it won't be republished."));
+        core_1.ux.log(chalk_1.default.blueBright(`You can follow the publishing of ${gradient.fruit(integrationConfiguration.name)} by running the command ${chalk_1.default.yellowBright('integration-cli activity --follow')}.`));
     }
     indent(paragraph, tabs = 1) {
         return paragraph

package/dist/src/commands/test.js

@@ -98,9 +98,6 @@ class Test extends baseCommand_1.BaseCommand {
             }
             credentialPayload = JSON.stringify(credentials);
         }
-        if (!credentialPayload || credentialPayload === '{}') {
-            throw new errors_1.MissingCredentialsError();
-        }
         let secrets = {};
         // Decrypt secrets, if necessary.
         if (configuration.secrets) {

package/dist/src/commands/upgrade.js

@@ -6,7 +6,6 @@ const child_process_1 = tslib_1.__importDefault(require("child_process"));
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const baseCommand_1 = require("../baseCommand");
 const errors_1 = require("../errors");
-const errors_2 = require("../errors");
 class Upgrade extends baseCommand_1.BaseCommand {
     static description = 'Upgrade the CLI';
     static examples = ['<%= config.bin %> <%= command.id %>'];
@@ -18,17 +17,6 @@ class Upgrade extends baseCommand_1.BaseCommand {
         throw error;
     }
     async run() {
-        //
-        // Check for the presence of UNITO_GITHUB_PKG_TOKEN.
-        //
-        // Necessary until we deploy to a public NPM repository.
-        //
-        core_1.ux.action.start('Checking for the presence of UNITO_GITHUB_PKG_TOKEN');
-        // istanbul ignore next
-        if (!process.env.UNITO_GITHUB_PKG_TOKEN) {
-            throw new errors_2.MissingEnvironmentVariableError('UNITO_GITHUB_PKG_TOKEN');
-        }
-        core_1.ux.action.stop('found');
         //
         // Global command options
         //

package/dist/src/errors.d.ts

@@ -5,16 +5,12 @@ export declare class NoConfigurationFileError extends Error {
 }
 export declare class ConfigurationMalformed extends Error {
 }
-export declare class MissingEnvironmentVariableError extends Error {
-}
 export declare class NoRefreshTokenError extends Error {
 }
 export declare class FailedToRetrieveAccessTokenError extends Error {
 }
 export declare class InvalidRequestContentTypeError extends Error {
 }
-export declare class MissingCredentialsError extends Error {
-}
 export declare class MissingAuth2AuthorizationError extends Error {
 }
 export declare class FileSizeExceeded extends Error {
@@ -24,8 +20,6 @@ export declare class MissingApiKey extends Error {
 export declare class AuthenticationFailed extends Error {
 }
 export declare class DecryptionAuthenticationError extends Error {
-    encryptedEntityName: string;
-    constructor(entityName: string);
 }
 export declare class EntryDecryptionError extends Error {
     key: string;

package/dist/src/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleError = exports.ConfigurationInvalid = exports.EntryDecryptionError = exports.DecryptionAuthenticationError = exports.AuthenticationFailed = exports.MissingApiKey = exports.FileSizeExceeded = exports.MissingAuth2AuthorizationError = exports.MissingCredentialsError = exports.InvalidRequestContentTypeError = exports.FailedToRetrieveAccessTokenError = exports.NoRefreshTokenError = exports.MissingEnvironmentVariableError = exports.ConfigurationMalformed = exports.NoConfigurationFileError = exports.NoIntegrationFoundError = void 0;
+exports.handleError = exports.ConfigurationInvalid = exports.EntryDecryptionError = exports.DecryptionAuthenticationError = exports.AuthenticationFailed = exports.MissingApiKey = exports.FileSizeExceeded = exports.MissingAuth2AuthorizationError = exports.InvalidRequestContentTypeError = exports.FailedToRetrieveAccessTokenError = exports.NoRefreshTokenError = exports.ConfigurationMalformed = exports.NoConfigurationFileError = exports.NoIntegrationFoundError = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
@@ -17,9 +17,6 @@ exports.NoConfigurationFileError = NoConfigurationFileError;
 class ConfigurationMalformed extends Error {
 }
 exports.ConfigurationMalformed = ConfigurationMalformed;
-class MissingEnvironmentVariableError extends Error {
-}
-exports.MissingEnvironmentVariableError = MissingEnvironmentVariableError;
 class NoRefreshTokenError extends Error {
 }
 exports.NoRefreshTokenError = NoRefreshTokenError;
@@ -29,9 +26,6 @@ exports.FailedToRetrieveAccessTokenError = FailedToRetrieveAccessTokenError;
 class InvalidRequestContentTypeError extends Error {
 }
 exports.InvalidRequestContentTypeError = InvalidRequestContentTypeError;
-class MissingCredentialsError extends Error {
-}
-exports.MissingCredentialsError = MissingCredentialsError;
 class MissingAuth2AuthorizationError extends Error {
 }
 exports.MissingAuth2AuthorizationError = MissingAuth2AuthorizationError;
@@ -45,11 +39,6 @@ class AuthenticationFailed extends Error {
 }
 exports.AuthenticationFailed = AuthenticationFailed;
 class DecryptionAuthenticationError extends Error {
-    encryptedEntityName;
-    constructor(entityName) {
-        super();
-        this.encryptedEntityName = entityName;
-    }
 }
 exports.DecryptionAuthenticationError = DecryptionAuthenticationError;
 class EntryDecryptionError extends Error {
@@ -90,11 +79,6 @@ function handleError(command, error) {
         command.logToStderr(`This file should be located at ${chalk_1.default.yellowBright(path_1.default.relative(process.cwd(), (0, configuration_1.getConfigurationPath)()))}.`);
         handled = true;
     }
-    else if (error instanceof MissingEnvironmentVariableError) {
-        command.logToStderr(chalk_1.default.redBright('This command requires a variable which is missing from your environment :('));
-        command.logToStderr(`Make sure the environment variable ${chalk_1.default.yellowBright(error.message)} is defined.`);
-        handled = true;
-    }
     else if (error instanceof ConfigurationMalformed) {
         command.logToStderr(chalk_1.default.redBright(`Your ${chalk_1.default.yellowBright(configuration_1.DEFAULT_CONFIGURATION_NAME)} was found but its not a valid JSON file!`));
         handled = true;
@@ -126,35 +110,36 @@ function handleError(command, error) {
         command.logToStderr();
         command.logToStderr((0, json_colorizer_1.default)(JSON.stringify(error.data, null, 2)));
     }
-    else if (error instanceof MissingCredentialsError) {
-        command.logToStderr();
-        command.logToStderr(chalk_1.default.redBright('The credentials are missing from your configuration file'));
-        handled = true;
-    }
     else if (error instanceof MissingApiKey) {
         command.logToStderr();
         command.logToStderr(chalk_1.default.redBright('Your API key is not set!'));
-        command.logToStderr(`Make sure to run the ${chalk_1.default.yellowBright('login')} command first`);
+        command.logToStderr(`Make sure to run the ${chalk_1.default.yellowBright('login')} command first.`);
         handled = true;
     }
     else if (error instanceof AuthenticationFailed) {
         command.logToStderr();
         command.logToStderr(chalk_1.default.redBright('This command requires that you are logged to Unito!'));
-        command.logToStderr(`Make sure to run the ${chalk_1.default.yellowBright('login')} command first`);
+        command.logToStderr(`Make sure to run the ${chalk_1.default.yellowBright('login')} command first.`);
         handled = true;
     }
     else if (error instanceof DecryptionAuthenticationError) {
         command.logToStderr();
-        command.logToStderr(chalk_1.default.yellowBright(`Your configuration contains encrypted ${error.encryptedEntityName}.`));
-        command.logToStderr('To use them locally, you must be authenticated to Unito.');
+        command.logToStderr(chalk_1.default.redBright('A secret cannot be decrypted!'));
+        command.logToStderr('Your configuration contains secrets (i.e. in top-level secrets, in test accounts, etc.).');
+        command.logToStderr('To decrypt those secrets locally, you must authenticate to Unito.');
+        command.logToStderr(`Make sure to run the ${chalk_1.default.yellowBright('login')} command first.`);
         handled = true;
     }
     else if (error instanceof EntryDecryptionError) {
         command.logToStderr();
-        command.logToStderr(chalk_1.default.yellowBright(`Error decrypting entry:`));
-        command.logToStderr(chalk_1.default.redBright(`${error.key}: ${error.value}`));
+        command.logToStderr(chalk_1.default.redBright('A secret cannot be decrypted!'));
+        command.logToStderr(`The secret ${chalk_1.default.yellowBright(error.key)} with the value ${chalk_1.default.yellowBright(error.value)} could not be decrypted.`);
+        command.logToStderr();
+        command.logToStderr(`To decrypt this secret locally, make sure:`);
         command.logToStderr();
-        command.logToStderr(`Make sure they were encrypted by the same environement (Currently targeting: ${error.environment}).`);
+        command.logToStderr(`1. The integration was deployed once with the ${chalk_1.default.yellowBright('publish')} command.`);
+        command.logToStderr('2. You have access to the integration.');
+        command.logToStderr(`3. The secret was encrypted for the ${chalk_1.default.yellowBright(error.environment)} environment.`);
         handled = true;
     }
     else if (error instanceof MissingAuth2AuthorizationError) {

package/dist/src/services/integrationsPlatform.d.ts

@@ -32,5 +32,9 @@ export declare function getIntegrations(): Promise<IntegrationSummary[]>;
 export declare function publishIntegration(archivePath: string): Promise<Integration>;
 export declare function createIntegration(configuration: Configuration): Promise<Integration>;
 export declare function inviteUserToIntegration(integrationId: number, email: string): Promise<Integration>;
-export declare function getIntegrationEvents(integrationId: number): Promise<IntegrationEvent[]>;
+export declare function getIntegrationEvents(integrationId: number, options?: {
+    $from?: number;
+    search?: string;
+    limit?: number;
+}): Promise<IntegrationEvent[]>;
 export declare function updateIntegration(integrationId: number, configuration: Configuration): Promise<Integration>;

package/dist/src/services/integrationsPlatform.js

@@ -27,7 +27,7 @@ function setApiKey(apiKey) {
         integrations_platform_client_1.default.defaults.headers = { Authorization: `Bearer ${apiKey}` };
     }
     else {
-        integrations_platform_client_1.default.defaults.headers = undefined;
+        integrations_platform_client_1.default.defaults.headers = {};
     }
 }
 exports.setApiKey = setApiKey;
@@ -97,8 +97,8 @@ async function inviteUserToIntegration(integrationId, email) {
     return await integrations_platform_client_1.default.inviteUser(integrationId, { email });
 }
 exports.inviteUserToIntegration = inviteUserToIntegration;
-async function getIntegrationEvents(integrationId) {
-    const { data: events } = await integrations_platform_client_1.default.getIntegrationEvents(integrationId);
+async function getIntegrationEvents(integrationId, options = {}) {
+    const { data: events } = await integrations_platform_client_1.default.getIntegrationEvents(integrationId, options);
     return events;
 }
 exports.getIntegrationEvents = getIntegrationEvents;

package/dist/test/commands/activity.test.js

@@ -7,6 +7,7 @@ const IntegrationsPlatform = tslib_1.__importStar(require("../../src/services/in
 const IntegrationResource = tslib_1.__importStar(require("../../src/resources/integrations"));
 const IntegrationConfiguration = tslib_1.__importStar(require("../../src/resources/configuration"));
 describe('activity', () => {
+    let getIntegrationEventsStub;
     beforeEach(() => {
         sinon_1.default.stub(IntegrationResource, 'validateIsIntegrationDirectory');
         sinon_1.default.stub(IntegrationsPlatform, 'setEnvironment');
@@ -14,7 +15,7 @@ describe('activity', () => {
         sinon_1.default
             .stub(IntegrationsPlatform, 'getIntegrationByName')
             .resolves({ name: 'integrationName', id: 'foo' });
-        sinon_1.default.stub(IntegrationsPlatform, 'getIntegrationEvents').resolves([
+        getIntegrationEventsStub = sinon_1.default.stub(IntegrationsPlatform, 'getIntegrationEvents').resolves([
             { date: '1', text: 'This is a foo', title: 'foo', tags: ['a', 'b', 'c'] },
             { date: '2', text: 'This is a bar', title: 'bar', tags: ['x', 'y', 'z'] },
         ]);
@@ -35,7 +36,8 @@ describe('activity', () => {
         .command(['activity', '--number', '1'])
         .it('displays only specified number of activity entries', ctx => {
         (0, test_1.expect)(ctx.stdout).to.contains('foo');
-        (0, test_1.expect)(ctx.stdout).to.not.contains('bar');
+        (0, test_1.expect)(ctx.stdout).to.contains('bar');
+        sinon_1.default.assert.calledWithExactly(getIntegrationEventsStub, 'foo', { $from: undefined, limit: 1 });
     });
     test_1.test
         .stdout()
@@ -61,4 +63,19 @@ describe('activity', () => {
         (0, test_1.expect)(error.message).to.equal('EEXIT: -1');
     })
         .it('handles unpublished integration');
+    test_1.test
+        .stdout()
+        .command(['activity', '--follow'])
+        .it('displays activity - follow', ctx => {
+        (0, test_1.expect)(ctx.stdout).to.contains('foo');
+        (0, test_1.expect)(ctx.stdout).to.contains('bar');
+    });
+    test_1.test
+        .stdout()
+        .command(['activity', '--follow', '--number', '1'])
+        .it('displays activity - follow', ctx => {
+        (0, test_1.expect)(ctx.stdout).to.contains('foo');
+        (0, test_1.expect)(ctx.stdout).to.contains('bar');
+        sinon_1.default.assert.calledWithExactly(getIntegrationEventsStub, 'foo', { $from: undefined, limit: 1 });
+    });
 });

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

@@ -82,7 +82,7 @@ describe('Login', () => {
     test_1.test
         .stdout()
         .stub(GlobalConfiguration, 'read', () => {
-        throw new errors_1.MissingEnvironmentVariableError();
+        throw new errors_1.ConfigurationMalformed();
     })
         .command(['login'])
         .exit(-1)

package/dist/test/commands/test.test.js

@@ -63,17 +63,6 @@ describe('Test', () => {
         .command(['test'])
         .exit(-1)
         .it('handled exception');
-    test_1.test
-        .stdout()
-        .stub(ConfigurationResource, 'getConfiguration', () => {
-        return {
-            name: 'a',
-            baseUrl: 'b',
-        };
-    })
-        .command(['test', '--test-account', 'compliance'])
-        .exit(-1)
-        .it('should throw an error if no test account is configured');
     test_1.test
         .stdout()
         .command(['test', '--verbose'])

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

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

package/dist/test/errors.test.js

@@ -37,21 +37,13 @@ describe('handleError', () => {
         (0, chai_1.expect)(stdErrStub.firstCall.args[0]).to.equal(chalk_1.default.redBright('This command requires a configuration file for your integration :('));
         (0, chai_1.expect)(stdErrStub.secondCall.args[0]).to.equal(`This file should be located at ${chalk_1.default.yellowBright(path_1.default.relative(process.cwd(), (0, configuration_1.getConfigurationPath)()))}.`);
     });
-    it('should handle MissingEnvironmentVariableError', () => {
-        const error = new errors_1.MissingEnvironmentVariableError('VAR_NAME');
-        const handled = (0, errors_1.handleError)(command, error);
-        (0, chai_1.expect)(handled).to.be.true;
-        (0, chai_1.expect)(stdErrStub.calledTwice).to.be.true;
-        (0, chai_1.expect)(stdErrStub.firstCall.args[0]).to.equal(chalk_1.default.redBright('This command requires a variable which is missing from your environment :('));
-        (0, chai_1.expect)(stdErrStub.secondCall.args[0]).to.equal(`Make sure the environment variable ${chalk_1.default.yellowBright('VAR_NAME')} is defined.`);
-    });
     it('should return false for unrecognized error', () => {
         const error = new Error('Unrecognized error');
         const handled = (0, errors_1.handleError)(command, error);
         (0, chai_1.expect)(handled).to.be.false;
         (0, chai_1.expect)(stdErrStub.called).to.be.false;
     });
-    it('should handle MissingEnvironmentVariableError', () => {
+    it('should handle ConfigurationInvalid', () => {
         const error = new errors_1.ConfigurationInvalid('VAR_NAME', 'details', 'prettyDetails');
         const handled = (0, errors_1.handleError)(command, error);
         (0, chai_1.expect)(handled).to.be.true;
@@ -86,16 +78,10 @@ describe('handleError', () => {
         const error = new errors_1.DecryptionAuthenticationError('secrets');
         const handled = (0, errors_1.handleError)(command, error);
         (0, chai_1.expect)(handled).to.be.true;
-        (0, chai_1.expect)(stdErrStub.calledThrice).to.be.true;
-        (0, chai_1.expect)(stdErrStub.secondCall.args[0]).to.equal(chalk_1.default.yellowBright('Your configuration contains encrypted secrets.'));
-        (0, chai_1.expect)(stdErrStub.thirdCall.args[0]).to.equal('To use them locally, you must be authenticated to Unito.');
     });
     it('should handle EntryDecryptionError', () => {
         const error = new errors_1.EntryDecryptionError('key', 'value', 'staging');
         const handled = (0, errors_1.handleError)(command, error);
         (0, chai_1.expect)(handled).to.be.true;
-        (0, chai_1.expect)(stdErrStub.called).to.be.true;
-        (0, chai_1.expect)(stdErrStub.secondCall.args[0]).to.equal(chalk_1.default.yellowBright('Error decrypting entry:'));
-        (0, chai_1.expect)(stdErrStub.thirdCall.args[0]).to.equal(chalk_1.default.redBright('key: value'));
     });
 });

package/dist/test/services/integrationsPlatform.test.js

@@ -56,7 +56,7 @@ describe('integrations platform', function () {
         });
         IntegrationsPlatform.setApiKey(undefined);
         (0, chai_1.expect)(IntegrationsPlatform.getApiKey()).to.equal(undefined);
-        (0, chai_1.expect)(integrations_platform_client_1.default.defaults.headers).to.be.undefined;
+        (0, chai_1.expect)(integrations_platform_client_1.default.defaults.headers).to.be.deep.equal({});
     });
     it('getProfile', async function () {
         sinon.stub(integrations_platform_client_1.default, 'getProfile').resolves(user);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.56.1",
+  "version": "0.57.0",
   "commands": {
     "activity": {
       "id": "activity",
@@ -32,6 +32,14 @@
             "production"
           ],
           "default": "production"
+        },
+        "follow": {
+          "name": "follow",
+          "type": "boolean",
+          "char": "f",
+          "summary": "follow the activity",
+          "description": "Follow the activity of your integration. This will keep the command running and will show new events as they are created.\n\n      Usage: <%= config.bin %> <%= command.id %> --follow",
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-cli",
-  "version": "0.56.1",
+  "version": "0.57.0",
   "description": "Integration CLI",
   "bin": {
     "integration-cli": "./bin/run"
@@ -38,8 +38,8 @@
     "@oclif/core": "2.x",
     "@typescript-eslint/eslint-plugin": "6.x",
     "@typescript-eslint/parser": "6.13.x",
-    "@unito/integration-debugger": "0.22.10",
-    "@unito/integrations-platform-client": "0.44.4",
+    "@unito/integration-debugger": "0.23.0",
+    "@unito/integrations-platform-client": "0.46.1",
     "ajv": "8.x",
     "ajv-formats": "2.x",
     "better-ajv-errors": "1.x",