@griddo/cx 10.4.12 → 10.4.13

package/build/utils/shared.d.ts

@@ -0,0 +1,109 @@
+import type { Adapters } from "../adapters";
+import type { APIResponses } from "../types/api";
+import type { LifeCyclesNames } from "../types/global";
+import type { Site } from "../types/sites";
+declare const CXRootDir: string;
+declare const instanceRootDir: string;
+/**
+ * Walk a directory and returns the file pathts.
+ *
+ * @param dir A directory path.
+ */
+declare function walk(dir: string): string[];
+/**
+ * Custom log inside a line-box.
+ *
+ * @param stringValue The string to be logged.
+ * @param paddingInline The number of white spaces inside the box at left and right.
+ * @param paddingBlock The number of white spaces inside the box at top and bottom.
+ */
+declare function logBox(stringValue: string, title?: string, paddingInline?: number, paddingBlock?: number): void;
+/**
+ * Custom basic logging function controlled by a environment variable.
+ * Strip double spaces.
+ *
+ * @param str The string to be logged.
+ */
+declare function logInfo(str: string): void;
+/**
+ * Internal log
+ * @param values The values to be logged.
+ */
+declare function debug(...values: Array<unknown>): void;
+/**
+ * Custom delay using the "promise hack",
+ *
+ * @param ms Amount of miliseconds to be delayed
+ */
+declare function delay(ms: number): Promise<unknown>;
+/**
+ * Return a scale size colors with a number and a measure string (KB by default).
+ *
+ * @param size The page size in KB.
+ * @param measure The measure string to be added in the log.
+ */
+declare function logPageSize(size: number, measure?: string): string;
+/**
+ * Converts milliseconds to seconds with a fixed number of decimals.
+ *
+ * @param ms The number in milliseconds.
+ * @param fixed The amount of fixed decimals.
+ * @returns The converted number in seconds with the fixed number of decimals.
+ */
+export declare function msToSec(ms: number, decimals?: number): string;
+/**
+ * Return a siteID from a response object if exist
+ * @param response A response object
+ */
+export declare function getSafeSiteId(response: APIResponses): number | undefined;
+/**
+ * Remove props from an object
+ *
+ * @param obj The object
+ * @param props An array of props to be removed
+ */
+declare function removeProperties(obj: Record<string, unknown>, props: Array<string>): void;
+/**
+ * Return a list of sites with their names and ids.
+ *
+ * @param sites An array of sites objects
+ */
+declare function siteList(sites: Array<Site>): string;
+/**
+ * Print the great Griddo Exporter logo in ASCII.
+ */
+declare function printExporterLogo(adapter: Adapters): void;
+/**
+ * Remove unused files (old) inside the `apiCache` dir
+ *
+ * @param dirPath The path for the `apiCache` dir
+ * @todo remove other file types: sites, socials, etc..
+ */
+declare function sanitizeAPICacheDir(dirPath: string): void;
+/**
+ * Measures the execution time of a series of sync or async functions.
+ * @param functions - Functions to be executed to measure their execution time.
+ * @returns A promise that resolves with the total execution time in seconds.
+ */
+declare function measureExecutionTime(...functions: Array<(...args: Array<unknown>) => unknown | Promise<any>>): Promise<number>;
+declare function pause(title: string): Promise<void> | undefined;
+declare function startLifeCycle(lifeCyleName: string): void;
+declare function successLifeCyle(value: string): void;
+/**
+ * Executes a life cycle process, which involves executing an array of
+ * functions, printing to the console, and handling errors with optional
+ * retries.
+ *
+ * @async
+ * @param args - The arguments object.
+ * @param args.steps - An array of functions to execute.
+ * @param args.name - The name of the life cycle.
+ * @param [args.attempts=1] - The number of retry attempts allowed in case of errors.
+ * @returns - A promise that resolves when the life cycle process is completed.
+ */
+declare function doLifeCycle(args: {
+    steps: Array<(...args: Array<unknown>) => unknown | Promise<any>>;
+    name: LifeCyclesNames;
+    attempts?: number;
+}): Promise<void>;
+export { CXRootDir, debug, delay, doLifeCycle, instanceRootDir, logBox, logInfo, logPageSize, measureExecutionTime, pause, printExporterLogo, removeProperties, sanitizeAPICacheDir, siteList, startLifeCycle, successLifeCyle, walk, };

package/build/utils/sites.d.ts

@@ -0,0 +1,36 @@
+import type { Site, SiteData } from "../types/sites";
+/**
+ * Check the instance sites and returns site prepared to be published and unpublished.
+ */
+declare function checkSites(domain: string): Promise<{
+    sitesToPublish: Site[];
+    sitesToUnpublish: Site[];
+}>;
+/**
+ * Unpublish an array of sites in two steps:
+ * - Sending the information to the API
+ *
+ * @param sites An array of sites
+ * @see https://griddoio.notion.site/Sites-d7bb0b7cb8d24894a5337e1139fc3d09#2019d3255bda4d219c7e19cf28d0c4fe
+ */
+declare function unpublishSites(sites: Array<Site>): Promise<void>;
+/**
+ * Return a single site generic data.
+ *
+ * @param siteID The site id.
+ * @param cacheKey Boolean that indicates if we want to get cache version.
+ *
+ * @see SiteData
+ */
+declare function getSiteData(siteID: number): Promise<SiteData>;
+/**
+ * Save a file with the end of build process
+ */
+declare function generateBuildReport(): Promise<void>;
+/**
+ * Generate sitemaps and save them into file system.
+ *
+ * @param sites An array of sites
+ */
+declare function generateSitemaps(): Promise<void>;
+export { checkSites, generateBuildReport, generateSitemaps, getSiteData, unpublishSites, };

package/build/utils/store.d.ts

@@ -0,0 +1,63 @@
+import type { BuildMetaData } from "../types/api";
+import type { RenderInfo } from "../types/global";
+import type { GriddoPageObject } from "../types/pages";
+import { Site } from "../types/sites";
+/**
+ * Read all pages stored in `store` Griddo directory and return one by one with
+ * a generator.
+ */
+declare function getBuildPages<PageType extends GriddoPageObject>(basePath: string): AsyncGenerator<PageType, void, unknown>;
+/**
+ * Get the build metadata from the Store.
+ * TODO: Refactorizar para leer un solo archivo: __metadata__.json
+ */
+declare function getBuildMetadata(): Promise<BuildMetaData>;
+/**
+ * Creates an `store` dir to store pages transformed by createStore
+ */
+declare function createStoreDir(storeDir: string): void;
+/**
+ * Write render info into a file.
+ * @param basePath - Absolute path of the dir from which files will be saved.
+ * @param renderInfo - Data that will be saved related to the render process.
+ */
+declare function saveRenderInfoInStore(basePath: string, renderInfo: RenderInfo): void;
+/**
+ * Return an array of ids only from `.json` files (no dirs) in the `basePath` dir based in the file name.
+ * @param basePath - Absolute path of the dir from which files will be read.
+ * @returns A Array<number> of pages ids in `basePath` dir.
+ */
+declare function getPageInStoreDir(basePath: string): Array<number>;
+/**
+ * Save the pages into the file system.
+ * @param basePath - Absolute path of the dir from which files will be saved.
+ * @param pages - An array of Griddo page objects to be saved.
+ */
+declare function savePagesInStore(basePath: string, pages: Array<GriddoPageObject>): void;
+/**
+ * Remove files from dir.
+ * @param basePath - Absolute path of the dir from which files will be removed.
+ * @param filenames - An array of ids representing file page names.
+ */
+declare function removePagesFromStore(basePath: string, filenames: Array<number>): void;
+/**
+ * Returns pages that need to be created or deleted for a site in the store based on the provided arguments.
+ * @param sitePages - Properties for page retrieval.
+ * @param props.storeDir - Absolute path of the Griddo store.
+ * @param props.pages - Exhaustive array of all pages in the site.
+ * @param props.validPagesIds - Array of valid pages in the site.
+ * @param props.changedPages - Array of pages that have been modified in the site.
+ * @returns - An object containing the pages to be created and deleted in the site.
+ */
+declare function getPagesToCreateOrDelete(storeDir: string, sitePages: {
+    sitesToPublish: Array<Site>;
+    pages: Array<number>;
+    validPagesIds: Array<number>;
+    changedPages: Array<number>;
+}): Promise<{
+    pagesInStore: number[];
+    pagesMissingInStore: number[];
+    pagesToDeleteFromStore: number[];
+    pagesToWriteToStore: number[];
+}>;
+export { createStoreDir, getBuildMetadata, getBuildPages, getPageInStoreDir, getPagesToCreateOrDelete, removePagesFromStore, savePagesInStore, saveRenderInfoInStore, };

package/build/utils/temp-utils.d.ts

@@ -0,0 +1,10 @@
+import { CXConfig } from "../types/global";
+declare function getConfig(): CXConfig;
+/**
+ * Update the Griddo's `/dist` dir with the contents from `public` dir only
+ * with files of type: js, json and css.
+ */
+declare function legacy__createDistFromGatsbyPublic(domain: string, needsAssetPrefix: boolean): Promise<void>;
+declare function griddoCreateInitialDirectories(domain: string): Promise<void>;
+declare function griddoCleanDisposableDirectories(domain: string): Promise<void>;
+export { getConfig, griddoCleanDisposableDirectories, griddoCreateInitialDirectories, legacy__createDistFromGatsbyPublic, };

package/{exporter/cx.config.d.ts → cx.config.d.ts}

@@ -1,6 +1,5 @@
 import { CXConfig } from "./src/types/global";
 
-declare const artifacts: readonly ["public", ".cache", "static"];
 declare const config: CXConfig;
 
 export default config;
@@ -21,4 +20,4 @@ export type Artifact =
 	| "dist"
 	| "assets";
 
-export { CXDir, artifacts };
+export { CXDir };

package/{exporter/cx.config.js → cx.config.js}

@@ -2,30 +2,28 @@ import path from "node:path";
 
 import pkgDir from "pkg-dir";
 
-import { resolveComponentsPath } from "./utils/instance";
+import { resolveComponentsPath } from "./src/utils/instance";
 
 // Paths
 const REPO_ROOT_DIR = pkgDir.sync(path.resolve(__dirname, "../.."));
 const CX_ROOT_DIR = pkgDir.sync(__dirname);
-const SSG_DIR = pkgDir.sync(__dirname);
+const SSG_DIR = path.resolve(pkgDir.sync(__dirname), "./ssg/gatsby");
 const CX_CACHE_DIR = path.resolve(CX_ROOT_DIR, "caches");
 const COMPONENTS_DIR = resolveComponentsPath();
 const EXPORTS_DIR = path.join(REPO_ROOT_DIR, "exports/sites");
 
-const artifacts = ["public", ".cache", "static"];
-
 const config = {
 	proDomain: "pro-",
 	CXDir: {
 		EXPORTS: "__exports",
-		CACHE: "__cache",
+		CACHE: "__caches",
 		CX: "__cx",
 		SSG: "__ssg",
 		COMPONENTS: "__components",
 		ROOT: "__root",
 	},
 	dirs: (domain) => ({
-		__cache: path.join(CX_CACHE_DIR, domain || ""),
+		__caches: path.join(CX_CACHE_DIR, domain || ""),
 		__components: COMPONENTS_DIR,
 		__cx: CX_ROOT_DIR,
 		__exports: path.join(EXPORTS_DIR, domain || ""),
@@ -36,5 +34,4 @@ const config = {
 
 export default config;
 const CXDir = config.CXDir;
-
-export { CXDir, artifacts };
+export { CXDir };

package/package.json

@@ -1,14 +1,13 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "10.4.12",
+	"version": "10.4.13",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
 		"Francis Vega <francis.vega@secuoyas.com>",
 		"Gonzalo Hernández <gonzalo.hernandez@secuoyas.com>",
-		"Sergio Ródenas <sergio.rodenas@secuoyas.com>",
-		"Txema León <txema.leon@secuoyas.com>"
+		"Sergio Ródenas <sergio.rodenas@secuoyas.com>"
 	],
 	"license": "UNLICENSED",
 	"homepage": "https://griddo.io",
@@ -17,31 +16,31 @@
 		"url": "https://github.com/griddo/griddo"
 	},
 	"bin": {
-		"griddo-cx": "./index.js"
+		"griddo-cx": "./start-render.js"
 	},
 	"scripts": {
-		"build": "yarn build:exporter && yarn build:reset-render && yarn build:build-complete && yarn build:create-build-data",
-		"build:exporter": "esbuild ./exporter/index.ts --bundle --platform=node --minify --outfile=./build/index.js",
-		"build:build-complete": "esbuild ./exporter/build-complete.ts --bundle --platform=node --minify --outfile=./build/build-complete.js",
-		"build:reset-render": "esbuild ./exporter/reset-render.ts --bundle --platform=node --minify --outfile=./build/reset-render.js",
-		"build:create-build-data": "esbuild ./exporter/create-build-data.ts --bundle --platform=node --minify --outfile=./build/create-build-data.js",
-		"clean": "gatsby clean; rm -rf .cache public assets dist build store",
-		"export": "yarn build && yarn download:data && yarn gatsby-build",
-		"gatsby-build": "gatsby telemetry --disable && gatsby build --prefix-paths",
+		"build": "yarn build:exporter && yarn build:reset-render && yarn build:build-complete && yarn build:start-render && yarn build:run-start-render && yarn build:browser && yarn build:types",
+		"build:exporter": "esbuild ./src/index.ts --bundle --platform=node --minify --outfile=./build/index.js",
+		"build:build-complete": "esbuild ./src/build-complete.ts --bundle --platform=node --minify --outfile=./build/build-complete.js",
+		"build:reset-render": "esbuild ./src/reset-render.ts --bundle --platform=node --minify --outfile=./build/reset-render.js",
+		"build:start-render": "esbuild ./src/start-render.ts --bundle --platform=node --minify --outfile=./build/start-render.js",
+		"build:run-start-render": "esbuild ./src/run-start-render.ts --bundle --platform=node --minify --outfile=./build/run-start-render.js",
+		"build:browser": "esbuild ./src/browser/index.ts --platform=node --bundle --minify --outfile=./build/browser/index.js",
+		"build:types": "npx tsc --emitDeclarationOnly --declaration --outDir build --project tsconfig.json",
 		"export:complete": "node ./build/build-complete.js",
 		"export:reset": "node ./build/reset-render.js",
 		"prepare": "yarn run build",
 		"watch:tscheck": "tsc --noEmit --watch",
 		"complete-render": "node ./build/build-complete.js",
-		"reset-render": "node ./build/reset-render.js",
-		"download:data": "node ./build/create-build-data.js"
+		"reset-render": "node ./build/reset-render.js"
 	},
 	"dependencies": {
 		"@babel/core": "^7.21.0",
-		"@babel/plugin-proposal-class-properties": "^7.7.4",
+		"@babel/plugin-transform-class-properties": "^7.24.1",
 		"@babel/preset-env": "^7.14.5",
 		"@babel/preset-react": "^7.14.5",
 		"@babel/preset-typescript": "^7.16.5",
+		"@griddo/core": "^10.4.13",
 		"@svgr/webpack": "^5.5.0",
 		"babel-loader": "^8.0.6",
 		"babel-plugin-styled-components": "^1.10.7",
@@ -51,9 +50,7 @@
 		"dotenv": "^8.1.0",
 		"find-up": "^5.0.0",
 		"fs-extra": "^9.0.1",
-		"gatsby": "^4.8.0",
-		"gatsby-plugin-react-helmet": "^5.8.0",
-		"gatsby-plugin-svgr-loader": "^0.1.0",
+		"gatsby": "file:./ssg/gatsby",
 		"gradient-string": "^2.0.2",
 		"html-react-parser": "^1.4.10",
 		"js2xmlparser": "^4.0.1",
@@ -86,19 +83,14 @@
 		"node": ">=16.17.0"
 	},
 	"files": [
-		".babelrc",
-		"build",
-		"gatsby-browser.tsx",
-		"gatsby-config.ts",
-		"gatsby-node.ts",
-		"gatsby-ssr.tsx",
-		"exporter",
-		"index.js",
 		"src",
-		"static"
+		"ssg",
+		"build",
+		"start-render.js",
+		"cx.config.js",
+		"cx.config.d.ts"
 	],
 	"keywords": [
-		"gatsby",
 		"griddo",
 		"secuoyas",
 		"typescript",
@@ -110,5 +102,5 @@
 	"resolutions": {
 		"memoizee": "0.4.15"
 	},
-	"gitHead": "0e1a43fd246d2a955b9d4040c1489ff733f4ed5e"
+	"gitHead": "860786a44231619fd5c046df325e77e5e183d289"
 }

package/src/adapters/gatsby/index.ts

@@ -0,0 +1,219 @@
+import { spawnSync } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+
+import { attempts, getGatsbyAssetPrefixSlug } from "./utils";
+import { RobotsService } from "../../services/robots";
+import { createBuildData } from "../../utils/create-build-data";
+import { getInstanceDomains } from "../../utils/domains";
+import {
+	clearEmptyDirs,
+	copyDirsSync,
+	createDirsSync,
+	moveDirsSync,
+	removeDirsSync,
+	removeVirtualPagesFromStore,
+} from "../../utils/folders";
+import { uploadSearchContentToAPI } from "../../utils/searches";
+import {
+	doLifeCycle,
+	logBox,
+	pause,
+	printExporterLogo,
+} from "../../utils/shared";
+import { generateBuildReport, generateSitemaps } from "../../utils/sites";
+import {
+	getConfig,
+	legacy__createDistFromGatsbyPublic,
+} from "../../utils/temp-utils";
+
+async function runGatsbyAdapter() {
+	printExporterLogo("gatsby");
+
+	const domains = await getInstanceDomains();
+	const config = getConfig();
+
+	for (const domain of domains) {
+		const {
+			__ssg: __gatsby,
+			__exports,
+			__caches,
+			__cx,
+			__components,
+		} = config.dirs(domain);
+
+		logBox(`Initializing render for the domain ${domain}`, "", 1, 0);
+
+		const assetPrefix = getGatsbyAssetPrefixSlug(domain);
+		const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
+		const shouldUploadSearchData = JSON.parse(
+			process.env.GRIDDO_SEARCH_FEATURE || "false"
+		);
+
+		/*
+		 * Clean LifeCycle.
+		 *
+		 * We first secure the stage by removing artifacts from previous failed
+		 * render. Both, griddo and gatsby artifacts.
+		 */
+		await doLifeCycle({
+			name: "Clean",
+			attempts: attempts.clean,
+			steps: [
+				() => removeDirsSync(__cx, ["store", "apiCache", "dist"]),
+				() => removeDirsSync(__gatsby, ["dist", "public", "static", ".cache"]),
+				() => pause("Clean LifeCycle"),
+			],
+		});
+
+		/*
+		 * Prepare LifeCycle.
+		 *
+		 * We prepare the stage creating necessary directories: exports and
+		 * caches.
+		 */
+		await doLifeCycle({
+			name: "Prepare",
+			attempts: attempts.prepare,
+			steps: [
+				() => createDirsSync([__exports]),
+				() => createDirsSync([__caches]),
+				() => pause("Prepare LifeCycle"),
+			],
+		});
+
+		/*
+		 * Restore LifeCycle.
+		 */
+		await doLifeCycle({
+			name: "Restore",
+			attempts: attempts.restore,
+			steps: [
+				// Copy instance static directory into the gatsby one.
+				() => copyDirsSync(__components, __gatsby, ["static"]),
+				() => copyDirsSync(__exports, __cx, ["assets"]),
+				() => copyDirsSync(__exports, __gatsby, ["dist"]),
+				// Renames dist to public.
+				// En este paso de dist to public también se sacan los "assets"
+				// de public si el dominio es "pro-". Este proceso es sacar
+				// elementos del public y guardarlos en una carpeta "assets"
+				// para que infra los suba un subdominio.
+				() => {
+					if (fs.existsSync(path.join(__gatsby, "dist"))) {
+						fs.renameSync(
+							path.join(__gatsby, "dist"),
+							path.join(__gatsby, "public")
+						);
+					}
+				},
+				() => moveDirsSync(__caches, __cx, ["apiCache", "store"]),
+				() => moveDirsSync(__caches, __gatsby, [".cache"]),
+				() => pause("Restore LifeCycle"),
+			],
+		});
+
+		/*
+		 * Data LifeCycle.
+		 */
+		await doLifeCycle({
+			name: "Data",
+			attempts: attempts.data,
+			steps: [
+				// API -> Store
+				() => createBuildData(domain),
+				() => pause("Data LifeCycle"),
+			],
+		});
+
+		/*
+		 * SSG LifeCycle.
+		 */
+		await doLifeCycle({
+			name: "SSG",
+			attempts: attempts.ssg,
+			steps: [
+				() =>
+					// Run Gatsby
+					spawnSync("yarn", ["gatsby-build"], {
+						cwd: __gatsby,
+						stdio: ["ignore", "inherit", "ignore"],
+						encoding: "utf8",
+						shell: true,
+						env: Object.assign(process.env, {
+							GRIDDO_EXPORTER: "true",
+							GRIDDO_ASSET_PREFIX: assetPrefix,
+						}),
+					}),
+				() => pause("SSG LifeCycle"),
+			],
+		});
+
+		/*
+		 * Relocation LifeCycle.
+		 */
+		await doLifeCycle({
+			name: "Relocation",
+			steps: [
+				() => legacy__createDistFromGatsbyPublic(domain, needsAssetPrefix),
+				() => pause("Relocation LifeCycle"),
+			],
+		});
+
+		/*
+		 * Meta LifeCycle.
+		 */
+		await doLifeCycle({
+			name: "Meta",
+			attempts: attempts.meta,
+			steps: [
+				() => generateBuildReport(),
+				() => RobotsService.writeFiles(domain),
+				() => generateSitemaps(),
+				() => (shouldUploadSearchData ? uploadSearchContentToAPI() : undefined),
+				() => pause("Meta LifeCycle"),
+			],
+		});
+
+		/*
+		 * Archive LifeCycle.
+		 */
+		await doLifeCycle({
+			name: "Archive",
+			attempts: attempts.archive,
+			steps: [
+				// Elimina las páginas de MultiPages y de templates de listados
+				// estáticos (mode: list) del `store`. De este modo nos
+				// aseguramos que se vuelven a crear por Gatsby siempre
+				// actualizadas. Esto es debido a que estas páinas son creadas
+				// en el contexto de CX y no tienen id único por lo que no son
+				// tenidas en cuenta por la API y por lo tanto escapan a la
+				// lógica de `changedPages` y la persistencia del store.
+				() => removeVirtualPagesFromStore(),
+				// Eliminamos carpetas vacías que puedan quedar de sites
+				// despublicados. Incluye aquellas que solo tengan archivos .xml
+				() => clearEmptyDirs(),
+				() =>
+					moveDirsSync(__cx, __exports, ["dist", "assets"], {
+						withBackup: true,
+					}),
+				() => moveDirsSync(__cx, __caches, ["apiCache", "store"]),
+				() => moveDirsSync(__gatsby, __caches, [".cache"]),
+				() => pause("Archive LifeCycle"),
+			],
+		});
+
+		/*
+		 * Clean LifeCycle.
+		 */
+		await doLifeCycle({
+			name: "Clean",
+			steps: [
+				() => removeDirsSync(__gatsby, ["static", "public", "dist"]),
+				() => pause("Clean LifeCycle"),
+			],
+			attempts: attempts.clean,
+		});
+	}
+}
+
+export { runGatsbyAdapter };

package/src/adapters/gatsby/utils.ts

@@ -0,0 +1,85 @@
+import { Fields } from "@griddo/core";
+import dotenv from "dotenv";
+
+import { getConfig } from "../../utils/temp-utils";
+
+dotenv.config();
+
+const attempts = {
+	prepare: JSON.parse(process.env.GRIDDO_PREPARE_LIFECYCLE_MAX_ATTEMPTS || "1"),
+	restore: JSON.parse(process.env.GRIDDO_RESTORE_LIFECYCLE_MAX_ATTEMPTS || "1"),
+	data: JSON.parse(process.env.GRIDDO_DATA_LIFECYCLE_MAX_ATTEMPTS || "1"),
+	ssg: JSON.parse(process.env.GRIDDO_SSG_LIFECYCLE_MAX_ATTEMPTS || "1"),
+	relocation: JSON.parse(
+		process.env.GRIDDO_RELOCATION_LIFECYCLE_MAX_ATTEMPTS || "1"
+	),
+	meta: JSON.parse(process.env.GRIDDO_META_LIFECYCLE_MAX_ATTEMPTS || "1"),
+	archive: JSON.parse(process.env.GRIDDO_ARCHIVE_LIFECYCLE_MAX_ATTEMPTS || "1"),
+	clean: JSON.parse(process.env.GRIDDO_CLEAN_LIFECYCLE_MAX_ATTEMPTS || "1"),
+};
+
+/**
+ * Return the assetPrefix url `assetPrefix/domain`
+ */
+function getGatsbyAssetPrefixSlug(domain: string) {
+	const { proDomain } = getConfig();
+	const assetPrefix =
+		process.env.GRIDDO_ASSET_PREFIX || process.env.ASSET_PREFIX;
+
+	if (!assetPrefix || !domain) return "";
+	if (!domain.startsWith(proDomain)) return "";
+
+	return `${assetPrefix}/${domain}`;
+}
+
+/**
+ * Format Cloudinary or DAM URL
+ *
+ * @param image The image url
+ * @param width With of the image
+ * @param height Height of the image
+ * @param format Format of the image
+ * @returns A composed URL for the Cloudinary or DAM service
+ */
+function formatImage(
+	image: Fields.Image | string,
+	width: number,
+	height: number,
+	format = "jpg"
+) {
+	const url = typeof image === "string" ? image : image?.url;
+
+	if (!url) {
+		return null;
+	}
+
+	const isCloudinary = url.split("/")[2].includes("cloudinary.com");
+
+	return isCloudinary
+		? addCloudinaryParams(url, `c_fill,w_${width},h_${height}`)
+		: addGriddoDamParams(url, `f/${format}/w/${width}/h/${height}`);
+}
+
+/**
+ * Format Griddo DAM image url.
+ */
+function addGriddoDamParams(image: string, params: string) {
+	const urlParts = image.split("/");
+	const imagePath = urlParts.slice(0, -1).join("/");
+	const imageName = urlParts.slice(-1)[0];
+
+	return `${imagePath}/${params}/${imageName}`;
+}
+
+/**
+ * Take a cloudinary url and add query params.
+ */
+function addCloudinaryParams(image: string, params: string) {
+	const plainUrl = image.replace("https://", "");
+	const head = plainUrl.split("/").slice(0, 4).join("/");
+	const fullId = plainUrl.replace(head, "");
+
+	return `https://${head}/${params}${fullId}`;
+}
+
+export { attempts, formatImage, getGatsbyAssetPrefixSlug };