@sitecore-content-sdk/cli 1.2.0-canary.9 → 1.3.0-canary.2

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

@@ -33,7 +33,7 @@ function handler(argv) {
         const cliConfig = (0, load_config_1.default)(argv.config);
         if (cliConfig.build && Array.isArray(cliConfig.build.commands)) {
             for (const command of cliConfig.build.commands) {
-                yield command();
+                yield command({ scConfig: cliConfig.config });
             }
         }
         // Exit the process to avoid hanging the process by custom build commands

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

@@ -0,0 +1,184 @@
+"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 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 unitMocks = (toolsModule) => {
+    getComponentVariantSpec = toolsModule.getComponentVariantSpec;
+    getComponentList = toolsModule.getComponentList;
+    getComponentVariantSpecUrl = toolsModule.getComponentVariantSpecUrl;
+};
+exports.unitMocks = unitMocks;
+/**
+ * @param {Argv} yargs
+ */
+function args(yargs) {
+    /* istanbul ignore next */
+    return yargs
+        .positional('variantId', {
+        requiresArg: true,
+        positional: true,
+        type: 'string',
+        describe: `The unique identifier of the newly created variant.`,
+    })
+        .option('token', {
+        requiresArg: true,
+        type: 'string',
+        describe: 'The authentication token.',
+        demandOption: true,
+    })
+        .option('target-path', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'The target path for the component variant.',
+    })
+        .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 <variant-id>', 'Adds a component variant', args, handler);
+}
+/**
+ * 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'));
+        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;
+        try {
+            const spec = yield getComponentVariantSpec({
+                edgeUrl,
+                variantId,
+                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 variant.\nThe filename must follow the format: {componentName}.{variantName}.{extension}\n(example: src/components/MyComponent/MyComponent.variantA.ts):`,
+                    })
+                        .then((answer) => answer.targetPath);
+                }
+            }
+            const variantSpecUrl = getComponentVariantSpecUrl({
+                variantId,
+                targetPath: targetPath,
+                edgeUrl,
+                token,
+            });
+            (0, child_process_1.execSync)(`npx shadcn@^3.4.2 add "${variantSpecUrl}"${overwrite ? ' --overwrite' : ''}`, {
+                stdio: 'inherit',
+                cwd: process.cwd(),
+            });
+            if (!skipComponentMap) {
+                (0, generate_map_1.handler)({ config });
+            }
+            console.log(chalk_1.default.green(`Component variant ${variantName} added successfully`));
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            console.error(chalk_1.default.red(`Failed to add component variant: ${errorMessage}`));
+            return;
+        }
+    });
+}

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

@@ -42,13 +42,27 @@ function handler(argv) {
         return;
     }
     const componentMapGenerator = cliConfig.componentMap.generator;
-    const { paths, destination, componentImports, exclude } = cliConfig.componentMap;
+    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 }));
+        (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 });
+        componentMapGenerator({
+            paths,
+            destination,
+            componentImports,
+            exclude,
+            clientComponentMap,
+            includeVariants,
+        });
     }
 }

package/dist/cjs/utils/process-env.js

@@ -40,6 +40,7 @@ exports.default = processEnv;
 const path_1 = __importDefault(require("path"));
 const dotenv = __importStar(require("dotenv"));
 const dotenv_expand_1 = __importDefault(require("dotenv-expand"));
+const config_cli_1 = require("@sitecore-content-sdk/core/config-cli");
 /**
  * Loads and processes environment variables from `.env` files in the specified directory.
  * It supports multiple `.env` files, including
@@ -60,6 +61,8 @@ function processEnv(dir) {
         mode && `.env.${mode}`,
         '.env',
     ].filter(Boolean);
+    // Set the environment variable to indicate that the application is running in CLI mode
+    process.env[config_cli_1.SITECORE_CLI_MODE_ENV_VAR] = 'true';
     // inspired by https://github.com/entropitor/dotenv-cli/blob/v4.0.0/cli.js#L53-L55
     dotenvFiles.forEach(function (env) {
         dotenv_expand_1.default.expand(dotenv.config({ path: path_1.default.resolve(dir, env) }));

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

@@ -26,7 +26,7 @@ export function handler(argv) {
         const cliConfig = loadCliConfig(argv.config);
         if (cliConfig.build && Array.isArray(cliConfig.build.commands)) {
             for (const command of cliConfig.build.commands) {
-                yield command();
+                yield command({ scConfig: cliConfig.config });
             }
         }
         // Exit the process to avoid hanging the process by custom build commands

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

@@ -0,0 +1,141 @@
+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 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;
+export const unitMocks = (toolsModule) => {
+    getComponentVariantSpec = toolsModule.getComponentVariantSpec;
+    getComponentList = toolsModule.getComponentList;
+    getComponentVariantSpecUrl = toolsModule.getComponentVariantSpecUrl;
+};
+/**
+ * @param {Argv} yargs
+ */
+export function args(yargs) {
+    /* istanbul ignore next */
+    return yargs
+        .positional('variantId', {
+        requiresArg: true,
+        positional: true,
+        type: 'string',
+        describe: `The unique identifier of the newly created variant.`,
+    })
+        .option('token', {
+        requiresArg: true,
+        type: 'string',
+        describe: 'The authentication token.',
+        demandOption: true,
+    })
+        .option('target-path', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'The target path for the component variant.',
+    })
+        .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 <variant-id>', 'Adds a component variant', args, handler);
+}
+/**
+ * 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'));
+        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;
+        try {
+            const spec = yield getComponentVariantSpec({
+                edgeUrl,
+                variantId,
+                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 variant.\nThe filename must follow the format: {componentName}.{variantName}.{extension}\n(example: src/components/MyComponent/MyComponent.variantA.ts):`,
+                    })
+                        .then((answer) => answer.targetPath);
+                }
+            }
+            const variantSpecUrl = getComponentVariantSpecUrl({
+                variantId,
+                targetPath: targetPath,
+                edgeUrl,
+                token,
+            });
+            execSync(`npx shadcn@^3.4.2 add "${variantSpecUrl}"${overwrite ? ' --overwrite' : ''}`, {
+                stdio: 'inherit',
+                cwd: process.cwd(),
+            });
+            if (!skipComponentMap) {
+                generateMapHandler({ config });
+            }
+            console.log(chalk.green(`Component variant ${variantName} added successfully`));
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            console.error(chalk.red(`Failed to add component variant: ${errorMessage}`));
+            return;
+        }
+    });
+}

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

@@ -34,13 +34,27 @@ export function handler(argv) {
         return;
     }
     const componentMapGenerator = cliConfig.componentMap.generator;
-    const { paths, destination, componentImports, exclude } = cliConfig.componentMap;
+    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')}`);
-        watchItems(paths, componentMapGenerator.bind(null, { paths, destination, componentImports, exclude }));
+        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 });
+        componentMapGenerator({
+            paths,
+            destination,
+            componentImports,
+            exclude,
+            clientComponentMap,
+            includeVariants,
+        });
     }
 }

package/dist/esm/utils/process-env.js

@@ -1,6 +1,7 @@
 import path from 'path';
 import * as dotenv from 'dotenv';
 import dotenvExpand from 'dotenv-expand';
+import { SITECORE_CLI_MODE_ENV_VAR } from '@sitecore-content-sdk/core/config-cli';
 /**
  * Loads and processes environment variables from `.env` files in the specified directory.
  * It supports multiple `.env` files, including
@@ -21,6 +22,8 @@ export default function processEnv(dir) {
         mode && `.env.${mode}`,
         '.env',
     ].filter(Boolean);
+    // Set the environment variable to indicate that the application is running in CLI mode
+    process.env[SITECORE_CLI_MODE_ENV_VAR] = 'true';
     // inspired by https://github.com/entropitor/dotenv-cli/blob/v4.0.0/cli.js#L53-L55
     dotenvFiles.forEach(function (env) {
         dotenvExpand.expand(dotenv.config({ path: path.resolve(dir, env) }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/cli",
-  "version": "1.2.0-canary.9",
+  "version": "1.3.0-canary.2",
   "description": "Sitecore Content SDK CLI",
   "main": "dist/cjs/cli.js",
   "module": "dist/esm/cli.js",
@@ -34,10 +34,11 @@
     "url": "https://github.com/sitecore/content-sdk/issues"
   },
   "dependencies": {
-    "@sitecore-content-sdk/core": "1.2.0-canary.9",
+    "@sitecore-content-sdk/core": "1.3.0-canary.2",
     "chokidar": "^4.0.3",
     "dotenv": "^16.5.0",
     "dotenv-expand": "^12.0.2",
+    "inquirer": "^12.9.6",
     "resolve": "^1.22.10",
     "tmp": "^0.2.3",
     "tsx": "^4.19.4",
@@ -46,6 +47,7 @@
   "devDependencies": {
     "@stylistic/eslint-plugin": "^5.2.2",
     "@types/chai": "^5.2.2",
+    "@types/inquirer": "^9.0.9",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.15.13",
     "@types/resolve": "^1.20.6",
@@ -69,7 +71,7 @@
     "ts-node": "^10.9.1",
     "typescript": "~5.8.3"
   },
-  "gitHead": "32072423128e5b9fce1a78f461ddace7ea06ab07",
+  "gitHead": "8daa222f701d12815256314f861d9b79ada1fc1b",
   "files": [
     "dist",
     "types"

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

@@ -0,0 +1,58 @@
+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;
+type AddArgs = {
+    /**
+     * The unique identifier of the newly created variant.
+     */
+    variantId: string;
+    /**
+     * The authentication token.
+     */
+    token: string;
+    /**
+     * The target path for the component variant.
+     */
+    targetPath?: string;
+    /**
+     * If true, skips the component map generation.
+     * Default: false.
+     */
+    skipComponentMap?: boolean;
+    /**
+     * If true, overwrites the existing component.
+     * Default: false.
+     */
+    overwrite?: boolean;
+    /**
+     * Path to the `sitecore.cli.config` file.
+     * Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats.
+     */
+    config?: string;
+};
+/**
+ * @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;
+}, "token"> & {
+    token: string;
+} & {
+    "target-path": string | undefined;
+} & {
+    "skip-component-map": boolean;
+}, "overwrite"> & {
+    overwrite: boolean;
+}, "config"> & {
+    config: string | undefined;
+}>;
+/**
+ * @param {Argv} yargs
+ */
+export declare function builder(yargs: Argv<AddArgs>): Argv<AddArgs>;
+/**
+ * Handler for the add command.
+ * @param {AddArgs} argv - The arguments passed to the command.
+ */
+export declare function handler(argv: AddArgs): Promise<void>;
+export {};