@sitecore-jss/sitecore-jss-dev-tools 21.2.0-canary.8 → 21.3.0-canary.1

package/dist/cjs/index.js

@@ -14,7 +14,7 @@ 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 });
-exports.strip = exports.resolveScJssConfig = exports.createDefaultDisconnectedServer = exports.createDefaultDocumentMiddleware = exports.createDisconnectedDictionaryService = exports.createDisconnectedLayoutService = exports.createDisconnectedAssetMiddleware = exports.packageGenerate = exports.packageDeploy = exports.clean = exports.deploy = exports.mergeFs = exports.verifySetup = exports.userConfigPath = exports.setup = exports.replaceConfigTokens = void 0;
+exports.resolveScJssConfig = exports.createDefaultDisconnectedServer = exports.createDefaultDocumentMiddleware = exports.createDisconnectedDictionaryService = exports.createDisconnectedLayoutService = exports.createDisconnectedAssetMiddleware = exports.packageGenerate = exports.packageDeploy = exports.clean = exports.deploy = exports.mergeFs = exports.verifySetup = exports.userConfigPath = exports.setup = exports.replaceConfigTokens = void 0;
 var jss_config_1 = require("./setup/jss-config");
 Object.defineProperty(exports, "replaceConfigTokens", { enumerable: true, get: function () { return jss_config_1.replaceConfigTokens; } });
 var setup_1 = require("./setup/setup");
@@ -44,8 +44,7 @@ var create_default_disconnected_server_1 = require("./disconnected-server/create
 Object.defineProperty(exports, "createDefaultDisconnectedServer", { enumerable: true, get: function () { return create_default_disconnected_server_1.createDefaultDisconnectedServer; } });
 var resolve_scjssconfig_1 = require("./resolve-scjssconfig");
 Object.defineProperty(exports, "resolveScJssConfig", { enumerable: true, get: function () { return resolve_scjssconfig_1.resolveScJssConfig; } });
-var strip_1 = require("./templating/strip");
-Object.defineProperty(exports, "strip", { enumerable: true, get: function () { return strip_1.strip; } });
+__exportStar(require("./templating"), exports);
 __exportStar(require("./manifest"), exports);
 __exportStar(require("./pipelines"), exports);
 __exportStar(require("./update"), 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,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.strip = exports.scaffoldFile = exports.ModuleType = exports.generatePlugins = void 0;
+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 strip_1 = require("./strip");
+Object.defineProperty(exports, "strip", { enumerable: true, get: function () { return strip_1.strip; } });

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

@@ -0,0 +1,61 @@
+"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 {boolean} [settings.watch] whether to watch for changes to component builder sources
+ */
+function generateComponentBuilder({ componentRootPath = defaultComponentRootPath, componentBuilderOutputPath = defaultComponentBuilderOutputPath, packages = [], watch, } = {}) {
+    if (watch) {
+        watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages });
+    }
+    else {
+        writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages });
+    }
+}
+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
+ */
+function watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, }) {
+    console.log(`Watching for changes to component builder sources in ${componentRootPath}...`);
+    (0, utils_1.watchItems)([componentRootPath], writeComponentBuilder.bind(null, { componentRootPath, componentBuilderOutputPath, packages }));
+}
+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
+ */
+function writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, }) {
+    const components = (0, components_1.getComponentList)(componentRootPath);
+    components.unshift(...packages);
+    const componentBuilderPath = path_1.default.resolve(componentBuilderOutputPath);
+    const fileContent = (0, component_builder_1.getComponentBuilderTemplate)(components);
+    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,54 @@
+"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}'`;
+    })}
+${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')}
+
+const components = new Map();
+${packages.map((p) => p.components.map((component) => `components.set('${component.componentName}', ${component.moduleName})`))}
+${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,56 @@
+"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 {boolean} settings.watch whether to watch for changes to component builder sources
+ */
+function generateComponentBuilder({ componentRootPath = defaultComponentRootPath, packages, watch, }) {
+    if (watch) {
+        watchComponentBuilder(componentRootPath, packages);
+    }
+    else {
+        writeComponentBuilder(componentRootPath, packages);
+    }
+}
+exports.generateComponentBuilder = generateComponentBuilder;
+/**
+ * Watch for changes to component builder sources
+ * @param {string} componentRootPath root path to components
+ * @param {PackageDefinition[]} [packages] packages to include in component builder
+ */
+function watchComponentBuilder(componentRootPath, packages) {
+    console.log(`Watching for changes to component builder sources in ${componentRootPath}...`);
+    (0, utils_1.watchItems)([componentRootPath], writeComponentBuilder.bind(null, componentRootPath, packages));
+}
+exports.watchComponentBuilder = watchComponentBuilder;
+/**
+ * Write component builder to file
+ * @param {string} componentRootPath root path to components
+ * @param {PackageDefinition[]} [packages] packages to include in component builder
+ */
+function writeComponentBuilder(componentRootPath, packages = []) {
+    const components = (0, components_1.getComponentList)(componentRootPath);
+    components.unshift(...packages);
+    const componentBuilderPath = path_1.default.resolve(componentBuilderOutputPath);
+    const fileContent = (0, component_builder_1.getComponentBuilderTemplate)(components, 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,48 @@
+"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}'`;
+    })
+        .join('\n')}
+${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})`))
+        .join('\n')}
+${componentFiles
+        .map((component) => `components.set('${component.componentName}', ${component.moduleName});`)
+        .join('\n')}
+
+const componentBuilder = new ComponentBuilder({ components });
+
+export const componentFactory = componentBuilder.getComponentFactory();
+`;
+};
+exports.getComponentBuilderTemplate = getComponentBuilderTemplate;

package/dist/cjs/templating/scaffold.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scaffoldFile = exports.editLineEndings = void 0;
+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');
+}
+exports.editLineEndings = editLineEndings;
+/**
+ * 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;
+}
+exports.scaffoldFile = scaffoldFile;

package/dist/cjs/templating/utils.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.watchItems = exports.getItems = void 0;
+const fs_1 = __importDefault(require("fs"));
+const chokidar_1 = __importDefault(require("chokidar"));
+/**
+ * Using @var path find all files and generate output using @var resolveItem function for each file
+ * Can be used to generate list of components, templates, etc.
+ * @param {GetItemsSettings} settings
+ * @returns {Item[]} list of items
+ */
+function getItems(settings) {
+    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), } = settings;
+    const items = [];
+    const folders = [];
+    if (!fs_1.default.existsSync(path))
+        return [];
+    fs_1.default.readdirSync(path, { withFileTypes: true }).forEach((item) => {
+        if (item.isDirectory()) {
+            folders.push(item);
+        }
+        if (fileFormat.test(item.name)) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const name = item.name.match(fileFormat)[1];
+            items.push(resolveItem(path, name));
+            cb && cb(name);
+        }
+    });
+    for (const folder of folders) {
+        recursive
+            ? items.push(...getItems({
+                path: `${path}/${folder.name}`,
+                resolveItem,
+                cb,
+                fileFormat,
+            }))
+            : items.push(resolveItem(`${path}/${folder.name}`, folder.name));
+    }
+    return items;
+}
+exports.getItems = getItems;
+/**
+ * Run watch mode, watching on @var paths
+ * @param {string[]} paths paths to watch by chokidar
+ * @param {Function<void>} cb callback to run on file change
+ */
+function watchItems(paths, cb) {
+    chokidar_1.default
+        .watch(paths, { ignoreInitial: true, awaitWriteFinish: true })
+        .on('add', cb)
+        .on('unlink', cb);
+}
+exports.watchItems = watchItems;

package/dist/esm/index.js

@@ -12,7 +12,7 @@ export { createDisconnectedDictionaryService, } from './disconnected-server/dict
 export { createDefaultDocumentMiddleware, } from './disconnected-server/default-document';
 export { createDefaultDisconnectedServer, } from './disconnected-server/create-default-disconnected-server';
 export { resolveScJssConfig } from './resolve-scjssconfig';
-export { strip } from './templating/strip';
+export * from './templating';
 export * from './manifest';
 export * from './pipelines';
 export * from './update';

package/dist/esm/templating/components.js

@@ -0,0 +1,23 @@
+import { getItems } from './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
+ */
+export function getComponentList(path) {
+    const components = 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;
+}

package/dist/esm/templating/index.js

@@ -0,0 +1,3 @@
+export { generatePlugins, ModuleType } from './plugins';
+export { scaffoldFile } from './scaffold';
+export { strip } from './strip';

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

@@ -0,0 +1,52 @@
+import path from 'path';
+import fs from 'fs';
+import { getComponentBuilderTemplate } from './templates/component-builder';
+import { getComponentList } from '../components';
+import { watchItems } from '../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 {boolean} [settings.watch] whether to watch for changes to component builder sources
+ */
+export function generateComponentBuilder({ componentRootPath = defaultComponentRootPath, componentBuilderOutputPath = defaultComponentBuilderOutputPath, packages = [], watch, } = {}) {
+    if (watch) {
+        watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages });
+    }
+    else {
+        writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages });
+    }
+}
+/**
+ * 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
+ */
+export function watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, }) {
+    console.log(`Watching for changes to component builder sources in ${componentRootPath}...`);
+    watchItems([componentRootPath], writeComponentBuilder.bind(null, { componentRootPath, componentBuilderOutputPath, packages }));
+}
+/**
+ * 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
+ */
+export function writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, }) {
+    const components = getComponentList(componentRootPath);
+    components.unshift(...packages);
+    const componentBuilderPath = path.resolve(componentBuilderOutputPath);
+    const fileContent = getComponentBuilderTemplate(components);
+    console.log(`Writing component builder to ${componentBuilderPath}`);
+    fs.writeFileSync(componentBuilderPath, fileContent, {
+        encoding: 'utf8',
+    });
+}

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

@@ -0,0 +1,2 @@
+export { generateComponentBuilder } from './generate-component-builder';
+export { getComponentBuilderTemplate } from './templates/component-builder';

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

@@ -0,0 +1,50 @@
+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
+ */
+export 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}'`;
+    })}
+${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')}
+
+const components = new Map();
+${packages.map((p) => p.components.map((component) => `components.set('${component.componentName}', ${component.moduleName})`))}
+${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();
+`;
+};

package/dist/esm/templating/plugins.js

@@ -0,0 +1,70 @@
+import fs from 'fs';
+import path from 'path';
+import { getItems } from './utils';
+/**
+ * Identifies the format of the module to be compiled
+ */
+export var ModuleType;
+(function (ModuleType) {
+    ModuleType[ModuleType["CJS"] = 0] = "CJS";
+    ModuleType[ModuleType["ESM"] = 1] = "ESM";
+})(ModuleType || (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
+ */
+export function getPluginList({ path, pluginName, silent = false, }) {
+    const plugins = 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;
+}
+/**
+ * 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
+ */
+export 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.relative(path.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.resolve(distPath);
+    !silent && console.log(`Writing ${pluginName} plugins to ${filePath}`);
+    fs.writeFileSync(filePath, fileContent, {
+        encoding: 'utf8',
+    });
+}

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

@@ -0,0 +1,47 @@
+import path from 'path';
+import fs from 'fs';
+import { getComponentBuilderTemplate } from './templates/component-builder';
+import { getComponentList } from '../components';
+import { watchItems } from '../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 {boolean} settings.watch whether to watch for changes to component builder sources
+ */
+export function generateComponentBuilder({ componentRootPath = defaultComponentRootPath, packages, watch, }) {
+    if (watch) {
+        watchComponentBuilder(componentRootPath, packages);
+    }
+    else {
+        writeComponentBuilder(componentRootPath, packages);
+    }
+}
+/**
+ * Watch for changes to component builder sources
+ * @param {string} componentRootPath root path to components
+ * @param {PackageDefinition[]} [packages] packages to include in component builder
+ */
+export function watchComponentBuilder(componentRootPath, packages) {
+    console.log(`Watching for changes to component builder sources in ${componentRootPath}...`);
+    watchItems([componentRootPath], writeComponentBuilder.bind(null, componentRootPath, packages));
+}
+/**
+ * Write component builder to file
+ * @param {string} componentRootPath root path to components
+ * @param {PackageDefinition[]} [packages] packages to include in component builder
+ */
+export function writeComponentBuilder(componentRootPath, packages = []) {
+    const components = getComponentList(componentRootPath);
+    components.unshift(...packages);
+    const componentBuilderPath = path.resolve(componentBuilderOutputPath);
+    const fileContent = getComponentBuilderTemplate(components, componentBuilderPath);
+    console.log(`Writing component builder to ${componentBuilderPath}`);
+    fs.writeFileSync(componentBuilderPath, fileContent, {
+        encoding: 'utf8',
+    });
+}

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

@@ -0,0 +1,2 @@
+export { getComponentBuilderTemplate } from './templates/component-builder';
+export { generateComponentBuilder } from './generate-component-builder';

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

@@ -0,0 +1,41 @@
+import path from '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
+ */
+export 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}'`;
+    })
+        .join('\n')}
+${componentFiles
+        .map((component) => {
+        const sourcePath = path.relative(path.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})`))
+        .join('\n')}
+${componentFiles
+        .map((component) => `components.set('${component.componentName}', ${component.moduleName});`)
+        .join('\n')}
+
+const componentBuilder = new ComponentBuilder({ components });
+
+export const componentFactory = componentBuilder.getComponentFactory();
+`;
+};

package/dist/esm/templating/scaffold.js

@@ -0,0 +1,30 @@
+import fs from 'fs';
+import chalk from 'chalk';
+import path from 'path';
+/**
+ * Force to use `crlf` line endings, we are using `crlf` across the project.
+ * Replace: `lf` (\n), `cr` (\r)
+ * @param {string} content
+ */
+export 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
+ */
+export function scaffoldFile(filePath, fileContent) {
+    const outputDir = path.dirname(filePath);
+    if (fs.existsSync(filePath)) {
+        console.log(chalk.red(`Skipping creating ${filePath}; already exists.`));
+        return null;
+    }
+    fs.mkdirSync(outputDir, { recursive: true });
+    fs.writeFileSync(filePath, editLineEndings(fileContent), 'utf8');
+    console.log(chalk.green(`File ${filePath} has been scaffolded.`));
+    return filePath;
+}

package/dist/esm/templating/utils.js

@@ -0,0 +1,48 @@
+import fs from 'fs';
+import chokidar from 'chokidar';
+/**
+ * Using @var path find all files and generate output using @var resolveItem function for each file
+ * Can be used to generate list of components, templates, etc.
+ * @param {GetItemsSettings} settings
+ * @returns {Item[]} list of items
+ */
+export function getItems(settings) {
+    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), } = settings;
+    const items = [];
+    const folders = [];
+    if (!fs.existsSync(path))
+        return [];
+    fs.readdirSync(path, { withFileTypes: true }).forEach((item) => {
+        if (item.isDirectory()) {
+            folders.push(item);
+        }
+        if (fileFormat.test(item.name)) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const name = item.name.match(fileFormat)[1];
+            items.push(resolveItem(path, name));
+            cb && cb(name);
+        }
+    });
+    for (const folder of folders) {
+        recursive
+            ? items.push(...getItems({
+                path: `${path}/${folder.name}`,
+                resolveItem,
+                cb,
+                fileFormat,
+            }))
+            : items.push(resolveItem(`${path}/${folder.name}`, folder.name));
+    }
+    return items;
+}
+/**
+ * Run watch mode, watching on @var paths
+ * @param {string[]} paths paths to watch by chokidar
+ * @param {Function<void>} cb callback to run on file change
+ */
+export function watchItems(paths, cb) {
+    chokidar
+        .watch(paths, { ignoreInitial: true, awaitWriteFinish: true })
+        .on('add', cb)
+        .on('unlink', cb);
+}

package/nextjs.d.ts

@@ -0,0 +1 @@
+export * from './types/templating/nextjs/index';

package/nextjs.js

@@ -0,0 +1,3 @@
+const templating = require('./dist/cjs/templating/nextjs/index');
+
+module.exports = { ...templating };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-dev-tools",
-  "version": "21.2.0-canary.8",
+  "version": "21.3.0-canary.1",
   "description": "Utilities to assist in the development and deployment of Sitecore JSS apps.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -33,7 +33,7 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.2.0-canary.8",
+    "@sitecore-jss/sitecore-jss": "^21.3.0-canary.1",
     "axios": "^1.3.2",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -84,9 +84,11 @@
     "typescript": "~4.9.5"
   },
   "types": "types/index.d.ts",
-  "gitHead": "632fb767b0e2295f18c68e07d994a8a495e03619",
+  "gitHead": "fcf3490aa19fd1aee6320a4865098d99523878ad",
   "files": [
     "dist",
-    "types"
+    "types",
+    "/*.js",
+    "/*.d.ts"
   ]
 }

package/react.d.ts

@@ -0,0 +1 @@
+export * from './types/templating/react/index';

package/react.js

@@ -0,0 +1,3 @@
+const templating = require('./dist/cjs/templating/react/index');
+
+module.exports = { ...templating };

package/types/index.d.ts

@@ -13,7 +13,7 @@ export { createDisconnectedDictionaryService, DisconnectedDictionaryServiceOptio
 export { createDefaultDocumentMiddleware, DefaultDocumentMiddlewareOptions, } from './disconnected-server/default-document';
 export { createDefaultDisconnectedServer, DisconnectedServerOptions, } from './disconnected-server/create-default-disconnected-server';
 export { ScJssConfig, JssConfiguration, resolveScJssConfig } from './resolve-scjssconfig';
-export { strip } from './templating/strip';
+export * from './templating';
 export * from './manifest';
 export * from './pipelines';
 export * from './update';

package/types/templating/components.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Describes a file that represents a component definition
+ */
+export interface ComponentFile {
+    path: string;
+    moduleName: string;
+    componentName: string;
+}
+/**
+ * Describes a package and components to be imported
+ */
+export interface PackageDefinition {
+    name: string;
+    components: {
+        moduleName: string;
+        componentName: string;
+    }[];
+}
+/**
+ * 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
+ */
+export declare function getComponentList(path: string): (PackageDefinition | ComponentFile)[];

package/types/templating/index.d.ts

@@ -0,0 +1,4 @@
+export { ComponentFile, PackageDefinition } from './components';
+export { PluginDefinition, generatePlugins, ModuleType } from './plugins';
+export { scaffoldFile } from './scaffold';
+export { strip } from './strip';

package/types/templating/nextjs/generate-component-builder.d.ts

@@ -0,0 +1,39 @@
+import { PackageDefinition } from '../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 {boolean} [settings.watch] whether to watch for changes to component builder sources
+ */
+export declare function generateComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, watch, }?: {
+    componentRootPath?: string;
+    componentBuilderOutputPath?: string;
+    packages?: PackageDefinition[];
+    watch?: boolean;
+}): void;
+/**
+ * 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
+ */
+export declare function watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, }: {
+    componentRootPath: string;
+    componentBuilderOutputPath: string;
+    packages: PackageDefinition[];
+}): void;
+/**
+ * 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
+ */
+export declare function writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, }: {
+    componentRootPath: string;
+    componentBuilderOutputPath: string;
+    packages: PackageDefinition[];
+}): void;

package/types/templating/nextjs/index.d.ts

@@ -0,0 +1,2 @@
+export { generateComponentBuilder } from './generate-component-builder';
+export { getComponentBuilderTemplate } from './templates/component-builder';

package/types/templating/nextjs/templates/component-builder.d.ts

@@ -0,0 +1,7 @@
+import { ComponentFile, PackageDefinition } from '../../components';
+/**
+ * Generate component builder template
+ * @param {(PackageDefinition | ComponentFile)[]} components components to include in component builder
+ * @returns generated component builder template
+ */
+export declare const getComponentBuilderTemplate: (components: (PackageDefinition | ComponentFile)[]) => string;

package/types/templating/plugins.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Identifies the format of the module to be compiled
+ */
+export declare enum ModuleType {
+    CJS = 0,
+    ESM = 1
+}
+/**
+ * Type to specify plugin file details
+ */
+export interface PluginFile {
+    path: string;
+    name: string;
+}
+/**
+ * Definition to be used for plugin registration during bootstrap
+ */
+export interface PluginDefinition {
+    /**
+     * destination path to compile plugins to
+     */
+    distPath: string;
+    /**
+     * source path for where the plugins are defined
+     */
+    rootPath: string;
+    /**
+     * CJS or ESM - which type to compile plugins to
+     */
+    moduleType: ModuleType;
+    /**
+     * whether to use relative or absolute paths in the generated file. By default, absolute paths are used.
+     */
+    relative?: boolean;
+    /**
+     * whether to suppress console output
+     */
+    silent?: boolean;
+}
+/**
+ * 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
+ */
+export declare function getPluginList({ path, pluginName, silent, }: {
+    path: string;
+    pluginName: string;
+    silent?: boolean;
+}): PluginFile[];
+/**
+ * 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
+ */
+export declare function generatePlugins(definition: PluginDefinition): void;

package/types/templating/react/generate-component-builder.d.ts

@@ -0,0 +1,25 @@
+import { PackageDefinition } from '../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 {boolean} settings.watch whether to watch for changes to component builder sources
+ */
+export declare function generateComponentBuilder({ componentRootPath, packages, watch, }: {
+    componentRootPath?: string;
+    packages?: PackageDefinition[];
+    watch?: boolean;
+}): void;
+/**
+ * Watch for changes to component builder sources
+ * @param {string} componentRootPath root path to components
+ * @param {PackageDefinition[]} [packages] packages to include in component builder
+ */
+export declare function watchComponentBuilder(componentRootPath: string, packages?: PackageDefinition[]): void;
+/**
+ * Write component builder to file
+ * @param {string} componentRootPath root path to components
+ * @param {PackageDefinition[]} [packages] packages to include in component builder
+ */
+export declare function writeComponentBuilder(componentRootPath: string, packages?: PackageDefinition[]): void;

package/types/templating/react/index.d.ts

@@ -0,0 +1,2 @@
+export { getComponentBuilderTemplate } from './templates/component-builder';
+export { generateComponentBuilder } from './generate-component-builder';

package/types/templating/react/templates/component-builder.d.ts

@@ -0,0 +1,8 @@
+import { ComponentFile, PackageDefinition } from '../../components';
+/**
+ * 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
+ */
+export declare const getComponentBuilderTemplate: (components: (PackageDefinition | ComponentFile)[], distPath: string) => string;

package/types/templating/scaffold.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Force to use `crlf` line endings, we are using `crlf` across the project.
+ * Replace: `lf` (\n), `cr` (\r)
+ * @param {string} content
+ */
+export declare function editLineEndings(content: string): string;
+/**
+ * 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
+ */
+export declare function scaffoldFile(filePath: string, fileContent: string): string | null;

package/types/templating/utils.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Settings for @var getItems function
+ */
+export type GetItemsSettings<Item> = {
+    /**
+     * items path
+     */
+    path: string;
+    /**
+     * Resolve item in required data format
+     */
+    resolveItem: (path: string, name: string) => Item;
+    /**
+     * Will be called when new file is found
+     */
+    cb?: (name: string) => void;
+    /**
+     * Matches specific files format
+     */
+    fileFormat?: RegExp;
+    /**
+     * Wether to search recursively
+     */
+    recursive?: boolean;
+};
+/**
+ * Using @var path find all files and generate output using @var resolveItem function for each file
+ * Can be used to generate list of components, templates, etc.
+ * @param {GetItemsSettings} settings
+ * @returns {Item[]} list of items
+ */
+export declare function getItems<Item>(settings: GetItemsSettings<Item>): Item[];
+/**
+ * Run watch mode, watching on @var paths
+ * @param {string[]} paths paths to watch by chokidar
+ * @param {Function<void>} cb callback to run on file change
+ */
+export declare function watchItems(paths: string[], cb: () => void): void;