@griddo/cx 11.0.22 → 11.0.23

package/build/utils/loggin.d.ts

@@ -43,8 +43,9 @@ declare function debugLog(...values: Array<unknown>): void;
  */
 declare function pageSizeLog(size: number, measure?: string): string;
 /**
- * Print Griddo, adapter and Node version.
+ * Console log the Griddo exporter version.
  */
-declare function printExporterLogo(): void;
+declare function showExporterVersion(): void;
 declare function listSitesLog(title: string, sites: Array<Site>): void;
-export { boxLog, buildLog, debugLog, infoLog, listSitesLog, pageSizeLog, printExporterLogo, successLog, verboseLog, };
+declare function errorLabelLog(msg: string): void;
+export { boxLog, buildLog, debugLog, errorLabelLog, infoLog, listSitesLog, pageSizeLog, showExporterVersion, successLog, verboseLog, };

package/build/utils/render.d.ts

@@ -8,4 +8,8 @@ declare function deleteSentinelRenderFile(): void;
 declare function isValidRenderProcessOrThrow(): void;
 declare function initRender(): void;
 declare function finishRender(): undefined;
-export { finishRender, initRender, isValidRenderProcessOrThrow, createSentinelRenderFile, deleteSentinelRenderFile, };
+/**
+ * Send the default registers through Griddo alerts.
+ */
+declare function sendGriddoDefaultAlerts(): void;
+export { createSentinelRenderFile, deleteSentinelRenderFile, finishRender, initRender, isValidRenderProcessOrThrow, sendGriddoDefaultAlerts, };

package/build/utils/store.d.ts

@@ -80,4 +80,10 @@ declare function getPagesToCreateOrDelete(sitePages: {
     pagesToDeleteFromStore: number[];
     pagesToWriteToStore: number[];
 }>;
-export { createStoreDir, getBuildMetadata, getBuildPagesFromCachedStore, getBuildPagesFromStore, getBuildPagesPath, getPageInStoreDir, getPagesToCreateOrDelete, removePagesFromStore, savePagesInStore, saveRenderInfoInStore, };
+/**
+ * Removes sites that exist in the store that should no longer be there because
+ * the domain has been changed. This is necessary because those sites will not
+ * be marked as `sitesToUnpublish` so they must be removed manually.
+ */
+declare function removeOrphanSites(sitesToPublish: Array<Site>, domain: string): void;
+export { createStoreDir, getBuildMetadata, getBuildPagesFromCachedStore, getBuildPagesFromStore, getBuildPagesPath, getPageInStoreDir, getPagesToCreateOrDelete, removeOrphanSites, removePagesFromStore, savePagesInStore, saveRenderInfoInStore, };

package/cx.config.d.ts

@@ -1,4 +1,4 @@
-import { CXConfig } from "./exporter/types/global";
+import type { CXConfig } from "./exporter/types/global";
 
 declare const config: CXConfig;
 

package/exporter/adapters/gatsby/index.ts

@@ -1,3 +1,5 @@
+import type { Artifacts } from "../../types/global";
+
 import path from "node:path";
 
 import {
@@ -5,10 +7,7 @@ import {
 	getGatsbyAssetPrefixWithDomain,
 	runGatsbyBuildCommand,
 } from "./utils";
-import { getRenderArtifacts } from "../../artifacts";
-import { envs } from "../../constants";
-import { apiRegister } from "../../registers";
-import { insertAlert } from "../../utils/alerts";
+import getCxArtifacts from "../../artifacts";
 import {
 	createRenderMetadata,
 	doLifeCycle,
@@ -25,7 +24,7 @@ import {
 	removeVirtualPagesFromStore,
 	renameArtifact,
 } from "../../utils/folders";
-import { debugLog, infoLog, printExporterLogo } from "../../utils/loggin";
+import { infoLog } from "../../utils/loggin";
 import {
 	createSentinelRenderFile,
 	deleteSentinelRenderFile,
@@ -34,114 +33,116 @@ import {
 
 const config = getConfig();
 
-async function main() {
-	printExporterLogo();
-
+/**
+ * Render every instance domain with the Gatsby adapter.
+ */
+export async function renderDomainsWithGatsbyAdapter() {
 	const domains = await getInstanceDomains();
 
 	for (const domain of domains) {
-		await renderDomain(domain);
-	}
+		infoLog(`Initializing render for the domain ${domain}`);
+
+		createSentinelRenderFile();
+
+		const {
+			//
+			__ssg,
+			__exports,
+			__cache,
+			__cx,
+			__components,
+		} = config.paths(domain);
+
+		// Griddo artifacts
+		const cxArtifacts = getCxArtifacts(domain);
+
+		// Gatsby artifacts
+		const gatsbyArtifacts: Artifacts = {
+			disposables: [
+				path.join(__ssg, "public"),
+				path.join(__ssg, "static"),
+				path.join(__ssg, ".cache"),
+			],
+			cacheables: [".cache"],
+			initials: [],
+			archivables: [],
+		};
+
+		// These variables are involved in the build for create the dist directory
+		// from public and pass to the gatsby-build command via spawnSync.
+		const assetPrefix = getGatsbyAssetPrefixWithDomain(domain);
+		const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
+
+		// LifeCycles
+
+		await doLifeCycle("Clean", {
+			steps: [
+				() =>
+					removeArtifacts([
+						...cxArtifacts.disposables,
+						...gatsbyArtifacts.disposables,
+					]),
+			],
+		});
 
-	if (envs.GRIDDO_ALERT_FEATURE) {
-		const registerContent = apiRegister.get("API_RESPONSE_TOO_BIG");
-
-		if (registerContent.entries.length < 1) {
-			return;
-		}
-
-		debugLog("\nRender register report\n");
-		debugLog(registerContent);
-		debugLog();
-
-		insertAlert({
-			description: `API response size is too large (${envs.GRIDDO_API_MAX_RESPONSE_SIZE}KB).`,
-			area: "Griddo",
-			level: "W",
-			fullData: {
-				output: registerContent,
-				date: new Date().toISOString(),
-			},
+		await doLifeCycle("Prepare", {
+			steps: [() => createArtifacts(cxArtifacts.initials)],
 		});
-	}
-}
 
-async function renderDomain(domain: string) {
-	infoLog(`Initializing render for the domain ${domain}`);
-
-	createSentinelRenderFile();
-
-	const cxPaths = config.paths(domain);
-	const {
-		all: ALL_ART,
-		gatsby: GATSBY_ARTIFACTS,
-		cx: CX_ARTIFACTS,
-	} = getRenderArtifacts("gatsby", { cxPaths });
-	const { __ssg, __exports, __cache, __cx, __components } = cxPaths;
-
-	// These variables are involved in the build for create the dist directory
-	// from public and pass to the gatsby-build command via spawnSync.
-	const assetPrefix = getGatsbyAssetPrefixWithDomain(domain);
-	const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
-
-	// LifeCycles
-
-	await doLifeCycle("Clean", {
-		steps: [() => removeArtifacts(ALL_ART.disposables)],
-	});
-
-	await doLifeCycle("Prepare", {
-		steps: [() => createArtifacts(ALL_ART.initials)],
-	});
-
-	await doLifeCycle("Restore", {
-		steps: [
-			() => copyArtifacts(__components, __ssg, ["static"]),
-			() => copyArtifacts(__exports, __cx, CX_ARTIFACTS.archivables),
-			() => renameArtifact(path.join(__cx, "dist"), path.join(__ssg, "public")),
-			() => moveArtifacts(__cache, __cx, CX_ARTIFACTS.cacheables),
-			() => moveArtifacts(__cache, __ssg, GATSBY_ARTIFACTS.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)],
-	});
-
-	await doLifeCycle("Archive", {
-		steps: [
-			() => removeVirtualPagesFromStore(),
-			() => clearEmptyDirs(path.join(__cx, "dist")),
-			() =>
-				moveArtifacts(__cx, __exports, CX_ARTIFACTS.archivables, {
-					withBackup: true,
-				}),
-			() => moveArtifacts(__cx, __cache, CX_ARTIFACTS.cacheables),
-			() => moveArtifacts(__ssg, __cache, GATSBY_ARTIFACTS.cacheables),
-		],
-	});
-
-	await doLifeCycle("Close", {
-		steps: [() => removeArtifacts(ALL_ART.disposables)],
-	});
-
-	await doLifeCycle("HealthCheck", {
-		steps: [() => isValidRenderProcessOrThrow()],
-	});
-
-	deleteSentinelRenderFile();
-}
+		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)],
+		});
 
-export default main;
+		await doLifeCycle("Relocation", {
+			steps: [() => createDistFromGatsbyPublic(domain, needsAssetPrefix)],
+		});
+
+		await doLifeCycle("Meta", {
+			steps: [() => createRenderMetadata(domain)],
+		});
+
+		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()],
+		});
+
+		deleteSentinelRenderFile();
+	}
+}

package/exporter/adapters/gatsby/utils.ts

@@ -1,7 +1,6 @@
 import { spawnSync } from "node:child_process";
 import path from "node:path";
 
-import dotenv from "dotenv";
 import fsx from "fs-extra";
 
 import { envs } from "../../constants";
@@ -10,8 +9,6 @@ import { ErrorInSSGBuildProcess } from "../../errors/errors-data";
 import { getConfig } from "../../utils/core-utils";
 import { verboseLog } from "../../utils/loggin";
 
-dotenv.config();
-
 const config = getConfig();
 
 /**

package/exporter/artifacts/index.ts

@@ -1,40 +1,32 @@
-import type { Adapters } from "../adapters";
-import type { PlaceholderPath } from "../types/global";
+import type { Artifacts } from "../types/global";
 
-import getCxArtifacts from "./cx";
-import getGatsbyArtifacts from "./gatsby";
+import path from "node:path";
+
+import { getConfig } from "../utils/core-utils";
 
 /**
- * Returns the artifacts of a specific adapter along with those of CX.
- *
- * @param adapter - The adapter for which to get the artifacts.
- * @param options.cxPaths - The cx-paths.
+ * Returns the artifacts of CX.
  */
-function getRenderArtifacts(
-	adapter: Adapters,
-	options: {
-		cxPaths: Record<PlaceholderPath, string>;
-	},
-) {
-	const { cxPaths } = options;
-	const ssgArtifacts = {
-		gatsby: getGatsbyArtifacts(cxPaths),
-	};
+function getCxArtifacts(domain: string): Artifacts {
+	const config = getConfig();
+	const { __cx, __exports, __cache } = config.paths(domain);
 
 	return {
-		cx: getCxArtifacts(cxPaths),
-		[adapter]: ssgArtifacts[adapter],
-		all: {
-			initials: [
-				...getCxArtifacts(cxPaths).initials,
-				...ssgArtifacts[adapter].initials,
-			],
-			disposables: [
-				...getCxArtifacts(cxPaths).disposables,
-				...ssgArtifacts[adapter].disposables,
-			],
-		},
+		initials: [
+			__exports, // `/exports/<domain>`
+			__cache, // `__cx/.cx-cache/<domain>`
+			path.join(__cx, "store"),
+			path.join(__cx, "apiCache"),
+		],
+		disposables: [
+			path.join(__cx, "store"),
+			path.join(__cx, "apiCache"),
+			path.join(__cx, "render-metadata.json"),
+			path.join(__cx, "dist"),
+		],
+		cacheables: ["apiCache", "store"],
+		archivables: ["dist", "assets"],
 	};
 }
 
-export { getRenderArtifacts };
+export default getCxArtifacts;

package/exporter/react/GriddoIntegrations/utils.ts

@@ -1,7 +1,6 @@
+import type { Dimensions } from "../../types/pages";
 import type { Core } from "@griddo/core";
 
-import { Dimensions } from "../../types/pages";
-
 /**
  * Return true if the argument is an object (not null)
  */

package/exporter/scripts/start-render.ts

@@ -1,37 +1,24 @@
 #!/usr/bin/env node
 /* eslint-disable node/shebang */
 
-import kleur from "kleur";
-
-import { runGatsbyAdapter } from "../adapters";
+import { renderDomainsWithGatsbyAdapter } from "../adapters/gatsby";
 import { RenderError } from "../errors";
-import { measureExecutionTime } from "../utils/core-utils";
-import { infoLog } from "../utils/loggin";
+import { errorLabelLog, showExporterVersion } from "../utils/loggin";
+import { sendGriddoDefaultAlerts } from "../utils/render";
 
 async function startRender() {
 	try {
-		const exeTime = await measureExecutionTime([() => runGatsbyAdapter()]);
-
-		infoLog(`All domains rendered in ${exeTime}s.`);
-
-		process.exit(0);
+		showExporterVersion();
+		await renderDomainsWithGatsbyAdapter();
+		sendGriddoDefaultAlerts();
 	} catch (error) {
-		// Errors using the `throwError` function.
-		// In this case it does not log the stack error here because it is
-		// already logged in the `throwError` function.
 		if (error instanceof RenderError) {
-			console.log();
-			console.log(kleur.black().bgRed(" GRIDDO InternalCXError "));
-			console.log();
+			errorLabelLog("GRIDDO_ERROR InternalCXError");
 			process.exit(1);
 		}
 
-		// Other unknown errors.
-		console.log();
-		console.log(kleur.black().bgRed(" GRIDDO UnknownError "));
-		console.log();
-		console.log(error);
-		console.log();
+		errorLabelLog("GRIDDO_ERROR UnknownError");
+		console.error(error);
 		process.exit(1);
 	}
 }

package/exporter/services/store.ts

@@ -31,6 +31,7 @@ import { checkSites, getSiteData, unpublishSites } from "../utils/sites";
 import {
 	createStoreDir,
 	getPagesToCreateOrDelete,
+	removeOrphanSites,
 	removePagesFromStore,
 	savePagesInStore,
 	saveRenderInfoInStore,
@@ -78,6 +79,11 @@ async function createStore(domain: string) {
 		// store de los sites para despublicar.
 		await unpublishSites(sitesToUnpublish);
 
+		// Eliminamos posibles sites que estén en el store pero que no deberían
+		// porque han sido cambiados de dominio. Si han sido despublicados ya se
+		// despublican bien porque entran en `sitesToUnpublish`
+		removeOrphanSites(sitesToPublish, domain);
+
 		// Solo los sites to publish...
 		for (const site of sitesToPublish) {
 			const {

package/exporter/utils/loggin.ts

@@ -127,14 +127,16 @@ function pageSizeLog(size: number, measure = "KB") {
 }
 
 /**
- * Print Griddo, adapter and Node version.
+ * Console log the Griddo exporter version.
  */
-function printExporterLogo() {
+function showExporterVersion() {
 	console.clear();
 	const config = getConfig();
-	const nodeVersion = process.version;
 	const { griddoVersion } = config;
-	const logo = `\n${kleur.bold("Griddo Exporter " + griddoVersion)} ${kleur.dim("~ node " + nodeVersion)}\n`;
+	const logo = `\n  ${kleur
+		.bgYellow()
+		.black()
+		.bold(" Griddo Exporter " + griddoVersion + " ")}\n`;
 
 	console.log(logo);
 }
@@ -156,14 +158,19 @@ ${title}
 ${sitesStr.join("\n") || "---"}`);
 }
 
+function errorLabelLog(msg: string) {
+	console.error("\n" + kleur.black().bgRed(" " + msg + " ") + "\n");
+}
+
 export {
 	boxLog,
 	buildLog,
 	debugLog,
+	errorLabelLog,
 	infoLog,
 	listSitesLog,
 	pageSizeLog,
-	printExporterLogo,
+	showExporterVersion,
 	successLog,
 	verboseLog,
 };

package/exporter/utils/render.ts

@@ -1,9 +1,13 @@
 import fs from "node:fs";
 import path from "node:path";
 
-import { getConfig } from "./core-utils";
+import { envs } from "../constants";
 import { throwError } from "../errors";
 import { RenderUUIDError } from "../errors/errors-data";
+import { apiRegister } from "../registers";
+import { insertAlert } from "./alerts";
+import { getConfig } from "./core-utils";
+import { debugLog } from "./loggin";
 
 const config = getConfig();
 
@@ -40,10 +44,38 @@ function finishRender() {
 	return undefined;
 }
 
+/**
+ * Send the default registers through Griddo alerts.
+ */
+function sendGriddoDefaultAlerts() {
+	if (envs.GRIDDO_ALERT_FEATURE) {
+		const registerContent = apiRegister.get("API_RESPONSE_TOO_BIG");
+
+		if (registerContent.entries.length < 1) {
+			return;
+		}
+
+		debugLog("\nRender register report\n");
+		debugLog(registerContent);
+		debugLog();
+
+		insertAlert({
+			description: `API response size is too large (${envs.GRIDDO_API_MAX_RESPONSE_SIZE}KB).`,
+			area: "Griddo",
+			level: "W",
+			fullData: {
+				output: registerContent,
+				date: new Date().toISOString(),
+			},
+		});
+	}
+}
+
 export {
+	createSentinelRenderFile,
+	deleteSentinelRenderFile,
 	finishRender,
 	initRender,
 	isValidRenderProcessOrThrow,
-	createSentinelRenderFile,
-	deleteSentinelRenderFile,
+	sendGriddoDefaultAlerts,
 };

package/exporter/utils/store.ts

@@ -10,6 +10,7 @@ import fsx from "fs-extra";
 
 import { throwError } from "../errors";
 import { getConfig, removeProperties, walk, walkStore } from "./core-utils";
+import { verboseLog } from "./loggin";
 import { ReadFromStoreError, WriteToStoreError } from "../errors/errors-data";
 
 const config = getConfig();
@@ -302,6 +303,25 @@ async function getPagesToCreateOrDelete(sitePages: {
 	};
 }
 
+/**
+ * Removes sites that exist in the store that should no longer be there because
+ * the domain has been changed. This is necessary because those sites will not
+ * be marked as `sitesToUnpublish` so they must be removed manually.
+ */
+function removeOrphanSites(sitesToPublish: Array<Site>, domain: string) {
+	const { __cx } = getConfig().paths(domain);
+	const currentSitesInStore = fs.readdirSync(path.join(__cx, "store"));
+	const sitesFromAPI = sitesToPublish.map(({ id }) => `${id}`);
+	const sitesToDelete = currentSitesInStore.filter(
+		(site) => !sitesFromAPI.includes(site),
+	);
+
+	for (const site of sitesToDelete) {
+		fs.rmSync(path.join(__cx, "store", site), { recursive: true, force: true });
+		verboseLog(`Removed orphan site id: ${site}`);
+	}
+}
+
 export {
 	createStoreDir,
 	getBuildMetadata,
@@ -310,6 +330,7 @@ export {
 	getBuildPagesPath,
 	getPageInStoreDir,
 	getPagesToCreateOrDelete,
+	removeOrphanSites,
 	removePagesFromStore,
 	savePagesInStore,
 	saveRenderInfoInStore,

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "11.0.22",
+	"version": "11.0.23",
 	"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.0.22",
+		"@griddo/core": "11.0.23",
 		"@svgr/webpack": "5.5.0",
 		"axios": "1.7.9",
 		"babel-loader": "9.2.1",
@@ -126,5 +126,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "f47b8da5bc98f03f7f23a65d471a0429785c280d"
+	"gitHead": "eec9df5df565f610ec25cfb4b48bf737e9073990"
 }

package/build/adapters/index.d.ts

@@ -1,3 +0,0 @@
-import runGatsbyAdapter from "./gatsby";
-export type Adapters = "gatsby";
-export { runGatsbyAdapter };

package/build/artifacts/cx.d.ts

@@ -1,6 +0,0 @@
-import type { Artifacts, PlaceholderPath } from "../types/global";
-/**
- * Returns the artifacts of CX.
- */
-declare function getCxArtifacts(paths: Record<PlaceholderPath, string>): Artifacts;
-export default getCxArtifacts;

package/build/artifacts/gatsby.d.ts

@@ -1,6 +0,0 @@
-import type { Artifacts, PlaceholderPath } from "../types/global";
-/**
- * Returns the artifacts of Gatsby.
- */
-declare function gatsbyArtifacts(paths: Record<PlaceholderPath, string>): Artifacts;
-export default gatsbyArtifacts;

package/exporter/adapters/index.ts

@@ -1,4 +0,0 @@
-import runGatsbyAdapter from "./gatsby";
-
-export type Adapters = "gatsby";
-export { runGatsbyAdapter };

package/exporter/artifacts/cx.ts

@@ -1,29 +0,0 @@
-import type { Artifacts, PlaceholderPath } from "../types/global";
-
-import path from "node:path";
-
-/**
- * Returns the artifacts of CX.
- */
-function getCxArtifacts(paths: Record<PlaceholderPath, string>): Artifacts {
-	const { __cx, __exports, __cache } = paths;
-
-	return {
-		initials: [
-			__exports, // `/exports/<domain>`
-			__cache, // `__cx/.cx-cache/<domain>`
-			path.join(__cx, "store"),
-			path.join(__cx, "apiCache"),
-		],
-		disposables: [
-			path.join(__cx, "store"),
-			path.join(__cx, "apiCache"),
-			path.join(__cx, "render-metadata.json"),
-			path.join(__cx, "dist"),
-		],
-		cacheables: ["apiCache", "store"],
-		archivables: ["dist", "assets"],
-	};
-}
-
-export default getCxArtifacts;