@griddo/cx 11.7.12-rc.3 → 11.7.12

package/exporter/index.ts

@@ -0,0 +1,82 @@
+/**
+ *
+ * Griddo CX library main export file.
+ *
+ * This file exports functions to use in both: adapters and SSG's frameworks.
+ * Turning CX basically in a javascript library.
+ *
+ * # React
+ * There is another export in the `/react` directory to use exclusivelly in
+ * the browser context where nodejs (path, fs, etc..) is not available.
+ *
+ * # Separate scripts.
+ * There are some separate .ts files as end-render.ts or reset-render.ts
+ * that are intended to be used by infra via npm script like `npm run
+ * end-render`
+ *
+ */
+
+import type { SocialsResponse } from "./types/api";
+import type {
+	AdditionalInfo,
+	Dimensions,
+	GriddoListPage,
+	GriddoMultiPage,
+	GriddoPageObject,
+	GriddoSinglePage,
+} from "./types/pages";
+import type { Site } from "./types/sites";
+
+import { endpoints, envs } from "./constants";
+import { apiRegister } from "./registers/index";
+import { FileRegister, MemoryRegister, Register } from "./services/register";
+import { insertAlert } from "./utils/alerts";
+import { getConfig, walk } from "./utils/core-utils";
+import {
+	componentLibraryPathAlias,
+	isComponentLibrary,
+	resolveComponentsPath,
+} from "./utils/instance";
+import {
+	buildLog,
+	debugLog,
+	infoLog,
+	pageSizeLog,
+	verboseLog,
+} from "./utils/loggin";
+import {
+	getBuildPagesFromCachedStore,
+	getBuildPagesFromStore,
+	getBuildPagesPath,
+} from "./utils/store";
+
+export {
+	apiRegister,
+	buildLog,
+	componentLibraryPathAlias,
+	debugLog,
+	endpoints,
+	envs,
+	FileRegister,
+	getBuildPagesFromCachedStore,
+	getBuildPagesFromStore,
+	getBuildPagesPath,
+	getConfig,
+	infoLog,
+	insertAlert,
+	isComponentLibrary,
+	MemoryRegister,
+	pageSizeLog,
+	Register,
+	resolveComponentsPath,
+	verboseLog,
+	walk,
+	type AdditionalInfo,
+	type Dimensions,
+	type GriddoListPage,
+	type GriddoMultiPage,
+	type GriddoPageObject,
+	type GriddoSinglePage,
+	type Site,
+	type SocialsResponse,
+};

package/{react → exporter/react}/Favicon/index.tsx

@@ -1,3 +1,5 @@
+import * as React from "react";
+
 import { formatImage } from "./utils";
 
 function Favicon({ url }: { url: string | undefined }) {
@@ -24,7 +26,11 @@ function Favicon({ url }: { url: string | undefined }) {
 				sizes="180x180"
 				href={formatImage(url, { width: 180, height: 180, format: "png" })}
 			/>
-			<link rel="icon" type="image/svg+xml" href={formatImage(url, { format: "svg" })} />
+			<link
+				rel="icon"
+				type="image/svg+xml"
+				href={formatImage(url, { format: "svg" })}
+			/>
 		</>
 	);
 }

package/{react → exporter/react}/GriddoIntegrations/index.tsx

@@ -1,13 +1,12 @@
+import type { Dimensions } from "../../types/pages";
 import type { Core } from "@griddo/core";
-import type { Dimensions } from "../../exporter/types/pages";
-
-import * as React from "react";
 
 import { generateAutomaticDimensions } from "@griddo-instance";
+import parse from "html-react-parser";
+import * as React from "react";
 
 import {
 	composeAnalytics,
-	extractScriptContent,
 	filterBodyIntegrationFromPosition,
 	filterHeadIntegrations,
 } from "./utils";
@@ -57,7 +56,12 @@ function GriddoIntegrations(props: GriddoIntegrationsProps) {
 	// @shame!
 	// El fix sería llamar a `composeAnalytics()` solo si `pageInfo` existe.
 	const { analyticsScript, analyticsDimensions } = pageInfo
-		? composeAnalytics(siteScript, dimensions, pageInfo, generateAutomaticDimensions)
+		? composeAnalytics(
+				siteScript,
+				dimensions,
+				pageInfo,
+				generateAutomaticDimensions,
+			)
 		: { analyticsDimensions: null, analyticsScript: null };
 
 	// GTAG WITH UA
@@ -66,13 +70,9 @@ function GriddoIntegrations(props: GriddoIntegrationsProps) {
 			`https://www.googletagmanager.com/gtag/js?id=${analyticsScript}`) ||
 		null;
 
-	const siteScriptContent = extractScriptContent(siteScript);
-
 	return (
 		<>
 			{integrationsOrdered?.map((integration, key) => {
-				const integrationScriptContent = extractScriptContent(integration.content);
-
 				/* Data Layer */
 				if (integration.type === "datalayer") {
 					return (
@@ -88,19 +88,25 @@ function GriddoIntegrations(props: GriddoIntegrationsProps) {
 				if (integration.type === "analytics") {
 					// If UA- is provided
 					if (analyticsWithUA) {
-						return <script key={key} src={analyticsWithUA} data-griddo-id={id} />;
+						return (
+							<script key={key} src={analyticsWithUA} data-griddo-id={id} />
+						);
 					}
 
-					return siteScriptContent ? (
-						<script key={key} dangerouslySetInnerHTML={{ __html: siteScriptContent }} />
-					) : null;
+					return (
+						<React.Fragment key={key}>
+							{siteScript && parse(siteScript, { trim: true })}
+						</React.Fragment>
+					);
 				}
 
 				/* Integration integration.type === "addon" */
 				if (integration.type === "addon") {
-					return integrationScriptContent ? (
-						<script key={key} dangerouslySetInnerHTML={{ __html: integrationScriptContent }} />
-					) : null;
+					return (
+						<React.Fragment key={key}>
+							{parse(integration.content, { trim: true })}
+						</React.Fragment>
+					);
 				}
 
 				return null;

package/{react → exporter/react}/GriddoIntegrations/utils.ts

@@ -1,5 +1,5 @@
+import type { Dimensions } from "../../types/pages";
 import type { Core } from "@griddo/core";
-import type { Dimensions } from "../../exporter/types/pages";
 
 /**
  * Return true if the argument is an object (not null)
@@ -70,13 +70,16 @@ function composeAnalytics(
 			};
 		};
 	},
-	generateAutomaticDimensions = (_page: Record<string, unknown>) => null,
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	generateAutomaticDimensions = (page: Record<string, unknown>) => null,
 ) {
 	const analyticsScript = siteScriptRaw ? siteScriptRaw.trim() : "";
 
 	// Las dimensiones o DataLayer
 	const dynamicValuePrefix = "__SCRIPT:";
-	const dimensionValues = isObject(dimensions?.values) ? dimensions?.values : {};
+	const dimensionValues = isObject(dimensions?.values)
+		? dimensions?.values
+		: {};
 	const automaticDimensionValues = generateAutomaticDimensions
 		? generateAutomaticDimensions(page || {})
 		: {};
@@ -101,7 +104,9 @@ function composeAnalytics(
 		);
 	}
 
-	const analyticsDimensions = allDimensions.length ? `{${allDimensions.join(",")}}` : null;
+	const analyticsDimensions = allDimensions.length
+		? `{${allDimensions.join(",")}}`
+		: null;
 
 	return {
 		analyticsScript,
@@ -109,25 +114,8 @@ function composeAnalytics(
 	};
 }
 
-function extractScriptContent(rawInput?: unknown) {
-	if (typeof rawInput !== "string" || !rawInput) {
-		return null;
-	}
-
-	const trimmedInput = rawInput.trim();
-
-	if (!trimmedInput.startsWith("<script>") || !trimmedInput.endsWith("</script>")) {
-		return null;
-	}
-
-	const content = trimmedInput.replace(/<script>|<\/script>/g, "").trim();
-
-	return content || null;
-}
-
 export {
 	composeAnalytics,
-	extractScriptContent,
 	filterBodyIntegrationFromPosition,
 	filterHeadIntegrations,
 	filterPositionIntegrations,

package/exporter/react/index.tsx

@@ -0,0 +1,11 @@
+//
+// Griddo CX library react export file.
+// This file exports functions to use in the SSG's frameworks.
+//
+// import { ... } from "@griddo/cx/react";
+//
+
+import { Favicon } from "./Favicon";
+import { GriddoIntegrations } from "./GriddoIntegrations";
+
+export { Favicon, GriddoIntegrations };

package/exporter/registers/api.ts

@@ -0,0 +1,14 @@
+import { MemoryRegister, Register } from "../services/register";
+
+const entries = {
+	API_RESPONSE_TOO_BIG: {
+		title: "API response size is too large",
+		description:
+			"API response size is too large and may affect rendering performance",
+		entries: [],
+	},
+};
+
+const register = new Register(new MemoryRegister(entries));
+
+export default register;

package/exporter/registers/gatsby.ts

@@ -0,0 +1,14 @@
+import { MemoryRegister, Register } from "../services/register";
+
+const entries = {
+	GATSBY_PAGE_SIZE_TOO_BIG: {
+		title: "Gatsby JSON page size is too large",
+		description:
+			"The JSON of some Gatsby pages (page-data folder) are too large and may affect rendering performance",
+		entries: [],
+	},
+};
+
+const register = new Register(new MemoryRegister(entries));
+
+export default register;

package/exporter/registers/index.ts

@@ -0,0 +1,4 @@
+import apiRegister from "./api";
+import gatsbyRegister from "./gatsby";
+
+export { apiRegister, gatsbyRegister };

package/exporter/services/auth.ts

@@ -1,9 +1,8 @@
 import type { AuthHeaders } from "../types/api";
 
-import { LOGIN } from "../constants/endpoints";
-import { GRIDDO_BOT_PASSWORD, GRIDDO_BOT_USER } from "../constants/envs";
-import { LoginError } from "../constants/errors";
-import { throwError } from "../utils/errors";
+import { endpoints, envs } from "../constants";
+import { throwError } from "../errors";
+import { LoginError } from "../errors/errors-data";
 
 /**
  * Service for authentication in the Griddo Private API
@@ -13,12 +12,12 @@ class AuthService {
 
 	async login() {
 		try {
-			const response = await fetch(LOGIN, {
+			const response = await fetch(endpoints.LOGIN, {
 				method: "POST",
 				headers: { "Content-Type": "application/json", Connection: "close" },
 				body: JSON.stringify({
-					username: GRIDDO_BOT_USER,
-					password: GRIDDO_BOT_PASSWORD,
+					username: envs.GRIDDO_BOT_USER,
+					password: envs.GRIDDO_BOT_PASSWORD,
 				}),
 			});
 

package/exporter/services/domains.ts

@@ -0,0 +1,16 @@
+import type { Domains } from "../types/global";
+
+import { endpoints } from "../constants";
+import { get } from "../utils/api";
+
+/**
+ * Get an array of available domain.
+ */
+async function getAllDomains() {
+	return get<Domains>({
+		endpoint: endpoints.DOMAINS,
+		useApiCacheDir: false,
+	});
+}
+
+export { getAllDomains };

package/exporter/services/navigation.ts

@@ -68,7 +68,9 @@ class NavigationService {
 		const rightLanguageItem = list.find(
 			(item) =>
 				item.language === language &&
-				item.navigationLanguages?.find((version) => version.navigationId === id),
+				item.navigationLanguages?.find(
+					(version) => version.navigationId === id,
+				),
 		);
 
 		const result = rightLanguageItem || list.find((item) => item.id === id);
@@ -85,9 +87,13 @@ class NavigationService {
 	}
 
 	getPageNavigations(page: APIPageObject) {
-		const { header: pageHeader, footer: pageFooter, language, template, templateConfig } = page;
-		const { templateType } = template;
-		const { defaultHeader, defaultFooter, templates } = templateConfig;
+		const {
+			header: pageHeader,
+			footer: pageFooter,
+			language,
+			template: { templateType },
+			templateConfig: { defaultHeader, defaultFooter, templates },
+		} = page;
 
 		// The navigations would be:
 		// - The one with the page or ...

package/exporter/services/reference-fields.ts

@@ -1,9 +1,9 @@
-import type { Core, Fields } from "@griddo/core";
 import type { FetchDataProps } from "../types/global";
 import type { APIPageObject } from "../types/pages";
+import type { Core, Fields } from "@griddo/core";
 
-import { boxLog } from "../utils/loggin";
 import { getReferenceFieldSiteData } from "./sites";
+import { boxLog } from "../utils/loggin";
 
 /**
  * Get the body data from a ReferenceField.
@@ -54,7 +54,9 @@ function getBody(data: Fields.Reference<unknown>, page: Core.Page) {
 		};
 	}
 
-	console.log(`Error: ReferenceField mode: ${mode} is not recognized on page ${page?.id}.`);
+	console.log(
+		`Error: ReferenceField mode: ${mode} is not recognized on page ${page?.id}.`,
+	);
 
 	return data;
 }
@@ -69,8 +71,11 @@ function getBody(data: Fields.Reference<unknown>, page: Core.Page) {
  * @returns The ContentType data.
  */
 async function fetchContentTypeData(props: FetchDataProps) {
-	const { page, component, cacheKey } = props;
-	const { data } = component;
+	const {
+		page,
+		component: { data },
+		cacheKey,
+	} = props;
 
 	// Distrubutor with `hasDistributorData: true` / `getStaticData: true` but without `data` prop
 	if (!data) {
@@ -104,7 +109,13 @@ async function fetchContentTypeData(props: FetchDataProps) {
 
 	const body = getBody(data, page);
 
-	const response = await getReferenceFieldSiteData(page, body, cacheKey, site, lang);
+	const response = await getReferenceFieldSiteData(
+		page,
+		body,
+		cacheKey,
+		site,
+		lang,
+	);
 
 	return response;
 }
@@ -154,7 +165,10 @@ async function getReferenceFieldData({
 					continue;
 				}
 
-				const _key = key as "hasDistributorData" | "queriedItems" | "getStaticData";
+				const _key = key as
+					| "hasDistributorData"
+					| "queriedItems"
+					| "getStaticData";
 				const component = templateChunk[_key] as unknown as {
 					data: Fields.Reference<unknown>;
 					queriedItems: Fields.QueriedData<unknown>;
@@ -167,7 +181,8 @@ async function getReferenceFieldData({
 					continue;
 				}
 
-				const componentHasRequestForData = component.hasDistributorData || component.getStaticData;
+				const componentHasRequestForData =
+					component.hasDistributorData || component.getStaticData;
 
 				if (componentHasRequestForData) {
 					component.queriedItems = await fetchContentTypeData({
@@ -195,7 +210,7 @@ async function getReferenceFieldData({
 	} catch (err) {
 		console.error(`Error in getReferenceFieldData ${err}`);
 
-		throw err;
+		process.exit(1);
 	}
 }
 

package/exporter/services/register.ts

@@ -0,0 +1,113 @@
+import fsx from "fs-extra";
+
+type Entry = Record<string, unknown>;
+
+type EntryData = {
+	title: string;
+	description: string;
+	entries: Array<Entry>;
+};
+
+type Entries = Record<string, EntryData>;
+
+interface RegisterBase<T extends Entries> {
+	insert(name: keyof T, entry: Entry): void;
+	get(name: keyof T): EntryData;
+	getAll(): T;
+}
+
+class MemoryRegister<T extends Entries> implements RegisterBase<T> {
+	entries: T;
+
+	constructor(entries: T) {
+		this.entries = entries;
+	}
+
+	insert(name: keyof T, entry: Entry) {
+		this.entries[name].entries.push(entry);
+	}
+
+	get(name: keyof T) {
+		return this.entries[name];
+	}
+
+	getAll() {
+		return this.entries;
+	}
+}
+
+class FileRegister<T extends Entries> implements RegisterBase<T> {
+	private readonly filePath: string;
+	entries: T;
+
+	constructor(filePath: string, entries: T) {
+		this.entries = entries;
+		this.filePath = filePath;
+		try {
+			fsx.writeJSONSync(this.filePath, this.entries);
+		} catch (e) {
+			console.error(`Error writing ${this.filePath}`, e);
+		}
+	}
+
+	private getCurrentEntries(): T {
+		return fsx.readJSONSync(this.filePath, "utf8") as T;
+	}
+
+	insert(name: keyof T, entry: Entry) {
+		try {
+			const currentEntries = this.getCurrentEntries();
+			currentEntries[name].entries.push(entry);
+			fsx.writeJSONSync(this.filePath, currentEntries);
+		} catch (e) {
+			console.error(e);
+		}
+	}
+
+	get(name: keyof T) {
+		try {
+			return fsx.readJSONSync(this.filePath, "utf8")[name] as EntryData;
+		} catch (e) {
+			console.error(e);
+			throw new Error(`Error reading ${this.filePath}`);
+		}
+	}
+
+	getAll() {
+		try {
+			return fsx.readJSONSync(this.filePath, "utf8") as T;
+		} catch (e) {
+			console.error(e);
+			throw new Error(`Error reading ${this.filePath}`);
+		}
+	}
+}
+
+class Register<T extends Entries> {
+	private strategy: RegisterBase<T>;
+
+	constructor(strategy: RegisterBase<T>) {
+		this.strategy = strategy;
+	}
+
+	insert<K extends keyof T>(name: K, entry: Entry) {
+		this.strategy.insert(name, entry);
+	}
+
+	get<K extends keyof T>(name: K) {
+		return this.strategy.get(name);
+	}
+
+	getAll() {
+		return this.strategy.getAll();
+	}
+}
+
+export {
+	FileRegister,
+	MemoryRegister,
+	Register,
+	type Entries,
+	type Entry,
+	type EntryData,
+};

package/exporter/services/robots.ts

@@ -1,14 +1,18 @@
 import type { Robots } from "../types/global";
 
-import fsp from "node:fs/promises";
+import fs from "node:fs";
 import path from "node:path";
 
-import { ROBOTS } from "../constants/endpoints";
+import { endpoints } from "../constants";
 import { get } from "../utils/api";
-import { pathExists } from "../utils/folders";
+import { getConfig } from "../utils/core-utils";
 import { verboseLog } from "../utils/loggin";
-import { getRenderPathsFromDB } from "../utils/render";
 
+const config = getConfig();
+
+/**
+ * TODO: JSDoc
+ */
 class RobotsService {
 	robots: Robots;
 	settings: Record<string, unknown>;
@@ -18,9 +22,12 @@ class RobotsService {
 		this.settings = {};
 	}
 
+	/**
+	 * TODO: JSDoc
+	 */
 	private async getRobots() {
 		try {
-			const apiRobots = await get<Robots>({ endpoint: ROBOTS });
+			const apiRobots = await get<Robots>({ endpoint: endpoints.ROBOTS });
 			this.robots =
 				apiRobots
 					?.filter((r) => !!r.path)
@@ -37,8 +44,8 @@ class RobotsService {
 	 * Write robots.txt files for the domain.
 	 */
 	async writeFiles(domain: string) {
-		const { __root } = await getRenderPathsFromDB({ domain });
-		const distDirectory = path.join(__root, "dist");
+		const { __cx } = config.paths(domain);
+		const distDirectory = path.join(__cx, "dist");
 
 		await this.getRobots();
 
@@ -49,9 +56,9 @@ class RobotsService {
 			return;
 		}
 
-		if (await pathExists(distDirectory)) {
+		if (fs.existsSync(distDirectory)) {
 			const fileLocation = path.join(distDirectory, "robots.txt");
-			await fsp.writeFile(fileLocation, robot?.content);
+			fs.writeFileSync(fileLocation, robot?.content);
 			verboseLog(`wrote robots.txt to ${fileLocation}`);
 		} else {
 			console.log(`${distDirectory} not found`);

package/exporter/services/settings.ts

@@ -0,0 +1,17 @@
+import type { Settings } from "../types/global";
+
+import { endpoints } from "../constants";
+import { get, post } from "../utils/api";
+
+async function getAllSettings() {
+	return get<Settings>({ endpoint: endpoints.SETTINGS });
+}
+
+async function resetRender() {
+	await post({
+		endpoint: endpoints.RESET_RENDER,
+		useApiCacheDir: false,
+	});
+}
+
+export { getAllSettings, resetRender };