@griddo/cx 11.1.3 → 11.1.5

package/build/utils/core-utils.d.ts

@@ -1,5 +1,5 @@
 import type { APIResponses } from "../types/api";
-import type { CXConfig, LifeCyclesNames } from "../types/global";
+import type { CXConfig, LifeCyclesNames, LifeCycleSteps } from "../types/global";
 declare const instanceRootDir: string;
 /**
  * Returns the configuration file content.
@@ -91,7 +91,7 @@ declare function pause(title: string): Promise<void> | undefined;
  * @returns - A promise that resolves when the life cycle process is completed.
  */
 declare function doLifeCycle(name: LifeCyclesNames, options: {
-    steps: Array<(...args: Array<unknown>) => unknown | Promise<unknown>>;
+    steps: LifeCycleSteps;
     delay?: number;
     bypass?: boolean;
 }): Promise<void>;
@@ -104,5 +104,10 @@ declare function doLifeCycle(name: LifeCyclesNames, options: {
  */
 declare function createRenderMetadata(domain: string): Promise<void>;
 declare function removeAllSiteDirsFromStore(): void;
+/**
+ * Save render information to a file to use as debug log.
+ *
+ * This information will **not** be sent to any API.
+ */
 declare function saveBuildEndLogs(): void;
 export { createRenderMetadata, delay, doLifeCycle, getConfig, getSafeSiteId, instanceRootDir, isTruthy, measureExecutionTime, msToSec, pause, removeAllSiteDirsFromStore, removeProperties, sanitizeAPICacheDir, saveBuildEndLogs, walk, walkStore, };

package/build/utils/sites.d.ts

@@ -21,13 +21,11 @@ declare function unpublishSites(sites: Array<Site>): Promise<void>;
  */
 declare function getSiteData(siteID: number): Promise<SiteData>;
 /**
- * Save a file with the end of build process
+ * Save a file with the end of build process to use as `build-end` signal.
  */
 declare function generateBuildReport(): Promise<void>;
 /**
  * Generate sitemaps and save them into file system.
- *
- * @param sites An array of sites
  */
 declare function generateSitemaps(): Promise<void>;
 export { checkSites, generateBuildReport, generateSitemaps, getSiteData, unpublishSites, };

package/exporter/adapters/gatsby/index.ts

@@ -1,4 +1,8 @@
-import type { Artifacts } from "../../types/global";
+import type {
+	Artifacts,
+	LifeCyclesNames,
+	LifeCycleSteps,
+} from "../../types/global";
 
 import path from "node:path";
 
@@ -68,6 +72,11 @@ export async function renderDomainsWithGatsbyAdapter() {
 			initials: [],
 			archivables: [],
 		};
+		// Compose artifacts
+		const disposableArtifacts = [
+			...cxArtifacts.disposables,
+			...gatsbyArtifacts.disposables,
+		];
 
 		// These variables are involved in the build for create the dist directory
 		// from public and pass to the gatsby-build command via spawnSync.
@@ -76,77 +85,82 @@ export async function renderDomainsWithGatsbyAdapter() {
 
 		// LifeCycles
 
-		await doLifeCycle("Clean", {
-			steps: [
-				() =>
-					removeArtifacts([
-						...cxArtifacts.disposables,
-						...gatsbyArtifacts.disposables,
-					]),
-			],
-		});
-
-		await doLifeCycle("Prepare", {
-			steps: [() => createArtifacts(cxArtifacts.initials)],
-		});
-
-		await doLifeCycle("Restore", {
-			steps: [
-				() => copyArtifacts(__components, __ssg, ["static"]),
-				() => copyArtifacts(__exports, __cx, cxArtifacts.archivables),
-				() =>
-					renameArtifact(path.join(__cx, "dist"), path.join(__ssg, "public")),
-				() => moveArtifacts(__cache, __cx, cxArtifacts.cacheables),
-				() => moveArtifacts(__cache, __ssg, gatsbyArtifacts.cacheables),
-			],
-		});
-
-		await doLifeCycle("Data", {
-			steps: [() => createBuildData(domain)],
-		});
-
-		await doLifeCycle("SSG", {
-			steps: [() => runGatsbyBuildCommand(assetPrefix)],
-		});
-
-		await doLifeCycle("Relocation", {
-			steps: [() => createDistFromGatsbyPublic(domain, needsAssetPrefix)],
-		});
-
-		await doLifeCycle("Meta", {
-			steps: [
-				//
-				() => createRenderMetadata(domain),
-				() => saveBuildEndLogs(),
-			],
-		});
-
-		await doLifeCycle("Archive", {
-			steps: [
-				() => removeVirtualPagesFromStore(),
-				() => clearEmptyDirs(path.join(__cx, "dist")),
-				() =>
-					moveArtifacts(__cx, __exports, cxArtifacts.archivables, {
-						withBackup: true,
-					}),
-				() => moveArtifacts(__cx, __cache, cxArtifacts.cacheables),
-				() => moveArtifacts(__ssg, __cache, gatsbyArtifacts.cacheables),
-			],
-		});
-
-		await doLifeCycle("Close", {
-			steps: [
-				() =>
-					removeArtifacts([
-						...cxArtifacts.disposables,
-						...gatsbyArtifacts.disposables,
-					]),
-			],
-		});
-
-		await doLifeCycle("HealthCheck", {
-			steps: [() => isValidRenderProcessOrThrow()],
-		});
+		const allLifeCycles: Array<{
+			name: LifeCyclesNames;
+			steps: LifeCycleSteps;
+		}> = [
+			{
+				name: "Clean",
+				steps: [() => removeArtifacts(disposableArtifacts)],
+			},
+
+			{
+				name: "Prepare",
+				steps: [() => createArtifacts(cxArtifacts.initials)],
+			},
+
+			{
+				name: "Restore",
+				steps: [
+					() => copyArtifacts(__components, __ssg, ["static"]),
+					() => copyArtifacts(__exports, __cx, cxArtifacts.archivables),
+					() =>
+						renameArtifact(path.join(__cx, "dist"), path.join(__ssg, "public")),
+					() => moveArtifacts(__cache, __cx, cxArtifacts.cacheables),
+					() => moveArtifacts(__cache, __ssg, gatsbyArtifacts.cacheables),
+				],
+			},
+
+			{
+				name: "Data",
+				steps: [() => createBuildData(domain)],
+			},
+
+			{
+				name: "SSG",
+				steps: [() => runGatsbyBuildCommand(assetPrefix)],
+			},
+
+			{
+				name: "Relocation",
+				steps: [() => createDistFromGatsbyPublic(domain, needsAssetPrefix)],
+			},
+
+			{
+				name: "Meta",
+				steps: [() => createRenderMetadata(domain), () => saveBuildEndLogs()],
+			},
+
+			{
+				name: "Archive",
+				steps: [
+					() => removeVirtualPagesFromStore(),
+					() => clearEmptyDirs(path.join(__cx, "dist")),
+					() =>
+						moveArtifacts(__cx, __exports, cxArtifacts.archivables, {
+							withBackup: true,
+						}),
+					() => moveArtifacts(__cx, __cache, cxArtifacts.cacheables),
+					() => moveArtifacts(__ssg, __cache, gatsbyArtifacts.cacheables),
+				],
+			},
+
+			{
+				name: "Close",
+				steps: [() => removeArtifacts(disposableArtifacts)],
+			},
+
+			{
+				name: "HealthCheck",
+				steps: [() => isValidRenderProcessOrThrow()],
+			},
+		];
+
+		for (const { name, steps } of allLifeCycles) {
+			await doLifeCycle(name, {
+				steps: steps,
+			});
+		}
 
 		deleteSentinelRenderFile();
 	}

package/exporter/services/domains.ts

@@ -7,7 +7,10 @@ import { get } from "../utils/api";
  * Get an array of available domain.
  */
 async function getAllDomains() {
-	return await get<Domains>({ endpoint: endpoints.DOMAINS });
+	return await get<Domains>({
+		endpoint: endpoints.DOMAINS,
+		useApiCacheDir: false,
+	});
 }
 
 export { getAllDomains };

package/exporter/services/robots.ts

@@ -41,7 +41,7 @@ class RobotsService {
 	}
 
 	/**
-	 * Write robots.txt files for the current rendering domain.
+	 * Write robots.txt files for the domain.
 	 */
 	async writeFiles(domain: string) {
 		const { __cx } = config.paths(domain);

package/exporter/services/settings.ts

@@ -8,7 +8,10 @@ async function getAllSettings() {
 }
 
 async function resetRender() {
-	await post({ endpoint: endpoints.RESET_RENDER });
+	await post({
+		endpoint: endpoints.RESET_RENDER,
+		useApiCacheDir: false,
+	});
 }
 
 export { getAllSettings, resetRender };

package/exporter/services/sites.ts

@@ -71,6 +71,7 @@ async function endSiteRender(id: number, body: EndSiteRenderBody) {
 	return await post<EndPageInfoResponse>({
 		endpoint: `${prefix}${id}${suffix}`,
 		body,
+		useApiCacheDir: false,
 	});
 }
 

package/exporter/types/api.ts

@@ -124,6 +124,8 @@ export interface APIRequest {
 	 * @todo type this correctly from axios types
 	 */
 	headers?: any; // Record<string, unknown>;
+	/* Save results in apiCache folder */
+	useApiCacheDir?: boolean;
 }
 
 /** Type with the POST request properties. */

package/exporter/types/global.ts

@@ -68,6 +68,10 @@ interface RenderInfo {
 	sitesToPublish: Array<Site>;
 }
 
+type LifeCycleSteps = Array<
+	(...args: Array<unknown>) => unknown | Promise<unknown>
+>;
+
 type LifeCyclesNames =
 	| "Prepare"
 	| "Restore"
@@ -126,4 +130,5 @@ export type {
 	Robot,
 	Robots,
 	Settings,
+	LifeCycleSteps,
 };

package/exporter/utils/api.ts

@@ -44,11 +44,18 @@ async function requestAPI<T extends APIResponses>(
 	method: Method,
 	appendToLog = "",
 ): Promise<T> {
-	const { endpoint, body, cacheKey = "", attempt = 1, headers } = props;
+	const {
+		endpoint,
+		body,
+		cacheKey = "",
+		attempt = 1,
+		headers,
+		useApiCacheDir = true,
+	} = props;
 	const cacheOptions = { endpoint, body, headers, cacheKey };
 
 	// Cache
-	if (cacheKey) {
+	if (cacheKey && useApiCacheDir) {
 		const start = new Date();
 		const cacheData = searchCacheData<T>(cacheOptions);
 
@@ -83,7 +90,9 @@ async function requestAPI<T extends APIResponses>(
 			`${method} (fetch) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`,
 		);
 
-		saveCache(cacheOptions, data);
+		if (useApiCacheDir) {
+			saveCache(cacheOptions, data);
+		}
 
 		// Only save registers if alerts are enabled
 		if (envs.GRIDDO_ALERT_FEATURE) {

package/exporter/utils/core-utils.ts

@@ -1,5 +1,9 @@
 import type { APIResponses } from "../types/api";
-import type { CXConfig, LifeCyclesNames } from "../types/global";
+import type {
+	CXConfig,
+	LifeCyclesNames,
+	LifeCycleSteps,
+} from "../types/global";
 import type { APIPageObject } from "../types/pages";
 
 import fs from "node:fs";
@@ -312,7 +316,7 @@ function pause(title: string) {
 async function doLifeCycle(
 	name: LifeCyclesNames,
 	options: {
-		steps: Array<(...args: Array<unknown>) => unknown | Promise<unknown>>;
+		steps: LifeCycleSteps;
 		delay?: number;
 		bypass?: boolean;
 	},
@@ -411,6 +415,11 @@ function getFormattedDateTime() {
 	return `${date}_${time}`;
 }
 
+/**
+ * Save render information to a file to use as debug log.
+ *
+ * This information will **not** be sent to any API.
+ */
 function saveBuildEndLogs() {
 	const { __cx } = config.paths();
 	const { sitesToPublish, createdPages, buildProcessData } = fsx.readJSONSync(

package/exporter/utils/searches.ts

@@ -43,6 +43,7 @@ async function postSearchInfo(props: PostSearchInfoProps) {
 			template,
 			content: prepareHTMLContentForSearch(content),
 		},
+		useApiCacheDir: false,
 	});
 
 	return response;
@@ -165,6 +166,7 @@ async function startAIEmbeddings() {
 	try {
 		await post<AIEmbeddingsResponse>({
 			endpoint: endpoints.AI_EMBEDDINGS,
+			useApiCacheDir: false,
 		});
 	} catch (error) {
 		console.warn(

package/exporter/utils/sites.ts

@@ -153,7 +153,7 @@ async function getSiteData(siteID: number) {
 }
 
 /**
- * Save a file with the end of build process
+ * Save a file with the end of build process to use as `build-end` signal.
  */
 async function generateBuildReport() {
 	const { __cx } = config.paths();
@@ -184,8 +184,6 @@ async function generateBuildReport() {
 
 /**
  * Generate sitemaps and save them into file system.
- *
- * @param sites An array of sites
  */
 async function generateSitemaps() {
 	const { sitesToPublish } = await getBuildMetadata();

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "11.1.3",
+	"version": "11.1.5",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -60,7 +60,7 @@
 		"@babel/preset-env": "7.26.0",
 		"@babel/preset-react": "7.26.3",
 		"@babel/preset-typescript": "7.26.0",
-		"@griddo/core": "11.1.3",
+		"@griddo/core": "11.1.5",
 		"@svgr/webpack": "5.5.0",
 		"axios": "1.7.9",
 		"babel-loader": "9.2.1",
@@ -126,5 +126,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "5b505e1cd245ac9c2d566bd6efa533f9f910c423"
+	"gitHead": "3d7508419bdedbaa6dc6eae55fe73c10cb5bcdb8"
 }