@griddo/cx 11.9.12-rc.0 → 11.9.12

package/exporter/{shared/types → types}/api.ts

@@ -1,59 +1,60 @@
-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 = {
 	/** Site hashes to publish. */
-	publishHashes: string[];
+	publishHashes: Array<string>;
 	/** Current site hash. */
 	siteHash: string | null;
 	/**  Site hashes to unpublish. */
-	unpublishHashes: string[];
+	unpublishHashes: Array<string>;
 	/**  Page ids that publish */
-	publishPagesIds: number[];
+	publishPagesIds: Array<number>;
 };
 
 /** ReferenceField Body */
 export interface ReferenceFieldBody {
 	mode?: "auto" | "manual" | "navigation";
 	order?: string;
-	sources?: Fields.Source<unknown>[];
+	sources?: Array<Fields.Source<unknown>>;
 	quantity?: number;
-	filter?: unknown[];
+	filter?: Array<unknown>;
 	fullRelations?: boolean;
 	allLanguages?: boolean;
-	fixed?: number[];
+	fixed?: Array<number>;
 	referenceId?: number;
 }
 
 /** Describes the props of the body object for the get page */
-// 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;
-// }
+// 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;
+}
 
 /** Describes an item in a sitemap. */
-export interface SitemapItem {
+interface SitemapItem {
 	/** The URL of the page. */
 	loc: string;
 	/** The date the page was last modified. */
@@ -73,7 +74,7 @@ interface URL {
 }
 
 /** Describes the items returned by a sitemap response. */
-export type SitemapItems = Record<string, SitemapItem[]>;
+export type SitemapItems = Record<string, Array<SitemapItem>>;
 
 /** Describes the response object returned by a Griddo ReferenceField. */
 export type ReferenceFieldResponse = Fields.QueriedData<unknown>;
@@ -104,7 +105,7 @@ export interface LanguagesResponse {
 	/** Total of languages */
 	totalItems: number;
 	/** Array of languages objects */
-	items: Core.SiteLanguage[];
+	items: Array<Core.SiteLanguage>;
 }
 
 /** Describes common props for api responses. */
@@ -119,12 +120,12 @@ export interface APIRequest {
 	attempt?: number;
 	/**
 	 * Headers for the post api fetch
+	 * @shame any
+	 * @todo type this correctly from axios types
 	 */
-	headers?: Record<string, unknown>;
+	headers?: any; // 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. */
@@ -141,11 +142,11 @@ export type PutAPI = APIRequest;
 /** Response type for the start render API call */
 export interface StartPageRenderResponse {
 	/** Site hashes to publish */
-	publishIds: number[];
+	publishIds: Array<number>;
 	/** Current site hash */
 	siteHash: string | null;
 	/** Site hashes to unpublish */
-	unpublishHashes: string[];
+	unpublishHashes: Array<string>;
 }
 
 /** Response type for the end render API call */
@@ -159,7 +160,7 @@ export interface EndPageInfoResponse {
 export type PostEmbeddingsResponse = string;
 
 /** Describes a response type for GET all sites */
-export type AllSitesReponse = Site[];
+export type AllSitesReponse = Array<Site>;
 
 /** Describes a response type for GET one page */
 export type PageResponse = APIPageObject;
@@ -188,8 +189,8 @@ export interface ShowApiErrorOptions {
 
 export interface BuildMetaData {
 	buildProcessData: Record<string, EndSiteRenderBody>;
-	createdPages: number[];
-	sitesToPublish: Site[];
+	createdPages: Array<number>;
+	sitesToPublish: Array<Site>;
 }
 
 export interface Auth {

package/exporter/{shared/types → 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;
@@ -55,22 +55,24 @@ type Domain = {
 	url: string;
 };
 
-type Domains = Domain[];
+type Domains = Array<Domain>;
 
 /** Describes the type of build process data object. */
 type BuildProcessData = Record<string, EndSiteRenderBody>;
 
 type Robot = { path: string; content: string };
 
-type Robots = Robot[];
+type Robots = Array<Robot>;
 
 interface RenderInfo {
 	buildProcessData: BuildProcessData;
-	createdPages: number[];
-	sitesToPublish: Site[];
+	createdPages: Array<number>;
+	sitesToPublish: Array<Site>;
 }
 
-type LifeCycleAction = (...args: unknown[]) => void | Promise<void>;
+type LifeCycleSteps = Array<
+	(...args: Array<unknown>) => unknown | Promise<unknown>
+>;
 
 type LifeCyclesNames =
 	| "Init"
@@ -80,11 +82,12 @@ type LifeCyclesNames =
 	| "SSG"
 	| "Relocation"
 	| "Meta"
-	| "Sync"
+	| "Archive"
 	| "Clean"
 	| "Close"
 	| "HealthCheck"
-	| "Close";
+	| "Close"
+	| "__DEBUG__";
 
 type PlaceholderPath =
 	| "__exports"
@@ -94,11 +97,13 @@ type PlaceholderPath =
 	| "__components"
 	| "__root"
 	| "__exports_dist"
-	| "__sites";
+	| "__cx_dist";
 
 interface CXConfig {
+	proDomain: string;
 	griddoVersion: string;
 	buildReportFileName: string;
+	paths: (domain?: string) => Record<PlaceholderPath, string>;
 }
 
 interface AIEmbeddingsResponse {
@@ -106,17 +111,16 @@ interface AIEmbeddingsResponse {
 	message: string;
 }
 
-interface RenderArtifacts {
-	disposables: string[];
-	cacheables: string[];
-	initials: string[];
-	archivables: string[];
-	restaurable: string[];
+interface Artifacts {
+	disposables: Array<string>;
+	cacheables: Array<string>;
+	initials: Array<string>;
+	archivables: Array<string>;
 }
 
 export type {
 	AIEmbeddingsResponse,
-	RenderArtifacts,
+	Artifacts,
 	BuildProcessData,
 	CXConfig,
 	Domain,
@@ -130,5 +134,5 @@ export type {
 	Robot,
 	Robots,
 	Settings,
-	LifeCycleAction,
+	LifeCycleSteps,
 };

package/exporter/{shared/types → types}/navigation.ts

@@ -4,7 +4,7 @@ export type Header = {
 	id: number;
 	isDefault: boolean;
 	language: number;
-	navigationLanguages: { navigationId: number }[];
+	navigationLanguages: Array<{ navigationId: number }>;
 	setAsDefault: boolean;
 	theme: null | string;
 	title: string;
@@ -17,9 +17,9 @@ export type Footer = {
 	id: number;
 	isDefault: boolean;
 	language: number;
-	navigationLanguages: { navigationId: number }[];
+	navigationLanguages: Array<{ navigationId: number }>;
 	setAsDefault: boolean;
 	theme: null | string;
 	title: string;
-	type: "footer";
+	type: "header";
 };

package/exporter/{shared/types → 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`.
@@ -35,7 +35,7 @@ export type GriddoSinglePage = Core.Page & {
 
 export type GriddoListPage = Core.Page & {
 	page: APIPageObject;
-	pages: Fields.QueriedDataItem[][];
+	pages: Array<Array<Fields.QueriedDataItem>>;
 	isRoot?: boolean;
 	defaultLang?: Core.SiteLanguage;
 	template: {
@@ -45,7 +45,7 @@ export type GriddoListPage = Core.Page & {
 		activeSectionSlug: string;
 		activeSectionBase: string;
 	};
-	totalQueriedItems: Fields.QueriedDataItem[];
+	totalQueriedItems: Array<Fields.QueriedDataItem>;
 };
 
 export type GriddoMultiPage = Core.Page & {
@@ -62,7 +62,7 @@ export interface AdditionalInfo {
 	griddoVersion: string;
 	instance?: string;
 	publicBaseUrl: string;
-	siteLangs: Core.SiteLanguage[];
+	siteLangs: Array<Core.SiteLanguage>;
 	siteMetadata: Site["siteMetadata"];
 	siteSlug: string;
 	socials: SocialsResponse;
@@ -90,14 +90,14 @@ export interface PageAdditionalInfo extends AdditionalInfo {
 export type MultiPageElement = {
 	component: string;
 	title: string | Required<Fields.Heading>;
-	elements: Record<string, unknown>[];
-	componentModules: Record<string, unknown>[];
+	elements: Array<Record<string, unknown>>;
+	componentModules: Array<Record<string, unknown>>;
 	sectionSlug: string;
 	metaTitle: string;
 	metaDescription: string;
 };
 
-export type MultiPageElements = MultiPageElement[];
+export type MultiPageElements = Array<MultiPageElement>;
 
 /**
  * Gatsby page object format.
@@ -140,7 +140,7 @@ export type GriddoPageObject = {
 		siteMetadata: Site["siteMetadata"];
 		theme: string;
 		title: string;
-		siteLangs: Core.SiteLanguage[];
+		siteLangs: Array<Core.SiteLanguage>;
 		siteOptions: AdditionalInfo["siteOptions"];
 		siteScript: string;
 		socials: SocialsResponse;
@@ -153,10 +153,11 @@ export interface Dimensions {
 	values: Record<string, string> | null;
 	contentSelect?: "group" | "individual" | null;
 	groupSelect?: string;
-	dimensionsSelect?: string[];
+	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/{shared/types → 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.
@@ -28,12 +28,12 @@ export interface Site
 	> {
 	author: string;
 	deleted: number;
-	domains: Record<string, string>[];
-	footers: Footer[];
+	domains: Array<Record<string, string>>;
+	footers: Array<Footer>;
 	hash: string | null;
-	headers: Header[];
-	languages: Core.SiteLanguage[]; // in Core is number[]
-	languageSites: number[];
+	headers: Array<Header>;
+	languages: Array<Core.SiteLanguage>; // in Core is Array<number>
+	languageSites: Array<number>;
 	navigationModules: { header?: string; footer?: string } | null;
 	/**
 	 * Array of all pages (from day 0): published, unpublished and deleted
@@ -41,8 +41,9 @@ export interface Site
 	 * `select/site/33/pages` -> [{id,label}, {id,label}, {id,label}] // array of published, pending, unpublished... page objects
 	 * `select/site/33/pages?liveStatus=active` -> // array of publishedpage objects
 	 */
-	pages: number[];
-	onlinePages: number[];
+	pages: Array<number>;
+	onlinePages: Array<number>;
+	changedPages: Array<number>;
 	published: string;
 	rendering: boolean;
 	renderingHours: number;
@@ -51,23 +52,23 @@ export interface Site
 	smallAvatar: string;
 	updated: boolean;
 	pagesStatus: {
-		active: number[];
-		uploadPending: number[];
-		offlinePending: number[];
-		offline: number[];
-		deleted: number[];
+		active: Array<number>;
+		uploadPending: Array<number>;
+		offlinePending: Array<number>;
+		offline: Array<number>;
+		deleted: Array<number>;
 	};
 }
 
 export interface SiteData {
 	siteInfo: Site;
-	validPagesIds: number[];
+	validPagesIds: Array<number>;
 	siteHash: string | null;
-	unpublishHashes: string[];
-	siteLangs: Core.SiteLanguage[];
+	unpublishHashes: Array<string>;
+	siteLangs: Array<Core.SiteLanguage>;
 	defaultLang: Core.SiteLanguage | undefined;
-	headers: Header[];
-	footers: Footer[];
+	headers: Array<Header>;
+	footers: Array<Footer>;
 	socials: SocialsResponse;
 }
 

package/exporter/utils/alerts.ts

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

@@ -0,0 +1,243 @@
+import type {
+	APIRequest,
+	APIResponses,
+	GetAPI,
+	PostAPI,
+	PutAPI,
+	ShowApiErrorOptions,
+} from "../types/api";
+import type { AxiosError, Method } from "axios";
+
+import axios from "axios";
+import dotenv from "dotenv";
+import kleur from "kleur";
+
+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();
+
+// Envs
+const {
+	env: { RETRY_WAIT_SECONDS = "4", RETRY_ATTEMPTS = "4" },
+} = process;
+
+/**
+ * Make a GET/PUT/POST request to the Griddo API.
+ *
+ * @template T Response Type returned.
+ * @returns {Promise<T>} A promise that is resolved with the data from the API response.
+ *
+ * @example
+ *	const response = await requestAPI<Site>(
+ *		{ endpoint: "...", cacheKey: "...", ... },
+ *		"get",
+ *		"..."
+ *	);
+ */
+async function requestAPI<T extends APIResponses>(
+	props: APIRequest,
+	method: Method,
+	appendToLog = "",
+): Promise<T> {
+	const {
+		endpoint,
+		body,
+		cacheKey = "",
+		attempt = 1,
+		headers,
+		useApiCacheDir = true,
+	} = props;
+	const cacheOptions = { endpoint, body, headers, cacheKey };
+
+	// Cache
+	if (cacheKey && useApiCacheDir) {
+		const start = new Date();
+		const cacheData = 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}`,
+			);
+			return cacheData;
+		}
+	}
+
+	// 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,
+		});
+
+		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);
+		}
+
+		// 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,
+				});
+			}
+		}
+
+		return data;
+	} catch (e) {
+		const error = e as AxiosError;
+
+		if (error.response?.status === 404) {
+			// @ts-expect-error page maybe will be 404
+			return null;
+		}
+
+		if (attempt > parseInt(RETRY_ATTEMPTS)) {
+			console.log(`
+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)}
+--------------------------------------
+`);
+
+			console.log(JSON.stringify(error, null, 2));
+			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 },
+		});
+
+		console.warn(`Waiting for retry: ${method}`, endpoint);
+
+		await delay(parseInt(RETRY_WAIT_SECONDS) * 1000);
+
+		return requestAPI<T>(
+			{
+				endpoint,
+				body,
+				headers,
+				cacheKey,
+				attempt: attempt + 1,
+			},
+			method,
+			appendToLog,
+		);
+	}
+}
+
+/**
+ * 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) {
+	return requestAPI<T>(props, "get");
+}
+
+/**
+ * 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) {
+	return requestAPI<T>(props, "put");
+}
+
+/**
+ * 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) {
+	const { endpoint, body, headers } = props;
+	const referenceFieldBodyParams =
+		endpoint.endsWith("/distributor") &&
+		`# ReferenceField body: ${JSON.stringify(body)} lang: ${JSON.stringify(
+			headers?.lang,
+		)}`;
+
+	return requestAPI<T>(props, "post", referenceFieldBodyParams || "");
+}
+
+/**
+ * Shows an API error through the terminal.
+ */
+function showApiError(error: AxiosError, options: ShowApiErrorOptions) {
+	const { response, 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]
+			}`,
+		);
+	}
+
+	// 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(`
+=============
+
+{ Call info }
+${callInfoStr}
+
+{ API Response }
+${apiResponseStr}
+
+{ Error details }
+${errorDetailsStr}
+
+=============
+`),
+	);
+}
+
+export { getApi as get, postApi as post, putApi as put };