@griddo/cx 11.7.5 → 11.7.6-rc.1

package/exporter/registers/api.ts

@@ -1,14 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

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

package/exporter/services/domains.ts

@@ -1,16 +0,0 @@
-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/register.ts

@@ -1,113 +0,0 @@
-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/settings.ts

@@ -1,17 +0,0 @@
-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 };

package/exporter/utils/alerts.ts

@@ -1,29 +0,0 @@
-import type { GriddoAlertRegisterProps } from "@griddo/core";
-
-import axios from "axios";
-
-import { endpoints } from "../constants";
-
-// Esta función está duplicada de core de manera intencionada por si esta recibe
-// cambios necesitados solo por CX.
-// Nota: Sí estamos reutilizando el type.
-async function insertAlert({
-	area,
-	description,
-	fullData,
-	instantNotification = false,
-	level,
-}: Omit<GriddoAlertRegisterProps, "publicApiUrl">) {
-	const url = endpoints.ALERT;
-	const body = { level, area, description, fullData, instantNotification };
-
-	try {
-		await axios.post(url, body, {
-			headers: { "Content-Type": "application/json", Connection: "close" },
-		});
-	} catch (error) {
-		console.error("Error creating Griddo alert:", error);
-	}
-}
-
-export { insertAlert };

package/exporter/utils/create-build-data.ts

@@ -1,17 +0,0 @@
-import { createAPICacheDir } from "./cache";
-import { sanitizeAPICacheDir } from "./core-utils";
-import { createStore } from "../services/store";
-
-/**
- * Download all data: sites, pages etc.. from the instance private Griddo API.
- * Then you can use the generator funcion `getBuildPagesFromStore()` to get the pages and
- * `getBuildMetadata()` to get build and sites metadata as objects. Both from
- * exporter utils sites dir.
- */
-async function createDomainRenderData(domain: string) {
-	createAPICacheDir();
-	await createStore(domain);
-	sanitizeAPICacheDir();
-}
-
-export { createDomainRenderData };

package/exporter/utils/health-checks.ts

@@ -1,64 +0,0 @@
-import { boxLog } from "./loggin";
-import { envs } from "../constants";
-
-const GRIDDO_ENVS_VARS: ReadonlyArray<string> = [];
-
-/**
- * Check if the environment is secure to launch a render.
- * If something fails then log an error message and exit from the process.
- * Otherwise just return true.
- */
-function checkRenderHealthOrExit() {
-	// Bypass the check using this env var, handy for local renders.
-	if (envs.GRIDDO_SKIP_BUILD_CHECKS) {
-		console.info("Build health check skipped");
-
-		return true;
-	}
-
-	// Checklist
-	const envsVars = checkEnvsVars(GRIDDO_ENVS_VARS);
-
-	// Render is safe if...
-	const renderingIsSave = envsVars;
-
-	// The environment is suitable for a build-render
-	if (renderingIsSave) {
-		console.info("Build health check passed");
-
-		return true;
-	}
-
-	// Error
-	boxLog(
-		"Error. The environment is not suitable for a build.",
-		"Not valid environment",
-	);
-	process.exit(1);
-}
-
-/**
- * Check if a list of environments variables exist with any value.
- *
- * @todo Also check the value.
- * @param envs An array of environments variables
- * @returns exists with (1) if there are missing envs vars
- */
-function checkEnvsVars(envs: ReadonlyArray<string>) {
-	const missingEnvs = envs.filter((envName) => {
-		return !process.env[envName];
-	});
-
-	if (missingEnvs.length) {
-		const missingEnvsMsg = missingEnvs.join("\n");
-		console.error(
-			`Env check failed. These envs vars are missing: \n\n${missingEnvsMsg}`,
-		);
-
-		return false;
-	}
-
-	return true;
-}
-
-export { checkRenderHealthOrExit };

package/exporter/utils/searches.ts

@@ -1,179 +0,0 @@
-import type { PostSearchInfoResponse } from "../types/api";
-import type {
-	AIEmbeddingsResponse,
-	PostSearchInfoProps,
-} from "../types/global";
-
-import fs from "node:fs";
-import path from "node:path";
-
-import { post } from "./api";
-import { getConfig } from "./core-utils";
-import { getBuildPagesFromCachedStore } from "./store";
-import { endpoints } from "../constants";
-
-/**
- * Save in the BBDD the content of a page parsed without HTML tags.
- *
- * @param props Object with parts of the final page object to be saved in the BBDD.
- */
-async function postSearchInfo(props: PostSearchInfoProps) {
-	const {
-		title,
-		description,
-		image,
-		pageId,
-		languageId,
-		siteId,
-		url,
-		content,
-		template,
-	} = props;
-
-	const response = await post<PostSearchInfoResponse>({
-		endpoint: endpoints.SEARCH,
-		body: {
-			title,
-			description,
-			image,
-			pageId,
-			languageId,
-			siteId,
-			url,
-			template,
-			content: prepareHTMLContentForSearch(content),
-		},
-		useApiCacheDir: false,
-	});
-
-	return response;
-}
-
-/**
- * Remove the every cntent inside some HTML tags including them.
- *
- * @param content A string with the content.
- */
-function prepareHTMLContentForSearch(content: string) {
-	const noTagsContent = removeHTMLTags(
-		["meta", "link", "style", "script", "noscript", "nav", "header", "footer"],
-		content,
-	);
-	const plainTextContent = stripHTMLTags(noTagsContent);
-
-	return stripSpaces(plainTextContent);
-}
-
-/**
- * Removes (replacing with empty string) the content for the HTML tags and the tags themself from the content string.
- *
- * @param tags An array of HTML tags without the <>.
- * @param content The content string.
- */
-function removeHTMLTags(tags: Array<string>, content: string) {
-	let filteredContent = content;
-
-	for (const tag of tags) {
-		filteredContent = filteredContent
-			// eslint-disable-next-line no-useless-escape
-			.replace(new RegExp(`<${tag}.*?>.*?<\/${tag}>`, "gis"), " ")
-			.replace(new RegExp(`(<${tag}([^>]+)>)`, "gis"), " ");
-	}
-
-	return filteredContent;
-}
-
-/**
- * Remove every HTML tags from the content
- *
- * @param content The string to be processed.
- * @param replaceWith The string to replace the remove HTML tags.
- */
-function stripHTMLTags(content: string) {
-	return content.replace(/(<([^>]+)>)/gis, " ");
-}
-
-/**
- * Removes duplicate whitespaces
- *
- * @param str The string to remove white spaces
- *
- * @example
- * stripSpaces("   Lorem     ipsum  dolor ") // " Lorem ipsum dolor "
- */
-function stripSpaces(str: string) {
-	return str.replace(/\s+/g, " ");
-}
-
-/**
- * Function that search in the `/public` dir the content info of the pages and
- * send it to the search table in the ddbb using the API.
- */
-async function uploadRenderedSearchContentToAPI(
-	distDomainPath: string,
-	domain: string,
-) {
-	const config = getConfig();
-	const { __cache } = config.paths(domain);
-
-	// Extraemos el path de la carpeta store dentro de un dominio
-	const storeFolder = path.join(__cache, "store");
-
-	// Este caso sería que el dominio existe en la instancia pero no hay sites
-	// renderizardos bajo el mismo. Por lo que `store` no existe.
-	if (!fs.existsSync(storeFolder)) {
-		console.log(
-			`Skipping uploading content to the search endpoint for the domain ${domain}, it has not exported sites.`,
-		);
-		return;
-	}
-
-	// Obtenemos las páginas del store cacheado de un dominio
-	const storePages = getBuildPagesFromCachedStore(domain);
-
-	for await (const store of storePages) {
-		const {
-			context: { page, openGraph, pageMetadata },
-		} = store;
-
-		const { compose } = page.fullPath;
-
-		const contextPath = path.resolve(`${distDomainPath}/${compose}/index.html`);
-
-		const content = fs.readFileSync(contextPath).toString();
-
-		const pageObject: PostSearchInfoProps = {
-			siteId: page.site,
-			pageId: page.id,
-			// `pageMetadata.title` has already a fallback `metatitle ||
-			// pageTitle` so probably `title` never will be take the
-			// `openGraph?.title` value. Only when the `metatitle` and
-			// `pageTitle` are empty.
-			title: pageMetadata?.title || openGraph?.title,
-			languageId: page.language,
-			url: page.fullUrl,
-			template: page.template.templateType || page.templateId,
-			description: pageMetadata?.description || openGraph?.description,
-			image: openGraph.image,
-			content,
-		};
-
-		await postSearchInfo(pageObject);
-	}
-}
-
-async function startAIEmbeddings() {
-	try {
-		await post<AIEmbeddingsResponse>({
-			endpoint: endpoints.AI_EMBEDDINGS,
-			useApiCacheDir: false,
-		});
-	} catch (error) {
-		console.warn(
-			"There was an error with the ai embeddings",
-			(error as Error).message,
-		);
-	}
-}
-
-export { postSearchInfo, startAIEmbeddings, uploadRenderedSearchContentToAPI };

package/src/README.md

@@ -1,7 +0,0 @@
-# Griddo CX + Gatsby
-
-The `/src` dir and almost every file in the root dir is now 100% Gatsby related code along with the historical `/public`, `/dist`, `/apiCache`, `/store`, etc.. render dirs.
-
-Griddo CX code (the business logic) is now in `/exporter` dir.
-
-In the future, Griddo CX and Gatsby will split int their own packages dirs inside the mono-repo.

package/build/{types → exporter/types}/pages.d.ts

@@ -1,7 +1,7 @@
+import type { Core, Fields } from "@griddo/core";
 import type { SocialsResponse } from "./api";
 import type { Settings } from "./global";
 import type { Site } from "./sites";
-import type { Core, Fields } from "@griddo/core";
 export type APIPageObject = Core.Page & {
     id: number;
 } & {