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

package/types/tools/generateSites.d.ts

@@ -1,22 +1,25 @@
-import { SitecoreConfig } from '../config';
-/**
- * Configuration object for generating sites.
- */
-export type GenerateSitesConfig = {
-    /**
-     * The Sitecore configuration used at build and run time.
-     * @deprecated Pass `config` to the `defineCliConfig` function instead. This argument will be removed in the next major version.
-     */
-    scConfig?: SitecoreConfig;
-    /**
-     * Optional path where the generated sites will be saved.
-     * If not provided, the default '.sitecore/sites.json' will be used.
-     */
-    destinationPath?: string;
-};
-/**
- * Generates site information and writes it to a specified destination path.
- * @param {GenerateSitesConfig} config - The configuration for generating site info.
- * @returns {Promise<Function>} - A promise that resolves to an asynchronous function that fetches site information and writes it to a file.
- */
-export declare const generateSites: ({ scConfig: deprecatedScConfig, destinationPath, }?: GenerateSitesConfig) => (() => Promise<void>);
+import { SitecoreConfig } from '../config';
+/**
+ * Configuration object for generating sites.
+ * @public
+ */
+export type GenerateSitesConfig = {
+    /**
+     * The Sitecore configuration used at build and run time.
+     * @deprecated Pass `config` to the `defineCliConfig` function instead. This argument will be removed in the next major version.
+     */
+    scConfig?: SitecoreConfig;
+    /**
+     * Optional path where the generated sites will be saved.
+     * If not provided, the default '.sitecore/sites.json' will be used.
+     */
+    destinationPath?: string;
+};
+/**
+ * Generates site information and writes it to a specified destination path.
+ * @param {GenerateSitesConfig} config - The configuration for generating site info.
+ * @returns {Promise<Function>} - A promise that resolves to an asynchronous function that fetches site information and writes it to a file.
+ * @public
+ */
+export declare const generateSites: ({ scConfig: deprecatedScConfig, destinationPath, }?: GenerateSitesConfig) => (() => Promise<void>);
+//# sourceMappingURL=generateSites.d.ts.map

package/types/tools/generateSites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateSites.d.ts","sourceRoot":"","sources":["../../src/tools/generateSites.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAK3C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,qDAG3B,mBAAwB,KAAG,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CA8CjD,CAAC"}

package/types/tools/index.d.ts

@@ -1,20 +1,22 @@
-export { generateSites, GenerateSitesConfig } from './generateSites';
-export { generateMetadata } from './generateMetadata';
-export { scaffoldComponent } from './scaffold';
-export { GenerateMapFunction, GenerateMapArgs } from './generate-map';
-export { extractFiles } from './codegen/extract-files';
-export { writeImportMap } from './codegen/import-map';
-export { getComponentSpec, getComponentSpecUrl } from './codegen/component-generation';
-export * from './templating';
-export * from './auth/models';
-import * as authModule from './auth';
-/**
- * Preserve "live binding" semantics similar to ES module imports: production
- * code always sees the current implementation; tests can swap it safely and
- * restore via `sandbox.restore()` with no hidden global state.
- *
- * Public surface consumed by the rest of the codebase.
- */
-export declare const auth: {
-    readonly clientCredentialsFlow: typeof authModule.clientCredentialsFlow;
-};
+export { generateSites, GenerateSitesConfig } from './generateSites';
+export { generateMetadata } from './generateMetadata';
+export { scaffoldComponent } from './scaffold';
+export { GenerateMapFunction, GenerateMapArgs } from './generate-map';
+export { extractFiles } from './codegen/extract-files';
+export { writeImportMap, WriteImportMapArgs, WriteImportMapArgsInternal, defaultMapTemplate as defaultImportMapTemplate, ModuleExports, } from './codegen/import-map';
+export { getComponentSpec, getComponentSpecUrl } from './codegen/component-generation';
+export * from './templating';
+export * from './auth/models';
+import * as authModule from './auth';
+/**
+ * Preserve "live binding" semantics similar to ES module imports: production
+ * code always sees the current implementation; tests can swap it safely and
+ * restore via `sandbox.restore()` with no hidden global state.
+ *
+ * Public surface consumed by the rest of the codebase.
+ * @public
+ */
+export declare const auth: {
+    readonly clientCredentialsFlow: typeof authModule.clientCredentialsFlow;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tools/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC1B,kBAAkB,IAAI,wBAAwB,EAC9C,aAAa,GACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACvF,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,OAAO,KAAK,UAAU,MAAM,QAAQ,CAAC;AAErC;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB,QAAQ,CAAC,qBAAqB,EAAE,OAAO,UAAU,CAAC,qBAAqB,CAAC;CAC7D,CAAC"}

package/types/tools/scaffold.d.ts

@@ -1,25 +1,27 @@
-import { ScaffoldTemplate } from '../config';
-/**
- * Force to use `crlf` line endings, we are using `crlf` across the project.
- * Replace: `lf` (\n), `cr` (\r)
- * @param {string} content
- */
-export declare function editLineEndings(content: string): string;
-/**
- * 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 declare function scaffoldFile(filePath: string, fileContent: string): string | null;
-/**
- * Scaffolds a new component based on the provided template.
- * @param {string} outputFolderPath - The file path where the component will be created.
- * @param {string} componentName - The name of the component to be created.
- * @param {string} templateName - The name of the template to use for scaffolding. If not provided, defaults to 'byoc' if `byoc` is true, otherwise 'default'.
- * @param {ScaffoldTemplate[]} templates - An array of template objects, each containing a name, a template function, and a getNextSteps function.
- * @throws Will throw an error if the specified template is not found.
- */
-export declare function scaffoldComponent(outputFolderPath: string, componentName: string, templateName: string, templates: ScaffoldTemplate[]): void;
+import { ScaffoldTemplate } from '../config';
+/**
+ * Force to use `crlf` line endings, we are using `crlf` across the project.
+ * Replace: `lf` (\n), `cr` (\r)
+ * @param {string} content
+ */
+export declare function editLineEndings(content: string): string;
+/**
+ * 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 declare function scaffoldFile(filePath: string, fileContent: string): string | null;
+/**
+ * Scaffolds a new component based on the provided template.
+ * @param {string} outputFolderPath - The file path where the component will be created.
+ * @param {string} componentName - The name of the component to be created.
+ * @param {string} templateName - The name of the template to use for scaffolding. If not provided, defaults to 'byoc' if `byoc` is true, otherwise 'default'.
+ * @param {ScaffoldTemplate[]} templates - An array of template objects, each containing a name, a template function, and a getNextSteps function.
+ * @throws Will throw an error if the specified template is not found.
+ * @internal
+ */
+export declare function scaffoldComponent(outputFolderPath: string, componentName: string, templateName: string, templates: ScaffoldTemplate[]): void;
+//# sourceMappingURL=scaffold.d.ts.map

package/types/tools/scaffold.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../../src/tools/scaffold.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,UAE9C;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAajF;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,gBAAgB,EAAE,GAC5B,IAAI,CAwBN"}

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

@@ -1,103 +1,104 @@
-export declare let getComponentList: typeof _getComponentList;
-export declare const componentUnitMocks: {
-    getComponentList: typeof _getComponentList;
-};
-export type ComponentType = 'server' | 'client' | 'universal';
-export type RouterType = 'app' | 'pages';
-export type ComponentMapTemplate = (components: (ComponentFile | ComponentFileWithType)[], componentImports?: ComponentImport[]) => string;
-export type EnhancedComponentMapTemplate = (components: (ComponentFile | ComponentFileWithType)[], componentImports: ComponentImport[] | undefined, ctx: {
-    entries: ComponentMapEntry[];
-    includeVariants: boolean;
-    isClientMap: boolean;
-}) => string;
-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
- */
-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;
-}
-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
- */
-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[];
-/**
- * Detects the Next.js router type (App Router or Pages Router) based on directory structure.
- * @param {string} projectRoot - The project root directory. Defaults to current working directory.
- * @returns {RouterType} 'app' if App Router is detected, 'pages' otherwise
- */
-export declare function detectRouterType(projectRoot?: string): RouterType;
-/**
- * Detects the component type based on directives, imports, and router context.
- * - Checks for 'use client' directive
- * - Checks for explicit componentType export
- * - Checks for server-only imports (next/headers, etc.)
- * - Defaults to 'server' for App Router, 'universal' for Pages Router
- * @param {string} filePath - Path to the component file
- * @param {RouterType} [routerType] - Optional router type override. Auto-detected if not provided.
- * @returns {ComponentType} 'server', 'client', or 'universal'
- */
-export declare function detectComponentType(filePath: string, routerType?: RouterType): ComponentType;
-/**
- * Get list of components with detected types (server, client, or universal).
- * @param {string[]} paths - Paths to search for components
- * @param {string[]} [exclude] - Paths and glob patterns to exclude from final result
- * @param {boolean} includeVariants - Whether to include variant components
- * @param {RouterType} [routerType] - Optional router type override for type detection. Auto-detected if not provided.
- * @returns {ComponentFileWithType[]} Array of components with their detected types
- */
-export declare function getComponentListWithTypes(paths: string[], exclude?: string[], includeVariants?: boolean, routerType?: RouterType): ComponentFileWithType[];
-/**
- * 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
- */
-export declare function filterComponentsByType(components: ComponentFileWithType[], allowedTypes: ComponentType[]): ComponentFileWithType[];
-export {};
+/**
+ * @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

@@ -1,3 +1,4 @@
-export { ComponentFile, ComponentImport, ComponentFileWithType, ComponentType, RouterType, getComponentList, detectRouterType, detectComponentType, getComponentListWithTypes, filterComponentsByType, ComponentMapEntry, ComponentMapTemplate, EnhancedComponentMapTemplate, } from './components';
-export { PluginDefinition, generatePlugins, ModuleType } from './plugins';
-export { matchPath } from './utils';
+export { ComponentFile, ComponentImport, ComponentFileWithType, ComponentType, RouterType, getComponentList, filterComponentsByType, ComponentMapEntry, ComponentMapTemplate, EnhancedComponentMapTemplate, } from './components';
+export { PluginDefinition, generatePlugins, ModuleType } from './plugins';
+export { matchPath } from './utils';
+//# 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;AACtB,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC"}

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

@@ -1,67 +1,71 @@
-/**
- * Identifies the format of the module to be compiled
- */
-export declare enum ModuleType {
-    CJS = 0,
-    ESM = 1
-}
-/**
- * Type to specify plugin file details
- */
-export interface PluginFile {
-    path: string;
-    name: string;
-}
-/**
- * Definition to be used for plugin registration during bootstrap
- */
-export interface PluginDefinition {
-    /**
-     * destination path to compile plugins to
-     */
-    distPath: string;
-    /**
-     * source path for where the plugins are defined
-     */
-    rootPath: string;
-    /**
-     * CJS or ESM - which type to compile plugins to
-     */
-    moduleType: ModuleType;
-    /**
-     * whether to use relative or absolute paths in the generated file. By default, absolute paths are used.
-     */
-    relative?: boolean;
-    /**
-     * whether to suppress console output
-     */
-    silent?: boolean;
-}
-/**
- * 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 declare function getPluginList({ path, pluginName, silent, }: {
-    path: string;
-    pluginName: string;
-    silent?: boolean;
-}): PluginFile[];
-/**
- * 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 declare function generatePlugins(definition: PluginDefinition): void;
+/**
+ * Identifies the format of the module to be compiled
+ * @public
+ */
+export declare enum ModuleType {
+    CJS = 0,
+    ESM = 1
+}
+/**
+ * Type to specify plugin file details
+ */
+export interface PluginFile {
+    path: string;
+    name: string;
+}
+/**
+ * Definition to be used for plugin registration during bootstrap
+ * @public
+ */
+export interface PluginDefinition {
+    /**
+     * destination path to compile plugins to
+     */
+    distPath: string;
+    /**
+     * source path for where the plugins are defined
+     */
+    rootPath: string;
+    /**
+     * CJS or ESM - which type to compile plugins to
+     */
+    moduleType: ModuleType;
+    /**
+     * whether to use relative or absolute paths in the generated file. By default, absolute paths are used.
+     */
+    relative?: boolean;
+    /**
+     * whether to suppress console output
+     */
+    silent?: boolean;
+}
+/**
+ * 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 declare function getPluginList({ path, pluginName, silent, }: {
+    path: string;
+    pluginName: string;
+    silent?: boolean;
+}): PluginFile[];
+/**
+ * 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
+ * @public
+ */
+export declare function generatePlugins(definition: PluginDefinition): void;
+//# sourceMappingURL=plugins.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../../../src/tools/templating/plugins.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,oBAAY,UAAU;IACpB,GAAG,IAAA;IACH,GAAG,IAAA;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,EAC5B,IAAI,EACJ,UAAU,EACV,MAAc,GACf,EAAE;IACD,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,UAAU,EAAE,CAWf;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,gBAAgB,QA8B3D"}

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

@@ -1,40 +1,42 @@
-/**
- * Settings for @var getItems function
- */
-export type GetItemsSettings<Item> = {
-    /**
-     * items path
-     */
-    path: string;
-    /**
-     * Resolve item in required data format
-     */
-    resolveItem: (path: string, name: string) => Item;
-    /**
-     * Will be called when new file is found
-     */
-    cb?: (name: string) => void;
-    exclude?: string[];
-    /**
-     * Matches specific files format
-     */
-    fileFormat?: RegExp;
-    /**
-     * Wether to search recursively
-     */
-    recursive?: boolean;
-};
-/**
- * Compares two paths to determine if they match.
- * @param {string} itemPath base path to compare against, can be absolute or relative
- * @param {string} compare comparer, can be relate, absolute or regex string
- * @returns true if paths match, false otherwise
- */
-export declare const matchPath: (itemPath: string, compare: string) => boolean;
-/**
- * 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 declare function getItems<Item>(settings: GetItemsSettings<Item>): Item[];
+/**
+ * Settings for @var getItems function
+ */
+export type GetItemsSettings<Item> = {
+    /**
+     * items path
+     */
+    path: string;
+    /**
+     * Resolve item in required data format
+     */
+    resolveItem: (path: string, name: string) => Item;
+    /**
+     * Will be called when new file is found
+     */
+    cb?: (name: string) => void;
+    exclude?: string[];
+    /**
+     * Matches specific files format
+     */
+    fileFormat?: RegExp;
+    /**
+     * Wether to search recursively
+     */
+    recursive?: boolean;
+};
+/**
+ * Compares two paths to determine if they match.
+ * @param {string} itemPath base path to compare against, can be absolute or relative
+ * @param {string} compare comparer, can be relate, absolute or regex string
+ * @returns true if paths match, false otherwise
+ * @public
+ */
+export declare const matchPath: (itemPath: string, compare: string) => boolean;
+/**
+ * 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 declare function getItems<Item>(settings: GetItemsSettings<Item>): Item[];
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/tools/templating/utils.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,IAAI;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD;;OAEG;IACH,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAE5B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,UAAU,MAAM,EAAE,SAAS,MAAM,KAAG,OAU7D,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CA8CvE"}