@griddo/cx 1.75.192 → 1.75.195

package/src/services/store.ts

@@ -21,28 +21,24 @@
 //                        │      Build metadata     │                         //
 //                        └─────────────────────────┘                         //
 
-// Types
 import type { BuildProcessData, StoreMode } from "../types/global";
 import type { GatsbyPageObject, PageAdditionalInfo } from "../types/pages";
 import type { Site } from "../types/sites";
 
-// External libraries
-import chalk from "chalk";
-import dotenv from "dotenv";
 import fs from "fs";
 import fsp from "fs/promises";
-import pLimit from "p-limit";
 import path from "path";
 import v8 from "v8";
 
-// Services
+import chalk from "chalk";
+import dotenv from "dotenv";
+import pLimit from "p-limit";
+
 import { DistributorService } from "./distributors";
 import { NavigationService } from "./navigation";
 import { RobotsService } from "./robots";
 import { SettingsService } from "./settings";
 import { SitesService } from "./sites";
-
-// Utils
 import { version as griddoVersion } from "../../package.json";
 import { createSha256, updatedSiteHash } from "../utils/cache";
 import { deleteSites } from "../utils/folders";
@@ -53,7 +49,7 @@ import {
 	getMultiPageElements,
 	getPaginatedPages,
 } from "../utils/pages";
-import { logInfo, walk } from "../utils/shared";
+import { logInfo, removeProperties, siteList, walk } from "../utils/shared";
 import { checkSites, getSiteData, unpublishSites } from "../utils/sites";
 
 dotenv.config();
@@ -66,16 +62,17 @@ const GRIDDO_API_CONCURRENCY_COUNT = process.env.GRIDDO_API_CONCURRENCY_COUNT;
 const PUBLIC_API_URL = process.env.PUBLIC_API_URL as string;
 const RENDER_ID = process.env.RENDERID || new Date().valueOf().toString();
 
-// Constants shared between Gatsby phases.
+// Consts
 const CREATED_PAGES: Array<number> = [];
 const BUILD_PROCESS_DATA: BuildProcessData = {};
+const UNWANTED_PAGE_PROPS = ["editorID", "parentEditorID"];
 
 /**
- * Store service to fetch, process and save temporarily final pages and site
+ * Store service to fetch, process and save temporarily object pages and site
  * data to be consumed by external services (Griddo itself, Gatsby, etc.)
  *
  * Modes:
- * - File mode will save the final page objects in individual files in the file system.
+ * - File mode will save the final page objects in individual json files in the file system.
  * - Memory mode will save the final page objects in an array of objects in memory.
  *
  * @example
@@ -91,6 +88,7 @@ const BUILD_PROCESS_DATA: BuildProcessData = {};
 class StoreService {
 	static basePath: string;
 	static mode: "file" | "memory";
+	static sanitize? = false;
 	static pages: Array<GatsbyPageObject> = [];
 	static sitesToPublish: Array<Site>;
 	static buildProcessData: BuildProcessData;
@@ -99,14 +97,18 @@ class StoreService {
 	// Public methods
 
 	/**
-	 * Initialize the Store with a path to store the files in file mode and an option object to set the mode.
+	 * Initialize the Store with a path to save files (file mode) and an option object to configure the Store.
 	 *
 	 * @param basePath The path to store the page files.
 	 * @param options An object configuration
 	 * @param options.mode Store mode
 	 * @todo Avoid initialize the Store with a `basePath` in memory mode.
 	 */
-	public static init(basePath: string, options: { mode: StoreMode }) {
+	public static init(
+		basePath: string,
+		options: { mode: StoreMode; sanitize?: boolean }
+	) {
+		this.sanitize = options?.sanitize;
 		const { mode } = options;
 		const griddoCxThreads = parseInt(GRIDDO_API_CONCURRENCY_COUNT || "10");
 		const modeString = mode === "file" ? "File mode" : "Memory mode";
@@ -114,6 +116,10 @@ class StoreService {
 		console.log(`🧶 Processing API page calls with ${griddoCxThreads} threads`);
 		console.log(`📦 Griddo Store initialized - ${chalk.italic(modeString)}`);
 
+		if (this.sanitize) {
+			console.log(`🏥 Sanitize pages enabled`);
+		}
+
 		if (mode === "file") {
 			this.basePath = basePath;
 			this.mode = mode;
@@ -133,9 +139,9 @@ class StoreService {
 	}
 
 	/**
-	 * Save the build data to the Store.
+	 * Create a complete build fetching the necessary data from API.
 	 */
-	public static async saveBuildData() {
+	public static async createBuildSource() {
 		try {
 			// Get sites objects to publish and unpublish.
 			const { sitesToPublish, sitesToUnpublish } = await checkSites();
@@ -146,27 +152,15 @@ class StoreService {
 			// If no activity in sites, exit
 			if (!(sitesToPublish.length || sitesToUnpublish.length)) {
 				console.warn("There are no sites to update");
-
 				process.exit(0);
 			}
 
-			// Publish and unpublis sites
 			console.log(
-				chalk.green(
-					"\n⬆️ ",
-					`(${sitesToPublish.length}) Sites to publish:`,
-					sitesToPublish.map(({ name }) => name).join(", "),
-					"\n"
-				)
+				chalk.green(`\n⬆ Sites to publish: ${siteList(sitesToPublish)}`)
 			);
 
 			console.log(
-				chalk.red(
-					"⬇️ ",
-					`(${sitesToUnpublish.length}) Sites to unpublish:`,
-					sitesToUnpublish.map(({ name }) => name).join(", "),
-					"\n"
-				)
+				chalk.red(`\n⬇ Sites to unpublish: ${siteList(sitesToUnpublish)}\n`)
 			);
 
 			// Unpublish (API) and delete sites
@@ -178,9 +172,8 @@ class StoreService {
 			// Set robots information to use later in the `onPostBuild` phase.
 			await RobotsService.loadRobots();
 
-			// Array of sites (Promises)
-			for (const site of sitesToPublish) {
-				// Gets
+			const siteToPublishPromises = sitesToPublish.map(async (site) => {
+				// for (const site of sitesToPublish) {
 				const { id: siteId, slug: siteSlug, theme, favicon } = site;
 
 				const {
@@ -193,7 +186,6 @@ class StoreService {
 					headers,
 					footers,
 					socials,
-					// TODO: Check the false here...
 				} = await getSiteData(siteId, false);
 
 				const {
@@ -206,8 +198,6 @@ class StoreService {
 					avoidDebugMetas,
 				} = SettingsService.settings;
 
-				// Sets
-
 				BUILD_PROCESS_DATA[siteId] = {
 					siteHash,
 					unpublishHashes,
@@ -254,7 +244,7 @@ class StoreService {
 					siteScript,
 				};
 
-				logInfo(`${validPagesIds.length} valid pages`);
+				logInfo(`𝍌 ${site.name} site`);
 
 				// -------------------------------------------------------------------------
 				// Pages loop promise creation
@@ -382,7 +372,15 @@ class StoreService {
 				);
 
 				await Promise.all(pagesToRender);
-			}
+			});
+
+			// Create the pLimit array of promises
+			const limit = pLimit(1);
+			const sitesToPublishAwaited = siteToPublishPromises.map((site) =>
+				limit(() => site)
+			);
+
+			await Promise.all(sitesToPublishAwaited);
 		} catch (e) {
 			const error = e as { message: string };
 
@@ -393,7 +391,9 @@ class StoreService {
 	}
 
 	/**
-	 * Get the pages saved previously from the Store.
+	 * Get all pages data from the Store.
+	 * If the Store is in file mode `getPages` will return a Generator of pages.
+	 * If the Store is in memory mode `getPages` will return an array of pages.
 	 */
 	public static getPages() {
 		if (this.mode === "file") {
@@ -409,6 +409,12 @@ class StoreService {
 	 * @param pages An array of pages to save in the store.
 	 */
 	public static async savePages(pages: Array<GatsbyPageObject>) {
+		// WARNS: This mutate the page objects and could hurt the build render
+		// performance.
+		if (this.sanitize) {
+			pages.forEach((page) => removeProperties(page, UNWANTED_PAGE_PROPS));
+		}
+
 		if (this.mode === "file") {
 			await this.savePagesToFiles(pages);
 		} else {
@@ -464,6 +470,7 @@ class StoreService {
 		);
 
 		for (const filePath of jsonFilePaths) {
+			// eslint-disable-next-line @typescript-eslint/no-var-requires
 			const page = require(filePath) as GatsbyPageObject;
 			page.size = fs.statSync(filePath).size / 1024;
 			yield { ...page };

package/src/types/api.ts

@@ -1,8 +1,7 @@
-// Types
-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 = {
@@ -20,7 +19,7 @@ export interface DistributorBody {
 	order?: string;
 	source?: Array<string>;
 	quantity?: number;
-	filter?: Array<any>;
+	filter?: Array<unknown>;
 	fullRelations?: boolean;
 	allLanguages?: boolean;
 	fixed?: Array<number>;
@@ -112,13 +111,13 @@ export interface APIRequest {
 	/** The URL of the API endpoint. */
 	endpoint: string;
 	/** The parameters to be sent in the request body. */
-	body?: any;
+	body?: unknown;
 	/** Indicates whether to use the cache to get the response from the API. */
 	cached?: unknown;
 	/** Number of connection attempts (in case it fails on the first attempt). */
 	attempt?: number;
 	/** Headers for the post api fetch */
-	headers?: any;
+	headers?: Record<string, unknown>;
 }
 
 /** Type with the POST request properties. */
@@ -186,3 +185,14 @@ export type APIResponses =
 	| DistributorResponse
 	| PostSearchInfoResponse
 	| AllPagesResponse;
+
+// TODO: JSDoc
+export interface ShowApiErrorOptions {
+	callInfo: {
+		endpoint?: string;
+		body?: unknown;
+		headers?: unknown;
+		attempt?: number;
+	};
+	breakProcess: boolean;
+}

package/src/types/global.ts

@@ -1,9 +1,10 @@
-// Types
-import type { Core, Fields } from "@griddo/core";
 import type { EndSiteRenderBody } from "./api";
+import type { Core, Fields } from "@griddo/core";
 
+// TODO: JSDoc
 export type StoreMode = "memory" | "file";
 
+// TODO: JSDoc
 export interface Settings {
 	apiVersion?: string;
 	avoidCanonicalsOnSitemaps?: boolean;
@@ -27,9 +28,10 @@ export interface Settings {
 	welcomeText2?: string;
 }
 
-/** ??? */
+// TODO: JSDoc
 export type Petition = Record<string, unknown>;
 
+// TODO: JSDoc
 export interface PostSearchInfoProps {
 	title?: string;
 	description: string;
@@ -42,6 +44,7 @@ export interface PostSearchInfoProps {
 	url?: string;
 }
 
+// TODO: JSDoc
 export interface FetchDataProps {
 	page: Core.Page;
 	component: {
@@ -50,6 +53,7 @@ export interface FetchDataProps {
 	cached: boolean;
 }
 
+// TODO: JSDoc
 export type Domains = Array<{
 	id: number;
 	slug: string;
@@ -59,6 +63,8 @@ export type Domains = Array<{
 /** Describes the type of build process data object. */
 export type BuildProcessData = Record<string, EndSiteRenderBody>;
 
+// TODO: JSDoc
 export type Robot = { path: string; content: string };
 
+// TODO: JSDoc
 export type Robots = Array<Robot>;

package/src/types/pages.ts

@@ -1,8 +1,7 @@
-// Types
-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`.
@@ -11,11 +10,13 @@ export type APIPageObject = Core.Page & {
 	footer: number | null;
 };
 
+// TODO: JSDoc
 export type CleanPage = Core.Page & {
 	isRoot: boolean;
 	defaultLang?: Core.SiteLanguage | undefined;
 };
 
+// TODO: JSDoc
 export type RenderPage = Core.Page & {
 	isRoot?: boolean;
 	multiPageElements: MultiPageElements;
@@ -30,17 +31,19 @@ export type RenderPage = Core.Page & {
 	mode: "list";
 };
 
+// TODO: JSDoc
 export type GriddoSinglePage = Core.Page & {
 	defaultLang?: Core.SiteLanguage;
 };
 
+// TODO: JSDoc
 export type GriddoListPage = Core.Page & {
 	page: APIPageObject;
 	pages: Array<Array<Fields.QueriedDataItem>>;
 	isRoot?: boolean;
 	defaultLang?: Core.SiteLanguage;
 	template: {
-		[key: string]: any;
+		[key: string]: unknown;
 		type: "template";
 		templateType: string;
 		activeSectionSlug: string;
@@ -49,6 +52,7 @@ export type GriddoListPage = Core.Page & {
 	totalQueriedItems: Array<Fields.QueriedDataItem>;
 };
 
+// TODO: JSDoc
 export type GriddoMultiPage = Core.Page & {
 	header: number | null;
 	footer: number | null;
@@ -57,6 +61,7 @@ export type GriddoMultiPage = Core.Page & {
 	defaultLang?: Core.SiteLanguage | undefined;
 };
 
+// TODO: JSDoc
 export interface AdditionalInfo {
 	baseUrl: string;
 	BUILD_MODE?: string;
@@ -81,6 +86,7 @@ export interface AdditionalInfo {
 	theme: string;
 }
 
+// TODO: JSDoc
 export interface PageAdditionalInfo extends AdditionalInfo {
 	navigations: {
 		header: Record<string, unknown> | null;
@@ -88,6 +94,7 @@ export interface PageAdditionalInfo extends AdditionalInfo {
 	};
 }
 
+// TODO: JSDoc
 export type GatsbyPageObject = {
 	matchPath?: string;
 	path: string;
@@ -134,6 +141,7 @@ export type GatsbyPageObject = {
 	};
 };
 
+// TODO: JSDoc
 export type MultiPageElements = Array<{
 	component: string;
 	title: string | Required<Fields.Heading>;

package/src/types/sites.ts

@@ -1,7 +1,6 @@
-// Types
-import type { Core } from "@griddo/core";
 import type { AllPagesResponse, SocialsResponse } from "./api";
 import type { Footer, Header } from "./navigation";
+import type { Core } from "@griddo/core";
 
 /**
  * Describe a Griddo site object from API.
@@ -46,11 +45,12 @@ export interface Site
 	updated: boolean;
 }
 
+// TODO: JSDoc
 export interface SiteData {
 	siteInfo: Site;
-	validPagesIds: number[];
+	validPagesIds: Array<number>;
 	siteHash: string | null;
-	unpublishHashes: string[];
+	unpublishHashes: Array<string>;
 	siteLangs: Array<Core.SiteLanguage>;
 	defaultLang: Core.SiteLanguage | undefined;
 	headers: Array<Header>;
@@ -59,6 +59,8 @@ export interface SiteData {
 	sitePages: AllPagesResponse;
 }
 
+// TODO: JSDoc
 export type SiteHash = string | null;
 
+// TODO: JSDoc
 export type HashSites = Record<string, number | string>;

package/src/types/templates.ts

@@ -1,4 +1,3 @@
-// Types
 import type { Core, Fields } from "@griddo/core";
 
 /** Describe a template object from a Griddo Page */

package/src/utils/api.ts

@@ -1,4 +1,3 @@
-// Types
 import type {
 	APIRequest,
 	APIResponses,
@@ -6,19 +5,17 @@ import type {
 	GetAPI,
 	PostAPI,
 	PutAPI,
+	ShowApiErrorOptions,
 } from "../types/api";
+import type { Method } from "axios";
 
-// External libraries
-import axios, { Method } from "axios";
+import axios from "axios";
 import chalk from "chalk";
 import dotenv from "dotenv";
 
-// Services
-import { AuthService } from "../services/auth";
-
-// Utils
 import { getCache, saveCache } from "./cache";
 import { delay, getSafeSiteId, logInfo, msToSec } from "./shared";
+import { AuthService } from "../services/auth";
 
 dotenv.config();
 
@@ -32,7 +29,7 @@ const {
  *
  * @template T Response Type returned.
  * @returns {Promise<T>} A promise that is resolved with the data from the API response.
- * @todo Maybe remove the loggin responsability
+ *
  * @example
  *	const response = await requestAPI<Site>({
  *		endpoint: "...",
@@ -69,14 +66,13 @@ async function requestAPI<T extends APIResponses>(
 	} catch (e) {
 		const error = e as Error;
 
-		showApiError(
-			error,
-			{ endpoint, body, attempt },
-			error.response.status !== 404
-		);
+		showApiError(error, {
+			callInfo: { endpoint, body, attempt },
+			breakProcess: error.response.status !== 404,
+		});
 
 		if (error.response.status === 404) {
-			// @ts-expect-error
+			// @ts-expect-error page maybe will be 404
 			return null;
 		}
 
@@ -98,6 +94,12 @@ async function requestAPI<T extends APIResponses>(
 	}
 }
 
+/**
+ * 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) {
 	// Starts
 	const start = new Date();
@@ -117,6 +119,12 @@ async function getApi<T extends APIResponses>(props: GetAPI) {
 	return response;
 }
 
+/**
+ * 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) {
 	// Starts
 	const start = new Date();
@@ -134,6 +142,12 @@ async function putApi<T extends APIResponses>(props: PutAPI) {
 	return response;
 }
 
+/**
+ * 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) {
 	// Starts
 	const start = new Date();
@@ -161,18 +175,9 @@ async function postApi<T extends APIResponses>(props: PostAPI) {
 /**
  * Shows an API error through the terminal.
  */
-function showApiError(
-	error: Error,
-	callInfo: {
-		endpoint?: string;
-		// TODO: Remove any's
-		body?: any;
-		headers?: any;
-		attempt?: number;
-	} = {},
-	breakProcess = true
-) {
+function showApiError(error: Error, options: ShowApiErrorOptions) {
 	const { response, message, stack } = error;
+	const { breakProcess, callInfo } = options;
 	const { status, statusText, data } = response || {};
 	const callInfoArray = [];
 

package/src/utils/cache.ts

@@ -1,13 +1,11 @@
-// Types
 import type { Petition } from "../types/global";
 import type { HashSites, SiteHash } from "../types/sites";
 
-// External libraries
 import crypto from "crypto";
 import fs from "fs";
 import path from "path";
 
-// Constants
+// Consts
 const API_CACHE_DIR_PATH = path.resolve(__dirname, "./../../apiCache");
 const SITE_HASH_FILENAME = `${API_CACHE_DIR_PATH}/siteHash.json`;
 
@@ -24,8 +22,8 @@ function initCache() {
 
 /**
  * Generate a filename with a hash using a Petition object
- * TODO: Merge with createSha256
  *
+ * @todo Merge with createSha256
  * @param petition An object
  */
 function generateFilenameWithHash(petition: Petition) {
@@ -37,8 +35,8 @@ function generateFilenameWithHash(petition: Petition) {
 
 /**
  * Generate a filename with a hash using a string.
- * TODO: Merge with generateFilenameWithHash
  *
+ * @todo Merge with generateFilenameWithHash
  * @param data A string to create a sha256 based on.
  */
 function createSha256(data: string) {
@@ -54,11 +52,11 @@ function createSha256(data: string) {
  * @param petition An object.
  * @param content Content to be saved.
  */
-const saveCache = <T>(petition: Petition, content: T) => {
+function saveCache<T>(petition: Petition, content: T) {
 	const stringContent =
 		typeof content === "string" ? content : JSON.stringify(content);
 	fs.writeFileSync(generateFilenameWithHash(petition), stringContent, "utf8");
-};
+}
 
 /**
  * Read a cache file and return it as an object

package/src/utils/domains.ts

@@ -1,7 +1,5 @@
-// Types
 import type { Domains } from "../types/global";
 
-// Services
 import { AuthService } from "../services/auth";
 import { DomainsService } from "../services/domains";
 

package/src/utils/folders.ts

@@ -1,11 +1,9 @@
-// Types
 import type { Site } from "../types/sites";
 
-// External libraries
-import fs from "fs-extra";
 import path from "path";
 
-// Utils
+import fs from "fs-extra";
+
 import { resolveComponentsPath } from "./instance";
 import { logInfo } from "./shared";
 
@@ -107,21 +105,6 @@ async function updateDist() {
 	}
 }
 
-/**
- * Copy the Griddo's `/dist` folder into the Griddo's `/public` folder.
- */
-async function prepareServe() {
-	const src = "./dist";
-	const dest = "./public";
-
-	try {
-		await fs.copy(src, dest);
-		logInfo("Public copied");
-	} catch (err) {
-		console.warn("error", err);
-	}
-}
-
 /**
  * Copy the instance's `/static` folder into the Gatsby's to take it into account for bundle.
  */
@@ -144,4 +127,4 @@ function prepareStaticFolder() {
 	}
 }
 
-export { deleteSites, updateDist, prepareServe, prepareStaticFolder };
+export { deleteSites, updateDist, prepareStaticFolder };