@griddo/cx 11.9.17 → 11.10.0

package/build/utils/alerts.d.ts

@@ -1,3 +0,0 @@
-import type { GriddoAlertRegisterProps } from "@griddo/core";
-declare function insertAlert({ area, description, fullData, instantNotification, level, }: Omit<GriddoAlertRegisterProps, "publicApiUrl">): Promise<void>;
-export { insertAlert };

package/build/utils/cache.d.ts

@@ -1,35 +0,0 @@
-import type { Petition } from "../types/global";
-import type { SiteHash } from "../types/sites";
-/**
- * Creates an `apiCache` dir to store pages fetched from them API.
- */
-declare function createAPICacheDir(): void;
-/**
- * Generate a filename with a hash using a string.
- *
- * @todo Merge with generateFilenameWithHash
- * @param data A string to create a sha256 based on.
- */
-declare function createSha256(data: string): string;
-/**
- * Save a file using a hash name.
- *
- * @param petition An object.
- * @param content Content to be saved.
- */
-declare function saveCache<T>(petition: Petition, content: T): void;
-/**
- * Search in the `apiCache` dir for a file using the petition as hash generator.
- * Return the file content if found or null if not.
- *
- * @param petition An object
- */
-declare function searchCacheData<T>(petition: Petition): T | null;
-/**
- * Update (write) the site hash file.
- *
- * @param siteId The id of the site.
- * @param siteHash The has of the site.
- */
-declare function updatedSiteHash(siteId: number, siteHash: SiteHash): string;
-export { createAPICacheDir, createSha256, saveCache, searchCacheData, updatedSiteHash, };

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

@@ -1,107 +0,0 @@
-import type { APIResponses } from "../types/api";
-import type { CXConfig, LifeCyclesNames, LifeCycleSteps } from "../types/global";
-declare const instanceRootDir: string;
-/**
- * Returns the configuration file content.
- *
- * @example
- * const config = getConfig()
- * const { __cx } = config.paths()
- * const { griddoVersion, proDomain } = config
- */
-declare function getConfig(): CXConfig;
-/**
- * Returns true for "true", "on", true and positive numbers.
- * Returns false for "false", "off", false, 0, negative integers and anything else.
- */
-declare function isTruthy(value: any): boolean;
-/**
- * Walk a directory and returns the file pathts.
- *
- * @param dir A directory path.
- */
-declare function walk(dir: string): string[];
-/**
- * Walk a directory and returns the JSON file absolute paths with one level of depth.
- * Bypass the `metadata` folder.
- * /abs/.../sotre/<siteId>/jsonfile.json
- * /abs/.../sotre/<siteId>/jsonfile.json
- * /abs/.../sotre/<siteId>/jsonfile.json
- * /abs/.../sotre/<siteId>/jsonfile.json
- */
-declare function walkStore(dir: string): Array<string>;
-/**
- * Custom delay using the "promise hack",
- *
- * @param ms Amount of miliseconds to be delayed
- */
-declare function delay(ms: number): Promise<unknown>;
-/**
- * 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.
- */
-declare function msToSec(ms: number, decimals?: number): string;
-/**
- * Return a siteID from a response object if exist
- * @param response A response object
- */
-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;
-/**
- * Remove unused files (old) inside the `apiCache` dir
- *
- * @todo remove other file types: sites, socials, etc..
- */
-declare function sanitizeAPICacheDir(): void;
-/**
- * Measures the execution time of a series of sync or async functions.
- *
- * @async
- * @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<unknown>>): Promise<number>;
-/**
- * Pause the process until a key is pressed.
- *
- * @param title
- * @returns
- */
-declare function pause(title: string): Promise<void> | undefined;
-/**
- * Executes a life cycle process, which involves executing an array of
- * functions, printing to the console, and handling errors with optional
- * retries.
- *
- * @async
- * @param name - The name of the life cycle.
- * @param options - The arguments object.
- * @param options.steps - An array of functions to execute.
- * @returns - A promise that resolves when the life cycle process is completed.
- */
-declare function doLifeCycle(name: LifeCyclesNames, steps: LifeCycleSteps): Promise<void>;
-/**
- * Creates additional files after the render: sitemaps, robots and a report of
- * the finished render.
- *
- * @async
- * @param domain
- */
-declare function createDomainMetadata(domain: string): Promise<void>;
-declare function removeAllSiteDirsFromStore(): void;
-/**
- * Save render information to a file to use as debug log.
- *
- * This information will **not** be sent to any API.
- */
-declare function saveBuildEndLogs(): void;
-export { createDomainMetadata, delay, doLifeCycle, getConfig, getSafeSiteId, instanceRootDir, isTruthy, measureExecutionTime, msToSec, pause, removeAllSiteDirsFromStore, removeProperties, sanitizeAPICacheDir, saveBuildEndLogs, walk, walkStore, };

package/build/utils/create-build-data.d.ts

@@ -1,8 +0,0 @@
-/**
- * Download all data: sites, pages etc.. from the instance private Griddo API.
- * Then you can use the generator funcion `getBuildPagesFromStore()` to get the pages and
- * `getBuildMetadata()` to get build and sites metadata as objects. Both from
- * exporter utils sites dir.
- */
-declare function createDomainRenderData(domain: string): Promise<void>;
-export { createDomainRenderData };

package/build/utils/domains.d.ts

@@ -1,13 +0,0 @@
-import type { Domains } from "../types/global";
-/**
- * Return an array of domains name (string) of the current instance.
- */
-declare function getInstanceDomains(): Promise<string[]>;
-/**
- * Return an unique array of domains, filtered without "/".
- *
- * @param domains An array of domains
- * @see Domains
- */
-declare function getDomainSlugs(domains: Domains): string[];
-export { getInstanceDomains, getDomainSlugs };

package/build/utils/folders.d.ts

@@ -1,53 +0,0 @@
-import { type MakeDirectoryOptions } from "fs-extra";
-/**
- * Remove an empty directory from the basePath recursively.
- * If the directory has only .xml files it will handle as empty too (empty site)
- *
- * @param baseDir - The base directory.
- */
-declare function deleteDisposableSiteDirs(): void;
-/**
- * Creates multiple directories.
- *
- * @param dirs - An array of directory paths.
- * @param options - Same option as `fs.mkdirSync()`
- */
-declare function createArtifacts(dirs: Array<string>, options?: MakeDirectoryOptions): void;
-declare function renameArtifact(src: string, dst: string): void;
-/**
- * Copy multiple directories with backup option.
- *
- * @param src - Source directory.
- * @param dst - Destination directory.
- * @param dirs - Directories to copy.
- * @param options.withBackup - Create a previous backup before copy.
- */
-declare function copyArtifacts(src: string, dst: string, dirs: Array<string>, options?: {
-    withBackup: boolean;
-}): void;
-/**
- * Move artifacts between cx-paths
- *
- * @param src - Source directory.
- * @param dst - Destination directory.
- * @param dirs - Directories to move.
- * @param options - Options.
- */
-declare function moveArtifacts(src: string, dst: string, dirs: Array<string>, options?: {
-    withBackup?: boolean;
-    override?: boolean;
-}): void;
-/**
- * Removes multiple artifact directories.
- *
- * @param artifacts - An array of artifact directory paths.
- */
-declare function removeArtifacts(artifacts: Array<string>): void;
-/**
- * Elimina todas las páginas del store (de todos los sites) cuyo nombre empiece con un guión "-".
- * Estas páginas son "virtuales" y no tienen ids desde API por lo que mantenerlas en el store es un problema cuando se hacen modificaciones en la página "madre".
- * La solución por ahora es borrarlas del store y rehacerlas en todos los renders.
- */
-declare function removeVirtualPagesFromStore(): Promise<void>;
-declare function prependFileSync(filePath: string, content: string): void;
-export { copyArtifacts, createArtifacts, deleteDisposableSiteDirs, moveArtifacts, prependFileSync, removeArtifacts, removeVirtualPagesFromStore, renameArtifact, };

package/build/utils/loggin.d.ts

@@ -1,51 +0,0 @@
-import type { Site } from "../types/sites";
-/**
- * Custom basic logging function controlled by a environment variable.
- *
- * @param str The string to be logged.
- */
-declare function verboseLog(str: string): void;
-/**
- * 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 boxLog(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 buildLog(str: string): void;
-/**
- * Console log with a blue color in the info prefix.
- * @param str The string to be logged.
- */
-declare function infoLog(str: string): void;
-/**
- * Console log with a green color in the success prefix.
- * @param str The string to be logged.
- */
-declare function successLog(str: string): void;
-/**
- * Internal log
- * @param values The values to be logged.
- */
-declare function debugLog(...values: Array<unknown>): void;
-/**
- * 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 pageSizeLog(size: number, measure?: string): string;
-/**
- * Console log the Griddo exporter version.
- */
-declare function showExporterVersion(): void;
-declare function listSitesLog(title: string, sites: Array<Site>): void;
-declare function errorLabelLog(msg: string): void;
-export { boxLog, buildLog, debugLog, errorLabelLog, infoLog, listSitesLog, pageSizeLog, showExporterVersion, successLog, verboseLog, };

package/build/utils/render.d.ts

@@ -1,13 +0,0 @@
-/**
- * Creates a sentinel file with the current date and time.
- * This file is used to track later if node_modules/@griddo/cx was cleaned by a
- * npm install from a deploy.
- */
-declare function createSentinelRenderFile(): void;
-declare function deleteSentinelRenderFile(): void;
-declare function isValidRender(): void;
-/**
- * Send the default registers through Griddo alerts.
- */
-declare function sendGriddoDefaultAlerts(): Promise<void>;
-export { createSentinelRenderFile, deleteSentinelRenderFile, isValidRender, sendGriddoDefaultAlerts, };

package/build/utils/searches.d.ts

@@ -1,15 +0,0 @@
-import type { PostSearchInfoResponse } from "../types/api";
-import type { PostSearchInfoProps } from "../types/global";
-/**
- * Save in the BBDD the content of a page parsed without HTML tags.
- *
- * @param props Object with parts of the final page object to be saved in the BBDD.
- */
-declare function postSearchInfo(props: PostSearchInfoProps): Promise<PostSearchInfoResponse>;
-/**
- * Function that search in the `/public` dir the content info of the pages and
- * send it to the search table in the ddbb using the API.
- */
-declare function uploadRenderedSearchContentToAPI(distDomainPath: string, domain: string): Promise<void>;
-declare function startAIEmbeddings(): Promise<void>;
-export { postSearchInfo, startAIEmbeddings, uploadRenderedSearchContentToAPI };

package/build/utils/sites.d.ts

@@ -1,31 +0,0 @@
-import type { Site, SiteData } from "../types/sites";
-/**
- * Check the instance sites and returns site prepared to be published and unpublished.
- */
-declare function getSitesToRender(domain: string): Promise<{
-    sitesToPublish: Site[];
-    sitesToUnpublish: Site[];
-}>;
-/**
- * Unpublish an array of sites 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.
- * @see SiteData
- */
-declare function getSiteData(siteID: number): Promise<SiteData>;
-/**
- * Save a file with the end of build process to use as `build-end` signal.
- */
-declare function generateBuildReport(): Promise<void>;
-/**
- * Generate sitemaps and save them into file system.
- */
-declare function generateSitemaps(): Promise<void>;
-export { generateBuildReport, generateSitemaps, getSiteData, getSitesToRender, unpublishSites, };

package/build/utils/store.d.ts

@@ -1,81 +0,0 @@
-import type { BuildMetaData } from "../types/api";
-import type { RenderInfo } from "../types/global";
-import type { GriddoPageObject } from "../types/pages";
-import type { Site } from "../types/sites";
-/**
- * Read all path pages stored in the `store` Griddo directory and returns the
- * absolute file path.
- *
- * @param domain - The domain to get the pages from.
- */
-declare function getBuildPagesFromCachedStore<PageType extends GriddoPageObject>(domain: string): Generator<PageType, void, unknown>;
-/**
- * Read all pages stored in the `store` Griddo directory and returns one by one
- * with a generator.
- *
- * @param basePath - Base directory to get pages from.
- * @param options.withSizeProp - Add size prop to the page object.
- * @todo throw error if the basePath is not an store folder
- */
-declare function getBuildPagesFromStore<PageType extends GriddoPageObject>(args?: {
-    basePath?: string;
-    withSizeProp?: boolean;
-}): Generator<PageType, void, unknown>;
-/**
- * Read all pages stored in `store` Griddo directory and return the absolute
- * path.
- */
-declare function getBuildPagesPath(): string[];
-/**
- * Get the build metadata from the Store.
- */
-declare function getBuildMetadata(): Promise<BuildMetaData>;
-/**
- * Write render info into a file.
- * @param renderInfo - Data that will be saved related to the render process.
- */
-declare function saveRenderInfoInStore(renderInfo: RenderInfo): void;
-/**
- * Return an array of ids only from `.json` files (no dirs) in the `basePath` dir based in the file name and filtered by the pages ids in a concrete site.
- * @param basePath - Absolute path of the dir from which files will be read.
- * @returns A Array<number> of pages ids in `basePath` dir filtered by pages ids in a concrete site.
- */
-/**
- * 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 pages - An array of Griddo page objects to be saved.
- */
-declare function saveSitePagesInStore(siteDirName: string, pages: Array<GriddoPageObject>): void;
-/**
- * Removes JSON files from the specified site directory based on the provided arrays of page numbers.
- * For each number in the arrays, a corresponding file with the format `<number>.json` is removed if it exists.
- *
- * WARNING: This function may end up handling large arrays, so don't be tempted
- * to refactor it to use something cool like the spread operator and make a
- * single array, etc..
- *
- * @param siteDirName - The name of the site directory containing the pages.
- * @param pageIdsArray - A two-dimensional array where each inner array contains numbers representing page files to be removed.
- */
-declare function removeSitePagesFromStore(siteDirName: string, pageIdsArray: Array<Array<number>>): void;
-/**
- * Removes sites that exist in the store that should no longer be there because
- * the domain has been changed. This is necessary because those sites will not
- * be marked as `sitesToUnpublish` so they must be removed manually.
- */
-declare function removeOrphanSites(sitesToPublish: Array<Site>, domain: string): void;
-/**
- * Returns the list of `activePages` pages that do not currently exist in a
- * site's store (probably due to a failed render).
- */
-declare function getMissingPublishedPagesInStore(siteName: string, activePages: Array<number>): number[];
-/**
- * Get pages that are not active anymore but are in the store.
- */
-declare function getZombiePagesInStore(siteDir: string, activePages: Array<number>): number[];
-export { getBuildMetadata, getBuildPagesFromCachedStore, getBuildPagesFromStore, getBuildPagesPath, getMissingPublishedPagesInStore, getPageInStoreDir, getZombiePagesInStore, removeOrphanSites, removeSitePagesFromStore, saveSitePagesInStore, saveRenderInfoInStore, };

package/cx.config.d.ts

@@ -1,5 +0,0 @@
-import type { CXConfig } from "./exporter/types/global";
-
-declare const config: CXConfig;
-
-export default config;

package/cx.config.js

@@ -1,36 +0,0 @@
-import path from "node:path";
-
-import pkgDir from "pkg-dir";
-
-import { resolveComponentsPath } from "./exporter/utils/instance";
-
-// Paths
-const REPO_ROOT_DIR = pkgDir.sync(path.resolve(__dirname, "../.."));
-const CX_ROOT_DIR = pkgDir.sync(__dirname);
-const SSG_DIR = path.resolve(pkgDir.sync(__dirname));
-const CX_CACHE_DIR = path.resolve(CX_ROOT_DIR, ".cx-cache");
-const COMPONENTS_DIR = resolveComponentsPath();
-const EXPORTS_DIR = path.join(REPO_ROOT_DIR, "exports/sites");
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { version: griddoVersion } = require(
-	path.join(CX_ROOT_DIR, "package.json"),
-);
-
-const config = {
-	proDomain: "pro-",
-	griddoVersion,
-	buildReportFileName: "build-report.json",
-	paths: (domain) => ({
-		__cache: path.join(CX_CACHE_DIR, domain || ""),
-		__components: COMPONENTS_DIR,
-		__cx: CX_ROOT_DIR,
-		__exports: path.join(EXPORTS_DIR, domain || ""),
-		__root: REPO_ROOT_DIR,
-		__ssg: SSG_DIR,
-		__exports_dist: domain ? path.join(EXPORTS_DIR, domain, "dist") : "",
-		__cx_dist: path.join(CX_ROOT_DIR, "dist"),
-	}),
-};
-
-export default config;

package/exporter/adapters/gatsby/index.ts

@@ -1,182 +0,0 @@
-import type {
-	Artifacts,
-	LifeCyclesNames,
-	LifeCycleSteps,
-} from "../../types/global";
-
-import fs from "node:fs";
-import path from "node:path";
-
-import {
-	createDistFromGatsbyPublic,
-	getGatsbyAssetPrefixWithDomain,
-	hasNewCommit,
-	runGatsbyBuildCommand,
-	updateCommitFile,
-} from "./utils";
-import getCxArtifacts from "../../artifacts";
-import { AuthService } from "../../services/auth";
-import {
-	createDomainMetadata,
-	doLifeCycle,
-	getConfig,
-	saveBuildEndLogs,
-} from "../../utils/core-utils";
-import { createDomainRenderData } from "../../utils/create-build-data";
-import {
-	copyArtifacts,
-	createArtifacts,
-	deleteDisposableSiteDirs,
-	moveArtifacts,
-	removeArtifacts,
-	removeVirtualPagesFromStore,
-	renameArtifact,
-} from "../../utils/folders";
-import { infoLog } from "../../utils/loggin";
-import {
-	createSentinelRenderFile,
-	deleteSentinelRenderFile,
-	isValidRender,
-} from "../../utils/render";
-
-/**
- * Render every instance domain with the Gatsby adapter.
- */
-export async function renderDomainsWithGatsbyAdapter(domain: string) {
-	await AuthService.login();
-	const config = getConfig();
-
-	infoLog(`Initializing render for the domain ${domain}\n`);
-
-	const {
-		//
-		__ssg,
-		__exports,
-		__cache,
-		__cx,
-		__components,
-	} = config.paths(domain);
-
-	// Griddo artifacts
-	const cxArtifacts = getCxArtifacts(domain);
-
-	// Gatsby artifacts
-	const gatsbyArtifacts: Pick<Artifacts, "disposables" | "cacheables"> = {
-		disposables: [
-			path.join(__ssg, "public"),
-			path.join(__ssg, "static"),
-			path.join(__ssg, ".cache"),
-		],
-		cacheables: [".cache"],
-	};
-
-	// These variables are involved in the build for create the dist directory
-	// from public and pass to the gatsby-build command via spawnSync.
-	const assetPrefix = getGatsbyAssetPrefixWithDomain(domain);
-	const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
-
-	// Compose artifacts
-	const disposableArtifacts = [
-		...cxArtifacts.disposables,
-		...gatsbyArtifacts.disposables,
-	];
-
-	// LifeCycles
-
-	const allLifeCycles: Array<{
-		name: LifeCyclesNames;
-		steps: LifeCycleSteps;
-	}> = [
-		{
-			name: "Init",
-			steps: [() => createSentinelRenderFile()],
-		},
-
-		{
-			name: "Clean",
-			steps: [() => removeArtifacts(disposableArtifacts)],
-		},
-
-		{
-			name: "Prepare",
-			steps: [() => createArtifacts(cxArtifacts.initials)],
-		},
-
-		{
-			name: "Restore",
-			steps: [
-				() => copyArtifacts(__components, __ssg, ["static"]),
-				() => copyArtifacts(__exports, __cx, cxArtifacts.archivables),
-				() =>
-					renameArtifact(path.join(__cx, "dist"), path.join(__ssg, "public")),
-				() => moveArtifacts(__cache, __cx, cxArtifacts.cacheables),
-				() => moveArtifacts(__cache, __ssg, gatsbyArtifacts.cacheables),
-				// Remove .cache if new deploy detected
-				() => {
-					if (hasNewCommit(__cache)) {
-						if (fs.existsSync(path.join(__ssg, ".cache"))) {
-							infoLog(
-								"New deploy detected, removing Gatsby `.cache` directory to prevent data corruption",
-							);
-							fs.rmSync(path.join(__ssg, ".cache"), {
-								recursive: true,
-								force: true,
-							});
-						}
-					}
-				},
-			],
-		},
-
-		{
-			name: "Data",
-			steps: [() => createDomainRenderData(domain)],
-		},
-
-		{
-			name: "SSG",
-			steps: [() => runGatsbyBuildCommand(assetPrefix)],
-		},
-
-		{
-			name: "Relocation",
-			steps: [() => createDistFromGatsbyPublic(domain, needsAssetPrefix)],
-		},
-
-		{
-			name: "Meta",
-			steps: [() => createDomainMetadata(domain), () => saveBuildEndLogs()],
-		},
-
-		{
-			name: "Archive",
-			steps: [
-				() => removeVirtualPagesFromStore(),
-				() => deleteDisposableSiteDirs(),
-				() =>
-					moveArtifacts(__cx, __exports, cxArtifacts.archivables, {
-						withBackup: true,
-					}),
-				() => moveArtifacts(__cx, __cache, cxArtifacts.cacheables),
-				() => moveArtifacts(__ssg, __cache, gatsbyArtifacts.cacheables),
-			],
-		},
-
-		{
-			name: "Close",
-			steps: [
-				() => removeArtifacts(disposableArtifacts),
-				() => updateCommitFile({ basePath: __cache }),
-			],
-		},
-
-		{
-			name: "HealthCheck",
-			steps: [() => isValidRender(), () => deleteSentinelRenderFile()],
-		},
-	];
-
-	for (const { name, steps } of allLifeCycles) {
-		await doLifeCycle(name, steps);
-	}
-}