@griddo/cx 11.7.11 → 11.7.12-rc.0

package/exporter/types/api.ts

@@ -1,7 +1,7 @@
+import type { Core, Fields } from "@griddo/core";
 import type { Domains, Robots, Settings } from "./global";
 import type { APIPageObject } from "./pages";
 import type { Site } from "./sites";
-import type { Core, Fields } from "@griddo/core";
 
 /** EndSiteRender Body */
 export type EndSiteRenderBody = {
@@ -29,32 +29,31 @@ export interface ReferenceFieldBody {
 }
 
 /** Describes the props of the body object for the get page */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-interface PageBody {
-	/** The title of the page. */
-	title?: string;
-	/** The description of the page. */
-	description?: string;
-	/** The URL of the page's image. */
-	image?: string;
-	/** The ID of the page. */
-	pageId?: number;
-	/** The ID of the page's language. */
-	languageId?: number;
-	/** The ID of the page's site. */
-	siteId?: number;
-	/** The URL of the page. */
-	url?: string;
-	/** The template of the page. */
-	template?: string | null | number;
-	/** The content of the page. */
-	content?: string;
-	/** Additional properties. */
-	[key: string]: unknown;
-}
+// interface PageBody {
+// 	/** The title of the page. */
+// 	title?: string;
+// 	/** The description of the page. */
+// 	description?: string;
+// 	/** The URL of the page's image. */
+// 	image?: string;
+// 	/** The ID of the page. */
+// 	pageId?: number;
+// 	/** The ID of the page's language. */
+// 	languageId?: number;
+// 	/** The ID of the page's site. */
+// 	siteId?: number;
+// 	/** The URL of the page. */
+// 	url?: string;
+// 	/** The template of the page. */
+// 	template?: string | null | number;
+// 	/** The content of the page. */
+// 	content?: string;
+// 	/** Additional properties. */
+// 	[key: string]: unknown;
+// }
 
 /** Describes an item in a sitemap. */
-interface SitemapItem {
+export interface SitemapItem {
 	/** The URL of the page. */
 	loc: string;
 	/** The date the page was last modified. */
@@ -120,12 +119,12 @@ export interface APIRequest {
 	attempt?: number;
 	/**
 	 * Headers for the post api fetch
-	 * @shame any
-	 * @todo type this correctly from axios types
 	 */
-	headers?: any; // Record<string, unknown>;
+	headers?: Record<string, unknown>;
 	/* Save results in apiCache folder */
 	useApiCacheDir?: boolean;
+	/* Save log in the cx log file */
+	logToFile?: boolean;
 }
 
 /** Type with the POST request properties. */

package/exporter/types/global.ts

@@ -1,6 +1,6 @@
+import type { Core, Fields } from "@griddo/core";
 import type { EndSiteRenderBody } from "./api";
 import type { Site } from "./sites";
-import type { Core, Fields } from "@griddo/core";
 
 interface Settings {
 	apiVersion?: string;
@@ -70,9 +70,7 @@ interface RenderInfo {
 	sitesToPublish: Array<Site>;
 }
 
-type LifeCycleSteps = Array<
-	(...args: Array<unknown>) => unknown | Promise<unknown>
->;
+type LifeCycleAction = (...args: Array<unknown>) => void | Promise<void>;
 
 type LifeCyclesNames =
 	| "Init"
@@ -82,12 +80,11 @@ type LifeCyclesNames =
 	| "SSG"
 	| "Relocation"
 	| "Meta"
-	| "Archive"
+	| "Sync"
 	| "Clean"
 	| "Close"
 	| "HealthCheck"
-	| "Close"
-	| "__DEBUG__";
+	| "Close";
 
 type PlaceholderPath =
 	| "__exports"
@@ -97,13 +94,12 @@ type PlaceholderPath =
 	| "__components"
 	| "__root"
 	| "__exports_dist"
-	| "__cx_dist";
+	| "__sites";
 
 interface CXConfig {
-	proDomain: string;
+	proDomainPrefix: string;
 	griddoVersion: string;
 	buildReportFileName: string;
-	paths: (domain?: string) => Record<PlaceholderPath, string>;
 }
 
 interface AIEmbeddingsResponse {
@@ -116,6 +112,7 @@ interface Artifacts {
 	cacheables: Array<string>;
 	initials: Array<string>;
 	archivables: Array<string>;
+	restaurable: Array<string>;
 }
 
 export type {
@@ -134,5 +131,5 @@ export type {
 	Robot,
 	Robots,
 	Settings,
-	LifeCycleSteps,
+	LifeCycleAction,
 };

package/exporter/types/navigation.ts

@@ -21,5 +21,5 @@ export type Footer = {
 	setAsDefault: boolean;
 	theme: null | string;
 	title: string;
-	type: "header";
+	type: "footer";
 };

package/exporter/types/pages.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";
 
 // TODO: In @griddo/core the type Core.Page has header/footer as React-Types,
 // but API return `number | null`.
@@ -156,8 +156,7 @@ export interface Dimensions {
 	dimensionsSelect?: Array<string>;
 }
 
-export interface GatsbyPageTemplateProps
-	extends Omit<GriddoPageObject, "context"> {
+export interface GatsbyPageTemplateProps extends Omit<GriddoPageObject, "context"> {
 	pageContext: GriddoPageObject["context"] & {
 		page: Core.Page;
 	};

package/exporter/types/render.ts

@@ -0,0 +1,59 @@
+import type { RenderInfo } from "./global";
+
+const RENDER_MODE = {
+	FROM_SCRATCH: "FROM_SCRATCH",
+	INCREMENTAL: "INCREMENTAL",
+	IDLE: "IDLE",
+} as const;
+
+type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
+
+export interface RenderModeTuple {
+	renderMode: RenderMode;
+	reason?: string;
+}
+
+type DomainLike = string;
+
+type RenderDB = {
+	proDomainPrefix: string;
+	griddoVersion: string;
+	buildReportFileName: string;
+	sortedDomains: Array<DomainLike>;
+	paths: {
+		root: string;
+		cx: string;
+		ssg: string;
+		cxCache: string;
+		components: string;
+		exportsDir: string;
+	};
+	domains: {
+		[key: DomainLike]: {
+			renderMode?: RenderMode;
+			shouldBeRendered?: boolean;
+			isRendering?: boolean;
+			renderInfo?: RenderInfo;
+			renderModeReason?: string;
+		};
+	};
+};
+
+interface Report {
+	authControl:
+		| {
+				Authorization: string;
+				"Cache-Control": string;
+				lang?: string | undefined;
+		  }
+		| undefined;
+	sites: Array<{
+		siteId: number;
+		publishHashes: Array<string>;
+		siteHash: string | null;
+		unpublishHashes: Array<string>;
+		publishPagesIds: Array<number>;
+	}>;
+}
+
+export { RENDER_MODE, type RenderDB, type RenderMode, type Report };

package/exporter/types/sites.ts

@@ -1,6 +1,6 @@
+import type { Core } from "@griddo/core";
 import type { SocialsResponse } from "./api";
 import type { Footer, Header } from "./navigation";
-import type { Core } from "@griddo/core";
 
 /**
  * Describes a Griddo site object from API.
@@ -43,7 +43,6 @@ export interface Site
 	 */
 	pages: Array<number>;
 	onlinePages: Array<number>;
-	changedPages: Array<number>;
 	published: string;
 	rendering: boolean;
 	renderingHours: number;

package/exporter/utils/api.ts

@@ -6,25 +6,16 @@ import type {
 	PutAPI,
 	ShowApiErrorOptions,
 } from "../types/api";
-import type { AxiosError, Method } from "axios";
-
-import axios from "axios";
-import dotenv from "dotenv";
-import kleur from "kleur";
 
+import { AuthService } from "../services/auth";
+import { brush } from "./brush";
 import { saveCache, searchCacheData } from "./cache";
 import { delay, getSafeSiteId, msToSec } from "./core-utils";
-import { buildLog } from "./loggin";
-import { envs } from "../constants";
-import { apiRegister } from "../registers";
-import { AuthService } from "../services/auth";
-
-dotenv.config();
+import { appendLogToFile } from "./loggin";
 
 // Envs
-const {
-	env: { RETRY_WAIT_SECONDS = "4", RETRY_ATTEMPTS = "4" },
-} = process;
+const { env } = process;
+const { RETRY_WAIT_SECONDS = "4", RETRY_ATTEMPTS = "4" } = env;
 
 /**
  * Make a GET/PUT/POST request to the Griddo API.
@@ -41,7 +32,7 @@ const {
  */
 async function requestAPI<T extends APIResponses>(
 	props: APIRequest,
-	method: Method,
+	method: string,
 	appendToLog = "",
 ): Promise<T> {
 	const {
@@ -51,21 +42,24 @@ async function requestAPI<T extends APIResponses>(
 		attempt = 1,
 		headers,
 		useApiCacheDir = true,
+		logToFile = true,
 	} = props;
 	const cacheOptions = { endpoint, body, headers, cacheKey };
 
 	// Cache
 	if (cacheKey && useApiCacheDir) {
 		const start = new Date();
-		const cacheData = searchCacheData<T>(cacheOptions);
+		const cacheData = await searchCacheData<T>(cacheOptions);
 
 		if (cacheData) {
 			const siteId = getSafeSiteId(cacheData);
 			const siteIdMsg = siteId ? `site: ${siteId}` : "";
-			const duration = msToSec(new Date().getTime() - start.getTime());
-			buildLog(
-				`${method} (cache) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`,
-			);
+			const duration = msToSec(Date.now() - start.getTime());
+			if (logToFile) {
+				await appendLogToFile(
+					`${method} (cache) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`,
+				);
+			}
 			return cacheData;
 		}
 	}
@@ -73,47 +67,50 @@ async function requestAPI<T extends APIResponses>(
 	// Network
 	try {
 		const start = new Date();
-		const {
-			data,
-			headers: responseHeaders,
-		}: { data: T; headers: { "content-length": string } } = await axios({
-			url: endpoint,
-			method,
-			headers: Object.assign({}, headers, AuthService.headers),
-			data: body,
-		});
+
+		// Prepare fetch options
+		const fetchOptions: RequestInit = {
+			method: method.toUpperCase(),
+			headers: Object.assign({}, headers, AuthService.headers) as Record<string, string>,
+		};
+
+		// Add body for non-GET requests
+		if (method.toLowerCase() !== "get" && body) {
+			fetchOptions.body = JSON.stringify(body);
+			if (!fetchOptions.headers) fetchOptions.headers = {};
+			(fetchOptions.headers as Record<string, string>)["Content-Type"] = "application/json";
+		}
+
+		const response = await fetch(endpoint, fetchOptions);
+
+		// Handle non-2xx responses
+		if (!response.ok) {
+			if (response.status === 404) {
+				// @ts-expect-error page maybe will be 404
+				return null;
+			}
+
+			throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+		}
+
+		const data: T = await response.json();
 
 		const siteId = getSafeSiteId(data);
 		const siteIdMsg = siteId ? `site: ${siteId}` : "";
-		const duration = msToSec(new Date().getTime() - start.getTime());
-		buildLog(
-			`${method} (fetch) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`,
-		);
-
-		if (useApiCacheDir) {
-			saveCache(cacheOptions, data);
+		const duration = msToSec(Date.now() - start.getTime());
+		if (logToFile) {
+			await appendLogToFile(
+				`${method} (fetch) ${siteIdMsg} ${endpoint} - ${duration}s ${appendToLog}`,
+			);
 		}
 
-		// Only save registers if alerts are enabled
-		if (envs.GRIDDO_ALERT_FEATURE) {
-			const responseSize = Number.parseInt(responseHeaders["content-length"]);
-			if (responseSize > envs.GRIDDO_API_MAX_RESPONSE_SIZE) {
-				apiRegister.insert("API_RESPONSE_TOO_BIG", {
-					endpoint,
-					responseSize,
-					duration,
-				});
-			}
+		if (useApiCacheDir) {
+			await saveCache(cacheOptions, data);
 		}
 
 		return data;
 	} catch (e) {
-		const error = e as AxiosError;
-
-		if (error.response?.status === 404) {
-			// @ts-expect-error page maybe will be 404
-			return null;
-		}
+		const error = e as Error;
 
 		if (attempt > parseInt(RETRY_ATTEMPTS)) {
 			console.log(`
@@ -122,7 +119,7 @@ Max attempts ${RETRY_ATTEMPTS} reached
 - ${method.toUpperCase()} ${endpoint}
 - BODY: ${JSON.stringify(body)}
 - HEADERS: ${JSON.stringify(headers)}
-- RESPONSE: ${error.response?.status} ${JSON.stringify(error.response?.data)}
+- ERROR: ${error.message}
 --------------------------------------
 `);
 
@@ -130,12 +127,6 @@ Max attempts ${RETRY_ATTEMPTS} reached
 			process.exit(1);
 		}
 
-		if (!error.response) {
-			console.log("Unknown error occurred");
-			console.log(JSON.stringify(error, null, 2));
-			process.exit(1);
-		}
-
 		showApiError(error, {
 			callInfo: { endpoint, body },
 		});
@@ -188,9 +179,7 @@ async function postApi<T extends APIResponses>(props: PostAPI) {
 	const { endpoint, body, headers } = props;
 	const referenceFieldBodyParams =
 		endpoint.endsWith("/distributor") &&
-		`# ReferenceField body: ${JSON.stringify(body)} lang: ${JSON.stringify(
-			headers?.lang,
-		)}`;
+		`# ReferenceField body: ${JSON.stringify(body)} lang: ${JSON.stringify(headers?.lang)}`;
 
 	return requestAPI<T>(props, "post", referenceFieldBodyParams || "");
 }
@@ -198,40 +187,31 @@ async function postApi<T extends APIResponses>(props: PostAPI) {
 /**
  * Shows an API error through the terminal.
  */
-function showApiError(error: AxiosError, options: ShowApiErrorOptions) {
-	const { response, message, stack } = error;
+function showApiError(error: Error, options: ShowApiErrorOptions) {
+	const { message, stack } = error;
 	const { callInfo } = options;
-	const { status, statusText, data } = response || {};
 	const callInfoArray = [];
 
 	for (const item of Object.keys(callInfo) as Array<keyof typeof callInfo>) {
 		callInfoArray.push(
 			`${item}: ${
-				typeof callInfo[item] === "object"
-					? JSON.stringify(callInfo[item])
-					: callInfo[item]
+				typeof callInfo[item] === "object" ? JSON.stringify(callInfo[item]) : callInfo[item]
 			}`,
 		);
 	}
 
 	// Compose the errors output
 	const callInfoStr = callInfoArray.join("\n");
-	const apiResponseStr = response
-		? `Code: ${status} - ${statusText}\nResponse: ${JSON.stringify(data)}`
-		: "";
 	const errorDetailsStr = `${message}\n${stack}`;
 
 	// Print the error
 	console.warn(
-		kleur.red(`
+		brush.red(`
 =============
 
 { Call info }
 ${callInfoStr}
 
-{ API Response }
-${apiResponseStr}
-
 { Error details }
 ${errorDetailsStr}
 

package/exporter/utils/artifacts.ts

@@ -0,0 +1,38 @@
+import type { Artifacts } from "../types/global";
+
+import path from "node:path";
+
+import { getRenderPathsFromDB } from "./render";
+
+/**
+ * Returns the artifacts of CX.
+ */
+async function getCxArtifacts(domain: string): Promise<Artifacts> {
+	const { __exports, __cache, __root, __ssg } = await getRenderPathsFromDB({ domain });
+
+	return {
+		initials: [
+			__exports, // `<root>/exports/<domain>`
+			__cache, // `<root>/.cx-cache/<domain>`
+			path.join(__exports, "logs"),
+			path.join(__root, "store"),
+			path.join(__root, "apiCache"),
+		],
+		disposables: [
+			path.join(__root, "store"),
+			path.join(__root, "apiCache"),
+			path.join(__root, "dist"),
+			path.join(__root, "dist-restored"),
+			path.join(__root, "assets"),
+			path.join(__root, "render-detail-log.txt"),
+			path.join(__ssg, "domains.json"),
+			path.join(__ssg, "domains.txt"),
+			path.join(__ssg, "render-metadata.json"),
+		],
+		cacheables: [],
+		archivables: ["dist", "assets"],
+		restaurable: ["dist"],
+	};
+}
+
+export { getCxArtifacts };

package/exporter/utils/brush.ts

@@ -0,0 +1,34 @@
+//
+// Brush adds color to a string|number, it does not print it!
+// Its simple, no log, no chains, just color in a string|number
+// usage:
+// console.log(brush.green("sucess!"))
+//
+
+const RESET = "\x1b[0m";
+const CODES = {
+	black: "\x1b[30m",
+	red: "\x1b[31m",
+	green: "\x1b[32m",
+	yellow: "\x1b[33m",
+	blue: "\x1b[34m",
+	magenta: "\x1b[35m",
+	cyan: "\x1b[36m",
+	white: "\x1b[37m",
+	gray: "\x1b[90m",
+	bold: "\x1b[1m",
+	dim: "\x1b[2m",
+} as const;
+
+type ColorFunction = (text: string | number) => string;
+type ColorName = keyof typeof CODES;
+type Brush = Record<ColorName, ColorFunction>;
+
+const brush = {} as Brush;
+
+for (const color in CODES) {
+	const key = color as ColorName;
+	brush[key] = (text: string | number) => `${CODES[key]}${text}${RESET}`;
+}
+
+export { brush };