@sitecore-content-sdk/cli 1.3.0-canary.4 → 1.3.0-canary.5

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

@@ -49,17 +49,19 @@ 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 load_config_1 = __importDefault(require("../../../utils/load-config"));
 const generate_map_1 = require("./generate-map");
-let { getComponentVariantSpec, getComponentList, getComponentVariantSpecUrl } = tools;
+const load_config_1 = __importDefault(require("../../../utils/load-config"));
+let { getComponentSpec, getComponentList, getComponentSpecUrl } = tools;
 const unitMocks = (toolsModule) => {
-    getComponentVariantSpec = toolsModule.getComponentVariantSpec;
+    getComponentSpec = toolsModule.getComponentSpec;
     getComponentList = toolsModule.getComponentList;
-    getComponentVariantSpecUrl = toolsModule.getComponentVariantSpecUrl;
+    getComponentSpecUrl = toolsModule.getComponentSpecUrl;
 };
 exports.unitMocks = unitMocks;
 /**
@@ -68,11 +70,11 @@ exports.unitMocks = unitMocks;
 function args(yargs) {
     /* istanbul ignore next */
     return yargs
-        .positional('variantId', {
+        .positional('componentId', {
         requiresArg: true,
         positional: true,
         type: 'string',
-        describe: `The unique identifier of the newly created variant.`,
+        describe: `The unique identifier of the newly created component.`,
     })
         .option('token', {
         requiresArg: true,
@@ -83,7 +85,7 @@ function args(yargs) {
         .option('target-path', {
         requiresArg: false,
         type: 'string',
-        describe: 'The target path for the component variant.',
+        describe: 'The relative target path for the component.\n(Example: components/Promo.WithText.ts)',
     })
         .option('skip-component-map', {
         requiresArg: false,
@@ -108,16 +110,35 @@ function args(yargs) {
  */
 function builder(yargs) {
     /* istanbul ignore next */
-    return yargs.command('add <variant-id>', 'Adds a component variant', args, handler);
+    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 { variantId, token, targetPath: targetPathArg, skipComponentMap, config, overwrite } = argv;
-        console.log(chalk_1.default.green('Adding component variant'));
+        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) {
@@ -125,10 +146,16 @@ function handler(argv) {
             return;
         }
         const { edgeUrl } = cliConfig.config.api.edge;
+        let backupPath;
+        let resolvedFilePath;
         try {
-            const spec = yield getComponentVariantSpec({
+            if (validateTargetPath(targetPath) !== true) {
+                console.error(chalk_1.default.red(validateTargetPath(targetPath)));
+                return;
+            }
+            const spec = yield getComponentSpec({
                 edgeUrl,
-                variantId,
+                componentId,
                 targetPath,
                 token,
             });
@@ -155,29 +182,54 @@ function handler(argv) {
                         type: 'input',
                         name: 'targetPath',
                         required: true,
-                        message: `Enter the target path for the component variant.\nThe filename must follow the format: {componentName}.{variantName}.{extension}\n(example: src/components/MyComponent/MyComponent.variantA.ts):`,
+                        message: `Enter the target path for the component.\n(Example: components/Promo.WithText.ts):`,
+                        validate: validateTargetPath,
                     })
                         .then((answer) => answer.targetPath);
                 }
             }
-            const variantSpecUrl = getComponentVariantSpecUrl({
-                variantId,
+            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 "${variantSpecUrl}"${overwrite ? ' --overwrite' : ''}`, {
+            (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 variant ${variantName} added successfully`));
+            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 variant: ${errorMessage}`));
+            console.error(chalk_1.default.red(`Failed to add component: ${errorMessage}`));
             return;
         }
     });

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

@@ -7,17 +7,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import fs from 'fs';
+import path from 'path';
 import chalk from 'chalk';
 import { execSync } from 'child_process';
 import * as tools from '@sitecore-content-sdk/core/tools';
 import inquirer from 'inquirer';
-import loadCliConfig from '../../../utils/load-config';
 import { handler as generateMapHandler } from './generate-map';
-let { getComponentVariantSpec, getComponentList, getComponentVariantSpecUrl } = tools;
+import loadCliConfig from '../../../utils/load-config';
+let { getComponentSpec, getComponentList, getComponentSpecUrl } = tools;
 export const unitMocks = (toolsModule) => {
-    getComponentVariantSpec = toolsModule.getComponentVariantSpec;
+    getComponentSpec = toolsModule.getComponentSpec;
     getComponentList = toolsModule.getComponentList;
-    getComponentVariantSpecUrl = toolsModule.getComponentVariantSpecUrl;
+    getComponentSpecUrl = toolsModule.getComponentSpecUrl;
 };
 /**
  * @param {Argv} yargs
@@ -25,11 +27,11 @@ export const unitMocks = (toolsModule) => {
 export function args(yargs) {
     /* istanbul ignore next */
     return yargs
-        .positional('variantId', {
+        .positional('componentId', {
         requiresArg: true,
         positional: true,
         type: 'string',
-        describe: `The unique identifier of the newly created variant.`,
+        describe: `The unique identifier of the newly created component.`,
     })
         .option('token', {
         requiresArg: true,
@@ -40,7 +42,7 @@ export function args(yargs) {
         .option('target-path', {
         requiresArg: false,
         type: 'string',
-        describe: 'The target path for the component variant.',
+        describe: 'The relative target path for the component.\n(Example: components/Promo.WithText.ts)',
     })
         .option('skip-component-map', {
         requiresArg: false,
@@ -65,16 +67,35 @@ export function args(yargs) {
  */
 export function builder(yargs) {
     /* istanbul ignore next */
-    return yargs.command('add <variant-id>', 'Adds a component variant', args, handler);
+    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.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.
  */
 export function handler(argv) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { variantId, token, targetPath: targetPathArg, skipComponentMap, config, overwrite } = argv;
-        console.log(chalk.green('Adding component variant'));
+        const { componentId, token, targetPath: targetPathArg, skipComponentMap, config, overwrite, } = argv;
+        console.log(chalk.green('Adding component'));
         let targetPath = targetPathArg;
         const cliConfig = loadCliConfig(config);
         if (!cliConfig.config) {
@@ -82,10 +103,16 @@ export function handler(argv) {
             return;
         }
         const { edgeUrl } = cliConfig.config.api.edge;
+        let backupPath;
+        let resolvedFilePath;
         try {
-            const spec = yield getComponentVariantSpec({
+            if (validateTargetPath(targetPath) !== true) {
+                console.error(chalk.red(validateTargetPath(targetPath)));
+                return;
+            }
+            const spec = yield getComponentSpec({
                 edgeUrl,
-                variantId,
+                componentId,
                 targetPath,
                 token,
             });
@@ -112,29 +139,54 @@ export function handler(argv) {
                         type: 'input',
                         name: 'targetPath',
                         required: true,
-                        message: `Enter the target path for the component variant.\nThe filename must follow the format: {componentName}.{variantName}.{extension}\n(example: src/components/MyComponent/MyComponent.variantA.ts):`,
+                        message: `Enter the target path for the component.\n(Example: components/Promo.WithText.ts):`,
+                        validate: validateTargetPath,
                     })
                         .then((answer) => answer.targetPath);
                 }
             }
-            const variantSpecUrl = getComponentVariantSpecUrl({
-                variantId,
+            resolvedFilePath = path.resolve(process.cwd(), targetPath);
+            const isFileAlreadyExists = fs.existsSync(resolvedFilePath);
+            backupPath = `${resolvedFilePath}.backup`;
+            if (isFileAlreadyExists) {
+                if (!overwrite) {
+                    const shouldOverwrite = yield inquirer.prompt({
+                        type: 'confirm',
+                        name: 'overwrite',
+                        message: `File already exists: ${targetPath}. Overwrite?`,
+                        default: false,
+                    });
+                    if (!shouldOverwrite.overwrite) {
+                        return;
+                    }
+                }
+                fs.renameSync(resolvedFilePath, backupPath);
+                console.log(chalk.yellow(`Overwriting existing file: ${targetPath}`));
+            }
+            const componentSpecUrl = getComponentSpecUrl({
+                componentId,
                 targetPath: targetPath,
                 edgeUrl,
                 token,
             });
-            execSync(`npx shadcn@^3.4.2 add "${variantSpecUrl}"${overwrite ? ' --overwrite' : ''}`, {
+            execSync(`npx shadcn@^3.4.2 add "${componentSpecUrl}"`, {
                 stdio: 'inherit',
                 cwd: process.cwd(),
             });
+            if (isFileAlreadyExists) {
+                fs.unlinkSync(backupPath);
+            }
             if (!skipComponentMap) {
                 generateMapHandler({ config });
             }
-            console.log(chalk.green(`Component variant ${variantName} added successfully`));
+            console.log(chalk.green(`Component ${componentName} added successfully`));
         }
         catch (error) {
+            if (backupPath && resolvedFilePath && fs.existsSync(backupPath)) {
+                fs.renameSync(backupPath, resolvedFilePath);
+            }
             const errorMessage = error instanceof Error ? error.message : String(error);
-            console.error(chalk.red(`Failed to add component variant: ${errorMessage}`));
+            console.error(chalk.red(`Failed to add component: ${errorMessage}`));
             return;
         }
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/cli",
-  "version": "1.3.0-canary.4",
+  "version": "1.3.0-canary.5",
   "description": "Sitecore Content SDK CLI",
   "main": "dist/cjs/cli.js",
   "module": "dist/esm/cli.js",
@@ -34,7 +34,7 @@
     "url": "https://github.com/sitecore/content-sdk/issues"
   },
   "dependencies": {
-    "@sitecore-content-sdk/core": "1.3.0-canary.4",
+    "@sitecore-content-sdk/core": "1.3.0-canary.5",
     "chokidar": "^4.0.3",
     "dotenv": "^16.5.0",
     "dotenv-expand": "^12.0.2",
@@ -71,7 +71,7 @@
     "ts-node": "^10.9.1",
     "typescript": "~5.8.3"
   },
-  "gitHead": "24542709986dbcaba7706fe86ca51cf6b64fd282",
+  "gitHead": "654b9fe883af77f4bbab49114002ac0cf2054125",
   "files": [
     "dist",
     "types"

package/types/scripts/project/component/add.d.ts

@@ -1,17 +1,17 @@
 import { Argv } from 'yargs';
 import * as tools from '@sitecore-content-sdk/core/tools';
-export declare const unitMocks: (toolsModule: Pick<typeof tools, "getComponentVariantSpec" | "getComponentList" | "getComponentVariantSpecUrl">) => void;
+export declare const unitMocks: (toolsModule: Pick<typeof tools, "getComponentSpec" | "getComponentList" | "getComponentSpecUrl">) => void;
 type AddArgs = {
     /**
-     * The unique identifier of the newly created variant.
+     * The unique identifier of the newly created component.
      */
-    variantId: string;
+    componentId: string;
     /**
      * The authentication token.
      */
     token: string;
     /**
-     * The target path for the component variant.
+     * The target path for the component.
      */
     targetPath?: string;
     /**
@@ -33,8 +33,8 @@ type AddArgs = {
 /**
  * @param {Argv} yargs
  */
-export declare function args(yargs: Argv<AddArgs>): Argv<import("yargs").Omit<import("yargs").Omit<import("yargs").Omit<import("yargs").Omit<AddArgs, "variantId"> & {
-    variantId: string | undefined;
+export declare function args(yargs: Argv<AddArgs>): Argv<import("yargs").Omit<import("yargs").Omit<import("yargs").Omit<import("yargs").Omit<AddArgs, "componentId"> & {
+    componentId: string | undefined;
 }, "token"> & {
     token: string;
 } & {