@sitecore-jss/sitecore-jss-dev-tools 0.1.0-beta.2

package/LICENSE.txt

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

package/README.md

@@ -0,0 +1,12 @@
+# Sitecore JavaScript Rendering SDK Developer Tools
+
+This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains developer tooling such as scripts concerning metadata, scaffolding components, component builder.
+
+<!---
+@TODO: Update to next version docs before release
+-->
+[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/21/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html)
+
+[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdks--jss-.html)
+
+[API reference documentation](/ref-docs/sitecore-jss-dev-tools/)

package/dist/cjs/index.js

@@ -0,0 +1,17 @@
+"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 __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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./templating"), exports);

package/dist/cjs/templating/components.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getComponentList = void 0;
+const utils_1 = require("./utils");
+/**
+ * Get list of components from @var path
+ * Returns a list of components in the following format:
+ * {
+ *  path: 'path/to/component',
+ *  componentName: 'ComponentName',
+ *  moduleName: 'ComponentName'
+ * }
+ * @param {string} path path to search
+ */
+function getComponentList(path) {
+    const components = (0, utils_1.getItems)({
+        path,
+        resolveItem: (path, name) => ({
+            path: `${path}/${name}`,
+            componentName: name,
+            moduleName: name.replace(/[^\w]+/g, ''),
+        }),
+        cb: (name) => console.debug(`Registering JSS component ${name}`),
+    });
+    return components;
+}
+exports.getComponentList = getComponentList;

package/dist/cjs/templating/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetadata = exports.scaffoldFile = exports.ModuleType = exports.generatePlugins = exports.getComponentList = void 0;
+var components_1 = require("./components");
+Object.defineProperty(exports, "getComponentList", { enumerable: true, get: function () { return components_1.getComponentList; } });
+var plugins_1 = require("./plugins");
+Object.defineProperty(exports, "generatePlugins", { enumerable: true, get: function () { return plugins_1.generatePlugins; } });
+Object.defineProperty(exports, "ModuleType", { enumerable: true, get: function () { return plugins_1.ModuleType; } });
+var scaffold_1 = require("./scaffold");
+Object.defineProperty(exports, "scaffoldFile", { enumerable: true, get: function () { return scaffold_1.scaffoldFile; } });
+var metadata_1 = require("./metadata");
+Object.defineProperty(exports, "getMetadata", { enumerable: true, get: function () { return metadata_1.getMetadata; } });

package/dist/cjs/templating/metadata.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetadata = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Get application metadata
+ */
+function getMetadata() {
+    const metadata = { packages: {} };
+    const trackedScopes = ['@sitecore', '@sitecore-cloudsdk', '@sitecore-feaas', '@sitecore-jss'];
+    const dirs = fs_1.default.readdirSync('node_modules');
+    dirs.forEach((dir) => {
+        if (trackedScopes.includes(dir)) {
+            const packageNames = fs_1.default.readdirSync(path_1.default.join('node_modules', dir));
+            packageNames.forEach((pkg) => {
+                try {
+                    const json = JSON.parse(fs_1.default.readFileSync(path_1.default.join('node_modules', dir, pkg, 'package.json'), 'utf8'));
+                    metadata.packages[json.name] = json.version;
+                }
+                catch (e) {
+                    console.error(`Failed to read/parse package.json for ${pkg}`, e);
+                }
+            });
+        }
+    });
+    return metadata;
+}
+exports.getMetadata = getMetadata;

package/dist/cjs/templating/nextjs/generate-component-builder.js

@@ -0,0 +1,72 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeComponentBuilder = exports.watchComponentBuilder = exports.generateComponentBuilder = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const component_builder_1 = require("./templates/component-builder");
+const components_1 = require("../components");
+const utils_1 = require("../utils");
+// Default destination path for component builder
+const defaultComponentBuilderOutputPath = 'src/temp/componentBuilder.ts';
+const defaultComponentRootPath = 'src/components';
+/**
+ * Generate component builder based on provided settings
+ * @param {Object} [settings] settings for component builder generation
+ * @param {string} [settings.componentRootPath] path to components root
+ * @param {string} [settings.componentBuilderOutputPath] path to component builder output
+ * @param {PackageDefinition[]} [settings.packages] list of packages to include in component builder
+ * @param {ComponentFile[]} [settings.components] list of components to include in component builder
+ * @param {boolean} [settings.watch] whether to watch for changes to component builder sources
+ */
+function generateComponentBuilder({ componentRootPath = defaultComponentRootPath, componentBuilderOutputPath = defaultComponentBuilderOutputPath, packages = [], components = [], watch, } = {}) {
+    if (watch) {
+        watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components });
+    }
+    else {
+        writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components });
+    }
+}
+exports.generateComponentBuilder = generateComponentBuilder;
+/**
+ * Watch for changes to component builder sources
+ * @param {Object} settings settings for component builder generation
+ * @param {string} settings.componentRootPath path to components root
+ * @param {string} settings.componentBuilderOutputPath path to component builder output
+ * @param {PackageDefinition[]} settings.packages list of packages to include in component builder
+ * @param {ComponentFile[]} settings.components list of components to include in component builder
+ */
+function watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components, }) {
+    console.log(`Watching for changes to component builder sources in ${componentRootPath}...`);
+    (0, utils_1.watchItems)([componentRootPath], writeComponentBuilder.bind(null, {
+        componentRootPath,
+        componentBuilderOutputPath,
+        packages,
+        components,
+    }));
+}
+exports.watchComponentBuilder = watchComponentBuilder;
+/**
+ * Write component builder to file
+ * @param {Object} settings settings for component builder generation
+ * @param {string} settings.componentRootPath path to components root
+ * @param {string} settings.componentBuilderOutputPath path to component builder output
+ * @param {PackageDefinition[]} settings.packages list of packages to include in component builder
+ * @param {ComponentFile[]} settings.components list of components to include in component builder
+ */
+function writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components, }) {
+    const items = [
+        ...packages,
+        ...components,
+        ...(0, components_1.getComponentList)(componentRootPath),
+    ];
+    const componentBuilderPath = path_1.default.resolve(componentBuilderOutputPath);
+    const fileContent = (0, component_builder_1.getComponentBuilderTemplate)(items);
+    console.log(`Writing component builder to ${componentBuilderPath}`);
+    fs_1.default.writeFileSync(componentBuilderPath, fileContent, {
+        encoding: 'utf8',
+    });
+}
+exports.writeComponentBuilder = writeComponentBuilder;

package/dist/cjs/templating/nextjs/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getComponentBuilderTemplate = exports.generateComponentBuilder = void 0;
+var generate_component_builder_1 = require("./generate-component-builder");
+Object.defineProperty(exports, "generateComponentBuilder", { enumerable: true, get: function () { return generate_component_builder_1.generateComponentBuilder; } });
+var component_builder_1 = require("./templates/component-builder");
+Object.defineProperty(exports, "getComponentBuilderTemplate", { enumerable: true, get: function () { return component_builder_1.getComponentBuilderTemplate; } });

package/dist/cjs/templating/nextjs/templates/component-builder.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getComponentBuilderTemplate = void 0;
+const isLazyLoadingModule = (componentPath) => componentPath.includes('.dynamic');
+const removeDynamicModuleNameEnding = (moduleName) => moduleName.replace(/\.?dynamic$/i, '');
+/**
+ * Generate component builder template
+ * @param {(PackageDefinition | ComponentFile)[]} components components to include in component builder
+ * @returns generated component builder template
+ */
+const getComponentBuilderTemplate = (components) => {
+    const componentFiles = components.filter((component) => component.componentName);
+    const packages = components.filter((component) => component.components);
+    const hasLazyModules = componentFiles.find((component) => isLazyLoadingModule(component.path));
+    return `/* eslint-disable */
+// Do not edit this file, it is auto-generated at build time!
+// See scripts/generate-component-builder/index.ts to modify the generation of this file.
+
+${hasLazyModules ? "import dynamic from 'next/dynamic';" : ''}
+import { ComponentBuilder } from '@sitecore-jss/sitecore-jss-nextjs';
+
+${packages
+        .map((pkg) => {
+        const list = pkg.components.map((c) => c.moduleName).join(', ');
+        return `import { ${list} } from '${pkg.name}';\n`;
+    })
+        .join('')}
+${componentFiles
+        .map((component) => {
+        if (isLazyLoadingModule(component.path)) {
+            const moduleName = removeDynamicModuleNameEnding(component.moduleName);
+            return `const ${moduleName} = {
+  module: () => import('${component.path}'),
+  element: (isEditing?: boolean) => isEditing ? require('${component.path}')?.default : dynamic(${moduleName}.module)
+}`;
+        }
+        return `import * as ${component.moduleName} from '${component.path}';`;
+    })
+        .join('\n')}
+
+export const components = new Map();
+${packages
+        .map((p) => p.components.map((component) => `components.set('${component.componentName}', ${component.moduleName});\n`))
+        .flat()
+        .join('')}
+${componentFiles
+        .map((component) => `components.set('${isLazyLoadingModule(component.path)
+        ? removeDynamicModuleNameEnding(component.componentName)
+        : component.componentName}', ${isLazyLoadingModule(component.path)
+        ? removeDynamicModuleNameEnding(component.moduleName)
+        : component.moduleName});`)
+        .join('\n')}
+
+export const componentBuilder = new ComponentBuilder({ components });
+
+export const moduleFactory = componentBuilder.getModuleFactory();
+`;
+};
+exports.getComponentBuilderTemplate = getComponentBuilderTemplate;

package/dist/cjs/templating/plugins.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePlugins = exports.getPluginList = exports.ModuleType = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("./utils");
+/**
+ * Identifies the format of the module to be compiled
+ */
+var ModuleType;
+(function (ModuleType) {
+    ModuleType[ModuleType["CJS"] = 0] = "CJS";
+    ModuleType[ModuleType["ESM"] = 1] = "ESM";
+})(ModuleType = exports.ModuleType || (exports.ModuleType = {}));
+/**
+ * Get list of plugins from @var path
+ * Returns a list of plugins in the following format:
+ * {
+ *   path: 'path/to/plugin/foo',
+ *   name: 'fooPlugin'
+ * }
+ * @example getPluginList('src/foo/plugins', 'Foo')
+ * @param {Object} definition plugin definition
+ * @param {string} definition.path path to get plugin from
+ * @param {string} definition.pluginName plugin name
+ * @param {boolean} [definition.silent] whether to suppress console output
+ */
+function getPluginList({ path, pluginName, silent = false, }) {
+    const plugins = (0, utils_1.getItems)({
+        path,
+        resolveItem: (path, name) => ({
+            path: `${path}/${name}`,
+            name: `${name.replace(/-./g, (x) => x[1].toUpperCase())}Plugin`,
+        }),
+        cb: (name) => !silent && console.debug(`Registering ${pluginName} plugin ${name}`),
+    });
+    return plugins;
+}
+exports.getPluginList = getPluginList;
+/**
+ * Generates the plugins file and saves it to the filesystem.
+ * By convention, we expect to find plugins under {pluginName}/plugins/** (subfolders are searched recursively).
+ * generated file will be saved to @var {distPath} and will contain a list of plugins in the following format:
+ * CJS: exports.fooPlugin = require('{pluginPath}');
+ * ESM: export { fooPlugin } from '{pluginPath}';
+ * @example generatePlugins({ distPath: 'src/temp/foo-plugins.js', rootPath: 'src/foo/plugins', moduleType: ModuleType.CJS })
+ * @param {PluginDefinition} definition plugin definition
+ */
+function generatePlugins(definition) {
+    const { rootPath, distPath, moduleType, relative = false, silent } = definition;
+    const segments = rootPath.split('/');
+    const pluginName = segments[segments.length - 2];
+    const plugins = getPluginList({ path: rootPath, pluginName, silent });
+    let fileContent = '';
+    fileContent = plugins
+        .map((plugin) => {
+        const sourcePath = relative
+            ? path_1.default.relative(path_1.default.dirname(distPath), plugin.path).replace(/\\/g, '/')
+            : plugin.path;
+        return moduleType === ModuleType.CJS
+            ? `exports.${plugin.name} = require('${sourcePath}');`
+            : `export { ${plugin.name} } from '${sourcePath}';`;
+    })
+        .join('\r\n')
+        .concat('\r\n');
+    if (!plugins.length) {
+        fileContent = moduleType === ModuleType.CJS ? 'module.exports = {};\r\n' : 'export {};\r\n';
+    }
+    const filePath = path_1.default.resolve(distPath);
+    !silent && console.log(`Writing ${pluginName} plugins to ${filePath}`);
+    fs_1.default.writeFileSync(filePath, fileContent, {
+        encoding: 'utf8',
+    });
+}
+exports.generatePlugins = generatePlugins;

package/dist/cjs/templating/react/generate-component-builder.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeComponentBuilder = exports.watchComponentBuilder = exports.generateComponentBuilder = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const component_builder_1 = require("./templates/component-builder");
+const components_1 = require("../components");
+const utils_1 = require("../utils");
+// Default destination path for component builder
+const componentBuilderOutputPath = 'src/temp/componentBuilder.js';
+const defaultComponentRootPath = 'src/components';
+/**
+ * Generate component builder based on provided settings
+ * @param {Object} settings settings for component builder generation
+ * @param {string} settings.componentRootPath path to components root
+ * @param {PackageDefinition[]} [settings.packages] list of packages to include in component builder
+ * @param {ComponentFile[]} [settings.components] list of components to include in component builder
+ * @param {boolean} settings.watch whether to watch for changes to component builder sources
+ */
+function generateComponentBuilder({ componentRootPath = defaultComponentRootPath, packages = [], components = [], watch, }) {
+    if (watch) {
+        watchComponentBuilder({ componentRootPath, packages, components });
+    }
+    else {
+        writeComponentBuilder({ componentRootPath, packages, components });
+    }
+}
+exports.generateComponentBuilder = generateComponentBuilder;
+/**
+ * Watch for changes to component builder sources
+ * @param {object} config configuration for component builder watcher
+ * @param {string} config.componentRootPath root path to components
+ * @param {PackageDefinition[]} config.packages packages to include in component builder
+ * @param {ComponentFile[]} config.components components to include in component builder
+ */
+function watchComponentBuilder({ componentRootPath, packages, components, }) {
+    console.log(`Watching for changes to component builder sources in ${componentRootPath}...`);
+    (0, utils_1.watchItems)([componentRootPath], writeComponentBuilder.bind(null, { componentRootPath, packages, components }));
+}
+exports.watchComponentBuilder = watchComponentBuilder;
+/**
+ * Write component builder to file
+ * @param {Object} settings settings for component builder generation
+ * @param {string} settings.componentRootPath root path to components
+ * @param {PackageDefinition[]} settings.packages packages to include in component builder
+ * @param {ComponentFile[]} settings.components list of components to include in component builder
+ */
+function writeComponentBuilder({ componentRootPath, packages, components, }) {
+    const items = [
+        ...packages,
+        ...components,
+        ...(0, components_1.getComponentList)(componentRootPath),
+    ];
+    const componentBuilderPath = path_1.default.resolve(componentBuilderOutputPath);
+    const fileContent = (0, component_builder_1.getComponentBuilderTemplate)(items, componentBuilderPath);
+    console.log(`Writing component builder to ${componentBuilderPath}`);
+    fs_1.default.writeFileSync(componentBuilderPath, fileContent, {
+        encoding: 'utf8',
+    });
+}
+exports.writeComponentBuilder = writeComponentBuilder;

package/dist/cjs/templating/react/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateComponentBuilder = exports.getComponentBuilderTemplate = void 0;
+var component_builder_1 = require("./templates/component-builder");
+Object.defineProperty(exports, "getComponentBuilderTemplate", { enumerable: true, get: function () { return component_builder_1.getComponentBuilderTemplate; } });
+var generate_component_builder_1 = require("./generate-component-builder");
+Object.defineProperty(exports, "generateComponentBuilder", { enumerable: true, get: function () { return generate_component_builder_1.generateComponentBuilder; } });

package/dist/cjs/templating/react/templates/component-builder.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getComponentBuilderTemplate = void 0;
+const path_1 = __importDefault(require("path"));
+/**
+ * Generate component builder template
+ * @param {(PackageDefinition | ComponentFile)[]} components components to include in component builder
+ * @param {string} distPath destination path for component builder
+ * @returns generated component builder template
+ */
+const getComponentBuilderTemplate = (components, distPath) => {
+    const componentFiles = components.filter((component) => component.componentName);
+    const packages = components.filter((component) => component.components);
+    return `/* eslint-disable */
+// Do not edit this file, it is auto-generated at build time!
+// See scripts/generate-component-builder/index.js to modify the generation of this file.
+
+import { ComponentBuilder } from '@sitecore-jss/sitecore-jss-react';
+${packages
+        .map((pkg) => {
+        const list = pkg.components.map((c) => c.moduleName).join(', ');
+        return `import { ${list} } from '${pkg.name}';\n`;
+    })
+        .join('')}
+${componentFiles
+        .map((component) => {
+        const sourcePath = path_1.default.relative(path_1.default.dirname(distPath), component.path).replace(/\\/g, '/');
+        return `import ${component.moduleName} from '${sourcePath}';`;
+    })
+        .join('\n')}
+
+const components = new Map();
+${packages
+        .map((p) => p.components.map((component) => `components.set('${component.componentName}', ${component.moduleName});\n`))
+        .flat()
+        .join('')}
+${componentFiles
+        .map((component) => `components.set('${component.componentName}', ${component.moduleName});`)
+        .join('\n')}
+
+const componentBuilder = new ComponentBuilder({ components });
+
+export const componentFactory = componentBuilder.getComponentFactory();
+`;
+};
+exports.getComponentBuilderTemplate = getComponentBuilderTemplate;