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

package/dist/esm/cli.js

@@ -1,63 +1,63 @@
-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());
-    });
-};
-import yargs from 'yargs';
-// Makes the script crash on unhandled rejections instead of silently
-// ignoring them. In the future, promise rejections that are not handled will
-// terminate the Node.js process with a non-zero exit code.
-process.on('unhandledRejection', (err) => {
-    throw err;
-});
-/**
- * Initializes and configures the CLI application using yargs.
- * This function registers commands, sets up argument parsing, and handles command execution.
- * @param {object} commands - An object containing command modules to be registered with yargs.
- * Each key in the object represents a command name, and the value is a `CommandModule` object
- * that defines the command's behavior, arguments, and options.
- */
-export default function cli(commands) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let appCommands = yargs.usage('$0 <command>');
-        appCommands = appCommands.scriptName('sitecore-tools');
-        // Register commands if available
-        if (commands && Object.keys(commands).length > 0) {
-            for (const cmd of Object.keys(commands)) {
-                const commandObject = commands[cmd];
-                if (typeof commandObject.builder === 'function') {
-                    appCommands = yield commandObject.builder(appCommands);
-                }
-                if (typeof commandObject.builder === 'object') {
-                    const ogBuilder = commandObject.builder;
-                    const builderFunc = commandObject.disableStrictArgs
-                        ? (yarrrrg) => yarrrrg.options(ogBuilder)
-                        : (yarrrrg) => yarrrrg.options(ogBuilder).strict();
-                    commandObject.builder = builderFunc;
-                    appCommands = appCommands.command(commandObject);
-                }
-            }
-        }
-        appCommands
-            .command({
-            command: '*',
-            handler: (argv) => {
-                if (argv._.length > 0) {
-                    console.error(`Command not found: "${argv._[0]}"`);
-                }
-                else {
-                    console.error('No command provided');
-                }
-                yargs.showHelp();
-                process.exit(1);
-            },
-        })
-            .demandCommand(1, 'You need to specify a command to run')
-            .strict();
-        yield appCommands.argv;
-    });
-}
+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());
+    });
+};
+import yargs from 'yargs';
+// Makes the script crash on unhandled rejections instead of silently
+// ignoring them. In the future, promise rejections that are not handled will
+// terminate the Node.js process with a non-zero exit code.
+process.on('unhandledRejection', (err) => {
+    throw err;
+});
+/**
+ * Initializes and configures the CLI application using yargs.
+ * This function registers commands, sets up argument parsing, and handles command execution.
+ * @param {object} commands - An object containing command modules to be registered with yargs.
+ * Each key in the object represents a command name, and the value is a `CommandModule` object
+ * that defines the command's behavior, arguments, and options.
+ */
+export default function cli(commands) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let appCommands = yargs.usage('$0 <command>');
+        appCommands = appCommands.scriptName('sitecore-tools');
+        // Register commands if available
+        if (commands && Object.keys(commands).length > 0) {
+            for (const cmd of Object.keys(commands)) {
+                const commandObject = commands[cmd];
+                if (typeof commandObject.builder === 'function') {
+                    appCommands = yield commandObject.builder(appCommands);
+                }
+                if (typeof commandObject.builder === 'object') {
+                    const ogBuilder = commandObject.builder;
+                    const builderFunc = commandObject.disableStrictArgs
+                        ? (yarrrrg) => yarrrrg.options(ogBuilder)
+                        : (yarrrrg) => yarrrrg.options(ogBuilder).strict();
+                    commandObject.builder = builderFunc;
+                    appCommands = appCommands.command(commandObject);
+                }
+            }
+        }
+        appCommands
+            .command({
+            command: '*',
+            handler: (argv) => {
+                if (argv._.length > 0) {
+                    console.error(`Command not found: "${argv._[0]}"`);
+                }
+                else {
+                    console.error('No command provided');
+                }
+                yargs.showHelp();
+                process.exit(1);
+            },
+        })
+            .demandCommand(1, 'You need to specify a command to run')
+            .strict();
+        yield appCommands.argv;
+    });
+}

package/dist/esm/scripts/index.js

@@ -1,4 +1,4 @@
-// commands available when running from an app location (with CLI installed to local node_modules)
-// e.g. setup, deploy
-import * as project from './project';
-export { project };
+// commands available when running from an app location (with CLI installed to local node_modules)
+// e.g. setup, deploy
+import * as project from './project';
+export { project };

package/dist/esm/scripts/project/build.js

@@ -1,35 +1,35 @@
-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());
-    });
-};
-import loadCliConfig from '../../utils/load-config';
-export const command = 'build';
-export const describe = 'Performs build time automation';
-export const builder = {
-    config: {
-        requiresArg: false,
-        type: 'string',
-        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats.',
-    },
-};
-/**
- * Handler for the build command.
- * @param {BuildArgs} argv - The arguments passed to the command.
- */
-export function handler(argv) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const cliConfig = loadCliConfig(argv.config);
-        if (cliConfig.build && Array.isArray(cliConfig.build.commands)) {
-            for (const command of cliConfig.build.commands) {
-                yield command({ scConfig: cliConfig.config });
-            }
-        }
-        // Exit the process to avoid hanging the process by custom build commands
-        process.exit(0);
-    });
-}
+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());
+    });
+};
+import loadCliConfig from '../../utils/load-config';
+export const command = ['build', 'b'];
+export const describe = 'Performs build time automation';
+export const builder = {
+    config: {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats.',
+    },
+};
+/**
+ * Handler for the build command.
+ * @param {BuildArgs} argv - The arguments passed to the command.
+ */
+export function handler(argv) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cliConfig = loadCliConfig(argv.config);
+        if (cliConfig.build && Array.isArray(cliConfig.build.commands)) {
+            for (const command of cliConfig.build.commands) {
+                yield command({ scConfig: cliConfig.config });
+            }
+        }
+        // Exit the process to avoid hanging the process by custom build commands
+        process.exit(0);
+    });
+}

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

@@ -1,193 +1,198 @@
-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());
-    });
-};
-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 { handler as generateMapHandler } from './generate-map';
-import loadCliConfig from '../../../utils/load-config';
-let { getComponentSpec, getComponentList, getComponentSpecUrl } = tools;
-export const unitMocks = (toolsModule) => {
-    getComponentSpec = toolsModule.getComponentSpec;
-    getComponentList = toolsModule.getComponentList;
-    getComponentSpecUrl = toolsModule.getComponentSpecUrl;
-};
-/**
- * @param {Argv} yargs
- */
-export 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
- */
-export 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.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 { componentId, token, targetPath: targetPathArg, skipComponentMap, config, overwrite, } = argv;
-        console.log(chalk.green('Adding component'));
-        let targetPath = targetPathArg;
-        const cliConfig = loadCliConfig(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.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.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
-                        .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.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 "${componentSpecUrl}"`, {
-                stdio: 'inherit',
-                cwd: process.cwd(),
-            });
-            if (isFileAlreadyExists) {
-                fs.unlinkSync(backupPath);
-            }
-            if (!skipComponentMap) {
-                generateMapHandler({ config });
-            }
-            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: ${errorMessage}`));
-            return;
-        }
-    });
-}
+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());
+    });
+};
+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 { handler as generateMapHandler } from './generate-map';
+import loadCliConfig from '../../../utils/load-config';
+let { getComponentSpec, getComponentList, getComponentSpecUrl } = tools;
+export const unitMocks = (toolsModule) => {
+    getComponentSpec = toolsModule.getComponentSpec;
+    getComponentList = toolsModule.getComponentList;
+    getComponentSpecUrl = toolsModule.getComponentSpecUrl;
+};
+/**
+ * @param {Argv} yargs
+ */
+export 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
+ */
+export 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.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 { componentId, token, targetPath: targetPathArg, skipComponentMap, config, overwrite, } = argv;
+        console.log(chalk.green('Adding component'));
+        let targetPath = targetPathArg;
+        const cliConfig = loadCliConfig(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.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.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
+                        .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.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 "${componentSpecUrl}"`, {
+                stdio: 'inherit',
+                cwd: process.cwd(),
+            });
+            if (isFileAlreadyExists) {
+                fs.unlinkSync(backupPath);
+            }
+            if (!skipComponentMap) {
+                generateMapHandler({ config });
+            }
+            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: ${errorMessage}`));
+            return;
+        }
+    });
+}