npm - @griddo/cx - Versions diffs - 1.75.178 → 1.75.180 - Mend

@griddo/cx 1.75.178 → 1.75.180

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (72) hide show

package/README.md +22 -14
package/build/index.js +49 -0
package/gatsby-browser.tsx +140 -0
package/gatsby-config.ts +40 -0
package/gatsby-node.ts +130 -0
package/gatsby-ssr.tsx +63 -0
package/index.js +4 -0
package/package.json +119 -100
package/scripts/build-reset.ts +9 -0
package/scripts/griddo-exporter.ts +302 -0
package/src/components/Head.tsx +207 -0
package/src/components/template.tsx +90 -0
package/src/components/types.ts +35 -0
package/src/components/utils.ts +138 -0
package/src/html.tsx +31 -0
package/src/services/auth.ts +64 -0
package/src/services/distributors.ts +153 -0
package/src/services/domains.ts +27 -0
package/src/services/navigation.ts +169 -0
package/src/services/robots.ts +64 -0
package/src/services/settings.ts +52 -0
package/src/services/sites.ts +199 -0
package/src/services/store-with-for-loop.ts +513 -0
package/src/services/store-with-promise-all.ts +515 -0
package/src/services/store.ts +513 -0
package/src/types/api.ts +155 -0
package/src/types/global.ts +72 -0
package/src/types/navigation.ts +25 -0
package/src/types/pages.ts +145 -0
package/src/types/sites.ts +64 -0
package/src/types/templates.ts +11 -0
package/src/utils/api.ts +326 -0
package/src/utils/cache.ts +114 -0
package/src/utils/domains.ts +32 -0
package/src/utils/folders.ts +147 -0
package/src/utils/instance.ts +71 -0
package/src/utils/pages.ts +534 -0
package/src/utils/searches.ts +102 -0
package/src/utils/shared.ts +131 -0
package/src/utils/sites.ts +280 -0
package/.babelrc +0 -7
package/LICENSE +0 -1
package/gatsby-browser.js +0 -115
package/gatsby-config.js +0 -38
package/gatsby-node.js +0 -273
package/gatsby-ssr.js +0 -43
package/scripts/griddo-exporter.js +0 -133
package/src/api/index.js +0 -172
package/src/components/template.js +0 -261
package/src/html.js +0 -30
package/src/images/readme.md +0 -1
package/src/scripts/build-reset.js +0 -12
package/src/services/auth.js +0 -44
package/src/services/distributors.js +0 -85
package/src/services/domains.js +0 -16
package/src/services/navigation.js +0 -104
package/src/services/robots.js +0 -37
package/src/services/settings.js +0 -25
package/src/services/sites.js +0 -110
package/src/utils/cache.js +0 -70
package/src/utils/component-lib-helpers.js +0 -56
package/src/utils/dataLayer.js +0 -47
package/src/utils/delay.js +0 -5
package/src/utils/domains.js +0 -24
package/src/utils/folders.js +0 -123
package/src/utils/helpers.js +0 -144
package/src/utils/index.js +0 -44
package/src/utils/package.js +0 -20
package/src/utils/pages.js +0 -236
package/src/utils/searches.js +0 -62
package/src/utils/sites.js +0 -207
package/static/griddo-full-logo.png +0 -0

package/src/components/utils.ts ADDED Viewed

@@ -0,0 +1,138 @@
+// Only browser environment code
+//
+// Don't write node code (fs, path, etc..) in this folder because is imported by
+// `template.tsx` in a browser environment and node doesn't exists.
+// If yo do that the render process will be break in the SSR build process
+//
+// Browserify doesn't work with the mixture of typescript + webpack 5 + SSR
+// Types
+import type { Fields } from "@griddo/core";
+/**
+ * Sanitize a string separated by commas.
+ */
+function cleanCommaSeparated(str: string) {
+	return str
+		.split(",")
+		.map((item) => item.trim())
+		.filter(Boolean)
+		.join(",");
+}
+/**
+ * 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}`;
+}
+/**
+ * TODO: JSDoc
+ */
+function composeAnalytics(
+	page: {
+		pageContext: {
+			siteScript: string;
+			page: {
+				dimensions: {
+					// TODO: Type dimensions / remove any
+					values: any;
+				};
+			};
+		};
+	},
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	generateAutomaticDimensions = (page: Record<string, unknown>) => {
+		return null;
+	}
+) {
+	const {
+		pageContext: {
+			siteScript: siteScriptBulk,
+			page: { dimensions },
+		},
+	} = page;
+	const analyticsScript = siteScriptBulk ? siteScriptBulk.trim() : "";
+	// Las dimensiones o DataLayer
+	const dynamicValuePrefix = "__SCRIPT:";
+	const dimensionValues = dimensions?.values || {};
+	const automaticDimensionValues = generateAutomaticDimensions
+		? generateAutomaticDimensions(page)
+		: {};
+	const allDimensionsValues = {
+		...dimensionValues,
+		...automaticDimensionValues,
+	};
+	const allDimensions = [];
+	for (const dimension of Object.keys(allDimensionsValues)) {
+		const dimensionValue = allDimensionsValues[dimension];
+		allDimensions.push(
+			`"${dimension}":${
+				dimensionValue?.startsWith(dynamicValuePrefix)
+					? `${dimensionValue.slice(
+							dynamicValuePrefix.length,
+							dimensionValue.endsWith(";") ? -1 : dimensionValue.length
+					  )}`
+					: `"${dimensionValue}"`
+			}`
+		);
+	}
+	const analyticsDimensions = allDimensions.length
+		? `{${allDimensions.join(",")}}`
+		: null;
+	return {
+		analyticsScript,
+		analyticsDimensions,
+	};
+}
+export { cleanCommaSeparated, composeAnalytics, formatImage };

package/src/html.tsx ADDED Viewed

@@ -0,0 +1,31 @@
+import * as React from "react";
+import type { HtmlProps } from "./components/types";
+export default function HTML(props: HtmlProps) {
+	return (
+		<html {...props.htmlAttributes}>
+			<head>
+				<meta charSet="utf-8" />
+				<meta httpEquiv="x-ua-compatible" content="ie=edge" />
+				<meta
+					name="viewport"
+					content="width=device-width, initial-scale=1, shrink-to-fit=no"
+				/>
+				{props.headComponents}
+			</head>
+			<body {...props.bodyAttributes}>
+				{props.preBodyComponents}
+				<noscript key="noscript" id="gatsby-noscript">
+					This app works best with JavaScript enabled.
+				</noscript>
+				<div
+					key={"body"}
+					id="___gatsby"
+					dangerouslySetInnerHTML={{ __html: props.body }}
+				/>
+				<div id="modal" />
+				{props.postBodyComponents}
+			</body>
+		</html>
+	);
+}

package/src/services/auth.ts ADDED Viewed

@@ -0,0 +1,64 @@
+// External libraries
+import axios from "axios";
+import chalk from "chalk";
+/**
+ * Service for authentication in the Griddo Private API
+ */
+class AuthService {
+	user: string | undefined;
+	password: string | undefined;
+	baseUrl: string | undefined;
+	headers:
+		| { Authorization: string; "Cache-Control": string; lang?: string }
+		| undefined;
+	constructor() {
+		this.user = process.env.botEmail;
+		this.password = process.env.botPassword;
+		this.baseUrl = process.env.API_URL;
+	}
+	async login() {
+		try {
+			const response = await axios({
+				url: `${this.baseUrl}/login_check`,
+				method: "POST",
+				headers: {
+					"Content-Type": "application/json",
+				},
+				data: {
+					username: this.user,
+					password: this.password,
+				},
+			});
+			if (response.status === 200) {
+				const {
+					data: { token },
+				} = response;
+				this.headers = {
+					Authorization: "bearer " + token,
+					"Cache-Control": "no-store",
+				};
+			}
+			console.log("👋 Login\n");
+		} catch (e) {
+			console.error(
+				chalk.red(`
+╭────────────────────────────────────────────────────────────╮
+│ Access credentials failure                                 │
+│ Check that the login details are correct in your .env file │
+╰────────────────────────────────────────────────────────────╯
+`)
+			);
+			process.exit(1);
+		}
+	}
+}
+const authService = new AuthService();
+export { authService as AuthService };

package/src/services/distributors.ts ADDED Viewed

@@ -0,0 +1,153 @@
+// Types
+import type { Core, Fields } from "@griddo/core";
+import type { FetchDataProps } from "../types/global";
+import type { APIPageObject } from "../types/pages";
+// Utils
+import { logBox } from "../utils/shared";
+// Services
+import { SitesService } from "./sites";
+/**
+ * Service to work with distributors.
+ */
+class DistributorService {
+	/**
+	 * Get the body data from a ReferenceField in auto or manual mode.
+	 * @param data The ReferenceField props.
+	 * @returns The props for one of the ReferenceField mode.
+	 */
+	static getBody(data: Fields.Reference<unknown>) {
+		const {
+			order,
+			source,
+			quantity,
+			mode,
+			fixed,
+			filter,
+			fullRelations = false,
+			allLanguages = false,
+		} = data;
+		return mode === "auto"
+			? {
+					mode,
+					order,
+					source,
+					quantity,
+					filter,
+					fullRelations,
+					allLanguages,
+			  }
+			: {
+					mode,
+					fixed,
+					fullRelations,
+			  };
+	}
+	/**
+	 * Gets ContentType data from API
+	 *
+	 * @param props
+	 * @param props.page The Page object
+	 * @param props.component.data The ReferenceField, always in the data prop.
+	 * @param props.cached Boolean that indicates cache use.
+	 * @returns The Content Type data.
+	 */
+	static async fetchContentTypeData(props: FetchDataProps) {
+		const {
+			page,
+			component: { data },
+			cached,
+		} = props;
+		// Distrubutor with `hasDistributorDat: true` but without `data` prop
+		if (!data) {
+			logBox(
+				`Error: Page ${page.id} has \`hasDistributorData: true\` but it doesn't have a \`data\` prop`
+			);
+			return [];
+		}
+		const body = this.getBody(data);
+		const response = await SitesService.getDistributorData(page, body, cached);
+		return response;
+	}
+	/**
+	 * Compose the queriedItems prop from a distributor data of a page.
+	 *
+	 * @param props
+	 * @param props.page The APIPage object
+	 * @param props.cached Boolean that indicates cache use.
+	 */
+	static async getDistributorData({
+		page,
+		cached = false,
+	}: {
+		page: APIPageObject;
+		cached: boolean;
+	}) {
+		try {
+			const { template } = page;
+			const checkDistributors = async (
+				// No puede ser Core.Page['template'] porque a medida que va bajando en
+				// el árbol ya no es la estructura de un template.
+				templateChunk: Record<string, any>, // Core.Page['template'],
+				level = 1
+			) => {
+				// If it doesn't a "template strcuture"
+				if (!templateChunk || typeof templateChunk !== "object") return;
+				// If doesn't have `hasDistributorData: true`
+				if (
+					!JSON.stringify(templateChunk).includes('"hasDistributorData":true')
+				) {
+					return;
+				}
+				// For each prop in the "template"
+				for (const key in templateChunk) {
+					// Si la key es `queriedItems` saltamos al siguiente `key`
+					if (key === "queriedItems") continue;
+					const component = templateChunk[key];
+					// Si el elemento no existe o no es un objeto saltamos al siguiente `key`
+					if (!component || typeof component !== "object") continue;
+					// Si el elemento tiene la prop `hasDistributorData: true` hacemos el fetch
+					if (component.hasDistributorData) {
+						component.queriedItems = await this.fetchContentTypeData({
+							page,
+							component,
+							cached,
+						});
+					}
+					await checkDistributors(component, level + 1);
+				}
+			};
+			const getDistributors = async (template: Core.Page["template"]) => {
+				await checkDistributors([template]); // ==> En array para que también revise la propia template como objeto.
+				return template;
+			};
+			const response = await getDistributors(template);
+			return response;
+		} catch (err) {
+			console.error(`Error en get distributor ${err}`);
+			process.exit(1);
+		}
+	}
+}
+export { DistributorService };

package/src/services/domains.ts ADDED Viewed

@@ -0,0 +1,27 @@
+// Types
+import type { Domains } from "../types/global";
+// Utils
+import { get } from "../utils/api";
+// Envs
+const API_URL = process.env.API_URL;
+// Constants
+const ENDPOINTS = {
+	GET_ALL: `${API_URL}/domains`,
+};
+/**
+ * Get an array of domains availables.
+ */
+class DomainsService {
+	static async getAll() {
+		const { GET_ALL } = ENDPOINTS;
+		const response = await get<Domains>({ endpoint: GET_ALL });
+		return response;
+	}
+}
+export { DomainsService };

package/src/services/navigation.ts ADDED Viewed

@@ -0,0 +1,169 @@
+// Types
+import type { Footer, Header } from "../types/navigation";
+import type { APIPageObject } from "../types/pages";
+/**
+ * TODO: JSDoc
+ */
+class NavigationService {
+	private _defaultHeaders: Record<string, Header>;
+	private _defaultFooters: Record<string, Footer>;
+	private _navigations: {
+		headers: Array<Header>;
+		footers: Array<Footer>;
+	};
+	constructor() {
+		this._navigations = {
+			footers: [],
+			headers: [],
+		};
+		this._defaultHeaders = {};
+		this._defaultFooters = {};
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	set navigations(navigations) {
+		this._navigations = navigations;
+		this._defaultFooters = this.getDefaultFooters();
+		this._defaultHeaders = this.getDefaultHeaders();
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	get navigations() {
+		return this._navigations;
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	getDefaultFooters() {
+		const safeFooters = [...this.navigations.footers];
+		const defaultFooters = safeFooters.filter(
+			(footer) => !!footer.setAsDefault
+		);
+		const defaultFootersByLang = defaultFooters.reduce((prev, footer) => {
+			const { language } = footer;
+			return { ...prev, [language]: footer };
+		}, {});
+		return defaultFootersByLang;
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	getDefaultHeaders() {
+		const safeHeaders = [...this.navigations.headers];
+		const defaultHeaders = safeHeaders.filter(
+			(header) => !!header.setAsDefault
+		);
+		const defaultHeadersByLang = defaultHeaders.reduce((prev, header) => {
+			const { language } = header;
+			return { ...prev, [language]: header };
+		}, {});
+		return defaultHeadersByLang;
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	getRightLanguage(
+		list: Array<{
+			language: number;
+			navigationLanguages: Array<{ navigationId: number }>;
+			id: number;
+		}>,
+		id: number,
+		language: number
+	) {
+		if (!list || !id) {
+			return null;
+		}
+		const rightLanguageItem = list.find(
+			(item) =>
+				item.language === language &&
+				item.navigationLanguages?.find((version) => version.navigationId === id)
+		);
+		const result = rightLanguageItem || list.find((item) => item.id === id);
+		return result ? { ...result } : null;
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	getPageHeader(id: number, language: number) {
+		return this.getRightLanguage(this.navigations.headers, id, language);
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	getPageFooter(id: number, language: number) {
+		return this.getRightLanguage(this.navigations.footers, id, language);
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	getPageNavigations(page: APIPageObject) {
+		const {
+			header: pageHeader,
+			footer: pageFooter,
+			language,
+			template: { templateType },
+			templateConfig: { defaultHeader, defaultFooter, templates },
+		} = page;
+		// The navigations would be:
+		// - The one with the page or ...
+		// - The one defined for that template or ...
+		// - The one you have defined for that data package
+		const getValidNavigation = (values: Array<number | unknown>) => {
+			const fineNavigation = values.find((item) => typeof item === "number");
+			return typeof fineNavigation === "number" ? fineNavigation : null;
+		};
+		const headerID = getValidNavigation([
+			pageHeader,
+			templates?.[templateType]?.defaultHeader,
+			defaultHeader,
+		]);
+		const footerID = getValidNavigation([
+			pageFooter,
+			templates?.[templateType]?.defaultFooter,
+			defaultFooter,
+		]);
+		const header = headerID
+			? this.getPageHeader(headerID, language)
+			: headerID === 0
+			? null
+			: this._defaultHeaders[language];
+		const footer = footerID
+			? this.getPageFooter(footerID, language)
+			: footerID === 0
+			? null
+			: this._defaultFooters[language];
+		return {
+			header,
+			footer,
+		} as { header: Header; footer: Footer };
+	}
+}
+export { NavigationService };

package/src/services/robots.ts ADDED Viewed

@@ -0,0 +1,64 @@
+// Types
+import type { Robots } from "../types/global";
+// External libraries
+import fs from "fs";
+import path from "path";
+// Utils
+import { get } from "../utils/api";
+/**
+ * TODO: JSDoc
+ */
+class RobotsService {
+	robots: Robots;
+	baseURL: string | undefined;
+	settings: Record<string, unknown>;
+	endpoint: string;
+	constructor() {
+		this.robots = [];
+		this.baseURL = process.env.API_URL;
+		this.settings = {};
+		this.endpoint = `${this.baseURL}/domains/robots`;
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	async loadRobots() {
+		try {
+			const apiRobots = await get<Robots>({
+				endpoint: this.endpoint,
+			});
+			this.robots =
+				apiRobots
+					?.filter((r) => !!r.path)
+					.map(({ path, content }) => ({
+						path,
+						content: content || "User-agent: *\n\r\n\rAllow: /",
+					})) || [];
+		} catch (e) {
+			console.warn(`${this.constructor.name}: ${(e as Error).message}`);
+		}
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	async writeFiles(basePath = "") {
+		for (const robot of this.robots) {
+			const basePathLocation = path.join(basePath, robot.path);
+			const fileLocation = path.join(basePathLocation, "robots.txt");
+			if (fs.existsSync(basePathLocation)) {
+				fs.writeFileSync(fileLocation, robot.content);
+			}
+		}
+	}
+}
+const robotsService = new RobotsService();
+export { robotsService as RobotsService };

package/src/services/settings.ts ADDED Viewed

@@ -0,0 +1,52 @@
+// Types
+import type { Settings } from "../types/global";
+// Utils
+import { get, post } from "../utils/api";
+/**
+ * TODO: JSDoc
+ */
+class SettingsService {
+	baseURL?: string;
+	settings: Settings;
+	ENDPOINTS: { settings: string; resetRender: string };
+	constructor() {
+		this.baseURL = process.env.API_URL;
+		this.settings = {
+			cloudinaryName: "",
+			useMetaTitle: false,
+			showBasicMetaRobots: false,
+			avoidHrefLangsOnCanonicals: false,
+			avoidSelfReferenceCanonicals: false,
+			avoidHrefLangXDefault: false,
+			avoidDebugMetas: false,
+		};
+		this.ENDPOINTS = {
+			settings: `${this.baseURL}/settings`,
+			resetRender: `${this.baseURL}/debug/reset-render`,
+		};
+	}
+	/**
+	 * Get settings for a full domain render.
+	 */
+	async getAll() {
+		const { settings } = this.ENDPOINTS;
+		const response = await get<Settings>({ endpoint: settings });
+		this.settings = response;
+	}
+	/**
+	 * TODO: JSDoc
+	 */
+	async resetRender() {
+		const { resetRender } = this.ENDPOINTS;
+		await post({ endpoint: resetRender });
+	}
+}
+const settingsService = new SettingsService();
+export { settingsService as SettingsService };