@squiz/dxp-cli-next 5.22.0 → 5.22.1-develop.2

package/lib/auth/login.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const loginCommand: Command;
+export default loginCommand;

package/lib/auth/login.js

@@ -0,0 +1,237 @@
+"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 __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 cli_color_1 = __importDefault(require("cli-color"));
+const commander_1 = require("commander");
+const ApiService_1 = require("../ApiService");
+const ApplicationStore_1 = require("../ApplicationStore");
+const prompt_1 = __importDefault(require("prompt"));
+const PRODUCTION_URL = 'https://dxp.squiz.cloud';
+const loginCommand = new commander_1.Command('login')
+    .name('login')
+    .description('Login to the DXP platform')
+    .addOption(new commander_1.Option('--username <username>', 'Optionally provide username through CLI, or environment variable. If this option is omitted you will be prompted for input in interactive mode').env('DXP_USERNAME'))
+    .addOption(new commander_1.Option('--password <password>', 'Optionally provide password through CLI, or environment variable. If this option is omitted you will be prompted for input in interactive mode').env('DXP_PASSWORD'))
+    .addOption(new commander_1.Option('--dxp-base-url <baseURL>', 'dxp cloud base url e.g. "https://develop-apps-dxp-console.dev.dxp.squiz.cloud/"')
+    .env('DXP_BASE_URL')
+    .default(PRODUCTION_URL))
+    .addOption(new commander_1.Option('--region <region>').choices(['au']).default('au'))
+    .addOption(new commander_1.Option('--tenant <tenantID>'))
+    .configureOutput({
+    outputError(str, write) {
+        write(cli_color_1.default.red(str));
+    },
+})
+    .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const credentials = yield getLoginCredentials(options.username, options.password);
+        if (credentials == false) {
+            console.log(''); // needed to not screw up line endings in terminal
+            return;
+        }
+        yield handleLoginRequest(credentials, options);
+        const availableTenants = yield handleGetTenantsRequest(options);
+        if (options.tenant == undefined) {
+            const selectedTenant = yield promptForTenant(availableTenants);
+            options.tenant = selectedTenant;
+        }
+        else {
+            validateTenant(options.tenant, availableTenants);
+        }
+        return yield writeTenantToSessionConfig(options);
+    }
+    catch (error) {
+        if (!!process.env.DEBUG && error.stack) {
+            loginCommand.error(error.stack);
+        }
+        if (error.message) {
+            loginCommand.error(cli_color_1.default.red(error.message));
+        }
+        else {
+            loginCommand.error(cli_color_1.default.red('An unknown error occurred'));
+        }
+    }
+}));
+function getLoginCredentials(optionalUsername, optionalPassword) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const prompts = [];
+        let username = '';
+        let password = '';
+        if (!optionalUsername) {
+            prompts.push({
+                name: 'username',
+                description: 'Username: ',
+                required: true,
+            });
+        }
+        else {
+            username = optionalUsername;
+        }
+        if (!optionalPassword) {
+            prompts.push({
+                name: 'password',
+                description: 'Password: ',
+                hidden: true,
+                replace: '*',
+                required: true,
+            });
+        }
+        else {
+            password = optionalPassword;
+        }
+        let result;
+        try {
+            prompt_1.default.start({ message: ' ', delimiter: ' ' });
+            result = yield prompt_1.default.get(prompts);
+        }
+        catch (e) {
+            if (e instanceof Error && e.message === 'canceled') {
+                return false;
+            }
+            else {
+                throw e;
+            }
+        }
+        if (result.username)
+            username = result.username;
+        if (result.password)
+            password = result.password;
+        return { username, password };
+    });
+}
+function handleLoginRequest(login, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const apiService = new ApiService_1.ApiService();
+        // Just need to make sure no extra slash at the end
+        const baseUrl = options.dxpBaseUrl.replace(/\/$/, '');
+        const loginUrl = `${baseUrl}/__dxp/${options.region}/dxp/access/login`;
+        const loginString = Buffer.from(JSON.stringify(login)).toString('base64');
+        const loginResponse = yield apiService.client.post(loginUrl, {
+            token: loginString,
+        });
+        switch (loginResponse.status) {
+            case 204:
+                console.log('Login successful');
+                yield (0, ApplicationStore_1.saveApplicationFile)(ApplicationStore_1.STORE_FILES.sessionConfig, JSON.stringify({
+                    baseUrl,
+                    region: options.region,
+                }));
+                return;
+            default:
+                throw new Error(`An error occurred during login ${loginResponse.data.message ? `"${loginResponse.data.message}"` : ''} (code: ${loginResponse.status})`.trim());
+        }
+    });
+}
+function handleGetTenantsRequest(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const apiService = new ApiService_1.ApiService();
+        const baseUrl = options.dxpBaseUrl.replace(/\/$/, '');
+        const tenantsUrl = `${baseUrl}/__dxp/${options.region}/dxp/access/tenants`;
+        const tenantsResponse = yield apiService.client.get(tenantsUrl);
+        switch (tenantsResponse.status) {
+            case 200:
+                return tenantsResponse.data;
+            default:
+                throw new Error(`An error occurred fetching tenants ${tenantsResponse.data.message
+                    ? `"${tenantsResponse.data.message}"`
+                    : ''} (code: ${tenantsResponse.status})`.trim());
+        }
+    });
+}
+function promptForTenant(tenants) {
+    return __awaiter(this, void 0, void 0, function* () {
+        //Our tsconfig module is commonjs so we need to use require here and only version ^8.0.0 of inquirer as latest is default esm
+        const inquirer = yield Promise.resolve().then(() => __importStar(require('inquirer')));
+        const tenantChoices = formatTenantResponseForInquirer(tenants);
+        const selectedTenant = yield inquirer.default.prompt([
+            {
+                type: 'list',
+                name: 'selectedTenantId',
+                message: 'Select a tenant: ',
+                choices: tenantChoices,
+            },
+        ]);
+        //return the tenant ID
+        return selectedTenant.selectedTenantId;
+    });
+}
+function formatTenantResponseForInquirer(tenants) {
+    return tenants.organisations.map(tenant => {
+        return {
+            name: `${tenant.name} : (${tenant.id})`,
+            value: tenant.id,
+        };
+    });
+}
+function validateTenant(tenant, tenants) {
+    if (tenants.organisations.some(t => t.id === tenant)) {
+        return true;
+    }
+    else {
+        let tenantListErrorString = undefined;
+        if (tenants.organisations.length > 5) {
+            const initialTenants = tenants.organisations.slice(0, 5).map(t => t.name);
+            tenantListErrorString = `${initialTenants} ... and ${tenants.organisations.length - 5} more}`;
+        }
+        else {
+            tenantListErrorString = tenants.organisations.map(t => t.name).join(', ');
+        }
+        throw new Error(`
+    The tenant ID you provided : ${tenant} does not correspond to a tenant that you have access to.\n
+    Please ensure that you are using the correct ID and that you have the appropriate permissions to access this tenant.
+    Here is a list of the tenants you have access to: ${tenantListErrorString || 'None'}
+    `);
+    }
+}
+function writeTenantToSessionConfig(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const baseUrl = options.dxpBaseUrl.replace(/\/$/, '');
+        try {
+            yield (0, ApplicationStore_1.saveApplicationFile)(ApplicationStore_1.STORE_FILES.sessionConfig, JSON.stringify({
+                baseUrl,
+                tenant: options.tenant,
+                region: options.region,
+            }));
+            console.log('Tenant saved to session');
+            return;
+        }
+        catch (error) {
+            throw new Error(`An error occurred during saving of tenant: ${error}`);
+        }
+    });
+}
+exports.default = loginCommand;

package/lib/init/index.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const initCommand: Command;
+export default initCommand;

package/lib/init/index.js

@@ -0,0 +1,52 @@
+"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 commander_1 = require("commander");
+const cli_color_1 = __importDefault(require("cli-color"));
+const component_cli_lib_1 = require("@squiz/component-cli-lib");
+var componentTypes;
+(function (componentTypes) {
+    componentTypes["basic"] = "basic";
+    componentTypes["advanced"] = "advanced";
+})(componentTypes || (componentTypes = {}));
+const initCommand = new commander_1.Command('init')
+    .name('init')
+    .addOption(new commander_1.Option('-t, --type <string>', 'Type of component to create. Must be one of: basic, advanced (default: basic)')
+    .choices(['basic', 'advanced'])
+    .default('basic'))
+    .addOption(new commander_1.Option('-d, --destination <string>', 'Destination folder to create the component in (default: current directory)'))
+    .action(({ type: componentType, destination }) => __awaiter(void 0, void 0, void 0, function* () {
+    if (componentType !== 'basic' && componentType !== 'advanced') {
+        initCommand.error(cli_color_1.default.red('Invalid component type. Must be one of: basic, advanced'));
+    }
+    if (!destination) {
+        destination = '.';
+    }
+    console.log(`Creating ${componentType} component in current directory`);
+    try {
+        yield (0, component_cli_lib_1.componentInit)({ componentType, destination });
+    }
+    catch (error) {
+        if (!!process.env.DEBUG && error.stack) {
+            initCommand.error(error.stack);
+        }
+        if (error.message) {
+            initCommand.error(cli_color_1.default.red(error.message));
+        }
+        else {
+            initCommand.error(cli_color_1.default.red('An unknown error occurred'));
+        }
+    }
+}));
+exports.default = initCommand;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.22.0",
+  "version": "5.22.1-develop.2",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },
@@ -41,7 +41,7 @@
   ],
   "dependencies": {
     "@apidevtools/swagger-parser": "10.1.0",
-    "@squiz/component-cli-lib": "~1.70.3",
+    "@squiz/component-cli-lib": "~1.71.1",
     "@squiz/dxp-porter-shared": "0.4.0",
     "@squiz/local-component-dev-ui": "^0.6.1",
     "axios": "1.1.3",