@sitecore-content-sdk/core 0.3.0-canary.2 → 0.3.0-canary.20

package/types/tools/generate-map.d.ts

@@ -0,0 +1,18 @@
+import { ComponentFile, ComponentImport } from './templating';
+export type GenerateMapFunction = (args: GenerateMapArgs) => void;
+/**
+ * Arguments for the generateMap function.
+ * @typedef GenerateMapArgs
+ * @property {string[]} paths - Array of component paths to include in component map.
+ * @property {string} [destination='src/.sitecore'] - Destination folder path for the generated map.
+ * @property {ComponentImport[]} [componentImports] - Optional array of package definitions for component imports to include in the map.
+ * @property {string[]} [exclude] - Optional array of glob paths to exclude from the map.
+ * @property {function} [mapTemplate] - Optional custom template function to generate the component map content.
+ */
+export type GenerateMapArgs = {
+    paths: string[];
+    destination?: string;
+    componentImports?: ComponentImport[];
+    exclude?: string[];
+    mapTemplate?: (components: ComponentFile[], componentImports?: ComponentImport[]) => string;
+};

package/types/tools/index.d.ts

@@ -1,4 +1,5 @@
 export { generateSites, GenerateSitesConfig } from './generateSites';
 export { generateMetadata } from './generateMetadata';
 export { scaffoldComponent } from './scaffold';
+export { GenerateMapFunction, GenerateMapArgs } from './generate-map';
 export * from './templating';

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

@@ -7,14 +7,20 @@ export interface ComponentFile {
     componentName: string;
 }
 /**
- * Describes a package and components to be imported
+ * Definition for custom components to be included in component map.
+ * Use this to define components imported from modules/dependencies/packages
+ * @typedef ComponentImport
+ * @property {string} importName - Name of the import.
+ * @property {object} importInfo - Information about how to import the package.
+ * @property {string} importInfo.importFrom - The path from which to import the component(s).
+ * @property {string[]} [importInfo.namedImports] - 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.
  */
-export interface PackageDefinition {
-    name: string;
-    components: {
-        moduleName: string;
-        componentName: string;
-    }[];
+export interface ComponentImport {
+    importName: string;
+    importInfo: {
+        importFrom: string;
+        namedImports?: string[];
+    };
 }
 /**
  * Get list of components from @var path
@@ -24,6 +30,7 @@ export interface PackageDefinition {
  *  componentName: 'ComponentName',
  *  moduleName: 'ComponentName'
  * }
- * @param {string} path path to search
+ * @param {string[]} paths paths to search
+ * @param {string[]} [exclude] paths and glob patterns to exclude from final result
  */
-export declare function getComponentList(path: string): ComponentFile[];
+export declare function getComponentList(paths: string[], exclude?: string[]): ComponentFile[];

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

@@ -1,2 +1,3 @@
-export { ComponentFile, PackageDefinition, getComponentList } from './components';
+export { ComponentFile, ComponentImport, getComponentList } from './components';
 export { PluginDefinition, generatePlugins, ModuleType } from './plugins';
+export { matchPath } from './utils';

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

@@ -14,6 +14,7 @@ export type GetItemsSettings<Item> = {
      * Will be called when new file is found
      */
     cb?: (name: string) => void;
+    exclude?: string[];
     /**
      * Matches specific files format
      */
@@ -23,6 +24,13 @@ export type GetItemsSettings<Item> = {
      */
     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.

package/dist/cjs/data-fetcher.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseError = void 0;
-exports.fetchData = fetchData;
-const utils_1 = require("./utils/utils");
-class ResponseError extends Error {
-    constructor(message, response) {
-        super(message);
-        Object.setPrototypeOf(this, ResponseError.prototype);
-        this.response = response;
-    }
-}
-exports.ResponseError = ResponseError;
-/**
- * @param {string} url the URL to request; may include query string
- * @param {HttpDataFetcher<T> | NativeDataFetcherFunction<T>} fetcher the fetcher to use to perform the request
- * @param {ParsedUrlQueryInput} params the query string parameters to send with the request
- */
-async function fetchData(url, fetcher, params = {}) {
-    const response = await fetcher((0, utils_1.resolveUrl)(url, params));
-    return response.data;
-}

package/dist/esm/data-fetcher.js

@@ -1,17 +0,0 @@
-import { resolveUrl } from './utils/utils';
-export class ResponseError extends Error {
-    constructor(message, response) {
-        super(message);
-        Object.setPrototypeOf(this, ResponseError.prototype);
-        this.response = response;
-    }
-}
-/**
- * @param {string} url the URL to request; may include query string
- * @param {HttpDataFetcher<T> | NativeDataFetcherFunction<T>} fetcher the fetcher to use to perform the request
- * @param {ParsedUrlQueryInput} params the query string parameters to send with the request
- */
-export async function fetchData(url, fetcher, params = {}) {
-    const response = await fetcher(resolveUrl(url, params));
-    return response.data;
-}

package/types/data-fetcher.d.ts

@@ -1,34 +0,0 @@
-import { NativeDataFetcherFunction } from './native-fetcher';
-import { ParsedUrlQueryInput } from 'querystring';
-/**
- * Response data for an HTTP request sent to an API
- * @template T the type of data model requested
- */
-export interface HttpResponse<T> {
-    /** HTTP status code of the response (i.e. 200, 404) */
-    status: number;
-    /** HTTP status text of the response (i.e. 'OK', 'Bad Request') */
-    statusText: string;
-    /** Response content */
-    data: T;
-}
-/**
- * Describes functions that fetch data asynchronously (i.e. from an API endpoint).
- * This interface conforms to 'fetch' public API, but is adaptable to other HTTP libraries and
- * fetch polyfills.
- * The interface implementation must:
- * - Support SSR
- * - Comply with the rules of REST by returning appropriate response status codes when there is an error instead of throwing exceptions.
- * - Send HTTP POST requests if `data` param is specified; GET is suggested but not required for data-less requests
- */
-export type HttpDataFetcher<T> = (url: string, data?: unknown) => Promise<HttpResponse<T>>;
-export declare class ResponseError extends Error {
-    response: HttpResponse<unknown>;
-    constructor(message: string, response: HttpResponse<unknown>);
-}
-/**
- * @param {string} url the URL to request; may include query string
- * @param {HttpDataFetcher<T> | NativeDataFetcherFunction<T>} fetcher the fetcher to use to perform the request
- * @param {ParsedUrlQueryInput} params the query string parameters to send with the request
- */
-export declare function fetchData<T>(url: string, fetcher: HttpDataFetcher<T> | NativeDataFetcherFunction<T>, params?: ParsedUrlQueryInput): Promise<T>;