@griddo/cx 11.9.17 → 11.10.0

package/build/{types → shared/types}/global.d.ts

@@ -1,6 +1,6 @@
+import type { Core, Fields } from "@griddo/core";
 import type { EndSiteRenderBody } from "./api";
 import type { Site } from "./sites";
-import type { Core, Fields } from "@griddo/core";
 interface Settings {
     apiVersion?: string;
     avoidCanonicalsOnSitemaps?: boolean;
@@ -49,36 +49,35 @@ type Domain = {
     slug: string;
     url: string;
 };
-type Domains = Array<Domain>;
+type Domains = Domain[];
 /** Describes the type of build process data object. */
 type BuildProcessData = Record<string, EndSiteRenderBody>;
 type Robot = {
     path: string;
     content: string;
 };
-type Robots = Array<Robot>;
+type Robots = Robot[];
 interface RenderInfo {
     buildProcessData: BuildProcessData;
-    createdPages: Array<number>;
-    sitesToPublish: Array<Site>;
+    createdPages: number[];
+    sitesToPublish: Site[];
 }
-type LifeCycleSteps = Array<(...args: Array<unknown>) => unknown | Promise<unknown>>;
-type LifeCyclesNames = "Init" | "Prepare" | "Restore" | "Data" | "SSG" | "Relocation" | "Meta" | "Archive" | "Clean" | "Close" | "HealthCheck" | "Close" | "__DEBUG__";
-type PlaceholderPath = "__exports" | "__cache" | "__cx" | "__ssg" | "__components" | "__root" | "__exports_dist" | "__cx_dist";
+type LifeCycleAction = (...args: unknown[]) => void | Promise<void>;
+type LifeCyclesNames = "Init" | "Prepare" | "Restore" | "Data" | "SSG" | "Relocation" | "Meta" | "Sync" | "Clean" | "Close" | "HealthCheck" | "Close";
+type PlaceholderPath = "__exports" | "__cache" | "__cx" | "__ssg" | "__components" | "__root" | "__exports_dist" | "__sites";
 interface CXConfig {
-    proDomain: string;
     griddoVersion: string;
     buildReportFileName: string;
-    paths: (domain?: string) => Record<PlaceholderPath, string>;
 }
 interface AIEmbeddingsResponse {
     code: number;
     message: string;
 }
-interface Artifacts {
-    disposables: Array<string>;
-    cacheables: Array<string>;
-    initials: Array<string>;
-    archivables: Array<string>;
+interface RenderArtifacts {
+    disposables: string[];
+    cacheables: string[];
+    initials: string[];
+    archivables: string[];
+    restaurable: string[];
 }
-export type { AIEmbeddingsResponse, Artifacts, BuildProcessData, CXConfig, Domain, Domains, FetchDataProps, LifeCyclesNames, Petition, PlaceholderPath, PostSearchInfoProps, RenderInfo, Robot, Robots, Settings, LifeCycleSteps, };
+export type { AIEmbeddingsResponse, RenderArtifacts, BuildProcessData, CXConfig, Domain, Domains, FetchDataProps, LifeCyclesNames, Petition, PlaceholderPath, PostSearchInfoProps, RenderInfo, Robot, Robots, Settings, LifeCycleAction, };

package/build/{types → shared/types}/navigation.d.ts

@@ -4,9 +4,9 @@ export type Header = {
     id: number;
     isDefault: boolean;
     language: number;
-    navigationLanguages: Array<{
+    navigationLanguages: {
         navigationId: number;
-    }>;
+    }[];
     setAsDefault: boolean;
     theme: null | string;
     title: string;
@@ -18,11 +18,11 @@ export type Footer = {
     id: number;
     isDefault: boolean;
     language: number;
-    navigationLanguages: Array<{
+    navigationLanguages: {
         navigationId: number;
-    }>;
+    }[];
     setAsDefault: boolean;
     theme: null | string;
     title: string;
-    type: "header";
+    type: "footer";
 };

package/build/{types → shared/types}/pages.d.ts

@@ -1,7 +1,7 @@
+import type { Core, Fields } from "@griddo/core";
 import type { SocialsResponse } from "./api";
 import type { Settings } from "./global";
 import type { Site } from "./sites";
-import type { Core, Fields } from "@griddo/core";
 export type APIPageObject = Core.Page & {
     id: number;
 } & {
@@ -29,7 +29,7 @@ export type GriddoSinglePage = Core.Page & {
 };
 export type GriddoListPage = Core.Page & {
     page: APIPageObject;
-    pages: Array<Array<Fields.QueriedDataItem>>;
+    pages: Fields.QueriedDataItem[][];
     isRoot?: boolean;
     defaultLang?: Core.SiteLanguage;
     template: {
@@ -39,7 +39,7 @@ export type GriddoListPage = Core.Page & {
         activeSectionSlug: string;
         activeSectionBase: string;
     };
-    totalQueriedItems: Array<Fields.QueriedDataItem>;
+    totalQueriedItems: Fields.QueriedDataItem[];
 };
 export type GriddoMultiPage = Core.Page & {
     header: number | null;
@@ -54,7 +54,7 @@ export interface AdditionalInfo {
     griddoVersion: string;
     instance?: string;
     publicBaseUrl: string;
-    siteLangs: Array<Core.SiteLanguage>;
+    siteLangs: Core.SiteLanguage[];
     siteMetadata: Site["siteMetadata"];
     siteSlug: string;
     socials: SocialsResponse;
@@ -71,13 +71,13 @@ export interface PageAdditionalInfo extends AdditionalInfo {
 export type MultiPageElement = {
     component: string;
     title: string | Required<Fields.Heading>;
-    elements: Array<Record<string, unknown>>;
-    componentModules: Array<Record<string, unknown>>;
+    elements: Record<string, unknown>[];
+    componentModules: Record<string, unknown>[];
     sectionSlug: string;
     metaTitle: string;
     metaDescription: string;
 };
-export type MultiPageElements = Array<MultiPageElement>;
+export type MultiPageElements = MultiPageElement[];
 /**
  * Gatsby page object format.
  */
@@ -119,7 +119,7 @@ export type GriddoPageObject = {
         siteMetadata: Site["siteMetadata"];
         theme: string;
         title: string;
-        siteLangs: Array<Core.SiteLanguage>;
+        siteLangs: Core.SiteLanguage[];
         siteOptions: AdditionalInfo["siteOptions"];
         siteScript: string;
         socials: SocialsResponse;
@@ -130,7 +130,7 @@ export interface Dimensions {
     values: Record<string, string> | null;
     contentSelect?: "group" | "individual" | null;
     groupSelect?: string;
-    dimensionsSelect?: Array<string>;
+    dimensionsSelect?: string[];
 }
 export interface GatsbyPageTemplateProps extends Omit<GriddoPageObject, "context"> {
     pageContext: GriddoPageObject["context"] & {

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

@@ -0,0 +1,56 @@
+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;
+    commitHash: string;
+    commitMessage: string;
+    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/{types → shared/types}/sites.d.ts

@@ -1,6 +1,6 @@
+import type { Core } from "@griddo/core";
 import type { SocialsResponse } from "./api";
 import type { Footer, Header } from "./navigation";
-import type { Core } from "@griddo/core";
 /**
  * Describes a Griddo site object from API.
  * This takes some type props from Core.Site.
@@ -8,12 +8,12 @@ import type { Core } from "@griddo/core";
 export interface Site extends Required<Pick<Core.Site, "bigAvatar" | "favicon" | "home" | "id" | "isPublished" | "timezone" | "thumbnail" | "theme" | "socials" | "slug" | "smallAvatar" | "modified" | "name" | "siteMetadata">> {
     author: string;
     deleted: number;
-    domains: Array<Record<string, string>>;
-    footers: Array<Footer>;
+    domains: Record<string, string>[];
+    footers: Footer[];
     hash: string | null;
-    headers: Array<Header>;
-    languages: Array<Core.SiteLanguage>;
-    languageSites: Array<number>;
+    headers: Header[];
+    languages: Core.SiteLanguage[];
+    languageSites: number[];
     navigationModules: {
         header?: string;
         footer?: string;
@@ -24,9 +24,8 @@ export interface Site extends Required<Pick<Core.Site, "bigAvatar" | "favicon" |
      * `select/site/33/pages` -> [{id,label}, {id,label}, {id,label}] // array of published, pending, unpublished... page objects
      * `select/site/33/pages?liveStatus=active` -> // array of publishedpage objects
      */
-    pages: Array<number>;
-    onlinePages: Array<number>;
-    changedPages: Array<number>;
+    pages: number[];
+    onlinePages: number[];
     published: string;
     rendering: boolean;
     renderingHours: number;
@@ -35,22 +34,22 @@ export interface Site extends Required<Pick<Core.Site, "bigAvatar" | "favicon" |
     smallAvatar: string;
     updated: boolean;
     pagesStatus: {
-        active: Array<number>;
-        uploadPending: Array<number>;
-        offlinePending: Array<number>;
-        offline: Array<number>;
-        deleted: Array<number>;
+        active: number[];
+        uploadPending: number[];
+        offlinePending: number[];
+        offline: number[];
+        deleted: number[];
     };
 }
 export interface SiteData {
     siteInfo: Site;
-    validPagesIds: Array<number>;
+    validPagesIds: number[];
     siteHash: string | null;
-    unpublishHashes: Array<string>;
-    siteLangs: Array<Core.SiteLanguage>;
+    unpublishHashes: string[];
+    siteLangs: Core.SiteLanguage[];
     defaultLang: Core.SiteLanguage | undefined;
-    headers: Array<Header>;
-    footers: Array<Footer>;
+    headers: Header[];
+    footers: Footer[];
     socials: SocialsResponse;
 }
 export type SiteHash = string | null;

package/build/shared/types.d.ts

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,3 @@
+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

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

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

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

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

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

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

@@ -0,0 +1,3 @@
+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

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

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

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

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

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

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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,9 @@
+/**
+ * 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

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

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

@@ -0,0 +1,15 @@
+/**
+ * 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

@@ -0,0 +1,7 @@
+/**
+ * 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

@@ -0,0 +1,7 @@
+/**
+ * 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

@@ -0,0 +1,18 @@
+/**
+ * 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

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,34 @@
+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 };