@sitecore-content-sdk/nextjs 0.1.0-beta.16 → 0.1.0-beta.17

package/component-props-loader.d.ts

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

package/component-props-loader.js

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

package/dist/cjs/tools/component-props.loader.js

@@ -0,0 +1,101 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = componentPropsLoader;
+const recast = __importStar(require("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
+ */
+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/cjs/tools/index.js

@@ -1,6 +1,24 @@
 "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 });
-exports.generateMetadata = exports.generateSites = void 0;
+exports.ModuleType = exports.generatePlugins = exports.getComponentList = exports.generateMetadata = exports.generateSites = void 0;
 var tools_1 = require("@sitecore-content-sdk/core/tools");
 Object.defineProperty(exports, "generateSites", { enumerable: true, get: function () { return tools_1.generateSites; } });
 Object.defineProperty(exports, "generateMetadata", { enumerable: true, get: function () { return tools_1.generateMetadata; } });
+Object.defineProperty(exports, "getComponentList", { enumerable: true, get: function () { return tools_1.getComponentList; } });
+Object.defineProperty(exports, "generatePlugins", { enumerable: true, get: function () { return tools_1.generatePlugins; } });
+Object.defineProperty(exports, "ModuleType", { enumerable: true, get: function () { return tools_1.ModuleType; } });
+__exportStar(require("./templating"), exports);

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

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateComponentBuilder = generateComponentBuilder;
+exports.watchComponentBuilder = watchComponentBuilder;
+exports.writeComponentBuilder = writeComponentBuilder;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const component_builder_1 = require("./templates/component-builder");
+const tools_1 = require("@sitecore-content-sdk/core/tools");
+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 });
+    }
+}
+/**
+ * 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,
+    }));
+}
+/**
+ * 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, tools_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',
+    });
+}

package/dist/cjs/tools/templating/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/tools/templating/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-content-sdk/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/tools/templating/utils.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.watchItems = watchItems;
+const chokidar_1 = __importDefault(require("chokidar"));
+/**
+ * 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);
+}

package/dist/esm/tools/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/tools/index.js

@@ -1 +1,2 @@
-export { generateSites, generateMetadata, } from '@sitecore-content-sdk/core/tools';
+export { generateSites, generateMetadata, getComponentList, generatePlugins, ModuleType, } from '@sitecore-content-sdk/core/tools';
+export * from './templating';

package/dist/esm/tools/templating/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 '@sitecore-content-sdk/core/tools';
+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/tools/templating/index.js

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

package/dist/esm/tools/templating/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-content-sdk/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/tools/templating/utils.js

@@ -0,0 +1,12 @@
+import chokidar from 'chokidar';
+/**
+ * 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/nextjs",
-  "version": "0.1.0-beta.16",
+  "version": "0.1.0-beta.17",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -57,6 +57,7 @@
     "next": "^14.2.18",
     "nock": "14.0.0-beta.7",
     "nyc": "^17.1.0",
+    "proxyquire": "^2.1.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "sinon": "^19.0.2",
@@ -72,17 +73,17 @@
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-content-sdk/core": "0.1.0-beta.16",
-    "@sitecore-content-sdk/dev-tools": "0.1.0-beta.16",
-    "@sitecore-content-sdk/react": "0.1.0-beta.16",
+    "@sitecore-content-sdk/core": "0.1.0-beta.17",
+    "@sitecore-content-sdk/react": "0.1.0-beta.17",
     "@vercel/kv": "^3.0.0",
     "prop-types": "^15.8.1",
+    "recast": "^0.23.11",
     "regex-parser": "^2.3.0",
     "sync-disk-cache": "^2.1.0"
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "6ad14b74f9e5a1e88e14289a16de1bd25de5cc74",
+  "gitHead": "9a7a8fea513ada0ae441941bcf05a1a86d4f7d99",
   "files": [
     "dist",
     "types",

package/types/editing/editing-config-middleware.d.ts

@@ -1,5 +1,5 @@
 import { NextApiRequest, NextApiResponse } from 'next';
-import { Metadata } from '@sitecore-content-sdk/dev-tools';
+import { Metadata } from '@sitecore-content-sdk/core/editing';
 export type EditingConfigMiddlewareConfig = {
     /**
      * Components available in the application

package/types/tools/component-props.loader.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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: string): string;

package/types/tools/index.d.ts

@@ -1 +1,2 @@
-export { generateSites, GenerateSitesConfig, generateMetadata, } from '@sitecore-content-sdk/core/tools';
+export { generateSites, GenerateSitesConfig, generateMetadata, ComponentFile, PackageDefinition, getComponentList, PluginDefinition, generatePlugins, ModuleType, } from '@sitecore-content-sdk/core/tools';
+export * from './templating';

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

@@ -0,0 +1,45 @@
+import { ComponentFile, PackageDefinition } from '@sitecore-content-sdk/core/tools';
+/**
+ * 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 declare function generateComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components, watch, }?: {
+    componentRootPath?: string;
+    componentBuilderOutputPath?: string;
+    packages?: PackageDefinition[];
+    components?: ComponentFile[];
+    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
+ * @param {ComponentFile[]} settings.components list of components to include in component builder
+ */
+export declare function watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components, }: {
+    componentRootPath: string;
+    componentBuilderOutputPath: string;
+    packages: PackageDefinition[];
+    components: ComponentFile[];
+}): 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
+ * @param {ComponentFile[]} settings.components list of components to include in component builder
+ */
+export declare function writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, components, }: {
+    componentRootPath: string;
+    componentBuilderOutputPath: string;
+    packages: PackageDefinition[];
+    components: ComponentFile[];
+}): void;

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

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

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

@@ -0,0 +1,7 @@
+import { ComponentFile, PackageDefinition } from '@sitecore-content-sdk/core/tools';
+/**
+ * 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/tools/templating/utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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;