@griddo/cx 11.7.12-rc.3 → 11.7.12

package/exporter/utils/loggin.ts

@@ -1,39 +1,52 @@
 import type { Site } from "../types/sites";
 
-import fsp from "node:fs/promises";
-import path from "node:path";
+import kleur from "kleur";
 
-import { GRIDDO_BUILD_LOGS, GRIDDO_VERBOSE_LOGS } from "../constants/envs";
-import { readDB } from "../services/db";
-import { brush } from "./brush";
+import { envs } from "../constants";
+import { getConfig } from "./core-utils";
 
 /**
  * Custom basic logging function controlled by a environment variable.
+ *
  * @param str The string to be logged.
  */
 function verboseLog(str: string) {
-	if (GRIDDO_VERBOSE_LOGS) {
-		console.log(brush.yellow("verbose"), brush.dim(str.replace(/(\s)\s+/g, "$1").trim()));
+	if (envs.GRIDDO_VERBOSE_LOGS) {
+		console.log(
+			kleur.yellow("verbose"),
+			kleur.dim(str.replace(/(\s)\s+/g, "$1").trim()),
+		);
 	}
 }
 
 /**
  * Custom log inside a line-box.
+ *
  * @param stringValue The string to be logged.
  * @param paddingInline The number of white spaces inside the box at left and right.
  * @param paddingBlock The number of white spaces inside the box at top and bottom.
  */
-function boxLog(stringValue: string, title = "", paddingInline = 1, paddingBlock = 1) {
+function boxLog(
+	stringValue: string,
+	title = "",
+	paddingInline = 1,
+	paddingBlock = 1,
+) {
 	const lines = stringValue
 		.split("\n") // lines
 		.map((line) => line.trim()); // remove extra spaces
 	const windowTitle = title ? ` ${title} ` : "";
 	const windowTitleLength = title ? windowTitle.length : 0;
-	const longerContent = Math.max(...lines.map((l) => l.length)) + paddingInline * 2;
+	const longerContent =
+		Math.max(...lines.map((l) => l.length)) + paddingInline * 2;
 	const longerLine = Math.max(longerContent, windowTitleLength);
-	const paddingBlockString = `│${" ".repeat(longerLine)}│\n`.repeat(paddingBlock);
+	const paddingBlockString = `│${" ".repeat(longerLine)}│\n`.repeat(
+		paddingBlock,
+	);
 	const minWidth = longerLine;
-	const borderTop = `╭${windowTitle}${"─".repeat(minWidth - windowTitleLength)}╮\n`;
+	const borderTop = `╭${windowTitle}${"─".repeat(
+		minWidth - windowTitleLength,
+	)}╮\n`;
 	const borderBottom = `╰${"─".repeat(minWidth)}╯`;
 	const content = lines
 		.map((l) => {
@@ -42,7 +55,9 @@ function boxLog(stringValue: string, title = "", paddingInline = 1, paddingBlock
 		})
 		.join("");
 
-	console.log(`${borderTop}${paddingBlockString}${content}${paddingBlockString}${borderBottom}`);
+	console.log(
+		`${borderTop}${paddingBlockString}${content}${paddingBlockString}${borderBottom}`,
+	);
 }
 
 /**
@@ -52,7 +67,7 @@ function boxLog(stringValue: string, title = "", paddingInline = 1, paddingBlock
  * @param str The string to be logged.
  */
 function buildLog(str: string) {
-	if (GRIDDO_BUILD_LOGS) {
+	if (envs.GRIDDO_BUILD_LOGS) {
 		console.log(str.replace(/(\s)\s+/g, "$1").trim());
 	}
 }
@@ -62,7 +77,7 @@ function buildLog(str: string) {
  * @param str The string to be logged.
  */
 function infoLog(str: string) {
-	console.log(`${brush.blue("info")} ${str}`);
+	console.log(`${kleur.blue("info")} ${str}`);
 }
 
 /**
@@ -70,67 +85,99 @@ function infoLog(str: string) {
  * @param str The string to be logged.
  */
 function successLog(str: string) {
-	console.log(`${brush.green("success")} ${str}`);
+	console.log(`${kleur.green("success")} ${str}`);
+}
+
+/**
+ * Internal log
+ * @param values The values to be logged.
+ */
+function debugLog(...values: Array<unknown>) {
+	if (!envs.GRIDDO_DEBUG_LOGS) {
+		return;
+	}
+	console.log(...values);
+}
+
+/**
+ * Return a scale size colors with a number and a measure string (KB by default).
+ *
+ * @param size The page size in KB.
+ * @param measure The measure string to be added in the log.
+ */
+function pageSizeLog(size: number, measure = "KB") {
+	const sizeScale = {
+		low: 50,
+		mid: 80,
+		large: 130,
+		extraLarge: 210,
+	};
+
+	// Ternary pawa!
+	const color =
+		size > sizeScale.large
+			? "red"
+			: size > sizeScale.mid
+				? "magenta"
+				: size > sizeScale.low
+					? "blue"
+					: "green";
+
+	return kleur[color](kleur.bold(`${size}${measure}`));
 }
 
 /**
  * Console log the Griddo exporter version.
  */
-async function showExporterVersion() {
+function showExporterVersion() {
 	console.clear();
-	const { version } = JSON.parse(
-		await fsp.readFile(path.resolve(__dirname, "../..", "package.json"), "utf-8"),
-	) as { version: string };
-	const logo = `\n${brush.yellow(`Griddo Exporter ${version}`)}\n`;
+	const config = getConfig();
+	const { griddoVersion } = config;
+	const logo = `\n${kleur
+		.bgYellow()
+		.black()
+		.bold(" Griddo Exporter " + griddoVersion + " ")}\n`;
 
 	console.log(logo);
 }
 
 function listSitesLog(title: string, sites: Array<Site>) {
 	const maxline = Math.max(
-		...sites.map((s) => s.name.length + (s.shouldBeUpdated ? 1 : 0) + s.id.toString().length),
+		...sites.map(
+			(s) =>
+				s.name.length + (s.shouldBeUpdated ? 1 : 0) + s.id.toString().length,
+		),
 	);
 
 	const sitesStr = sites.map((s) => {
 		const shouldBeUpdated = s.shouldBeUpdated ? "*" : "";
-		const lineLen = s.name.length + shouldBeUpdated.length + s.id.toString().length;
+		const lineLen =
+			s.name.length + shouldBeUpdated.length + s.id.toString().length;
 		const padding = " ".repeat(maxline - lineLen);
-		return `${brush.bold(s.name)} ${brush.dim(`(${s.id})`)} ${shouldBeUpdated} ${padding}${brush.dim("-")} ${brush.dim(s.slug)}`;
+		return `${kleur.bold(s.name)} ${kleur.dim("(" + s.id + ")")} ${shouldBeUpdated} ${padding}${kleur.dim("-")} ${kleur.dim(s.slug)}`;
 	});
 
-	const sitesOutput = sitesStr.length > 0 ? `\n\n${sitesStr.join("\n")}` : brush.dim("--none--\n");
+	const sitesOutput =
+		sitesStr.length > 0
+			? "\n\n" + sitesStr.join("\n")
+			: kleur.dim("--none--\n");
 
 	console.log(`
 ${title} ${sitesOutput}`);
 }
 
-async function appendLogToFile(lineContent: string) {
-	if (!GRIDDO_BUILD_LOGS) {
-		return;
-	}
-
-	const data = await readDB();
-
-	const logFilePath = path.join(data.paths.root, `render-detail-log.txt`);
-
-	try {
-		await fsp.appendFile(logFilePath, `${lineContent.toString()}\n`);
-	} catch (error) {
-		if (error instanceof Error) {
-			console.error("Error", error.message);
-		} else {
-			console.error(error);
-		}
-		throw error;
-	}
+function errorLabelLog(msg: string) {
+	console.error("\n" + kleur.black().bgRed(" " + msg + " ") + "\n");
 }
 
 export {
-	appendLogToFile,
 	boxLog,
 	buildLog,
+	debugLog,
+	errorLabelLog,
 	infoLog,
 	listSitesLog,
+	pageSizeLog,
 	showExporterVersion,
 	successLog,
 	verboseLog,

package/exporter/utils/pages.ts

@@ -1,4 +1,3 @@
-import type { Core, Fields } from "@griddo/core";
 import type {
 	APIPageObject,
 	GriddoListPage,
@@ -10,9 +9,14 @@ import type {
 	PageAdditionalInfo,
 } from "../types/pages";
 import type { TemplateWithReferenceField } from "../types/templates";
+import type { Core, Fields } from "@griddo/core";
+
+import dotenv from "dotenv";
 
 import { formatImage } from "./images";
 
+dotenv.config();
+
 // Consts
 const DEFAULT_ITEMS_PER_PAGE_FOR_LIST_TEMPLATES = 25;
 
@@ -27,7 +31,10 @@ function getOpenGraph({
 	socialTitle,
 	socialDescription,
 	socialImage,
-}: Pick<Core.Page, "socialTitle" | "socialDescription" | "socialImage">): Core.Page["openGraph"] {
+}: Pick<
+	Core.Page,
+	"socialTitle" | "socialDescription" | "socialImage"
+>): Core.Page["openGraph"] {
 	return {
 		type: "website",
 		title: socialTitle,
@@ -42,7 +49,9 @@ function getOpenGraph({
  *
  * @param params A Page object
  */
-function getPageMetadata(params: Core.Page): GriddoPageObject["context"]["pageMetadata"] {
+function getPageMetadata(
+	params: Core.Page,
+): GriddoPageObject["context"]["pageMetadata"] {
 	const {
 		title,
 		metaTitle,
@@ -78,7 +87,9 @@ function getPageMetadata(params: Core.Page): GriddoPageObject["context"]["pageMe
 		index: isIndexed ? "index" : "noindex",
 		follow: follow ? "follow" : "nofollow",
 		translate: metasAdvancedList.includes("notranslate") ? "notranslate" : "",
-		metasAdvanced: metasAdvancedList.filter((item) => item !== "notranslate").join(),
+		metasAdvanced: metasAdvancedList
+			.filter((item) => item !== "notranslate")
+			.join(),
 		pageLanguages,
 		metaKeywords: metaKeywords
 			?.filter(Boolean)
@@ -122,9 +133,8 @@ async function createGriddoPageObject(
 		siteSlug,
 		socials,
 		theme,
-		navigations,
+		navigations: { header, footer },
 	} = additionalInfo;
-	const { header, footer } = navigations;
 
 	// Update page object
 	page.breadcrumb = breadcrumb;
@@ -197,7 +207,10 @@ async function createGriddoPageObject(
  * @param page A Griddo single page object.
  * @param additionalInfo Additional page info.
  */
-async function createGriddoSinglePage(page: GriddoSinglePage, additionalInfo: PageAdditionalInfo) {
+async function createGriddoSinglePage(
+	page: GriddoSinglePage,
+	additionalInfo: PageAdditionalInfo,
+) {
 	return createGriddoPageObject(page, additionalInfo);
 }
 
@@ -205,7 +218,14 @@ async function createGriddoSinglePage(page: GriddoSinglePage, additionalInfo: Pa
  * Create multiples pages from one page as list paginated pages
  */
 async function createGriddoListPages(
-	{ page, pages, isRoot = false, defaultLang, template, totalQueriedItems }: GriddoListPage,
+	{
+		page,
+		pages,
+		isRoot = false,
+		defaultLang,
+		template,
+		totalQueriedItems,
+	}: GriddoListPage,
 	additionalInfo: PageAdditionalInfo,
 ) {
 	const allPages = pages.map(async (dataInPage, idx) => {
@@ -213,8 +233,19 @@ async function createGriddoListPages(
 		const pageNumber = idx + 1;
 		const { domainUrl, compose } = page.fullPath;
 
+		// Crea un id como número negativo y añadiendo un sufijo para los
+		// listados estáticos. Esto es así para marcarlas y posteriormente
+		// borrarlas siempre en cada nuevo render desde el Adapter.
+		//
+		// id de página con mode:"list": 1546
+		// ids de las "sub-páginas": -15460, -15461, -1546n, (-)id(idx)
+		//
+		// @todo eliminar el concepto multipage de CX, debería ser algo core de
+		// Griddo itself: API/AX, que fuesen páginas con sus ids, etc..
+
 		const paginatedPage = {
 			...page,
+			id: Number.parseInt(`-${page.id}${idx}`),
 			fullPath: {
 				...page.fullPath,
 				// Add a page number (tailPageNumber) from page 2 onwards
@@ -256,11 +287,16 @@ async function createGriddoListPages(
  * @param page A Griddo Multipage object.
  * @param additionalInfo Additional page info.
  */
-function createGriddoMultiPages(page: GriddoMultiPage, additionalInfo: PageAdditionalInfo) {
+function createGriddoMultiPages(
+	page: GriddoMultiPage,
+	additionalInfo: PageAdditionalInfo,
+) {
 	const { multiPageElements: multiPageElementsBulk, ...cleanPage } = page;
 	// TODO: Use structuredClone() when node 18 is available.
 	// WARN!! Se ha probado que parse(stringify()) está tan optimizado que puede ser más rápido que structuredClone...
-	const multiPageElements: MultiPageElements = JSON.parse(JSON.stringify(multiPageElementsBulk));
+	const multiPageElements: MultiPageElements = JSON.parse(
+		JSON.stringify(multiPageElementsBulk),
+	);
 
 	// Si no hay un elemento sin slug, como mínimo hay que dibujar una página
 	// principal para el conjunto de páginas.
@@ -269,7 +305,7 @@ function createGriddoMultiPages(page: GriddoMultiPage, additionalInfo: PageAddit
 	}
 
 	// Creates each page based on `multiPageElements` from the schema.
-	const allPages = multiPageElements.map(async (pageElement) => {
+	const allPages = multiPageElements.map(async (pageElement, idx) => {
 		// TODO: Use structuredClone() when node 18 is available.
 		// WARN!! Se ha probado que parse(stringify()) está tan optimizado que puede ser más rápido que structuredClone...
 		const paginatedPage: APIPageObject = JSON.parse(JSON.stringify(cleanPage));
@@ -287,7 +323,9 @@ function createGriddoMultiPages(page: GriddoMultiPage, additionalInfo: PageAddit
 
 		const cleanSectionSlug = sectionSlug?.replace(/\//g, "");
 		const isRootSlug = sectionSlug === "/";
-		const rightSectionSlug = isRootSlug ? cleanSectionSlug : `${cleanSectionSlug}/`;
+		const rightSectionSlug = isRootSlug
+			? cleanSectionSlug
+			: `${cleanSectionSlug}/`;
 
 		const slash = compose.endsWith("/") ? "" : "/";
 		const newCompose = `${compose}${slash}${rightSectionSlug}`;
@@ -300,12 +338,24 @@ function createGriddoMultiPages(page: GriddoMultiPage, additionalInfo: PageAddit
 			paginatedPage.metaDescription = metaDescription;
 		}
 
+		// Crea un id como número negativo y añadiendo un sufijo para las multipages.
+		// Esto es así para marcarlas y posteriormente borrarlas siempre en cada
+		// nuevo render desde el Adapter.
+		//
+		// id de página con hasMultipageTrue: 1546
+		// ids de las "sub-páginas": -15460, -15461, -1546n, (-)id(idx)
+		//
+		// @todo eliminar el concepto multipage de CX, debería ser algo core de
+		// Griddo itself: API/AX, que fuesen páginas con sus ids, etc..
+		paginatedPage.id = Number.parseInt(`-${paginatedPage.id}${idx}`);
+
 		paginatedPage.fullUrl = `${fullUrl}/${rightSectionSlug}`;
 		paginatedPage.fullPath.compose = newCompose;
 		paginatedPage.slug = newCompose;
 		paginatedPage.template.activeSectionSlug = sectionSlug;
 		paginatedPage.template.activeSectionBase = fullUrl;
-		paginatedPage.metaTitle = metaTitle.trim() || title.trim() || paginatedPage.metaTitle;
+		paginatedPage.metaTitle =
+			metaTitle.trim() || title.trim() || paginatedPage.metaTitle;
 
 		return createGriddoPageObject(paginatedPage, additionalInfo);
 	});
@@ -318,7 +368,9 @@ function createGriddoMultiPages(page: GriddoMultiPage, additionalInfo: PageAddit
  *
  * @param page The page to get the multipage parts.
  */
-function getMultiPageElements(page: TemplateWithReferenceField): Promise<MultiPageElements> | null {
+function getMultiPageElements(
+	page: TemplateWithReferenceField,
+): Promise<MultiPageElements> | null {
 	const multiPageElements = new Promise((resolve) => {
 		// Recursive
 		const getMultiPageComponent = (
@@ -339,10 +391,11 @@ function getMultiPageElements(page: TemplateWithReferenceField): Promise<MultiPa
 					hasGriddoMultiPage: boolean;
 					elements: Array<Record<string, unknown>>;
 				};
-				const isValidComponent = currentComponent || typeof currentComponent === "object";
-				const hasGriddoMultiPageProp = JSON.stringify(currentComponent).includes(
-					'"hasGriddoMultiPage":true',
-				);
+				const isValidComponent =
+					currentComponent || typeof currentComponent === "object";
+				const hasGriddoMultiPageProp = JSON.stringify(
+					currentComponent,
+				).includes('"hasGriddoMultiPage":true');
 
 				if (!isValidComponent) {
 					continue;
@@ -392,7 +445,11 @@ function getMultiPageElements(page: TemplateWithReferenceField): Promise<MultiPa
  * getPage(3, ["a", "b", "c", "d", "e", "f", "g", "h"], 2)
  * // -> ["d", "e", "f"]
  */
-function getPage(itemsPerPage: number, items: Array<Fields.QueriedDataItem>, page: number) {
+function getPage(
+	itemsPerPage: number,
+	items: Array<Fields.QueriedDataItem>,
+	page: number,
+) {
 	return items?.slice(itemsPerPage * (page - 1), itemsPerPage * page);
 }
 
@@ -406,11 +463,16 @@ function getPage(itemsPerPage: number, items: Array<Fields.QueriedDataItem>, pag
  * getPageCluster(3, ["a", "b", "c", "d", "e", "f", "g", "h"])
  * // -> [["a", "b", "c"], ["d", "e", "f"], ["g", "h"]]
  */
-function getPageCluster(itemsPerPage: number, items: Array<Fields.QueriedDataItem>) {
+function getPageCluster(
+	itemsPerPage: number,
+	items: Array<Fields.QueriedDataItem>,
+) {
 	const totalPagesCount = Math.ceil(items.length / itemsPerPage) || 1;
 	const pageNumbers = Array.from({ length: totalPagesCount }, (_, i) => i + 1);
 
-	return pageNumbers?.map((pageNumber) => getPage(itemsPerPage, items, pageNumber));
+	return pageNumbers?.map((pageNumber) =>
+		getPage(itemsPerPage, items, pageNumber),
+	);
 }
 
 /**
@@ -420,7 +482,8 @@ function getPageCluster(itemsPerPage: number, items: Array<Fields.QueriedDataIte
  */
 function getPaginatedPages(listTemplate: TemplateWithReferenceField) {
 	const items = listTemplate.queriedItems || [];
-	const itemsPerPage = listTemplate?.itemsPerPage || DEFAULT_ITEMS_PER_PAGE_FOR_LIST_TEMPLATES;
+	const itemsPerPage =
+		listTemplate?.itemsPerPage || DEFAULT_ITEMS_PER_PAGE_FOR_LIST_TEMPLATES;
 	const pageClusters = getPageCluster(itemsPerPage, items);
 
 	return pageClusters;
@@ -461,7 +524,9 @@ function addPageNumberToUrl(
 		return removeDuplicateTrailing(`${url}${endingSlash}`);
 	}
 
-	return removeDuplicateTrailing(`${url}${trailingSlash}${pageNumber}${endingSlash}`);
+	return removeDuplicateTrailing(
+		`${url}${trailingSlash}${pageNumber}${endingSlash}`,
+	);
 }
 
 /**