@sitecore-content-sdk/core 1.3.0-canary.9 → 1.4.0-canary.2

package/dist/cjs/tools/generate-map.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/tools/generateMetadata.js

@@ -1,35 +1,36 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateMetadata = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const metadata_1 = require("../editing/metadata");
-const ensurePath_1 = require("../utils/ensurePath");
-/**
- * Generate application metadata
- * @param {GenerateMetadataConfig} config - Optional configuration for generating metadata.
- * If not provided, the default '.sitecore/metadata.json' will be used and allowWorkspaces will be set to false.
- * @returns {Promise<void>} A promise that resolves when the metadata generation is complete.
- */
-const generateMetadata = (config) => {
-    return async () => {
-        var _a;
-        const metadata = (0, metadata_1.getMetadata)(!!(config === null || config === void 0 ? void 0 : config.allowWorkspaces));
-        writeMetadata(metadata, (_a = config === null || config === void 0 ? void 0 : config.destinationPath) !== null && _a !== void 0 ? _a : '.sitecore/metadata.json');
-    };
-};
-exports.generateMetadata = generateMetadata;
-/**
- * Writes the metadata object to disk.
- * @param {Metadata} metadata metadata to write.
- * @param {string} destinationPath path to write the metadata to.
- */
-function writeMetadata(metadata, destinationPath) {
-    const filePath = path_1.default.resolve(destinationPath);
-    (0, ensurePath_1.ensurePathExists)(filePath);
-    console.log(`Writing metadata to ${filePath}`);
-    fs_1.default.writeFileSync(filePath, JSON.stringify(metadata, null, 2), { encoding: 'utf8' });
-}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMetadata = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const metadata_1 = require("../editing/metadata");
+const ensurePath_1 = require("../utils/ensurePath");
+/**
+ * Generate application metadata
+ * @param {GenerateMetadataConfig} config - Optional configuration for generating metadata.
+ * If not provided, the default '.sitecore/metadata.json' will be used and allowWorkspaces will be set to false.
+ * @returns {Promise<void>} A promise that resolves when the metadata generation is complete.
+ * @public
+ */
+const generateMetadata = (config) => {
+    return async () => {
+        var _a;
+        const metadata = (0, metadata_1.getMetadata)(!!(config === null || config === void 0 ? void 0 : config.allowWorkspaces));
+        writeMetadata(metadata, (_a = config === null || config === void 0 ? void 0 : config.destinationPath) !== null && _a !== void 0 ? _a : '.sitecore/metadata.json');
+    };
+};
+exports.generateMetadata = generateMetadata;
+/**
+ * Writes the metadata object to disk.
+ * @param {Metadata} metadata metadata to write.
+ * @param {string} destinationPath path to write the metadata to.
+ */
+function writeMetadata(metadata, destinationPath) {
+    const filePath = path_1.default.resolve(destinationPath);
+    (0, ensurePath_1.ensurePathExists)(filePath);
+    console.log(`Writing metadata to ${filePath}`);
+    fs_1.default.writeFileSync(filePath, JSON.stringify(metadata, null, 2), { encoding: 'utf8' });
+}

package/dist/cjs/tools/generateSites.js

@@ -1,58 +1,59 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateSites = void 0;
-const path_1 = __importDefault(require("path"));
-const chalk_1 = __importDefault(require("chalk"));
-const fs_1 = __importDefault(require("fs"));
-const debug_1 = __importDefault(require("../debug"));
-const site_1 = require("../site");
-const ensurePath_1 = require("../utils/ensurePath");
-const client_1 = require("../client");
-const DEFAULT_SITES_DIST_PATH = '.sitecore/sites.json';
-/**
- * Generates site information and writes it to a specified destination path.
- * @param {GenerateSitesConfig} config - The configuration for generating site info.
- * @returns {Promise<Function>} - A promise that resolves to an asynchronous function that fetches site information and writes it to a file.
- */
-const generateSites = ({ scConfig: deprecatedScConfig, destinationPath, } = {}) => {
-    return async ({ scConfig } = {}) => {
-        const config = deprecatedScConfig !== null && deprecatedScConfig !== void 0 ? deprecatedScConfig : scConfig;
-        if (!config) {
-            throw new Error('Sitecore configuration is required to be provided');
-        }
-        let sites = [];
-        const sitesFilePath = path_1.default.resolve(destinationPath !== null && destinationPath !== void 0 ? destinationPath : DEFAULT_SITES_DIST_PATH);
-        debug_1.default.multisite(config.multisite.enabled
-            ? 'Multisite Enabled: Generating site information'
-            : 'Multisite Disabled');
-        if (config.multisite.enabled) {
-            try {
-                const siteInfoService = new site_1.SiteInfoService({
-                    clientFactory: (0, client_1.createGraphQLClientFactory)({
-                        api: config.api,
-                        retries: config.retries.count,
-                        retryStrategy: config.retries.retryStrategy,
-                    }),
-                });
-                sites = await siteInfoService.fetchSiteInfo();
-            }
-            catch (error) {
-                console.error(chalk_1.default.red('Error fetching site information'));
-                throw error;
-            }
-        }
-        // Add default site to the list
-        const defaultSite = {
-            name: config.defaultSite,
-            hostName: '*',
-            language: config.defaultLanguage,
-        };
-        sites.unshift(defaultSite);
-        (0, ensurePath_1.ensurePathExists)(sitesFilePath);
-        fs_1.default.writeFileSync(sitesFilePath, JSON.stringify(sites, null, 2), { encoding: 'utf8' });
-    };
-};
-exports.generateSites = generateSites;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSites = void 0;
+const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const fs_1 = __importDefault(require("fs"));
+const debug_1 = __importDefault(require("../debug"));
+const site_1 = require("../site");
+const ensurePath_1 = require("../utils/ensurePath");
+const client_1 = require("../client");
+const DEFAULT_SITES_DIST_PATH = '.sitecore/sites.json';
+/**
+ * Generates site information and writes it to a specified destination path.
+ * @param {GenerateSitesConfig} config - The configuration for generating site info.
+ * @returns {Promise<Function>} - A promise that resolves to an asynchronous function that fetches site information and writes it to a file.
+ * @public
+ */
+const generateSites = ({ scConfig: deprecatedScConfig, destinationPath, } = {}) => {
+    return async ({ scConfig } = {}) => {
+        const config = deprecatedScConfig !== null && deprecatedScConfig !== void 0 ? deprecatedScConfig : scConfig;
+        if (!config) {
+            throw new Error('Sitecore configuration is required to be provided');
+        }
+        let sites = [];
+        const sitesFilePath = path_1.default.resolve(destinationPath !== null && destinationPath !== void 0 ? destinationPath : DEFAULT_SITES_DIST_PATH);
+        debug_1.default.multisite(config.multisite.enabled
+            ? 'Multisite Enabled: Generating site information'
+            : 'Multisite Disabled');
+        if (config.multisite.enabled) {
+            try {
+                const siteInfoService = new site_1.SiteInfoService({
+                    clientFactory: (0, client_1.createGraphQLClientFactory)({
+                        api: config.api,
+                        retries: config.retries.count,
+                        retryStrategy: config.retries.retryStrategy,
+                    }),
+                });
+                sites = await siteInfoService.fetchSiteInfo();
+            }
+            catch (error) {
+                console.error(chalk_1.default.red('Error fetching site information'));
+                throw error;
+            }
+        }
+        // Add default site to the list
+        const defaultSite = {
+            name: config.defaultSite,
+            hostName: '*',
+            language: config.defaultLanguage,
+        };
+        sites.unshift(defaultSite);
+        (0, ensurePath_1.ensurePathExists)(sitesFilePath);
+        fs_1.default.writeFileSync(sitesFilePath, JSON.stringify(sites, null, 2), { encoding: 'utf8' });
+    };
+};
+exports.generateSites = generateSites;

package/dist/cjs/tools/index.js

@@ -1,73 +1,75 @@
-"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-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.auth = exports.getComponentSpecUrl = exports.getComponentSpec = exports.writeImportMap = exports.extractFiles = exports.scaffoldComponent = exports.generateMetadata = exports.generateSites = void 0;
-var generateSites_1 = require("./generateSites");
-Object.defineProperty(exports, "generateSites", { enumerable: true, get: function () { return generateSites_1.generateSites; } });
-var generateMetadata_1 = require("./generateMetadata");
-Object.defineProperty(exports, "generateMetadata", { enumerable: true, get: function () { return generateMetadata_1.generateMetadata; } });
-var scaffold_1 = require("./scaffold");
-Object.defineProperty(exports, "scaffoldComponent", { enumerable: true, get: function () { return scaffold_1.scaffoldComponent; } });
-var extract_files_1 = require("./codegen/extract-files");
-Object.defineProperty(exports, "extractFiles", { enumerable: true, get: function () { return extract_files_1.extractFiles; } });
-var import_map_1 = require("./codegen/import-map");
-Object.defineProperty(exports, "writeImportMap", { enumerable: true, get: function () { return import_map_1.writeImportMap; } });
-var component_generation_1 = require("./codegen/component-generation");
-Object.defineProperty(exports, "getComponentSpec", { enumerable: true, get: function () { return component_generation_1.getComponentSpec; } });
-Object.defineProperty(exports, "getComponentSpecUrl", { enumerable: true, get: function () { return component_generation_1.getComponentSpecUrl; } });
-__exportStar(require("./templating"), exports);
-__exportStar(require("./auth/models"), exports);
-const authModule = __importStar(require("./auth"));
-/**
- * Preserve "live binding" semantics similar to ES module imports: production
- * code always sees the current implementation; tests can swap it safely and
- * restore via `sandbox.restore()` with no hidden global state.
- *
- * Public surface consumed by the rest of the codebase.
- */
-exports.auth = {};
-/*
- * Define an accessor so reads are dynamic
- *   - Production: returns the real `authModule.clientCredentialsFlow`.
- *   - Tests: can be replaced with a stub via `sinon.replaceGetter` or `sandbox.replaceGetter`
- */
-Object.defineProperty(exports.auth, 'clientCredentialsFlow', {
-    get: () => authModule.clientCredentialsFlow,
-    configurable: true,
-    enumerable: true,
-});
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+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.auth = exports.getComponentSpecUrl = exports.getComponentSpec = exports.defaultImportMapTemplate = exports.writeImportMap = exports.extractFiles = exports.scaffoldComponent = exports.generateMetadata = exports.generateSites = void 0;
+var generateSites_1 = require("./generateSites");
+Object.defineProperty(exports, "generateSites", { enumerable: true, get: function () { return generateSites_1.generateSites; } });
+var generateMetadata_1 = require("./generateMetadata");
+Object.defineProperty(exports, "generateMetadata", { enumerable: true, get: function () { return generateMetadata_1.generateMetadata; } });
+var scaffold_1 = require("./scaffold");
+Object.defineProperty(exports, "scaffoldComponent", { enumerable: true, get: function () { return scaffold_1.scaffoldComponent; } });
+var extract_files_1 = require("./codegen/extract-files");
+Object.defineProperty(exports, "extractFiles", { enumerable: true, get: function () { return extract_files_1.extractFiles; } });
+var import_map_1 = require("./codegen/import-map");
+Object.defineProperty(exports, "writeImportMap", { enumerable: true, get: function () { return import_map_1.writeImportMap; } });
+Object.defineProperty(exports, "defaultImportMapTemplate", { enumerable: true, get: function () { return import_map_1.defaultMapTemplate; } });
+var component_generation_1 = require("./codegen/component-generation");
+Object.defineProperty(exports, "getComponentSpec", { enumerable: true, get: function () { return component_generation_1.getComponentSpec; } });
+Object.defineProperty(exports, "getComponentSpecUrl", { enumerable: true, get: function () { return component_generation_1.getComponentSpecUrl; } });
+__exportStar(require("./templating"), exports);
+__exportStar(require("./auth/models"), exports);
+const authModule = __importStar(require("./auth"));
+/**
+ * Preserve "live binding" semantics similar to ES module imports: production
+ * code always sees the current implementation; tests can swap it safely and
+ * restore via `sandbox.restore()` with no hidden global state.
+ *
+ * Public surface consumed by the rest of the codebase.
+ * @public
+ */
+exports.auth = {};
+/*
+ * Define an accessor so reads are dynamic
+ *   - Production: returns the real `authModule.clientCredentialsFlow`.
+ *   - Tests: can be replaced with a stub via `sinon.replaceGetter` or `sandbox.replaceGetter`
+ */
+Object.defineProperty(exports.auth, 'clientCredentialsFlow', {
+    get: () => authModule.clientCredentialsFlow,
+    configurable: true,
+    enumerable: true,
+});

package/dist/cjs/tools/scaffold.js

@@ -1,61 +1,62 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.editLineEndings = editLineEndings;
-exports.scaffoldFile = scaffoldFile;
-exports.scaffoldComponent = scaffoldComponent;
-const fs_1 = __importDefault(require("fs"));
-const chalk_1 = __importDefault(require("chalk"));
-const path_1 = __importDefault(require("path"));
-/**
- * Force to use `crlf` line endings, we are using `crlf` across the project.
- * Replace: `lf` (\n), `cr` (\r)
- * @param {string} content
- */
-function editLineEndings(content) {
-    return content.replace(/\r|\n/gm, '\r\n');
-}
-/**
- * Creates a file relative to the specified path if the file doesn't exist.
- * Creates directories as needed.
- * Does not overwrite existing files.
- * @param {string} filePath - the file path
- * @param {string} fileContent - the file content
- * @returns {string} the file path if the file was created, otherwise null
- */
-function scaffoldFile(filePath, fileContent) {
-    const outputDir = path_1.default.dirname(filePath);
-    if (fs_1.default.existsSync(filePath)) {
-        console.log(chalk_1.default.red(`Skipping creating ${filePath}; already exists.`));
-        return null;
-    }
-    fs_1.default.mkdirSync(outputDir, { recursive: true });
-    fs_1.default.writeFileSync(filePath, editLineEndings(fileContent), 'utf8');
-    console.log(chalk_1.default.green(`File ${filePath} has been scaffolded.`));
-    return filePath;
-}
-/**
- * Scaffolds a new component based on the provided template.
- * @param {string} outputFolderPath - The file path where the component will be created.
- * @param {string} componentName - The name of the component to be created.
- * @param {string} templateName - The name of the template to use for scaffolding. If not provided, defaults to 'byoc' if `byoc` is true, otherwise 'default'.
- * @param {ScaffoldTemplate[]} templates - An array of template objects, each containing a name, a template function, and a getNextSteps function.
- * @throws Will throw an error if the specified template is not found.
- */
-function scaffoldComponent(outputFolderPath, componentName, templateName, templates) {
-    const template = templates.find((t) => t.name === templateName);
-    if (!template) {
-        throw new Error(`Template ${templateName} not found.`);
-    }
-    const outputFilePath = path_1.default.join(outputFolderPath, `${componentName}.${template.fileExtension}`);
-    const componentOutputPath = scaffoldFile(outputFilePath, template.generateTemplate(componentName));
-    if (componentOutputPath) {
-        const nextSteps = [];
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.editLineEndings = editLineEndings;
+exports.scaffoldFile = scaffoldFile;
+exports.scaffoldComponent = scaffoldComponent;
+const fs_1 = __importDefault(require("fs"));
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Force to use `crlf` line endings, we are using `crlf` across the project.
+ * Replace: `lf` (\n), `cr` (\r)
+ * @param {string} content
+ */
+function editLineEndings(content) {
+    return content.replace(/\r|\n/gm, '\r\n');
+}
+/**
+ * Creates a file relative to the specified path if the file doesn't exist.
+ * Creates directories as needed.
+ * Does not overwrite existing files.
+ * @param {string} filePath - the file path
+ * @param {string} fileContent - the file content
+ * @returns {string} the file path if the file was created, otherwise null
+ */
+function scaffoldFile(filePath, fileContent) {
+    const outputDir = path_1.default.dirname(filePath);
+    if (fs_1.default.existsSync(filePath)) {
+        console.log(chalk_1.default.red(`Skipping creating ${filePath}; already exists.`));
+        return null;
+    }
+    fs_1.default.mkdirSync(outputDir, { recursive: true });
+    fs_1.default.writeFileSync(filePath, editLineEndings(fileContent), 'utf8');
+    console.log(chalk_1.default.green(`File ${filePath} has been scaffolded.`));
+    return filePath;
+}
+/**
+ * Scaffolds a new component based on the provided template.
+ * @param {string} outputFolderPath - The file path where the component will be created.
+ * @param {string} componentName - The name of the component to be created.
+ * @param {string} templateName - The name of the template to use for scaffolding. If not provided, defaults to 'byoc' if `byoc` is true, otherwise 'default'.
+ * @param {ScaffoldTemplate[]} templates - An array of template objects, each containing a name, a template function, and a getNextSteps function.
+ * @throws Will throw an error if the specified template is not found.
+ * @internal
+ */
+function scaffoldComponent(outputFolderPath, componentName, templateName, templates) {
+    const template = templates.find((t) => t.name === templateName);
+    if (!template) {
+        throw new Error(`Template ${templateName} not found.`);
+    }
+    const outputFilePath = path_1.default.join(outputFolderPath, `${componentName}.${template.fileExtension}`);
+    const componentOutputPath = scaffoldFile(outputFilePath, template.generateTemplate(componentName));
+    if (componentOutputPath) {
+        const nextSteps = [];
         nextSteps.push(chalk_1.default.green(`
     Scaffolding of ${componentName} complete.
-    Next steps:`), ...(template.getNextSteps ? template.getNextSteps(componentOutputPath) : []));
-        console.log(nextSteps.join('\n'));
-    }
-}
+    Next steps:`), ...(template.getNextSteps ? template.getNextSteps(componentOutputPath) : []));
+        console.log(nextSteps.join('\n'));
+    }
+}