@sitecore-jss/sitecore-jss-dev-tools 22.0.0-canary.9 → 22.1.0-canary.2

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/pipelines/runner.js

@@ -21,7 +21,7 @@ pipeline.addProcessor({
     },
 });
 pipeline
-    .runWithCompilers(['babel-core/register'])
+    .runWithCompilers(['@babel/register'])
     .then((result) => {
     console.log(JSON.stringify(result, null, 2));
 })
@@ -29,7 +29,7 @@ pipeline
     console.error(err);
 });
 const runner = () => __awaiter(void 0, void 0, void 0, function* () {
-    const compilers = ['babel-core/register'];
+    const compilers = ['@babel/register'];
     return initCompilers(compilers)
         .then(() => configLoader({ fileGlobs: ['../test/pipelines/**/*.config.js'], workingDirectory: __dirname }))
         .then((config) => configLoader({

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,5 @@
+export { getComponentList } from './components';
+export { generatePlugins, ModuleType } from './plugins';
+export { scaffoldFile } from './scaffold';
+export { strip } from './strip';
+export { getMetadata } from './metadata';

package/dist/esm/templating/metadata.js

@@ -0,0 +1,25 @@
+import fs from 'fs';
+import path from 'path';
+/**
+ * Get application metadata
+ */
+export function getMetadata() {
+    const metadata = { packages: {} };
+    const trackedScopes = ['@sitecore', '@sitecore-cloudsdk', '@sitecore-feaas', '@sitecore-jss'];
+    const dirs = fs.readdirSync('node_modules');
+    dirs.forEach((dir) => {
+        if (trackedScopes.includes(dir)) {
+            const packageNames = fs.readdirSync(path.join('node_modules', dir));
+            packageNames.forEach((pkg) => {
+                try {
+                    const json = JSON.parse(fs.readFileSync(path.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;
+}

package/dist/esm/templating/nextjs/component-props.loader.js

@@ -0,0 +1,65 @@
+import * as recast from 'recast';
+/**
+ * Webpack loader to strip functions from the source code
+ * Strips the `getServerSideProps` and `getStaticProps` functions from the source code
+ * @param {string} source file source code
+ * @returns {string} output file source code with stripped functions
+ */
+export default function componentPropsLoader(source) {
+    // Parse the source code into an AST (Abstract Syntax Tree)
+    const ast = recast.parse(source, {
+        parser: require('recast/parsers/babel-ts'),
+    });
+    // List of functions to strip from the AST
+    const functionsToStrip = ['getServerSideProps', 'getStaticProps'];
+    // Remove the function from the list of functions to strip
+    const updateList = (functionName) => {
+        // Remove the function from the list of functions to strip
+        functionsToStrip.splice(functionsToStrip.indexOf(functionName), 1);
+    };
+    // Traverse the AST and strip the functions
+    recast.visit(ast, {
+        // Visit the named export function expression
+        visitExportNamedDeclaration: function (path) {
+            var _a, _b;
+            // Get the variable declaration from the AST
+            (_b = (_a = path.node.declaration) === null || _a === void 0 ? void 0 : _a.declarations) === null || _b === void 0 ? void 0 : _b.forEach((declaration) => {
+                // Check if the function is in the list of functions to strip
+                if ('id' in declaration &&
+                    'name' in declaration.id &&
+                    typeof declaration.id.name === 'string' &&
+                    functionsToStrip.includes(declaration.id.name)) {
+                    updateList(declaration.id.name);
+                    // Strip the function from the AST
+                    path.prune();
+                }
+            });
+            if (functionsToStrip.length === 0) {
+                // We have pruned all the functions we need to, so we can stop traversing the AST
+                return false;
+            }
+            // Continue traversing the AST
+            this.traverse(path);
+        },
+        // Visit the named export function declaration
+        visitFunctionDeclaration: function (path) {
+            // Check if the function is in the list of functions to strip
+            if (path.node.id &&
+                'name' in path.node.id &&
+                typeof path.node.id.name === 'string' &&
+                functionsToStrip.includes(path.node.id.name)) {
+                updateList(path.node.id.name);
+                // Strip the function from the AST
+                path.prune();
+            }
+            if (functionsToStrip.length === 0) {
+                // We have pruned all the functions we need to, so we can stop traversing the AST
+                return false;
+            }
+            // Continue traversing the AST
+            this.traverse(path);
+        },
+    });
+    // Generate the output code
+    return recast.print(ast).code;
+}

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

@@ -0,0 +1,63 @@
+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 {ComponentFile[]} [settings.components] list of components 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 = [], components = [], watch, } = {}) {
+    if (watch) {
+        watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components });
+    }
+    else {
+        writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components });
+    }
+}
+/**
+ * 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
+ */
+export function watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components, }) {
+    console.log(`Watching for changes to component builder sources in ${componentRootPath}...`);
+    watchItems([componentRootPath], writeComponentBuilder.bind(null, {
+        componentRootPath,
+        componentBuilderOutputPath,
+        packages,
+        components,
+    }));
+}
+/**
+ * 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
+ */
+export function writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components, }) {
+    const items = [
+        ...packages,
+        ...components,
+        ...getComponentList(componentRootPath),
+    ];
+    const componentBuilderPath = path.resolve(componentBuilderOutputPath);
+    const fileContent = getComponentBuilderTemplate(items);
+    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,55 @@
+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}';\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();
+`;
+};

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,55 @@
+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 {ComponentFile[]} [settings.components] list of components to include in component builder
+ * @param {boolean} settings.watch whether to watch for changes to component builder sources
+ */
+export function generateComponentBuilder({ componentRootPath = defaultComponentRootPath, packages = [], components = [], watch, }) {
+    if (watch) {
+        watchComponentBuilder({ componentRootPath, packages, components });
+    }
+    else {
+        writeComponentBuilder({ componentRootPath, packages, components });
+    }
+}
+/**
+ * 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
+ */
+export function watchComponentBuilder({ componentRootPath, packages, components, }) {
+    console.log(`Watching for changes to component builder sources in ${componentRootPath}...`);
+    watchItems([componentRootPath], writeComponentBuilder.bind(null, { componentRootPath, packages, components }));
+}
+/**
+ * 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
+ */
+export function writeComponentBuilder({ componentRootPath, packages, components, }) {
+    const items = [
+        ...packages,
+        ...components,
+        ...getComponentList(componentRootPath),
+    ];
+    const componentBuilderPath = path.resolve(componentBuilderOutputPath);
+    const fileContent = getComponentBuilderTemplate(items, 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,42 @@
+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}';\n`;
+    })
+        .join('')}
+${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});\n`))
+        .flat()
+        .join('')}
+${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-component-props-loader.d.ts

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

package/nextjs-component-props-loader.js

@@ -0,0 +1,3 @@
+const loader = require('./dist/cjs/templating/nextjs/component-props.loader');
+
+module.exports = loader;

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 };