@squiz/dxp-cli-next 5.23.0 → 5.23.1-develop.2

package/lib/ApiService.d.ts

@@ -1,5 +1,10 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 export declare const COOKIE_KEY = "dxp-sessionid";
+interface ApiServiceParameters {
+    validateStatus?: (status: number) => boolean;
+    baseUrl?: string;
+    tenantId?: string;
+}
 /**
  * ApiService provides HTTP access to the DXP systems.
  * This class wraps the authorization model within the DXP system by seamlessly
@@ -7,7 +12,7 @@ export declare const COOKIE_KEY = "dxp-sessionid";
  */
 export declare class ApiService {
     client: AxiosInstance;
-    constructor(validateStatus?: (status: number) => boolean, baseUrl?: string);
+    constructor({ validateStatus, baseUrl, tenantId, }?: ApiServiceParameters);
 }
 /**
  * The API Service requestInterceptor will load the session cookie from
@@ -31,3 +36,4 @@ export declare class InvalidLoginSessionError extends Error {
 export declare class InvalidTenantError extends Error {
     constructor();
 }
+export {};

package/lib/ApiService.js

@@ -23,10 +23,13 @@ exports.COOKIE_KEY = 'dxp-sessionid';
  * adding the session cookie to requests.
  */
 class ApiService {
-    constructor(validateStatus, baseUrl) {
+    constructor({ validateStatus, baseUrl, tenantId = process.env.SQUIZ_DXP_TENANT_ID, } = {}) {
         this.client = axios_1.default.create({
             validateStatus: validateStatus,
             baseURL: baseUrl,
+            headers: {
+                'x-dxp-tenant': tenantId,
+            },
         });
         this.client.interceptors.request.use(requestInterceptor);
         this.client.interceptors.response.use(responseInterceptor);
@@ -42,10 +45,17 @@ function requestInterceptor(request) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const additionalHeaders = {};
-        const maybeSessionCookie = yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie);
-        if (maybeSessionCookie) {
-            additionalHeaders.cookie =
-                (_a = tough_cookie_1.Cookie.fromJSON(maybeSessionCookie)) === null || _a === void 0 ? void 0 : _a.cookieString();
+        // Support usage of API Keys generated from API Key Service
+        // @see - https://squizgroup.atlassian.net/wiki/spaces/PRODUCT/pages/2915959855/API+Key+Service+details
+        if (process.env.SQUIZ_DXP_API_TOKEN) {
+            additionalHeaders['x-api-key'] = process.env.SQUIZ_DXP_API_TOKEN;
+        }
+        else {
+            const maybeSessionCookie = yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie);
+            if (maybeSessionCookie) {
+                additionalHeaders.cookie =
+                    (_a = tough_cookie_1.Cookie.fromJSON(maybeSessionCookie)) === null || _a === void 0 ? void 0 : _a.cookieString();
+            }
         }
         if (process.env.DXP_JWT) {
             additionalHeaders.authorization = `Bearer ${process.env.DXP_JWT}`;

package/lib/ApiService.spec.js

@@ -20,6 +20,8 @@ describe('ApiService', () => {
     describe('requestInterceptor', () => {
         beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
             delete process.env.DXP_JWT;
+            delete process.env.SQUIZ_DXP_API_TOKEN;
+            delete process.env.SQUIZ_DXP_TENANT_ID;
             yield (0, ApplicationStore_1.deleteApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie);
         }));
         it('loads stored session cookie into request config', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -47,6 +49,15 @@ describe('ApiService', () => {
                 },
             });
         }));
+        it('uses the SQUIZ_DXP_API_TOKEN variable instead of session if provided', () => __awaiter(void 0, void 0, void 0, function* () {
+            process.env.SQUIZ_DXP_API_TOKEN = '123';
+            yield (0, ApplicationStore_1.saveApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie, JSON.stringify(VALID_COOKIE.toJSON()));
+            yield expect((0, ApiService_1.requestInterceptor)({})).resolves.toMatchObject({
+                headers: {
+                    'x-api-key': '123',
+                },
+            });
+        }));
     });
     describe('responseInterceptor', () => {
         beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {

package/lib/auth/login/login.js

@@ -43,15 +43,15 @@ const ApplicationStore_1 = require("../../ApplicationStore");
 const opener_1 = __importDefault(require("opener"));
 const ora_1 = __importDefault(require("ora"));
 const crypto_1 = require("crypto");
-const PRODUCTION_URL = 'https://dxp.squiz.cloud';
+const constants_1 = require("../../constants");
 const AUTH_TIMEOUT = 300000;
 const createLoginCommand = () => {
     const loginCommand = new commander_1.Command('login')
         .name('login')
         .description('Login to the DXP platform')
-        .addOption(new commander_1.Option('--dxp-base-url <baseURL>', 'dxp cloud base url e.g. "https://develop-apps-dxp-console.dev.dxp.squiz.cloud/"')
+        .addOption(new commander_1.Option('--dxp-base-url <baseURL>', 'DXP Console URL')
         .env('DXP_BASE_URL')
-        .default(PRODUCTION_URL))
+        .default(constants_1.PRODUCTION_URL))
         .addOption(new commander_1.Option('--region <region>').choices(['au']).default('au'))
         .addOption(new commander_1.Option('--override-session', 'Override the existing authorized session if it exists'))
         .addOption(new commander_1.Option('--tenant <tenantID>'))

package/lib/cdp/schema/deploy/deploy.js

@@ -58,8 +58,10 @@ const createDeployCommand = () => {
         console.log('');
         const spinner = (0, ora_1.default)('Please wait a few minutes while our cloud builds this for you.').start();
         try {
-            const apiService = new ApiService_1.ApiService((status) => {
-                return status < 400;
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: (status) => {
+                    return status < 400;
+                },
             });
             const scvDeployBaseUrl = yield (0, utils_1.buildDXPUrl)(constants_1.SCV_DEPLOY_SERVICE_NAME, options.tenant, options.overrideUrl, options.region);
             const schemaFilePath = path_1.default.resolve(process.cwd(), options.path);

package/lib/cmp/deploy.js

@@ -39,30 +39,33 @@ const commander_1 = require("commander");
 const component_cli_lib_1 = require("@squiz/component-cli-lib");
 const cli_color_1 = __importDefault(require("cli-color"));
 const ApiService_1 = require("../ApiService");
-const ApplicationStore_1 = require("../ApplicationStore");
 const ApplicationConfig_1 = require("../ApplicationConfig");
 const definitions_1 = require("./utils/definitions");
 const fs = __importStar(require("node:fs/promises"));
 const path = __importStar(require("node:path"));
+const constants_1 = require("../constants");
 const deployCommand = new commander_1.Command()
     .name('deploy')
     .argument('<source>', 'folder containing a manifest.json file')
-    .addOption(new commander_1.Option('-cu, --component-service-url <string>', 'Override the component service url from login').env('COMPONENT_SERVICE_URL'))
-    .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to deploy to. If not provided will use configured tenant from login'))
+    .addOption(new commander_1.Option('-cu, --component-service-url <string>', 'Override the component service url from login')
+    .env('COMPONENT_SERVICE_URL')
+    .argParser(s => s.replace(/v1\/?$/, ''))
+    .hideHelp(true))
+    .addOption(new commander_1.Option('--dxp-base-url <baseURL>', 'DXP Console URL').env('DXP_BASE_URL'))
+    .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to deploy to. If not provided will use configured tenant from login').env('SQUIZ_DXP_TENANT_ID'))
     .addOption(new commander_1.Option('--dry-run', 'Run all pre-deployment processes without deploying').default(false))
     .action((source, options) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
-    if (process.env.COMPONENT_SERVICE_URL !== undefined) {
-        console.log(`NOTICE: COMPONENT_SERVICE_URL is set and will deploy to ${process.env.COMPONENT_SERVICE_URL}`);
-    }
-    if (!options.componentServiceUrl &&
-        !(yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie))) {
-        deployCommand.error(cli_color_1.default.red('You must login to deploy components. See `dxp-next auth login`'));
-    }
-    const apiService = new ApiService_1.ApiService();
-    if ((_a = options.componentServiceUrl) === null || _a === void 0 ? void 0 : _a.match(/v1\/?$/)) {
-        console.warn(cli_color_1.default.yellow('WARN: Component service URL no longer requires /v1/ suffix'));
+    var _a, _b, _c, _d;
+    if (options.componentServiceUrl) {
+        console.log(`NOTICE: COMPONENT_SERVICE_URL is set and will deploy to ${options.componentServiceUrl}`);
     }
+    const maybeConfig = yield maybeGetApplicationConfig();
+    const baseUrl = (_b = (_a = options.dxpBaseUrl) !== null && _a !== void 0 ? _a : maybeConfig === null || maybeConfig === void 0 ? void 0 : maybeConfig.baseUrl) !== null && _b !== void 0 ? _b : constants_1.PRODUCTION_URL;
+    const apiService = new ApiService_1.ApiService({
+        baseUrl,
+        tenantId: (_c = options.tenant) !== null && _c !== void 0 ? _c : maybeConfig === null || maybeConfig === void 0 ? void 0 : maybeConfig.tenant,
+    });
+    const componentServiceUrl = (_d = options.componentServiceUrl) !== null && _d !== void 0 ? _d : new URL('/__dxp/service/components-management', baseUrl).toString();
     const dxpCacheDirPath = path.resolve(source, '../.dxp');
     try {
         yield fs.mkdir(dxpCacheDirPath, { recursive: true });
@@ -71,8 +74,6 @@ const deployCommand = new commander_1.Command()
         if (!def) {
             throw new Error('Failed to load component for deployment');
         }
-        const componentServiceUrl = ((_b = options.componentServiceUrl) === null || _b === void 0 ? void 0 : _b.replace(/v1\/?$/, '')) ||
-            (yield buildComponentServiceUrl(options.tenant));
         if (def.type === 'server') {
             console.info(cli_color_1.default.yellow('INFO: Edge components are a new way to develop your component code offering a more stable runtime implementation of the DXP Component Service. Documentation outlining the benefits of Edge components along with Edge component development & migration guidelines can be found in DXP Component Service documentation: at https://docs.squiz.net/component-service/latest/tutorials/components-at-edge/index.html .'));
             yield definitions_1.ComponentPreUpload.forServer(def, outputDir);
@@ -113,9 +114,11 @@ const deployCommand = new commander_1.Command()
     return fs.rm(dxpCacheDirPath, { recursive: true });
 }));
 exports.default = deployCommand;
-function buildComponentServiceUrl(tenantID) {
+function maybeGetApplicationConfig() {
     return __awaiter(this, void 0, void 0, function* () {
-        const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)(tenantID);
-        return `${existingConfig.baseUrl}/__dxp/${existingConfig.region}/components-management/${existingConfig.tenant}`;
+        try {
+            return yield (0, ApplicationConfig_1.fetchApplicationConfig)();
+        }
+        catch (_a) { }
     });
 }

package/lib/constants.d.ts

@@ -0,0 +1 @@
+export declare const PRODUCTION_URL = "https://dxp.squiz.cloud";

package/lib/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRODUCTION_URL = void 0;
+exports.PRODUCTION_URL = 'https://dxp.squiz.cloud';

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

@@ -46,7 +46,9 @@ const createAddCommand = () => {
         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);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: 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));

package/lib/datastore/blueprint/list/list.js

@@ -33,7 +33,9 @@ const createListCommand = () => {
         const spinner = (0, ora_1.default)('Gathering details for all cloud blueprints.').start();
         let input;
         try {
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+            });
             (0, utils_1.logDebug)('Checking blueprint limit');
             const datastoreInstanceResp = yield apiService.client.get(yield (0, utils_1.buildDatastoreInstancesUrl)(options.tenant, options.overrideUrl));
             (0, utils_1.logDebug)(`Listing blueprint instance: ${JSON.stringify(datastoreInstanceResp.data)}`);

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

@@ -44,7 +44,9 @@ const createRenameCommand = () => {
         let input;
         const organisationId = null;
         try {
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: 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));

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

@@ -35,7 +35,9 @@ const createUpdateCommand = () => {
         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);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: 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));

package/lib/datastore/bundle/bundle.js

@@ -85,7 +85,9 @@ const createBundleCommand = () => {
                     allowedExtensions.join(', ');
                 throw new Error(errorMsg);
             }
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+            });
             let datastoreInstance;
             if (options.name) {
                 (0, utils_1.logDebug)('Checking current blueprints');

package/lib/datastore/simulator/upgrade/upgrade.js

@@ -23,7 +23,7 @@ const ApiService_1 = require("../../../ApiService");
 function getCurrentLatest() {
     return __awaiter(this, void 0, void 0, function* () {
         const dockerAPI = 'https://registry.hub.docker.com/v2/repositories/squizdxp/datastore/tags/latest';
-        const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+        const apiService = new ApiService_1.ApiService({ validateStatus: utils_1.validateAxiosStatus });
         apiService.client.interceptors.request.clear();
         apiService.client.interceptors.response.clear();
         const dockerFetch = yield apiService.client.get(dockerAPI);

package/lib/datastore/simulator/utils.js

@@ -140,7 +140,9 @@ const checkUpdateAvailable = () => __awaiter(void 0, void 0, void 0, function* (
             refreshVersionCache = true;
         }
         if (refreshVersionCache === true) {
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+            });
             apiService.client.interceptors.request.clear();
             apiService.client.interceptors.response.clear();
             const dockerFetch = yield apiService.client.get(dockerAPI);

package/lib/job-runner/job/listJobs/listJobs.js

@@ -34,7 +34,9 @@ const createListJobsCommand = () => {
         yield (0, utils_1.throwErrorIfNotLoggedIn)(listJobsCommand);
         const spinner = (0, ora_1.default)('Retrieving jobs').start();
         try {
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+            });
             let listJobsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/job/latest?`;
             listJobsUrl = (0, utils_1.addPaginationToUrl)(listJobsUrl, {
                 before: options.before,

package/lib/job-runner/job/listJobs/listJobs.spec.js

@@ -14,12 +14,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const nock_1 = __importDefault(require("nock"));
 const listJobs_1 = __importDefault(require("./listJobs"));
-const logSpy = jest.spyOn(global.console, 'log');
 describe('listJobs', () => {
     it('correctly lists the job', () => __awaiter(void 0, void 0, void 0, function* () {
         process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL = 'true';
         (0, nock_1.default)('http://localhost:9999')
-            .get('/job/latest?&page[size]=5')
+            .get('/job/latest?&page%5Bsize%5D=5')
             .reply(200, [{ name: 'simple-job', type: 'job', version: '1.0.0' }]);
         const program = (0, listJobs_1.default)();
         yield program.parseAsync([

package/lib/job-runner/job/uploadJob/uploadJob.js

@@ -33,7 +33,10 @@ const createUploadJobCommand = () => {
         yield (0, utils_1.throwErrorIfNotLoggedIn)(uploadJobCommand);
         const spinner = (0, ora_1.default)('Uploading job ').start();
         try {
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl));
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+                baseUrl: yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl),
+            });
             yield (0, component_cli_lib_1.uploadJobFolder)(apiService.client, inputSource);
             spinner.succeed();
             return;

package/lib/job-runner/jobContext/listJobContexts.js

@@ -34,7 +34,9 @@ const createListJobContextsCommand = () => {
         yield (0, utils_1.throwErrorIfNotLoggedIn)(listJobContextsCommand);
         const spinner = (0, ora_1.default)('Retrieving job contexts\r\n').start();
         try {
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+            });
             let listJobContextsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/job-context?`;
             listJobContextsUrl = (0, utils_1.addPaginationToUrl)(listJobContextsUrl, {
                 before: options.before,
@@ -42,16 +44,9 @@ const createListJobContextsCommand = () => {
                 size: options.size,
             });
             const res = yield apiService.client.get(listJobContextsUrl);
-            if (Array.isArray(res.data) && res.data.length > 0) {
-                spinner.succeed(`${res.data.length} contexts successfully retrieved`);
-                (0, utils_1.writeLineSeparator)();
-                res.data.forEach((context) => {
-                    console.log(`${chalk_1.default.green(chalk_1.default.bold(context.contextName))}: ${chalk_1.default.green(context.description)}`);
-                    for (const [key, value] of Object.entries(context.environment)) {
-                        console.log(`${chalk_1.default.bold(key)}: ${JSON.stringify(value)}`);
-                    }
-                    (0, utils_1.writeLineSeparator)();
-                });
+            if (Array.isArray(res.data.data) && res.data.data.length > 0) {
+                spinner.succeed(`Retrieved ${res.data.data.length} job contexts`);
+                yield (0, utils_1.logArrayResults)(res.data.data, res.data.links);
             }
             else {
                 spinner.succeed('No job contexts found');

package/lib/job-runner/jobContext/listJobContexts.spec.js

@@ -14,13 +14,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const nock_1 = __importDefault(require("nock"));
 const listJobContexts_1 = __importDefault(require("./listJobContexts"));
-const chalk_1 = __importDefault(require("chalk"));
-const logSpy = jest.spyOn(global.console, 'log');
 describe('listJobContexts', () => {
     process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL = 'true';
     it('correctly lists the job contexts', () => __awaiter(void 0, void 0, void 0, function* () {
         (0, nock_1.default)('http://localhost:9999')
-            .get('/job-context?')
+            .get('/job-context?page%5Bsize%5D=20')
             .reply(200, [
             {
                 contextName: 'dev',
@@ -55,10 +53,5 @@ describe('listJobContexts', () => {
         const opts = program.opts();
         expect(opts.tenant).toEqual('myTenant');
         expect(opts.overrideUrl).toEqual('http://localhost:9999');
-        expect(logSpy).toHaveBeenCalledTimes(9);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.green(chalk_1.default.bold('dev'))}: ${chalk_1.default.green('dev context')}`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('something')}: ${JSON.stringify('cool')}`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('somethingElse')}: ${JSON.stringify('cooler')}`);
-        expect(logSpy).toHaveBeenCalledWith(chalk_1.default.cyan('------------------------------'));
     }));
 });

package/lib/job-runner/jobExecution/beginJob/beginJob.js

@@ -39,7 +39,9 @@ const createBeginJobCommand = () => {
             if (options.inputFile) {
                 input = yield (0, utils_1.readInputFile)(options.inputFile);
             }
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+            });
             const beginJobUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/executions/begin`;
             const res = yield apiService.client.post(beginJobUrl, {
                 jobName: jobName,

package/lib/job-runner/jobExecution/listJobExecutions/listJobExecutions.js

@@ -35,7 +35,9 @@ const createListJobExecutionsCommand = () => {
         yield (0, utils_1.throwErrorIfNotLoggedIn)(listJobExecutionsCommand);
         const spinner = (0, ora_1.default)('Retrieving job executions').start();
         try {
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+            });
             let listExecutionsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/executions/jobName/${jobName}?`;
             listExecutionsUrl = (0, utils_1.addPaginationToUrl)(listExecutionsUrl, {
                 before: options.before,

package/lib/job-runner/jobExecution/listJobExecutions/listJobExecutions.spec.js

@@ -19,7 +19,7 @@ describe('listJobExecutions', () => {
     it('correctly lists the job executions', () => __awaiter(void 0, void 0, void 0, function* () {
         process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL = 'true';
         (0, nock_1.default)('http://localhost:9999')
-            .get('/executions/jobName/job-runner?&page[size]=5')
+            .get('/executions/jobName/job-runner?&page%5Bsize%5D=5')
             .reply(200, [
             {
                 context: 'dev',

package/lib/job-runner/jobExecution/terminateJob/terminateJob.js

@@ -36,7 +36,9 @@ const createTerminateJobCommand = () => {
         const spinner = (0, ora_1.default)('Terminating job').start();
         console.log('');
         try {
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+            });
             const terminateJobUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/executions/terminate`;
             const res = yield apiService.client.post(terminateJobUrl, {
                 jobName: jobName,

package/lib/job-runner/utils.js

@@ -96,19 +96,20 @@ function addPaginationToUrl(url, opts) {
     if (opts.before && opts.after) {
         throw new Error('Only one of before and after can be set');
     }
-    if (opts.size) {
-        url += `&page[size]=${PaginationPageLimit[opts.size]}`;
-    }
-    else {
-        `&page[size]=${PaginationPageLimit.small}`;
-    }
+    const parsedUrl = new URL(url);
+    const params = parsedUrl.searchParams;
+    // Set page size
+    params.set('page[size]', opts.size
+        ? `${PaginationPageLimit[opts.size]}`
+        : `${PaginationPageLimit.small}`);
+    // Set pagination parameters
     if (opts.before) {
-        url += `&page[before]=${opts.before}`;
+        params.set('page[before]', opts.before);
     }
-    if (opts.after) {
-        url += `&page[after]=${opts.after}`;
+    else if (opts.after) {
+        params.set('page[after]', opts.after);
     }
-    return url;
+    return parsedUrl.toString();
 }
 exports.addPaginationToUrl = addPaginationToUrl;
 function logArrayResults(results, links) {

package/lib/job-runner/utils.spec.js

@@ -93,11 +93,11 @@ describe('readInputFile', () => {
 describe('addPaginationToUrl', () => {
     it('correctly adds the pagination size param to the url', () => __awaiter(void 0, void 0, void 0, function* () {
         const url = (0, utils_1.addPaginationToUrl)('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?', { size: 'tiny', before: '', after: '' });
-        expect(url).toBe('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?&page[size]=5');
+        expect(url).toBe('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?page%5Bsize%5D=5');
     }));
     it('correctly adds the pagination params to the url', () => __awaiter(void 0, void 0, void 0, function* () {
         const url = (0, utils_1.addPaginationToUrl)('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?', { size: 'tiny', before: '12345', after: '' });
-        expect(url).toBe('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?&page[size]=5&page[before]=12345');
+        expect(url).toBe('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?page%5Bsize%5D=5&page%5Bbefore%5D=12345');
     }));
     it('correctly throws error for before and after params', () => __awaiter(void 0, void 0, void 0, function* () {
         expect(() => {

package/lib/porter/port/abort/abort.js

@@ -43,7 +43,10 @@ const createAbortPortCommand = () => {
         try {
             projectName = yield (0, utils_1.getProjectName)();
             spinner.start('Aborting port..');
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+                baseUrl,
+            });
             const abortRequest = {
                 status: 'abort',
             };

package/lib/porter/port/get/get.js

@@ -44,7 +44,10 @@ const createGetPortCommand = () => {
         try {
             projectName = yield (0, utils_1.getProjectName)();
             spinner.start('Retrieving port..');
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+                baseUrl,
+            });
             const response = yield apiService.client.get(`/projects/${projectName}/ports/${portId}`);
             const jsonResponse = response.data;
             (0, utils_1.logDebug)(JSON.stringify(jsonResponse));

package/lib/porter/port/start/start.js

@@ -35,7 +35,10 @@ const createStartPortCommand = () => {
         try {
             projectName = yield (0, utils_1.getProjectName)();
             spinner.start('Starting port..');
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+                baseUrl,
+            });
             // Read the stage directories for project configuration
             const stageConfigDir = path_1.default.resolve('stage-configs');
             const stageDirs = yield promises_1.default.readdir(stageConfigDir);

package/lib/porter/project/add/add.js

@@ -70,7 +70,10 @@ const createAddProjectCommand = () => {
                 throw new Error(`Project parent directory "${parentDir}" does not exist`);
             }
             spinner.start('Creating a new project..');
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+                baseUrl,
+            });
             const requestBody = { 'new-project': true };
             const response = yield apiService.client.put(`/projects/${projectName}`, requestBody);
             (0, utils_1.logDebug)(response.data);

package/lib/porter/project/get/get.js

@@ -34,7 +34,10 @@ const createGetProjectCommand = () => {
         try {
             projectName = yield (0, utils_1.getProjectName)();
             spinner.start('Retrieving project..');
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+                baseUrl,
+            });
             const response = yield apiService.client.get(`/projects/${projectName}`);
             const jsonResponse = response.data;
             (0, utils_1.logDebug)(JSON.stringify(jsonResponse));

package/lib/porter/project/remove/remove.js

@@ -43,7 +43,10 @@ const createRemoveProjectCommand = () => {
                 return;
             }
             spinner.start('Deleting project..');
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const apiService = new ApiService_1.ApiService({
+                validateStatus: utils_1.validateAxiosStatus,
+                baseUrl,
+            });
             const response = yield apiService.client.delete(`/projects/${projectName}`);
             (0, utils_1.logDebug)(response.data);
             spinner.succeed('Project has been deleted from the cloud');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.23.0",
+  "version": "5.23.1-develop.2",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },
@@ -41,9 +41,9 @@
   ],
   "dependencies": {
     "@apidevtools/swagger-parser": "10.1.0",
-    "@squiz/component-cli-lib": "1.71.10",
+    "@squiz/component-cli-lib": "1.71.12",
     "@squiz/dxp-porter-shared": "0.4.0",
-    "@squiz/local-component-dev-ui": "0.6.17",
+    "@squiz/local-component-dev-ui": "0.6.18",
     "axios": "1.1.3",
     "cli-color": "2.0.3",
     "commander": "9.4.0",