@griddo/cx 1.75.180 → 1.75.182

package/gatsby-node.ts

@@ -30,12 +30,16 @@ const GRIDDO_STORE_MODE = (process.env.GRIDDO_STORE_MODE ||
 
 // Consts
 const storeDirPath = path.resolve(__dirname, "./.store/");
+const isMonorepo = !isComponentLibraryEnv;
 
 // -----------------------------------------------------------------------------
 // onPreInit
 // -----------------------------------------------------------------------------
 export const onPreInit = async () => {
-	splash();
+	if (isMonorepo) {
+		splash();
+	}
+
 	initCache();
 	prepareStaticFolder();
 	StoreService.init(storeDirPath, { mode: GRIDDO_STORE_MODE });

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "1.75.180",
+	"version": "1.75.182",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -37,7 +37,7 @@
 		"@babel/preset-env": "^7.14.5",
 		"@babel/preset-react": "^7.14.5",
 		"@babel/preset-typescript": "^7.16.5",
-		"@griddo/core": "^1.75.180",
+		"@griddo/core": "^1.75.182",
 		"@svgr/webpack": "^5.5.0",
 		"babel-loader": "^8.0.6",
 		"babel-plugin-styled-components": "^1.10.7",
@@ -69,7 +69,7 @@
 		"react-helmet": "^6.0.0"
 	},
 	"devDependencies": {
-		"@griddo/eslint-config-back": "^1.75.180",
+		"@griddo/eslint-config-back": "^1.75.182",
 		"@types/babel__core": "^7.20.0",
 		"@types/babel__preset-env": "^7.9.2",
 		"@types/csvtojson": "^2.0.0",
@@ -117,5 +117,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "840c30d9ae22d8749015b110a203a4103367a8f6"
+	"gitHead": "888dd2eeef46c60b7f0e9139198eb57bb7253b5f"
 }

package/scripts/griddo-exporter.ts

@@ -5,14 +5,19 @@
 
 require("dotenv").config();
 
+// External libraries
+import chalk from "chalk";
 import { execSync } from "child_process";
 import fs from "fs";
 import path from "path";
 import pkgDir from "pkg-dir";
 
+// Utils
 import { initCache } from "../src/utils/cache";
 import { findDomains } from "../src/utils/domains";
+import { exporterLogo as splash } from "../src/utils/shared";
 
+// Envs
 const artifactsArchivable = ["dist", "assets", "apiCache", ".cache"];
 const artifactsDisposable = ["public", ".store"];
 
@@ -25,6 +30,7 @@ const exportArchiveBasePath = path.resolve(execBasePath, "exports/sites");
 // Where we are going to run the export command
 const workingPath = pkgDir.sync(__dirname)!;
 
+// Types
 type Env = Record<string, unknown>;
 
 // -----------------------------------------------------------------------------
@@ -56,12 +62,10 @@ const getAssetPrefix = (domain: string) => {
 // -----------------------------------------------------------------------------
 // Loggers
 // -----------------------------------------------------------------------------
-const logError = (...message: Array<any>) => console.info("error", ...message);
-const logInfo = (...message: Array<any>) => console.info("info", ...message);
-const logSuccess = (...message: Array<any>) =>
-	console.info("success", ...message);
-const logWarning = (...message: Array<any>) =>
-	console.info("warning", ...message);
+const logError = (...message: Array<any>) => console.log(...message);
+const logInfo = (...message: Array<any>) => console.log(...message);
+const logSuccess = (...message: Array<any>) => console.log(...message);
+const logWarning = (...message: Array<any>) => console.log(...message);
 
 // -----------------------------------------------------------------------------
 // Main Stuff
@@ -75,14 +79,13 @@ const domainExport = async (domain: string) => {
 };
 
 const launchExports = async () => {
-	logInfo("Griddo Exporter");
-
+	splash();
 	initCache();
 
 	const domains = await findDomains();
 
 	for (const domain of domains) {
-		logInfo(`Exporting domain ${domain}`);
+		logInfo(`️🚢 Exporting domain ${chalk.underline(domain)}`);
 		await domainExport(domain);
 	}
 };
@@ -98,7 +101,7 @@ const getDomainRunner = (domain: string) => {
 	});
 
 	const init = () => {
-		logInfo(`Initializing ${domain} exporter...`);
+		logInfo(`🚀 Initializing ${chalk.underline(domain)} exporter`);
 
 		cleanDirtyArtifactPaths();
 		createBaseExportPaths();
@@ -129,7 +132,7 @@ const getDomainRunner = (domain: string) => {
 			const { currentExportWorkingPath } = getArtifactPaths(artifact);
 
 			if (fs.existsSync(currentExportWorkingPath)) {
-				logWarning(`Deleting dirty ${currentExportWorkingPath}...`);
+				logWarning(`🧹 Cleanup dirty ${chalk.gray(currentExportWorkingPath)}`);
 				run(`rm -rf ${currentExportWorkingPath}`);
 			}
 		}
@@ -139,7 +142,7 @@ const getDomainRunner = (domain: string) => {
 		const { domainExportArchiveBasePath } = getArtifactPaths();
 
 		if (!fs.existsSync(domainExportArchiveBasePath)) {
-			logInfo(`Creating ${domainExportArchiveBasePath}...`);
+			logInfo(`✨ Creating ${domainExportArchiveBasePath}`);
 			run(`mkdir -p ${domainExportArchiveBasePath}`);
 		}
 	};
@@ -149,7 +152,9 @@ const getDomainRunner = (domain: string) => {
 			getArtifactPaths(artifact);
 
 		logInfo(
-			`Moving files from ${currentExportWorkingPath} to ${currentExportArchivePath}...`
+			`🚚 Moving files from ${chalk.gray(
+				currentExportWorkingPath
+			)} to ${chalk.gray(currentExportArchivePath)}`
 		);
 		run(`mv ${currentExportWorkingPath} ${currentExportArchivePath}`);
 	};
@@ -161,7 +166,7 @@ const getDomainRunner = (domain: string) => {
 
 			if (!fs.existsSync(currentExportWorkingPath)) {
 				logError(
-					"Source directory has not been created:",
+					"📁 Source directory has not been created:",
 					currentExportWorkingPath
 				);
 				continue;
@@ -173,7 +178,7 @@ const getDomainRunner = (domain: string) => {
 				deleteArtifactBackup(artifact);
 			} catch (error) {
 				logError(
-					`Error moving files to ${currentExportArchivePath}`,
+					`🚚 Error moving files to ${currentExportArchivePath}`,
 					error.message
 				);
 				restoreArtifactBackup(artifact);
@@ -188,7 +193,7 @@ const getDomainRunner = (domain: string) => {
 				getArtifactPaths(artifact);
 
 			if (fs.existsSync(currentExportArchivePath)) {
-				logWarning(`Restaurando ${currentExportArchivePath}...`);
+				logWarning(`️♻️  Restoring ${chalk.gray(currentExportArchivePath)}`);
 				run(`cp -R ${currentExportArchivePath} ${currentExportWorkingPath}`);
 			}
 		}
@@ -201,7 +206,7 @@ const getDomainRunner = (domain: string) => {
 			getArtifactPaths(artifact);
 
 		if (fs.existsSync(currentExportArchivePath)) {
-			logInfo(`Creando backup de ${currentExportArchivePath}...`);
+			logInfo(`💿 Creating backup of ${chalk.gray(currentExportArchivePath)}`);
 			run(`mv ${currentExportArchivePath} ${currentExportBackupPath}`);
 		}
 	};
@@ -211,7 +216,9 @@ const getDomainRunner = (domain: string) => {
 			getArtifactPaths(artifact);
 
 		if (fs.existsSync(currentExportBackupPath)) {
-			logWarning(`Restaurando ${currentExportArchivePath}...`);
+			logWarning(
+				`️♻️  Restoring backup ${chalk.gray(currentExportArchivePath)}`
+			);
 			run(`mv ${currentExportBackupPath} ${currentExportArchivePath}`);
 		}
 	};
@@ -220,23 +227,17 @@ const getDomainRunner = (domain: string) => {
 		const { currentExportArchivePath, currentExportBackupPath } =
 			getArtifactPaths(artifact);
 
-		logInfo(`Eliminando backup de ${currentExportArchivePath}...`);
+		logWarning(`️❌ Removing backup ${chalk.gray(currentExportArchivePath)}`);
 		run(`rm -rf ${currentExportBackupPath}`);
 	};
 
 	const runExporter = () => {
-		console.log(
-			"\n",
-			"****************************<GATSBY>*********************",
-			"\n"
-		);
+		console.log(`\n${chalk.black(chalk.bgGreen(" Gatsby (start) "))}\n`);
+
 		run("yarn export");
 		logSuccess("Your sites have been exported correctly");
-		console.log(
-			"\n",
-			"****************************</GATSBY>*********************",
-			"\n"
-		);
+
+		console.log(`\n${chalk.black(chalk.bgGreen(" Gatsby (end) "))}\n`);
 
 		removeDisposableArtifacts();
 	};
@@ -247,7 +248,9 @@ const getDomainRunner = (domain: string) => {
 		const { currentExportWorkingPath: publicPath } = getArtifactPaths("public");
 
 		if (fs.existsSync(distPath)) {
-			logWarning(`Moviendo ${distPath} a ${publicPath}...`);
+			logWarning(
+				`🚚 Moving ${chalk.gray(distPath)} to ${chalk.gray(publicPath)}`
+			);
 			run(`mv ${distPath} ${publicPath}`);
 		}
 	};
@@ -259,7 +262,7 @@ const getDomainRunner = (domain: string) => {
 		const { currentExportWorkingPath: distPath } = getArtifactPaths("dist");
 
 		if (fs.existsSync(publicPath)) {
-			logWarning(`Moviendo ${publicPath} a ${distPath}...`);
+			logWarning(`🚚 Moving ${publicPath} to ${distPath}`);
 			run(`mv ${publicPath} ${distPath}`);
 		}
 	};
@@ -270,7 +273,7 @@ const getDomainRunner = (domain: string) => {
 				getArtifactPaths(artifact);
 
 			if (fs.existsSync(artifactPath)) {
-				logWarning(`Borrando ${artifactPath}...`);
+				logWarning(`❌ Removing ${chalk.gray(artifactPath)}`);
 				run(`rm -rf ${artifactPath}`);
 			}
 		}
@@ -297,6 +300,6 @@ const getDomainRunner = (domain: string) => {
 console.clear();
 
 launchExports().catch((err) => {
-	console.error("ERROR", err?.stdout?.toString() || err);
+	console.error("❌ ERROR", err?.stdout?.toString() || err);
 	process.exit(1);
 });

package/src/services/distributors.ts

@@ -18,7 +18,7 @@ class DistributorService {
 	 * @param data The ReferenceField props.
 	 * @returns The props for one of the ReferenceField mode.
 	 */
-	static getBody(data: Fields.Reference<unknown>) {
+	static getBody(data: Fields.Reference<unknown>, page: Core.Page) {
 		const {
 			order,
 			source,
@@ -28,23 +28,44 @@ class DistributorService {
 			filter,
 			fullRelations = false,
 			allLanguages = false,
+			referenceId,
 		} = data;
 
-		return mode === "auto"
-			? {
-					mode,
-					order,
-					source,
-					quantity,
-					filter,
-					fullRelations,
-					allLanguages,
-			  }
-			: {
-					mode,
-					fixed,
-					fullRelations,
-			  };
+		if (mode === "auto") {
+			return {
+				mode,
+				order,
+				source,
+				quantity,
+				filter,
+				fullRelations,
+				allLanguages,
+			};
+		}
+
+		if (mode === "manual") {
+			return {
+				mode,
+				fixed,
+				fullRelations,
+			};
+		}
+
+		if (mode === "navigation") {
+			return {
+				mode,
+				order,
+				quantity,
+				fullRelations,
+				referenceId: referenceId || page?.structuredDataContent?.id,
+			};
+		}
+
+		console.log(
+			`ERROR: Distribuidor mode: ${mode} is not recognized on page ${page?.id}.`
+		);
+
+		return data;
 	}
 
 	/**
@@ -72,7 +93,7 @@ class DistributorService {
 			return [];
 		}
 
-		const body = this.getBody(data);
+		const body = this.getBody(data, page);
 		const response = await SitesService.getDistributorData(page, body, cached);
 
 		return response;

package/src/services/sites.ts

@@ -3,8 +3,10 @@ import type { Core } from "@griddo/core";
 import type {
 	AllPagesResponse,
 	AllSitesReponse,
+	DistributorBody,
 	DistributorResponse,
 	EndPageInfoResponse,
+	EndSiteRenderBody,
 	LanguagesResponse,
 	PageResponse,
 	SitemapAPIResponse,
@@ -59,7 +61,6 @@ class SitesService {
 		} = ENDPOINTS;
 		const response = await get<PageResponse>({
 			endpoint: `${prefix}${id}${suffix}`,
-			body: undefined,
 			cached,
 		});
 
@@ -75,7 +76,6 @@ class SitesService {
 		} = ENDPOINTS;
 		const response = await get<Site>({
 			endpoint: `${prefix}${id}${suffix}`,
-			body: undefined,
 			cached,
 		});
 
@@ -91,7 +91,6 @@ class SitesService {
 		} = ENDPOINTS;
 		const response = await get<LanguagesResponse>({
 			endpoint: `${prefix}${id}${suffix}`,
-			body: undefined,
 			cached,
 		});
 
@@ -115,7 +114,7 @@ class SitesService {
 	/**
 	 * Send the end signal to API for a render site.
 	 */
-	static async endSiteRender(id: number, body: any) {
+	static async endSiteRender(id: number, body: EndSiteRenderBody) {
 		const {
 			BUILD_END: [prefix, suffix],
 		} = ENDPOINTS;
@@ -132,7 +131,7 @@ class SitesService {
 	 */
 	static async getDistributorData(
 		page: Core.Page,
-		body: Record<string, unknown>,
+		body: DistributorBody,
 		cached: boolean
 	) {
 		const {
@@ -172,7 +171,6 @@ class SitesService {
 		} = ENDPOINTS;
 		const response = await get<SocialsResponse>({
 			endpoint: `${prefix}${id}${suffix}`,
-			body: undefined,
 			cached,
 		});
 
@@ -188,7 +186,6 @@ class SitesService {
 		} = ENDPOINTS;
 		const response = await get<AllPagesResponse>({
 			endpoint: `${prefix}${id}${suffix}`,
-			body: undefined,
 			cached,
 		});
 

package/src/types/api.ts

@@ -1,11 +1,34 @@
 // Types
 import type { Core, Fields } from "@griddo/core";
-import { Domains, Robots, Settings } from "./global";
+import type { Domains, Robots, Settings } from "./global";
 import type { APIPageObject } from "./pages";
 import type { Site } from "./sites";
 
-/** Describes the props of the body object for the API */
-interface Body {
+/** EndSiteRender Body */
+export type EndSiteRenderBody = {
+	/** Site hashes to publish. */
+	publishHashes: Array<string>;
+	/** Current site hash. */
+	siteHash: string | null;
+	/**  Site hashes to unpublish. */
+	unpublishHashes: Array<string>;
+};
+
+/** Distributor Body */
+export interface DistributorBody {
+	mode: "auto" | "manual" | "navigation";
+	order?: string;
+	source?: Array<string>;
+	quantity?: number;
+	filter?: Array<any>;
+	fullRelations?: boolean;
+	allLanguages?: boolean;
+	fixed?: Array<number>;
+	referenceId?: number;
+}
+
+/** Describes the props of the body object for the get page */
+interface PageBody {
 	/** The title of the page. */
 	title?: string;
 	/** The description of the page. */
@@ -57,6 +80,12 @@ export type DistributorResponse = Fields.QueriedData<unknown>;
 /** Describes the response object returned by socials from Griddo. */
 export type SocialsResponse = Record<Core.SocialName, string>;
 
+/** Describes the response object returned by post search info post. */
+export type PostSearchInfoResponse = {
+	code: number;
+	message: string;
+};
+
 /** Describes the response object returned by a sitemap. */
 export interface SitemapAPIResponse {
 	/** Number of items */
@@ -82,7 +111,7 @@ interface APIRequest {
 	/** The URL of the API endpoint. */
 	endpoint: string;
 	/** The parameters to be sent in the request body. */
-	body?: Body;
+	body?: any;
 	/** Indicates whether to use the cache to get the response from the API. */
 	cached?: unknown;
 	/** Number of connection attempts (in case it fails on the first attempt). */
@@ -152,4 +181,5 @@ export type APIResponses =
 	| PageResponse
 	| EndPageInfoResponse
 	| DistributorResponse
+	| PostSearchInfoResponse
 	| AllPagesResponse;

package/src/types/global.ts

@@ -1,5 +1,6 @@
 // Types
 import type { Core, Fields } from "@griddo/core";
+import type { EndSiteRenderBody } from "./api";
 
 export type StoreMode = "memory" | "file";
 
@@ -55,17 +56,8 @@ export type Domains = Array<{
 	url: string;
 }>;
 
-export type StartPageInfo = {
-	/** Site hashes to publish. */
-	publishHashes: Array<string>;
-	/** Current site hash. */
-	siteHash: string | null;
-	/**  Site hashes to unpublish. */
-	unpublishHashes: Array<string>;
-};
-
 /** Describes the type of build process data object. */
-export type BuildProcessData = Record<string, StartPageInfo>;
+export type BuildProcessData = Record<string, EndSiteRenderBody>;
 
 export type Robot = { path: string; content: string };
 

package/src/utils/api.ts

@@ -35,7 +35,6 @@ const {
  * @example
  *	const response = await get<Site>({
  *		endpoint: "...",
- *		body: {},
  *		cached: true,
  *	});
  */

package/src/utils/searches.ts

@@ -1,4 +1,5 @@
 // Types
+import type { PostSearchInfoResponse } from "../types/api";
 import type { PostSearchInfoProps } from "../types/global";
 
 // API
@@ -25,7 +26,7 @@ async function postSearchInfo(props: PostSearchInfoProps) {
 		template,
 	} = props;
 
-	const response = await post({
+	const response = await post<PostSearchInfoResponse>({
 		endpoint: `${API_URL}/search`,
 		body: {
 			title,

package/src/utils/shared.ts

@@ -4,6 +4,7 @@ import dotenv from "dotenv";
 import fs from "fs-extra";
 import gradient from "gradient-string";
 import { APIResponses } from "../types/api";
+import { version } from "../../package.json";
 
 dotenv.config();
 
@@ -115,17 +116,40 @@ export function getSafeSiteId(response: APIResponses) {
  */
 function splash() {
 	const logo = `
+··
+··     ______  ______ _____ ______  ______   _____
+··    |  ____ |_____/   |   |     \\ |     \\ |     |
+··    |_____| |    \\_ __|__ |_____/ |_____/ |_____|
+··    ______  _     _ _____        ______  _______  ______
+··    |_____] |     |   |   |      |     \\ |______ |_____/
+··    |_____] |_____| __|__ |_____ |_____/ |______ |    \\_
+··
+··    ${version}
+`;
+
+	console.log(gradient.cristal(logo));
+}
 
-    ______  ______ _____ ______  ______   _____
-   |  ____ |_____/   |   |     \\ |     \\ |     |
-   |_____| |    \\_ __|__ |_____/ |_____/ |_____|
-   ______  _     _ _____        ______  _______  ______
-   |_____] |     |   |   |      |     \\ |______ |_____/
-   |_____] |_____| __|__ |_____ |_____/ |______ |    \\_
-
-   `;
-
-	console.log(gradient.mind(logo));
+function exporterLogo() {
+	const logo = `
+··
+··                                                               /
+··                                                             / //
+··       ______  ______ _____ ______  ______   _____           /· /
+··      |  ____ |_____/   |   |     \\ |     \\ |     |       / · /  /
+··      |_____| |    \\_ __|__ |_____/ |_____/ |_____|   · · /    / · /
+··      _______ _     _  _____   _____   ______ _______ _______  ______
+··      |______  \\___/  |_____] |     | |_____/    |    |______ |_____/
+··      |______ _/   \\_ |       |_____| |    \\_    |    |______ |    \\_
+··
+··      Griddo exporter orchestrator              /  / / ·  / /
+··      ${version}                                 /  / /· /
+··                                                  /· /
+··                                                /
+··
+`;
+
+	console.log(gradient.cristal(logo));
 }
 
-export { delay, logBox, logInfo, logPageSize, splash, walk };
+export { delay, exporterLogo, logBox, logInfo, logPageSize, splash, walk };

package/src/utils/sites.ts

@@ -6,7 +6,6 @@ import type { Site, SiteData } from "../types/sites";
 import chalk from "chalk";
 import fs from "fs-extra";
 import { parse } from "js2xmlparser";
-import pLimit from "p-limit";
 import path from "path";
 
 // Services