@griddo/cx 11.9.12-rc.0 → 11.9.13

package/build/services/render.d.ts

@@ -1,70 +0,0 @@
-import type { RenderModeTuple } from "../shared/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(domain: string): Promise<void>;
-/**
- * Determines the appropriate render mode for a given domain based on its current state,
- * previous render errors, deployment status, and whether rendering is required.
- *
- * @param options - An object containing:
- *   - `domain`: The domain name to resolve the render mode for.
- *   - `shouldBeRendered`: A boolean indicating if the domain should be rendered.
- * @returns An object with:
- *   - `renderMode`: The resolved render mode (`FROM_SCRATCH`, `INCREMENTAL`, or `IDLE`).
- *   - `reason`: A string describing the reason for the chosen render mode.
- *
- * @remarks
- * The function checks for missing exports, previous render errors, new deployments,
- * and whether rendering is necessary to decide the render mode.
- *
- * @todo
- * Improve ifs and reason concatenations...
- */
-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 getRenderModeFromDB(domain: string): Promise<RenderModeTuple>;
-declare function getRenderPathsHydratedWithDomainFromDB(options?: {
-    domain?: string;
-    dbFilePath?: string;
-}): Promise<{
-    __root: string;
-    __cache: string;
-    __components: string;
-    __cx: string;
-    __sites: string;
-    __exports: string;
-    __exports_backup: string;
-    __ssg: string;
-    __exports_dist: string;
-}>;
-declare function getRenderMetadataFromDB(): Promise<{
-    griddoVersion: string;
-    buildReportFileName: string;
-}>;
-/**
- * Save a file with the end of build process to use as `end-render` signal.
- */
-declare function generateBuildReport(domain: string): Promise<void>;
-export { assertRenderIsValid, generateBuildReport, getRenderMetadataFromDB, getRenderModeFromDB, getRenderPathsHydratedWithDomainFromDB, markRenderAsCompleted, markRenderAsStarted, resolveDomainRenderMode, updateCommitFile, };

package/build/services/sitemaps.d.ts

@@ -1,5 +0,0 @@
-/**
- * Generate sitemaps and save them into file system.
- */
-declare function generateSitemaps(domain: string): Promise<void>;
-export { generateSitemaps };

package/build/shared/context.d.ts

@@ -1,36 +0,0 @@
-import type { PlaceholderPath, RenderArtifacts } from "./types/global";
-import type { RenderMode } from "./types/render";
-interface RenderContextProps<T> {
-    domain: string;
-    renderMode: RenderMode;
-    pathsHydratedWithDomain: Record<PlaceholderPath, string>;
-    ssg: T;
-    renderMetadata: {
-        griddoVersion: string;
-        buildReportFileName: string;
-    };
-    renderArtifacts: RenderArtifacts;
-}
-/**
- * Encapsulates the state, configuration, and artifacts for a single SSG
- * render process.
- *
- * This class is instantiated at the beginning of a render and passed through
- * each lifecycle step, providing a centralized and consistent context for all
- * operations. It is agnostic to the specific SSG being used.
- */
-export declare class RenderContext<T = unknown> {
-    readonly domain: string;
-    readonly renderMode: RenderMode;
-    readonly pathsHydratedWithDomain: Record<PlaceholderPath, string>;
-    pagesToCreate: number[];
-    pagesToDelete: number[];
-    ssg: T;
-    renderMetadata: {
-        griddoVersion: string;
-        buildReportFileName: string;
-    };
-    renderArtifacts: RenderArtifacts;
-    constructor({ domain, renderMode, ssg, pathsHydratedWithDomain, renderMetadata, renderArtifacts }: RenderContextProps<T>);
-}
-export {};

package/build/shared/envs.d.ts

@@ -1,19 +0,0 @@
-declare const GRIDDO_API_URL: string | undefined;
-declare const GRIDDO_PUBLIC_API_URL: string | undefined;
-declare const GRIDDO_BOT_USER: string | undefined;
-declare const GRIDDO_BOT_PASSWORD: string | undefined;
-declare const GRIDDO_API_CONCURRENCY_COUNT: number;
-declare const GRIDDO_SKIP_BUILD_CHECKS: boolean;
-declare const GRIDDO_RENDER_BY_DOMAINS: boolean;
-declare const GRIDDO_BUILD_LOGS: boolean;
-declare const GRIDDO_BUILD_LOGS_TO_FILE: boolean;
-declare const GRIDDO_BUILD_LOGS_BUFFER_SIZE: number;
-declare const GRIDDO_SSG_VERBOSE_LOGS: boolean;
-declare const GRIDDO_SEARCH_FEATURE: boolean;
-declare const GRIDDO_ASSET_PREFIX: string | undefined;
-declare const GRIDDO_REACT_APP_INSTANCE: string | undefined;
-declare const GRIDDO_AI_EMBEDDINGS: boolean;
-declare const GRIDDO_VERBOSE_LOGS: boolean;
-declare const GRIDDO_USE_DIST_BACKUP: boolean;
-declare const GRIDDO_SSG_BUNDLE_ANALYZER: boolean;
-export { GRIDDO_AI_EMBEDDINGS, GRIDDO_API_CONCURRENCY_COUNT, GRIDDO_API_URL, GRIDDO_ASSET_PREFIX, GRIDDO_BOT_PASSWORD, GRIDDO_BOT_USER, GRIDDO_BUILD_LOGS, GRIDDO_BUILD_LOGS_BUFFER_SIZE, GRIDDO_BUILD_LOGS_TO_FILE, GRIDDO_PUBLIC_API_URL, GRIDDO_REACT_APP_INSTANCE, GRIDDO_RENDER_BY_DOMAINS, GRIDDO_SEARCH_FEATURE, GRIDDO_SKIP_BUILD_CHECKS, GRIDDO_SSG_BUNDLE_ANALYZER, GRIDDO_SSG_VERBOSE_LOGS, GRIDDO_USE_DIST_BACKUP, GRIDDO_VERBOSE_LOGS, };

package/build/shared/npm-modules/brush.d.ts

@@ -1,18 +0,0 @@
-declare const CODES: {
-    readonly black: "\u001B[30m";
-    readonly red: "\u001B[31m";
-    readonly green: "\u001B[32m";
-    readonly yellow: "\u001B[33m";
-    readonly blue: "\u001B[34m";
-    readonly magenta: "\u001B[35m";
-    readonly cyan: "\u001B[36m";
-    readonly white: "\u001B[37m";
-    readonly gray: "\u001B[90m";
-    readonly bold: "\u001B[1m";
-    readonly dim: "\u001B[2m";
-};
-type ColorFunction = (text: string | number) => string;
-type ColorName = keyof typeof CODES;
-type Brush = Record<ColorName, ColorFunction>;
-declare const brush: Brush;
-export { brush };

package/build/shared/npm-modules/find-up-simple.d.ts

@@ -1,34 +0,0 @@
-/**
- * Opciones para controlar el comportamiento de la búsqueda.
- */
-export type Options = {
-    /**
-    El directorio desde donde empezar a buscar.
-    @default process.cwd()
-    */
-    readonly cwd?: URL | string;
-    /**
-    El tipo de ruta a buscar.
-    @default 'file'
-    */
-    readonly type?: "file" | "directory";
-    /**
-    Un directorio en el que la búsqueda se detiene si no se encuentran coincidencias.
-    @default El directorio raíz del sistema
-    */
-    readonly stopAt?: URL | string;
-};
-/**
- * Encuentra un archivo o directorio de forma asíncrona subiendo por los directorios padre.
- * @param name - El nombre del archivo o directorio a buscar.
- * @param options - Opciones de búsqueda.
- * @returns La ruta encontrada o `undefined` si no se pudo encontrar.
- */
-export declare function findUp(name: string, options?: Options): Promise<string | undefined>;
-/**
- * Encuentra un archivo o directorio de forma síncrona subiendo por los directorios padre.
- * @param name - El nombre del archivo o directorio a buscar.
- * @param options - Opciones de búsqueda.
- * @returns La ruta encontrada o `undefined` si no se pudo encontrar.
- */
-export declare function findUpSync(name: string, options?: Options): string | undefined;

package/build/shared/npm-modules/pkg-dir.d.ts

@@ -1,7 +0,0 @@
-declare function pkgDir(options?: {
-    readonly cwd?: string;
-}): Promise<string | undefined>;
-declare function pkgDirSync(options?: {
-    readonly cwd?: string;
-}): string | undefined;
-export { pkgDir, pkgDirSync };

package/build/shared/npm-modules/xml-parser.d.ts

@@ -1,4 +0,0 @@
-import type { SitemapItem } from "../types/api";
-declare function generateUrlsetXml(pages: SitemapItem[]): string;
-declare function generateSitemapIndexXml(sitemaps: string[]): string;
-export { generateSitemapIndexXml, generateUrlsetXml };

package/build/shared/types/render.d.ts

@@ -1,54 +0,0 @@
-import type { RenderInfo } from "./global";
-declare const RENDER_MODE: {
-    readonly FROM_SCRATCH: "FROM_SCRATCH";
-    readonly INCREMENTAL: "INCREMENTAL";
-    readonly IDLE: "IDLE";
-    readonly ERROR: "ERROR";
-    readonly COMPLETED: "COMPLETED";
-};
-type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
-export interface RenderModeTuple {
-    renderMode: RenderMode;
-    reason?: string;
-}
-type DomainLike = string;
-type RenderDB = {
-    griddoVersion: string;
-    buildReportFileName: string;
-    sortedDomains: DomainLike[];
-    needsRollbackOnError: boolean;
-    currentRenderingDomain: string | null;
-    paths: {
-        root: string;
-        cx: string;
-        ssg: string;
-        cxCache: string;
-        components: string;
-        exportsDir: string;
-        exportsDirBackup: string;
-    };
-    domains: {
-        [key: DomainLike]: {
-            renderMode?: RenderMode;
-            shouldBeRendered?: boolean;
-            isRendering?: boolean;
-            renderInfo?: RenderInfo;
-            renderModeReason?: string;
-        };
-    };
-};
-interface Report {
-    authControl: {
-        Authorization: string;
-        "Cache-Control": string;
-        lang?: string | undefined;
-    } | undefined;
-    sites: {
-        siteId: number;
-        publishHashes: string[];
-        siteHash: string | null;
-        unpublishHashes: string[];
-        publishPagesIds: number[];
-    }[];
-}
-export { RENDER_MODE, type RenderDB, type RenderMode, type Report };

package/build/shared/types.d.ts

@@ -1,15 +0,0 @@
-import type { Core } from "@griddo/core";
-import type { Dimensions, GriddoPageObject } from "@griddo/cx";
-import type { HeadProps } from "gatsby";
-interface CustomHeadProps extends HeadProps {
-    pageContext: GriddoPageObject["context"] & {
-        page: Core.Page & {
-            defaultLang: {
-                id: number;
-            };
-            dimensions: Dimensions;
-            disableHrefLangs: number[];
-        };
-    };
-}
-export type { CustomHeadProps };

package/build/ssg-adapters/gatsby/actions/clean.d.ts

@@ -1,3 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-import type { SSG } from "../shared/types";
-export declare function cleanAction(context: RenderContext<SSG>): Promise<void>;

package/build/ssg-adapters/gatsby/actions/close.d.ts

@@ -1,3 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-import type { SSG } from "../shared/types";
-export declare function closeAction(context: RenderContext<SSG>): Promise<void>;

package/build/ssg-adapters/gatsby/actions/data.d.ts

@@ -1,2 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-export declare function dataAction(context: RenderContext): Promise<void>;

package/build/ssg-adapters/gatsby/actions/healthCheck.d.ts

@@ -1,2 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-export declare function healthCheckAction(context: RenderContext): Promise<void>;

package/build/ssg-adapters/gatsby/actions/init.d.ts

@@ -1,2 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-export declare function initAction(context: RenderContext): Promise<void>;

package/build/ssg-adapters/gatsby/actions/logs.d.ts

@@ -1,3 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-import type { SSG } from "../shared/types";
-export declare function logsAction(context: RenderContext<SSG>): Promise<void>;

package/build/ssg-adapters/gatsby/actions/meta.d.ts

@@ -1,2 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-export declare function metaAction(context: RenderContext): Promise<void>;

package/build/ssg-adapters/gatsby/actions/prepare.d.ts

@@ -1,2 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-export declare function prepareAction(context: RenderContext): Promise<void>;

package/build/ssg-adapters/gatsby/actions/relocation.d.ts

@@ -1,2 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-export declare function relocationAction(context: RenderContext): Promise<void>;

package/build/ssg-adapters/gatsby/actions/restore.d.ts

@@ -1,3 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-import type { SSG } from "../shared/types";
-export declare function restoreAction(context: RenderContext<SSG>): Promise<void>;

package/build/ssg-adapters/gatsby/actions/ssg.d.ts

@@ -1,3 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-import type { SSG } from "../shared/types";
-export declare function ssgAction(context: RenderContext<SSG>): Promise<void>;

package/build/ssg-adapters/gatsby/actions/sync.d.ts

@@ -1,3 +0,0 @@
-import type { RenderContext } from "../../../shared/context";
-import type { SSG } from "../shared/types";
-export declare function syncAction(context: RenderContext<SSG>): Promise<void>;

package/build/ssg-adapters/gatsby/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * Executes a complete Gatsby render process for a given domain.
- *
- * The render process consists of multiple lifecycle steps that handle cleaning,
- * preparing, building and syncing the site. It can run in two modes:
- * - FROM_SCRATCH: Performs a complete rebuild of the domains sites.
- * - INCREMENTAL: Only rebuilds changed pages while preserving the rest.
- */
-export declare function gatsbyRenderDomain(domain: string): Promise<void>;

package/build/ssg-adapters/gatsby/shared/artifacts.d.ts

@@ -1,4 +0,0 @@
-export declare function getGatsbyArtifacts(): Promise<{
-    disposables: string[];
-    cacheables: string[];
-}>;

package/build/ssg-adapters/gatsby/shared/diff-assets.d.ts

@@ -1,15 +0,0 @@
-/**
- * Compara los assets clave entre dos directorios de build de Gatsby.
- * Solo compara los archivos definidos en KEY_ASSET_PATTERNS.
- *
- * @param dir1 Ruta al primer directorio (ej. el de producción)
- * @param dir2 Ruta al segundo directorio (ej. el del nuevo build)
- * @returns `true` si hay diferencias en los assets clave, `false` si son idénticos.
- */
-export declare function getAssetsDiffBetweenRenders(dir1: string, dir2: string): Promise<boolean>;
-/**
- * Actualiza el webpackCompilationHash en un único fichero HTML.
- * @param filePath Ruta al fichero HTML.
- * @param newHash El nuevo hash a insertar.
- */
-export declare function patchHtmlFile(filePath: string, newHash: string): Promise<void>;

package/build/ssg-adapters/gatsby/shared/extract-assets.d.ts

@@ -1,7 +0,0 @@
-/**
- * Update the Griddo's `/dist` dir with the contents from `public` dir only
- * with files of type: js, json and css.
- * TODO: Explicar que el static se copia a assets porque el js va en el subdominio de assets.
- */
-declare function extractAssetsFromDist(domain: string): Promise<void>;
-export { extractAssetsFromDist };

package/build/ssg-adapters/gatsby/shared/gatsby-build.d.ts

@@ -1,7 +0,0 @@
-/**
- * Spawn a new node process `gatsby build`
- * @note This proccess can not access to the custom Griddo `process.env` so it
- * needs variables passed to it via the `env` prop.
- */
-declare function gatsbyBuild(assetPrefixWithDomain: string): Promise<void>;
-export { gatsbyBuild };

package/build/ssg-adapters/gatsby/shared/render-rollback.d.ts

@@ -1,18 +0,0 @@
-/**
- * Enables the rollback-on-error feature for subsequent render lifecycles.
- * When this feature is active, if an error occurs during a render process,
- * the application will automatically restore the 'exports' directory to its
- * state before the render began. This function updates the configuration
- * in the database to reflect this change.
- * @async
- */
-declare function enableRollbackOnError(): Promise<void>;
-/**
- * Disables the rollback-on-error feature for subsequent render lifecycles.
- * When this feature is inactive, the application will not restore the
- * 'exports' directory if a render process fails. This is the default behavior.
- * This function updates the configuration in the database.
- * @async
- */
-declare function disableRollbackOnError(): Promise<void>;
-export { disableRollbackOnError, enableRollbackOnError };

package/build/ssg-adapters/gatsby/shared/sync-render.d.ts

@@ -1,26 +0,0 @@
-interface SyncRenderConfig {
-    src: string;
-    dst: string;
-    pagesToCreate: number[];
-    pagesToDelete: number[];
-    artifactsToCopyToExports: string[];
-}
-declare class SyncRender {
-    private bundleDir;
-    private currentRenderDir;
-    private pagesToCreate;
-    private pagesToDelete;
-    private assetArtifacts;
-    private state;
-    constructor(config: SyncRenderConfig);
-    execute(): Promise<void>;
-    private assertAssetsAreValid;
-    private setPagesToDelete;
-    private setPagesToAdd;
-    private sync;
-    private restoreWebpackCompilationHash;
-    private copyAssetArtifacts;
-    private copySitemaps;
-    private scanPages;
-}
-export { SyncRender };

package/build/ssg-adapters/gatsby/shared/types.d.ts

@@ -1,34 +0,0 @@
-interface SSG {
-    assetPrefix: string;
-    ssgArtifacts: {
-        disposables: string[];
-        cacheables: string[];
-    };
-}
-interface GatsbyPageData {
-    path: string;
-    result: {
-        pageContext: {
-            id: number;
-            title: string;
-            path: string;
-            openGraph: any;
-            pageMetadata: any;
-            page: {
-                site: number;
-                id: number;
-                fullPath: {
-                    compose: string;
-                };
-                language: number;
-                title: string;
-                fullUrl: string;
-                templateId: string;
-                template: {
-                    templateType: string;
-                };
-            };
-        };
-    };
-}
-export type { GatsbyPageData, SSG };