@squiz/dxp-cli-next 5.12.2-develop.1 → 5.13.0-develop.2

package/lib/auth/index.js

@@ -5,11 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const login_1 = __importDefault(require("./login/login"));
+const logout_1 = __importDefault(require("./logout/logout"));
 const authCommand = new commander_1.Command('auth');
 authCommand
     .description('Authenticate into the DXP-Next CLI')
-    .addCommand((0, login_1.default)());
-// Removed because it does not work
-// getting fixed in PLATFORM-940
-// .addCommand(createLogoutCommand());
+    .addCommand((0, login_1.default)())
+    .addCommand((0, logout_1.default)());
 exports.default = authCommand;

package/lib/auth/logout/logout.js

@@ -43,7 +43,7 @@ const createLogoutCommand = () => {
     const logoutCommand = new commander_1.Command('logout')
         .name('logout')
         .description('Log out of the current session')
-        .addOption(new commander_1.Option('-f, --force', 'Skip confirmation prompt'))
+        .addOption(new commander_1.Option('-f, --force', 'skip confirmation prompt'))
         .action((options) => __awaiter(void 0, void 0, void 0, function* () {
         try {
             yield handleLogoutRequest(options);

package/lib/datastore/blueprint/add/add.js

@@ -23,7 +23,15 @@ const createAddCommand = () => {
         .description('Adds a new blueprint')
         .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to run against. If not provided will use configured tenant from login'))
         .addOption(new commander_1.Option('-p, --path <string>', 'Path to your blueprint API yaml file e.g. documents/inputs/blueprint.yaml').makeOptionMandatory())
-        .addOption(new commander_1.Option('-n, --name <string>', 'Name for your blueprint e.g. MyFirstBlueprint').makeOptionMandatory())
+        .addOption(new commander_1.Option('-n, --name <string>', 'Name for your blueprint e.g. MyFirstBlueprint')
+        .makeOptionMandatory()
+        .argParser(v => {
+        const name = v;
+        if ((0, utils_1.dataServiceNameIsValid)(name) === false) {
+            throw new commander_1.InvalidArgumentError(utils_1.BLUEPRINT_ERROR);
+        }
+        return name;
+    }))
         .addOption(new commander_1.Option('-r, --region <string>', 'Region for your blueprint to be deployed yo e.g. au')
         .choices(['au', 'uk', 'us'])
         .makeOptionMandatory())

package/lib/datastore/blueprint/add/add.spec.js

@@ -1,4 +1,27 @@
 "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) {
@@ -15,6 +38,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const nock_1 = __importDefault(require("nock"));
 const add_1 = __importDefault(require("./add"));
 const utils_1 = require("../../utils");
+const utils = __importStar(require("../../utils"));
 const logSpy = jest.spyOn(global.console, 'log');
 describe('datastoreBlueprintAdd', () => {
     process.env.ENABLE_OVERRIDE_DATASTORE_URL = 'true';
@@ -79,4 +103,32 @@ describe('datastoreBlueprintAdd', () => {
         expect(logSpy).toHaveBeenCalledWith('    Region: au');
         expect(logSpy).toHaveBeenCalledWith('');
     }));
+    it('errors on bad blueprint name', () => __awaiter(void 0, void 0, void 0, function* () {
+        const dataServiceNameIsValidSpy = jest
+            .spyOn(utils, 'dataServiceNameIsValid')
+            .mockReturnValue(false);
+        const program = (0, add_1.default)()
+            .exitOverride()
+            .action(() => { });
+        expect(() => {
+            program.parse([
+                'node',
+                'dxp-cli',
+                'datastore',
+                'blueprint',
+                'add',
+                '-t',
+                'myTenant',
+                '-p',
+                './src/__tests__/datastore/blueprints/blueprint.yaml',
+                '-n',
+                'myBlueprint',
+                '-r',
+                'au',
+                '-ou',
+                'http://localhost:9999',
+            ]);
+        }).toThrow("error: option '-n, --name <string>' argument 'myBlueprint' is invalid. Blueprint names can be a mix of letters, numbers, hyphen, underscore, brackets including square and up to 100 characters long");
+        expect(dataServiceNameIsValidSpy).toHaveBeenCalledTimes(1);
+    }));
 });

package/lib/datastore/blueprint/rename/rename.js

@@ -23,7 +23,15 @@ const createRenameCommand = () => {
         .description('Renames an existing blueprint')
         .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to run against. If not provided will use configured tenant from login'))
         .addOption(new commander_1.Option('-on, --oldName <string>', 'Old Name for your blueprint e.g. MyFirstBlueprint').makeOptionMandatory())
-        .addOption(new commander_1.Option('-nn, --newName <string>', 'New Name for your blueprint e.g. MyFirstBlueprint').makeOptionMandatory())
+        .addOption(new commander_1.Option('-nn, --newName <string>', 'New Name for your blueprint e.g. MyFirstBlueprint')
+        .makeOptionMandatory()
+        .argParser(v => {
+        const name = v;
+        if ((0, utils_1.dataServiceNameIsValid)(name) === false) {
+            throw new commander_1.InvalidArgumentError(utils_1.BLUEPRINT_ERROR);
+        }
+        return name;
+    }))
         .configureOutput({
         outputError(str, write) {
             write(chalk_1.default.red(str));

package/lib/datastore/blueprint/rename/rename.spec.js

@@ -1,4 +1,27 @@
 "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) {
@@ -15,6 +38,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const nock_1 = __importDefault(require("nock"));
 const rename_1 = __importDefault(require("./rename"));
 const utils_1 = require("../../utils");
+const utils = __importStar(require("../../utils"));
 const logSpy = jest.spyOn(global.console, 'log');
 describe('datastoreBlueprintRename', () => {
     process.env.ENABLE_OVERRIDE_DATASTORE_URL = 'true';
@@ -89,4 +113,30 @@ describe('datastoreBlueprintRename', () => {
         expect(logSpy).toHaveBeenCalledWith('');
         expect(logSpy).toHaveBeenCalledWith('');
     }));
+    it('errors on bad blueprint rename', () => __awaiter(void 0, void 0, void 0, function* () {
+        const dataServiceNameIsValidSpy = jest
+            .spyOn(utils, 'dataServiceNameIsValid')
+            .mockReturnValue(false);
+        const program = (0, rename_1.default)()
+            .exitOverride()
+            .action(() => { });
+        expect(() => {
+            program.parse([
+                'node',
+                'dxp-cli',
+                'datastore',
+                'blueprint',
+                'rename',
+                '-t',
+                'myTenant',
+                '-on',
+                'myBlueprint',
+                '-nn',
+                'myRenamedBlueprint',
+                '-ou',
+                'http://localhost:9999',
+            ]);
+        }).toThrow("error: option '-nn, --newName <string>' argument 'myRenamedBlueprint' is invalid. Blueprint names can be a mix of letters, numbers, hyphen, underscore, brackets including square and up to 100 characters long");
+        expect(dataServiceNameIsValidSpy).toHaveBeenCalledTimes(1);
+    }));
 });

package/lib/datastore/utils.d.ts

@@ -2,6 +2,7 @@ import { Command } from 'commander';
 import { ApiService } from '../ApiService';
 export declare const CONSOLE_STATUS_CODE_LIVE = "Live";
 export declare const CONSOLE_STATUS_CODE_ERROR = "Error";
+export declare const BLUEPRINT_ERROR = "Blueprint names can be a mix of letters, numbers, hyphen, underscore, brackets including square and up to 100 characters long";
 export declare function logDebug(message: string): void;
 export declare function bundleBlueprint(filePath: string, asYaml?: boolean): Promise<string>;
 export declare function handleCommandError(command: Command, error: Error): void;
@@ -16,3 +17,4 @@ export declare function buildOrganisationUrl(tenantID?: string, override?: strin
 export declare function buildInstanceUrl(tenantID?: string, instanceID?: string, override?: string, isDeploy?: boolean): Promise<string>;
 export declare function buildDatastoreInstancesUrl(tenantID?: string, override?: string): Promise<string>;
 export declare function checkDeploymentStatus(apiService: ApiService, tenantID?: string, instanceID?: string, override?: string): Promise<any>;
+export declare function dataServiceNameIsValid(name: string): boolean;

package/lib/datastore/utils.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkDeploymentStatus = exports.buildDatastoreInstancesUrl = exports.buildInstanceUrl = exports.buildOrganisationUrl = exports.buildDXPUrl = exports.validateAxiosStatus = exports.writeLineSeparator = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = exports.bundleBlueprint = exports.logDebug = exports.CONSOLE_STATUS_CODE_ERROR = exports.CONSOLE_STATUS_CODE_LIVE = void 0;
+exports.dataServiceNameIsValid = exports.checkDeploymentStatus = exports.buildDatastoreInstancesUrl = exports.buildInstanceUrl = exports.buildOrganisationUrl = exports.buildDXPUrl = exports.validateAxiosStatus = exports.writeLineSeparator = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = exports.bundleBlueprint = exports.logDebug = exports.BLUEPRINT_ERROR = exports.CONSOLE_STATUS_CODE_ERROR = exports.CONSOLE_STATUS_CODE_LIVE = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const chalk_1 = __importDefault(require("chalk"));
@@ -46,6 +46,7 @@ const swagger_parser_1 = __importDefault(require("@apidevtools/swagger-parser"))
 const YAML = __importStar(require("yaml"));
 exports.CONSOLE_STATUS_CODE_LIVE = 'Live';
 exports.CONSOLE_STATUS_CODE_ERROR = 'Error';
+exports.BLUEPRINT_ERROR = 'Blueprint names can be a mix of letters, numbers, hyphen, underscore, brackets including square and up to 100 characters long';
 /* istanbul ignore next */
 const sleep = (ms) => {
     return new Promise(resolve => setTimeout(resolve, ms));
@@ -227,3 +228,14 @@ function checkDeploymentStatus(apiService, tenantID, instanceID, override) {
     });
 }
 exports.checkDeploymentStatus = checkDeploymentStatus;
+function dataServiceNameIsValid(name) {
+    const regex = /^[A-Za-z0-9\-\_\(\)\[\]:]+$/;
+    const found = name.match(regex);
+    if (found == null || name.length >= 100) {
+        return false;
+    }
+    else {
+        return true;
+    }
+}
+exports.dataServiceNameIsValid = dataServiceNameIsValid;

package/lib/datastore/utils.spec.js

@@ -89,4 +89,25 @@ paths:
         const res = yield (0, utils_1.bundleBlueprint)(path_1.default.join('./src/__tests__/datastore/blueprints/blueprint.json'), false);
         expect(res).toStrictEqual('{"openapi":"3.0.2","info":{"description":"A Sample Test API","version":"1.0.0","title":"Unit Test"},"paths":{"/acl-dxp-authentication-1":{"get":{"x-datastore-acl":"public","responses":{"200":{"description":"OK"}}}}}}');
     }));
+    describe('dataServiceNameIsValid', () => {
+        it.each([
+            'blueprint',
+            'abcdefghijklmnopqrstuvwxyz',
+            'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+            '1234567890',
+            '-_():[]',
+        ])('validates blueprint name as valid (%s)', name => {
+            const result = (0, utils_1.dataServiceNameIsValid)(name);
+            expect(result).toStrictEqual(true);
+        });
+    });
+    it.each([
+        '',
+        'blue!',
+        '/print',
+        'reallylongoverlimitnamesssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss',
+    ])('validates blueprint name as invalid (%s)', name => {
+        const result = (0, utils_1.dataServiceNameIsValid)(name);
+        expect(result).toStrictEqual(false);
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.12.2-develop.1",
+  "version": "5.13.0-develop.2",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },