@trayio/cdk-cli 0.0.3 → 0.0.4-beta

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

@@ -0,0 +1,127 @@
+"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 inquirer_1 = __importDefault(require("inquirer"));
+const child_process_1 = require("child_process");
+const init_1 = __importDefault(require("./init"));
+jest.mock('inquirer', () => ({
+    prompt: jest.fn(),
+    registerPrompt: jest.requireActual('inquirer').registerPrompt,
+}));
+jest.mock('child_process', () => (Object.assign(Object.assign({}, jest.requireActual('child_process')), { execSync: jest.fn() })));
+describe('Init', () => {
+    let connectorName = 'my-test-connector';
+    const mockInquirer = inquirer_1.default;
+    beforeAll(() => {
+        mockInquirer.prompt.mockResolvedValue({
+            shouldContinue: true,
+            connectorName,
+        });
+    });
+    afterAll(() => {
+        jest.restoreAllMocks();
+    });
+    it('should prompt for connector name if not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+        const init = new init_1.default([], {});
+        const mockGenerate = jest
+            .fn()
+            .mockImplementation(() => jest.fn().mockResolvedValue(true));
+        init['generator'] = {
+            generate: mockGenerate,
+        };
+        stdout_stderr_1.stdout.start();
+        yield init.run();
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toContain('Success! Added my-test-connector');
+        expect(mockInquirer.prompt).toBeCalledWith([
+            {
+                name: 'connectorName',
+                message: 'Connector directory name to generate template files',
+                type: 'input',
+                when: true,
+                default: 'my-connector',
+            },
+        ]);
+        expect(mockGenerate).toBeCalledWith(expect.stringContaining('modules/cdk-cli/src/templates/connector-template.zip'), process.cwd(), {
+            connectorNameCamelCase: 'myTestConnector',
+            connectorNameKebabCase: 'my-test-connector',
+            connectorNamePascalCase: 'MyTestConnector',
+            connectorNameTitleCase: 'My test connector',
+        });
+        expect(child_process_1.execSync).not.toBeCalled();
+    }));
+    it('should not prompt for connector name if provided', () => __awaiter(void 0, void 0, void 0, function* () {
+        connectorName = 'my-new-connector';
+        const init = new init_1.default([connectorName], {});
+        const mockGenerate = jest
+            .fn()
+            .mockImplementation(() => jest.fn().mockResolvedValue(true));
+        init['generator'] = {
+            generate: mockGenerate,
+        };
+        stdout_stderr_1.stdout.start();
+        yield init.run();
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toContain('Success! Added my-new-connector');
+        expect(mockInquirer.prompt).toBeCalledWith([
+            {
+                name: 'connectorName',
+                message: 'Connector directory name to generate template files',
+                type: 'input',
+                when: false,
+                default: 'my-connector',
+            },
+        ]);
+        expect(mockGenerate).toBeCalledWith(expect.stringContaining('modules/cdk-cli/src/templates/connector-template.zip'), process.cwd(), {
+            connectorNameCamelCase: 'myNewConnector',
+            connectorNameKebabCase: 'my-new-connector',
+            connectorNamePascalCase: 'MyNewConnector',
+            connectorNameTitleCase: 'My new connector',
+        });
+        expect(child_process_1.execSync).not.toBeCalled();
+    }));
+    it('should run npm install if "-i" install flag is passed', () => __awaiter(void 0, void 0, void 0, function* () {
+        connectorName = 'my-install-connector';
+        const init = new init_1.default([connectorName, '-i'], {});
+        const mockGenerate = jest
+            .fn()
+            .mockImplementation(() => jest.fn().mockResolvedValue(true));
+        init['generator'] = {
+            generate: mockGenerate,
+        };
+        stdout_stderr_1.stdout.start();
+        yield init.run();
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toContain('Success! Added my-install-connector');
+        expect(mockInquirer.prompt).toBeCalledWith([
+            {
+                name: 'connectorName',
+                message: 'Connector directory name to generate template files',
+                type: 'input',
+                when: false,
+                default: 'my-connector',
+            },
+        ]);
+        expect(mockGenerate).toBeCalledWith(expect.stringContaining('modules/cdk-cli/src/templates/connector-template.zip'), process.cwd(), {
+            connectorNameCamelCase: 'myInstallConnector',
+            connectorNameKebabCase: 'my-install-connector',
+            connectorNamePascalCase: 'MyInstallConnector',
+            connectorNameTitleCase: 'My install connector',
+        });
+        expect(child_process_1.execSync).toBeCalledWith(`cd ${connectorName} && npm install`, {
+            stdio: 'inherit',
+        });
+    }));
+});

package/dist/commands/test.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class Test extends Command {
+    static description: string;
+    static args: {
+        operationName: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static flags: {
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/commands/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAe,MAAM,aAAa,CAAC;AAMnD,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,OAAO;IACxC,MAAM,CAAC,WAAW,SAAsD;IAExE,MAAM,CAAC,IAAI;;MAMT;IAEF,MAAM,CAAC,KAAK;;MAMV;IAEI,GAAG;CAwBT"}

package/dist/commands/test.js

@@ -0,0 +1,55 @@
+"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 chalk_1 = __importDefault(require("chalk"));
+const lodash_1 = require("lodash");
+const child_process_1 = require("child_process");
+class Test extends core_1.Command {
+    run() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { args, flags } = yield this.parse(Test);
+            const operationNameSnakeCase = (0, lodash_1.snakeCase)(args.operationName);
+            this.log(chalk_1.default.bold(chalk_1.default.gray('Running npm compile...')));
+            (0, child_process_1.execSync)('npm run compile', { stdio: 'inherit' });
+            if (operationNameSnakeCase) {
+                const verboseFlag = flags.verbose ? '-- --verbose=true' : '';
+                this.log(chalk_1.default.bold(chalk_1.default.gray(`Running test for ${operationNameSnakeCase}...`)));
+                (0, child_process_1.execSync)(`npm run test ./src/${operationNameSnakeCase}/handler.test.ts ${verboseFlag}`, {
+                    stdio: 'inherit',
+                });
+            }
+            else {
+                this.log(chalk_1.default.bold(chalk_1.default.gray('Running npm test...')));
+                (0, child_process_1.execSync)('npm run test', { stdio: 'inherit' });
+            }
+            this.log(chalk_1.default.bold(chalk_1.default.green('Tests ran successfully')));
+        });
+    }
+}
+Test.description = 'Build and test connector project or an operation';
+Test.args = {
+    operationName: core_1.Args.string({
+        name: 'Operation name',
+        required: false,
+        description: 'Operation name to run the test against',
+    }),
+};
+Test.flags = {
+    verbose: core_1.Flags.boolean({
+        char: 'v',
+        description: 'Logs the input and output of an operation, requires operation name argument to be specified',
+    }),
+};
+exports.default = Test;

package/dist/utils/check-env.d.ts

@@ -0,0 +1,2 @@
+export declare const checkEnv: () => void;
+//# sourceMappingURL=check-env.d.ts.map

package/dist/utils/check-env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-env.d.ts","sourceRoot":"","sources":["../../src/utils/check-env.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,YAIpB,CAAC"}

package/dist/utils/check-env.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkEnv = void 0;
+const checkEnv = () => {
+    checkMissingEnv();
+    isApiUrlValid();
+    isValidApiToken();
+};
+exports.checkEnv = checkEnv;
+const checkMissingEnv = () => {
+    if (!process.env.TRAY_API_URL) {
+        throw new Error('required env TRAY_API_URL is not set');
+    }
+    if (!process.env.TRAY_API_TOKEN) {
+        throw new Error('required env TRAY_API_TOKEN is not set');
+    }
+};
+const isApiUrlValid = () => {
+    const apiUrl = process.env.TRAY_API_URL;
+    const validApiUrlRegex = /^https:\/\/api\.(?:ap1\.|eu1\.|staging\.)?tray\.io$/;
+    if (!validApiUrlRegex.test(apiUrl)) {
+        throw new Error(`TRAY_API_URL is invalid. It should be one of the following: https://api.tray.io, https://api.ap1.tray.io, https://api.eu1.tray.io`);
+    }
+};
+const isValidApiToken = () => {
+    let apiToken = process.env.TRAY_API_TOKEN;
+    if (apiToken.includes('Bearer ') || apiToken.includes('bearer ')) {
+        apiToken = apiToken.replace(/Bearer |bearer /, '');
+        process.env.TRAY_API_TOKEN = apiToken;
+    }
+    const validApiTokenRegex = /^.{36,}$/; // Token length is atleast 36 characters
+    if (!validApiTokenRegex.test(apiToken)) {
+        throw new Error(`TRAY_API_TOKEN is in a invalid format.`);
+    }
+};

package/dist/utils/check-env.unit.test.d.ts

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

package/dist/utils/check-env.unit.test.d.ts.map

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

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const check_env_1 = require("./check-env");
+describe('checkEnv', () => {
+    const subject = check_env_1.checkEnv;
+    const { env } = process;
+    afterEach(() => {
+        process.env = env;
+    });
+    it('should throw an error if TRAY_API_URL is not set', () => {
+        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' };
+        expect(() => subject()).toThrowError('required env TRAY_API_TOKEN is not set');
+    });
+    it('should throw an error if TRAY_API_URL is invalid', () => {
+        process.env = {
+            TRAY_API_URL: 'https://api.tray.io/invalid',
+            TRAY_API_TOKEN: 'random',
+        };
+        expect(() => subject()).toThrowError('TRAY_API_URL is invalid. It should be one of the following: https://api.tray.io, https://api.ap1.tray.io, https://api.eu1.tray.io');
+    });
+    it('should remove bearer prefix if TRAY_API_TOKEN contains Bearer prefix', () => {
+        process.env = {
+            TRAY_API_URL: 'https://api.tray.io',
+            TRAY_API_TOKEN: 'Bearer 1234567890123456789012345678901234567890123456789012345678901234',
+        };
+        subject();
+        expect(process.env.TRAY_API_TOKEN).toEqual('1234567890123456789012345678901234567890123456789012345678901234');
+    });
+    it('should throw an error if TRAY_API_TOKEN is in an invalid format', () => {
+        process.env = {
+            TRAY_API_URL: 'https://api.tray.io',
+            TRAY_API_TOKEN: '123',
+        };
+        expect(() => subject()).toThrowError('TRAY_API_TOKEN is in a invalid format.');
+    });
+    it('should not throw an error if TRAY_API_URL and TRAY_API_TOKEN are valid', () => {
+        process.env = {
+            TRAY_API_URL: 'https://api.tray.io',
+            TRAY_API_TOKEN: '1234567890123456789012345678901234567890123456789012345678901234',
+        };
+        expect(() => subject()).not.toThrowError();
+    });
+});

package/dist/utils/colorizeString.d.ts

@@ -0,0 +1,5 @@
+export declare const success: (message: string) => string;
+export declare const error: (message: string) => string;
+export declare const warning: (message: string) => string;
+export declare const info: (message: string) => string;
+//# sourceMappingURL=colorizeString.d.ts.map

package/dist/utils/colorizeString.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorizeString.d.ts","sourceRoot":"","sources":["../../src/utils/colorizeString.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,YAAa,MAAM,WAAqC,CAAC;AAE7E,eAAO,MAAM,KAAK,YAAa,MAAM,WAAmC,CAAC;AAEzE,eAAO,MAAM,OAAO,YAAa,MAAM,WAAsC,CAAC;AAE9E,eAAO,MAAM,IAAI,YAAa,MAAM,WAAoC,CAAC"}

package/dist/utils/colorizeString.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.info = exports.warning = exports.error = exports.success = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const success = (message) => chalk_1.default.bold(chalk_1.default.green(message));
+exports.success = success;
+const error = (message) => chalk_1.default.bold(chalk_1.default.red(message));
+exports.error = error;
+const warning = (message) => chalk_1.default.bold(chalk_1.default.yellow(message));
+exports.warning = warning;
+const info = (message) => chalk_1.default.bold(chalk_1.default.blue(message));
+exports.info = info;

package/oclif.manifest.json

@@ -1,36 +1,263 @@
 {
-  "version": "0.0.3",
   "commands": {
-    ".": {
-      "id": ".",
-      "pluginName": "@trayio/cdk-cli",
+    "add-operation": {
+      "aliases": [],
+      "args": {
+        "operationName": {
+          "description": "Operation name",
+          "name": "operationName",
+          "required": false
+        },
+        "operationType": {
+          "description": "Operation type",
+          "name": "operationType",
+          "options": [
+            "http",
+            "composite"
+          ],
+          "required": false
+        }
+      },
+      "description": "Add an operation to connector project",
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "add-operation",
       "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
       "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "add-operation.js"
+      ]
+    },
+    "build": {
       "aliases": [],
+      "args": {},
+      "description": "Builds a connector project",
       "flags": {},
-      "args": {}
-    },
-    "connector:init": {
-      "id": "connector:init",
-      "description": "Initialize a connector project",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "build",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
       "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "build.js"
+      ]
+    },
+    "deploy": {
+      "aliases": [],
+      "args": {},
+      "description": "Deploys a connector project",
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "deploy",
+      "pluginAlias": "@trayio/cdk-cli",
       "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "deploy.js"
+      ]
+    },
+    "deployment-status": {
+      "aliases": [],
+      "args": {
+        "connectorName": {
+          "description": "The name of the connector",
+          "name": "connectorName",
+          "required": true
+        },
+        "connectorVersion": {
+          "description": "The version of the connector",
+          "name": "connectorVersion",
+          "required": true
+        },
+        "uuid": {
+          "description": "The UUID of the deployment, this is included in the tray-cdk deploy output",
+          "name": "uuid",
+          "required": true
+        }
+      },
+      "description": "Retrieves the status of a connector deployment",
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "deployment-status",
       "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
       "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "deployment-status.js"
+      ]
+    },
+    "import-openapi-spec-tst": {
       "aliases": [],
+      "args": {
+        "openApiSpec": {
+          "description": "Location of the OpenAPI specification file",
+          "name": "openApiSpec",
+          "required": false
+        },
+        "connectorName": {
+          "description": "The name of the connector",
+          "name": "connectorName",
+          "required": false
+        }
+      },
+      "description": "Create a connector from an OpenAPI specification: Command is still in BETA",
       "flags": {},
-      "args": {}
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "import-openapi-spec-tst",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "import-openapi-spec-tst.js"
+      ]
     },
-    "connector:operation:add": {
-      "id": "connector:operation:add",
-      "description": "Add an operation to connector project",
+    "import-openapi-spec": {
+      "aliases": [],
+      "args": {
+        "openApiSpec": {
+          "description": "Location of the OpenAPI specification file",
+          "name": "openApiSpec",
+          "required": false
+        },
+        "connectorName": {
+          "description": "The name of the connector",
+          "name": "connectorName",
+          "required": false
+        }
+      },
+      "description": "Create a connector from an OpenAPI specification: Command is still in BETA",
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "import-openapi-spec",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
       "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "import-openapi-spec.js"
+      ]
+    },
+    ".": {
+      "aliases": [],
+      "args": {},
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": ".",
+      "pluginAlias": "@trayio/cdk-cli",
       "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "index.js"
+      ]
+    },
+    "init": {
+      "aliases": [],
+      "args": {
+        "connectorName": {
+          "description": "Connector directory name to generate template files",
+          "name": "connectorName",
+          "required": false
+        }
+      },
+      "description": "Initialize a connector project",
+      "flags": {
+        "install": {
+          "char": "i",
+          "description": "Runs `npm install` after successful generation",
+          "name": "install",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "init",
       "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
       "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "init.js"
+      ]
+    },
+    "test": {
       "aliases": [],
-      "flags": {},
-      "args": {}
+      "args": {
+        "operationName": {
+          "description": "Operation name to run the test against",
+          "name": "operationName",
+          "required": false
+        }
+      },
+      "description": "Build and test connector project or an operation",
+      "flags": {
+        "verbose": {
+          "char": "v",
+          "description": "Logs the input and output of an operation, requires operation name argument to be specified",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "test",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "test.js"
+      ]
     }
-  }
+  },
+  "version": "0.0.4-beta"
 }