@sitecore-content-sdk/cli 0.1.0-beta.4 → 0.1.0-beta.40

package/dist/cjs/bin/sitecore-tools.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const resolve_1 = __importDefault(require("resolve"));
+const process_env_1 = __importDefault(require("../utils/process-env"));
+const commands = __importStar(require("../scripts"));
+/**
+ * Resolves and executes the locally installed version of the sitecore content sdk CLI (sitecore-tools).
+ */
+(0, resolve_1.default)('@sitecore-content-sdk/cli', { basedir: process.cwd() }, (error, projectLocalCli) => {
+    let cli;
+    if (error) {
+        // If there is an error, resolve could not find the cli
+        // library from a package.json. Instead, include it from a relative
+        // path to this script file (which is likely a globally installed
+        // npm package).
+        // Not erroring here because we might use this in future for scaffolding.
+        cli = require('../cli').default;
+        console.warn('Sitecore Content SDK CLI is running in global mode because it was not installed in the local node_modules folder.');
+    }
+    else {
+        // No error implies a projectLocalCli, which will load whatever
+        // version of jss-cli you have installed in a local package.json
+        cli = require(projectLocalCli).default;
+        // Since we are in context of a project, load its environment variables
+        (0, process_env_1.default)(process.cwd());
+    }
+    cli(commands);
+});

package/dist/cjs/cli.js

@@ -30,7 +30,7 @@ process.on('unhandledRejection', (err) => {
 function cli(commands) {
     return __awaiter(this, void 0, void 0, function* () {
         let appCommands = yargs_1.default.usage('$0 <command>');
-        appCommands = appCommands.scriptName('jss');
+        appCommands = appCommands.scriptName('sitecore-tools');
         // Register commands if available
         if (commands && Object.keys(commands).length > 0) {
             for (const cmd of Object.keys(commands)) {

package/dist/cjs/scripts/build.js

@@ -0,0 +1,40 @@
+"use strict";
+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.builder = exports.describe = exports.command = void 0;
+exports.handler = handler;
+const load_config_1 = __importDefault(require("../utils/load-config"));
+exports.command = 'build';
+exports.describe = 'Handles build time automation';
+exports.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.
+ */
+function handler(argv) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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();
+            }
+        }
+    });
+}

package/dist/cjs/scripts/index.js

@@ -0,0 +1,42 @@
+"use strict";
+// commands available when running from an app location (with CLI installed to local node_modules)
+// e.g. setup, deploy
+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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scaffold = exports.build = void 0;
+const build = __importStar(require("./build"));
+exports.build = build;
+const scaffold = __importStar(require("./scaffold"));
+exports.scaffold = scaffold;

package/dist/cjs/scripts/scaffold.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.builder = builder;
+exports.args = args;
+exports.handler = handler;
+const tools_1 = require("@sitecore-content-sdk/core/tools");
+const load_config_1 = __importDefault(require("../utils/load-config"));
+const config_1 = require("@sitecore-content-sdk/core/config");
+/**
+ * @param {Argv} yargs
+ */
+function builder(yargs) {
+    return yargs.command('scaffold <componentName>', 'Scaffolds a new component. Use `sitecore-tools scaffold --help` for available options.', args, handler);
+}
+/**
+ * @param {Argv} yargs
+ */
+function args(yargs) {
+    return yargs
+        .positional('componentName', {
+        requiresArg: true,
+        positional: true,
+        type: 'string',
+        describe: `Name of the component to scaffold. Component name should start with an uppercase letter and contain only letters, numbers,
+dashes, or underscores. It can also contain slashes to indicate a subfolder. Example: MyComponent or MyFolder/MyComponent. If no subfolder is specified, the component will be created under 'src/components'.`,
+    })
+        .option('config', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
+    })
+        .option('templateName', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Name of the template that will be used to scaffold the component. Can be configured in the cli.config.',
+    })
+        .option('byoc', {
+        requiresArg: false,
+        type: 'boolean',
+        describe: 'If true, scaffolds a byoc component.',
+        default: false,
+    });
+}
+/**
+ * Handler for the scaffold command.
+ * @param {ScaffoldArgs} argv - The arguments passed to the command.
+ */
+function handler(argv) {
+    var _a;
+    if (!argv.componentName) {
+        throw new Error('Component name is required. Usage: sitecore-tools scaffold <ComponentName>');
+    }
+    const nameParamFormat = new RegExp(/^((?:[\w\-]+\/)*)([A-Z][\w-]+)$/);
+    const regExResult = nameParamFormat.exec(argv.componentName);
+    if (regExResult === null) {
+        throw new Error(`Component name should start with an uppercase letter and contain only letters, numbers,
+dashes, or underscores. It can also contain slashes to indicate a subfolder`);
+    }
+    const cliConfig = (0, load_config_1.default)(argv.config);
+    const componentPath = regExResult[1];
+    const componentName = regExResult[2];
+    const outputFolder = componentPath || 'src/components';
+    const templateName = (_a = argv.templateName) !== null && _a !== void 0 ? _a : (argv.byoc ? config_1.ComponentTemplateType.BYOC : config_1.ComponentTemplateType.DEFAULT);
+    (0, tools_1.scaffoldComponent)(outputFolder, componentName, templateName, cliConfig.scaffold.templates);
+}

package/dist/cjs/utils/load-config.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = loadCliConfig;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const process_env_1 = __importDefault(require("./process-env"));
+const tsx = require('tsx/cjs/api');
+/**
+ * Loads Sitecore Content SDK CLI configuration from the specified file.
+ * @param {string} [configFile] - The path to the configuration file.
+ * @returns {SitecoreCliConfig} The default export from the configuration file.
+ * @throws Will throw an error if the configuration file does not exist or does not have a default export.
+ */
+function loadCliConfig(configFile) {
+    // If no config file is provided, try to load the default config file.
+    if (!configFile) {
+        configFile = './sitecore.cli.config.ts';
+        if (!fs_1.default.existsSync(path_1.default.resolve(process.cwd(), configFile))) {
+            configFile = './sitecore.cli.config.js';
+        }
+    }
+    else {
+        // configuration file/filepath has been provided
+        // the env variables have been already loaded from the current working directory, however the current command may be running outside of a context of a project
+        // if so try loading the env vars from the directory of the provided config file
+        const configFileDirectory = path_1.default.dirname(path_1.default.resolve(process.cwd(), configFile));
+        if (process.cwd() !== configFileDirectory) {
+            (0, process_env_1.default)(configFileDirectory);
+        }
+    }
+    let cliConfig;
+    try {
+        cliConfig = tsx.require(path_1.default.resolve(process.cwd(), configFile), __filename);
+    }
+    catch (e) {
+        throw `Error while trying to load the cli configuration from ${configFile}. Error message: ${e.message}`;
+    }
+    return cliConfig.default;
+}

package/dist/esm/cli.js

@@ -24,7 +24,7 @@ process.on('unhandledRejection', (err) => {
 export default function cli(commands) {
     return __awaiter(this, void 0, void 0, function* () {
         let appCommands = yargs.usage('$0 <command>');
-        appCommands = appCommands.scriptName('jss');
+        appCommands = appCommands.scriptName('sitecore-tools');
         // Register commands if available
         if (commands && Object.keys(commands).length > 0) {
             for (const cmd of Object.keys(commands)) {

package/dist/esm/scripts/build.js

@@ -0,0 +1,33 @@
+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 = 'Handles 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();
+            }
+        }
+    });
+}

package/dist/esm/scripts/index.js

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

package/dist/esm/scripts/scaffold.js

@@ -0,0 +1,60 @@
+import { scaffoldComponent } from '@sitecore-content-sdk/core/tools';
+import loadCliConfig from '../utils/load-config';
+import { ComponentTemplateType } from '@sitecore-content-sdk/core/config';
+/**
+ * @param {Argv} yargs
+ */
+export function builder(yargs) {
+    return yargs.command('scaffold <componentName>', 'Scaffolds a new component. Use `sitecore-tools scaffold --help` for available options.', args, handler);
+}
+/**
+ * @param {Argv} yargs
+ */
+export function args(yargs) {
+    return yargs
+        .positional('componentName', {
+        requiresArg: true,
+        positional: true,
+        type: 'string',
+        describe: `Name of the component to scaffold. Component name should start with an uppercase letter and contain only letters, numbers,
+dashes, or underscores. It can also contain slashes to indicate a subfolder. Example: MyComponent or MyFolder/MyComponent. If no subfolder is specified, the component will be created under 'src/components'.`,
+    })
+        .option('config', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
+    })
+        .option('templateName', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Name of the template that will be used to scaffold the component. Can be configured in the cli.config.',
+    })
+        .option('byoc', {
+        requiresArg: false,
+        type: 'boolean',
+        describe: 'If true, scaffolds a byoc component.',
+        default: false,
+    });
+}
+/**
+ * Handler for the scaffold command.
+ * @param {ScaffoldArgs} argv - The arguments passed to the command.
+ */
+export function handler(argv) {
+    var _a;
+    if (!argv.componentName) {
+        throw new Error('Component name is required. Usage: sitecore-tools scaffold <ComponentName>');
+    }
+    const nameParamFormat = new RegExp(/^((?:[\w\-]+\/)*)([A-Z][\w-]+)$/);
+    const regExResult = nameParamFormat.exec(argv.componentName);
+    if (regExResult === null) {
+        throw new Error(`Component name should start with an uppercase letter and contain only letters, numbers,
+dashes, or underscores. It can also contain slashes to indicate a subfolder`);
+    }
+    const cliConfig = loadCliConfig(argv.config);
+    const componentPath = regExResult[1];
+    const componentName = regExResult[2];
+    const outputFolder = componentPath || 'src/components';
+    const templateName = (_a = argv.templateName) !== null && _a !== void 0 ? _a : (argv.byoc ? ComponentTemplateType.BYOC : ComponentTemplateType.DEFAULT);
+    scaffoldComponent(outputFolder, componentName, templateName, cliConfig.scaffold.templates);
+}

package/dist/esm/utils/load-config.js

@@ -0,0 +1,36 @@
+import path from 'path';
+import fs from 'fs';
+import processEnv from './process-env';
+const tsx = require('tsx/cjs/api');
+/**
+ * Loads Sitecore Content SDK CLI configuration from the specified file.
+ * @param {string} [configFile] - The path to the configuration file.
+ * @returns {SitecoreCliConfig} The default export from the configuration file.
+ * @throws Will throw an error if the configuration file does not exist or does not have a default export.
+ */
+export default function loadCliConfig(configFile) {
+    // If no config file is provided, try to load the default config file.
+    if (!configFile) {
+        configFile = './sitecore.cli.config.ts';
+        if (!fs.existsSync(path.resolve(process.cwd(), configFile))) {
+            configFile = './sitecore.cli.config.js';
+        }
+    }
+    else {
+        // configuration file/filepath has been provided
+        // the env variables have been already loaded from the current working directory, however the current command may be running outside of a context of a project
+        // if so try loading the env vars from the directory of the provided config file
+        const configFileDirectory = path.dirname(path.resolve(process.cwd(), configFile));
+        if (process.cwd() !== configFileDirectory) {
+            processEnv(configFileDirectory);
+        }
+    }
+    let cliConfig;
+    try {
+        cliConfig = tsx.require(path.resolve(process.cwd(), configFile), __filename);
+    }
+    catch (e) {
+        throw `Error while trying to load the cli configuration from ${configFile}. Error message: ${e.message}`;
+    }
+    return cliConfig.default;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/cli",
-  "version": "0.1.0-beta.4",
+  "version": "0.1.0-beta.40",
   "description": "Sitecore JSS command-line",
   "main": "dist/cjs/cli.js",
   "module": "dist/esm/cli.js",
@@ -13,7 +13,7 @@
     "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
     "clean": "del-cli dist types",
     "lint": "eslint \"./src/**/*.ts\"",
-    "jss": "node ./dist/cjs/bin/jss.js",
+    "sitecore-tools": "node ./dist/cjs/bin/sitecore-tools.js",
     "test": "mocha --require ts-node/register/transpile-only \"./src/**/*.test.ts\"",
     "coverage": "nyc --require ts-node/register/transpile-only npm test"
   },
@@ -22,7 +22,7 @@
   },
   "preferGlobal": true,
   "bin": {
-    "jss": "./dist/cjs/bin/jss.js"
+    "sitecore-tools": "./dist/cjs/bin/sitecore-tools.js"
   },
   "author": {
     "name": "Sitecore Corporation",
@@ -34,10 +34,12 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "dependencies": {
+    "@sitecore-content-sdk/core": "0.1.0-beta.40",
     "dotenv": "^16.4.7",
     "dotenv-expand": "^12.0.1",
     "resolve": "^1.22.10",
     "tmp": "^0.2.3",
+    "tsx": "^4.19.3",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
@@ -54,11 +56,12 @@
     "eslint": "^8.56.0",
     "mocha": "^11.1.0",
     "nyc": "^17.1.0",
+    "proxyquire": "^2.1.3",
     "sinon": "^19.0.2",
     "ts-node": "^10.9.1",
     "typescript": "~5.7.3"
   },
-  "gitHead": "cc71da011c0f83442d5d14d88b3bf483114b9013",
+  "gitHead": "90440a673c5d818a20218d8a0800bbd784caf924",
   "files": [
     "dist",
     "types"

package/types/scripts/build.d.ts

@@ -0,0 +1,24 @@
+export declare const command = "build";
+export declare const describe = "Handles build time automation";
+export declare const builder: {
+    config: {
+        requiresArg: boolean;
+        type: string;
+        describe: string;
+    };
+};
+/**
+ * The arguments for the build command.
+ */
+export type BuildArgs = {
+    /**
+     * Path to the `sitecore.cli.config` file.
+     * Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats.
+     */
+    config?: string;
+};
+/**
+ * Handler for the build command.
+ * @param {BuildArgs} argv - The arguments passed to the command.
+ */
+export declare function handler(argv: BuildArgs): Promise<void>;

package/types/scripts/index.d.ts

@@ -0,0 +1,3 @@
+import * as build from './build';
+import * as scaffold from './scaffold';
+export { build, scaffold };

package/types/scripts/scaffold.d.ts

@@ -0,0 +1,44 @@
+import { Argv } from 'yargs';
+/**
+ * @param {Argv} yargs
+ */
+export declare function builder(yargs: Argv<ScaffoldArgs>): Argv<ScaffoldArgs>;
+/**
+ * @param {Argv} yargs
+ */
+export declare function args(yargs: Argv<ScaffoldArgs>): Argv<import("yargs").Omit<import("yargs").Omit<import("yargs").Omit<import("yargs").Omit<ScaffoldArgs, "componentName"> & {
+    componentName: string | undefined;
+}, "config"> & {
+    config: string | undefined;
+}, "templateName"> & {
+    templateName: string | undefined;
+}, "byoc"> & {
+    byoc: boolean;
+}>;
+/**
+ * Arguments for the scaffold command.
+ */
+export type ScaffoldArgs = {
+    /**
+     * The name of the component to be scaffolded.
+     */
+    componentName: string;
+    /**
+     * Path to the `sitecore.cli.config` file.
+     * Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats.
+     */
+    config?: string;
+    /**
+     * The name of the template to use for scaffolding.
+     */
+    templateName?: string;
+    /**
+     * Indicates whether to scaffold a BYOC type component.
+     */
+    byoc?: boolean;
+};
+/**
+ * Handler for the scaffold command.
+ * @param {ScaffoldArgs} argv - The arguments passed to the command.
+ */
+export declare function handler(argv: ScaffoldArgs): void;

package/types/utils/load-config.d.ts

@@ -0,0 +1,8 @@
+import { SitecoreCliConfig } from '@sitecore-content-sdk/core/types/config';
+/**
+ * Loads Sitecore Content SDK CLI configuration from the specified file.
+ * @param {string} [configFile] - The path to the configuration file.
+ * @returns {SitecoreCliConfig} The default export from the configuration file.
+ * @throws Will throw an error if the configuration file does not exist or does not have a default export.
+ */
+export default function loadCliConfig(configFile?: string): SitecoreCliConfig;

package/dist/cjs/bin/jss.js

@@ -1,19 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const resolve_1 = __importDefault(require("resolve"));
-const process_env_1 = __importDefault(require("../utils/process-env"));
-/**
- * Resolves and executes the locally installed version of the JSS CLI.
- */
-(0, resolve_1.default)('@sitecore-content-sdk/cli', { basedir: process.cwd() }, (_, projectLocalCli) => {
-    // No error implies a projectLocalCli, which will load whatever
-    // version of jss-cli you have installed in a local package.json
-    const cli = require(projectLocalCli).default;
-    // Since we are in context of a project, load its environment variables
-    (0, process_env_1.default)(process.cwd());
-    cli();
-});