@trayio/cdk-cli-commons 4.87.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Tray.io, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

@@ -0,0 +1,3 @@
+export declare const checkTokenEnv: () => void;
+export declare const checkApiUrlEnv: () => 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,aAAa,YAGzB,CAAC;AAEF,eAAO,MAAM,cAAc,YAG1B,CAAC"}

package/dist/utils/check-env.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkApiUrlEnv = exports.checkTokenEnv = void 0;
+const checkTokenEnv = () => {
+    checkMissingTokenEnv();
+    isValidApiToken();
+};
+exports.checkTokenEnv = checkTokenEnv;
+const checkApiUrlEnv = () => {
+    checkMissingApiUrlEnv();
+    isApiUrlValid();
+};
+exports.checkApiUrlEnv = checkApiUrlEnv;
+const checkMissingTokenEnv = () => {
+    if (!process.env.TRAY_API_TOKEN) {
+        throw new Error('required env TRAY_API_TOKEN is not set');
+    }
+};
+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.`);
+    }
+};
+const checkMissingApiUrlEnv = () => {
+    if (!process.env.TRAY_API_URL) {
+        throw new Error('required env TRAY_API_URL is not set, or use the --us, --eu, or --ap region flags');
+    }
+};
+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. Or use the --us, --eu, or --ap region flags`);
+    }
+};

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,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const check_env_1 = require("./check-env");
+describe('checkTokenEnv', () => {
+    const subject = check_env_1.checkTokenEnv;
+    const { env } = process;
+    afterEach(() => {
+        process.env = env;
+    });
+    it('should throw an error if TRAY_API_TOKEN is not set', () => {
+        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 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_TOKEN is valid', () => {
+        process.env = {
+            TRAY_API_TOKEN: '1234567890123456789012345678901234567890123456789012345678901234',
+        };
+        expect(() => subject()).not.toThrowError();
+    });
+});
+describe('checkApiUrlEnv', () => {
+    const subject = check_env_1.checkApiUrlEnv;
+    const { env } = process;
+    afterEach(() => {
+        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_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 not throw an error if TRAY_API_URL is valid', () => {
+        process.env = {
+            TRAY_API_URL: 'https://api.tray.io',
+        };
+        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/dist/utils/region.d.ts

@@ -0,0 +1,20 @@
+import { ParserInput } from '@oclif/core/lib/interfaces/parser';
+import { HttpClient } from '@trayio/commons/src/http/HttpClient';
+import { HttpConfig } from '@trayio/tray-client/src/base/BaseClient';
+export declare const getBaseUrl: (flags: ParserInput['flags']) => string;
+export declare const regionFlags: {
+    us: import("@oclif/core/lib/interfaces/parser").BooleanFlag<boolean>;
+    eu: import("@oclif/core/lib/interfaces/parser").BooleanFlag<boolean>;
+    ap: import("@oclif/core/lib/interfaces/parser").BooleanFlag<boolean>;
+};
+interface HttpImplementation<T> {
+    new (httpConfig: HttpConfig, httpClient: HttpClient): T;
+}
+export declare class RegionHandler<T> {
+    private readonly HttpImplementation;
+    private readonly httpClient;
+    constructor(HttpImplementation: HttpImplementation<T>, httpClient: HttpClient);
+    invoke(flags: ParserInput['flags']): T;
+}
+export {};
+//# sourceMappingURL=region.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"region.d.ts","sourceRoot":"","sources":["../../src/utils/region.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAGrE,eAAO,MAAM,UAAU,UAAW,WAAW,CAAC,OAAO,CAAC,KAAG,MAYxD,CAAC;AAEF,eAAO,MAAM,WAAW;;;;CAUvB,CAAC;AAEF,UAAU,kBAAkB,CAAC,CAAC;IAC7B,KAAK,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,CAAC,CAAC;CACxD;AAED,qBAAa,aAAa,CAAC,CAAC;IAE1B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,UAAU;gBADV,kBAAkB,EAAE,kBAAkB,CAAC,CAAC,CAAC,EACzC,UAAU,EAAE,UAAU;IAGjC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC;CAIzC"}

package/dist/utils/region.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegionHandler = exports.regionFlags = exports.getBaseUrl = void 0;
+const core_1 = require("@oclif/core");
+const check_env_1 = require("./check-env");
+const getBaseUrl = (flags) => {
+    if (flags.us) {
+        return 'https://api.tray.io';
+    }
+    if (flags.eu) {
+        return 'https://api.eu1.tray.io';
+    }
+    if (flags.ap) {
+        return 'https://api.ap1.tray.io';
+    }
+    (0, check_env_1.checkApiUrlEnv)();
+    return process.env.TRAY_API_URL;
+};
+exports.getBaseUrl = getBaseUrl;
+exports.regionFlags = {
+    us: core_1.Flags.boolean({
+        description: 'Use the Tray US region',
+    }),
+    eu: core_1.Flags.boolean({
+        description: 'Use the Tray EU region',
+    }),
+    ap: core_1.Flags.boolean({
+        description: 'Use the Tray APAC region',
+    }),
+};
+class RegionHandler {
+    HttpImplementation;
+    httpClient;
+    constructor(HttpImplementation, httpClient) {
+        this.HttpImplementation = HttpImplementation;
+        this.httpClient = httpClient;
+    }
+    invoke(flags) {
+        const baseUrl = (0, exports.getBaseUrl)(flags);
+        return new this.HttpImplementation({ baseUrl }, this.httpClient);
+    }
+}
+exports.RegionHandler = RegionHandler;

package/dist/utils/region.unit.test.d.ts

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

package/dist/utils/region.unit.test.d.ts.map

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

package/dist/utils/region.unit.test.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AxiosHttpClient_1 = require("@trayio/axios/http/AxiosHttpClient");
+const region_1 = require("./region");
+class HttpImplementationStub {
+    httpConfig;
+    httpClient;
+    constructor(httpConfig, httpClient) {
+        this.httpConfig = httpConfig;
+        this.httpClient = httpClient;
+    }
+    get() {
+        return this.httpConfig.baseUrl;
+    }
+}
+describe('RegionHandler', () => {
+    it('should use TRAY_API_URL env var when passed no flag', () => {
+        process.env = {
+            TRAY_API_URL: 'https://api.tray.io',
+        };
+        const regionHandler = new region_1.RegionHandler(HttpImplementationStub, new AxiosHttpClient_1.AxiosHttpClient());
+        const result = regionHandler.invoke({}).get();
+        expect(result).toEqual('https://api.tray.io');
+    });
+    it('should throw an error when passed no flag and TRAY_API_URL env var is not set', () => {
+        process.env = {
+            TRAY_API_URL: '',
+        };
+        const regionHandler = new region_1.RegionHandler(HttpImplementationStub, new AxiosHttpClient_1.AxiosHttpClient());
+        expect(() => regionHandler.invoke({}).get()).toThrowError('required env TRAY_API_URL is not set, or use the --us, --eu, or --ap region flags');
+    });
+    it('should use US baseUrl when passed us flag', () => {
+        const regionHandler = new region_1.RegionHandler(HttpImplementationStub, new AxiosHttpClient_1.AxiosHttpClient());
+        const flags = { us: true };
+        const result = regionHandler.invoke(flags).get();
+        expect(result).toEqual('https://api.tray.io');
+    });
+    it('should use EU baseUrl when passed eu flag', () => {
+        const regionHandler = new region_1.RegionHandler(HttpImplementationStub, new AxiosHttpClient_1.AxiosHttpClient());
+        const flags = { eu: true };
+        const result = regionHandler.invoke(flags).get();
+        expect(result).toEqual('https://api.eu1.tray.io');
+    });
+    it('should use AP baseUrl when passed ap flag', () => {
+        const regionHandler = new region_1.RegionHandler(HttpImplementationStub, new AxiosHttpClient_1.AxiosHttpClient());
+        const flags = { ap: true };
+        const result = regionHandler.invoke(flags).get();
+        expect(result).toEqual('https://api.ap1.tray.io');
+    });
+});

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@trayio/cdk-cli-commons",
+  "version": "4.87.0",
+  "description": "Shared utils between CDK ClIs",
+  "exports": {
+    "./*": "./dist/*.js"
+  },
+  "author": "Tray.io",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.x"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@oclif/core": "3.18.1",
+    "@oclif/test": "3.1.12",
+    "@trayio/axios": "4.87.0",
+    "@trayio/commons": "4.87.0",
+    "@trayio/tray-client": "4.87.0",
+    "chalk": "4.1.2"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*"
+      ]
+    }
+  },
+  "files": [
+    "/dist"
+  ]
+}