@griddo/cx 1.75.193 → 1.75.196

package/src/utils/api.ts

@@ -1,4 +1,3 @@
-// Types
 import type {
 	APIRequest,
 	APIResponses,
@@ -6,19 +5,17 @@ import type {
 	GetAPI,
 	PostAPI,
 	PutAPI,
+	ShowApiErrorOptions,
 } from "../types/api";
+import type { Method } from "axios";
 
-// External libraries
-import axios, { Method } from "axios";
+import axios from "axios";
 import chalk from "chalk";
 import dotenv from "dotenv";
 
-// Services
-import { AuthService } from "../services/auth";
-
-// Utils
 import { getCache, saveCache } from "./cache";
 import { delay, getSafeSiteId, logInfo, msToSec } from "./shared";
+import { AuthService } from "../services/auth";
 
 dotenv.config();
 
@@ -32,7 +29,7 @@ const {
  *
  * @template T Response Type returned.
  * @returns {Promise<T>} A promise that is resolved with the data from the API response.
- * @todo Maybe remove the loggin responsability
+ *
  * @example
  *	const response = await requestAPI<Site>({
  *		endpoint: "...",
@@ -69,14 +66,13 @@ async function requestAPI<T extends APIResponses>(
 	} catch (e) {
 		const error = e as Error;
 
-		showApiError(
-			error,
-			{ endpoint, body, attempt },
-			error.response.status !== 404
-		);
+		showApiError(error, {
+			callInfo: { endpoint, body, attempt },
+			breakProcess: error.response.status !== 404,
+		});
 
 		if (error.response.status === 404) {
-			// @ts-expect-error
+			// @ts-expect-error page maybe will be 404
 			return null;
 		}
 
@@ -98,6 +94,12 @@ async function requestAPI<T extends APIResponses>(
 	}
 }
 
+/**
+ * Make a GET request to the Griddo API.
+ *
+ * @template T Response Type returned.
+ * @returns A promise that is resolved with the data from the API response.
+ */
 async function getApi<T extends APIResponses>(props: GetAPI) {
 	// Starts
 	const start = new Date();
@@ -117,6 +119,12 @@ async function getApi<T extends APIResponses>(props: GetAPI) {
 	return response;
 }
 
+/**
+ * Make a PUT request to the Griddo API.
+ *
+ * @template T Response Type returned.
+ * @returns A promise that is resolved with the data from the API response.
+ */
 async function putApi<T extends APIResponses>(props: PutAPI) {
 	// Starts
 	const start = new Date();
@@ -134,6 +142,12 @@ async function putApi<T extends APIResponses>(props: PutAPI) {
 	return response;
 }
 
+/**
+ * Make a POST request to the Griddo API.
+ *
+ * @template T Response Type returned.
+ * @returns A promise that is resolved with the data from the API response.
+ */
 async function postApi<T extends APIResponses>(props: PostAPI) {
 	// Starts
 	const start = new Date();
@@ -161,18 +175,9 @@ async function postApi<T extends APIResponses>(props: PostAPI) {
 /**
  * Shows an API error through the terminal.
  */
-function showApiError(
-	error: Error,
-	callInfo: {
-		endpoint?: string;
-		// TODO: Remove any's
-		body?: any;
-		headers?: any;
-		attempt?: number;
-	} = {},
-	breakProcess = true
-) {
+function showApiError(error: Error, options: ShowApiErrorOptions) {
 	const { response, message, stack } = error;
+	const { breakProcess, callInfo } = options;
 	const { status, statusText, data } = response || {};
 	const callInfoArray = [];
 

package/src/utils/cache.ts

@@ -1,13 +1,11 @@
-// Types
 import type { Petition } from "../types/global";
 import type { HashSites, SiteHash } from "../types/sites";
 
-// External libraries
 import crypto from "crypto";
 import fs from "fs";
 import path from "path";
 
-// Constants
+// Consts
 const API_CACHE_DIR_PATH = path.resolve(__dirname, "./../../apiCache");
 const SITE_HASH_FILENAME = `${API_CACHE_DIR_PATH}/siteHash.json`;
 
@@ -24,8 +22,8 @@ function initCache() {
 
 /**
  * Generate a filename with a hash using a Petition object
- * TODO: Merge with createSha256
  *
+ * @todo Merge with createSha256
  * @param petition An object
  */
 function generateFilenameWithHash(petition: Petition) {
@@ -37,8 +35,8 @@ function generateFilenameWithHash(petition: Petition) {
 
 /**
  * Generate a filename with a hash using a string.
- * TODO: Merge with generateFilenameWithHash
  *
+ * @todo Merge with generateFilenameWithHash
  * @param data A string to create a sha256 based on.
  */
 function createSha256(data: string) {
@@ -54,11 +52,11 @@ function createSha256(data: string) {
  * @param petition An object.
  * @param content Content to be saved.
  */
-const saveCache = <T>(petition: Petition, content: T) => {
+function saveCache<T>(petition: Petition, content: T) {
 	const stringContent =
 		typeof content === "string" ? content : JSON.stringify(content);
 	fs.writeFileSync(generateFilenameWithHash(petition), stringContent, "utf8");
-};
+}
 
 /**
  * Read a cache file and return it as an object

package/src/utils/domains.ts

@@ -1,7 +1,5 @@
-// Types
 import type { Domains } from "../types/global";
 
-// Services
 import { AuthService } from "../services/auth";
 import { DomainsService } from "../services/domains";
 

package/src/utils/folders.ts

@@ -1,11 +1,9 @@
-// Types
 import type { Site } from "../types/sites";
 
-// External libraries
-import fs from "fs-extra";
 import path from "path";
 
-// Utils
+import fs from "fs-extra";
+
 import { resolveComponentsPath } from "./instance";
 import { logInfo } from "./shared";
 
@@ -107,21 +105,6 @@ async function updateDist() {
 	}
 }
 
-/**
- * Copy the Griddo's `/dist` folder into the Griddo's `/public` folder.
- */
-async function prepareServe() {
-	const src = "./dist";
-	const dest = "./public";
-
-	try {
-		await fs.copy(src, dest);
-		logInfo("Public copied");
-	} catch (err) {
-		console.warn("error", err);
-	}
-}
-
 /**
  * Copy the instance's `/static` folder into the Gatsby's to take it into account for bundle.
  */
@@ -144,4 +127,4 @@ function prepareStaticFolder() {
 	}
 }
 
-export { deleteSites, updateDist, prepareServe, prepareStaticFolder };
+export { deleteSites, updateDist, prepareStaticFolder };

package/src/utils/gatsby.ts

@@ -0,0 +1,41 @@
+import type { GatsbyNode } from "gatsby";
+
+import { IS_COMPONENT_LIBRARY, PROJECT_ALIASES } from "./instance";
+
+// TODO: Use webpack types
+const onCreateWebpackConfig: GatsbyNode["onCreateWebpackConfig"] = ({
+	actions,
+	plugins,
+	loaders,
+	getConfig,
+}) => {
+	if (IS_COMPONENT_LIBRARY) {
+		const config = getConfig();
+		config.module.rules = [
+			// Omit the default rule where test === '\.jsx?$'
+			...config.module.rules.filter(
+				(rule: { test: string }) => String(rule.test) !== String(/\.jsx?$/)
+			),
+			// Recreate it with custom exclude filter
+			{
+				...loaders.js(),
+				test: /\.jsx?$/,
+				// Exclude all node_modules from transpilation, except for '@griddo/cx'
+				exclude: (modulePath: string) =>
+					/node_modules/.test(modulePath) && !/@griddo\/cx/.test(modulePath),
+			},
+		];
+		actions.replaceWebpackConfig(config);
+	}
+
+	// Add component-system aliases to Webpack's Resolve:
+	actions.setWebpackConfig({
+		resolve: {
+			fallback: { path: false },
+			alias: PROJECT_ALIASES,
+		},
+		plugins: [plugins.provide({ process: "process/browser", React: "react" })],
+	});
+};
+
+export { onCreateWebpackConfig };

package/src/utils/instance.ts

@@ -1,11 +1,11 @@
-// External libraries
-import findUp from "find-up";
 import path from "path";
+
+import findUp from "find-up";
 import pkgDir from "pkg-dir";
 
-// Envs
-const isComponentLibraryEnv = __dirname.includes("node_modules");
-const projectAliases = getComponentsLibAliases();
+// Consts
+const IS_COMPONENT_LIBRARY = __dirname.includes("node_modules");
+const PROJECT_ALIASES = getComponentsLibAliases();
 
 /**
  * Returns the instance or monorepo paths.
@@ -13,7 +13,7 @@ const projectAliases = getComponentsLibAliases();
  * @param customPath The path for the instance components
  */
 function resolveComponentsPath(customPath = "") {
-	return isComponentLibraryEnv
+	return IS_COMPONENT_LIBRARY
 		? path.resolve(pkgDir.sync(__dirname) as string, "../../../", customPath)
 		: path.resolve(
 				pkgDir.sync(__dirname) as string,
@@ -40,6 +40,7 @@ function getComponentsJSConfig() {
  * Get the instance webpack aliases
  */
 function getComponentsLibAliases() {
+	// eslint-disable-next-line @typescript-eslint/no-var-requires
 	const xsConfig = require(getComponentsJSConfig() as string);
 
 	return Object.keys(xsConfig?.compilerOptions?.paths).reduce(
@@ -65,7 +66,7 @@ function getComponentsLibAliases() {
 export {
 	getComponentsJSConfig,
 	getComponentsLibAliases,
-	isComponentLibraryEnv,
-	projectAliases,
+	IS_COMPONENT_LIBRARY,
+	PROJECT_ALIASES,
 	resolveComponentsPath,
 };

package/src/utils/pages.ts

@@ -1,5 +1,3 @@
-// Types
-import type { Core, Fields } from "@griddo/core";
 import type {
 	APIPageObject,
 	GatsbyPageObject,
@@ -10,15 +8,15 @@ import type {
 	PageAdditionalInfo,
 } from "../types/pages";
 import type { TemplateWithDistributor } from "../types/templates";
+import type { Core, Fields } from "@griddo/core";
 
-// External libraries
-import dotenv from "dotenv";
 import fs from "fs";
 import path from "path";
 
-// Utils
-import { formatImage } from "../components/utils";
+import dotenv from "dotenv";
+
 import { postSearchInfo } from "./searches";
+import { formatImage } from "../components/utils";
 
 dotenv.config();
 
@@ -28,7 +26,7 @@ const GRIDDO_SEARCH_FEATURE = !!JSON.parse(
 );
 const HAS_ASSET_PREFIX = !!process.env.GRIDDO_ASSET_PREFIX;
 
-// Constants
+// Consts
 const DEFAULT_ITEMS_PER_PAGE_FOR_LIST_TEMPLATES = 25;
 const COMPONENT = path.resolve(__dirname, "../../src/components/template.tsx");
 
@@ -328,7 +326,7 @@ function createGriddoMultiPages(
 			({ sectionSlug }: { sectionSlug: string }) => sectionSlug === "/"
 		)
 	) {
-		// @ts-expect-error
+		// @ts-expect-error ? ? ?
 		multiPageElements.push({});
 	}
 
@@ -384,7 +382,7 @@ function getMultiPageElements(page: TemplateWithDistributor) {
 		const getMultiPageComponent = (
 			// No puede ser Core.Page['template'] porque a medida que va bajando en
 			// el árbol ya no es la estructura de un template.
-			template: Record<string, any>,
+			template: Record<string, unknown>,
 			level = 0
 		) => {
 			// If it doesn't have a "template strcuture"
@@ -392,7 +390,11 @@ function getMultiPageElements(page: TemplateWithDistributor) {
 
 			// For each prop in the "template"
 			for (const key in template) {
-				const currentComponent = template[key];
+				const currentComponent = template[key] as {
+					component: string;
+					hasGriddoMultiPage: boolean;
+					elements: Array<Record<string, unknown>>;
+				};
 				const isValidComponent =
 					currentComponent || typeof currentComponent === "object";
 				const hasGriddoMultiPageProp = JSON.stringify(
@@ -415,7 +417,9 @@ function getMultiPageElements(page: TemplateWithDistributor) {
 			if (!level) resolve(null);
 		};
 
-		getMultiPageComponent([page]); // ==> En array para que también revise la propia template como objeto.
+		// `page` en un array para que también revise la propia template como objeto.
+		// @ts-expect-error remove the array
+		getMultiPageComponent([page]);
 	});
 
 	return multiPageElements as Promise<MultiPageElements>;
@@ -492,7 +496,6 @@ function getPaginatedPages(listTemplate: TemplateWithDistributor) {
  * addPageNumberToUrl("web.com", 3) // "web.com/3"
  * addPageNumberToUrl("web.com", 3, { addEndingSlash: true }) // "web.com/3/"
  */
-
 function addPageNumberToUrl(
 	url: string,
 	pageNumber: number,

package/src/utils/searches.ts

@@ -1,8 +1,6 @@
-// Types
 import type { PostSearchInfoResponse } from "../types/api";
 import type { PostSearchInfoProps } from "../types/global";
 
-// API
 import { post } from "./api";
 
 // Envs

package/src/utils/shared.ts

@@ -1,10 +1,11 @@
-// External libraries
 import chalk from "chalk";
 import dotenv from "dotenv";
 import fs from "fs-extra";
 import gradient from "gradient-string";
-import { APIResponses } from "../types/api";
+
 import { version } from "../../package.json";
+import { APIResponses } from "../types/api";
+import { Site } from "../types/sites";
 
 dotenv.config();
 
@@ -48,7 +49,7 @@ function logBox(str: string) {
 /**
  * Custom basic logging function controlled by a environment variable.
  *
- * @params str The string or strings separated by commans to be logged.
+ * @param str The string or strings separated by commans to be logged.
  */
 function logInfo(...str: Array<unknown>) {
 	if (GRIDDO_BUILD_LOGS) {
@@ -124,40 +125,61 @@ function measureFunctions(...funcs: Array<() => void>) {
 }
 
 /**
- * Print a f**king great Griddo builder logo.
+ * Remove props from an object
+ *
+ * @param obj The object
+ * @param props An array of props to be removed
+ */
+function removeProperties(obj: Record<string, unknown>, props: Array<string>) {
+	for (const key in obj) {
+		if (props.includes(key)) {
+			delete obj[key];
+		} else if (typeof obj[key] === "object") {
+			removeProperties(obj[key] as Record<string, unknown>, props);
+		}
+	}
+}
+
+/**
+ * Return a list of sites with their names and ids.
+ *
+ * @param sites An array of sites objects
+ */
+function siteList(sites: Array<Site>) {
+	return sites.map(({ name, id }) => `${name} (${id})`).join(", ");
+}
+
+/**
+ * Print a f**king great Griddo build domain logo.
  */
 function splash() {
 	const logo = `
-··
-··     ______  ______ _____ ______  ______   _____
-··    |  ____ |_____/   |   |     \\ |     \\ |     |
-··    |_____| |    \\_ __|__ |_____/ |_____/ |_____|
-··    ______  _     _ _____        ______  _______  ______
-··    |_____] |     |   |   |      |     \\ |______ |_____/
-··    |_____] |_____| __|__ |_____ |_____/ |______ |    \\_
-··
-··    ${version}
+ ___  _  _ _ _    ___  ___  ____ _  _ ____ _ __ _
+ |==] |__| | |___ |__> |__> [__] |\\/| |--| | | \\|
 `;
 
 	console.log(gradient.cristal(logo));
 }
 
+/**
+ * Print a f**king great Griddo builder logo.
+ */
 function exporterLogo() {
 	const logo = `
 ··
-··                                                               /
-··                                                             / //
-··       ______  ______ _____ ______  ______   _____           /· /
-··      |  ____ |_____/   |   |     \\ |     \\ |     |       / · /  /
-··      |_____| |    \\_ __|__ |_____/ |_____/ |_____|   · · /    / · /
+··
+··
+··       ______  ______ _____ ______  ______   _____
+··      |  ____ |_____/   |   |     \\ |     \\ |     |
+··      |_____| |    \\_ __|__ |_____/ |_____/ |_____|
 ··      _______ _     _  _____   _____   ______ _______ _______  ______
 ··      |______  \\___/  |_____] |     | |_____/    |    |______ |_____/
 ··      |______ _/   \\_ |       |_____| |    \\_    |    |______ |    \\_
 ··
-··      Griddo exporter orchestrator              /  / / ·  / /
-··      ${version}                                 /  / /· /
-··                                                  /· /
-··                                                /
+··      Griddo exporter orchestrator
+··      ${version}
+··
+··
 ··
 `;
 
@@ -171,6 +193,8 @@ export {
 	logInfo,
 	logPageSize,
 	measureFunctions,
+	removeProperties,
+	siteList,
 	splash,
 	walk,
 };

package/src/utils/sites.ts

@@ -1,21 +1,17 @@
-// Types
 import type { BuildProcessData } from "../types/global";
 import type { Site, SiteData } from "../types/sites";
 
-// External libraries
+import path from "path";
+
 import chalk from "chalk";
 import fs from "fs-extra";
 import { parse } from "js2xmlparser";
-import path from "path";
 
-// Services
+import { deleteSites } from "./folders";
+import { logInfo } from "./shared";
 import { AuthService } from "../services/auth";
 import { SitesService } from "../services/sites";
-
-// Utils
 import { AllPagesResponse } from "../types/api";
-import { deleteSites } from "./folders";
-import { logInfo } from "./shared";
 
 // Envs
 const API_URL = process.env.API_URL;
@@ -55,13 +51,12 @@ async function checkSites() {
 			const langResponse = await SitesService.getLanguages(site.id);
 
 			return (site.domains = langResponse.items
-				.filter((item) => {
-					return (
+				.filter(
+					(item) =>
 						item.domain &&
 						(!process.env.DOMAIN ||
 							item.domain.slug.indexOf(process.env.DOMAIN) > 0)
-					);
-				})
+				)
 				.map((item) => ({ [item.id]: `${item.domain.slug}${item.path}` })));
 		});
 
@@ -126,8 +121,8 @@ async function getSiteData(siteID: number, cached: boolean) {
 	const socials = await SitesService.getSocials(siteID, cached);
 	const siteLangsInfo = siteLangs.items;
 	const defaultLang = siteLangsInfo.find((lang) => lang.isDefault);
-	// eliminado para validar que efectivamente no rompe nada
-	// si el cambio es correcto, hay que eliminar las 7 líneas que contienen "sitePages"
+	// TODO: Eliminado para validar que efectivamente no rompe nada si el cambio
+	// es correcto, hay que eliminar las 7 líneas que contienen "sitePages":
 	// const sitePages = await SitesService.getPages(siteID, cached);
 	const sitePages: AllPagesResponse = [];
 
@@ -154,18 +149,36 @@ async function getSiteData(siteID: number, cached: boolean) {
 }
 
 /**
- * Send end render signal to the API for all pages.
+ * Save a file with the end of build process
  *
+ * @param filePathName The pathname for the file report
  * @param buildProcessData The whole build process data.
- * @param createdPages An array of pages ids.
  */
-async function setPagesRenderEnd(
-	buildProcessData: BuildProcessData,
-	createdPages: Array<number>
+async function generateBuildReport(
+	filePathName: string,
+	buildProcessData: BuildProcessData
 ) {
+	// Get the token
+	const authControl = await AuthService.login();
+
+	const buildSitesInfo = Object.keys(buildProcessData).map((siteID) => ({
+		...buildProcessData[siteID],
+		siteId: parseInt(siteID),
+	}));
+
+	const report = {
+		authControl,
+		sites: buildSitesInfo,
+	};
+
+	fs.writeFileSync(filePathName, JSON.stringify(report));
+
+	logInfo(`Build report saved for ${buildSitesInfo.length} site(s)`);
+
+	// API version
+	// TODO: Revemo when the file version is implemented.
 	const promises = Object.keys(buildProcessData).map(async (siteID) => {
 		const body = buildProcessData[siteID];
-
 		logInfo(`Deploying ending call to site ${siteID}:`);
 
 		return SitesService.endSiteRender(parseInt(siteID), body);
@@ -173,7 +186,7 @@ async function setPagesRenderEnd(
 
 	await Promise.all(promises);
 
-	logInfo(`Set pages as deployed. Total ${createdPages.length}`);
+	logInfo(`Build end signal sent for ${buildSitesInfo.length} site(s)`);
 }
 
 /**
@@ -273,7 +286,7 @@ function saveFile(filePath: string, content: string) {
 export {
 	checkSites,
 	unpublishSites,
-	setPagesRenderEnd,
+	generateBuildReport,
 	getSiteData,
 	generateSitemaps,
 };