@griddo/cx 10.6.5 → 10.6.7

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

@@ -85,6 +85,7 @@ declare function pause(title: string): Promise<void> | undefined;
  * retries.
  *
  * @async
+ * @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.
@@ -98,4 +99,12 @@ declare function doLifeCycle(name: LifeCyclesNames, options: {
 }): Promise<void>;
 declare function isVersionGreaterThan(versionA: string, versionB: string): boolean;
 declare function isVersionLowerThan(versionA: string, versionB: string): boolean;
-export { delay, doLifeCycle, exporterCleanDisposableDirectories, exporterCreateInitialDirectories, getConfig, instanceRootDir, isTruthy, isVersionGreaterThan, isVersionLowerThan, measureExecutionTime, pause, removeProperties, sanitizeAPICacheDir, siteList, walk, };
+/**
+ * Creates additional files after the render: sitemaps, robots and a report of
+ * the finished render.
+ *
+ * @async
+ * @param domain
+ */
+declare function createRenderMetadata(domain: string): Promise<void>;
+export { createRenderMetadata, delay, doLifeCycle, exporterCleanDisposableDirectories, exporterCreateInitialDirectories, getConfig, instanceRootDir, isTruthy, isVersionGreaterThan, isVersionLowerThan, measureExecutionTime, pause, removeProperties, sanitizeAPICacheDir, siteList, walk, };

package/build/utils/folders.d.ts

@@ -24,18 +24,6 @@ declare function createDirsSync(dirs: Array<string>, options?: MakeDirectoryOpti
 declare function copyDirsSync(src: string, dst: string, dirs: Array<string>, options?: {
     withBackup: boolean;
 }): void;
-/**
- * Move artifacts between CX valid directories.
- *
- * @param src - Source directory.
- * @param dst - Destination directory.
- * @param dirs - Directories to move.
- * @param options - Options.
- */
-declare function moveDirsSync(src: string, dst: string, dirs: Array<string>, options?: {
-    withBackup?: boolean;
-    override?: boolean;
-}): void;
 /**
  * Remove directories from `basePath` directory.
  *
@@ -49,4 +37,41 @@ declare function removeVirtualPagesFromStore(): Promise<void>;
  * @param initialFolder - The initial folder to start the searching...
  */
 declare function clearSitemapsFromDirs(initialFolder: string): void;
-export { clearEmptyDirs, clearSitemapsFromDirs, copyDirsSync, createDirsSync, moveDirsSync, removeDirsSync, removeVirtualPagesFromStore, };
+/**
+ * Removes multiple artifact directories.
+ *
+ * @param artifacts - An array of artifact directory paths.
+ */
+declare function removeArtifacts(artifacts: Array<string>): void;
+/**
+ * Creates multiple directories.
+ *
+ * @param dirs - An array of directory paths.
+ * @param options - Same option as `fs.mkdirSync()`
+ */
+declare function createArtifacts(dirs: Array<string>, options?: MakeDirectoryOptions): void;
+/**
+ * Copy multiple directories with backup option.
+ *
+ * @param src - Source directory.
+ * @param dst - Destination directory.
+ * @param dirs - Directories to copy.
+ * @param options.withBackup - Create a previous backup before copy.
+ */
+declare function copyArtifacts(src: string, dst: string, dirs: Array<string>, options?: {
+    withBackup: boolean;
+}): void;
+declare function renameArtifact(src: string, dst: string): void;
+/**
+ * Move artifacts between cx-paths
+ *
+ * @param src - Source directory.
+ * @param dst - Destination directory.
+ * @param dirs - Directories to move.
+ * @param options - Options.
+ */
+declare function moveArtifacts(src: string, dst: string, dirs: Array<string>, options?: {
+    withBackup?: boolean;
+    override?: boolean;
+}): void;
+export { clearEmptyDirs, clearSitemapsFromDirs, copyArtifacts, copyDirsSync, createArtifacts, createDirsSync, moveArtifacts, removeArtifacts, removeDirsSync, removeVirtualPagesFromStore, renameArtifact, };

package/build/utils/render.d.ts

@@ -3,9 +3,9 @@
  * This file is used to track later if node_modules/@griddo/cx was cleaned by a
  * npm install from a deploy.
  */
-declare function createSentinelDomainRenderFile(): void;
-declare function deleteSentinelFile(): void;
+declare function createSentinelRenderFile(): void;
+declare function deleteSentinelRenderFile(): void;
 declare function isValidRenderProcessOrThrow(): void;
 declare function initRender(): void;
 declare function finishRender(): undefined;
-export { finishRender, initRender, isValidRenderProcessOrThrow, createSentinelDomainRenderFile, deleteSentinelFile, };
+export { finishRender, initRender, isValidRenderProcessOrThrow, createSentinelRenderFile, deleteSentinelRenderFile, };

package/build/utils/store.d.ts

@@ -27,7 +27,6 @@ declare function getBuildPagesFromStore<PageType extends GriddoPageObject>(args?
 declare function getBuildPagesPath(): string[];
 /**
  * Get the build metadata from the Store.
- * TODO: Refactorizar para leer un solo archivo: __metadata__.json
  */
 declare function getBuildMetadata(): Promise<BuildMetaData>;
 /**

package/cx.config.d.ts

@@ -3,18 +3,3 @@ import { CXConfig } from "./exporter/types/global";
 declare const config: CXConfig;
 
 export default config;
-
-declare const CXDir: {
-	EXPORTS: "__exports";
-	CACHE: "__caches";
-	CX: "__cx";
-	SSG: "__ssg";
-	COMPONENTS: "__components";
-	ROOT: "__root";
-	EXPORT_DIST: "__exports_dist";
-	CX_DIST: "__cx_dist";
-};
-
-export type Artifact = "store" | "apiCache" | "dist" | "assets";
-
-export { CXDir };

package/cx.config.js

@@ -20,16 +20,6 @@ const { version: griddoVersion } = require(
 const config = {
 	proDomain: "pro-",
 	griddoVersion,
-	CXDir: {
-		EXPORTS: "__exports",
-		CACHE: "__caches",
-		CX: "__cx",
-		SSG: "__ssg",
-		COMPONENTS: "__components",
-		ROOT: "__root",
-		EXPORTS_DIST: "__exports_dist",
-		CX_DIST: "__cx_dist",
-	},
 	paths: (domain) => ({
 		__caches: path.join(CX_CACHE_DIR, domain || ""),
 		__components: COMPONENTS_DIR,
@@ -43,5 +33,3 @@ const config = {
 };
 
 export default config;
-const CXDir = config.CXDir;
-export { CXDir };

package/exporter/adapters/gatsby/index.ts

@@ -1,56 +1,61 @@
-import fs from "node:fs";
 import path from "node:path";
 
-/* prettier-ignore */ import { getGatsbyAssetPrefixWithDomain, legacy__createDistFromGatsbyPublic, runGatsbyBuildCommand, } from "./utils";
-/* prettier-ignore */ import { RobotsService } from "../../services/robots";
-/* prettier-ignore */ import { doLifeCycle, getConfig, pause } from "../../utils/core-utils";
+/* prettier-ignore */ import { getGatsbyAssetPrefixWithDomain, legacy__createDistFromGatsbyPublic, runGatsbyBuildCommand } from "./utils";
+/* prettier-ignore */ import { getArtifacts } from "../../artifacts";
+/* prettier-ignore */ import { createRenderMetadata, doLifeCycle, getConfig } from "../../utils/core-utils";
 /* prettier-ignore */ import { createBuildData } from "../../utils/create-build-data";
-/* prettier-ignore */ import { clearEmptyDirs, copyDirsSync, createDirsSync, moveDirsSync, removeDirsSync, removeVirtualPagesFromStore, } from "../../utils/folders";
-/* prettier-ignore */ import { boxLog, printExporterLogo } from "../../utils/loggin";
-/* prettier-ignore */ import { createSentinelDomainRenderFile, isValidRenderProcessOrThrow, } from "../../utils/render";
-/* prettier-ignore */ import { generateBuildReport, generateSitemaps } from "../../utils/sites";
+/* prettier-ignore */ import { clearEmptyDirs, copyArtifacts, createArtifacts, moveArtifacts, removeArtifacts, removeVirtualPagesFromStore, renameArtifact } from "../../utils/folders";
+/* prettier-ignore */ import { infoLog, printExporterLogo } from "../../utils/loggin";
+/* prettier-ignore */ import { createSentinelRenderFile, deleteSentinelRenderFile, isValidRenderProcessOrThrow } from "../../utils/render";
 
 const config = getConfig();
 
 async function renderDomain(domain: string) {
-	boxLog(`Initializing render for the domain ${domain}`, "", 1, 0);
-
-	createSentinelDomainRenderFile();
-
-	const { __ssg, __exports, __caches, __cx, __components } =
-		config.paths(domain);
-
-	// This variables are for both, create the dist directory from public
-	// and pass to the gatsby-build command via spawnSync.
+	infoLog(`Initializing render for the domain ${domain}`);
+
+	createSentinelRenderFile();
+
+	const cxPaths = config.paths(domain);
+	const domainArtifacts = getArtifacts("gatsby", { cxPaths });
+	const { __ssg, __exports, __caches, __cx, __components } = cxPaths;
+
+	const arts = {
+		...domainArtifacts,
+		all: {
+			disposables: [
+				...domainArtifacts.cx.disposables,
+				...domainArtifacts.ssg.disposables,
+			],
+			initials: [
+				...domainArtifacts.cx.initials,
+				...domainArtifacts.ssg.initials,
+			],
+		},
+	};
+
+	// This variables are for:
+	// - Create the dist directory from public in the Relocation LifeCycle.
+	// - Pass to the gatsby-build command via spawnSync in the SSG LifeCycle.
 	const assetPrefix = getGatsbyAssetPrefixWithDomain(domain);
 	const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
 
+	// LifeCycles
+
 	await doLifeCycle("Clean", {
-		steps: [
-			() => removeDirsSync(__cx, ["store", "apiCache", "dist"]),
-			() => removeDirsSync(__ssg, ["dist", "public", "static", ".cache"]),
-		],
+		steps: [() => removeArtifacts(arts.all.disposables)],
 	});
 
 	await doLifeCycle("Prepare", {
-		steps: [
-			() => createDirsSync([__exports]),
-			() => createDirsSync([__caches]),
-		],
+		steps: [() => createArtifacts(arts.all.initials)],
 	});
 
 	await doLifeCycle("Restore", {
 		steps: [
-			() => copyDirsSync(__components, __ssg, ["static"]),
-			() => copyDirsSync(__exports, __cx, ["assets"]),
-			() => copyDirsSync(__exports, __ssg, ["dist"]),
-			() => {
-				if (fs.existsSync(path.join(__ssg, "dist"))) {
-					fs.renameSync(path.join(__ssg, "dist"), path.join(__ssg, "public"));
-				}
-			},
-			() => moveDirsSync(__caches, __cx, ["apiCache", "store"]),
-			() => moveDirsSync(__caches, __ssg, [".cache"]),
+			() => copyArtifacts(__components, __ssg, ["static"]),
+			() => copyArtifacts(__exports, __cx, arts.cx.archivables),
+			() => renameArtifact(path.join(__cx, "dist"), path.join(__ssg, "public")),
+			() => moveArtifacts(__caches, __cx, arts.cx.cacheables),
+			() => moveArtifacts(__caches, __ssg, arts.ssg.cacheables),
 		],
 	});
 
@@ -67,12 +72,7 @@ async function renderDomain(domain: string) {
 	});
 
 	await doLifeCycle("Meta", {
-		steps: [
-			() => generateBuildReport(),
-			() => RobotsService.writeFiles(domain),
-			() => generateSitemaps(),
-			() => pause("Meta LifeCycle"),
-		],
+		steps: [() => createRenderMetadata(domain)],
 	});
 
 	await doLifeCycle("Archive", {
@@ -80,25 +80,28 @@ async function renderDomain(domain: string) {
 			() => removeVirtualPagesFromStore(),
 			() => clearEmptyDirs(path.join(__cx, "dist")),
 			() =>
-				moveDirsSync(__cx, __exports, ["dist", "assets"], {
+				moveArtifacts(__cx, __exports, arts.cx.archivables, {
 					withBackup: true,
 				}),
-			() => moveDirsSync(__cx, __caches, ["apiCache", "store"]),
-			() => moveDirsSync(__ssg, __caches, [".cache"]),
+			() => moveArtifacts(__cx, __caches, arts.cx.cacheables),
+			() => moveArtifacts(__ssg, __caches, arts.ssg.cacheables),
 		],
 	});
 
-	await doLifeCycle("Clean", {
-		steps: [() => removeDirsSync(__ssg, ["static", "public", "dist"])],
+	await doLifeCycle("Close", {
+		steps: [() => removeArtifacts(arts.all.disposables)],
 	});
 
 	await doLifeCycle("HealthCheck", {
 		steps: [() => isValidRenderProcessOrThrow()],
 	});
+
+	deleteSentinelRenderFile();
 }
 
 async function runGatsbyAdapter(domains: Array<string>) {
 	printExporterLogo("gatsby");
+
 	for (const domain of domains) {
 		await renderDomain(domain);
 	}

package/exporter/artifacts/README.md

@@ -0,0 +1,28 @@
+# CX Artifacs
+
+## How to add an artifact.
+
+An artifact is a **full path** to a file or directory if it has a fixed
+location or only a **name** when it is going to be moved (archived/restored)
+between directories in the rendering process and therefore doesn't have a
+single location.
+
+Only the exporter knows where the artifacts are archived and restored, so the
+artifacts don't need to know anything other than their own location or name.
+
+If you're creating an adapter, its artifacts should go in a separate file (the same as `artifacts/cx.ts`) and export a default function that returns an `Artifacts`. Everything should be exported from `artifacts/index.ts`.
+
+**Artifacts have four categories:**
+
+- **initials**: Are directories (probably empty) that need to be created for their future use.
+
+- **archivables**: Are stored in `__exports` which is the one uploaded to the server as the final render and restored in `__cx` and `__ssg` to be reused in the render. Therefore, they don't have a single location and should be added only with the artifact name (directory/file)
+
+- **cacheables**: Are stored in `__cache` and restored in `__cx` and `__ssg` to be reused in each domain render. Therefore, they don't have a single location.
+
+- **disposables**: Are generated alwais in `__cx` and `__ssg` or fixed locations.
+  These artifacts are discarded (deleted) in each domain render. They are temporary directories and/or files.
+
+## Example
+
+Check `cx.ts` inside `./artifacts` directory to see how to add an artifact.

package/exporter/artifacts/cx.ts

@@ -0,0 +1,26 @@
+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, __caches } = paths;
+
+	return {
+		initials: [
+			__exports, // `/exports/<domain>`
+			__caches, // `__cx/caches/<domain>`
+		],
+		disposables: [
+			path.join(__cx, "store"),
+			path.join(__cx, "apiCache"),
+			path.join(__cx, "dist"),
+		],
+		cacheables: ["apiCache", "store"],
+		archivables: ["dist", "assets"],
+	};
+}
+
+export default getCxArtifacts;

package/exporter/artifacts/gatsby.ts

@@ -0,0 +1,28 @@
+import type { Artifacts, PlaceholderPath } from "../types/global";
+
+import path from "node:path";
+
+/**
+ * Returns the artifacts of Gatsby.
+ */
+function gatsbyArtifacts(paths: Record<PlaceholderPath, string>): Artifacts {
+	const { __ssg } = paths;
+
+	return {
+		disposables: [
+			path.join(__ssg, "public"),
+			path.join(__ssg, "static"),
+			path.join(__ssg, ".cache"),
+		],
+		cacheables: [".cache"],
+
+		// Gatsby does not have an initials directories to be created.
+		initials: [],
+
+		// Gatsby does not have any archivable artifacts. The output of Gatsby
+		// is moved to the Griddo `dist` artifacts.
+		archivables: [],
+	};
+}
+
+export default gatsbyArtifacts;

package/exporter/artifacts/index.ts

@@ -0,0 +1,30 @@
+import type { Adapters } from "../adapters";
+import type { PlaceholderPath } from "../types/global";
+
+import getCxArtifacts from "./cx";
+import getGatsbyArtifacts from "./gatsby";
+
+/**
+ * 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.
+ */
+function getArtifacts(
+	adapter: Adapters,
+	options: {
+		cxPaths: Record<PlaceholderPath, string>;
+	},
+) {
+	const { cxPaths } = options;
+	const ssgArtifacts = {
+		gatsby: getGatsbyArtifacts(cxPaths),
+	};
+
+	return {
+		cx: getCxArtifacts(cxPaths),
+		ssg: ssgArtifacts[adapter],
+	};
+}
+
+export { getArtifacts };

package/exporter/services/navigation.ts

@@ -1,9 +1,6 @@
 import type { Footer, Header } from "../types/navigation";
 import type { APIPageObject } from "../types/pages";
 
-/**
- * TODO: JSDoc
- */
 class NavigationService {
 	private _defaultHeaders: Record<string, Header>;
 	private _defaultFooters: Record<string, Footer>;
@@ -21,25 +18,16 @@ class NavigationService {
 		this._defaultFooters = {};
 	}
 
-	/**
-	 * TODO: JSDoc
-	 */
 	set navigations(navigations) {
 		this._navigations = navigations;
 		this._defaultFooters = this.getDefaultFooters();
 		this._defaultHeaders = this.getDefaultHeaders();
 	}
 
-	/**
-	 * TODO: JSDoc
-	 */
 	get navigations() {
 		return this._navigations;
 	}
 
-	/**
-	 * TODO: JSDoc
-	 */
 	getDefaultFooters() {
 		const safeFooters = [...this.navigations.footers];
 		const defaultFooters = safeFooters.filter(
@@ -54,9 +42,6 @@ class NavigationService {
 		return defaultFootersByLang;
 	}
 
-	/**
-	 * TODO: JSDoc
-	 */
 	getDefaultHeaders() {
 		const safeHeaders = [...this.navigations.headers];
 		const defaultHeaders = safeHeaders.filter(
@@ -71,9 +56,6 @@ class NavigationService {
 		return defaultHeadersByLang;
 	}
 
-	/**
-	 * TODO: JSDoc
-	 */
 	getRightLanguage(
 		list: Array<{
 			language: number;
@@ -100,23 +82,14 @@ class NavigationService {
 		return result ? { ...result } : null;
 	}
 
-	/**
-	 * TODO: JSDoc
-	 */
 	getPageHeader(id: number, language: number) {
 		return this.getRightLanguage(this.navigations.headers, id, language);
 	}
 
-	/**
-	 * TODO: JSDoc
-	 */
 	getPageFooter(id: number, language: number) {
 		return this.getRightLanguage(this.navigations.footers, id, language);
 	}
 
-	/**
-	 * TODO: JSDoc
-	 */
 	getPageNavigations(page: APIPageObject) {
 		const {
 			header: pageHeader,

package/exporter/services/robots.ts

@@ -9,66 +9,47 @@ import { getConfig } from "../utils/core-utils";
 
 const config = getConfig();
 
-/**
- * TODO: JSDoc
- */
-class RobotsService {
-	robots: Robots;
-	baseURL: string | undefined;
-	settings: Record<string, unknown>;
-	endpoint: string;
-
-	constructor() {
-		this.robots = [];
-		this.settings = {};
-		this.endpoint = endpoints.ROBOTS;
+async function getRobots() {
+	try {
+		const robots = await get<Robots>({ endpoint: endpoints.ROBOTS });
+
+		return (
+			robots
+				?.filter((r) => !!r.path)
+				.map(({ path, content }) => ({
+					path,
+					content: content || "User-agent: *\n\r\n\rAllow: /",
+				})) || []
+		);
+	} catch (e) {
+		console.warn(`Robots: ${(e as Error).message}`);
 	}
+}
 
-	/**
-	 * TODO: JSDoc
-	 */
-	private async getRobots() {
-		try {
-			const apiRobots = await get<Robots>({
-				endpoint: this.endpoint,
-			});
-			this.robots =
-				apiRobots
-					?.filter((r) => !!r.path)
-					.map(({ path, content }) => ({
-						path,
-						content: content || "User-agent: *\n\r\n\rAllow: /",
-					})) || [];
-		} catch (e) {
-			console.warn(`${this.constructor.name}: ${(e as Error).message}`);
-		}
-	}
+async function writeRobots(domain: string) {
+	const { __cx } = config.paths(domain);
+	const distDirectory = path.join(__cx, "dist");
 
-	/**
-	 * Write robots.txt files for the current rendering domain.
-	 */
-	async writeFiles(domain: string) {
-		const { __cx } = config.paths(domain);
-		const distDirectory = path.join(__cx, "dist");
+	const robots = await getRobots();
 
-		await this.getRobots();
+	if (!robots) {
+		console.log(`Robots not found for ${domain}`);
+		return;
+	}
 
-		const robot = this.robots.find(({ path }) => path === `/${domain}`);
+	const robot = robots.find(({ path }) => path === `/${domain}`);
 
-		if (!robot) {
-			console.log(`Robots not found for ${domain}`);
-			return;
-		}
+	if (!robot) {
+		console.log(`Robots not found for ${domain}`);
+		return;
+	}
 
-		if (fs.existsSync(distDirectory)) {
-			const fileLocation = path.join(distDirectory, "robots.txt");
-			fs.writeFileSync(fileLocation, robot?.content);
-		} else {
-			console.log(`${distDirectory} not found`);
-		}
+	if (fs.existsSync(distDirectory)) {
+		const fileLocation = path.join(distDirectory, "robots.txt");
+		fs.writeFileSync(fileLocation, robot?.content);
+	} else {
+		console.log(`${distDirectory} not found`);
 	}
 }
 
-const robotsService = new RobotsService();
-
-export { robotsService as RobotsService };
+export { writeRobots };

package/exporter/services/sites.ts

@@ -45,9 +45,6 @@ async function getSiteInfo(id: number, cacheKey = "") {
 	});
 }
 
-/**
- * TODO: JSDoc
- */
 async function getSiteLanguages(id: number, cacheKey = "") {
 	const [prefix, suffix] = endpoints.LANGUAGES;
 
@@ -57,9 +54,6 @@ async function getSiteLanguages(id: number, cacheKey = "") {
 	});
 }
 
-/**
- * TODO: JSDoc
- */
 async function startSiteRender(id: number) {
 	const [prefix, suffix] = endpoints.BUILD_START;
 
@@ -80,15 +74,12 @@ async function endSiteRender(id: number, body: EndSiteRenderBody) {
 	});
 }
 
-/**
- * TODO: JSDoc
- */
 async function getDistributorData(
 	page: Core.Page,
 	body: DistributorBody,
 	cacheKey: string,
 	dataSiteId?: number,
-	dataLangID?: number
+	dataLangID?: number,
 ) {
 	const [prefix, suffix] = endpoints.GET_REFERENCE_FIELD_DATA;
 	const site = dataSiteId || page.site;
@@ -102,9 +93,6 @@ async function getDistributorData(
 	});
 }
 
-/**
- * TODO: JSDoc
- */
 async function getSitemap(id: number) {
 	const [prefix, suffix] = endpoints.GET_SITEMAP;
 
@@ -113,9 +101,6 @@ async function getSitemap(id: number) {
 	});
 }
 
-/**
- * TODO: JSDoc
- */
 async function getSiteSocials(id: number, cacheKey = "") {
 	const [prefix, suffix] = endpoints.SOCIALS;
 

package/exporter/types/api.ts

@@ -174,7 +174,6 @@ export type APIResponses =
 	| PostSearchInfoResponse
 	| PostEmbeddingsResponse;
 
-// TODO: JSDoc
 export interface ShowApiErrorOptions {
 	callInfo: {
 		endpoint?: string;