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

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

@@ -1,295 +1,295 @@
-import { detectRouterType, getComponentListWithTypes, filterComponentsByType, } from '@sitecore-content-sdk/core/tools';
-import * as path from 'path';
-import * as fs from 'fs';
-// Common builder for Next.js component map content
-const prepareComponentsForMap = (components, opts) => {
-    const groups = new Map();
-    const getPrefix = (name) => {
-        const index = name.indexOf('.');
-        return index === -1 ? name : name.slice(0, index);
-    };
-    for (const file of components) {
-        const dir = path.dirname(file.filePath).replace(/\\/g, '/');
-        const prefix = getPrefix(file.componentName);
-        const key = `${dir}::${prefix}`;
-        let group = groups.get(key);
-        if (!group) {
-            group = { dir, prefix, neighbors: [] };
-            groups.set(key, group);
-        }
-        if (file.componentName === prefix)
-            group.base = file;
-        else
-            group.neighbors.push(file);
-    }
-    const entries = [];
-    for (const group of groups.values()) {
-        const imports = [];
-        if (opts.includeVariants) {
-            const spreads = [];
-            for (const neighbor of group.neighbors) {
-                imports.push(`import * as ${neighbor.moduleName} from '${neighbor.importPath}';`);
-                spreads.push(`...${neighbor.moduleName}`);
-            }
-            if (group.base) {
-                imports.push(`import * as ${group.base.moduleName} from '${group.base.importPath}';`);
-                spreads.push(`...${group.base.moduleName}`);
-            }
-            const annotateClient = !!group.base && 'componentType' in group.base && group.base.componentType === 'client';
-            let valueExpr;
-            if (spreads.length) {
-                valueExpr = spreads.join(', ');
-            }
-            else {
-                valueExpr = group.base
-                    ? group.base.moduleName
-                    : group.neighbors[0].moduleName;
-            }
-            entries.push({
-                key: group.prefix,
-                imports,
-                valueExpr,
-                annotateClient,
-            });
-        }
-        else {
-            // Variants disabled: single entry per group
-            if (group.base) {
-                imports.push(`import * as ${group.base.moduleName} from '${group.base.importPath}';`);
-                const annotateClient = 'componentType' in group.base && group.base.componentType === 'client';
-                entries.push({
-                    key: group.prefix,
-                    imports,
-                    valueExpr: group.base.moduleName,
-                    annotateClient,
-                });
-            }
-            else if (group.neighbors.length) {
-                const first = group.neighbors[0];
-                imports.push(`import * as ${first.moduleName} from '${first.importPath}';`);
-                entries.push({
-                    key: group.prefix,
-                    imports,
-                    valueExpr: first.moduleName,
-                    annotateClient: false,
-                });
-            }
-        }
-    }
-    return entries;
-};
-const buildNextjsMapContent = (entries, componentImports, options = {}) => {
-    const { headerComment = "Below are built-in components that are available in the app, it's recommended to keep them as is", isClientMap = false, } = options;
-    const wildcardImports = [];
-    const namedImports = [];
-    const builtInImports = options.builtInImports ||
+import { filterComponentsByType, } from '@sitecore-content-sdk/core/tools';
+import * as path from 'path';
+import * as fs from 'fs';
+import { detectRouterType, getComponentListWithTypes } from './templating/utils';
+// Common builder for Next.js component map content
+const prepareComponentsForMap = (components, opts) => {
+    const groups = new Map();
+    const getPrefix = (name) => {
+        const index = name.indexOf('.');
+        return index === -1 ? name : name.slice(0, index);
+    };
+    for (const file of components) {
+        const dir = path.dirname(file.filePath).replace(/\\/g, '/');
+        const prefix = getPrefix(file.componentName);
+        const key = `${dir}::${prefix}`;
+        let group = groups.get(key);
+        if (!group) {
+            group = { dir, prefix, neighbors: [] };
+            groups.set(key, group);
+        }
+        if (file.componentName === prefix)
+            group.base = file;
+        else
+            group.neighbors.push(file);
+    }
+    const entries = [];
+    for (const group of groups.values()) {
+        const imports = [];
+        if (opts.includeVariants) {
+            const spreads = [];
+            for (const neighbor of group.neighbors) {
+                imports.push(`import * as ${neighbor.moduleName} from '${neighbor.importPath}';`);
+                spreads.push(`...${neighbor.moduleName}`);
+            }
+            if (group.base) {
+                imports.push(`import * as ${group.base.moduleName} from '${group.base.importPath}';`);
+                spreads.push(`...${group.base.moduleName}`);
+            }
+            const annotateClient = !!group.base && 'componentType' in group.base && group.base.componentType === 'client';
+            let valueExpr;
+            if (spreads.length) {
+                valueExpr = spreads.join(', ');
+            }
+            else {
+                valueExpr = group.base ? group.base.moduleName : group.neighbors[0].moduleName;
+            }
+            entries.push({
+                key: group.prefix,
+                imports,
+                valueExpr,
+                annotateClient,
+            });
+        }
+        else {
+            // Variants disabled: single entry per group
+            if (group.base) {
+                imports.push(`import * as ${group.base.moduleName} from '${group.base.importPath}';`);
+                const annotateClient = 'componentType' in group.base && group.base.componentType === 'client';
+                entries.push({
+                    key: group.prefix,
+                    imports,
+                    valueExpr: group.base.moduleName,
+                    annotateClient,
+                });
+            }
+            else if (group.neighbors.length) {
+                const first = group.neighbors[0];
+                imports.push(`import * as ${first.moduleName} from '${first.importPath}';`);
+                entries.push({
+                    key: group.prefix,
+                    imports,
+                    valueExpr: first.moduleName,
+                    annotateClient: false,
+                });
+            }
+        }
+    }
+    return entries;
+};
+const buildNextjsMapContent = (entries, componentImports, options = {}) => {
+    const { headerComment = "Below are built-in components that are available in the app, it's recommended to keep them as is", isClientMap = false, } = options;
+    const wildcardImports = [];
+    const namedImports = [];
+    const builtInImports = options.builtInImports ||
         `
 import { BYOCWrapper, NextjsContentSdkComponent, FEaaSWrapper } from '@sitecore-content-sdk/nextjs';
 import { Form } from '@sitecore-content-sdk/nextjs';
-`;
-    const builtInMapEntries = options.builtInMapEntries || [
-        `['BYOCWrapper', BYOCWrapper]`,
-        `['FEaaSWrapper', FEaaSWrapper]`,
-        `['Form', Form]`,
-    ];
-    // Add per-entry imports
-    entries.forEach((e) => wildcardImports.push(...e.imports));
-    // Handle package imports
-    componentImports === null || componentImports === void 0 ? void 0 : componentImports.forEach((pkg) => {
-        if (pkg.importInfo.namedImports) {
-            namedImports.push(`import { ${pkg.importInfo.namedImports.join(', ')} } from '${pkg.importInfo.importFrom}';`);
-        }
-        else {
-            wildcardImports.push(`import * as ${pkg.importName} from '${pkg.importInfo.importFrom}';`);
-        }
-    });
-    const importLines = [
-        headerComment.includes('built-in') ? '// end of built-in components' : null,
-        ...wildcardImports,
-        ...namedImports,
-    ].filter(Boolean);
-    const importsSection = importLines.length ? `\n${importLines.join('\n')}` : '';
-    // Build entry lines (package named imports are appended below)
-    const componentMapEntries = builtInMapEntries;
-    for (const e of entries) {
-        const value = !isClientMap && e.annotateClient
-            ? `{ ${e.valueExpr}, componentType: 'client' }`
-            : e.valueExpr.includes('...')
-                ? `{ ${e.valueExpr} }`
-                : e.valueExpr;
-        componentMapEntries.push(`['${e.key}', ${value}]`);
-    }
-    // Add package-based entries
-    componentImports === null || componentImports === void 0 ? void 0 : componentImports.forEach((pkg) => {
-        if (pkg.importInfo.namedImports) {
-            pkg.importInfo.namedImports.forEach((name) => {
-                componentMapEntries.push(`['${name}', ${name}]`);
-            });
-        }
-        else {
-            componentMapEntries.push(`['${pkg.importName}', ${pkg.importName}]`);
-        }
-    });
+`;
+    const builtInMapEntries = options.builtInMapEntries || [
+        `['BYOCWrapper', BYOCWrapper]`,
+        `['FEaaSWrapper', FEaaSWrapper]`,
+        `['Form', Form]`,
+    ];
+    // Add per-entry imports
+    entries.forEach((e) => wildcardImports.push(...e.imports));
+    // Handle package imports
+    componentImports === null || componentImports === void 0 ? void 0 : componentImports.forEach((pkg) => {
+        if (pkg.importInfo.namedImports) {
+            namedImports.push(`import { ${pkg.importInfo.namedImports.join(', ')} } from '${pkg.importInfo.importFrom}';`);
+        }
+        else {
+            wildcardImports.push(`import * as ${pkg.importName} from '${pkg.importInfo.importFrom}';`);
+        }
+    });
+    const importLines = [
+        headerComment.includes('built-in') ? '// end of built-in components' : null,
+        ...wildcardImports,
+        ...namedImports,
+    ].filter(Boolean);
+    const importsSection = importLines.length ? `\n${importLines.join('\n')}` : '';
+    // Build entry lines (package named imports are appended below)
+    const componentMapEntries = builtInMapEntries;
+    for (const e of entries) {
+        const value = !isClientMap && e.annotateClient
+            ? `{ ${e.valueExpr}, componentType: 'client' }`
+            : e.valueExpr.includes('...')
+                ? `{ ${e.valueExpr} }`
+                : e.valueExpr;
+        componentMapEntries.push(`['${e.key}', ${value}]`);
+    }
+    // Add package-based entries
+    componentImports === null || componentImports === void 0 ? void 0 : componentImports.forEach((pkg) => {
+        if (pkg.importInfo.namedImports) {
+            pkg.importInfo.namedImports.forEach((name) => {
+                componentMapEntries.push(`['${name}', ${name}]`);
+            });
+        }
+        else {
+            componentMapEntries.push(`['${pkg.importName}', ${pkg.importName}]`);
+        }
+    });
     return `// ${headerComment}
 ${builtInImports}${importsSection}
 
 export const componentMap = new Map<string, NextjsContentSdkComponent>([
-${componentMapEntries
-        .map((component) => {
-        return `  ${component},\n`;
-    })
+${componentMapEntries
+        .map((component) => {
+        return `  ${component},\n`;
+    })
         .join('')}]);
 
 export default componentMap;
-`;
-};
-// default client template
-export const defaultClientMapTemplate = (components, componentImports, ctx) => {
-    var _a, _b;
+`;
+};
+// default client template
+export const defaultClientMapTemplate = (components, componentImports, ctx) => {
+    var _a, _b;
     const builtInImports = `
 import { BYOCClientWrapper, NextjsContentSdkComponent, FEaaSClientWrapper } from '@sitecore-content-sdk/nextjs';
 import { Form } from '@sitecore-content-sdk/nextjs';
-`;
-    const builtInMapEntries = [
-        `['BYOCWrapper', BYOCClientWrapper]`,
-        `['FEaaSWrapper', FEaaSClientWrapper]`,
-        `['Form', Form]`,
-    ];
-    const entries = (_a = ctx === null || ctx === void 0 ? void 0 : ctx.entries) !== null && _a !== void 0 ? _a : prepareComponentsForMap(components, {
-        includeVariants: (_b = ctx === null || ctx === void 0 ? void 0 : ctx.includeVariants) !== null && _b !== void 0 ? _b : true,
-    });
-    return buildNextjsMapContent(entries, componentImports, {
-        headerComment: 'Client-safe component map for App Router',
-        isClientMap: true,
-        builtInImports,
-        builtInMapEntries,
-    });
-};
-// Collect components from specified paths, apply exclude and type filter, and prepare map entries.
-const collectComponents = (opts) => {
-    const withTypes = getComponentListWithTypes(opts.paths, opts.exclude, opts.includeVariants);
-    const filtered = opts.filter === 'client'
-        ? filterComponentsByType(withTypes, ['client', 'universal'])
-        : withTypes;
-    for (const file of filtered) {
-        console.debug(`Registering Content SDK component ${file.componentName}`);
-    }
-    return {
-        raw: filtered,
-        entries: prepareComponentsForMap(filtered, { includeVariants: opts.includeVariants }),
-    };
-};
-/**
- * Generate and write componentMap.ts files based on provided params.
- *
- * When clientComponentMap is true, generates:
- * - component-map.ts          : Full component map with all components (server, client, universal)
- * - component-map.client.ts   : Client-safe map with only client + universal components
- *
- * When clientComponentMap is false, generates:
- * - component-map.ts          : Single component map (traditional behavior)
- *
- * When includeVariants is true (in either mode):
- * - Includes component **variants** in the generated map(s) alongside base components
- * - Preserves the same client/server filtering rules (variants obey clientComponentMap filtering)
- * - Variant entries are emitted using the same naming/keys convention as their base components
- *
- * Template Customization:
- * - mapTemplate: Custom template for main component map (works for both single and dual map modes)
- * - clientMapTemplate: Custom template for client component map (only used when clientComponentMap is true)
- * @param {GenerateMapArgs} param0 params for generateMap
- */
-export const generateMap = ({ paths, destination = '.sitecore', exclude, componentImports, mapTemplate, clientMapTemplate, clientComponentMap, includeVariants = true, }) => {
-    const isAppRouter = detectRouterType() === 'app';
-    const shouldGenerateClientMap = clientComponentMap !== null && clientComponentMap !== void 0 ? clientComponentMap : isAppRouter;
-    if (shouldGenerateClientMap) {
-        // App Router case, main map
-        const getComponents = collectComponents({ paths, exclude, includeVariants, filter: 'all' });
-        let mainContent;
-        if (mapTemplate) {
-            mainContent = mapTemplate(getComponents.raw, componentImports, {
-                entries: getComponents.entries,
-                includeVariants,
-                isClientMap: false,
-            });
-        }
-        else {
-            // default app router server map
+`;
+    const builtInMapEntries = [
+        `['BYOCWrapper', BYOCClientWrapper]`,
+        `['FEaaSWrapper', FEaaSClientWrapper]`,
+        `['Form', Form]`,
+    ];
+    const entries = (_a = ctx === null || ctx === void 0 ? void 0 : ctx.entries) !== null && _a !== void 0 ? _a : prepareComponentsForMap(components, {
+        includeVariants: (_b = ctx === null || ctx === void 0 ? void 0 : ctx.includeVariants) !== null && _b !== void 0 ? _b : true,
+    });
+    return buildNextjsMapContent(entries, componentImports, {
+        headerComment: 'Client-safe component map for App Router',
+        isClientMap: true,
+        builtInImports,
+        builtInMapEntries,
+    });
+};
+// Collect components from specified paths, apply exclude and type filter, and prepare map entries.
+const collectComponents = (opts) => {
+    const withTypes = getComponentListWithTypes(opts.paths, opts.exclude, opts.includeVariants);
+    const filtered = opts.filter === 'client'
+        ? filterComponentsByType(withTypes, ['client', 'universal'])
+        : withTypes;
+    for (const file of filtered) {
+        console.debug(`Registering Content SDK component ${file.componentName}`);
+    }
+    return {
+        raw: filtered,
+        entries: prepareComponentsForMap(filtered, { includeVariants: opts.includeVariants }),
+    };
+};
+/**
+ * Generate and write componentMap.ts files based on provided params.
+ *
+ * When clientComponentMap is true, generates:
+ * - component-map.ts          : Full component map with all components (server, client, universal)
+ * - component-map.client.ts   : Client-safe map with only client + universal components
+ *
+ * When clientComponentMap is false, generates:
+ * - component-map.ts          : Single component map (traditional behavior)
+ *
+ * When includeVariants is true (in either mode):
+ * - Includes component **variants** in the generated map(s) alongside base components
+ * - Preserves the same client/server filtering rules (variants obey clientComponentMap filtering)
+ * - Variant entries are emitted using the same naming/keys convention as their base components
+ *
+ * Template Customization:
+ * - mapTemplate: Custom template for main component map (works for both single and dual map modes)
+ * - clientMapTemplate: Custom template for client component map (only used when clientComponentMap is true)
+ * @param {GenerateMapArgs} params - The parameters for the generateMap function.
+ * @public
+ */
+export const generateMap = ({ paths, destination = '.sitecore', exclude, componentImports, mapTemplate, clientMapTemplate, clientComponentMap, includeVariants = true, }) => {
+    const isAppRouter = detectRouterType() === 'app';
+    const shouldGenerateClientMap = clientComponentMap !== null && clientComponentMap !== void 0 ? clientComponentMap : isAppRouter;
+    if (shouldGenerateClientMap) {
+        // App Router case, main map
+        const getComponents = collectComponents({ paths, exclude, includeVariants, filter: 'all' });
+        let mainContent;
+        if (mapTemplate) {
+            mainContent = mapTemplate(getComponents.raw, componentImports, {
+                entries: getComponents.entries,
+                includeVariants,
+                isClientMap: false,
+            });
+        }
+        else {
+            // default app router server map
             const builtInImports = `
 import { BYOCServerWrapper, NextjsContentSdkComponent, FEaaSServerWrapper } from '@sitecore-content-sdk/nextjs';
 import { Form } from '@sitecore-content-sdk/nextjs';
-`;
-            const builtInMapEntries = [
-                `['BYOCWrapper', BYOCServerWrapper]`,
-                `['FEaaSWrapper', FEaaSServerWrapper]`,
-                `['Form', Form]`,
-            ];
-            mainContent = buildNextjsMapContent(getComponents.entries, componentImports, {
-                headerComment: "Below are built-in components that are available in the app, it's recommended to keep them as is",
-                isClientMap: false,
-                builtInImports,
-                builtInMapEntries,
-            });
-        }
-        fs.writeFileSync(path.join(process.cwd(), destination, 'component-map.ts'), mainContent, 'utf8');
-        // App Router, client map
-        const clientComponents = collectComponents({
-            paths,
-            exclude,
-            includeVariants,
-            filter: 'client',
-        });
-        const clientTemplate = clientMapTemplate || defaultClientMapTemplate;
-        let clientContent;
-        if (clientTemplate.length >= 2) {
-            clientContent = clientTemplate(clientComponents.raw, componentImports);
-        }
-        else {
-            clientContent = clientTemplate(clientComponents.raw, componentImports, {
-                entries: clientComponents.entries,
-                includeVariants,
-                isClientMap: true,
-            });
-        }
-        fs.writeFileSync(path.join(process.cwd(), destination, 'component-map.client.ts'), clientContent, 'utf8');
-    }
-    else {
-        // Either in pages/app router or clientComponentMap = false
-        const components = collectComponents({
-            paths,
-            exclude,
-            includeVariants,
-            filter: 'all',
-        }).entries;
-        const content = buildNextjsMapContent(components, componentImports, {
-            headerComment: "Below are built-in components that are available in the app, it's recommended to keep them as is",
-            isClientMap: false,
-        });
-        fs.writeFileSync(path.join(process.cwd(), destination, 'component-map.ts'), content, 'utf8');
-        // For App Router compatibility, always generate client map file even when clientComponentMap is false
-        // When clientComponentMap is false, only include built-in components (no custom client components)
-        if (shouldGenerateClientMap || isAppRouter) {
-            const clientMapTemplateToUse = clientMapTemplate || defaultClientMapTemplate;
-            const components = collectComponents({ paths: [], includeVariants, filter: 'all' });
-            let clientMapContent;
-            if (clientMapTemplateToUse.length >= 2) {
-                clientMapContent = clientMapTemplateToUse([], componentImports);
-            }
-            else {
-                clientMapContent = clientMapTemplateToUse([], componentImports, {
-                    entries: components.entries,
-                    includeVariants,
-                    isClientMap: true,
-                });
-            }
-            const clientMapFile = path.join(process.cwd(), destination, 'component-map.client.ts');
-            try {
-                fs.writeFileSync(clientMapFile, clientMapContent, { encoding: 'utf8' });
-            }
-            catch (error) {
-                console.error(`Client Component Map generation failed. Error writing to file ${destination}:`, error);
-                throw error;
-            }
-        }
-    }
-};
+`;
+            const builtInMapEntries = [
+                `['BYOCWrapper', BYOCServerWrapper]`,
+                `['FEaaSWrapper', FEaaSServerWrapper]`,
+                `['Form', Form]`,
+            ];
+            mainContent = buildNextjsMapContent(getComponents.entries, componentImports, {
+                headerComment: "Below are built-in components that are available in the app, it's recommended to keep them as is",
+                isClientMap: false,
+                builtInImports,
+                builtInMapEntries,
+            });
+        }
+        fs.writeFileSync(path.join(process.cwd(), destination, 'component-map.ts'), mainContent, 'utf8');
+        // App Router, client map
+        const clientComponents = collectComponents({
+            paths,
+            exclude,
+            includeVariants,
+            filter: 'client',
+        });
+        const clientTemplate = clientMapTemplate || defaultClientMapTemplate;
+        let clientContent;
+        if (clientTemplate.length >= 2) {
+            clientContent = clientTemplate(clientComponents.raw, componentImports);
+        }
+        else {
+            clientContent = clientTemplate(clientComponents.raw, componentImports, {
+                entries: clientComponents.entries,
+                includeVariants,
+                isClientMap: true,
+            });
+        }
+        fs.writeFileSync(path.join(process.cwd(), destination, 'component-map.client.ts'), clientContent, 'utf8');
+    }
+    else {
+        // Either in pages/app router or clientComponentMap = false
+        const components = collectComponents({
+            paths,
+            exclude,
+            includeVariants,
+            filter: 'all',
+        }).entries;
+        const content = buildNextjsMapContent(components, componentImports, {
+            headerComment: "Below are built-in components that are available in the app, it's recommended to keep them as is",
+            isClientMap: false,
+        });
+        fs.writeFileSync(path.join(process.cwd(), destination, 'component-map.ts'), content, 'utf8');
+        // For App Router compatibility, always generate client map file even when clientComponentMap is false
+        // When clientComponentMap is false, only include built-in components (no custom client components)
+        if (shouldGenerateClientMap || isAppRouter) {
+            const clientMapTemplateToUse = clientMapTemplate || defaultClientMapTemplate;
+            const components = collectComponents({ paths: [], includeVariants, filter: 'all' });
+            let clientMapContent;
+            if (clientMapTemplateToUse.length >= 2) {
+                clientMapContent = clientMapTemplateToUse([], componentImports);
+            }
+            else {
+                clientMapContent = clientMapTemplateToUse([], componentImports, {
+                    entries: components.entries,
+                    includeVariants,
+                    isClientMap: true,
+                });
+            }
+            const clientMapFile = path.join(process.cwd(), destination, 'component-map.client.ts');
+            try {
+                fs.writeFileSync(clientMapFile, clientMapContent, { encoding: 'utf8' });
+            }
+            catch (error) {
+                console.error(`Client Component Map generation failed. Error writing to file ${destination}:`, error);
+                throw error;
+            }
+        }
+    }
+};

package/dist/esm/tools/index.js

@@ -1,2 +1,3 @@
-export { generateSites, generateMetadata, getComponentList, generatePlugins, ModuleType, extractFiles, writeImportMap, } from '@sitecore-content-sdk/core/tools';
-export { generateMap } from './generate-map';
+export { generateSites, generateMetadata, getComponentList, generatePlugins, ModuleType, extractFiles, } from '@sitecore-content-sdk/core/tools';
+export { generateMap } from './generate-map';
+export { writeImportMap } from './codegen/import-map';