@griddo/cx 10.6.5 → 10.6.7

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 {
@@ -89,7 +82,7 @@ type LifeCyclesNames =
 	| "Close"
 	| "__DEBUG__";
 
-type CXDir =
+type PlaceholderPath =
 	| "__exports"
 	| "__caches"
 	| "__cx"
@@ -102,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 {
@@ -120,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/core-utils.ts

@@ -13,7 +13,9 @@ 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();
 
@@ -212,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.
@@ -280,6 +281,7 @@ function pause(title: string) {
  * 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.
@@ -361,7 +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 {
+	createRenderMetadata,
 	delay,
 	doLifeCycle,
 	exporterCleanDisposableDirectories,

package/exporter/utils/folders.ts

@@ -4,6 +4,7 @@ import path from "node:path";
 import fsx, { MakeDirectoryOptions } from "fs-extra";
 
 import { getConfig } from "./core-utils";
+import { verboseLog } from "./loggin";
 import { getPageInStoreDir, removePagesFromStore } from "./store";
 
 const config = getConfig();
@@ -132,53 +133,6 @@ function copyDirsSync(
 	}
 }
 
-/**
- * Move artifacts between CX valid directories.
- *
- * @param src - Source directory.
- * @param dst - Destination directory.
- * @param dirs - Directories to move.
- * @param options - Options.
- */
-function moveDirsSync(
-	src: string,
-	dst: string,
-	dirs: Array<string>,
-	options?: { withBackup?: boolean; override?: boolean },
-) {
-	const { override, withBackup } = options || {};
-
-	for (const dir of dirs) {
-		const srcCompose = path.join(src, dir);
-		const dstCompose = path.join(dst, dir);
-
-		if (!fsx.existsSync(srcCompose)) {
-			continue;
-		}
-
-		if (withBackup) {
-			createBackup(dstCompose);
-		}
-
-		try {
-			// Clean destination
-			if (override && fsx.existsSync(dstCompose)) {
-				fs.rmSync(dstCompose, { recursive: true, force: true });
-			}
-			fs.renameSync(srcCompose, dstCompose);
-			if (withBackup) {
-				deleteBackup(dstCompose);
-			}
-		} catch (e) {
-			console.log("Move failed!");
-			if (withBackup) {
-				restoreBackup(dstCompose);
-				console.log("Backup has been restored.");
-			}
-		}
-	}
-}
-
 /**
  * Remove directories from `basePath` directory.
  *
@@ -293,12 +247,171 @@ function clearSitemapsFromDirs(initialFolder: string) {
 	removeXmlFiles(initialFolder);
 }
 
+/**
+ * Removes multiple artifact directories.
+ *
+ * @param artifacts - An array of artifact directory paths.
+ */
+function removeArtifacts(artifacts: Array<string>) {
+	for (const dir of artifacts) {
+		if (!dir) {
+			continue;
+		}
+
+		if (fsx.existsSync(dir)) {
+			fs.rmSync(dir, { recursive: true, force: true });
+			verboseLog(`removed directory: ${dir}`);
+		}
+	}
+}
+
+/**
+ * Creates multiple directories.
+ *
+ * @param dirs - An array of directory paths.
+ * @param options - Same option as `fs.mkdirSync()`
+ */
+function createArtifacts(dirs: Array<string>, options?: MakeDirectoryOptions) {
+	for (const dir of dirs) {
+		if (!fs.existsSync(dir)) {
+			fs.mkdirSync(dir, { recursive: true, ...options });
+			verboseLog(`create directory: ${dir}`);
+		}
+	}
+}
+
+/**
+ * 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.
+ */
+function copyArtifacts(
+	src: string,
+	dst: string,
+	dirs: Array<string>,
+	options = {
+		withBackup: false,
+	},
+) {
+	const { withBackup } = options;
+	for (const dir of dirs) {
+		const srcCompose = path.join(src, dir);
+		const dstCompose = path.join(dst, dir);
+
+		// The dir we want to copy, doesn't exist.
+		if (!fsx.existsSync(srcCompose)) {
+			console.log(
+				`(Maybe first render) Source directory does not exist: ${srcCompose}`,
+			);
+			continue;
+		}
+
+		// Create the backup
+		if (withBackup) {
+			createBackup(dstCompose);
+			verboseLog(`create backup: ${dstCompose}`);
+		}
+
+		// Copy directory
+		try {
+			// First clean destination
+			if (fsx.existsSync(dstCompose)) {
+				fs.rmSync(dstCompose, { recursive: true, force: true });
+				verboseLog(`clean destination: ${dstCompose}`);
+			}
+
+			// Then copy src to dst
+			fs.cpSync(srcCompose, dstCompose, {
+				recursive: true,
+				preserveTimestamps: true,
+			});
+			verboseLog(`copy: ${srcCompose} to ${dstCompose}`);
+
+			if (withBackup) {
+				deleteBackup(dstCompose);
+				verboseLog(`delete backup: ${dstCompose}`);
+			}
+		} catch (e) {
+			console.log("copy failed!");
+			if (withBackup) {
+				restoreBackup(dstCompose);
+				console.log("Backup has been restored.");
+			}
+		}
+	}
+}
+
+function renameArtifact(src: string, dst: string) {
+	if (fs.existsSync(src)) {
+		fs.renameSync(src, dst);
+		verboseLog(`rename ${src} to ${dst}`);
+	}
+}
+
+/**
+ * Move artifacts between cx-paths
+ *
+ * @param src - Source directory.
+ * @param dst - Destination directory.
+ * @param dirs - Directories to move.
+ * @param options - Options.
+ */
+function moveArtifacts(
+	src: string,
+	dst: string,
+	dirs: Array<string>,
+	options?: { withBackup?: boolean; override?: boolean },
+) {
+	const { override, withBackup } = options || {};
+
+	for (const dir of dirs) {
+		const srcCompose = path.join(src, dir);
+		const dstCompose = path.join(dst, dir);
+
+		if (!fsx.existsSync(srcCompose)) {
+			continue;
+		}
+
+		if (withBackup) {
+			createBackup(dstCompose);
+		}
+
+		try {
+			// Clean destination
+			if (override && fsx.existsSync(dstCompose)) {
+				fs.rmSync(dstCompose, { recursive: true, force: true });
+			}
+
+			fs.renameSync(srcCompose, dstCompose);
+			verboseLog(`moved: ${srcCompose} to ${dstCompose}`);
+
+			if (withBackup) {
+				deleteBackup(dstCompose);
+			}
+		} catch (e) {
+			if (withBackup) {
+				restoreBackup(dstCompose);
+				console.log("Backup has been restored.");
+			}
+
+			throw new Error(JSON.stringify(e));
+		}
+	}
+}
+
 export {
 	clearEmptyDirs,
 	clearSitemapsFromDirs,
+	copyArtifacts,
 	copyDirsSync,
+	createArtifacts,
 	createDirsSync,
-	moveDirsSync,
+	moveArtifacts,
+	removeArtifacts,
 	removeDirsSync,
 	removeVirtualPagesFromStore,
+	renameArtifact,
 };

package/exporter/utils/render.ts

@@ -12,13 +12,13 @@ const config = getConfig();
  * This file is used to track later if node_modules/@griddo/cx was cleaned by a
  * npm install from a deploy.
  */
-function createSentinelDomainRenderFile() {
+function createSentinelRenderFile() {
 	const { __cx } = config.paths();
 	const renderSentinelFile = path.join(__cx, ".render-sentinel");
 	fs.writeFileSync(renderSentinelFile, new Date().toISOString());
 }
 
-function deleteSentinelFile() {
+function deleteSentinelRenderFile() {
 	const { __cx } = config.paths();
 	const renderSentinelFile = path.join(__cx, ".render-sentinel");
 	fs.unlinkSync(renderSentinelFile);
@@ -33,7 +33,7 @@ function isValidRenderProcessOrThrow() {
 }
 
 function initRender() {
-	createSentinelDomainRenderFile();
+	createSentinelRenderFile();
 }
 
 function finishRender() {
@@ -44,6 +44,6 @@ export {
 	finishRender,
 	initRender,
 	isValidRenderProcessOrThrow,
-	createSentinelDomainRenderFile,
-	deleteSentinelFile,
+	createSentinelRenderFile,
+	deleteSentinelRenderFile,
 };

package/exporter/utils/store.ts

@@ -85,7 +85,6 @@ function getBuildPagesPath() {
 
 /**
  * Get the build metadata from the Store.
- * TODO: Refactorizar para leer un solo archivo: __metadata__.json
  */
 async function getBuildMetadata(): Promise<BuildMetaData> {
 	const { __cx } = config.paths();

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "10.6.5",
+	"version": "10.6.7",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -32,7 +32,7 @@
 		"complete-render": "node ./build/build-complete.js",
 		"reset-render": "node ./build/reset-render.js",
 		"// SSG": "",
-		"clean": "gatsby clean; rm -rf .cache public assets",
+		"clean": "gatsby clean; rm -rf assets caches store apiCache build .render-sentinel",
 		"gatsby-build": "gatsby telemetry --disable && gatsby build --prefix-paths",
 		"// LINTER": "",
 		"watch:typescript-lint": "tsc --noEmit --watch",
@@ -46,7 +46,7 @@
 		"@babel/preset-env": "^7.14.5",
 		"@babel/preset-react": "^7.14.5",
 		"@babel/preset-typescript": "^7.16.5",
-		"@griddo/core": "10.6.5",
+		"@griddo/core": "10.6.7",
 		"@svgr/webpack": "^5.5.0",
 		"babel-loader": "^8.0.6",
 		"babel-plugin-transform-runtime": "^6.23.0",
@@ -75,7 +75,7 @@
 		"@types/react-dom": "18.0.11",
 		"@types/react-helmet": "^6.1.6",
 		"@types/webpack": "^5.28.0",
-		"cheerio": "^1.0.0-rc.12",
+		"cheerio": "^0.22.0",
 		"eslint": "^8.0.0",
 		"eslint-plugin-node": "^11.1.0",
 		"eslint-plugin-react": "7.34.2",
@@ -114,5 +114,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "4a065853330bcae74912ddb0f0785af16b0e261a"
+	"gitHead": "7518a5fa486026aeeceee57d87fac1841e9e35a6"
 }

package/src/types.ts

@@ -41,7 +41,6 @@ interface HtmlProps {
 	preBodyComponents: React.ReactNode;
 }
 
-// TODO: JSDoc
 type GatsbyPageObject = {
 	matchPath?: string;
 	path: string;