@sitecore-content-sdk/content 2.2.1 → 2.3.0-beta.atoms.20260721120640

package/dist/esm/tools/templating/utils.js

@@ -1,159 +0,0 @@
-import path from 'path';
-const DEFAULT_HEADER_COMMENT = "Below are built-in components that are available in the app, it's recommended to keep them as is";
-/**
- * Transform component description entries for the component map.
- * @param {ComponentSource[]} components - The components to transform.
- * @param {object} opts - The options for the transformation.
- * @param {boolean} opts.includeVariants - Whether to include variants in the component map.
- * @param {boolean} opts.shouldAnnotateClient - Whether to annotate the client in the component map. Used in frameworks that make server/client distinction.
- * @returns {ComponentMapEntry[]} The transformed component description entries.
- * @internal
- */
-export const prepareComponentsForMap = (components, opts) => {
-    var _a;
-    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 = opts.shouldAnnotateClient
-                ? !!group.base && 'componentType' in group.base && group.base.componentType === 'client'
-                : false;
-            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 = opts.shouldAnnotateClient
-                    ? 'componentType' in group.base && group.base.componentType === 'client'
-                    : false;
-                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: (_a = opts.shouldAnnotateClient) !== null && _a !== void 0 ? _a : false,
-                });
-            }
-        }
-    }
-    return entries;
-};
-/**
- * Cross framework function to build the component map content.
- * @param {ComponentMapEntry[]} entries - The entries to build the component map content for.
- * @param {ComponentImport[] | undefined} componentImports - The component imports to build the component map content for.
- * @param {TemplateOptions} options - The options for the buildComponentMapContent function.
- * @returns {string} The component map content.
- * @internal
- */
-export const buildComponentMapContent = (entries, componentImports, options) => {
-    const { headerComment = DEFAULT_HEADER_COMMENT, isClientMap = false, framework, builtInImports = '', builtInMapEntries = [], } = options;
-    if (!framework) {
-        throw new Error('options.framework is required to build the component map');
-    }
-    const frameworkComponentTypeName = `${framework.charAt(0).toUpperCase() + framework.slice(1)}ContentSdkComponent`;
-    const frameworkImportString = `import { ${frameworkComponentTypeName} } from '@sitecore-content-sdk/${framework}';\n`;
-    const wildcardImports = [];
-    const namedImports = [];
-    // 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 = [
-        builtInImports.length ? '// end of built-in import section' : null,
-        ...wildcardImports,
-        ...namedImports,
-    ].filter(Boolean);
-    const importsSection = importLines.length ? `\n${importLines.join('\n')}` : '';
-    // Clone to avoid mutating the caller's array
-    const componentMapEntries = structuredClone(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}
-${frameworkImportString}
-${builtInImports}${importsSection}
-
-export const componentMap = new Map<string, ${frameworkComponentTypeName}>([
-${componentMapEntries
-        .map((component) => {
-        return `  ${component},\n`;
-    })
-        .join('')}]);
-
-export default componentMap;
-`;
-};

package/types/layout/field-types.d.ts

@@ -1,75 +0,0 @@
-import type { FieldMetadata } from './models';
-/**
- * The interface for the Link field value.
- * @public
- */
-export interface LinkFieldValue {
-    [attributeName: string]: unknown;
-    href?: string;
-    className?: string;
-    class?: string;
-    title?: string;
-    target?: string;
-    text?: string;
-    anchor?: string;
-    querystring?: string;
-    linktype?: string;
-}
-/**
- * The interface for the Link field.
- * @public
- */
-export interface LinkField {
-    value: LinkFieldValue;
-}
-/**
- * The interface for the Image field value.
- * @public
- */
-export interface ImageFieldValue {
-    [attributeName: string]: unknown;
-    src?: string;
-}
-/**
- * The interface for the Image field.
- * @public
- */
-export interface ImageField {
-    value?: ImageFieldValue;
-}
-/**
- * The interface for the Image size parameters.
- * @public
- */
-export interface ImageSizeParameters {
-    [attr: string]: string | number | undefined;
-    /** Fixed width of the image */
-    w?: number;
-    /** Fixed height of the image */
-    h?: number;
-    /** Max width of the image */
-    mw?: number;
-    /** Max height of the image */
-    mh?: number;
-    /** Ignore aspect ratio */
-    iar?: 1 | 0;
-    /** Allow stretch */
-    as?: 1 | 0;
-    /** Image scale. Defaults to 1.0 */
-    sc?: number;
-}
-/**
- * The interface for the Text field.
- * @public
- */
-export interface TextField extends FieldMetadata {
-    value?: string | number;
-}
-/**
- * The interface for the Rich Text field.
- * @public
- */
-export interface RichTextField extends FieldMetadata {
-    value?: string;
-}
-//# sourceMappingURL=field-types.d.ts.map

package/types/layout/field-types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"field-types.d.ts","sourceRoot":"","sources":["../../src/layout/field-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,cAAc,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC;CAEd;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAC5C,+BAA+B;IAC/B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,6BAA6B;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,8BAA8B;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0BAA0B;IAC1B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACZ,oBAAoB;IACpB,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACX,mCAAmC;IACnC,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,aAAa;IAC9C,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

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

@@ -1,44 +0,0 @@
-import { ComponentFile, ComponentFileWithType, ComponentImport, ComponentMapEntry } from './components';
-/**
- * A component source can be either a file or a file with type information.
- */
-type ComponentSource = ComponentFile | ComponentFileWithType;
-/**
- * Template options for component map generation
- */
-type TemplateOptions = {
-    /** Custom header comment for the generated map */
-    headerComment?: string;
-    /** Whether this is a client-only map (no need for componentType annotations). Only used in frameworks that make server/client distinction. */
-    isClientMap?: boolean;
-    /** Built-in imports string to include in the map */
-    builtInImports?: string;
-    /** Built-in map entries to include in the map */
-    builtInMapEntries?: string[];
-    /** Framework name to use in the component map */
-    framework: string;
-};
-/**
- * Transform component description entries for the component map.
- * @param {ComponentSource[]} components - The components to transform.
- * @param {object} opts - The options for the transformation.
- * @param {boolean} opts.includeVariants - Whether to include variants in the component map.
- * @param {boolean} opts.shouldAnnotateClient - Whether to annotate the client in the component map. Used in frameworks that make server/client distinction.
- * @returns {ComponentMapEntry[]} The transformed component description entries.
- * @internal
- */
-export declare const prepareComponentsForMap: (components: ComponentSource[], opts: {
-    includeVariants: boolean;
-    shouldAnnotateClient?: boolean;
-}) => ComponentMapEntry[];
-/**
- * Cross framework function to build the component map content.
- * @param {ComponentMapEntry[]} entries - The entries to build the component map content for.
- * @param {ComponentImport[] | undefined} componentImports - The component imports to build the component map content for.
- * @param {TemplateOptions} options - The options for the buildComponentMapContent function.
- * @returns {string} The component map content.
- * @internal
- */
-export declare const buildComponentMapContent: (entries: ComponentMapEntry[], componentImports: ComponentImport[] | undefined, options: TemplateOptions) => string;
-export {};
-//# sourceMappingURL=utils.d.ts.map

package/types/tools/templating/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/tools/templating/utils.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,qBAAqB,EACrB,eAAe,EACf,iBAAiB,EAClB,MAAM,cAAc,CAAC;AAKtB;;GAEG;AACH,KAAK,eAAe,GAAG,aAAa,GAAG,qBAAqB,CAAC;AAE7D;;GAEG;AACH,KAAK,eAAe,GAAG;IACrB,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,GAClC,YAAY,eAAe,EAAE,EAC7B,MAAM;IAAE,eAAe,EAAE,OAAO,CAAC;IAAC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAAE,KACjE,iBAAiB,EAqFnB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,GACnC,SAAS,iBAAiB,EAAE,EAC5B,kBAAkB,eAAe,EAAE,GAAG,SAAS,EAC/C,SAAS,eAAe,KACvB,MA8EF,CAAC"}