@trayio/cdk-cli 4.76.0 → 4.78.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/4.76.0 linux-x64 node-v18.20.7
+@trayio/cdk-cli/4.78.0 linux-x64 node-v18.20.7
 $ tray-cdk --help [COMMAND]
 USAGE
   $ tray-cdk COMMAND
@@ -40,6 +40,8 @@ USAGE
 * [`tray-cdk deployment create`](#tray-cdk-deployment-create)
 * [`tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID]`](#tray-cdk-deployment-get-connectorname-connectorversion-uuid)
 * [`tray-cdk help [COMMAND]`](#tray-cdk-help-command)
+* [`tray-cdk namespace create ORGID NAMESPACE`](#tray-cdk-namespace-create-orgid-namespace)
+* [`tray-cdk namespace get ORGID`](#tray-cdk-namespace-get-orgid)
 * [`tray-cdk permissions add [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-add-connectorname-connectorversion)
 * [`tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-list-connectorname-connectorversion)
 * [`tray-cdk plugins`](#tray-cdk-plugins)
@@ -256,6 +258,57 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_
 
+## `tray-cdk namespace create ORGID NAMESPACE`
+
+Creates a new connector namespace for your organization
+
+```
+USAGE
+  $ tray-cdk namespace create ORGID NAMESPACE [--us] [--eu] [--ap]
+
+ARGUMENTS
+  ORGID      The ID of the organization for which to create the namespace
+  NAMESPACE  The name of the namespace to create
+
+FLAGS
+  --ap  Use the Tray APAC region
+  --eu  Use the Tray EU region
+  --us  Use the Tray US region
+
+DESCRIPTION
+  Creates a new connector namespace for your organization
+
+EXAMPLES
+  $ tray-cdk namespace create org-id namespace
+
+  $ tray-cdk namespace create org-id namespace --us
+```
+
+## `tray-cdk namespace get ORGID`
+
+Retrieves the connector namespace for your organization, if one exists
+
+```
+USAGE
+  $ tray-cdk namespace get ORGID [--us] [--eu] [--ap]
+
+ARGUMENTS
+  ORGID  The ID of the organization you want to retrieve the namespace for
+
+FLAGS
+  --ap  Use the Tray APAC region
+  --eu  Use the Tray EU region
+  --us  Use the Tray US region
+
+DESCRIPTION
+  Retrieves the connector namespace for your organization, if one exists
+
+EXAMPLES
+  $ tray-cdk namespace get some-org-id
+
+  $ tray-cdk namespace get some-org-id --us
+```
+
 ## `tray-cdk permissions add [CONNECTORNAME] [CONNECTORVERSION]`
 
 Share your connector version with other users in your organization

package/dist/commands/namespace/create.d.ts

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+export default class Create extends Command {
+    static description: string;
+    static args: {
+        orgId: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+        namespace: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        us: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        eu: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        ap: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static examples: string[];
+    private regionHandler;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=create.d.ts.map

package/dist/commands/namespace/create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../src/commands/namespace/create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAmB,MAAM,aAAa,CAAC;AAQvD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,OAAO;IAC1C,MAAM,CAAC,WAAW,SACyC;IAE3D,MAAM,CAAC,IAAI;;;MAYT;IAEF,MAAM,CAAC,KAAK;;;;MAEV;IAEF,MAAM,CAAC,QAAQ,WAGb;IAEF,OAAO,CAAC,aAAa,CAGnB;IAEI,GAAG;CAgDT"}

package/dist/commands/namespace/create.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const ConnectorNamespaceHttpClient_1 = require("@trayio/tray-client/connector/namespace/ConnectorNamespaceHttpClient");
+const AxiosHttpClient_1 = require("@trayio/axios/http/AxiosHttpClient");
+const region_1 = require("../../utils/region");
+const colorizeString_1 = require("../../utils/colorizeString");
+const check_env_1 = require("../../utils/check-env");
+class Create extends core_1.Command {
+    static description = 'Creates a new connector namespace for your organization';
+    static args = {
+        orgId: core_1.Args.string({
+            name: 'Organization ID',
+            required: true,
+            description: 'The ID of the organization for which to create the namespace',
+        }),
+        namespace: core_1.Args.string({
+            name: 'Namespace',
+            required: true,
+            description: 'The name of the namespace to create',
+        }),
+    };
+    static flags = {
+        ...region_1.regionFlags,
+    };
+    static examples = [
+        `<%= config.bin %> <%= command.id %> org-id namespace`,
+        `<%= config.bin %> <%= command.id %> org-id namespace --us`,
+    ];
+    regionHandler = new region_1.RegionHandler(ConnectorNamespaceHttpClient_1.ConnectorNamespaceHttpClient, new AxiosHttpClient_1.AxiosHttpClient());
+    async run() {
+        const { args, flags } = await this.parse(Create);
+        const { orgId, namespace } = args;
+        (0, check_env_1.checkTokenEnv)();
+        const input = {
+            organizationId: orgId,
+            namespace,
+            token: process.env.TRAY_API_TOKEN,
+        };
+        core_1.ux.action.start(`Creating namespace...`);
+        const response = await this.regionHandler.invoke(flags).create(input);
+        core_1.ux.action.stop();
+        if (response.isSuccess) {
+            this.log((0, colorizeString_1.success)(`Namespace Added!\nOrganization: ${(0, colorizeString_1.info)(orgId)}\nNamespace: ${(0, colorizeString_1.info)(namespace)}`));
+        }
+        if (response.isFailure) {
+            if (response.error.message.includes('is already associated with a namespace')) {
+                this.log((0, colorizeString_1.error)(`A namespace already exists for organization '${orgId}', use the 'get' command to retrieve it.\n${(0, colorizeString_1.info)('If you would like to update your namespace, please contact Tray support.')}`));
+            }
+            else {
+                this.log((0, colorizeString_1.error)(`Failed to create namespace: ${response.error.message}`));
+            }
+        }
+    }
+}
+exports.default = Create;

package/dist/commands/namespace/create.unit.test.d.ts

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

package/dist/commands/namespace/create.unit.test.d.ts.map

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

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

@@ -0,0 +1,66 @@
+"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 ConnectorNamespaceHttpClient_1 = require("@trayio/tray-client/connector/namespace/ConnectorNamespaceHttpClient");
+const create_1 = __importDefault(require("./create"));
+jest.mock('@trayio/tray-client/connector/namespace/ConnectorNamespaceHttpClient', () => ({
+    ConnectorNamespaceHttpClient: jest.fn(),
+}));
+describe('CreateNamespace', () => {
+    let success = true;
+    let failure = false;
+    let namespaceExists = false;
+    const orgId = 'some-org-id';
+    const namespace = 'some-namespace';
+    beforeEach(() => {
+        success = true;
+        failure = false;
+        ConnectorNamespaceHttpClient_1.ConnectorNamespaceHttpClient.mockImplementation(() => ({
+            create: jest.fn().mockReturnValue({
+                isSuccess: success,
+                ...(success && {
+                    value: {
+                        namespace,
+                    },
+                }),
+                isFailure: failure,
+                ...(failure && {
+                    error: {
+                        message: namespaceExists
+                            ? 'Organization org-id is already associated with a namespace: namespace'
+                            : 'There was an error creating the namespace',
+                    },
+                }),
+            }),
+        }));
+    });
+    afterAll(() => {
+        jest.clearAllMocks();
+    });
+    it('should log success message when namespace is created', async () => {
+        stdout_stderr_1.stdout.start();
+        await create_1.default.run([orgId, namespace]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(`Namespace Added!\nOrganization: ${orgId}\nNamespace: ${namespace}`));
+    });
+    it('should log error message when namespace creation fails', async () => {
+        success = false;
+        failure = true;
+        stdout_stderr_1.stdout.start();
+        await create_1.default.run([orgId, namespace]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Failed to create namespace: There was an error creating the namespace'));
+    });
+    it('should log error message when namespace already exists', async () => {
+        success = false;
+        failure = true;
+        namespaceExists = true;
+        stdout_stderr_1.stdout.start();
+        await create_1.default.run([orgId, namespace]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(`A namespace already exists for organization '${orgId}', use the 'get' command to retrieve it.\nIf you would like to update your namespace, please contact Tray support.`));
+    });
+});

package/dist/commands/namespace/get.d.ts

@@ -0,0 +1,16 @@
+import { Command } from '@oclif/core';
+export default class Get extends Command {
+    static description: string;
+    static args: {
+        orgId: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        us: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        eu: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        ap: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static examples: string[];
+    private regionHandler;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=get.d.ts.map

package/dist/commands/namespace/get.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../../src/commands/namespace/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAmB,MAAM,aAAa,CAAC;AASvD,MAAM,CAAC,OAAO,OAAO,GAAI,SAAQ,OAAO;IACvC,MAAM,CAAC,WAAW,SACwD;IAE1E,MAAM,CAAC,IAAI;;MAOT;IAEF,MAAM,CAAC,KAAK;;;;MAEV;IAEF,MAAM,CAAC,QAAQ,WAGb;IAEF,OAAO,CAAC,aAAa,CAGnB;IAEI,GAAG;CA6CT"}

package/dist/commands/namespace/get.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const AxiosHttpClient_1 = require("@trayio/axios/http/AxiosHttpClient");
+const ConnectorNamespaceHttpClient_1 = require("@trayio/tray-client/connector/namespace/ConnectorNamespaceHttpClient");
+const region_1 = require("../../utils/region");
+const colorizeString_1 = require("../../utils/colorizeString");
+const check_env_1 = require("../../utils/check-env");
+class Get extends core_1.Command {
+    static description = 'Retrieves the connector namespace for your organization, if one exists';
+    static args = {
+        orgId: core_1.Args.string({
+            name: 'Organization ID',
+            required: true,
+            description: 'The ID of the organization you want to retrieve the namespace for',
+        }),
+    };
+    static flags = {
+        ...region_1.regionFlags,
+    };
+    static examples = [
+        `<%= config.bin %> <%= command.id %> some-org-id`,
+        `<%= config.bin %> <%= command.id %> some-org-id --us`,
+    ];
+    regionHandler = new region_1.RegionHandler(ConnectorNamespaceHttpClient_1.ConnectorNamespaceHttpClient, new AxiosHttpClient_1.AxiosHttpClient());
+    async run() {
+        (0, check_env_1.checkTokenEnv)();
+        const { args, flags } = await this.parse(Get);
+        const TRAY_API_TOKEN = process.env.TRAY_API_TOKEN;
+        const input = {
+            organizationId: args.orgId,
+            token: TRAY_API_TOKEN,
+        };
+        core_1.ux.action.start(`Fetching namespace...`);
+        const response = await this.regionHandler.invoke(flags).get(input);
+        core_1.ux.action.stop();
+        if (response.isSuccess) {
+            this.log((0, colorizeString_1.success)(`Organization: ${(0, colorizeString_1.info)(args.orgId)}\nNamespace: ${(0, colorizeString_1.info)(response.value.namespace)}`));
+        }
+        if (response.isFailure) {
+            if (response.error.message.includes('Could not find namespace')) {
+                this.log((0, colorizeString_1.error)(`Namespace could not be found for organization: ${(0, colorizeString_1.info)(args.orgId)}`));
+            }
+            else {
+                this.log((0, colorizeString_1.error)(`There was an error retrieving the namespace, please try again or contact support`));
+                this.log(response.error.message);
+            }
+        }
+    }
+}
+exports.default = Get;

package/dist/commands/namespace/get.unit.test.d.ts

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

package/dist/commands/namespace/get.unit.test.d.ts.map

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

package/dist/commands/namespace/get.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 ConnectorNamespaceHttpClient_1 = require("@trayio/tray-client/connector/namespace/ConnectorNamespaceHttpClient");
+const get_1 = __importDefault(require("./get"));
+jest.mock('@trayio/tray-client/connector/namespace/ConnectorNamespaceHttpClient', () => ({
+    ConnectorNamespaceHttpClient: jest.fn(),
+}));
+describe('GetNamespace', () => {
+    let success = true;
+    let failure = false;
+    let notFound = false;
+    const orgId = 'some-org-id';
+    const namespace = 'some-namespace';
+    beforeEach(() => {
+        success = true;
+        failure = false;
+        notFound = false;
+        ConnectorNamespaceHttpClient_1.ConnectorNamespaceHttpClient.mockImplementation(() => ({
+            get: jest.fn().mockReturnValue({
+                isSuccess: success,
+                ...(success && {
+                    value: {
+                        namespace,
+                    },
+                }),
+                isFailure: failure,
+                ...(failure && {
+                    error: {
+                        message: notFound
+                            ? 'Could not find namespace'
+                            : 'There was an error retrieving the namespace',
+                    },
+                }),
+            }),
+        }));
+    });
+    afterAll(() => {
+        jest.clearAllMocks();
+    });
+    it('should log success message when namespace is retrieved', async () => {
+        stdout_stderr_1.stdout.start();
+        await get_1.default.run([orgId]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(`Organization: ${orgId}\nNamespace: ${namespace}`));
+    });
+    it('should log error message when namespace retrieval fails', async () => {
+        success = false;
+        failure = true;
+        stdout_stderr_1.stdout.start();
+        await get_1.default.run([orgId]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('There was an error retrieving the namespace, please try again or contact support'));
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('There was an error retrieving the namespace'));
+    });
+    it('should log error message when namespace could not be found', async () => {
+        success = false;
+        failure = true;
+        notFound = true;
+        stdout_stderr_1.stdout.start();
+        await get_1.default.run([orgId]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining(`Namespace could not be found for organization: ${orgId}`));
+    });
+    it('should set baseUrl based on region flag', async () => {
+        await get_1.default.run([orgId]);
+        expect(ConnectorNamespaceHttpClient_1.ConnectorNamespaceHttpClient).toHaveBeenCalledWith({
+            baseUrl: 'https://api.tray.io',
+        }, expect.anything());
+        await get_1.default.run([orgId, '--us']);
+        expect(ConnectorNamespaceHttpClient_1.ConnectorNamespaceHttpClient).toHaveBeenCalledWith({
+            baseUrl: 'https://api.tray.io',
+        }, expect.anything());
+        await get_1.default.run([orgId, '--eu']);
+        expect(ConnectorNamespaceHttpClient_1.ConnectorNamespaceHttpClient).toHaveBeenCalledWith({
+            baseUrl: 'https://api.eu1.tray.io',
+        }, expect.anything());
+        await get_1.default.run([orgId, '--ap']);
+        expect(ConnectorNamespaceHttpClient_1.ConnectorNamespaceHttpClient).toHaveBeenCalledWith({
+            baseUrl: 'https://api.ap1.tray.io',
+        }, expect.anything());
+    });
+});

package/oclif.manifest.json

@@ -303,6 +303,111 @@
         "get.js"
       ]
     },
+    "namespace:create": {
+      "aliases": [],
+      "args": {
+        "orgId": {
+          "description": "The ID of the organization for which to create the namespace",
+          "name": "orgId",
+          "required": true
+        },
+        "namespace": {
+          "description": "The name of the namespace to create",
+          "name": "namespace",
+          "required": true
+        }
+      },
+      "description": "Creates a new connector namespace for your organization",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> org-id namespace",
+        "<%= config.bin %> <%= command.id %> org-id namespace --us"
+      ],
+      "flags": {
+        "us": {
+          "description": "Use the Tray US region",
+          "name": "us",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "eu": {
+          "description": "Use the Tray EU region",
+          "name": "eu",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "ap": {
+          "description": "Use the Tray APAC region",
+          "name": "ap",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "namespace:create",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "namespace",
+        "create.js"
+      ]
+    },
+    "namespace:get": {
+      "aliases": [],
+      "args": {
+        "orgId": {
+          "description": "The ID of the organization you want to retrieve the namespace for",
+          "name": "orgId",
+          "required": true
+        }
+      },
+      "description": "Retrieves the connector namespace for your organization, if one exists",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> some-org-id",
+        "<%= config.bin %> <%= command.id %> some-org-id --us"
+      ],
+      "flags": {
+        "us": {
+          "description": "Use the Tray US region",
+          "name": "us",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "eu": {
+          "description": "Use the Tray EU region",
+          "name": "eu",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "ap": {
+          "description": "Use the Tray APAC region",
+          "name": "ap",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "namespace:get",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "namespace",
+        "get.js"
+      ]
+    },
     "permissions:add": {
       "aliases": [],
       "args": {
@@ -430,5 +535,5 @@
       ]
     }
   },
-  "version": "4.76.0"
+  "version": "4.78.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-cli",
-  "version": "4.76.0",
+  "version": "4.78.0",
   "description": "A CLI for connector development",
   "exports": {
     "./*": "./dist/*.js"
@@ -22,12 +22,12 @@
     "@oclif/plugin-version": "2.0.11",
     "@oclif/plugin-warn-if-update-available": "^3.1.4",
     "@oclif/test": "3.1.12",
-    "@trayio/axios": "4.76.0",
-    "@trayio/cdk-build": "4.76.0",
-    "@trayio/commons": "4.76.0",
-    "@trayio/generator": "4.76.0",
-    "@trayio/tray-client": "4.76.0",
-    "@trayio/tray-openapi": "4.76.0",
+    "@trayio/axios": "4.78.0",
+    "@trayio/cdk-build": "4.78.0",
+    "@trayio/commons": "4.78.0",
+    "@trayio/generator": "4.78.0",
+    "@trayio/tray-client": "4.78.0",
+    "@trayio/tray-openapi": "4.78.0",
     "chalk": "4.1.2",
     "inquirer": "8.2.6"
   },