@griddo/cx 10.6.4 → 10.6.6

package/exporter/types/global.ts

@@ -3,7 +3,6 @@ import type { Core, Fields } from "@griddo/core";
 
 import { Site } from "./sites";
 
-// TODO: JSDoc
 interface Settings {
 	apiVersion?: string;
 	avoidCanonicalsOnSitemaps?: boolean;
@@ -28,10 +27,8 @@ interface Settings {
 	welcomeText2?: string;
 }
 
-// TODO: JSDoc
 type Petition = Record<string, unknown>;
 
-// TODO: JSDoc
 interface PostSearchInfoProps {
 	title?: string;
 	description: string | null | undefined;
@@ -44,7 +41,6 @@ interface PostSearchInfoProps {
 	url?: string;
 }
 
-// TODO: JSDoc
 interface FetchDataProps {
 	page: Core.Page;
 	component: {
@@ -54,7 +50,6 @@ interface FetchDataProps {
 	cacheKey: string;
 }
 
-// TODO: JSDoc
 type Domains = Array<{
 	id: number;
 	slug: string;
@@ -64,10 +59,8 @@ type Domains = Array<{
 /** Describes the type of build process data object. */
 type BuildProcessData = Record<string, EndSiteRenderBody>;
 
-// TODO: JSDoc
 type Robot = { path: string; content: string };
 
-// TODO: JSDoc
 type Robots = Array<Robot>;
 
 interface RenderInfo {
@@ -86,9 +79,10 @@ type LifeCyclesNames =
 	| "Archive"
 	| "Clean"
 	| "HealthCheck"
+	| "Close"
 	| "__DEBUG__";
 
-type CXDir =
+type PlaceholderPath =
 	| "__exports"
 	| "__caches"
 	| "__cx"
@@ -101,17 +95,7 @@ type CXDir =
 interface CXConfig {
 	proDomain: string;
 	griddoVersion: string;
-	CXDir: {
-		EXPORTS: "__exports";
-		CACHE: "__caches";
-		CX: "__cx";
-		SSG: "__ssg";
-		COMPONENTS: "__components";
-		ROOT: "__root";
-		EXPORTS_DIST: "__exports_dist";
-		CX_DIST: "__cx_dist";
-	};
-	paths: (domain?: string) => Record<CXDir, string>;
+	paths: (domain?: string) => Record<PlaceholderPath, string>;
 }
 
 interface AIEmbeddingsResponse {
@@ -119,18 +103,26 @@ interface AIEmbeddingsResponse {
 	message: string;
 }
 
-export {
+interface Artifacts {
+	disposables: Array<string>;
+	cacheables: Array<string>;
+	initials: Array<string>;
+	archivables: Array<string>;
+}
+
+export type {
+	AIEmbeddingsResponse,
+	Artifacts,
 	BuildProcessData,
 	CXConfig,
-	CXDir,
 	Domains,
 	FetchDataProps,
 	LifeCyclesNames,
 	Petition,
+	PlaceholderPath,
 	PostSearchInfoProps,
 	RenderInfo,
 	Robot,
 	Robots,
 	Settings,
-	type AIEmbeddingsResponse,
 };

package/exporter/types/pages.ts

@@ -10,13 +10,11 @@ export type APIPageObject = Core.Page & { id: number } & {
 	footer: number | null;
 };
 
-// TODO: JSDoc
 export type CleanPage = Core.Page & {
 	isRoot: boolean;
 	defaultLang?: Core.SiteLanguage | undefined;
 };
 
-// TODO: JSDoc
 export type RenderPage = Core.Page & {
 	isRoot?: boolean;
 	multiPageElements: MultiPageElements;
@@ -31,12 +29,10 @@ export type RenderPage = Core.Page & {
 	mode: "list";
 };
 
-// TODO: JSDoc
 export type GriddoSinglePage = Core.Page & {
 	defaultLang?: Core.SiteLanguage;
 };
 
-// TODO: JSDoc
 export type GriddoListPage = Core.Page & {
 	page: APIPageObject;
 	pages: Array<Array<Fields.QueriedDataItem>>;
@@ -52,7 +48,6 @@ export type GriddoListPage = Core.Page & {
 	totalQueriedItems: Array<Fields.QueriedDataItem>;
 };
 
-// TODO: JSDoc
 export type GriddoMultiPage = Core.Page & {
 	header: number | null;
 	footer: number | null;
@@ -61,7 +56,6 @@ export type GriddoMultiPage = Core.Page & {
 	defaultLang?: Core.SiteLanguage | undefined;
 };
 
-// TODO: JSDoc
 export interface AdditionalInfo {
 	baseUrl: string;
 	cloudinaryName?: string;
@@ -86,7 +80,6 @@ export interface AdditionalInfo {
 	theme: string;
 }
 
-// TODO: JSDoc
 export interface PageAdditionalInfo extends AdditionalInfo {
 	navigations: {
 		header: Record<string, unknown> | null;
@@ -94,7 +87,6 @@ export interface PageAdditionalInfo extends AdditionalInfo {
 	};
 }
 
-// TODO: JSDoc
 export type MultiPageElement = {
 	component: string;
 	title: string | Required<Fields.Heading>;
@@ -105,7 +97,6 @@ export type MultiPageElement = {
 	metaDescription: string;
 };
 
-// TODO: JSDoc
 export type MultiPageElements = Array<MultiPageElement>;
 
 /**

package/exporter/types/sites.ts

@@ -46,7 +46,6 @@ export interface Site
 	updated: boolean;
 }
 
-// TODO: JSDoc
 export interface SiteData {
 	siteInfo: Site;
 	validPagesIds: Array<number>;
@@ -59,8 +58,6 @@ export interface SiteData {
 	socials: SocialsResponse;
 }
 
-// TODO: JSDoc
 export type SiteHash = string | null;
 
-// TODO: JSDoc
 export type HashSites = Record<string, number | string>;

package/exporter/utils/api.ts

@@ -13,7 +13,8 @@ import chalk from "chalk";
 import dotenv from "dotenv";
 
 import { saveCache, searchCacheData } from "./cache";
-import { delay, getSafeSiteId, logInfo, msToSec } from "./core-utils";
+import { delay, getSafeSiteId, msToSec } from "./core-utils";
+import { infoLog } from "./loggin";
 import { AuthService } from "../services/auth";
 
 dotenv.config();
@@ -39,7 +40,7 @@ const {
 async function requestAPI<T extends APIResponses>(
 	props: APIRequest,
 	method: Method,
-	appendToLog = ""
+	appendToLog = "",
 ): Promise<T> {
 	const { endpoint, body, cacheKey = "", attempt = 1, headers } = props;
 	const cacheOptions = { endpoint, body, headers, cacheKey };
@@ -53,8 +54,8 @@ async function requestAPI<T extends APIResponses>(
 			const siteId = getSafeSiteId(cacheData);
 			const siteIdMsg = siteId ? `site: ${siteId}` : "";
 			const duration = msToSec(new Date().getTime() - start.getTime());
-			logInfo(
-				`${method} (cache) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`
+			infoLog(
+				`${method} (cache) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`,
 			);
 			return cacheData;
 		}
@@ -73,8 +74,8 @@ async function requestAPI<T extends APIResponses>(
 		const siteId = getSafeSiteId(data);
 		const siteIdMsg = siteId ? `site: ${siteId}` : "";
 		const duration = msToSec(new Date().getTime() - start.getTime());
-		logInfo(
-			`${method} (fetch) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`
+		infoLog(
+			`${method} (fetch) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`,
 		);
 
 		saveCache(cacheOptions, data);
@@ -123,7 +124,7 @@ Max attempts ${RETRY_ATTEMPTS} reached
 				attempt: attempt + 1,
 			},
 			method,
-			appendToLog
+			appendToLog,
 		);
 	}
 }
@@ -159,7 +160,7 @@ async function postApi<T extends APIResponses>(props: PostAPI) {
 	const distributorBodyParams =
 		endpoint.endsWith("/distributor") &&
 		`# Distributor body: ${JSON.stringify(body)} lang: ${JSON.stringify(
-			headers?.lang
+			headers?.lang,
 		)}`;
 
 	return await requestAPI<T>(props, "post", distributorBodyParams || "");
@@ -180,7 +181,7 @@ function showApiError(error: AxiosError, options: ShowApiErrorOptions) {
 				typeof callInfo[item] === "object"
 					? JSON.stringify(callInfo[item])
 					: callInfo[item]
-			}`
+			}`,
 		);
 	}
 
@@ -206,7 +207,7 @@ ${apiResponseStr}
 ${errorDetailsStr}
 
 =============
-`)
+`),
 	);
 }
 

package/exporter/utils/core-utils.ts

@@ -1,4 +1,3 @@
-import type { Adapters } from "../adapters";
 import type { APIResponses } from "../types/api";
 import type { CXConfig, LifeCyclesNames } from "../types/global";
 import type { APIPageObject } from "../types/pages";
@@ -10,33 +9,20 @@ import path from "node:path";
 import chalk from "chalk";
 import dotenv from "dotenv";
 import fsx from "fs-extra";
-import gradient from "gradient-string";
 import pkgDir from "pkg-dir";
 
 import { createDirsSync, removeDirsSync } from "./folders";
+import { boxLog, verboseLog } from "./loggin";
+import { generateBuildReport, generateSitemaps } from "./sites";
+import { envs } from "../constants";
+import { writeRobots } from "../services/robots";
 
 dotenv.config();
 
 const config = getConfig();
 
-const GRIDDO_DEBUG_LOGS = isTruthy(process.env.GRIDDO_DEBUG_LOGS);
-const GRIDDO_BUILD_LOGS = isTruthy(process.env.GRIDDO_BUILD_LOGS);
-
 const instanceRootDir = pkgDir.sync()!; // instance root dir
 
-const attempts = {
-	clean: JSON.parse(process.env.GRIDDO_CLEAN_LIFECYCLE_MAX_ATTEMPTS || "1"),
-	prepare: JSON.parse(process.env.GRIDDO_PREPARE_LIFECYCLE_MAX_ATTEMPTS || "1"),
-	restore: JSON.parse(process.env.GRIDDO_RESTORE_LIFECYCLE_MAX_ATTEMPTS || "1"),
-	data: JSON.parse(process.env.GRIDDO_DATA_LIFECYCLE_MAX_ATTEMPTS || "1"),
-	ssg: JSON.parse(process.env.GRIDDO_SSG_LIFECYCLE_MAX_ATTEMPTS || "2"),
-	relocation: JSON.parse(
-		process.env.GRIDDO_RELOCATION_LIFECYCLE_MAX_ATTEMPTS || "1"
-	),
-	meta: JSON.parse(process.env.GRIDDO_META_LIFECYCLE_MAX_ATTEMPTS || "4"),
-	archive: JSON.parse(process.env.GRIDDO_ARCHIVE_LIFECYCLE_MAX_ATTEMPTS || "1"),
-};
-
 /**
  * Returns the configuration file content.
  *
@@ -67,9 +53,9 @@ async function exporterCreateInitialDirectories(domain: string) {
 	const { __exports, __caches } = config.paths(domain);
 
 	createDirsSync([__exports]);
-	verbose("create `exports/sites/<domain>` directory");
+	verboseLog("create `exports/sites/<domain>` directory");
 	createDirsSync([__caches]);
-	verbose("create `caches/<domain>` directory");
+	verboseLog("create `caches/<domain>` directory");
 }
 
 /**
@@ -81,21 +67,7 @@ async function exporterCleanDisposableDirectories(domain: string) {
 	const { __cx } = config.paths(domain);
 
 	removeDirsSync(__cx, ["store", "apiCache", "dist"]);
-	verbose("clean `store`, `apiCache` and `dist` directories from `__cx`");
-}
-
-/**
- * Custom basic logging function controlled by a environment variable.
- *
- * @param str The string to be logged.
- */
-function verbose(str: string) {
-	if (GRIDDO_DEBUG_LOGS) {
-		console.log(
-			chalk.hex("#ffff33")("verbose"),
-			chalk.gray(str.replace(/(\s)\s+/g, "$1").trim())
-		);
-	}
+	verboseLog("clean `store`, `apiCache` and `dist` directories from `__cx`");
 }
 
 /**
@@ -142,70 +114,6 @@ function walk(dir: string) {
 	return results;
 }
 
-/**
- * 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 logBox(
-	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 longerLine = Math.max(longerContent, windowTitleLength);
-	const paddingBlockString = `│${" ".repeat(longerLine)}│\n`.repeat(
-		paddingBlock
-	);
-	const minWidth = longerLine;
-	const borderTop = `╭${windowTitle}${"─".repeat(
-		minWidth - windowTitleLength
-	)}╮\n`;
-	const borderBottom = `╰${"─".repeat(minWidth)}╯`;
-	const content = lines
-		.map((l) => {
-			const mr = " ".repeat(longerLine - l.length - paddingInline);
-			return `│${" ".repeat(paddingInline)}${l}${mr}│\n`;
-		})
-		.join("");
-
-	console.log(
-		`${borderTop}${paddingBlockString}${content}${paddingBlockString}${borderBottom}`
-	);
-}
-
-/**
- * Custom basic logging function controlled by a environment variable.
- * Strip double spaces.
- *
- * @param str The string to be logged.
- */
-function logInfo(str: string) {
-	if (GRIDDO_BUILD_LOGS) {
-		console.info(str.replace(/(\s)\s+/g, "$1").trim());
-	}
-}
-
-/**
- * Internal log
- * @param values The values to be logged.
- */
-function debug(...values: Array<unknown>) {
-	if (!GRIDDO_DEBUG_LOGS) {
-		return;
-	}
-	console.log(...values);
-}
-
 /**
  * Custom delay using the "promise hack",
  *
@@ -215,33 +123,6 @@ function delay(ms: number) {
 	return new Promise((res) => setTimeout(res, ms));
 }
 
-/**
- * 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 logPageSize(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 chalk[color].bold(`${size}${measure}`);
-}
-
 /**
  * Converts milliseconds to seconds with a fixed number of decimals.
  *
@@ -259,9 +140,9 @@ export function msToSec(ms: number, decimals = 3) {
  */
 export function getSafeSiteId(response: APIResponses) {
 	if (typeof response === "string") {
-		return undefined
+		return undefined;
 	}
-	
+
 	return "site" in response && response.site ? response?.site : undefined;
 }
 
@@ -290,23 +171,6 @@ function siteList(sites: Array<Site>) {
 	return sites.map(({ name, id }) => `${name} (${id})`).join(", ");
 }
 
-/**
- * Print the great Griddo Exporter logo in ASCII.
- */
-function printExporterLogo(adapter: Adapters) {
-	const nodeVersion = process.version;
-	const { griddoVersion } = config;
-	const logo = `
-··
-··      Griddo Exporter ${griddoVersion}
-··      Adapter: ${adapter}
-··      Node: ${nodeVersion}
-··
-`;
-
-	console.log(gradient.cristal(logo));
-}
-
 /**
  * Remove unused files (old) inside the `apiCache` dir
  *
@@ -350,7 +214,6 @@ function sanitizeAPICacheDir() {
 		if (validPageFile) filesByIdMap[id] = fileName;
 	}
 
-	// TODO: Remove this counter for production
 	let counter = 0;
 
 	// Delete files using the store object filesById as reference map.
@@ -376,12 +239,16 @@ function sanitizeAPICacheDir() {
  * @returns A promise that resolves with the total execution time in seconds.
  */
 async function measureExecutionTime(
-	...functions: Array<(...args: Array<unknown>) => unknown | Promise<any>>
+	functions: Array<(...args: Array<unknown>) => unknown | Promise<unknown>>,
+	delayInMS = 0,
 ): Promise<number> {
 	const start = process.hrtime();
 
 	for (const func of functions) {
 		await func();
+		if (delayInMS > 0) {
+			await delay(delayInMS);
+		}
 	}
 
 	const [seconds, miliseconds] = process.hrtime(start);
@@ -392,7 +259,7 @@ async function measureExecutionTime(
 
 function pause(title: string) {
 	const isPauseEnabled = !!JSON.parse(
-		process.env.GRIDDO_RENDER_BREAKPOINTS_FEATURE || "false"
+		process.env.GRIDDO_RENDER_BREAKPOINTS_FEATURE || "false",
 	);
 
 	if (!isPauseEnabled) {
@@ -401,51 +268,64 @@ function pause(title: string) {
 
 	return new Promise<void>((resolve) => {
 		console.log("\n");
-		logBox(`⌛️ ${title}`, "", 1, 0);
+		boxLog(`⌛️ ${title}`, "", 1, 0);
 		process.stdin.once("data", () => {
 			resolve();
 		});
 	});
 }
 
-function startLifeCycle(lifeCyleName: string) {
-	console.info(`
-${chalk.blue(`info`)} start ${lifeCyleName} life-cycle`);
-}
-
-function successLifeCyle(value: string) {
-	console.info(`${chalk.green("success")} ${value}`);
-}
-
 /**
  * Executes a life cycle process, which involves executing an array of
  * functions, printing to the console, and handling errors with optional
  * retries.
  *
  * @async
- * @param args - The arguments object.
- * @param args.steps - An array of functions to execute.
- * @param args.name - The name of the life cycle.
- * @param args.attempts=1 - The number of retry attempts allowed in case of errors.
- * @param args.bypass - Skip the step functions.
+ * @param name - The name of the life cycle.
+ * @param options - The arguments object.
+ * @param options.steps - An array of functions to execute.
+ * @param options.delay - Delay between steps functions.
+ * @param options.bypass - Skip the step functions.
  * @returns - A promise that resolves when the life cycle process is completed.
  */
-async function doLifeCycle(args: {
-	steps: Array<(...args: Array<unknown>) => unknown | Promise<any>>;
-	name: LifeCyclesNames;
-	attempts?: number;
-}) {
-	const { steps, name, attempts } = args;
+async function doLifeCycle(
+	name: LifeCyclesNames,
+	options: {
+		steps: Array<(...args: Array<unknown>) => unknown | Promise<any>>;
+		delay?: number;
+		bypass?: boolean;
+	},
+) {
+	const { steps, bypass, delay } = options;
+
+	if (bypass) {
+		return;
+	}
+
+	const attemptsByLifeCycleName: Record<LifeCyclesNames, number> = {
+		Archive: envs.GRIDDO_ARCHIVE_LIFECYCLE_MAX_ATTEMPTS,
+		Data: envs.GRIDDO_DATA_LIFECYCLE_MAX_ATTEMPTS,
+		Meta: envs.GRIDDO_META_LIFECYCLE_MAX_ATTEMPTS,
+		Relocation: envs.GRIDDO_RELOCATION_LIFECYCLE_MAX_ATTEMPTS,
+		Clean: envs.GRIDDO_CLEAN_LIFECYCLE_MAX_ATTEMPTS,
+		Restore: envs.GRIDDO_RESTORE_LIFECYCLE_MAX_ATTEMPTS,
+		Prepare: envs.GRIDDO_PREPARE_LIFECYCLE_MAX_ATTEMPTS,
+		Close: envs.GRIDDO_CLOSE_LIFECYCLE_MAX_ATTEMPTS,
+		SSG: envs.GRIDDO_SSG_LIFECYCLE_MAX_ATTEMPTS,
+		HealthCheck: 1,
+		__DEBUG__: 1,
+	};
 
 	let trysCount = 0;
-	const maxTrysAccepted = attempts || 1;
+	const maxTrysAccepted = attemptsByLifeCycleName[name] || 1;
 
 	while (trysCount < maxTrysAccepted) {
 		try {
 			console.info(`\n${chalk.blue(`info`)} start ${name} life-cycle`);
-			const exeTime = await measureExecutionTime(...steps);
+			const exeTime = await measureExecutionTime(steps, delay);
 			console.info(`${chalk.green("success")} ${name} - ${exeTime}s`);
 			// if no errors, go out!! :)
+			await pause(`${name} LifeCycle`);
 			break;
 		} catch (error) {
 			const errorString = chalk.bgRed.black(` Error in ${name} LifeCycle `);
@@ -459,7 +339,7 @@ async function doLifeCycle(args: {
 	}
 	if (trysCount === maxTrysAccepted) {
 		throw new Error(
-			`Exceeded maximum retry attempts (${maxTrysAccepted}) for ${name} LifeCycle`
+			`Exceeded maximum retry attempts (${maxTrysAccepted}) for ${name} LifeCycle`,
 		);
 	}
 }
@@ -483,9 +363,21 @@ function isVersionLowerThan(versionA: string, versionB: string) {
 	return !isVersionGreaterThan(versionA, versionB);
 }
 
+/**
+ * Creates additional files after the render: sitemaps, robots and a report of
+ * the finished render.
+ *
+ * @async
+ * @param domain
+ */
+async function createRenderMetadata(domain: string) {
+	await generateBuildReport();
+	await generateSitemaps();
+	await writeRobots(domain);
+}
+
 export {
-	attempts,
-	debug,
+	createRenderMetadata,
 	delay,
 	doLifeCycle,
 	exporterCleanDisposableDirectories,
@@ -495,17 +387,10 @@ export {
 	isTruthy,
 	isVersionGreaterThan,
 	isVersionLowerThan,
-	logBox,
-	logInfo,
-	logPageSize,
 	measureExecutionTime,
 	pause,
-	printExporterLogo,
 	removeProperties,
 	sanitizeAPICacheDir,
 	siteList,
-	startLifeCycle,
-	successLifeCyle,
-	verbose,
 	walk,
 };

package/exporter/utils/domains.ts

@@ -1,9 +1,27 @@
 import type { Domains } from "../types/global";
 
-import { verbose } from "./core-utils";
+import { verboseLog } from "./loggin";
+import { throwError } from "../errors";
+import { NoDomainsFoundError } from "../errors/errors-data";
 import { AuthService } from "../services/auth";
 import { DomainsService } from "../services/domains";
 
+/**
+ * Return an array of domains name (string) of the current instance.
+ */
+async function getInstanceDomainsOrThrow() {
+	await AuthService.login();
+	const domains = await DomainsService.getAll();
+
+	if (!domains.length) {
+		throwError(NoDomainsFoundError);
+	}
+
+	verboseLog(`getting domains names (${domains.length})`);
+
+	return getDomainSlugs(domains);
+}
+
 /**
  * Return an array of domains name (string) of the current instance.
  */
@@ -11,7 +29,7 @@ async function getInstanceDomains() {
 	await AuthService.login();
 	const domains = await DomainsService.getAll();
 
-	verbose(`Getting domains slugs (${domains.length})`);
+	verboseLog(`Getting domains slugs (${domains.length})`);
 
 	return getDomainSlugs(domains);
 }
@@ -30,4 +48,4 @@ function getDomainSlugs(domains: Domains) {
 	return [...new Set(filteredDomains)];
 }
 
-export { getInstanceDomains };
+export { getInstanceDomains, getInstanceDomainsOrThrow };