@sitecore-content-sdk/core 0.1.0-beta.22 → 0.1.0-beta.24

package/dist/cjs/tools/generateSites.js

@@ -7,21 +7,30 @@ exports.generateSites = void 0;
 const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 const fs_1 = __importDefault(require("fs"));
+const site_1 = require("../site");
 const ensurePath_1 = require("../utils/ensurePath");
+const client_1 = require("../client");
 const DEFAULT_SITES_DIST_PATH = '.sitecore/sites.json';
 /**
  * Generates site information and writes it to a specified destination path.
  * @param {GenerateSitesConfig} config - The configuration for generating site info.
- * @param {GraphQLSiteInfoService} config.siteInfoService - The service used to fetch site information.
+ * @param {GraphQLSiteInfoService} config.scConfig - The Sitecore configuration used at build and run time.
  * @param {string} config.destinationPath - The optional path where the generated sites file will be written. Defaults to '.sitecore/sites.json'.
  * @returns {Promise<Function>} - A promise that resolves to an asynchronous function that fetches site information and writes it to a file.
  */
-const generateSites = ({ multisiteEnabled, defaultSite, siteInfoService, destinationPath, }) => {
+const generateSites = ({ scConfig, destinationPath, }) => {
     return async () => {
         let sites = [];
         const sitesFilePath = path_1.default.resolve(destinationPath !== null && destinationPath !== void 0 ? destinationPath : DEFAULT_SITES_DIST_PATH);
-        if (multisiteEnabled) {
+        if (scConfig.multisite.enabled) {
             try {
+                const siteInfoService = new site_1.GraphQLSiteInfoService({
+                    clientFactory: (0, client_1.createGraphQLClientFactory)({
+                        api: scConfig.api,
+                        retries: scConfig.retries.count,
+                        retryStrategy: scConfig.retries.retryStrategy,
+                    }),
+                });
                 console.log('Fetching site information');
                 sites = await siteInfoService.fetchSiteInfo();
             }
@@ -30,6 +39,12 @@ const generateSites = ({ multisiteEnabled, defaultSite, siteInfoService, destina
                 console.error(error);
             }
         }
+        // Add default site to the list
+        const defaultSite = {
+            name: scConfig.defaultSite,
+            hostName: scConfig.multisite.defaultHostname,
+            language: scConfig.defaultLanguage,
+        };
         sites.unshift(defaultSite);
         (0, ensurePath_1.ensurePathExists)(sitesFilePath);
         console.log(`Writing site info to ${sitesFilePath}`);

package/dist/cjs/tools/scaffold.js

@@ -38,17 +38,18 @@ function scaffoldFile(filePath, fileContent) {
 }
 /**
  * Scaffolds a new component based on the provided template.
- * @param {string} outputFilePath - The file path where the component will be created.
+ * @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.
  */
-function scaffoldComponent(outputFilePath, componentName, templateName, templates) {
+function scaffoldComponent(outputFolderPath, componentName, templateName, templates) {
     const template = templates.find((t) => t.name === templateName);
     if (!template) {
         throw new Error(`Template ${templateName} not found.`);
     }
+    const outputFilePath = path_1.default.join(outputFolderPath, `${componentName}.${template.fileExtension}`);
     const componentOutputPath = scaffoldFile(outputFilePath, template.generateTemplate(componentName));
     if (componentOutputPath) {
         const nextSteps = [];

package/dist/esm/tools/generateSites.js

@@ -1,21 +1,30 @@
 import path from 'path';
 import chalk from 'chalk';
 import fs from 'fs';
+import { GraphQLSiteInfoService } from '../site';
 import { ensurePathExists } from '../utils/ensurePath';
+import { createGraphQLClientFactory } from '../client';
 const DEFAULT_SITES_DIST_PATH = '.sitecore/sites.json';
 /**
  * Generates site information and writes it to a specified destination path.
  * @param {GenerateSitesConfig} config - The configuration for generating site info.
- * @param {GraphQLSiteInfoService} config.siteInfoService - The service used to fetch site information.
+ * @param {GraphQLSiteInfoService} config.scConfig - The Sitecore configuration used at build and run time.
  * @param {string} config.destinationPath - The optional path where the generated sites file will be written. Defaults to '.sitecore/sites.json'.
  * @returns {Promise<Function>} - A promise that resolves to an asynchronous function that fetches site information and writes it to a file.
  */
-export const generateSites = ({ multisiteEnabled, defaultSite, siteInfoService, destinationPath, }) => {
+export const generateSites = ({ scConfig, destinationPath, }) => {
     return async () => {
         let sites = [];
         const sitesFilePath = path.resolve(destinationPath !== null && destinationPath !== void 0 ? destinationPath : DEFAULT_SITES_DIST_PATH);
-        if (multisiteEnabled) {
+        if (scConfig.multisite.enabled) {
             try {
+                const siteInfoService = new GraphQLSiteInfoService({
+                    clientFactory: createGraphQLClientFactory({
+                        api: scConfig.api,
+                        retries: scConfig.retries.count,
+                        retryStrategy: scConfig.retries.retryStrategy,
+                    }),
+                });
                 console.log('Fetching site information');
                 sites = await siteInfoService.fetchSiteInfo();
             }
@@ -24,6 +33,12 @@ export const generateSites = ({ multisiteEnabled, defaultSite, siteInfoService,
                 console.error(error);
             }
         }
+        // Add default site to the list
+        const defaultSite = {
+            name: scConfig.defaultSite,
+            hostName: scConfig.multisite.defaultHostname,
+            language: scConfig.defaultLanguage,
+        };
         sites.unshift(defaultSite);
         ensurePathExists(sitesFilePath);
         console.log(`Writing site info to ${sitesFilePath}`);

package/dist/esm/tools/scaffold.js

@@ -30,17 +30,18 @@ export function scaffoldFile(filePath, fileContent) {
 }
 /**
  * Scaffolds a new component based on the provided template.
- * @param {string} outputFilePath - The file path where the component will be created.
+ * @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 function scaffoldComponent(outputFilePath, componentName, templateName, templates) {
+export function scaffoldComponent(outputFolderPath, componentName, templateName, templates) {
     const template = templates.find((t) => t.name === templateName);
     if (!template) {
         throw new Error(`Template ${templateName} not found.`);
     }
+    const outputFilePath = path.join(outputFolderPath, `${componentName}.${template.fileExtension}`);
     const componentOutputPath = scaffoldFile(outputFilePath, template.generateTemplate(componentName));
     if (componentOutputPath) {
         const nextSteps = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.1.0-beta.22",
+  "version": "0.1.0-beta.24",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -68,7 +68,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "5d08aecb15836849a90a2f93f15c6d8ec915f667",
+  "gitHead": "68d52610f8306266df0e0ddba6dc6c4d0f284ba5",
   "files": [
     "dist",
     "types",

package/types/config/models.d.ts

@@ -214,6 +214,10 @@ export type ScaffoldTemplate = {
      * Name of the template.
      */
     name: string;
+    /**
+     * File extension for the generated component.
+     */
+    fileExtension: string;
     /**
      * Function to generate the component file contents based on the component name.
      * @param componentName - The name of the component.

package/types/tools/generateSites.d.ts

@@ -1,20 +1,12 @@
-import { SiteInfo, GraphQLSiteInfoService } from '../site';
+import { SitecoreConfig } from '../config';
 /**
  * Configuration object for generating sites.
  */
 export type GenerateSitesConfig = {
     /**
-     * Indicates if multisite support is enabled.
+     * The Sitecore configuration used at build and run time.
      */
-    multisiteEnabled: boolean;
-    /**
-     * The default site name.
-     */
-    defaultSite: SiteInfo;
-    /**
-     * The SiteInfo service.
-     */
-    siteInfoService: GraphQLSiteInfoService;
+    scConfig: SitecoreConfig;
     /**
      * Optional path where the generated sites will be saved.
      * If not provided, the default '.sitecore/sites.json' will be used.
@@ -24,8 +16,8 @@ export type GenerateSitesConfig = {
 /**
  * Generates site information and writes it to a specified destination path.
  * @param {GenerateSitesConfig} config - The configuration for generating site info.
- * @param {GraphQLSiteInfoService} config.siteInfoService - The service used to fetch site information.
+ * @param {GraphQLSiteInfoService} config.scConfig - The Sitecore configuration used at build and run time.
  * @param {string} config.destinationPath - The optional path where the generated sites file will be written. Defaults to '.sitecore/sites.json'.
  * @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: ({ multisiteEnabled, defaultSite, siteInfoService, destinationPath, }: GenerateSitesConfig) => (() => Promise<void>);
+export declare const generateSites: ({ scConfig, destinationPath, }: GenerateSitesConfig) => (() => Promise<void>);

package/types/tools/scaffold.d.ts

@@ -16,10 +16,10 @@ export declare function editLineEndings(content: string): string;
 export declare function scaffoldFile(filePath: string, fileContent: string): string | null;
 /**
  * Scaffolds a new component based on the provided template.
- * @param {string} outputFilePath - The file path where the component will be created.
+ * @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(outputFilePath: string, componentName: string, templateName: string, templates: ScaffoldTemplate[]): void;
+export declare function scaffoldComponent(outputFolderPath: string, componentName: string, templateName: string, templates: ScaffoldTemplate[]): void;