@griddo/cx 11.7.6-rc.1 → 11.7.6-rc.2

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

@@ -1,77 +0,0 @@
-import type { APIResponses } from "../types/api";
-import type { LifeCycleAction, LifeCyclesNames } from "../types/global";
-/**
- * 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 JSON file absolute paths with one level of depth.
- * /abs/.../sotre/<siteId>/jsonfile.json
- * /abs/.../sotre/<siteId>/jsonfile.json
- * /abs/.../sotre/<siteId>/jsonfile.json
- * /abs/.../sotre/<siteId>/jsonfile.json
- */
-declare function walkStore(storeDir: string): AsyncGenerator<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;
-/**
- * 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 executeAndReturnExecutionTime<T>(func: () => T | Promise<T>): Promise<number>;
-/**
- * Executes a life cycle process, which involves executing a callback
- * function, printing to the console, and handling errors with optional retries.
- *
- * @async
- * @param name - The name of the life cycle.
- * @param action - A callback function to execute.
- * @param options - Optional configuration for the life cycle process.
- * @param options.maxRetrys - The maximum number of retries for the life cycle.
- * @param options.enabled - Whether the life cycle process should be executed.
- * @returns - A promise that resolves when the life cycle process is completed.
- */
-declare function doLifeCycle(name: string, action: LifeCycleAction, options?: {
-    maxRetrys?: number;
-    spinner?: boolean;
-}): Promise<void>;
-declare function removeAllSiteDirsFromStore(): Promise<void>;
-/**
- * Save render information to a file to use as debug log.
- *
- * This information will **not** be sent to any API.
- */
-declare function saveBuildEndLogs(options: {
-    basePath: string;
-    domain: string;
-}): Promise<void>;
-declare const lifeCycleNames: Record<LifeCyclesNames, LifeCyclesNames>;
-export { delay, doLifeCycle, executeAndReturnExecutionTime, getSafeSiteId, isTruthy, lifeCycleNames, msToSec, removeAllSiteDirsFromStore, removeProperties, saveBuildEndLogs, walkStore, };

package/build/exporter/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 { getDomainSlugs, getInstanceDomains };

package/build/exporter/utils/errors.d.ts

@@ -1,15 +0,0 @@
-import type { ErrorsType } from "../constants/errors";
-export type ErrorData = {
-    error: ErrorsType;
-    message: string;
-    expected?: string;
-    hint?: string;
-};
-export declare class RenderError extends Error {
-    constructor(originalError?: unknown);
-}
-/**
- * Throws an error with the provided error message, expected value, and hint.
- */
-declare function throwError(options: ErrorData, stack?: unknown): never;
-export { throwError };

package/build/exporter/utils/folders.d.ts

@@ -1,66 +0,0 @@
-import type { MakeDirectoryOptions } from "node:fs";
-/**
- * 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(baseDir: string): Promise<void>;
-/**
- * Creates multiple artifact directories.
- *
- * @param dirs - An array of directory paths.
- * @param options - Same option as `fs.mkdirSync()`
- */
-declare function createDirs(dirs: Array<string>, options?: MakeDirectoryOptions): Promise<void>;
-declare function renamePath(src: string, dst: string): Promise<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 copyDirs(src: string, dst: string, dirs: Array<string>, options?: {
-    withBackup: boolean;
-}): Promise<void>;
-/**
- * Move artifacts between cx-paths
- *
- * @param src - Source directory.
- * @param dst - Destination directory.
- * @param dirs - Directories to move.
- * @param options - Options.
- */
-declare function moveDirs(src: string, dst: string, dirs: Array<string>, options?: {
-    withBackup?: boolean;
-    override?: boolean;
-}): Promise<void>;
-/**
- * Removes multiple artifact directories.
- *
- * @param dirs - An array of directory paths.
- */
-declare function removeDirs(dirs: Array<string>): Promise<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 removeVirtualPages(dirPath: string): Promise<void>;
-declare function prependFileSync(filePath: string, content: string): Promise<void>;
-/**
- * Delete empty directories from the given directory in a recursive way.
- */
-declare function deleteEmptyDirectories(dirPath: string): Promise<void>;
-declare function pathExists(dir: string): Promise<boolean>;
-declare function pkgDir(options?: {
-    readonly cwd?: string;
-}): Promise<string | undefined>;
-declare function pkgDirSync(options?: {
-    readonly cwd?: string;
-}): string | undefined;
-export { copyDirs, createDirs, deleteDisposableSiteDirs, deleteEmptyDirectories, moveDirs, pathExists, pkgDir, pkgDirSync, prependFileSync, removeDirs, removeVirtualPages, renamePath, };

package/build/exporter/utils/images.d.ts

@@ -1,16 +0,0 @@
-import type { Fields } from "@griddo/core";
-/**
- * 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
- *
- * @example
- * formatImage("https://images.griddo.io/tree", 300, 200, "jpg")
- * // https://images.griddo.io/tree/w/300/h/200/f/jpg
- */
-declare function formatImage(image: Fields.Image | string, width: number, height: number, format?: string): string | null;
-export { formatImage };

package/build/exporter/utils/instance.d.ts

@@ -1,21 +0,0 @@
-declare const isComponentLibrary: boolean;
-declare const componentLibraryPathAlias: {
-    "@griddo-instance": string;
-};
-/**
- * Returns the instance or monorepo paths.
- *
- * @param customPath The path for the instance components
- */
-declare function resolveComponentsPath(customPath?: string): string;
-/**
- * Return the instance or monorepo components {t|j}sconfig.json file.
- */
-declare function getComponentsJSConfig(): string | undefined;
-/**
- * Get the instance webpack aliases
- */
-declare function getComponentsLibAliases(): {
-    "@griddo-instance": string;
-};
-export { componentLibraryPathAlias, getComponentsJSConfig, getComponentsLibAliases, isComponentLibrary, resolveComponentsPath, };

package/build/exporter/utils/loggin.d.ts

@@ -1,37 +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;
-/**
- * Console log the Griddo exporter version.
- */
-declare function showExporterVersion(): Promise<void>;
-declare function listSitesLog(title: string, sites: Array<Site>): void;
-declare function errorLabelLog(msg: string): void;
-export { boxLog, buildLog, errorLabelLog, infoLog, listSitesLog, showExporterVersion, successLog, verboseLog, };

package/build/exporter/utils/pages.d.ts

@@ -1,34 +0,0 @@
-import type { Fields } from "@griddo/core";
-import type { GriddoListPage, GriddoMultiPage, GriddoPageObject, GriddoSinglePage, MultiPageElements, PageAdditionalInfo } from "../types/pages";
-import type { TemplateWithReferenceField } from "../types/templates";
-/**
- * Create a single Griddo page object.
- *
- * @param page A Griddo single page object.
- * @param additionalInfo Additional page info.
- */
-declare function createGriddoSinglePage(page: GriddoSinglePage, additionalInfo: PageAdditionalInfo): Promise<GriddoPageObject>;
-/**
- * Create multiples pages from one page as list paginated pages
- */
-declare function createGriddoListPages({ page, pages, isRoot, defaultLang, template, totalQueriedItems }: GriddoListPage, additionalInfo: PageAdditionalInfo): Promise<GriddoPageObject[]>;
-/**
- * Create multiples pages from a MultiPage module
- *
- * @param page A Griddo Multipage object.
- * @param additionalInfo Additional page info.
- */
-declare function createGriddoMultiPages(page: GriddoMultiPage, additionalInfo: PageAdditionalInfo): Promise<GriddoPageObject[]>;
-/**
- * Get the multi pages elements.
- *
- * @param page The page to get the multipage parts.
- */
-declare function getMultiPageElements(page: TemplateWithReferenceField): Promise<MultiPageElements> | null;
-/**
- * Takes a template object and split the whole queriedItems into separated queriedItems to use in Griddo static list templates.
- *
- * @param listTemplate A template schema with the ReferenceField data included.
- */
-declare function getPaginatedPages(listTemplate: TemplateWithReferenceField): Fields.SimpleContentType<Omit<unknown, "__contentTypeKind">>[][];
-export { createGriddoListPages, createGriddoMultiPages, createGriddoSinglePage, getMultiPageElements, getPaginatedPages, };

package/build/exporter/utils/render.d.ts

@@ -1,49 +0,0 @@
-import type { RenderModeTuple } from "../types/render";
-/**
- * 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 coming from a deploy.
- */
-declare function markRenderAsStarted(options: {
-    domain: string;
-    basePath: string;
-}): Promise<void>;
-declare function markRenderAsCompleted(domain: string): Promise<void>;
-declare function assertRenderIsValid(): Promise<void>;
-declare function resolveDomainRenderMode(options: {
-    domain: string;
-    shouldBeRendered: boolean;
-}): Promise<{
-    renderMode: "FROM_SCRATCH";
-    reason: string;
-} | {
-    renderMode: "IDLE";
-    reason: string;
-} | {
-    renderMode: "INCREMENTAL";
-    reason: string;
-}>;
-declare function updateCommitFile(options: {
-    basePath: string;
-}): Promise<void>;
-declare function getRenderMode(domain: string): Promise<RenderModeTuple>;
-declare function getRenderPathsFromDB(options?: {
-    domain?: string;
-    dbFilePath?: string;
-}): Promise<{
-    __root: string;
-    __cache: string;
-    __components: string;
-    __cx: string;
-    __sites: string;
-    __exports: string;
-    __ssg: string;
-    __exports_dist: string;
-    __cx_dist: string;
-}>;
-declare function getRenderMetadataFromDB(): Promise<{
-    proDomain: string;
-    griddoVersion: string;
-    buildReportFileName: string;
-}>;
-export { assertRenderIsValid, getRenderMetadataFromDB, getRenderMode, getRenderPathsFromDB, markRenderAsCompleted, markRenderAsStarted, resolveDomainRenderMode, updateCommitFile, };

package/build/exporter/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(domain: string): Promise<void>;
-/**
- * Generate sitemaps and save them into file system.
- */
-declare function generateSitemaps(domain: string): Promise<void>;
-export { generateBuildReport, generateSitemaps, getSiteData, getSitesToRender, unpublishSites };

package/build/exporter/utils/store.d.ts

@@ -1,53 +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";
-/**
- * Get the build metadata from the Store.
- */
-declare function getBuildMetadata(domain: string): 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, domain: string): Promise<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 paths 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): Promise<string[]>;
-/**
- * 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>): Promise<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>>): Promise<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): Promise<void>;
-/**
- * Get pages that are not active anymore but are in the store.
- */
-declare function getZombiePagesInStore(siteDir: string, activePages: Array<number>): Promise<number[]>;
-declare function writeUniqueFileSync(filePath: string, content: string): Promise<void>;
-export { getBuildMetadata, getPageInStoreDir, getZombiePagesInStore, removeOrphanSites, removeSitePagesFromStore, saveRenderInfoInStore, saveSitePagesInStore, writeUniqueFileSync, };

package/start-render.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-// This is the "bin" for the griddo-cx package used by "infra" to trigger a
-// render running `npm run griddo-cx`.
-require("./build/commands/start-render.js");