@griddo/cx 11.0.8 → 11.0.9

package/build/utils/store.d.ts

@@ -22,7 +22,8 @@ declare function getBuildPagesFromStore<PageType extends GriddoPageObject>(args?
     withSizeProp?: boolean;
 }): Generator<PageType, void, unknown>;
 /**
- * Read all pages stored in `store` Griddo directory and return the absolute path.
+ * Read all pages stored in `store` Griddo directory and return the absolute
+ * path.
  */
 declare function getBuildPagesPath(): string[];
 /**

package/exporter/build.sh

@@ -0,0 +1,39 @@
+# Build CX script file
+#
+# This file generates the necessary builds for CX.
+# - Setup, to generate necessary elements (tsconfig, etc..)
+# - Library, CX library that will be used by the SSG framework.
+# - Scripts, CX scripts that will be used by infra during the render process.
+#
+# @todo:
+# In the future, we will try to eliminate the bundling processes and use
+# TypeScript or ESModules directly.
+
+# start
+echo "📦 Building ..."
+
+# CLI options
+log="--log-level=error"
+production_node_opts="--bundle --platform=node --minify --sourcemap"
+debugging_node_opts="--bundle --platform=node --sourcemap"
+react_opts="--platform=node --external:@griddo-instance --external:react --external:react-dom --bundle --minify"
+
+# Manage --minify for debugging
+bundle_node_opts=$production_node_opts
+if [ "$1" = "--debug" ]; then
+    bundle_node_opts=$debugging_node_opts
+fi
+
+# library
+esbuild ${log} ./exporter/index.ts ${bundle_node_opts} --outfile=./build/index.js
+esbuild ${log} ./exporter/react/index.tsx ${react_opts} --outfile=./build/react/index.js
+
+# scripts
+esbuild ${log} ./exporter/scripts/run-start-render.ts ${bundle_node_opts} --outfile=./build/run-start-render.js
+esbuild ${log} ./exporter/scripts/end-render.ts ${bundle_node_opts} --outfile=./build/end-render.js
+esbuild ${log} ./exporter/scripts/upload-search-content.ts ${bundle_node_opts} --outfile=./build/upload-search-content.js
+esbuild ${log} ./exporter/scripts/reset-render.ts ${bundle_node_opts} --outfile=./build/reset-render.js
+esbuild ${log} ./exporter/scripts/start-render.ts ${bundle_node_opts} --outfile=./build/start-render.js
+
+# types
+tsc --emitDeclarationOnly --declaration --outDir build --project tsconfig.exporter.json

package/exporter/errors/errors-data.ts

@@ -10,17 +10,19 @@
 import type { ErrorData } from ".";
 import type { SpawnSyncReturns } from "node:child_process";
 
-export type ErrorsType =
-	| "NoDomainsFoundError"
-	| "RenderUUIDError"
+type ErrorsType =
 	| "ArtifactError"
-	| "LoginError"
 	| "ErrorInSSGBuildProcess"
 	| "LifecycleExecutionError"
+	| "LoginError"
+	| "NoDomainsFoundError"
 	| "NoJSConfigFileFound"
-	| "ReferenceFieldSourcesNotFoundError";
+	| "ReadFromStoreError"
+	| "ReferenceFieldSourcesNotFoundError"
+	| "RenderUUIDError"
+	| "WriteToStoreError";
 
-export const ArtifactError: ErrorData = {
+const ArtifactError: ErrorData = {
 	error: "ArtifactError",
 	message: "There was a problem with an artifact",
 	expected:
@@ -28,14 +30,16 @@ export const ArtifactError: ErrorData = {
 	hint: "Have there been any recent deployments? These can delete directories from the current render.",
 };
 
-export const NoJSConfigFileFound: ErrorData = {
-	error: "NoJSConfigFileFound",
-	message: "Could not find jsconfig.json or tsconfig.json",
+const ErrorInSSGBuildProcess = (
+	command: SpawnSyncReturns<string>,
+): ErrorData => ({
+	error: "ErrorInSSGBuildProcess",
+	message: `Error in SSG build process: ${JSON.stringify(command)}`,
 	expected:
-		"This can happen if the instance is not properly configured with a jsconfig.json or tsconfig.json file.",
-};
+		"This can happen if there was a problem with the SSG build process.",
+});
 
-export const LifecycleExecutionError = (
+const LifecycleExecutionError = (
 	attempts: number,
 	name: string,
 ): ErrorData => ({
@@ -43,16 +47,14 @@ export const LifecycleExecutionError = (
 	message: `Exceeded maximum retry attempts (${attempts}) for ${name} LifeCycle`,
 });
 
-export const ErrorInSSGBuildProcess = (
-	command: SpawnSyncReturns<string>,
-): ErrorData => ({
-	error: "ErrorInSSGBuildProcess",
-	message: `Error in SSG build process: ${JSON.stringify(command)}`,
+const LoginError: ErrorData = {
+	error: "LoginError",
+	message: "There was a problem logging in to the API",
 	expected:
-		"This can happen if there was a problem with the SSG build process.",
-});
+		"This happens if the API is currently not working or the credentials are incorrect.",
+};
 
-export const NoDomainsFoundError: ErrorData = {
+const NoDomainsFoundError: ErrorData = {
 	error: "NoDomainsFoundError",
 	message:
 		"No domains were found in this instance. The process cannot continue.",
@@ -61,7 +63,27 @@ export const NoDomainsFoundError: ErrorData = {
 	hint: "You can contact the instance administrator.",
 };
 
-export const RenderUUIDError: ErrorData = {
+const NoJSConfigFileFound: ErrorData = {
+	error: "NoJSConfigFileFound",
+	message: "Could not find jsconfig.json or tsconfig.json",
+	expected:
+		"This can happen if the instance is not properly configured with a jsconfig.json or tsconfig.json file.",
+};
+
+const ReadFromStoreError: ErrorData = {
+	error: "ReadFromStoreError",
+	message: "There was an error reading a file to the Store directory",
+	hint: "There may be an issue such as permissions preventing the file from being read.",
+};
+
+const ReferenceFieldSourcesNotFoundError: ErrorData = {
+	error: "ReferenceFieldSourcesNotFoundError",
+	message: "The distributor has no sources defined.",
+	expected:
+		"It is expected to have at least one data source in the `sources` property, even if it is empty.",
+};
+
+const RenderUUIDError: ErrorData = {
 	error: "RenderUUIDError",
 	message: `Render sentinel file does not exist.
 The rendering UUID cannot be read safely.
@@ -70,16 +92,22 @@ There was probably an instance deployment during the render, and files were dele
 The files generated in this render will not be published.`,
 };
 
-export const ReferenceFieldSourcesNotFoundError: ErrorData = {
-	error: "ReferenceFieldSourcesNotFoundError",
-	message: "The distributor has no sources defined.",
-	expected:
-		"It is expected to have at least one data source in the `sources` property, even if it is empty.",
+const WriteToStoreError: ErrorData = {
+	error: "WriteToStoreError",
+	message: "There was an error writing a file to the Store directory",
+	hint: "There may be an issue such as lack of space or permissions preventing the file from being written.",
 };
 
-export const LoginError: ErrorData = {
-	error: "LoginError",
-	message: "There was a problem logging in to the API",
-	expected:
-		"This happens if the API is currently not working or the credentials are incorrect.",
+export {
+	ArtifactError,
+	ErrorInSSGBuildProcess,
+	LifecycleExecutionError,
+	LoginError,
+	NoDomainsFoundError,
+	NoJSConfigFileFound,
+	ReadFromStoreError,
+	ReferenceFieldSourcesNotFoundError,
+	RenderUUIDError,
+	WriteToStoreError,
+	type ErrorsType,
 };

package/exporter/utils/core-utils.ts

@@ -1,7 +1,6 @@
 import type { APIResponses } from "../types/api";
 import type { CXConfig, LifeCyclesNames } from "../types/global";
 import type { APIPageObject } from "../types/pages";
-import type { Site } from "../types/sites";
 
 import fs from "node:fs";
 import path from "node:path";
@@ -38,8 +37,8 @@ function getConfig(): CXConfig {
 
 		return config;
 	} catch (error) {
-		console.log("Error while reading configuration file");
-		process.exit(1);
+		console.log(error);
+		throw new Error("Error while reading configuration file");
 	}
 }
 

package/exporter/utils/folders.ts

@@ -77,8 +77,8 @@ function createArtifacts(dirs: Array<string>, options?: MakeDirectoryOptions) {
 				fs.mkdirSync(dir, { recursive: true, ...options });
 				verboseLog(`create directory: ${dir}`);
 			}
-		} catch (e) {
-			throwError(ArtifactError, e);
+		} catch (error) {
+			throwError(ArtifactError, error);
 		}
 	}
 }
@@ -89,8 +89,8 @@ function renameArtifact(src: string, dst: string) {
 			fs.renameSync(src, dst);
 			verboseLog(`rename ${src} to ${dst}`);
 		}
-	} catch (e) {
-		throwError(ArtifactError, e);
+	} catch (error) {
+		throwError(ArtifactError, error);
 	}
 }
 
@@ -148,13 +148,13 @@ function copyArtifacts(
 				deleteBackup(dstCompose);
 				verboseLog(`delete backup: ${dstCompose}`);
 			}
-		} catch (e) {
+		} catch (error) {
 			if (withBackup) {
 				restoreBackup(dstCompose);
 				console.log("Backup has been restored.");
 			}
 
-			throwError(ArtifactError, e);
+			throwError(ArtifactError, error);
 		}
 	}
 }
@@ -199,13 +199,13 @@ function moveArtifacts(
 			if (withBackup) {
 				deleteBackup(dstCompose);
 			}
-		} catch (e) {
+		} catch (error) {
 			if (withBackup) {
 				restoreBackup(dstCompose);
 				console.log("Backup has been restored.");
 			}
 
-			throwError(ArtifactError, e);
+			throwError(ArtifactError, error);
 		}
 	}
 }
@@ -226,8 +226,8 @@ function removeArtifacts(artifacts: Array<string>) {
 				fs.rmSync(dir, { recursive: true, force: true });
 				verboseLog(`removed directory: ${dir}`);
 			}
-		} catch (e) {
-			throwError(ArtifactError, e);
+		} catch (error) {
+			throwError(ArtifactError, error);
 		}
 	}
 }
@@ -237,8 +237,9 @@ function restoreBackup(src: string, suffix = "-BACKUP") {
 	try {
 		fs.renameSync(dst, src);
 		console.log(`Backup ${dst} has been restored`);
-	} catch (e) {
-		console.log(`Error while delete ${dst} backup`);
+	} catch (error) {
+		console.log(error);
+		throw new Error(`Error while delete ${dst} backup`);
 	}
 }
 
@@ -252,8 +253,9 @@ function deleteBackup(src: string, suffix = "-BACKUP") {
 	try {
 		fs.rmSync(dst, { recursive: true, force: true });
 		console.log(`Backup ${dst} has been deleted`);
-	} catch (e) {
-		console.log(`Error while delete ${dst} backup`);
+	} catch (error) {
+		console.log(error);
+		throw new Error(`Error while delete ${dst} backup`);
 	}
 }
 
@@ -272,10 +274,9 @@ function createBackup(src: string, suffix = "-BACKUP") {
 	try {
 		fs.renameSync(src, dst);
 		console.log(`Backup of ${src} has been created in ${dst}`);
-	} catch (e) {
+	} catch (error) {
 		console.log(`Error while coping ${src} to ${dst} backup`);
-
-		throwError(ArtifactError, e);
+		throwError(ArtifactError, error);
 	}
 }
 
@@ -296,7 +297,7 @@ async function removeVirtualPagesFromStore() {
 				fs.unlinkSync(filePath);
 			}
 		}
-	} catch (e) {
+	} catch (error) {
 		console.info(
 			"`store` folder does not exist. Skipping multipage or static list template cleaning.",
 		);
@@ -328,8 +329,9 @@ function clearSitemapsFromDirs(initialFolder: string) {
 					fs.unlinkSync(fullPath);
 				}
 			}
-		} catch (err) {
-			console.error(`Error processing directory: ${folder}`, err);
+		} catch (error) {
+			console.error(error);
+			throw new Error(`Error processing directory: ${folder}`);
 		}
 	}
 

package/exporter/utils/sites.ts

@@ -284,8 +284,9 @@ function saveFile(filePath: string, content: string) {
 			fs.mkdirSync(pathName, { recursive: true });
 		}
 		fs.writeFileSync(filePath, content);
-	} catch (err) {
-		console.error(`Error saving file: ${err}`);
+	} catch (error) {
+		console.log(error);
+		throw new Error(`Error saving a file`);
 	}
 }
 

package/exporter/utils/store.ts

@@ -8,7 +8,9 @@ import path from "node:path";
 
 import fsx from "fs-extra";
 
+import { throwError } from "../errors";
 import { getConfig, removeProperties, walk, walkStore } from "./core-utils";
+import { ReadFromStoreError, WriteToStoreError } from "../errors/errors-data";
 
 const config = getConfig();
 
@@ -64,13 +66,14 @@ function* getBuildPagesFromStore<PageType extends GriddoPageObject>(args?: {
 				yield page;
 			}
 		} catch (error) {
-			console.error(`Error: The file ${filePath} doesn't exist`, error);
+			throwError(ReadFromStoreError, error);
 		}
 	}
 }
 
 /**
- * Read all pages stored in `store` Griddo directory and return the absolute path.
+ * Read all pages stored in `store` Griddo directory and return the absolute
+ * path.
  */
 function getBuildPagesPath() {
 	const config = getConfig();
@@ -198,8 +201,8 @@ function savePagesInStore(
 			const filePath = path.join(__cx, "store", siteFolderName, filename);
 			fsx.writeJSONSync(filePath, page);
 		}
-	} catch (e) {
-		console.log("ERROR", e);
+	} catch (error) {
+		throwError(WriteToStoreError, error);
 	}
 }
 
@@ -219,7 +222,8 @@ function removePagesFromStore(siteDirName: string, filenames: Array<number>) {
 		try {
 			fs.unlinkSync(filePath);
 		} catch (error) {
-			console.log(`Error removing file ${filename}`, (error as Error).message);
+			console.log(error);
+			throw new Error(`Error removing file ${filename}`);
 		}
 	}
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "11.0.8",
+	"version": "11.0.9",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -34,8 +34,8 @@
 		"// NPM": "",
 		"prepare": "yarn run build",
 		"// BUILD": "",
-		"build": "sh ./scripts/build.sh",
-		"build:debug": "sh ./scripts/build.sh --debug",
+		"build": "sh ./exporter/build.sh",
+		"build:debug": "sh ./exporter/build.sh --debug",
 		"// TESTS": "",
 		"test": "tsx ./__tests__/utils/tests-health.ts && jest --verbose",
 		"test:create-render-fixtures": "tsx ./__tests__/utils/create-fixtures.ts",
@@ -60,7 +60,7 @@
 		"@babel/preset-env": "7.24.7",
 		"@babel/preset-react": "7.24.7",
 		"@babel/preset-typescript": "7.24.7",
-		"@griddo/core": "11.0.8",
+		"@griddo/core": "11.0.9",
 		"@svgr/webpack": "8.1.0",
 		"axios": "^1.7.4",
 		"babel-loader": "9.1.3",
@@ -127,5 +127,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "edada900fcedea9f5cb310554b949762e4c8fe9f"
+	"gitHead": "5b1d8199d3fed51e32cf0f47e5c65210f6b1eeef"
 }

package/src/gatsby-node-utils.ts

@@ -24,8 +24,9 @@ function prepareStaticDir() {
 		});
 
 		console.info("Components `static` dir copied");
-	} catch (err) {
-		console.error(err);
+	} catch (error) {
+		console.log(error);
+		throw new Error("Error copying `static` dir");
 	}
 }