@trayio/cdk-cli 2.17.0 → 2.18.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.17.0 linux-x64 node-v18.19.0
+@trayio/cdk-cli/2.18.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 share [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-share-connectorname-connectorversion)
 * [`tray-cdk test [OPERATIONNAME]`](#tray-cdk-test-operationname)
 * [`tray-cdk version`](#tray-cdk-version)
 
@@ -191,6 +192,41 @@ DESCRIPTION
   Initialize a connector project
 ```
 
+## `tray-cdk share [CONNECTORNAME] [CONNECTORVERSION]`
+
+Share your connector version with other users in your organization
+
+```
+USAGE
+  $ tray-cdk share [CONNECTORNAME] [CONNECTORVERSION] [-e <value>] [-w <value>]
+
+ARGUMENTS
+  CONNECTORNAME     The name of the connector
+  CONNECTORVERSION  The version of the connector
+
+FLAGS
+  -e, --email=<value>       Share with users by providing a list of emails
+  -w, --workspaces=<value>  Share with the emails of users in a workspace by providing a list of workspace IDs
+
+DESCRIPTION
+  Share your connector version with other users in your organization
+
+EXAMPLES
+  $ tray-cdk share
+
+  $ tray-cdk share my-connector
+
+  $ tray-cdk share my-connector 1.0
+
+  $ tray-cdk share my-connector 1.0 --email="my.email@domain.com, your.email@domain.com"
+
+  $ tray-cdk share my-connector 1.0 -e="my.email@domain.com, your.email@domain.com"
+
+  $ tray-cdk share my-connector 1.0 --workspace="<workspace-id>, <another-workspace-id>"
+
+  $ tray-cdk share my-connector 1.0 -w="<workspace-id>, <another-workspace-id>"
+```
+
 ## `tray-cdk test [OPERATIONNAME]`
 
 Build and test connector project or an operation

package/dist/commands/share.d.ts

@@ -0,0 +1,20 @@
+import { Command } from '@oclif/core';
+export default class Share 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: {
+        email: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        workspaces: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    private connectorPermissions;
+    run(): Promise<void>;
+    private handleShareByEmail;
+    private handleShareByWorkspace;
+    private splitList;
+    private truncateVersion;
+}
+//# sourceMappingURL=share.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"share.d.ts","sourceRoot":"","sources":["../../src/commands/share.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,OAAO,EAAa,MAAM,aAAa,CAAC;AAMvD,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,OAAO;IACzC,MAAM,CAAC,WAAW,SACoD;IAEtE,MAAM,CAAC,QAAQ,WAQb;IAEF,MAAM,CAAC,IAAI;;;MAWT;IAEF,MAAM,CAAC,KAAK;;;MAYV;IAEF,OAAO,CAAC,oBAAoB,CAK1B;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;YA6EnB,kBAAkB;YA+BlB,sBAAsB;IAoCpC,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,eAAe;CAGvB"}

package/dist/commands/share.js

@@ -0,0 +1,175 @@
+"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 inquirer_1 = __importDefault(require("inquirer"));
+const AxiosHttpClient_1 = require("@trayio/axios/http/AxiosHttpClient");
+const ConnectorPermissionsHttpClient_1 = require("@trayio/tray-client/connector/permissions/ConnectorPermissionsHttpClient");
+const colorizeString_1 = require("../utils/colorizeString");
+class Share 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* () {
+            const { args, flags } = yield this.parse(Share);
+            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: 'shareMethod',
+                    message: 'How would you like to share the connector?',
+                    type: 'list',
+                    choices: [{ name: 'email' }, { name: 'workspace' }],
+                    when: !flags.email && !flags.workspaces,
+                },
+            ]);
+            const shareTargetPrompt = yield inquirer_1.default.prompt([
+                {
+                    name: 'emails',
+                    message: 'Enter a comma separated list of emails to share the connector version with',
+                    type: 'input',
+                    when: !flags.email &&
+                        !flags.workspaces &&
+                        promptRes.shareMethod === 'email',
+                },
+                {
+                    name: 'workspaceIds',
+                    message: 'Enter the workspace IDs to share the connector version with',
+                    type: 'input',
+                    when: !flags.email &&
+                        !flags.workspaces &&
+                        promptRes.shareMethod === 'workspace',
+                },
+            ]);
+            const connectorName = args.connectorName || promptRes.connectorName;
+            const connectorVersion = this.truncateVersion(args.connectorVersion || promptRes.connectorVersion);
+            const emails = flags.email || shareTargetPrompt.emails;
+            const workspaceIds = flags.workspaces || shareTargetPrompt.workspaceIds;
+            if (emails && workspaceIds) {
+                this.log((0, colorizeString_1.error)('Please provide either emails or workspace IDs, not both'));
+            }
+            else if (emails && !workspaceIds) {
+                this.handleShareByEmail(connectorName, connectorVersion, TRAY_API_TOKEN, emails);
+            }
+            else if (workspaceIds && !emails) {
+                this.handleShareByWorkspace(connectorName, connectorVersion, TRAY_API_TOKEN, workspaceIds);
+            }
+            else {
+                this.log((0, colorizeString_1.error)('Please provide either emails or workspace IDs'));
+            }
+        });
+    }
+    handleShareByEmail(connectorName, connectorVersion, token, emails) {
+        return __awaiter(this, void 0, void 0, function* () {
+            core_1.ux.action.start(`Sharing ${connectorName} ${connectorVersion} with emails`);
+            const input = {
+                connectorName,
+                connectorVersion,
+                emails: this.splitList(emails),
+                token,
+            };
+            const response = yield this.connectorPermissions.shareWithEmails(input);
+            core_1.ux.action.stop();
+            if (response.isSuccess) {
+                this.log((0, colorizeString_1.success)(response.value.message));
+            }
+            if (response.isFailure) {
+                this.log((0, colorizeString_1.error)(`Connector Share By Email Failed, please try again or contact support`));
+                this.log(response.error.message);
+            }
+        });
+    }
+    handleShareByWorkspace(connectorName, connectorVersion, token, workspaceIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            core_1.ux.action.start(`Sharing ${connectorName} ${connectorVersion} with emails assigned to the given workspaces`);
+            const input = {
+                connectorName,
+                connectorVersion,
+                workspaceIds: this.splitList(workspaceIds),
+                token,
+            };
+            const response = yield this.connectorPermissions.shareWithWorkspaces(input);
+            core_1.ux.action.stop();
+            if (response.isSuccess) {
+                this.log((0, colorizeString_1.success)(response.value.success.message));
+                if (response.value.warnings.emptyWorkspaces.length > 0) {
+                    this.log((0, colorizeString_1.error)(response.value.warnings.emptyWorkspaces.join(', ')));
+                }
+            }
+            if (response.isFailure) {
+                this.log((0, colorizeString_1.error)(`Connector Share By Workspace Failed, please try again or contact support`));
+                this.log(response.error.message);
+            }
+        });
+    }
+    splitList(list) {
+        return list
+            .replace(/['"]+/g, '')
+            .split(',')
+            .map((item) => item.trim());
+    }
+    truncateVersion(version) {
+        return version.split('.').slice(0, 2).join('.');
+    }
+}
+Share.description = 'Share your connector version with other users in your organization';
+Share.examples = [
+    '<%= config.bin %> <%= command.id %>',
+    '<%= config.bin %> <%= command.id %> my-connector',
+    '<%= config.bin %> <%= command.id %> my-connector 1.0',
+    '<%= config.bin %> <%= command.id %> my-connector 1.0 --email="my.email@domain.com, your.email@domain.com"',
+    '<%= config.bin %> <%= command.id %> my-connector 1.0 -e="my.email@domain.com, your.email@domain.com"',
+    '<%= config.bin %> <%= command.id %> my-connector 1.0 --workspace="<workspace-id>, <another-workspace-id>"',
+    '<%= config.bin %> <%= command.id %> my-connector 1.0 -w="<workspace-id>, <another-workspace-id>"',
+];
+Share.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',
+    }),
+};
+Share.flags = {
+    email: core_1.Flags.string({
+        char: 'e',
+        aliases: ['emails', 'email'],
+        description: 'Share with users by providing a list of emails',
+    }),
+    workspaces: core_1.Flags.string({
+        char: 'w',
+        aliases: ['workspaces', 'workspace'],
+        description: 'Share with the emails of users in a workspace by providing a list of workspace IDs',
+    }),
+};
+exports.default = Share;

package/dist/commands/share.unit.test.d.ts

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

package/dist/commands/share.unit.test.d.ts.map

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

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

@@ -0,0 +1,119 @@
+"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 stdout_stderr_1 = require("stdout-stderr");
+const ConnectorPermissionsHttpClient_1 = require("@trayio/tray-client/connector/permissions/ConnectorPermissionsHttpClient");
+const share_1 = __importDefault(require("./share"));
+jest.mock('@trayio/tray-client/connector/permissions/ConnectorPermissionsHttpClient', () => ({
+    ConnectorPermissionsHttpClient: jest.fn(),
+}));
+describe('Share', () => {
+    let success = true;
+    const connectorName = 'some-connector-name';
+    const connectorVersion = '1.0';
+    const emails = 'test.user@tray.io, another.user@tray.io';
+    const workspaceIds = 'workspace-id,another-workspace-id';
+    const mockedShareWithEmailsSuccess = jest.fn().mockReturnValue({
+        isSuccess: true,
+        value: {
+            message: '1 permissions added',
+        },
+    });
+    const mockedShareWithEmailsFailure = jest.fn().mockReturnValue({
+        isFailure: true,
+        error: {
+            message: `The connector (Left(some-connector-name~1.1)) was not found or you don't have permission to access it`,
+        },
+    });
+    const mockedShareWithWorkspacesSuccess = jest.fn().mockReturnValue({
+        isSuccess: true,
+        value: {
+            success: { message: '5 permissions added' },
+            warnings: {
+                emptyWorkspaces: [
+                    'No permissions to add for workspace: 9b31dc75-3217-458b-923a-8a48ff5b5e',
+                ],
+            },
+        },
+    });
+    const mockedShareWithWorkspacesFailure = jest.fn().mockReturnValue({
+        isFailure: true,
+        error: {
+            message: `The connector (Left(some-connector-name~1.1)) was not found or you don't have permission to access it`,
+        },
+    });
+    beforeEach(() => {
+        ConnectorPermissionsHttpClient_1.ConnectorPermissionsHttpClient.mockImplementation(() => ({
+            shareWithEmails: success
+                ? mockedShareWithEmailsSuccess
+                : mockedShareWithEmailsFailure,
+            shareWithWorkspaces: success
+                ? mockedShareWithWorkspacesSuccess
+                : mockedShareWithWorkspacesFailure,
+        }));
+    });
+    afterAll(() => {
+        jest.clearAllMocks();
+    });
+    it('should log success message when connector is shared by email', () => __awaiter(void 0, void 0, void 0, function* () {
+        success = true;
+        stdout_stderr_1.stdout.start();
+        yield share_1.default.run([connectorName, connectorVersion, `--email='${emails}'`]);
+        stdout_stderr_1.stdout.stop();
+        expect(mockedShareWithEmailsSuccess).toHaveBeenCalledWith({
+            connectorName,
+            connectorVersion,
+            emails: ['test.user@tray.io', 'another.user@tray.io'],
+            token: undefined,
+        });
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('1 permissions added'));
+    }));
+    it('should log error messages when share with emails fails', () => __awaiter(void 0, void 0, void 0, function* () {
+        success = false;
+        stdout_stderr_1.stdout.start();
+        yield share_1.default.run([connectorName, connectorVersion, `--emails='${emails}'`]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector Share By Email Failed, please try again or contact support'));
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(`The connector (Left(some-connector-name~1.1)) was not found or you don't have permission to access it`));
+    }));
+    it('should log success message when connector is shared by workspaces and warn of empty workspaces', () => __awaiter(void 0, void 0, void 0, function* () {
+        success = true;
+        stdout_stderr_1.stdout.start();
+        yield share_1.default.run([
+            connectorName,
+            connectorVersion,
+            `--workspaces='${workspaceIds}'`,
+        ]);
+        stdout_stderr_1.stdout.stop();
+        expect(mockedShareWithWorkspacesSuccess).toHaveBeenCalledWith({
+            connectorName,
+            connectorVersion,
+            workspaceIds: ['workspace-id', 'another-workspace-id'],
+            token: undefined,
+        });
+        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'));
+    }));
+    it('should log error message when connector share by workspaces fails', () => __awaiter(void 0, void 0, void 0, function* () {
+        success = false;
+        stdout_stderr_1.stdout.start();
+        yield share_1.default.run([
+            connectorName,
+            connectorVersion,
+            `--workspaces='${workspaceIds}'`,
+        ]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(`The connector (Left(some-connector-name~1.1)) was not found or you don't have permission to access it`));
+    }));
+});

package/oclif.manifest.json

@@ -193,6 +193,71 @@
         "init.js"
       ]
     },
+    "share": {
+      "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": "Share your connector version with other users in your organization",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> my-connector",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 --email=\"my.email@domain.com, your.email@domain.com\"",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 -e=\"my.email@domain.com, your.email@domain.com\"",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 --workspace=\"<workspace-id>, <another-workspace-id>\"",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 -w=\"<workspace-id>, <another-workspace-id>\""
+      ],
+      "flags": {
+        "email": {
+          "aliases": [
+            "emails",
+            "email"
+          ],
+          "char": "e",
+          "description": "Share with users by providing a list of emails",
+          "name": "email",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "workspaces": {
+          "aliases": [
+            "workspaces",
+            "workspace"
+          ],
+          "char": "w",
+          "description": "Share with the emails of users in a workspace by providing a list of workspace IDs",
+          "name": "workspaces",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "share",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "share.js"
+      ]
+    },
     "test": {
       "aliases": [],
       "args": {
@@ -228,5 +293,5 @@
       ]
     }
   },
-  "version": "2.17.0"
+  "version": "2.18.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-cli",
-  "version": "2.17.0",
+  "version": "2.18.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.17.0",
-    "@trayio/cdk-build": "2.17.0",
-    "@trayio/commons": "2.17.0",
-    "@trayio/generator": "2.17.0",
-    "@trayio/tray-client": "2.17.0",
-    "@trayio/tray-openapi": "2.17.0",
+    "@trayio/axios": "2.18.0",
+    "@trayio/cdk-build": "2.18.0",
+    "@trayio/commons": "2.18.0",
+    "@trayio/generator": "2.18.0",
+    "@trayio/tray-client": "2.18.0",
+    "@trayio/tray-openapi": "2.18.0",
     "@types/inquirer": "8.2.6",
     "chalk": "4.1.2",
     "inquirer": "8.2.5"