@sitecore-content-sdk/content 1.5.0-canary.10

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

@@ -0,0 +1,104 @@
+/**
+ * @public
+ */
+export declare let getComponentList: typeof _getComponentList;
+export declare const componentUnitMocks: {
+    getComponentList: typeof _getComponentList;
+};
+/**
+ * @internal
+ */
+export type ComponentType = 'server' | 'client' | 'universal';
+/**
+ * @internal
+ */
+export type RouterType = 'app' | 'pages';
+/**
+ * @internal
+ */
+export type ComponentMapTemplate = (components: (ComponentFile | ComponentFileWithType)[], componentImports?: ComponentImport[]) => string;
+/**
+ * @internal
+ */
+export type EnhancedComponentMapTemplate = (components: (ComponentFile | ComponentFileWithType)[], componentImports: ComponentImport[] | undefined, ctx: {
+    entries: ComponentMapEntry[];
+    includeVariants: boolean;
+    isClientMap: boolean;
+}) => string;
+/**
+ * An entry in the component map, including import lines and value expression.
+ * @internal
+ */
+export type ComponentMapEntry = {
+    /** map entry key */
+    key: string;
+    /** namespace import lines needed for this entry */
+    imports: string[];
+    /** whether base is client (and we're in main map) */
+    annotateClient: boolean;
+    /** expression used as the map value */
+    valueExpr: string;
+};
+/**
+ * Definition for a component file
+ * @public
+ */
+export interface ComponentFile {
+    /** The original file path of the component */
+    filePath: string;
+    /** Normalized path that can be used for import statements */
+    importPath: string;
+    /** Normalized name that can be used as import */
+    moduleName: string;
+    /** Name of the code file */
+    componentName: string;
+    /** Detected component type (server, client, or universal) */
+    componentType?: ComponentType;
+}
+/**
+ * Definition for a component file with guaranteed componentType
+ * @internal
+ */
+export interface ComponentFileWithType extends ComponentFile {
+    /** Detected component type (server, client, or universal) */
+    componentType: ComponentType;
+}
+/**
+ * Definition for custom components to be included in component map.
+ * Use this to define components imported from modules/dependencies/packages
+ * @public
+ */
+export interface ComponentImport {
+    /** The name of the import (e.g., 'MyComponent')*/
+    importName: string;
+    /** Information about how to import the package */
+    importInfo: {
+        /** The path from which to import the component(s) */
+        importFrom: string;
+        /** The specific named components to import from the package. Leave empty to have whole package be imported as wildcard and allow SXA variants support for component. */
+        namedImports?: string[];
+    };
+}
+/**
+ * Get list of components from @var path
+ * Returns a list of components in the following format:
+ * {
+ *  path: 'path/to/component',
+ *  componentName: 'ComponentName',
+ *  moduleName: 'ComponentName'
+ * }
+ * @param {string[]} paths paths to search
+ * @param {string[]} [exclude] paths and glob patterns to exclude from final result
+ * @param {boolean} [includeVariants] whether to include variant components
+ */
+declare function _getComponentList(paths: string[], exclude?: string[], includeVariants?: boolean): ComponentFile[];
+/**
+ * Filters components by their detected type.
+ * @param {ComponentFileWithType[]} components - Array of components with types
+ * @param {ComponentType[]} allowedTypes - Array of allowed component types to filter by
+ * @returns {ComponentFileWithType[]} Filtered array containing only components matching allowed types
+ * @internal
+ */
+export declare function filterComponentsByType(components: ComponentFileWithType[], allowedTypes: ComponentType[]): ComponentFileWithType[];
+export {};
+//# sourceMappingURL=components.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/tools/templating/components.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,IAAI,gBAAgB,0BAAoB,CAAC;AAEhD,eAAO,MAAM,kBAAkB;;CAO9B,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,OAAO,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,UAAU,EAAE,CAAC,aAAa,GAAG,qBAAqB,CAAC,EAAE,EACrD,gBAAgB,CAAC,EAAE,eAAe,EAAE,KACjC,MAAM,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,CACzC,UAAU,EAAE,CAAC,aAAa,GAAG,qBAAqB,CAAC,EAAE,EACrD,gBAAgB,EAAE,eAAe,EAAE,GAAG,SAAS,EAC/C,GAAG,EAAE;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7B,eAAe,EAAE,OAAO,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;CACtB,KACE,MAAM,CAAC;AAEZ;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oBAAoB;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,mDAAmD;IACnD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,qDAAqD;IACrD,cAAc,EAAE,OAAO,CAAC;IACxB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,6DAA6D;IAC7D,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IAC1D,6DAA6D;IAC7D,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,UAAU,EAAE;QACV,qDAAqD;QACrD,UAAU,EAAE,MAAM,CAAC;QACnB,wKAAwK;QACxK,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;KACzB,CAAC;CACH;AAED;;;;;;;;;;;GAWG;AACH,iBAAS,iBAAiB,CACxB,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,eAAe,CAAC,EAAE,OAAO,GACxB,aAAa,EAAE,CAyBjB;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,qBAAqB,EAAE,EACnC,YAAY,EAAE,aAAa,EAAE,GAC5B,qBAAqB,EAAE,CAEzB"}

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

@@ -0,0 +1,2 @@
+export { ComponentFile, ComponentImport, ComponentFileWithType, ComponentType, RouterType, getComponentList, filterComponentsByType, ComponentMapEntry, ComponentMapTemplate, EnhancedComponentMapTemplate, } from './components';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tools/templating/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,eAAe,EACf,qBAAqB,EACrB,aAAa,EACb,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,cAAc,CAAC"}