@griddo/cx 11.7.10 → 11.7.12-rc.0

package/exporter/adapters/gatsby/utils.ts

@@ -1,161 +0,0 @@
-import { spawnSync } from "node:child_process";
-import path from "node:path";
-
-import fsx from "fs-extra";
-
-import { envs } from "../../constants";
-import { throwError } from "../../errors";
-import { ErrorInSSGBuildProcess } from "../../errors/errors-data";
-import { getConfig } from "../../utils/core-utils";
-import { verboseLog } from "../../utils/loggin";
-
-const config = getConfig();
-
-/**
- * Return the assetPrefix with the domain concatenated `assetPrefix/domain` only
- * if the domain is "pro-" **and** there is a env `GRIDDO_ASSET_PREFIX` with any
- * value different from `null`, `undefined` or `empty string`
- *
- * else...
- * - If assetPrefix or domain is falsy, returns ""
- * - If the domain is not "pro-", returns ""
- */
-function getGatsbyAssetPrefixWithDomain(domain: string) {
-	const { proDomain } = getConfig();
-
-	if (!envs.GRIDDO_ASSET_PREFIX || !domain) {
-		return "";
-	}
-
-	if (!domain.startsWith(proDomain)) {
-		return "";
-	}
-
-	const assetPrefixWithDomain = `${envs.GRIDDO_ASSET_PREFIX}/${domain}`;
-
-	verboseLog(
-		`Reading process.env.GRIDDO_ASSET_PREFIX, ${envs.GRIDDO_ASSET_PREFIX}`,
-	);
-	verboseLog(
-		`Setting the asset prefix with the domain concatenated, ${assetPrefixWithDomain}`,
-	);
-
-	return assetPrefixWithDomain;
-}
-
-/**
- * Spawn a new node process `yarn gatsby-build`
- * @note This proccess (`yarn gatsby-build`) can not access to the custom Griddo
- * `process.env` so it needs variables passed to it via the `env` prop.
- */
-function runGatsbyBuildCommand(assetPrefixWithDomain: string) {
-	verboseLog(`read assetPrefixWithDomain, ${assetPrefixWithDomain}`);
-	verboseLog(
-		`using this NODE_OPTIONS in gatsby command: ${process.env.NODE_OPTIONS}`,
-	);
-
-	const { __ssg } = config.paths();
-
-	// Remove `--openssl-legacy-provider` from NODE_OPTIONS because this value
-	// break Gataby render.
-	const nodeOptionsWithoutLegacyOpenSSL = process.env.NODE_OPTIONS
-		? process.env.NODE_OPTIONS.replace(
-				/--openssl-legacy-provider\s*/g,
-				"",
-			).trim()
-		: "";
-
-	const command = spawnSync(
-		"yarn",
-		["gatsby-build", envs.GRIDDO_SSG_VERBOSE_LOGS ? "--verbose" : ""],
-		{
-			cwd: __ssg,
-			stdio: ["ignore", "inherit", "ignore"],
-			encoding: "utf8",
-			shell: true,
-			env: Object.assign(process.env, {
-				GRIDDO_EXPORTER: "true",
-				SPAWN_ASSET_PREFIX_WITH_DOMAIN: assetPrefixWithDomain,
-				NODE_OPTIONS: nodeOptionsWithoutLegacyOpenSSL,
-			}),
-		},
-	);
-
-	if (command.status !== 0) {
-		throwError(ErrorInSSGBuildProcess(command));
-	}
-}
-
-/**
- * Update the Griddo's `/dist` dir with the contents from `public` dir only
- * with files of type: js, json and css.
- */
-async function createDistFromGatsbyPublic(
-	domain: string,
-	needsAssetPrefix: boolean,
-) {
-	const { __cx, __ssg } = config.paths(domain);
-
-	const cxDistDir = path.join(__cx, "dist");
-	const cxAssetsDir = path.join(__cx, "assets");
-	const cxDistDirWithDomain = path.join(__cx, "dist", domain);
-	const publicDir = path.join(__ssg, "public");
-
-	const validFilesFromPublic = fsx
-		.readdirSync(publicDir)
-		.filter(
-			(file) =>
-				path.extname(file) === ".js" ||
-				path.extname(file) === ".json" ||
-				path.extname(file) === ".css",
-		);
-
-	const pageDataSrc = `${publicDir}/page-data`;
-	const pageDataDest = `${cxAssetsDir}/page-data`;
-
-	const projectStaticSrc = path.join(__ssg, "static");
-	const projectStaticDest = cxAssetsDir;
-
-	const gatsbyStaticSrc = `${cxDistDir}/static`;
-	const gatsbyStaticDest = `${cxAssetsDir}/static`;
-
-	try {
-		fsx.mkdirSync(cxAssetsDir, { recursive: true });
-		fsx.copySync(publicDir, cxDistDir, { preserveTimestamps: true });
-
-		if (needsAssetPrefix) {
-			fsx.copySync(pageDataSrc, pageDataDest, { preserveTimestamps: true });
-			if (fsx.existsSync(projectStaticSrc)) {
-				fsx.copySync(projectStaticSrc, projectStaticDest, {
-					overwrite: false,
-					preserveTimestamps: true,
-				});
-			}
-			fsx.copySync(gatsbyStaticSrc, gatsbyStaticDest, {
-				overwrite: false,
-				preserveTimestamps: true,
-			});
-			if (fsx.existsSync(projectStaticSrc)) {
-				fsx.copySync(projectStaticSrc, cxDistDirWithDomain, {
-					overwrite: false,
-					preserveTimestamps: true,
-				});
-			}
-
-			// Copia el resto de archivos...
-			validFilesFromPublic.map((file) => {
-				const fileSrc = `${publicDir}/${file}`;
-				const fileDest = `${cxAssetsDir}/${file}`;
-				fsx.copySync(fileSrc, fileDest, { preserveTimestamps: true });
-			});
-		}
-	} catch (err) {
-		console.error(err);
-	}
-}
-
-export {
-	createDistFromGatsbyPublic,
-	getGatsbyAssetPrefixWithDomain,
-	runGatsbyBuildCommand,
-};

package/exporter/artifacts/README.md

@@ -1,34 +0,0 @@
-# CX Artifacs
-
-## How to add an artifact.
-
-An artifact is a **full path** to a file or directory if it has a fixed
-location or only a **name** when it is going to be moved (archived/restored)
-between directories in the rendering process and therefore doesn't have a
-single location.
-
-Only the exporter knows where the artifacts are archived and restored, so the
-artifacts don't need to know anything other than their own location or name.
-
-Si estás creando un adaptador, sus artefactos deberán ir en un archivo separado (igual que `artifacts/cx.ts`) y exportar una función por defecto que devuelva un `Artifacts`. Todo deberá estar exportado desde `artifacts/index.ts`.
-
-**Artifacts have four categories:**
-
-- **initials**: Are directories that need to be created for their
-  future use.
-
-- **archivables**: Are stored in `__exports` which is the one uploaded to the
-  server as the final render and restored in `__cx` and `__ssg` to be reused in the
-  render. Therefore, they don't have a single location and should be added only
-  with the artifact name (directory/file)
-
-- **cacheables**: Are stored in `__cache` and restored in `__cx` and `__ssg` to be
-  reused in each domain render. Therefore, they don't have a single location.
-
-- **disposables**: Are generated alwais in `__cx` and `__ssg` or fixed locations.
-  These artifacts are discarded (deleted) in each domain render. They are
-  temporary directories and/or files.
-
-## Example
-
-Check `cx.ts` inside `./artifacts` directory to see how to add an artifact.

package/exporter/artifacts/index.ts

@@ -1,33 +0,0 @@
-import type { Artifacts } from "../types/global";
-
-import path from "node:path";
-
-import { getConfig } from "../utils/core-utils";
-
-/**
- * Returns the artifacts of CX.
- */
-function getCxArtifacts(domain: string): Artifacts {
-	const config = getConfig();
-	const { __cx, __exports, __cache } = config.paths(domain);
-
-	return {
-		initials: [
-			__exports, // `/exports/<domain>`
-			__cache, // `__cx/.cx-cache/<domain>`
-			path.join(__cx, "store"),
-			path.join(__cx, "apiCache"),
-		],
-		disposables: [
-			path.join(__cx, "store"),
-			path.join(__cx, "apiCache"),
-			path.join(__cx, "render-metadata.json"),
-			path.join(__cx, "dist"),
-			path.join(__cx, "debug"),
-		],
-		cacheables: ["apiCache", "store"],
-		archivables: ["dist", "assets", "debug"],
-	};
-}
-
-export default getCxArtifacts;

package/exporter/commands/move-assets.ts

@@ -1,11 +0,0 @@
-import { execSync } from "node:child_process";
-import path from "node:path";
-
-const domainName = "pro-griddo";
-const domainPath = path.resolve(
-	__dirname,
-	`../../../exports/sites/${domainName}`,
-);
-
-execSync(`mkdir -p ${domainPath}/assets/${domainName}`);
-execSync(`cp -R ${domainPath}/assets/* ${domainPath}/assets/${domainName}`);

package/exporter/constants/index.ts

@@ -1,129 +0,0 @@
-import type { LifeCyclesNames } from "../types/global";
-
-import {
-	AI_EMBEDDINGS,
-	ALERT,
-	BUILD_END,
-	BUILD_START,
-	DOMAINS,
-	GET_ALL,
-	GET_PAGE,
-	GET_PAGES,
-	GET_REFERENCE_FIELD_DATA,
-	GET_SITEMAP,
-	INFO,
-	LANGUAGES,
-	LOGIN,
-	RESET_RENDER,
-	ROBOTS,
-	SEARCH,
-	SETTINGS,
-	SOCIALS,
-} from "./endpoints";
-import {
-	GRIDDO_AI_EMBEDDINGS,
-	GRIDDO_ALERT_FEATURE,
-	GRIDDO_API_CONCURRENCY_COUNT,
-	GRIDDO_API_MAX_RESPONSE_SIZE,
-	GRIDDO_API_URL,
-	GRIDDO_ARCHIVE_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_ASSET_PREFIX,
-	GRIDDO_BOT_PASSWORD,
-	GRIDDO_BOT_USER,
-	GRIDDO_BUILD_LOGS,
-	GRIDDO_CLEAN_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_CLOSE_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_DATA_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_DEBUG_LOGS,
-	GRIDDO_FIXTURES_DOMAIN_NAMES,
-	GRIDDO_FIXTURES_SITE_NAMES,
-	GRIDDO_META_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_PREPARE_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_PUBLIC_API_URL,
-	GRIDDO_REACT_APP_INSTANCE,
-	GRIDDO_RELOCATION_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_RENDER_ALL_SITES,
-	GRIDDO_RENDER_BREAKPOINTS_FEATURE,
-	GRIDDO_RENDER_PAGES,
-	GRIDDO_RENDER_SITE,
-	GRIDDO_RESTORE_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_SEARCH_FEATURE,
-	GRIDDO_SKIP_BUILD_CHECKS,
-	GRIDDO_SSG_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_SSG_MAX_PAGE_SIZE,
-	GRIDDO_SSG_VERBOSE_LOGS,
-	GRIDDO_VERBOSE_LOGS,
-} from "./envs";
-
-const endpoints = {
-	ALERT,
-	AI_EMBEDDINGS,
-	BUILD_END,
-	BUILD_START,
-	DOMAINS,
-	GET_ALL,
-	GET_PAGE,
-	GET_PAGES,
-	GET_REFERENCE_FIELD_DATA,
-	GET_SITEMAP,
-	INFO,
-	LANGUAGES,
-	LOGIN,
-	RESET_RENDER,
-	ROBOTS,
-	SEARCH,
-	SETTINGS,
-	SOCIALS,
-};
-
-const envs = {
-	GRIDDO_AI_EMBEDDINGS,
-	GRIDDO_ALERT_FEATURE,
-	GRIDDO_API_CONCURRENCY_COUNT,
-	GRIDDO_API_MAX_RESPONSE_SIZE,
-	GRIDDO_API_URL,
-	GRIDDO_ARCHIVE_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_ASSET_PREFIX,
-	GRIDDO_BOT_PASSWORD,
-	GRIDDO_BOT_USER,
-	GRIDDO_BUILD_LOGS,
-	GRIDDO_CLEAN_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_CLOSE_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_DATA_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_DEBUG_LOGS,
-	GRIDDO_FIXTURES_DOMAIN_NAMES,
-	GRIDDO_FIXTURES_SITE_NAMES,
-	GRIDDO_META_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_PREPARE_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_PUBLIC_API_URL,
-	GRIDDO_REACT_APP_INSTANCE,
-	GRIDDO_RELOCATION_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_RENDER_ALL_SITES,
-	GRIDDO_RENDER_BREAKPOINTS_FEATURE,
-	GRIDDO_RENDER_PAGES,
-	GRIDDO_RENDER_SITE,
-	GRIDDO_RESTORE_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_SEARCH_FEATURE,
-	GRIDDO_SKIP_BUILD_CHECKS,
-	GRIDDO_SSG_LIFECYCLE_MAX_ATTEMPTS,
-	GRIDDO_SSG_MAX_PAGE_SIZE,
-	GRIDDO_SSG_VERBOSE_LOGS,
-	GRIDDO_VERBOSE_LOGS,
-};
-
-const lifeCycleNames: Record<LifeCyclesNames, LifeCyclesNames> = {
-	__DEBUG__: "__DEBUG__",
-	Archive: "Archive",
-	Clean: "Clean",
-	Close: "Close",
-	Data: "Data",
-	HealthCheck: "HealthCheck",
-	Init: "Init",
-	Meta: "Meta",
-	Prepare: "Prepare",
-	Relocation: "Relocation",
-	Restore: "Restore",
-	SSG: "SSG",
-} as const;
-
-export { endpoints, envs, lifeCycleNames };

package/exporter/index.ts

@@ -1,82 +0,0 @@
-/**
- *
- * 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/exporter/react/index.tsx

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

@@ -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 };