@squiz/dxp-cli-next 5.9.0-develop.32 → 5.9.0-develop.34

package/lib/__tests__/integration/main.spec.js

@@ -15,6 +15,7 @@ describe('dxp', () => {
             'auth           Authenticate into the DXP CLI',
             'cmp            Component Service Commands',
             'job-runner     Job Runner Service Commands',
+            'datastore      Datastore Commands',
         ]);
     });
 });

package/lib/datastore/blueprint/add/add.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const createAddCommand: () => Command;
+export default createAddCommand;

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

@@ -0,0 +1,109 @@
+"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 chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const ApiService_1 = require("../../../ApiService");
+const utils_1 = require("../../utils");
+const createAddCommand = () => {
+    const addCommand = new commander_1.Command('add')
+        .name('add')
+        .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('-r, --region <string>', 'Region for your blueprint to be deployed yo e.g. au')
+        .choices(['au', 'uk', 'us'])
+        .makeOptionMandatory())
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(addCommand);
+        console.log('');
+        const spinner = (0, ora_1.default)('Please wait (5 minutes) while our cloud builds this for you.').start();
+        let input;
+        try {
+            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            (0, utils_1.logDebug)('Checking blueprint limit');
+            // Check if we are at the blueprint limit.
+            const dxpTenantResp = yield apiService.client.get(yield (0, utils_1.buildOrganisationUrl)(options.tenant, options.overrideUrl));
+            (0, utils_1.logDebug)(`Blueprint limit response: ${JSON.stringify(dxpTenantResp.data)}`);
+            if (dxpTenantResp.data.numberOfDatastoreInstances &&
+                dxpTenantResp.data.numberOfDatastoreInstances + 1 >
+                    dxpTenantResp.data.maximumDatastoreInstances) {
+                let limitError = 'Sorry. You are currently limited to ';
+                limitError += `${dxpTenantResp.data.maximumDatastoreInstances} blueprint for this customer.`;
+                limitError += ' Please speak to your account owner to enable more';
+                if (dxpTenantResp.data.maximumDatastoreInstances > 1) {
+                    limitError = 'Sorry. You are currently limited to ';
+                    limitError += `${dxpTenantResp.data.maximumDatastoreInstances} blueprints for this customer.`;
+                    limitError += ' Please speak to your account owner to enable more.';
+                }
+                throw new Error(limitError);
+            }
+            // Bundle the blueprint.
+            input = yield (0, utils_1.bundleBlueprint)(options.path, true);
+            const blueprintFile = Buffer.from(input).toString('base64');
+            // Create the instance in the DXP console.
+            const datastoreInstanceReq = {
+                blueprintFile,
+                name: options.name,
+                region: options.region,
+                type: 'datastore',
+            };
+            (0, utils_1.logDebug)('Creating new blueprint');
+            const datastoreInstanceResp = yield apiService.client.post(yield (0, utils_1.buildInstanceUrl)(options.tenant, undefined, options.overrideUrl, false), datastoreInstanceReq);
+            (0, utils_1.logDebug)(`Creating blueprint instance: ${JSON.stringify(datastoreInstanceResp.data)}`);
+            if (datastoreInstanceResp.data.message) {
+                let errorMsg = '';
+                if (datastoreInstanceResp.data.message.startsWith('Error') &&
+                    datastoreInstanceResp.data.message.toLowerCase() ===
+                        'error: name is not unique') {
+                    errorMsg =
+                        'That blueprint name is already taken. Try renaming to something else.';
+                }
+                else {
+                    errorMsg = `Failed to add blueprint for "${options.name}" - "${options.path}".`;
+                }
+                throw new Error(errorMsg);
+            }
+            // Deploy the instance.
+            (0, utils_1.logDebug)('Starting deploy');
+            const deployResp = yield apiService.client.post(yield (0, utils_1.buildInstanceUrl)(options.tenant, datastoreInstanceResp.data.instanceId, options.overrideUrl, true));
+            (0, utils_1.logDebug)(`Deploying blueprint: ${JSON.stringify(deployResp.data)}`);
+            const createdInstance = yield (0, utils_1.checkDeploymentStatus)(apiService, options.tenant, datastoreInstanceResp.data.instanceId, options.overrideUrl);
+            spinner.succeed('Done! Use these details for production querying:');
+            console.log('');
+            console.log(`    URL: ${createdInstance.deploymentUrl}`);
+            console.log(`    Secret Key: ${createdInstance.secretKey}`);
+            console.log(`    Region: ${createdInstance.region}`);
+            console.log('');
+            return;
+        }
+        catch (error) {
+            (0, utils_1.logDebug)(`ERROR: ${JSON.stringify(error)}`);
+            spinner.fail();
+            (0, utils_1.handleCommandError)(addCommand, error);
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_DATASTORE_URL === 'true') {
+        addCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire DXP url with a custom value'));
+    }
+    return addCommand;
+};
+exports.default = createAddCommand;

package/lib/datastore/blueprint/add/add.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,82 @@
+"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 nock_1 = __importDefault(require("nock"));
+const add_1 = __importDefault(require("./add"));
+const utils_1 = require("../../utils");
+const logSpy = jest.spyOn(global.console, 'log');
+describe('listJobContexts', () => {
+    process.env.ENABLE_OVERRIDE_DATASTORE_URL = 'true';
+    it('correctly adds a blueprint', () => __awaiter(void 0, void 0, void 0, function* () {
+        (0, nock_1.default)('http://localhost:9999')
+            .get('/__dxp/au/dxp/tenants/myTenant')
+            .reply(200, {
+            numberOfDatastoreInstances: 1,
+            maximumDatastoreInstances: 2,
+        });
+        (0, nock_1.default)('http://localhost:9999')
+            .post('/__dxp/au/dxp/tenants/myTenant/instances', {
+            blueprintFile: /.+/i,
+            name: 'myBlueprint',
+            region: 'au',
+            type: 'datastore',
+        })
+            .reply(200, {
+            instanceId: 'mock-instance-id',
+        });
+        (0, nock_1.default)('http://localhost:9999')
+            .post('/__dxp/au/dxp/tenants/myTenant/instances/mock-instance-id/_deploy')
+            .reply(200, {
+            instanceId: 'mock-instance-id',
+        });
+        (0, nock_1.default)('http://localhost:9999')
+            .get('/__dxp/au/dxp/tenants/myTenant/instances/mock-instance-id')
+            .reply(200, {
+            status: {
+                code: utils_1.CONSOLE_STATUS_CODE_LIVE,
+            },
+            deploymentUrl: 'https://au-12345678.datastore.squiz.cloud',
+            secretKey: 'secretKey',
+            region: 'au',
+        });
+        const program = (0, add_1.default)();
+        yield program.parseAsync([
+            'node',
+            'dxp-cli',
+            'datastore',
+            'blueprint',
+            'add',
+            '-t',
+            'myTenant',
+            '-p',
+            './src/__tests__/datastore/blueprints/blueprint.yaml',
+            '-n',
+            'myBlueprint',
+            '-r',
+            'au',
+            '-ou',
+            'http://localhost:9999',
+        ]);
+        const opts = program.opts();
+        expect(opts.tenant).toEqual('myTenant');
+        expect(opts.overrideUrl).toEqual('http://localhost:9999');
+        expect(logSpy).toHaveBeenCalledTimes(6);
+        expect(logSpy).toHaveBeenCalledWith('');
+        expect(logSpy).toHaveBeenCalledWith('');
+        expect(logSpy).toHaveBeenCalledWith('    URL: https://au-12345678.datastore.squiz.cloud');
+        expect(logSpy).toHaveBeenCalledWith('    Secret Key: secretKey');
+        expect(logSpy).toHaveBeenCalledWith('    Region: au');
+        expect(logSpy).toHaveBeenCalledWith('');
+    }));
+});

package/lib/datastore/blueprint/blueprintCommand.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const createBlueprintCommand: () => Command;
+export default createBlueprintCommand;

package/lib/datastore/blueprint/blueprintCommand.js

@@ -0,0 +1,17 @@
+"use strict";
+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 add_1 = __importDefault(require("./add/add"));
+const update_1 = __importDefault(require("./update/update"));
+const createBlueprintCommand = () => {
+    const datastoreBlueprintCommand = new commander_1.Command('blueprint');
+    datastoreBlueprintCommand
+        .description('Datastore Blueprint Commands')
+        .addCommand((0, add_1.default)())
+        .addCommand((0, update_1.default)());
+    return datastoreBlueprintCommand;
+};
+exports.default = createBlueprintCommand;

package/lib/datastore/blueprint/update/update.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const createUpdateCommand: () => Command;
+export default createUpdateCommand;

package/lib/datastore/blueprint/update/update.js

@@ -0,0 +1,87 @@
+"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 chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const ApiService_1 = require("../../../ApiService");
+const utils_1 = require("../../utils");
+const createUpdateCommand = () => {
+    const updateCommand = new commander_1.Command('update')
+        .name('update')
+        .description('Updates 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('-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())
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(updateCommand);
+        console.log('');
+        const spinner = (0, ora_1.default)('Please wait (5 minutes) while our cloud builds this for you.').start();
+        let input;
+        try {
+            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            (0, utils_1.logDebug)('Checking current blueprints');
+            // Check if we are at the blueprint limit.
+            const datastoreInstancesResp = yield apiService.client.get(yield (0, utils_1.buildDatastoreInstancesUrl)(options.tenant, options.overrideUrl));
+            (0, utils_1.logDebug)(`Finding blueprint with name: ${options.name}`);
+            const datastoreInstances = datastoreInstancesResp.data.filter((instance) => {
+                return instance.name === options.name;
+            });
+            if (datastoreInstances.length !== 1) {
+                throw new Error('Unexpected error. Ask for help in our support forums.');
+            }
+            const datastoreInstance = datastoreInstances[0];
+            // Bundle the blueprint.
+            input = yield (0, utils_1.bundleBlueprint)(options.path, true);
+            const blueprintFile = Buffer.from(input).toString('base64');
+            const datastoreInstanceReq = {
+                blueprintFile,
+                status: {
+                    code: 'Deploying',
+                    message: 'Instance is deploying',
+                },
+            };
+            (0, utils_1.logDebug)(`Updating blueprint: ${options.name}`);
+            const datastoreInstanceResp = yield apiService.client.patch(yield (0, utils_1.buildInstanceUrl)(options.tenant, datastoreInstance.instanceId, options.overrideUrl, false), datastoreInstanceReq);
+            (0, utils_1.logDebug)(`Updating blueprint instance: ${JSON.stringify(datastoreInstanceResp.data)}`);
+            // Deploy the instance.
+            (0, utils_1.logDebug)('Starting deploy');
+            const deployResp = yield apiService.client.post(yield (0, utils_1.buildInstanceUrl)(options.tenant, datastoreInstance.instanceId, options.overrideUrl, true), datastoreInstanceReq);
+            (0, utils_1.logDebug)(`Deploying blueprint: ${JSON.stringify(deployResp.data)}`);
+            const updatedInstance = yield (0, utils_1.checkDeploymentStatus)(apiService, options.tenant, datastoreInstance.instanceId, options.overrideUrl);
+            spinner.succeed('Done! Use these details for production querying:');
+            console.log('');
+            console.log(`    URL: ${updatedInstance.deploymentUrl}`);
+            console.log(`    Secret Key: ${updatedInstance.secretKey}`);
+            console.log(`    Region: ${updatedInstance.region}`);
+            console.log('');
+            return;
+        }
+        catch (error) {
+            (0, utils_1.logDebug)(`ERROR: ${JSON.stringify(error)}`);
+            spinner.fail();
+            (0, utils_1.handleCommandError)(updateCommand, error);
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_DATASTORE_URL === 'true') {
+        updateCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire DXP url with a custom value'));
+    }
+    return updateCommand;
+};
+exports.default = createUpdateCommand;

package/lib/datastore/blueprint/update/update.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,99 @@
+"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 nock_1 = __importDefault(require("nock"));
+const update_1 = __importDefault(require("./update"));
+const utils_1 = require("../../utils");
+const logSpy = jest.spyOn(global.console, 'log');
+describe('listJobContexts', () => {
+    process.env.ENABLE_OVERRIDE_DATASTORE_URL = 'true';
+    it('correctly adds a blueprint', () => __awaiter(void 0, void 0, void 0, function* () {
+        (0, nock_1.default)('http://localhost:9999')
+            .get('/__dxp/au/dxp/tenants/myTenant/instances?type=datastore')
+            .reply(200, [
+            {
+                status: {
+                    code: utils_1.CONSOLE_STATUS_CODE_LIVE,
+                },
+                deploymentUrl: 'https://au-asdfghj.datastore.squiz.cloud',
+                secretKey: 'secretKey',
+                region: 'au',
+                name: 'secondBlueprint',
+                instanceId: '1234',
+            },
+            {
+                status: {
+                    code: utils_1.CONSOLE_STATUS_CODE_LIVE,
+                },
+                deploymentUrl: 'https://au-12345678.datastore.squiz.cloud',
+                secretKey: 'secretKey',
+                region: 'au',
+                name: 'myBlueprint',
+                instanceId: 'mock-instance-id',
+            },
+        ]);
+        (0, nock_1.default)('http://localhost:9999')
+            .patch('/__dxp/au/dxp/tenants/myTenant/instances/mock-instance-id', {
+            blueprintFile: /.+/i,
+            status: {
+                code: 'Deploying',
+                message: 'Instance is deploying',
+            },
+        })
+            .reply(200, {
+            instanceId: 'mock-instance-id',
+        });
+        (0, nock_1.default)('http://localhost:9999')
+            .post('/__dxp/au/dxp/tenants/myTenant/instances/mock-instance-id/_deploy')
+            .reply(200, {
+            instanceId: 'mock-instance-id',
+        });
+        (0, nock_1.default)('http://localhost:9999')
+            .get('/__dxp/au/dxp/tenants/myTenant/instances/mock-instance-id')
+            .reply(200, {
+            status: {
+                code: utils_1.CONSOLE_STATUS_CODE_LIVE,
+            },
+            deploymentUrl: 'https://au-12345678.datastore.squiz.cloud',
+            secretKey: 'secretKey',
+            region: 'au',
+        });
+        const program = (0, update_1.default)();
+        yield program.parseAsync([
+            'node',
+            'dxp-cli',
+            'datastore',
+            'blueprint',
+            'update',
+            '-t',
+            'myTenant',
+            '-p',
+            './src/__tests__/datastore/blueprints/blueprint.yaml',
+            '-n',
+            'myBlueprint',
+            '-ou',
+            'http://localhost:9999',
+        ]);
+        const opts = program.opts();
+        expect(opts.tenant).toEqual('myTenant');
+        expect(opts.overrideUrl).toEqual('http://localhost:9999');
+        expect(logSpy).toHaveBeenCalledTimes(6);
+        expect(logSpy).toHaveBeenCalledWith('');
+        expect(logSpy).toHaveBeenCalledWith('');
+        expect(logSpy).toHaveBeenCalledWith('    URL: https://au-12345678.datastore.squiz.cloud');
+        expect(logSpy).toHaveBeenCalledWith('    Secret Key: secretKey');
+        expect(logSpy).toHaveBeenCalledWith('    Region: au');
+        expect(logSpy).toHaveBeenCalledWith('');
+    }));
+});

package/lib/datastore/index.d.ts

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

package/lib/datastore/index.js

@@ -0,0 +1,12 @@
+"use strict";
+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 blueprintCommand_1 = __importDefault(require("./blueprint/blueprintCommand"));
+const datastoreCommand = new commander_1.Command('datastore');
+datastoreCommand
+    .description('Datastore Commands')
+    .addCommand((0, blueprintCommand_1.default)());
+exports.default = datastoreCommand;

package/lib/datastore/utils.d.ts

@@ -0,0 +1,18 @@
+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 function logDebug(message: string): void;
+export declare function bundleBlueprint(filePath: string, asYaml?: boolean): Promise<string>;
+export declare function handleCommandError(command: Command, error: Error): void;
+export declare function throwErrorIfNotLoggedIn(command: Command): Promise<void>;
+export declare function writeLineSeparator(): void;
+export declare function validateAxiosStatus(status: number): boolean;
+export declare function buildDXPUrl(tenantID?: string, override?: string): Promise<{
+    dxpUrl: string;
+    tenant: string | undefined;
+}>;
+export declare function buildOrganisationUrl(tenantID?: string, override?: string): Promise<string>;
+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>;

package/lib/datastore/utils.js

@@ -0,0 +1,229 @@
+"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 });
+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;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const chalk_1 = __importDefault(require("chalk"));
+const ApplicationConfig_1 = require("../ApplicationConfig");
+const axios_1 = __importDefault(require("axios"));
+const ApplicationStore_1 = require("../ApplicationStore");
+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';
+/* istanbul ignore next */
+const sleep = (ms) => {
+    return new Promise(resolve => setTimeout(resolve, ms));
+};
+/* istanbul ignore next */
+function logDebug(message) {
+    if (!!process.env.DEBUG) {
+        console.log(message);
+    }
+}
+exports.logDebug = logDebug;
+function bundleBlueprint(filePath, asYaml = true) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const inputPath = path_1.default.resolve(filePath);
+        let bundle;
+        if (fs_1.default.existsSync(inputPath)) {
+            try {
+                logDebug(`Bundling ${inputPath}`);
+                bundle = yield swagger_parser_1.default.dereference(inputPath, {
+                    dereference: {
+                        circular: 'ignore',
+                    },
+                    parse: {
+                        json: {
+                            order: 2,
+                        },
+                        yaml: {
+                            order: 1,
+                        },
+                    },
+                    resolve: {
+                        external: true,
+                        file: {
+                            canRead: true,
+                            order: 1,
+                        },
+                        http: {
+                            canRead: true,
+                            order: 1,
+                        },
+                    },
+                    validate: {
+                        spec: true,
+                    },
+                });
+                if (asYaml) {
+                    bundle = YAML.stringify(bundle);
+                }
+                else {
+                    bundle = JSON.stringify(bundle);
+                }
+                return bundle;
+            }
+            catch (e) {
+                throw new Error(`Unable to read file ${inputPath} - ${e.message}`);
+            }
+        }
+        else {
+            throw new Error('Input could not be found');
+        }
+    });
+}
+exports.bundleBlueprint = bundleBlueprint;
+function handleCommandError(command, error) {
+    var _a, _b, _c, _d;
+    if (axios_1.default.isAxiosError(error)) {
+        let message = `${error.message}`;
+        if ((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) {
+            message += `: ${error.response.data.message}`;
+        }
+        if ((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.details) {
+            message += ` - ${error.response.data.details}`;
+        }
+        command.error(chalk_1.default.red(message));
+    }
+    else {
+        if (!!process.env.DEBUG && error.stack) {
+            command.error(error.stack);
+        }
+        if (error.message) {
+            command.error(chalk_1.default.red(error.message));
+        }
+        else {
+            command.error(chalk_1.default.red('An unknown error occurred'));
+        }
+    }
+}
+exports.handleCommandError = handleCommandError;
+function throwErrorIfNotLoggedIn(command) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!(yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie))) {
+            command.error(chalk_1.default.red('You must login to interact with the job runner. See `dxp-next auth login`'));
+        }
+    });
+}
+exports.throwErrorIfNotLoggedIn = throwErrorIfNotLoggedIn;
+function writeLineSeparator() {
+    console.log(chalk_1.default.cyan('------------------------------'));
+}
+exports.writeLineSeparator = writeLineSeparator;
+function validateAxiosStatus(status) {
+    return status < 400;
+}
+exports.validateAxiosStatus = validateAxiosStatus;
+function buildDXPUrl(tenantID, override) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!override) {
+            const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)(tenantID);
+            logDebug(`existingConfig: ${JSON.stringify(existingConfig)}`);
+            return {
+                dxpUrl: `${existingConfig.baseUrl}/__dxp/${existingConfig.region}/dxp`,
+                tenant: existingConfig.tenant,
+            };
+        }
+        else {
+            logDebug(`Using override URL: ${override}`);
+            return {
+                dxpUrl: `${override}/__dxp/au/dxp`,
+                tenant: tenantID,
+            };
+        }
+    });
+}
+exports.buildDXPUrl = buildDXPUrl;
+function buildOrganisationUrl(tenantID, override) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const dxpUrlConfig = yield buildDXPUrl(tenantID, override);
+        return `${dxpUrlConfig.dxpUrl}/tenants/${dxpUrlConfig.tenant}`;
+    });
+}
+exports.buildOrganisationUrl = buildOrganisationUrl;
+function buildInstanceUrl(tenantID, instanceID, override, isDeploy = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const dxpUrlConfig = yield buildDXPUrl(tenantID, override);
+        const base = `${dxpUrlConfig.dxpUrl}/tenants/${dxpUrlConfig.tenant}`;
+        if (isDeploy) {
+            return `${base}/instances/${instanceID}/_deploy`;
+        }
+        return instanceID ? `${base}/instances/${instanceID}` : `${base}/instances`;
+    });
+}
+exports.buildInstanceUrl = buildInstanceUrl;
+function buildDatastoreInstancesUrl(tenantID, override) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = yield buildInstanceUrl(tenantID, undefined, override, false);
+        return `${url}?type=datastore`;
+    });
+}
+exports.buildDatastoreInstancesUrl = buildDatastoreInstancesUrl;
+function checkDeploymentStatus(apiService, tenantID, instanceID, override) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let lastPollStatus = '';
+        let lastPollTime = 0;
+        let pollTimeout = false;
+        let datastoreInstanceResp;
+        let datastoreInstance;
+        do {
+            datastoreInstanceResp = yield apiService.client.get(yield buildInstanceUrl(tenantID, instanceID, override, false));
+            datastoreInstance = datastoreInstanceResp.data;
+            const nowAt = Math.floor(Date.now() / 1000);
+            if (lastPollStatus !== datastoreInstance.status.message) {
+                lastPollStatus = datastoreInstance.status.message;
+                lastPollTime = nowAt;
+            }
+            else if (nowAt - lastPollTime > 600 &&
+                lastPollStatus === datastoreInstance.status.message) {
+                pollTimeout = true;
+            }
+            yield sleep(3000);
+        } while (datastoreInstance.status.code !== exports.CONSOLE_STATUS_CODE_LIVE &&
+            datastoreInstance.status.code !== exports.CONSOLE_STATUS_CODE_ERROR &&
+            !pollTimeout);
+        if (datastoreInstance.status.code === exports.CONSOLE_STATUS_CODE_LIVE) {
+            return datastoreInstance;
+        }
+        else {
+            throw new Error(datastoreInstance.status.message);
+        }
+    });
+}
+exports.checkDeploymentStatus = checkDeploymentStatus;

package/lib/datastore/utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/datastore/utils.spec.js

@@ -0,0 +1,92 @@
+"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 utils_1 = require("./utils");
+const commander_1 = require("commander");
+const axios_1 = require("axios");
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+const exitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {
+    return undefined;
+}); // prevent process exit on error
+const stderrSpy = jest.spyOn(process.stderr, 'write');
+const logSpy = jest.spyOn(global.console, 'log');
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+describe('handleCommandError', () => {
+    it('correctly displays the console logs for command error', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        (0, utils_1.handleCommandError)(command, new Error(message));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        console.log(stderrSpy.mock.calls);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(message);
+    }));
+    it('correctly displays the console logs for axios error', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        const responseMessage = 'I am an error response';
+        const errDetails = 'i am error details';
+        (0, utils_1.handleCommandError)(command, new axios_1.AxiosError(message, '500', undefined, undefined, {
+            data: { message: responseMessage, details: errDetails },
+        }));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(`${message}: ${responseMessage} - ${errDetails}`);
+    }));
+    it('correctly displays the console logs for error without a message', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        (0, utils_1.handleCommandError)(command, new Error());
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain('An unknown error occurred');
+    }));
+});
+describe('writeLineSeparator', () => {
+    it('correctly displays the console logs for line separator', () => __awaiter(void 0, void 0, void 0, function* () {
+        (0, utils_1.writeLineSeparator)();
+        expect(logSpy).toHaveBeenCalledTimes(1);
+        expect(logSpy).toHaveBeenCalledWith(chalk_1.default.cyan('------------------------------'));
+    }));
+});
+describe('validateAxiosStatus', () => {
+    it('correctly validates the status', () => __awaiter(void 0, void 0, void 0, function* () {
+        expect((0, utils_1.validateAxiosStatus)(200)).toBe(true);
+        expect((0, utils_1.validateAxiosStatus)(400)).toBe(false);
+    }));
+});
+describe('bundleBlueprint', () => {
+    it('should return a YAML string', () => __awaiter(void 0, void 0, void 0, function* () {
+        const res = yield (0, utils_1.bundleBlueprint)(path_1.default.join('./src/__tests__/datastore/blueprints/blueprint.yaml'));
+        expect(res).toEqual(`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
+`);
+    }));
+    it('should return a JSON string', () => __awaiter(void 0, void 0, void 0, function* () {
+        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"}}}}}}');
+    }));
+});

package/lib/dxp.js

@@ -14,6 +14,7 @@ validateNodeVersion();
 const auth_1 = __importDefault(require("./auth"));
 const cmp_1 = __importDefault(require("./cmp"));
 const job_runner_1 = __importDefault(require("./job-runner"));
+const datastore_1 = __importDefault(require("./datastore"));
 const program = new commander_1.default.Command();
 const packageJson = require('../package.json');
 const version = packageJson.version;
@@ -24,6 +25,7 @@ program
     .addCommand(auth_1.default)
     .addCommand(cmp_1.default)
     .addCommand(job_runner_1.default)
+    .addCommand(datastore_1.default)
     .action(() => {
     program.help();
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.9.0-develop.32",
+  "version": "5.9.0-develop.34",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },
@@ -39,7 +39,8 @@
     "codecov"
   ],
   "dependencies": {
-    "@squiz/component-cli-lib": "1.60.0",
+    "@squiz/component-cli-lib": "1.60.1-alpha.1",
+    "@apidevtools/swagger-parser": "10.1.0",
     "axios": "1.1.3",
     "cli-color": "2.0.3",
     "commander": "9.4.0",
@@ -49,7 +50,8 @@
     "ora": "^5.4.1",
     "prompt": "^1.3.0",
     "tough-cookie": "4.1.2",
-    "update-notifier": "5.1.0"
+    "update-notifier": "5.1.0",
+    "yaml": "^2.3.4"
   },
   "devDependencies": {
     "@semantic-release/git": "10.0.1",