@unito/integration-cli 0.57.2 → 0.58.0

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

@@ -4,147 +4,131 @@ const tslib_1 = require("tslib");
 /* eslint-disable  @typescript-eslint/no-explicit-any */
 const strict_1 = tslib_1.__importDefault(require("node:assert/strict"));
 const sinon_1 = tslib_1.__importDefault(require("sinon"));
-const oauth2Helper_1 = tslib_1.__importStar(require("../../src/oauth2Helper/oauth2Helper")), oauth2Namespace = oauth2Helper_1;
+const oauth2Helper_1 = tslib_1.__importStar(require("../../src/services/oauth2Helper")), oauth2Namespace = oauth2Helper_1;
 const configurationTypes_1 = require("../../src/configurationTypes");
 const errors_1 = require("../../src/errors");
 describe('OAuth2Helper', () => {
     let oauth2Helper;
     let openSpy;
     let fetchStub;
-    beforeEach(() => {
-        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,
-            tokenRequestParameters: {
-                header: {
-                    Authorization: 'custom',
-                },
-            },
-        };
-        oauth2Helper = new oauth2Helper_1.default(authorizationInfo);
-        fetchStub = sinon_1.default.stub().resolves({ json: sinon_1.default.stub().resolves({}), status: 200 });
-        sinon_1.default.stub(oauth2Helper, 'startServer').resolves('http://localhost:5050');
-        sinon_1.default.stub(oauth2Helper, 'stopServer');
-        sinon_1.default.replace(global, 'fetch', fetchStub);
-        sinon_1.default.replace(oauth2Namespace, 'open', { open: (_url) => undefined });
-        openSpy = sinon_1.default.spy(oauth2Namespace.open, 'open');
-    });
-    afterEach(() => {
-        sinon_1.default.restore();
-    });
-    describe('handleAuthorize', () => {
-        it('should open the authorization URL', async () => {
-            const req = {};
-            const res = { sendStatus: sinon_1.default.stub() };
-            await oauth2Helper['handleAuthorize'](req, res);
-            sinon_1.default.assert.calledOnce(openSpy);
-            sinon_1.default.assert.calledWith(openSpy, 'https://provider.com/oauth/authorize?client_id=your-client-id&redirect_uri=https%3A%2F%2Fintegrations-platform.unito.io%2Fcredentials%2Fnew%2Foauth2%2Fcallback-cli&state=eyJjbGlDYWxsYmFja1VybCI6Ii9jcmVkZW50aWFscy9uZXcvb2F1dGgyL2NhbGxiYWNrIn0%3D&scope=scope1+scope2&response_type=code');
-            sinon_1.default.assert.calledOnce(res.sendStatus);
-        });
-        it('should maintain the pre-existing query parameters in authorization URL', async () => {
-            oauth2Helper['providerAuthorizationUrl'] = 'https://provider.com/oauth/authorize?query1=value1&query2=value2';
-            const req = {};
-            const res = { sendStatus: sinon_1.default.stub() };
-            await oauth2Helper['handleAuthorize'](req, res);
-            sinon_1.default.assert.calledOnce(openSpy);
-            sinon_1.default.assert.calledWith(openSpy, 'https://provider.com/oauth/authorize?query1=value1&query2=value2&client_id=your-client-id&redirect_uri=https%3A%2F%2Fintegrations-platform.unito.io%2Fcredentials%2Fnew%2Foauth2%2Fcallback-cli&state=eyJjbGlDYWxsYmFja1VybCI6Ii9jcmVkZW50aWFscy9uZXcvb2F1dGgyL2NhbGxiYWNrIn0%3D&scope=scope1+scope2&response_type=code');
-            (0, strict_1.default)(openSpy.firstCall.args[0].includes('query1=value1'));
-            (0, strict_1.default)(openSpy.firstCall.args[0].includes('query2=value2'));
-            sinon_1.default.assert.calledOnce(res.sendStatus);
-        });
-    });
-    describe('handleCallback', () => {
-        it('should store the authorization code', async () => {
-            const code = 'test-code';
-            const req = { body: { query: { code } } };
-            const res = { sendStatus: sinon_1.default.stub() };
-            await oauth2Helper['handleCallback'](req, res);
-            strict_1.default.equal(oauth2Helper['code'], code);
-            sinon_1.default.assert.calledOnce(res.sendStatus);
+    describe('constructor', () => {
+        it('should throw an error if the request content type is not supported', async () => {
+            try {
+                new oauth2Helper_1.default({ scopes: [], requestContentType: 'random' });
+            }
+            catch (err) {
+                (0, strict_1.default)(err instanceof errors_1.UnsupportedContentTypeError);
+            }
         });
     });
-    describe('handleToken', () => {
-        it('should retrieve the access token and return it in the response', async () => {
-            const req = { query: {} };
-            const res = { json: sinon_1.default.stub() };
-            await oauth2Helper['handleToken'](req, res);
-            sinon_1.default.assert.calledOnce(fetchStub);
-            sinon_1.default.assert.calledWith(fetchStub, 'https://provider.com/oauth/token', {
-                headers: {
-                    'Content-type': 'application/x-www-form-urlencoded',
-                    Authorization: 'custom',
+    describe('endpoints', () => {
+        beforeEach(() => {
+            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,
+                tokenRequestParameters: {
+                    header: {
+                        Authorization: 'custom',
+                    },
                 },
-                body: sinon_1.default.match.string,
-                method: 'POST',
-            });
-            sinon_1.default.assert.calledOnce(res.json);
-        });
-        it('should handle errors and return 500 status', async () => {
-            const req = { query: {} };
-            const res = { status: sinon_1.default.stub().returns({ json: sinon_1.default.stub() }) };
-            fetchStub.rejects(new Error('Failed to retrieve access token'));
-            await oauth2Helper['handleToken'](req, res);
-            sinon_1.default.assert.calledWith(res.status, 500);
-        });
-        it('should return an error 400 if the request content type is not supported', async () => {
-            const req = { query: {} };
-            const res = { status: sinon_1.default.stub().returns({ json: sinon_1.default.stub() }) };
-            oauth2Helper['requestContentType'] = 'random';
-            await oauth2Helper['handleToken'](req, res);
-            sinon_1.default.assert.calledWith(res.status, 400);
-        });
-    });
-    describe('updateToken', () => {
-        it('should throw an error when no refresh token is available', async () => {
-            const response = oauth2Helper.updateToken();
-            await strict_1.default.rejects(response, errors_1.NoRefreshTokenError);
+            };
+            oauth2Helper = new oauth2Helper_1.default(authorizationInfo);
+            fetchStub = sinon_1.default.stub().resolves({ json: sinon_1.default.stub().resolves({}), status: 200 });
+            sinon_1.default.stub(oauth2Helper, 'startServer').resolves('http://localhost:5050');
+            sinon_1.default.stub(oauth2Helper, 'stopServer');
+            sinon_1.default.replace(global, 'fetch', fetchStub);
+            sinon_1.default.replace(oauth2Namespace, 'open', { open: (_url) => undefined });
+            openSpy = sinon_1.default.stub(oauth2Namespace.open, 'open');
         });
-        it('should retrieve the access token when a refresh token is available', async () => {
-            const refreshToken = 'test-refresh-token';
-            oauth2Helper['refreshToken'] = refreshToken;
-            const accessToken = 'test-access-token';
-            const fetchResponse = { access_token: accessToken, refresh_token: refreshToken };
-            fetchStub.resolves({ status: 200, json: sinon_1.default.stub().resolves(fetchResponse) });
-            const result = await oauth2Helper.updateToken();
-            strict_1.default.deepEqual(result, { accessToken, refreshToken });
-            sinon_1.default.assert.calledOnce(fetchStub);
+        afterEach(() => {
+            sinon_1.default.restore();
         });
-        it('should throw an error when failing to refresh the access token', async () => {
-            const refreshToken = 'test-refresh-token';
-            oauth2Helper['refreshToken'] = refreshToken;
-            fetchStub.rejects(new Error('Failed to retrieve access token'));
-            const response = oauth2Helper.updateToken();
-            await strict_1.default.rejects(response, errors_1.FailedToRetrieveAccessTokenError);
-            sinon_1.default.assert.calledOnce(fetchStub);
+        describe('handleAuthorize', () => {
+            it('should open the authorization URL', async () => {
+                await oauth2Helper.authorize();
+                sinon_1.default.assert.calledOnce(openSpy);
+                sinon_1.default.assert.calledWith(openSpy, 'https://provider.com/oauth/authorize?client_id=your-client-id&redirect_uri=https%3A%2F%2Fintegrations-platform.unito.io%2Fcredentials%2Fnew%2Foauth2%2Fcallback-cli&state=eyJjbGlDYWxsYmFja1VybCI6Ii9vYXV0aDIvY2FsbGJhY2sifQ%3D%3D&scope=scope1+scope2&response_type=code');
+            });
+            it('should maintain the pre-existing query parameters in authorization URL', async () => {
+                oauth2Helper['providerAuthorizationUrl'] = 'https://provider.com/oauth/authorize?query1=value1&query2=value2';
+                await oauth2Helper.authorize();
+                sinon_1.default.assert.calledOnce(openSpy);
+                sinon_1.default.assert.calledWith(openSpy, 'https://provider.com/oauth/authorize?query1=value1&query2=value2&client_id=your-client-id&redirect_uri=https%3A%2F%2Fintegrations-platform.unito.io%2Fcredentials%2Fnew%2Foauth2%2Fcallback-cli&state=eyJjbGlDYWxsYmFja1VybCI6Ii9vYXV0aDIvY2FsbGJhY2sifQ%3D%3D&scope=scope1+scope2&response_type=code');
+            });
         });
-        it("should throw an error if we don't support the request content type", async () => {
-            const refreshToken = 'test-refresh-token';
-            oauth2Helper['refreshToken'] = refreshToken;
-            oauth2Helper['requestContentType'] = 'random';
-            const response = oauth2Helper.updateToken();
-            await strict_1.default.rejects(response, errors_1.InvalidRequestContentTypeError);
+        describe('handleCallback', () => {
+            it('should retrieve the access token and return it in the response', async () => {
+                const code = 'test-code';
+                const req = { query: { code } };
+                const res = { send: sinon_1.default.stub(), setHeader: sinon_1.default.stub() };
+                await oauth2Helper['handleCallback'](req, res);
+                sinon_1.default.assert.calledOnce(fetchStub);
+                sinon_1.default.assert.calledWith(fetchStub, 'https://provider.com/oauth/token', {
+                    headers: {
+                        'Content-type': 'application/x-www-form-urlencoded',
+                        Authorization: 'custom',
+                    },
+                    body: sinon_1.default.match.string,
+                    method: 'POST',
+                });
+                sinon_1.default.assert.calledOnce(res.send);
+                sinon_1.default.assert.calledWith(res.send, oauth2Namespace.HTML_SUCCESS_MSG);
+            });
+            it('should handle errors and return 500 status', async () => {
+                const code = 'test-code';
+                const req = { query: { code } };
+                const res = { send: sinon_1.default.stub(), setHeader: sinon_1.default.stub() };
+                fetchStub.rejects(new Error('Failed to retrieve access token'));
+                await oauth2Helper['handleCallback'](req, res);
+                sinon_1.default.assert.calledOnce(res.send);
+                sinon_1.default.assert.calledWith(res.send, oauth2Namespace.HTML_ERROR_MSG);
+            });
         });
-    });
-    describe('encodeBody', () => {
-        it('should encode body data as URL-encoded when content type is URL_ENCODED', () => {
-            const bodyData = { key1: 'value1', key2: 'value2' };
-            const contentType = configurationTypes_1.RequestContentType.URL_ENCODED;
-            const expectedEncodedBody = 'key1=value1&key2=value2';
-            const encodedBody = oauth2Helper['encodeBody'](bodyData, contentType);
-            strict_1.default.equal(encodedBody, expectedEncodedBody);
+        describe('updateToken', () => {
+            it('should retrieve the access token when a refresh token is available', async () => {
+                const refreshToken = 'test-refresh-token';
+                const accessToken = 'test-access-token';
+                const fetchResponse = { access_token: accessToken, refresh_token: refreshToken };
+                fetchStub.resolves({ status: 200, json: sinon_1.default.stub().resolves(fetchResponse) });
+                const result = await oauth2Helper.updateToken(refreshToken);
+                strict_1.default.deepEqual(result, { accessToken, refreshToken });
+                sinon_1.default.assert.calledOnce(fetchStub);
+            });
+            it('should throw an error when failing to refresh the access token', async () => {
+                const refreshToken = 'test-refresh-token';
+                fetchStub.rejects(new Error('Failed to retrieve access token'));
+                const response = oauth2Helper.updateToken(refreshToken);
+                await strict_1.default.rejects(response, errors_1.FailedToRetrieveAccessTokenError);
+                sinon_1.default.assert.calledOnce(fetchStub);
+            });
+            it("should throw an error if we don't support the request content type", async () => {
+                const refreshToken = 'test-refresh-token';
+                oauth2Helper['requestContentType'] = 'random';
+                const response = oauth2Helper.updateToken(refreshToken);
+                await strict_1.default.rejects(response, errors_1.InvalidRequestContentTypeError);
+            });
         });
-        it('should encode body data as JSON when content type is JSON', () => {
-            const bodyData = { key1: 'value1', key2: 'value2' };
-            const contentType = configurationTypes_1.RequestContentType.JSON;
-            const expectedEncodedBody = JSON.stringify(bodyData);
-            const encodedBody = oauth2Helper['encodeBody'](bodyData, contentType);
-            strict_1.default.equal(encodedBody, expectedEncodedBody);
+        describe('encodeBody', () => {
+            it('should encode body data as URL-encoded when content type is URL_ENCODED', () => {
+                const bodyData = { key1: 'value1', key2: 'value2' };
+                const contentType = configurationTypes_1.RequestContentType.URL_ENCODED;
+                const expectedEncodedBody = 'key1=value1&key2=value2';
+                const encodedBody = oauth2Helper['encodeBody'](bodyData, contentType);
+                strict_1.default.equal(encodedBody, expectedEncodedBody);
+            });
+            it('should encode body data as JSON when content type is JSON', () => {
+                const bodyData = { key1: 'value1', key2: 'value2' };
+                const contentType = configurationTypes_1.RequestContentType.JSON;
+                const expectedEncodedBody = JSON.stringify(bodyData);
+                const encodedBody = oauth2Helper['encodeBody'](bodyData, contentType);
+                strict_1.default.equal(encodedBody, expectedEncodedBody);
+            });
         });
     });
 });

package/dist/test/resources/integrations.test.js

@@ -0,0 +1,37 @@
+"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 tmp_1 = tslib_1.__importDefault(require("tmp"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const Integration = tslib_1.__importStar(require("../../src/resources/integrations"));
+const errors_1 = require("../../src/errors");
+describe('integrations', () => {
+    let tempDir;
+    const boilerplatePath = path.join(__dirname, '../../boilerplate');
+    describe('copyBoilerplate', () => {
+        beforeEach(() => {
+            tempDir = tmp_1.default.dirSync().name;
+        });
+        it('copy files', async () => {
+            const result = await Integration.copyBoilerplate('foo', tempDir);
+            strict_1.default.equal(result, path.join(tempDir, 'foo'));
+            (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('already exists', async () => {
+            strict_1.default.doesNotThrow(async () => await Integration.copyBoilerplate('foo', tempDir));
+            strict_1.default.rejects(Integration.copyBoilerplate('foo', tempDir), errors_1.IntegrationAlreadyExistsError);
+        });
+        it('generates an .npmrc file', async () => {
+            const result = await Integration.copyBoilerplate('foo', tempDir);
+            const npmrc = await fs_1.default.promises.readFile(`${result}/.npmrc`, 'utf-8');
+            (0, strict_1.default)(npmrc.includes('engine-strict=true'));
+        });
+    });
+});

package/dist/test/{services → resources}/oauth2Helper.test.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const strict_1 = tslib_1.__importDefault(require("node:assert/strict"));
 const sinon_1 = tslib_1.__importDefault(require("sinon"));
-const oauth2Helper_1 = tslib_1.__importDefault(require("../../src/oauth2Helper/oauth2Helper"));
+const oauth2Helper_1 = tslib_1.__importDefault(require("../../src/services/oauth2Helper"));
 const configurationTypes_1 = require("../../src/configurationTypes");
-const oauth2HelperService = tslib_1.__importStar(require("../../src/services/oauth2Helper"));
+const oauth2HelperResource = tslib_1.__importStar(require("../../src/resources/oauth2Helper"));
 const errors_1 = require("../../src/errors");
 const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 describe('OAuth2Helper', () => {
@@ -23,7 +23,7 @@ describe('OAuth2Helper', () => {
     beforeEach(() => {
         sinon_1.default.stub(oauth2Helper_1.default.prototype, 'startServer').resolves('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(oauth2Helper_1.default.prototype, 'authorize');
         sinon_1.default.stub(inquirer_1.default, 'prompt');
     });
     afterEach(() => {
@@ -31,54 +31,24 @@ describe('OAuth2Helper', () => {
     });
     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' };
-                },
-            });
+            fetchStub = sinon_1.default.stub().onFirstCall().resolves({ status: 200 }).onSecondCall().resolves({ status: 200 });
             sinon_1.default.replace(global, 'fetch', fetchStub);
-            await oauth2HelperService.performOAuth2Flow(authorizationInfo);
+            sinon_1.default.stub(oauth2Helper_1.default.prototype, 'callbackIsDone').resolves({ accessToken: 'token' });
+            await oauth2HelperResource.performOAuth2Flow(authorizationInfo);
             strict_1.default.equal(fetchStub.getCall(0).args.at(0), 'http://localhost:5050/health');
-            strict_1.default.equal(fetchStub.getCall(1).args.at(0), 'http://localhost:5050/credentials/new/oauth2/authorize');
-            strict_1.default.equal(fetchStub.getCall(2).args.at(0), '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' });
+            fetchStub = sinon_1.default.stub().onFirstCall().resolves({ status: 200 }).onSecondCall().resolves({ status: 200 });
             sinon_1.default.replace(global, 'fetch', fetchStub);
-            const response = oauth2HelperService.performOAuth2Flow(authorizationInfo);
+            sinon_1.default.stub(oauth2Helper_1.default.prototype, 'callbackIsDone').resolves({});
+            const response = oauth2HelperResource.performOAuth2Flow(authorizationInfo);
             await strict_1.default.rejects(response, 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 {};
-                },
-            });
+            fetchStub = sinon_1.default.stub().onFirstCall().resolves({ status: 200 }).onSecondCall().resolves({ status: 200 });
             sinon_1.default.replace(global, 'fetch', fetchStub);
-            const response = oauth2HelperService.performOAuth2Flow(authorizationInfo);
+            sinon_1.default.stub(oauth2Helper_1.default.prototype, 'callbackIsDone').resolves({});
+            const response = oauth2HelperResource.performOAuth2Flow(authorizationInfo);
             await strict_1.default.rejects(response, errors_1.FailedToRetrieveAccessTokenError);
         });
     });

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.57.2",
+  "version": "0.58.0",
   "commands": {
     "activity": {
       "id": "activity",
@@ -74,6 +74,41 @@
           "description": "output more (debug) information",
           "allowNo": false
         },
+        "credential-payload": {
+          "name": "credential-payload",
+          "type": "option",
+          "description": "(advanced) credential payload to use.",
+          "multiple": false,
+          "exclusive": [
+            "credential-id"
+          ]
+        },
+        "credential-id": {
+          "name": "credential-id",
+          "type": "option",
+          "description": "(advanced) credential to use.",
+          "multiple": false,
+          "exclusive": [
+            "credential-payload"
+          ]
+        },
+        "test-account": {
+          "name": "test-account",
+          "type": "option",
+          "description": "test account to use.",
+          "multiple": false,
+          "options": [
+            "development",
+            "compliance"
+          ],
+          "default": "development"
+        },
+        "read-only": {
+          "name": "read-only",
+          "type": "boolean",
+          "description": "whether or not to only perform read operations",
+          "allowNo": true
+        },
         "crawlMode": {
           "name": "crawlMode",
           "type": "option",
@@ -209,15 +244,16 @@
     },
     "oauth2": {
       "id": "oauth2",
-      "summary": "Perform an OAuth2 workflow locally",
-      "description": "The Oauth2 command allows you to perform an OAuth2 workflow locally, either to create a new test account or to refresh an existing one.",
+      "summary": "Perform an OAuth2 workflow to either populate or refresh a test account's credentials.",
+      "description": "The Oauth2 command allows you to perform an OAuth2 workflow to populate the specified test account's accessToken and refreshToken to be used by the 'test' and 'dev' commands.\n\n    If the test-account is already populated, the command will refresh the credentials if the refresh token is available.\n    If you want to force a new OAuth2 flow to change the connected account or something else, use the --reauth flag.",
       "strict": true,
       "pluginName": "@unito/integration-cli",
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --reauth --test-account=compliance"
       ],
       "flags": {
         "test-account": {
@@ -235,6 +271,7 @@
           "name": "environment",
           "type": "option",
           "description": "the environment of the platform",
+          "hidden": true,
           "multiple": false,
           "options": [
             "local",
@@ -246,7 +283,7 @@
         "reauth": {
           "name": "reauth",
           "type": "boolean",
-          "description": "triggers a new oauth2 flow to collect credentials and overwrite the current one",
+          "description": "triggers a new oauth2 flow to overwrite the test account's current credentials",
           "allowNo": false
         },
         "config-path": {
@@ -394,13 +431,25 @@
         "credential-payload": {
           "name": "credential-payload",
           "type": "option",
+          "description": "(advanced) credential payload to use.",
+          "multiple": false,
+          "exclusive": [
+            "credential-id"
+          ]
+        },
+        "credential-id": {
+          "name": "credential-id",
+          "type": "option",
           "description": "(advanced) credential to use.",
-          "multiple": false
+          "multiple": false,
+          "exclusive": [
+            "credential-payload"
+          ]
         },
         "test-account": {
           "name": "test-account",
           "type": "option",
-          "description": "Test account to use.",
+          "description": "test account to use.",
           "multiple": false,
           "options": [
             "development",
@@ -408,6 +457,12 @@
           ],
           "default": "development"
         },
+        "read-only": {
+          "name": "read-only",
+          "type": "boolean",
+          "description": "whether or not to only perform read operations",
+          "allowNo": true
+        },
         "crawlMode": {
           "name": "crawlMode",
           "type": "option",
@@ -430,7 +485,7 @@
         "debug": {
           "name": "debug",
           "type": "boolean",
-          "description": "Log launch command to console before running it - including decrypted values - for debugging only",
+          "description": "log launch command to console before running it - including decrypted values - for debugging only",
           "hidden": true,
           "allowNo": false
         },
@@ -438,7 +493,7 @@
           "name": "config-path",
           "type": "option",
           "summary": "relative path to a custom \".unito.json\" file",
-          "description": "Use a custom configuration file instead of the default '.unito.json' or other environment specific\n      ones.\n\n      If you want to force the CLI to use a specific configuration file, you can use this flag to specify the relative\n      path from your integration's root folder (with a leading '/').\n\n      Usage: <%= config.bin %> <%= command.id %> --config-path=/myCustomConfig.json",
+          "description": "use a custom configuration file instead of the default '.unito.json' or other environment specific\n      ones.\n\n      If you want to force the CLI to use a specific configuration file, you can use this flag to specify the relative\n      path from your integration's root folder (with a leading '/').\n\n      Usage: <%= config.bin %> <%= command.id %> --config-path=/myCustomConfig.json",
           "multiple": false
         }
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-cli",
-  "version": "0.57.2",
+  "version": "0.58.0",
   "description": "Integration CLI",
   "bin": {
     "integration-cli": "./bin/run"
@@ -13,18 +13,18 @@
     "email": "hello@unito.io"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "scripts": {
     "prepublishOnly": "npm run lint && npm run test",
     "prepack": "oclif manifest",
     "postpack": "shx rm -f oclif.manifest.json",
     "prepare": "npm run compile",
-    "lint": "eslint --fix src test scripts integrationGenerator/src integrationGenerator/test --ext .ts && prettier --write src test scripts integrationGenerator/src integrationGenerator/test",
-    "compile": "ts-node scripts/generateTypes.ts > src/configurationTypes.ts && tsc -b && mkdir -p dist/schemas && cp schemas/*.json dist/schemas/ && cp -r integrationGenerator/integrationBoilerplate ./dist/integrationGenerator/integrationBoilerplate",
+    "lint": "eslint --fix src test scripts --ext .ts && prettier --write src test scripts",
+    "compile": "rm -rf dist && ts-node scripts/generateTypes.ts > src/configurationTypes.ts && tsc -b && mkdir -p dist/schemas && cp schemas/*.json dist/schemas/ && cp -r boilerplate ./dist/boilerplate",
     "compile:watch": "tsc --build -w",
-    "test": "mocha $(find test -name '*.test.ts') $(find integrationGenerator/test -name '*.test.ts')",
-    "test:debug": "mocha test/**/*.test.ts integrationGenerator/test/**/*.test.ts --inspect-brk",
+    "test": "mocha \"test/**/*.test.ts\"",
+    "test:debug": "mocha --inspect-brk \"test/**/*.test.ts\"",
     "ci:test": "c8 npm run test"
   },
   "files": [
@@ -38,7 +38,7 @@
     "@oclif/core": "3.x",
     "@typescript-eslint/eslint-plugin": "6.x",
     "@typescript-eslint/parser": "6.13.x",
-    "@unito/integration-debugger": "0.23.0",
+    "@unito/integration-debugger": "0.24.0",
     "@unito/integrations-platform-client": "0.46.1",
     "ajv": "8.x",
     "ajv-formats": "2.x",
@@ -62,7 +62,7 @@
     "@types/gradient-string": "1.x",
     "@types/inquirer": "9.x",
     "@types/mocha": "10.x",
-    "@types/node": "18.x",
+    "@types/node": "20.x",
     "@types/openurl": "1.x",
     "@types/tmp": "0.x",
     "c8": "9.x",

package/dist/integrationGenerator/errors.d.ts

@@ -1,2 +0,0 @@
-export declare class AlreadyExistingIntegrationError extends Error {
-}

package/dist/integrationGenerator/errors.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AlreadyExistingIntegrationError = void 0;
-class AlreadyExistingIntegrationError extends Error {
-}
-exports.AlreadyExistingIntegrationError = AlreadyExistingIntegrationError;

package/dist/integrationGenerator/index.d.ts

@@ -1,2 +0,0 @@
-export * from './src';
-export * from './errors';

package/dist/integrationGenerator/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./src"), exports);
-tslib_1.__exportStar(require("./errors"), exports);

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.dockerignore

@@ -1,3 +0,0 @@
-node_modules
-dist
-.eslintrc.js