@sitecore-content-sdk/cli 1.2.1 → 1.3.0-canary.10

package/LICENSE.txt

@@ -1,202 +1,202 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,5 @@
-# Sitecore Content SDK CLI
-
-This module is provided as a part of Sitecore Contents SDK. It contains the Sitecore Content SDK command line interface.
-
-[Documentation Sitecore Content SDK CLI](https://doc.sitecore.com/xmc/en/developers/content-sdk/cli-commands-and-configuration.html)
+# Sitecore Content SDK CLI
+
+This module is provided as a part of Sitecore Contents SDK. It contains the Sitecore Content SDK command line interface.
+
+[Documentation Sitecore Content SDK CLI](https://doc.sitecore.com/xmc/en/developers/content-sdk/cli-commands-and-configuration.html)

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.2.1",
+  "version": "1.3.0-canary.10",
   "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.2.1",
+    "@sitecore-content-sdk/core": "1.3.0-canary.10",
     "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": "8da441d76f351e6cf46e445fad4a72ffd99f4129",
+  "gitHead": "e54f09ce6b86a74ee99ec94abe062ac4928585db",
   "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;
 } & {