@sitecore-content-sdk/core 0.3.0-canary.13 → 0.3.0-canary.14

package/dist/cjs/config/cli/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineCliConfig = void 0;
+var define_cli_config_1 = require("./define-cli-config");
+Object.defineProperty(exports, "defineCliConfig", { enumerable: true, get: function () { return define_cli_config_1.defineCliConfig; } });

package/dist/cjs/config/index.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineCliConfig = exports.defineConfig = exports.ComponentTemplateType = void 0;
+exports.defineConfig = exports.ComponentTemplateType = void 0;
 var models_1 = require("./models");
 Object.defineProperty(exports, "ComponentTemplateType", { enumerable: true, get: function () { return models_1.ComponentTemplateType; } });
 var define_config_1 = require("./define-config");
 Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return define_config_1.defineConfig; } });
-var define_cli_config_1 = require("./define-cli-config");
-Object.defineProperty(exports, "defineCliConfig", { enumerable: true, get: function () { return define_cli_config_1.defineCliConfig; } });

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/tools/templating/components.js

@@ -1,7 +1,42 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getComponentList = getComponentList;
-const utils_1 = require("./utils");
+const glob = __importStar(require("glob"));
+const componentNamePattern = /^[\/]*(.+[\/\\])*(.+)\.[jt]sx?$/;
+const componentPathPattern = /^([\/]*.+[\/\\].+)\..+$/;
 /**
  * Get list of components from @var path
  * Returns a list of components in the following format:
@@ -10,17 +45,23 @@ const utils_1 = require("./utils");
  *  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
  */
-function getComponentList(path) {
-    const components = (0, utils_1.getItems)({
-        path,
-        resolveItem: (path, name) => ({
-            path: `${path}/${name}`,
-            componentName: name,
-            moduleName: name.replace(/[^\w]+/g, ''),
-        }),
-        cb: (name) => console.debug(`Registering Content SDK component ${name}`),
-    });
+function getComponentList(paths, exclude) {
+    const components = paths.reduce((result, path) => {
+        const globPath = glob.hasMagic(path, { magicalBraces: true }) || path.match(componentNamePattern)
+            ? path
+            : path.replace(/\/$/, '').concat('/*.{js,jsx,ts,tsx}');
+        return result.concat(...glob.sync(globPath, { ignore: exclude }).map((filePath) => {
+            const name = filePath.match(componentNamePattern)[2];
+            console.debug(`Registering Content SDK component ${name}`);
+            return {
+                path: filePath.match(componentPathPattern)[1].replace(/\\/g, '/'), // use forward slashes for consistency
+                componentName: name,
+                moduleName: name.replace(/[^\w]+/g, ''),
+            };
+        }));
+    }, []);
     return components;
 }

package/dist/cjs/tools/templating/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModuleType = exports.generatePlugins = exports.getComponentList = void 0;
+exports.matchPath = exports.ModuleType = exports.generatePlugins = exports.getComponentList = void 0;
 var components_1 = require("./components");
 Object.defineProperty(exports, "getComponentList", { enumerable: true, get: function () { return components_1.getComponentList; } });
 var plugins_1 = require("./plugins");
 Object.defineProperty(exports, "generatePlugins", { enumerable: true, get: function () { return plugins_1.generatePlugins; } });
 Object.defineProperty(exports, "ModuleType", { enumerable: true, get: function () { return plugins_1.ModuleType; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "matchPath", { enumerable: true, get: function () { return utils_1.matchPath; } });

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

@@ -3,8 +3,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchPath = void 0;
 exports.getItems = getItems;
 const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * 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
+ */
+const matchPath = (itemPath, compare) => {
+    if (compare === itemPath ||
+        path_1.default.join(process.cwd(), itemPath) === compare ||
+        itemPath === path_1.default.join(process.cwd(), compare) ||
+        new RegExp(compare).test(itemPath)) {
+        return true;
+    }
+    return false;
+};
+exports.matchPath = matchPath;
 /**
  * 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.
@@ -12,11 +30,17 @@ const fs_1 = __importDefault(require("fs"));
  * @returns {Item[]} list of items
  */
 function getItems(settings) {
-    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), } = settings;
+    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), exclude, } = settings;
     const items = [];
     const folders = [];
     if (!fs_1.default.existsSync(path))
         return [];
+    if (exclude) {
+        for (const exclusion of exclude) {
+            if ((0, exports.matchPath)(path, exclusion))
+                return [];
+        }
+    }
     fs_1.default.readdirSync(path, { withFileTypes: true }).forEach((item) => {
         if (item.isDirectory()) {
             folders.push(item);

package/dist/esm/config/cli/index.js

@@ -0,0 +1 @@
+export { defineCliConfig } from './define-cli-config';

package/dist/esm/config/index.js

@@ -1,3 +1,2 @@
 export { ComponentTemplateType, } from './models';
 export { defineConfig } from './define-config';
-export { defineCliConfig } from './define-cli-config';

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

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,6 @@
-import { getItems } from './utils';
+import * as glob from 'glob';
+const componentNamePattern = /^[\/]*(.+[\/\\])*(.+)\.[jt]sx?$/;
+const componentPathPattern = /^([\/]*.+[\/\\].+)\..+$/;
 /**
  * Get list of components from @var path
  * Returns a list of components in the following format:
@@ -7,17 +9,23 @@ import { getItems } from './utils';
  *  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 function getComponentList(path) {
-    const components = getItems({
-        path,
-        resolveItem: (path, name) => ({
-            path: `${path}/${name}`,
-            componentName: name,
-            moduleName: name.replace(/[^\w]+/g, ''),
-        }),
-        cb: (name) => console.debug(`Registering Content SDK component ${name}`),
-    });
+export function getComponentList(paths, exclude) {
+    const components = paths.reduce((result, path) => {
+        const globPath = glob.hasMagic(path, { magicalBraces: true }) || path.match(componentNamePattern)
+            ? path
+            : path.replace(/\/$/, '').concat('/*.{js,jsx,ts,tsx}');
+        return result.concat(...glob.sync(globPath, { ignore: exclude }).map((filePath) => {
+            const name = filePath.match(componentNamePattern)[2];
+            console.debug(`Registering Content SDK component ${name}`);
+            return {
+                path: filePath.match(componentPathPattern)[1].replace(/\\/g, '/'), // use forward slashes for consistency
+                componentName: name,
+                moduleName: name.replace(/[^\w]+/g, ''),
+            };
+        }));
+    }, []);
     return components;
 }

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

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

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

@@ -1,4 +1,20 @@
 import fs from 'fs';
+import path from 'path';
+/**
+ * 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 const matchPath = (itemPath, compare) => {
+    if (compare === itemPath ||
+        path.join(process.cwd(), itemPath) === compare ||
+        itemPath === path.join(process.cwd(), compare) ||
+        new RegExp(compare).test(itemPath)) {
+        return true;
+    }
+    return false;
+};
 /**
  * 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.
@@ -6,11 +22,17 @@ import fs from 'fs';
  * @returns {Item[]} list of items
  */
 export function getItems(settings) {
-    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), } = settings;
+    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), exclude, } = settings;
     const items = [];
     const folders = [];
     if (!fs.existsSync(path))
         return [];
+    if (exclude) {
+        for (const exclusion of exclude) {
+            if (matchPath(path, exclusion))
+                return [];
+        }
+    }
     fs.readdirSync(path, { withFileTypes: true }).forEach((item) => {
         if (item.isDirectory()) {
             folders.push(item);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.3.0-canary.13",
+  "version": "0.3.0-canary.14",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -69,6 +69,7 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "debug": "^4.4.0",
+    "glob": "^11.0.2",
     "graphql": "^16.11.0",
     "graphql-request": "^6.1.0",
     "memory-cache": "^0.2.0",
@@ -77,7 +78,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "60ee93b0b1dd958cd163cb2b157630d091a7bc70",
+  "gitHead": "62a8c4708e0be2ed7000f1dad2864500e8df7e40",
   "files": [
     "dist",
     "types",

package/types/config/{define-cli-config.d.ts → cli/define-cli-config.d.ts}

@@ -1,4 +1,4 @@
-import { SitecoreCliConfig, SitecoreCliConfigInput } from './models';
+import { SitecoreCliConfig, SitecoreCliConfigInput } from '../models';
 /**
  * Accepts a `SitecoreCliConfigInput` object and returns Sitecore Content SDK CLI configuration, updated with required default values
  * @param {SitecoreCliConfigInput} cliConfig the cli configuration provided by the application

package/types/config/cli/index.d.ts

@@ -0,0 +1 @@
+export { defineCliConfig } from './define-cli-config';

package/types/config/index.d.ts

@@ -1,3 +1,2 @@
 export { SitecoreConfig, SitecoreConfigInput, SitecoreCliConfig, SitecoreCliConfigInput, ScaffoldTemplate, ComponentTemplateType, DeepRequired, } from './models';
 export { defineConfig } from './define-config';
-export { defineCliConfig } from './define-cli-config';

package/types/config/models.d.ts

@@ -1,4 +1,5 @@
 import { RetryStrategy } from '../models';
+import { GenerateMapFunction, GenerateMapArgs } from '../tools';
 /**
  * Utility type to make every property in a type required
  */
@@ -205,6 +206,15 @@ export type SitecoreCliConfigInput = {
          */
         templates?: ScaffoldTemplate[];
     };
+    /**
+     * Configuration for the `sitecore-tools component generate-map` cli command
+     */
+    componentMap?: GenerateMapArgs & {
+        /**
+         * Function implementationt for generating a component map.
+         */
+        generator?: GenerateMapFunction;
+    };
 };
 /**
  * Final sitecore cli config type used required by the cli

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.