@trayio/cdk-cli 2.19.0 → 2.20.0

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @trayio/cdk-cli
 $ tray-cdk COMMAND
 running command...
 $ tray-cdk (--version|-v)
-@trayio/cdk-cli/2.19.0 linux-x64 node-v18.19.0
+@trayio/cdk-cli/2.20.0 linux-x64 node-v18.19.0
 $ tray-cdk --help [COMMAND]
 USAGE
   $ tray-cdk COMMAND
@@ -39,6 +39,7 @@ USAGE
 * [`tray-cdk help [COMMANDS]`](#tray-cdk-help-commands)
 * [`tray-cdk import-openapi-spec [OPENAPISPEC] [CONNECTORNAME]`](#tray-cdk-import-openapi-spec-openapispec-connectorname)
 * [`tray-cdk init [CONNECTORNAME]`](#tray-cdk-init-connectorname)
+* [`tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-list-connectorname-connectorversion)
 * [`tray-cdk share [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-share-connectorname-connectorversion)
 * [`tray-cdk test [OPERATIONNAME]`](#tray-cdk-test-operationname)
 * [`tray-cdk version`](#tray-cdk-version)
@@ -192,6 +193,29 @@ DESCRIPTION
   Initialize a connector project
 ```
 
+## `tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]`
+
+Retrieves a list of emails that have access to a connector
+
+```
+USAGE
+  $ tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]
+
+ARGUMENTS
+  CONNECTORNAME     The name of the connector
+  CONNECTORVERSION  The version of the connector
+
+DESCRIPTION
+  Retrieves a list of emails that have access to a connector
+
+EXAMPLES
+  $ tray-cdk permissions list
+
+  $ tray-cdk permissions list my-connector
+
+  $ tray-cdk permissions list my-connector 1.0
+```
+
 ## `tray-cdk share [CONNECTORNAME] [CONNECTORVERSION]`
 
 Share your connector version with other users in your organization

package/dist/commands/deploy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAM,MAAM,aAAa,CAAC;AAW1C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IACnD,MAAM,CAAC,WAAW,SAAiC;IAEnD,MAAM,CAAC,IAAI,KAAM;IAEjB,OAAO,CAAC,mBAAmB,CAKzB;IAEI,GAAG;CAyDT"}
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAM,MAAM,aAAa,CAAC;AAW1C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IACnD,MAAM,CAAC,WAAW,SAAiC;IAEnD,MAAM,CAAC,IAAI,KAAM;IAEjB,OAAO,CAAC,mBAAmB,CAKzB;IAEI,GAAG;CA2DT"}

package/dist/commands/deploy.js

@@ -73,7 +73,7 @@ class DeployConnector extends core_1.Command {
             };
             core_1.ux.action.start('Starting Connector Deployment');
             const response = yield this.connectorDeployment.deployFromSourceCode(input);
-            core_1.ux.action.stop();
+            core_1.ux.action.stop('Deployment started! This may take a few minutes. Use `tray-cdk deployment-status` to check the status.');
             if (response.isSuccess) {
                 const { id } = response.value;
                 if (response.value.repeatDeployment === true) {

package/dist/commands/deployment-status.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deployment-status.d.ts","sourceRoot":"","sources":["../../src/commands/deployment-status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAY,MAAM,aAAa,CAAC;AAMhD,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,OAAO;IACvD,MAAM,CAAC,WAAW,SAAoD;IAEtE,MAAM,CAAC,IAAI;;;;MAiBT;IAEF,OAAO,CAAC,mBAAmB,CAKzB;IAEI,GAAG;CAuDT"}
+{"version":3,"file":"deployment-status.d.ts","sourceRoot":"","sources":["../../src/commands/deployment-status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAY,MAAM,aAAa,CAAC;AAOhD,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,OAAO;IACvD,MAAM,CAAC,WAAW,SAAoD;IAEtE,MAAM,CAAC,IAAI;;;;MAiBT;IAEF,OAAO,CAAC,mBAAmB,CAKzB;IAEI,GAAG;CAyDT"}

package/dist/commands/deployment-status.js

@@ -14,6 +14,7 @@ const AxiosHttpClient_1 = require("@trayio/axios/http/AxiosHttpClient");
 const ConnectorDeploymentHttpClient_1 = require("@trayio/tray-client/connector/deployment/ConnectorDeploymentHttpClient");
 const ConnectorDeploymentApi_1 = require("@trayio/tray-api/connector/deployment/ConnectorDeploymentApi");
 const colorizeString_1 = require("../utils/colorizeString");
+const check_env_1 = require("../utils/check-env");
 class GetDeploymentStatus extends core_1.Command {
     constructor() {
         super(...arguments);
@@ -23,6 +24,7 @@ class GetDeploymentStatus extends core_1.Command {
     }
     run() {
         return __awaiter(this, void 0, void 0, function* () {
+            (0, check_env_1.checkEnv)();
             const { args } = yield this.parse(GetDeploymentStatus);
             const TRAY_API_TOKEN = process.env.TRAY_API_TOKEN;
             const input = {

package/dist/commands/permissions/list.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '@oclif/core';
+export default class PermissionsList extends Command {
+    static description: string;
+    static examples: string[];
+    static args: {
+        connectorName: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+        connectorVersion: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static flags: {};
+    private connectorPermissions;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=list.d.ts.map

package/dist/commands/permissions/list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../src/commands/permissions/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,OAAO,EAAa,MAAM,aAAa,CAAC;AAOvD,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IACnD,MAAM,CAAC,WAAW,SAC4C;IAG9D,MAAM,CAAC,QAAQ,WAIb;IAEF,MAAM,CAAC,IAAI;;;MAWT;IAEF,MAAM,CAAC,KAAK,KAYV;IAEF,OAAO,CAAC,oBAAoB,CAK1B;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAoDjC"}

package/dist/commands/permissions/list.js

@@ -0,0 +1,104 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const AxiosHttpClient_1 = require("@trayio/axios/http/AxiosHttpClient");
+const inquirer_1 = __importDefault(require("inquirer"));
+const ConnectorPermissionsHttpClient_1 = require("@trayio/tray-client/connector/permissions/ConnectorPermissionsHttpClient");
+const check_env_1 = require("../../utils/check-env");
+const colorizeString_1 = require("../../utils/colorizeString");
+class PermissionsList extends core_1.Command {
+    constructor() {
+        super(...arguments);
+        this.connectorPermissions = new ConnectorPermissionsHttpClient_1.ConnectorPermissionsHttpClient({
+            baseUrl: process.env.TRAY_API_URL,
+        }, new AxiosHttpClient_1.AxiosHttpClient());
+    }
+    run() {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, check_env_1.checkEnv)();
+            const { args, flags } = yield this.parse(PermissionsList);
+            const TRAY_API_TOKEN = process.env.TRAY_API_TOKEN;
+            const promptRes = yield inquirer_1.default.prompt([
+                {
+                    name: 'connectorName',
+                    message: 'The name of the connector to share',
+                    type: 'input',
+                    when: !args.connectorName,
+                },
+                {
+                    name: 'connectorVersion',
+                    message: 'The version of the connector to share',
+                    type: 'input',
+                    when: !args.connectorVersion,
+                },
+                // {
+                // 	name: 'permissionsType',
+                // 	message: 'How would you like to list connector permissions?',
+                // 	type: 'list',
+                // 	choices: [{ name: 'emails' }, { name: 'workspaces' }],
+                // 	when: !flags.email && !flags.workspaces,
+                // },
+            ]);
+            const input = {
+                connectorName: args.connectorName || promptRes.connectorName,
+                connectorVersion: args.connectorVersion || promptRes.connectorVersion,
+                token: TRAY_API_TOKEN,
+            };
+            core_1.ux.action.start(`Checking the connector deployment status`);
+            const response = yield this.connectorPermissions.listSharedEmails(input);
+            core_1.ux.action.stop();
+            if (response.isSuccess) {
+                this.log((0, colorizeString_1.success)(`Success! These are the emails that have access to ${input.connectorName}:`));
+                this.log(response.value.emails.join('\n'));
+            }
+            if (response.isFailure) {
+                this.log((0, colorizeString_1.error)(`There was an error when listing connector permissions.`));
+            }
+        });
+    }
+}
+PermissionsList.description = 'Retrieves a list of emails that have access to a connector';
+// 'Retrieves a list of emails and workspaces that have access to a connector';
+PermissionsList.examples = [
+    '<%= config.bin %> <%= command.id %>',
+    '<%= config.bin %> <%= command.id %> my-connector',
+    '<%= config.bin %> <%= command.id %> my-connector 1.0',
+];
+PermissionsList.args = {
+    connectorName: core_1.Args.string({
+        name: 'Connector Name',
+        required: false,
+        description: 'The name of the connector',
+    }),
+    connectorVersion: core_1.Args.string({
+        name: 'Connector Version',
+        required: false,
+        description: 'The version of the connector',
+    }),
+};
+PermissionsList.flags = {
+// email: Flags.string({
+// 	char: 'e',
+// 	aliases: ['emails', 'email'],
+// 	description: 'Retrieve a list of emails that have access to a connector',
+// }),
+// workspaces: Flags.string({
+// 	char: 'w',
+// 	aliases: ['workspaces', 'workspace'],
+// 	description:
+// 		'Retrieve a list of workspace IDs that have access to a connector',
+// }),
+};
+exports.default = PermissionsList;

package/dist/commands/permissions/list.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=list.unit.test.d.ts.map

package/dist/commands/permissions/list.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.unit.test.d.ts","sourceRoot":"","sources":["../../../src/commands/permissions/list.unit.test.ts"],"names":[],"mappings":""}

package/dist/commands/permissions/list.unit.test.js

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ConnectorPermissionsHttpClient_1 = require("@trayio/tray-client/connector/permissions/ConnectorPermissionsHttpClient");
+const stdout_stderr_1 = require("stdout-stderr");
+const list_1 = __importDefault(require("./list"));
+jest.mock('@trayio/tray-client/connector/permissions/ConnectorPermissionsHttpClient', () => ({
+    ConnectorPermissionsHttpClient: jest.fn(),
+}));
+describe('PermissionsList', () => {
+    let success = true;
+    let failure = false;
+    const connectorName = 'some-connector-name';
+    const connectorVersion = '1.0';
+    const emails = ['some@test.com', 'someOther@test.com'];
+    beforeEach(() => {
+        ConnectorPermissionsHttpClient_1.ConnectorPermissionsHttpClient.mockImplementation(() => ({
+            listSharedEmails: jest.fn().mockReturnValue(Object.assign(Object.assign(Object.assign({ isSuccess: success }, (success && {
+                value: {
+                    emails,
+                },
+            })), { isFailure: true }), (failure && {
+                error: {
+                    message: 'There was an error listing connector permissions',
+                },
+            }))),
+        }));
+    });
+    afterAll(() => {
+        jest.clearAllMocks();
+    });
+    it('should list shared emails', () => __awaiter(void 0, void 0, void 0, function* () {
+        stdout_stderr_1.stdout.start();
+        yield list_1.default.run([connectorName, connectorVersion]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(`Success! These are the emails that have access to some-connector-name:`));
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(emails.join('\n')));
+    }));
+    it('should handle error when listing shared emails', () => __awaiter(void 0, void 0, void 0, function* () {
+        success = false;
+        failure = true;
+        stdout_stderr_1.stdout.start();
+        yield list_1.default.run([connectorName, connectorVersion]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(`There was an error when listing connector permissions.`));
+    }));
+});

package/dist/commands/share.unit.test.js

@@ -75,7 +75,7 @@ describe('Share', () => {
             connectorName,
             connectorVersion,
             emails: ['test.user@tray.io', 'another.user@tray.io'],
-            token: undefined,
+            token: process.env.TRAY_API_TOKEN,
         });
         expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('1 permissions added'));
     }));
@@ -100,7 +100,7 @@ describe('Share', () => {
             connectorName,
             connectorVersion,
             workspaceIds: ['workspace-id', 'another-workspace-id'],
-            token: undefined,
+            token: process.env.TRAY_API_TOKEN,
         });
         expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('5 permissions added'));
         expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('No permissions to add for workspace: 9b31dc75-3217-458b-923a-8a48ff5b5e'));

package/dist/utils/check-env.unit.test.js

@@ -8,10 +8,14 @@ describe('checkEnv', () => {
         process.env = env;
     });
     it('should throw an error if TRAY_API_URL is not set', () => {
+        process.env = { TRAY_API_URL: undefined };
         expect(() => subject()).toThrowError('required env TRAY_API_URL is not set');
     });
     it('should throw an error if TRAY_API_TOKEN is not set', () => {
-        process.env = { TRAY_API_URL: 'https://api.tray.io' };
+        process.env = {
+            TRAY_API_URL: 'https://api.tray.io',
+            TRAY_API_TOKEN: undefined,
+        };
         expect(() => subject()).toThrowError('required env TRAY_API_TOKEN is not set');
     });
     it('should throw an error if TRAY_API_URL is invalid', () => {

package/oclif.manifest.json

@@ -291,7 +291,44 @@
         "commands",
         "test.js"
       ]
+    },
+    "permissions:list": {
+      "aliases": [],
+      "args": {
+        "connectorName": {
+          "description": "The name of the connector",
+          "name": "connectorName",
+          "required": false
+        },
+        "connectorVersion": {
+          "description": "The version of the connector",
+          "name": "connectorVersion",
+          "required": false
+        }
+      },
+      "description": "Retrieves a list of emails that have access to a connector",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> my-connector",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "permissions:list",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "permissions",
+        "list.js"
+      ]
     }
   },
-  "version": "2.19.0"
+  "version": "2.20.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-cli",
-  "version": "2.19.0",
+  "version": "2.20.0",
   "description": "A CLI for connector development",
   "exports": {
     "./*": "./dist/*.js"
@@ -19,12 +19,12 @@
     "@oclif/plugin-help": "6.0.12",
     "@oclif/plugin-version": "2.0.11",
     "@oclif/test": "3.1.12",
-    "@trayio/axios": "2.19.0",
-    "@trayio/cdk-build": "2.19.0",
-    "@trayio/commons": "2.19.0",
-    "@trayio/generator": "2.19.0",
-    "@trayio/tray-client": "2.19.0",
-    "@trayio/tray-openapi": "2.19.0",
+    "@trayio/axios": "2.20.0",
+    "@trayio/cdk-build": "2.20.0",
+    "@trayio/commons": "2.20.0",
+    "@trayio/generator": "2.20.0",
+    "@trayio/tray-client": "2.20.0",
+    "@trayio/tray-openapi": "2.20.0",
     "@types/inquirer": "8.2.6",
     "chalk": "4.1.2",
     "inquirer": "8.2.5"