@trayio/cdk-cli 3.13.0 → 3.14.0-beta

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/3.13.0 linux-x64 node-v18.19.1
+@trayio/cdk-cli/3.14.0-beta linux-x64 node-v18.19.1
 $ tray-cdk --help [COMMAND]
 USAGE
   $ tray-cdk COMMAND
@@ -39,6 +39,7 @@ USAGE
 * [`tray-cdk connector test [OPERATIONNAME]`](#tray-cdk-connector-test-operationname)
 * [`tray-cdk deployment create`](#tray-cdk-deployment-create)
 * [`tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID]`](#tray-cdk-deployment-get-connectorname-connectorversion-uuid)
+* [`tray-cdk deployment publish`](#tray-cdk-deployment-publish)
 * [`tray-cdk help [COMMANDS]`](#tray-cdk-help-commands)
 * [`tray-cdk permissions add [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-add-connectorname-connectorversion)
 * [`tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-list-connectorname-connectorversion)
@@ -213,6 +214,18 @@ EXAMPLES
   $ tray-cdk deployment get my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 -t
 ```
 
+## `tray-cdk deployment publish`
+
+Publishes a connector project (beta)
+
+```
+USAGE
+  $ tray-cdk deployment publish
+
+DESCRIPTION
+  Publishes a connector project (beta)
+```
+
 ## `tray-cdk help [COMMANDS]`
 
 Display help for tray-cdk.

package/dist/commands/deployment/create.js

@@ -65,10 +65,10 @@ class Create extends core_1.Command {
         if (response.isSuccess) {
             const { id } = response.value;
             if (response.value.repeatDeployment === true) {
-                core_1.ux.action.stop((0, colorizeString_1.warning)(`Connector ${connectorName} - ${connectorVersion} deployment is already in progress. Deployment ID: ${id}. Please check for the status using 'tray-cdk deployment get' command.`));
+                core_1.ux.action.stop((0, colorizeString_1.warning)(`Connector ${connectorName} - ${connectorVersion} deployment is already in progress. Deployment ID: ${id}. Run "tray-cdk deployment get" to check the status.`));
             }
             else {
-                core_1.ux.action.stop((0, colorizeString_1.success)('Deployment created! The deployment may take a few minutes to complete. Use `tray-cdk deployment get` to check the status.'));
+                core_1.ux.action.stop((0, colorizeString_1.success)(`Deployment created! The deployment may take a few minutes to complete. Run "tray-cdk deployment get" to check the status.`));
                 this.log(`Connector ${connectorName} - ${connectorVersion} deployment is in progress. Deployment ID: ${id}.`);
             }
         }

package/dist/commands/deployment/create.unit.test.js

@@ -61,7 +61,7 @@ describe('Create', () => {
         expect(test_1.default.run).toHaveBeenCalledWith([]);
         expect(build_1.default.run).toHaveBeenCalledWith([]);
         expect(startSpy).toHaveBeenCalledWith('Creating Connector Deployment');
-        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining('Deployment created! The deployment may take a few minutes to complete. Use `tray-cdk deployment get` to check the status.'));
+        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining('Deployment created! The deployment may take a few minutes to complete. Run "tray-cdk deployment get" to check the status.'));
         expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector connectorName - 1.0 deployment is in progress. Deployment ID: some-id.'));
     });
     it('should inform user of repeatDeployment when deployment is already in progress', async () => {
@@ -74,7 +74,7 @@ describe('Create', () => {
         expect(test_1.default.run).toHaveBeenCalledWith([]);
         expect(build_1.default.run).toHaveBeenCalledWith([]);
         expect(startSpy).toHaveBeenCalledWith('Creating Connector Deployment');
-        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining(`Connector connectorName - 1.0 deployment is already in progress. Deployment ID: some-id. Please check for the status using 'tray-cdk deployment get' command.`));
+        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining(`Connector connectorName - 1.0 deployment is already in progress. Deployment ID: some-id. Run "tray-cdk deployment get" to check the status.`));
     });
     it('should error when the deployment fails', async () => {
         success = false;

package/dist/commands/deployment/publish.d.ts

@@ -0,0 +1,8 @@
+import { Command } from '@oclif/core';
+export default class Publish extends Command {
+    static description: string;
+    static args: {};
+    private connectorDeployment;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=publish.d.ts.map

package/dist/commands/deployment/publish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../../../src/commands/deployment/publish.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAM,MAAM,aAAa,CAAC;AAa1C,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,OAAO;IAC3C,MAAM,CAAC,WAAW,SAA0C;IAE5D,MAAM,CAAC,IAAI,KAAM;IAEjB,OAAO,CAAC,mBAAmB,CAKzB;IAEI,GAAG;CAmET"}

package/dist/commands/deployment/publish.js

@@ -0,0 +1,88 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const pathLib = __importStar(require("path"));
+const core_1 = require("@oclif/core");
+const inquirer_1 = __importDefault(require("inquirer"));
+const fse = __importStar(require("fs-extra"));
+const AxiosHttpClient_1 = require("@trayio/axios/http/AxiosHttpClient");
+const ConnectorDeploymentHttpClient_1 = require("@trayio/tray-client/connector/deployment/ConnectorDeploymentHttpClient");
+const test_1 = __importDefault(require("../connector/test"));
+const build_1 = __importDefault(require("../connector/build"));
+const colorizeString_1 = require("../../utils/colorizeString");
+const check_env_1 = require("../../utils/check-env");
+class Publish extends core_1.Command {
+    static description = 'Publishes a connector project (beta)';
+    static args = {};
+    connectorDeployment = new ConnectorDeploymentHttpClient_1.ConnectorDeploymentHttpClient({
+        baseUrl: process.env.TRAY_API_URL,
+    }, new AxiosHttpClient_1.AxiosHttpClient());
+    async run() {
+        (0, check_env_1.checkEnv)();
+        await test_1.default.run([]);
+        await build_1.default.run([]);
+        const currentDirectory = process.cwd();
+        const connectorZipPath = pathLib.join(currentDirectory, 'dist', 'connector.zip');
+        const TRAY_API_TOKEN = process.env.TRAY_API_TOKEN;
+        const zipFile = fse.readFileSync(connectorZipPath);
+        const sourceCode = Buffer.from(zipFile).toString('base64');
+        const connectorJsonPath = pathLib.join(currentDirectory, 'connector.json');
+        const connectorJson = fse.readJsonSync(connectorJsonPath);
+        const connectorName = connectorJson.name;
+        const connectorVersion = connectorJson.version;
+        const promptRes = await inquirer_1.default.prompt([
+            {
+                name: 'makePublic',
+                message: 'Make connector public?',
+                type: 'confirm',
+                // TODO: only ask this prompt for connector devs once draft is available to customers
+                // when: !isConnectorDev,
+                default: false,
+            },
+        ]);
+        const input = {
+            connectorName,
+            connectorVersion,
+            connectorSourceCode: sourceCode,
+            makePublic: promptRes.makePublic,
+            token: TRAY_API_TOKEN,
+        };
+        core_1.ux.action.start('Starting Connector Publishing\n');
+        const response = await this.connectorDeployment.publishFromSourceCode(input);
+        if (response.isSuccess) {
+            const { id } = response.value;
+            core_1.ux.action.stop((0, colorizeString_1.success)(`Publishing is in progress! This may take a few minutes to complete. Run "tray-cdk deployment get" to check the status.`));
+            this.log(`Connector ${connectorName} - ${connectorVersion} publishing is in progress. Deployment ID: ${id}.`);
+        }
+        if (response.isFailure) {
+            core_1.ux.action.stop((0, colorizeString_1.error)('There was an error trying to publish.'));
+            this.log(response.error.message);
+        }
+    }
+}
+exports.default = Publish;

package/dist/commands/deployment/publish.unit.test.d.ts

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

package/dist/commands/deployment/publish.unit.test.d.ts.map

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

package/dist/commands/deployment/publish.unit.test.js

@@ -0,0 +1,86 @@
+"use strict";
+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 core_1 = require("@oclif/core");
+const inquirer_1 = __importDefault(require("inquirer"));
+const ConnectorDeploymentHttpClient_1 = require("@trayio/tray-client/connector/deployment/ConnectorDeploymentHttpClient");
+const test_1 = __importDefault(require("../connector/test"));
+const build_1 = __importDefault(require("../connector/build"));
+const publish_1 = __importDefault(require("./publish"));
+jest.mock('inquirer', () => ({
+    prompt: jest.fn(),
+    registerPrompt: jest.requireActual('inquirer').registerPrompt,
+}));
+jest.mock('fs-extra');
+jest.mock('path');
+jest.mock('../connector/test');
+jest.mock('../connector/build');
+jest.mock('@trayio/tray-client/connector/deployment/ConnectorDeploymentHttpClient', () => ({
+    ConnectorDeploymentHttpClient: jest.fn(),
+}));
+jest.mock('fs-extra', () => ({
+    readFileSync: jest.fn().mockReturnValue(new ArrayBuffer(8)),
+    readJsonSync: jest.fn().mockReturnValue({
+        name: 'connectorName',
+        version: '1.0',
+    }),
+}));
+describe('Publish', () => {
+    const mockInquirer = inquirer_1.default;
+    let success = true;
+    let failure = false;
+    beforeEach(() => {
+        ConnectorDeploymentHttpClient_1.ConnectorDeploymentHttpClient.mockImplementation(() => ({
+            publishFromSourceCode: jest.fn().mockReturnValue({
+                isSuccess: success,
+                ...(success && {
+                    value: {
+                        id: 'some-id',
+                    },
+                }),
+                isFailure: failure,
+                ...(failure && {
+                    error: {
+                        message: 'There was an error deploying the connector',
+                    },
+                }),
+            }),
+        }));
+    });
+    beforeAll(() => {
+        mockInquirer.prompt.mockResolvedValue({
+            makePublic: true,
+        });
+    });
+    afterAll(() => {
+        jest.clearAllMocks();
+    });
+    it('should start publishing without errors', async () => {
+        success = true;
+        failure = false;
+        const startSpy = jest.spyOn(core_1.ux.action, 'start');
+        const stopSpy = jest.spyOn(core_1.ux.action, 'stop');
+        stdout_stderr_1.stdout.start();
+        await publish_1.default.run([]);
+        stdout_stderr_1.stdout.stop();
+        expect(test_1.default.run).toHaveBeenCalledWith([]);
+        expect(build_1.default.run).toHaveBeenCalledWith([]);
+        expect(startSpy).toHaveBeenCalledWith(expect.stringContaining('Starting Connector Publishing'));
+        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining('Publishing is in progress! This may take a few minutes to complete. Run "tray-cdk deployment get" to check the status.'));
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector connectorName - 1.0 publishing is in progress. Deployment ID: some-id.'));
+    });
+    it('should error when the publishing fails', async () => {
+        success = false;
+        failure = true;
+        const startSpy = jest.spyOn(core_1.ux.action, 'start');
+        const stopSpy = jest.spyOn(core_1.ux.action, 'stop');
+        await publish_1.default.run([]);
+        expect(test_1.default.run).toHaveBeenCalledWith([]);
+        expect(build_1.default.run).toHaveBeenCalledWith([]);
+        expect(startSpy).toHaveBeenCalledWith(expect.stringContaining('Starting Connector Publishing'));
+        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining('There was an error trying to publish.'));
+    });
+});

package/oclif.manifest.json

@@ -253,6 +253,27 @@
         "get.js"
       ]
     },
+    "deployment:publish": {
+      "aliases": [],
+      "args": {},
+      "description": "Publishes a connector project (beta)",
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "deployment:publish",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "deployment",
+        "publish.js"
+      ]
+    },
     "permissions:add": {
       "aliases": [],
       "args": {
@@ -343,5 +364,5 @@
       ]
     }
   },
-  "version": "3.13.0"
+  "version": "3.14.0-beta"
 }

package/package.json

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