@squiz/dxp-cli-next 5.14.0 → 5.15.0-develop.1

package/README.md

@@ -25,4 +25,5 @@ Commands:
   job-runner     Job Runner Service Commands
   datastore      Datastore Service Commands
   cdp            Customer Data Platform Service Commands
+  porter         Porter Service Commands
 ```

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

@@ -15,8 +15,9 @@ describe('dxp', () => {
             'auth           Authenticate into the DXP-Next CLI',
             'cmp            Component Service Commands',
             'job-runner     Job Runner Service Commands',
-            'datastore      Datastore Commands',
-            'cdp            CDP Commands',
+            'datastore      Datastore Service Commands',
+            'cdp            Customer Data Platform Service Commands',
+            'porter         Porter Service Commands',
         ]);
     });
 });

package/lib/cdp/index.js

@@ -6,5 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const schemaCommand_1 = __importDefault(require("./schema/schemaCommand"));
 const cdpCommand = new commander_1.Command('cdp');
-cdpCommand.description('CDP Commands').addCommand((0, schemaCommand_1.default)());
+cdpCommand
+    .description('Customer Data Platform Service Commands')
+    .addCommand((0, schemaCommand_1.default)());
 exports.default = cdpCommand;

package/lib/cmp/deploy.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) {
@@ -18,11 +41,18 @@ const cli_color_1 = __importDefault(require("cli-color"));
 const ApiService_1 = require("../ApiService");
 const ApplicationStore_1 = require("../ApplicationStore");
 const ApplicationConfig_1 = require("../ApplicationConfig");
+const compiler_1 = require("./edge-components/compiler");
+const definitions_1 = require("./utils/definitions");
+const fs = __importStar(require("node:fs/promises"));
+const path = __importStar(require("node:path"));
 const deployCommand = new commander_1.Command()
     .name('deploy')
-    .argument('<source>', 'folder/file path containing the template files to 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('--type <type>', 'Type of component to deploy')
+    .choices(['edge', 'sandbox'])
+    .default('sandbox'))
     .action((source, options) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     if (process.env.COMPONENT_SERVICE_URL !== undefined) {
@@ -39,7 +69,24 @@ const deployCommand = new commander_1.Command()
     try {
         const componentServiceUrl = ((_b = options.componentServiceUrl) === null || _b === void 0 ? void 0 : _b.replace(/v1\/?$/, '')) ||
             (yield buildComponentServiceUrl(options.tenant));
-        return yield (0, component_cli_lib_1.uploadComponentFolder)(apiService.client, componentServiceUrl, source);
+        if (options.type === 'sandbox') {
+            return yield (0, component_cli_lib_1.uploadComponentFolder)(apiService.client, componentServiceUrl, source);
+        }
+        if (options.type === 'edge') {
+            if (process.env.FEATURE_EDGE_COMPONENTS !== 'true') {
+                throw new Error('Component type "edge" is still in development. Run with environment variable "FEATURE_EDGE_COMPONENTS=true" to enable');
+            }
+            const def = yield definitions_1.ComponentDefinition.load(source);
+            if (!def) {
+                throw new Error('Invalid definition');
+            }
+            const dxpCacheDirPath = path.resolve(source, '.dxp');
+            yield fs.mkdir(dxpCacheDirPath, { recursive: true });
+            const outputDir = yield fs.mkdtemp(path.resolve(dxpCacheDirPath, 'cmp-'));
+            yield (0, compiler_1.compileUserCode)(def.mainEntryFilePath, path.join(outputDir, 'userCode.js'));
+            yield fs.copyFile(def.manifestPath, path.resolve(outputDir, 'manifest.json'));
+            return yield (0, component_cli_lib_1.uploadComponentFolder)(apiService, componentServiceUrl, outputDir);
+        }
     }
     catch (error) {
         if (!!process.env.DEBUG && error.stack) {

package/lib/cmp/edge-components/compiler.d.ts

@@ -0,0 +1,13 @@
+import * as esbuild from 'esbuild';
+export declare function compileUserCode(codePath: string, outfile: string): Promise<esbuild.BuildResult<{
+    entryPoints: string[];
+    bundle: true;
+    outfile: string;
+    format: "esm";
+    loader: {
+        '.js': "jsx";
+    };
+    target: string;
+    minify: true;
+    sourcemap: true;
+}>>;

package/lib/cmp/edge-components/compiler.js

@@ -0,0 +1,55 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compileUserCode = void 0;
+const esbuild = __importStar(require("esbuild"));
+function compileUserCode(codePath, outfile) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // "esbuild --bundle --outfile=./src/userCode.actual.js --format=esm --loader:.js=jsx --target=es2022 --minify --sourcemap",
+        const output = yield esbuild.build({
+            entryPoints: [codePath],
+            bundle: true,
+            outfile,
+            format: 'esm',
+            loader: {
+                '.js': 'jsx',
+            },
+            target: 'es2022',
+            minify: true,
+            sourcemap: true,
+        });
+        return output;
+    });
+}
+exports.compileUserCode = compileUserCode;

package/lib/cmp/utils/definitions.d.ts

@@ -0,0 +1,12 @@
+export declare class ComponentDefinition {
+    private baseDir;
+    private definition;
+    static load(componentDirectory: string): Promise<ComponentDefinition | undefined>;
+    private constructor();
+    get mainEntryFilePath(): string;
+    get mainFunction(): {
+        name: string;
+        entry: string;
+    };
+    get manifestPath(): string;
+}

package/lib/cmp/utils/definitions.js

@@ -0,0 +1,76 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentDefinition = void 0;
+const fs = __importStar(require("node:fs/promises"));
+const path = __importStar(require("node:path"));
+const zod_1 = require("zod");
+class ComponentDefinition {
+    constructor(baseDir, definition) {
+        this.baseDir = baseDir;
+        this.definition = definition;
+    }
+    static load(componentDirectory) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const manifest = yield fs.readFile(path.resolve(componentDirectory, 'manifest.json'), { encoding: 'utf-8' });
+                const definition = yield BasicDefinition.parseAsync(JSON.parse(manifest));
+                return new ComponentDefinition(componentDirectory, definition);
+            }
+            catch (e) {
+                console.error(e);
+            }
+        });
+    }
+    get mainEntryFilePath() {
+        return path.resolve(this.baseDir, this.mainFunction.entry);
+    }
+    get mainFunction() {
+        return this.definition.functions.find(fn => fn.name === this.definition.mainFunction);
+    }
+    get manifestPath() {
+        return path.resolve(this.baseDir, 'manifest.json');
+    }
+}
+exports.ComponentDefinition = ComponentDefinition;
+const BasicDefinition = zod_1.z.object({
+    mainFunction: zod_1.z.string(),
+    functions: zod_1.z
+        .array(zod_1.z.object({
+        name: zod_1.z.string(),
+        entry: zod_1.z.string(),
+    }))
+        .refine(fns => new Set(fns.map(f => f.name)).size === fns.length),
+    type: zod_1.z.enum(['edge', 'sandbox']).optional().default('sandbox'),
+});

package/lib/datastore/index.js

@@ -9,7 +9,7 @@ const bundle_1 = __importDefault(require("./bundle/bundle"));
 const simulatorCommand_1 = __importDefault(require("./simulator/simulatorCommand"));
 const datastoreCommand = new commander_1.Command('datastore');
 datastoreCommand
-    .description('Datastore Commands')
+    .description('Datastore Service Commands')
     .addCommand((0, blueprintCommand_1.default)())
     .addCommand((0, bundle_1.default)())
     .addCommand((0, simulatorCommand_1.default)());

package/lib/dxp.js

@@ -16,6 +16,7 @@ const cmp_1 = __importDefault(require("./cmp"));
 const job_runner_1 = __importDefault(require("./job-runner"));
 const datastore_1 = __importDefault(require("./datastore"));
 const cdp_1 = __importDefault(require("./cdp"));
+const porter_1 = __importDefault(require("./porter"));
 const program = new commander_1.default.Command();
 const packageJson = require('../package.json');
 const version = packageJson.version;
@@ -28,6 +29,7 @@ program
     .addCommand(job_runner_1.default)
     .addCommand(datastore_1.default)
     .addCommand(cdp_1.default)
+    .addCommand(porter_1.default)
     .action(() => {
     program.help();
 })

package/lib/porter/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const SQUIZ_ROOT_TENANT = "SquizRoot-0000";
+export declare const PORTER_REGION = "au";
+export declare const PORTER_ERRORS: {
+    projectAlreadyExists: string;
+    projectNameMissing: string;
+};

package/lib/porter/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PORTER_ERRORS = exports.PORTER_REGION = exports.SQUIZ_ROOT_TENANT = void 0;
+exports.SQUIZ_ROOT_TENANT = 'SquizRoot-0000';
+exports.PORTER_REGION = 'au';
+exports.PORTER_ERRORS = {
+    projectAlreadyExists: 'Project directory already exists. Please choose a project directory that does not exist',
+    projectNameMissing: 'Project name is missing from the config.json file',
+};

package/lib/porter/index.d.ts

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

package/lib/porter/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 projectCommand_1 = __importDefault(require("./project/projectCommand"));
+const porterCommand = new commander_1.Command('porter');
+porterCommand
+    .description('Porter Service Commands')
+    .addCommand((0, projectCommand_1.default)());
+exports.default = porterCommand;

package/lib/porter/project/add/add.d.ts

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

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

@@ -0,0 +1,125 @@
+"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 promises_1 = __importDefault(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+const ora_1 = __importDefault(require("ora"));
+const ApiService_1 = require("../../../ApiService");
+const utils_1 = require("../../utils");
+const dxp_porter_shared_1 = require("@squiz/dxp-porter-shared");
+const constants_1 = require("../../constants");
+const { version: cliVersion } = require('../../../../package.json');
+const allPortStages = Object.values(dxp_porter_shared_1.Stage);
+const stageDirsToCreate = allPortStages.filter(stage => stage !== dxp_porter_shared_1.Stage['component-transform'] && stage !== dxp_porter_shared_1.Stage['design-dedupe']);
+const createAddProjectCommand = () => {
+    const addCommand = new commander_1.Command('addProject')
+        .description('Adds a new project')
+        .addOption(new commander_1.Option('--project-name <string>', 'project name')
+        .makeOptionMandatory()
+        .argParser(name => {
+        // Project name validation
+        const regex = /^[a-zA-Z0-9\-_]+$/;
+        if (!regex.test(name)) {
+            throw new commander_1.InvalidArgumentError('Project name can only contain letters, numbers, hyphen and underscore');
+        }
+        return name;
+    }))
+        .addOption(new commander_1.Option('--path <string>', 'path to store the project').makeOptionMandatory())
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b;
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(addCommand);
+        const baseUrl = yield (0, utils_1.buildPorterUrl)();
+        const projectName = options.projectName;
+        const projectPath = options.path;
+        const spinner = (0, ora_1.default)();
+        const projectDir = path_1.default.resolve(projectPath);
+        try {
+            const pathExists = yield (0, utils_1.doesPathExist)(projectPath);
+            if (pathExists) {
+                throw new Error(constants_1.PORTER_ERRORS.projectAlreadyExists);
+            }
+            const parentDir = path_1.default.dirname(projectDir);
+            try {
+                yield promises_1.default.access(parentDir);
+            }
+            catch (_c) {
+                throw new Error(`Project parent directory "${parentDir}" does not exist`);
+            }
+            spinner.start('Creating a new project..');
+            yield promises_1.default.mkdir(projectDir);
+            (0, utils_1.logDebug)(`Directory created successfully at ${projectDir}`);
+            const configJsonFile = path_1.default.join(projectDir, 'config.json');
+            yield promises_1.default.writeFile(configJsonFile, JSON.stringify({
+                service: 'dxp-porter',
+                projectName,
+                version: cliVersion,
+            }, null, 2));
+            (0, utils_1.logDebug)(`File created successfully at ${configJsonFile}`);
+            const stageConfigDir = path_1.default.join(projectDir, 'stage-configs');
+            yield promises_1.default.mkdir(stageConfigDir);
+            (0, utils_1.logDebug)(`Directory created successfully at ${stageConfigDir}`);
+            yield Promise.all(stageDirsToCreate.map((stage) => __awaiter(void 0, void 0, void 0, function* () {
+                const stageDir = path_1.default.join(stageConfigDir, stage);
+                yield promises_1.default.mkdir(stageDir);
+                (0, utils_1.logDebug)(`Directory created successfully at ${stageDir}`);
+            })));
+            const crawlConfigExample = path_1.default.join(stageConfigDir, 'crawl', 'config.json.example');
+            yield promises_1.default.writeFile(crawlConfigExample, JSON.stringify({
+                start_urls: ['https://...', 'https://...'],
+                exclude_patterns: ['https://...', 'https://...'],
+                max_download_size: 'MB',
+                request_delay: 'INT',
+                max_dir_depth: 'INT',
+                max_files_stored: 'INT',
+                run: true,
+            }, null, 2));
+            (0, utils_1.logDebug)(`File created successfully at ${crawlConfigExample}`);
+            // Default example configs for other stages
+            stageDirsToCreate
+                .filter(dir => dir !== dxp_porter_shared_1.Stage.crawl)
+                .map((dir) => __awaiter(void 0, void 0, void 0, function* () {
+                const configExample = path_1.default.join(stageConfigDir, dir, 'config.json.example');
+                yield promises_1.default.writeFile(configExample, JSON.stringify({ run: true }, null, 2));
+                (0, utils_1.logDebug)(`File created successfully at ${configExample}`);
+            }));
+            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const requestBody = { 'new-project': true };
+            const response = yield apiService.client.put(`/projects/${projectName}`, requestBody);
+            (0, utils_1.logDebug)(response.data);
+            spinner.succeed(`Project "${projectName}" created. Project directory initialized`);
+        }
+        catch (error) {
+            (0, utils_1.logDebug)(`ERROR: ${error instanceof Error ? `${error.message}` : JSON.stringify(error)}`);
+            if (spinner.isSpinning) {
+                spinner.fail();
+            }
+            if (((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.status) === 409) {
+                (0, utils_1.logDebug)(`Failed to create new project, removing project directory: "${projectDir}"`);
+                yield promises_1.default.rm(projectDir, { recursive: true });
+                const errorMessage = `Project "${projectName}" already exists. Try a different project name`;
+                return (0, utils_1.handleError)(addCommand, errorMessage);
+            }
+            (0, utils_1.handleCommandError)(addCommand, error);
+        }
+    }));
+    return addCommand;
+};
+exports.default = createAddProjectCommand;

package/lib/porter/project/add/add.spec.d.ts

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