@sitecore-content-sdk/cli 1.3.0-canary.7 → 1.3.0

package/dist/cjs/scripts/project/component/add.js

@@ -1,236 +1,241 @@
-"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 () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __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.unitMocks = void 0;
-exports.args = args;
-exports.builder = builder;
-exports.handler = handler;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const chalk_1 = __importDefault(require("chalk"));
-const child_process_1 = require("child_process");
-const tools = __importStar(require("@sitecore-content-sdk/core/tools"));
-const inquirer_1 = __importDefault(require("inquirer"));
-const generate_map_1 = require("./generate-map");
-const load_config_1 = __importDefault(require("../../../utils/load-config"));
-let { getComponentSpec, getComponentList, getComponentSpecUrl } = tools;
-const unitMocks = (toolsModule) => {
-    getComponentSpec = toolsModule.getComponentSpec;
-    getComponentList = toolsModule.getComponentList;
-    getComponentSpecUrl = toolsModule.getComponentSpecUrl;
-};
-exports.unitMocks = unitMocks;
-/**
- * @param {Argv} yargs
- */
-function args(yargs) {
-    /* istanbul ignore next */
-    return yargs
-        .positional('componentId', {
-        requiresArg: true,
-        positional: true,
-        type: 'string',
-        describe: `The unique identifier of the newly created component.`,
-    })
-        .option('token', {
-        requiresArg: true,
-        type: 'string',
-        describe: 'The authentication token.',
-        demandOption: true,
-    })
-        .option('target-path', {
-        requiresArg: false,
-        type: 'string',
-        describe: 'The relative target path for the component.\n(Example: components/Promo.WithText.ts)',
-    })
-        .option('skip-component-map', {
-        requiresArg: false,
-        type: 'boolean',
-        describe: 'If true, skips the component map generation.',
-        default: false,
-    })
-        .option('overwrite', {
-        requiresArg: false,
-        type: 'boolean',
-        describe: 'If true, overwrites the existing component.',
-        default: false,
-    })
-        .option('config', {
-        requiresArg: false,
-        type: 'string',
-        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
-    });
-}
-/**
- * @param {Argv} yargs
- */
-function builder(yargs) {
-    /* istanbul ignore next */
-    return yargs.command('add <component-id>', 'Adds a component', args, handler);
-}
-/**
- * Validates the target path. If no target path is provided, returns true.
- * @param {string} [targetPath] - The target path to validate.
- * @returns {boolean | string} True if the target path is valid, the error message otherwise.
- */
-const validateTargetPath = (targetPath) => {
-    if (!targetPath) {
-        return true;
-    }
-    // Check for unsafe absolute path starting with "/"
-    if (path_1.default.isAbsolute(targetPath)) {
-        return 'Target path cannot be an absolute path starting with "/"';
-    }
-    // Check for path traversal attempts
-    if (targetPath.includes('..')) {
-        return 'Target path cannot contain ".." (path traversal)';
-    }
-    return true;
-};
-/**
- * Handler for the add command.
- * @param {AddArgs} argv - The arguments passed to the command.
- */
-function handler(argv) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { componentId, token, targetPath: targetPathArg, skipComponentMap, config, overwrite, } = argv;
-        console.log(chalk_1.default.green('Adding component'));
-        let targetPath = targetPathArg;
-        const cliConfig = (0, load_config_1.default)(config);
-        if (!cliConfig.config) {
-            console.error('The `sitecore.cli.config` file is missing a `config`. Please add it to use this command.');
-            return;
-        }
-        const { edgeUrl } = cliConfig.config.api.edge;
-        let backupPath;
-        let resolvedFilePath;
-        try {
-            if (validateTargetPath(targetPath) !== true) {
-                console.error(chalk_1.default.red(validateTargetPath(targetPath)));
-                return;
-            }
-            const spec = yield getComponentSpec({
-                edgeUrl,
-                componentId,
-                targetPath,
-                token,
-            });
-            const componentType = spec.meta['contentsdk-component-type'];
-            const componentName = spec.meta['contentsdk-component-name'];
-            const variantName = spec.meta['contentsdk-component-variant-name'];
-            const title = spec.title;
-            if (componentType !== 'variant') {
-                console.error(chalk_1.default.red(`The component "${title}" is not a content-sdk variant. Please, select a content-sdk variant to use this command.`));
-                return;
-            }
-            if (!targetPath) {
-                const { paths, exclude } = cliConfig.componentMap;
-                const components = getComponentList(paths, exclude, true);
-                const registeredComponent = components.find((c) => c.componentName === componentName);
-                if (registeredComponent) {
-                    targetPath = registeredComponent.filePath
-                        .replace(/\\/g, '/')
-                        .replace(/([^/]+)\.([^.]+)$/, `$1.${variantName}.$2`);
-                }
-                else {
-                    targetPath = yield inquirer_1.default
-                        .prompt({
-                        type: 'input',
-                        name: 'targetPath',
-                        required: true,
-                        message: `Enter the target path for the component.\n(Example: components/Promo.WithText.ts):`,
-                        validate: validateTargetPath,
-                    })
-                        .then((answer) => answer.targetPath);
-                }
-            }
-            resolvedFilePath = path_1.default.resolve(process.cwd(), targetPath);
-            const isFileAlreadyExists = fs_1.default.existsSync(resolvedFilePath);
-            backupPath = `${resolvedFilePath}.backup`;
-            if (isFileAlreadyExists) {
-                if (!overwrite) {
-                    const shouldOverwrite = yield inquirer_1.default.prompt({
-                        type: 'confirm',
-                        name: 'overwrite',
-                        message: `File already exists: ${targetPath}. Overwrite?`,
-                        default: false,
-                    });
-                    if (!shouldOverwrite.overwrite) {
-                        return;
-                    }
-                }
-                fs_1.default.renameSync(resolvedFilePath, backupPath);
-                console.log(chalk_1.default.yellow(`Overwriting existing file: ${targetPath}`));
-            }
-            const componentSpecUrl = getComponentSpecUrl({
-                componentId,
-                targetPath: targetPath,
-                edgeUrl,
-                token,
-            });
-            (0, child_process_1.execSync)(`npx shadcn@^3.4.2 add "${componentSpecUrl}"`, {
-                stdio: 'inherit',
-                cwd: process.cwd(),
-            });
-            if (isFileAlreadyExists) {
-                fs_1.default.unlinkSync(backupPath);
-            }
-            if (!skipComponentMap) {
-                (0, generate_map_1.handler)({ config });
-            }
-            console.log(chalk_1.default.green(`Component ${componentName} added successfully`));
-        }
-        catch (error) {
-            if (backupPath && resolvedFilePath && fs_1.default.existsSync(backupPath)) {
-                fs_1.default.renameSync(backupPath, resolvedFilePath);
-            }
-            const errorMessage = error instanceof Error ? error.message : String(error);
-            console.error(chalk_1.default.red(`Failed to add component: ${errorMessage}`));
-            return;
-        }
-    });
-}
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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.unitMocks = void 0;
+exports.args = args;
+exports.builder = builder;
+exports.handler = handler;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const child_process_1 = require("child_process");
+const tools = __importStar(require("@sitecore-content-sdk/core/tools"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const generate_map_1 = require("./generate-map");
+const load_config_1 = __importDefault(require("../../../utils/load-config"));
+let { getComponentSpec, getComponentList, getComponentSpecUrl } = tools;
+const unitMocks = (toolsModule) => {
+    getComponentSpec = toolsModule.getComponentSpec;
+    getComponentList = toolsModule.getComponentList;
+    getComponentSpecUrl = toolsModule.getComponentSpecUrl;
+};
+exports.unitMocks = unitMocks;
+/**
+ * @param {Argv} yargs
+ */
+function args(yargs) {
+    /* istanbul ignore next */
+    return yargs
+        .positional('componentId', {
+        requiresArg: true,
+        positional: true,
+        type: 'string',
+        describe: `The unique identifier of the newly created component.`,
+    })
+        .option('token', {
+        requiresArg: true,
+        type: 'string',
+        describe: 'The authentication token.',
+        demandOption: true,
+        alias: 't',
+    })
+        .option('target-path', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'The relative target path for the component.\n(Example: components/Promo.WithText.ts)',
+        alias: 'p',
+    })
+        .option('skip-component-map', {
+        requiresArg: false,
+        type: 'boolean',
+        describe: 'If true, skips the component map generation.',
+        default: false,
+        alias: 's',
+    })
+        .option('overwrite', {
+        requiresArg: false,
+        type: 'boolean',
+        describe: 'If true, overwrites the existing component.',
+        default: false,
+        alias: 'o',
+    })
+        .option('config', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
+        alias: 'c',
+    });
+}
+/**
+ * @param {Argv} yargs
+ */
+function builder(yargs) {
+    /* istanbul ignore next */
+    return yargs.command(['add <component-id>', 'a <component-id>'], 'Adds a component', args, handler);
+}
+/**
+ * Validates the target path. If no target path is provided, returns true.
+ * @param {string} [targetPath] - The target path to validate.
+ * @returns {boolean | string} True if the target path is valid, the error message otherwise.
+ */
+const validateTargetPath = (targetPath) => {
+    if (!targetPath) {
+        return true;
+    }
+    // Check for unsafe absolute path starting with "/"
+    if (path_1.default.isAbsolute(targetPath)) {
+        return 'Target path cannot be an absolute path starting with "/"';
+    }
+    // Check for path traversal attempts
+    if (targetPath.includes('..')) {
+        return 'Target path cannot contain ".." (path traversal)';
+    }
+    return true;
+};
+/**
+ * Handler for the add command.
+ * @param {AddArgs} argv - The arguments passed to the command.
+ */
+function handler(argv) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { componentId, token, targetPath: targetPathArg, skipComponentMap, config, overwrite, } = argv;
+        console.log(chalk_1.default.green('Adding component'));
+        let targetPath = targetPathArg;
+        const cliConfig = (0, load_config_1.default)(config);
+        if (!cliConfig.config) {
+            console.error('The `sitecore.cli.config` file is missing a `config`. Please add it to use this command.');
+            return;
+        }
+        const { edgeUrl } = cliConfig.config.api.edge;
+        let backupPath;
+        let resolvedFilePath;
+        try {
+            if (validateTargetPath(targetPath) !== true) {
+                console.error(chalk_1.default.red(validateTargetPath(targetPath)));
+                return;
+            }
+            const spec = yield getComponentSpec({
+                edgeUrl,
+                componentId,
+                targetPath,
+                token,
+            });
+            const componentType = spec.meta['contentsdk-component-type'];
+            const componentName = spec.meta['contentsdk-component-name'];
+            const variantName = spec.meta['contentsdk-component-variant-name'];
+            const title = spec.title;
+            if (componentType !== 'variant') {
+                console.error(chalk_1.default.red(`The component "${title}" is not a content-sdk variant. Please, select a content-sdk variant to use this command.`));
+                return;
+            }
+            if (!targetPath) {
+                const { paths, exclude } = cliConfig.componentMap;
+                const components = getComponentList(paths, exclude, true);
+                const registeredComponent = components.find((c) => c.componentName === componentName);
+                if (registeredComponent) {
+                    targetPath = registeredComponent.filePath
+                        .replace(/\\/g, '/')
+                        .replace(/([^/]+)\.([^.]+)$/, `$1.${variantName}.$2`);
+                }
+                else {
+                    targetPath = yield inquirer_1.default
+                        .prompt({
+                        type: 'input',
+                        name: 'targetPath',
+                        required: true,
+                        message: `Enter the target path for the component.\n(Example: components/Promo.WithText.ts):`,
+                        validate: validateTargetPath,
+                    })
+                        .then((answer) => answer.targetPath);
+                }
+            }
+            resolvedFilePath = path_1.default.resolve(process.cwd(), targetPath);
+            const isFileAlreadyExists = fs_1.default.existsSync(resolvedFilePath);
+            backupPath = `${resolvedFilePath}.backup`;
+            if (isFileAlreadyExists) {
+                if (!overwrite) {
+                    const shouldOverwrite = yield inquirer_1.default.prompt({
+                        type: 'confirm',
+                        name: 'overwrite',
+                        message: `File already exists: ${targetPath}. Overwrite?`,
+                        default: false,
+                    });
+                    if (!shouldOverwrite.overwrite) {
+                        return;
+                    }
+                }
+                fs_1.default.renameSync(resolvedFilePath, backupPath);
+                console.log(chalk_1.default.yellow(`Overwriting existing file: ${targetPath}`));
+            }
+            const componentSpecUrl = getComponentSpecUrl({
+                componentId,
+                targetPath: targetPath,
+                edgeUrl,
+                token,
+            });
+            (0, child_process_1.execSync)(`npx shadcn@^3.4.2 add "${componentSpecUrl}"`, {
+                stdio: 'inherit',
+                cwd: process.cwd(),
+            });
+            if (isFileAlreadyExists) {
+                fs_1.default.unlinkSync(backupPath);
+            }
+            if (!skipComponentMap) {
+                (0, generate_map_1.handler)({ config });
+            }
+            console.log(chalk_1.default.green(`Component ${componentName} added successfully`));
+        }
+        catch (error) {
+            if (backupPath && resolvedFilePath && fs_1.default.existsSync(backupPath)) {
+                fs_1.default.renameSync(backupPath, resolvedFilePath);
+            }
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            console.error(chalk_1.default.red(`Failed to add component: ${errorMessage}`));
+            return;
+        }
+    });
+}

package/dist/cjs/scripts/project/component/generate-map.js

@@ -1,68 +1,70 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.builder = builder;
-exports.args = args;
-exports.handler = handler;
-const watch_items_1 = require("../../../utils/watch-items");
-const load_config_1 = __importDefault(require("../../../utils/load-config"));
-/**
- * @param {Argv} yargs
- */
-function builder(yargs) {
-    return yargs.command('generate-map', 'Generates component map based on provided paths', args, handler);
-}
-/**
- * @param {Argv} yargs
- */
-function args(yargs) {
-    return yargs
-        .option('watch', {
-        requiresArg: false,
-        type: 'boolean',
-        describe: 'If true, watches for changes in the specified paths and updates the component map accordingly.',
-        default: false,
-    })
-        .option('config', {
-        requiresArg: false,
-        type: 'string',
-        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
-    });
-}
-/**
- * Handler for the `generate-map` command.
- * @param {GenerateMapCliArgs} argv Cli arguments for the command
- */
-function handler(argv) {
-    const cliConfig = (0, load_config_1.default)(argv.config);
-    if (!cliConfig.componentMap) {
-        console.error('The `sitecore.cli.config` file is missing a `componentMap` configuration. Please add it to use this command.');
-        return;
-    }
-    const componentMapGenerator = cliConfig.componentMap.generator;
-    const { paths, destination, componentImports, exclude, clientComponentMap, includeVariants } = cliConfig.componentMap;
-    if (argv.watch) {
-        console.log(`Watching for component changes to component builder sources in:\n ${paths.join('\n')}`);
-        (0, watch_items_1.watchItems)(paths, componentMapGenerator.bind(null, {
-            paths,
-            destination,
-            componentImports,
-            exclude,
-            clientComponentMap,
-            includeVariants,
-        }));
-    }
-    else {
-        console.log(`Generating component map for:\n ${paths.join('\n')}`);
-        componentMapGenerator({
-            paths,
-            destination,
-            componentImports,
-            exclude,
-            clientComponentMap,
-            includeVariants,
-        });
-    }
-}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.builder = builder;
+exports.args = args;
+exports.handler = handler;
+const watch_items_1 = require("../../../utils/watch-items");
+const load_config_1 = __importDefault(require("../../../utils/load-config"));
+/**
+ * @param {Argv} yargs
+ */
+function builder(yargs) {
+    return yargs.command(['generate-map', 'g'], 'Generates component map based on provided paths', args, handler);
+}
+/**
+ * @param {Argv} yargs
+ */
+function args(yargs) {
+    return yargs
+        .option('watch', {
+        requiresArg: false,
+        type: 'boolean',
+        describe: 'If true, watches for changes in the specified paths and updates the component map accordingly.',
+        default: false,
+        alias: 'w',
+    })
+        .option('config', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
+        alias: 'c',
+    });
+}
+/**
+ * Handler for the `generate-map` command.
+ * @param {GenerateMapCliArgs} argv Cli arguments for the command
+ */
+function handler(argv) {
+    const cliConfig = (0, load_config_1.default)(argv.config);
+    if (!cliConfig.componentMap) {
+        console.error('The `sitecore.cli.config` file is missing a `componentMap` configuration. Please add it to use this command.');
+        return;
+    }
+    const componentMapGenerator = cliConfig.componentMap.generator;
+    const { paths, destination, componentImports, exclude, clientComponentMap, includeVariants } = cliConfig.componentMap;
+    if (argv.watch) {
+        console.log(`Watching for component changes to component builder sources in:\n ${paths.join('\n')}`);
+        (0, watch_items_1.watchItems)(paths, componentMapGenerator.bind(null, {
+            paths,
+            destination,
+            componentImports,
+            exclude,
+            clientComponentMap,
+            includeVariants,
+        }));
+    }
+    else {
+        console.log(`Generating component map for:\n ${paths.join('\n')}`);
+        componentMapGenerator({
+            paths,
+            destination,
+            componentImports,
+            exclude,
+            clientComponentMap,
+            includeVariants,
+        });
+    }
+}