@griddo/cx 10.4.12 → 10.4.13

package/build/types/api.d.ts

@@ -0,0 +1,130 @@
+import type { Domains, Robots, Settings } from "./global";
+import type { APIPageObject } from "./pages";
+import type { Site } from "./sites";
+import type { Core, Fields } from "@griddo/core";
+/** EndSiteRender Body */
+export type EndSiteRenderBody = {
+    /** Site hashes to publish. */
+    publishHashes: Array<string>;
+    /** Current site hash. */
+    siteHash: string | null;
+    /**  Site hashes to unpublish. */
+    unpublishHashes: Array<string>;
+};
+/** Distributor Body */
+export interface DistributorBody {
+    mode?: "auto" | "manual" | "navigation";
+    order?: string;
+    sources?: Array<Fields.Source<unknown>>;
+    quantity?: number;
+    filter?: Array<unknown>;
+    fullRelations?: boolean;
+    allLanguages?: boolean;
+    fixed?: Array<number>;
+    referenceId?: number;
+}
+/** Describes an item in a sitemap. */
+interface SitemapItem {
+    /** The URL of the page. */
+    loc: string;
+    /** The date the page was last modified. */
+    lastmod: string;
+    /** The priority of the page. */
+    priority: number;
+}
+/** Describes a URL. */
+interface URL {
+    /** The path of the URL. */
+    path: string;
+    /** The domain of the URL. */
+    domain: string;
+    /** The home of the URL. */
+    home: string;
+}
+/** Describes the items returned by a sitemap response. */
+export type SitemapItems = Record<string, Array<SitemapItem>>;
+/** Describes the response object returned by a Griddo distributor. */
+export type DistributorResponse = Fields.QueriedData<unknown>;
+/** Describes the response object returned by socials from Griddo. */
+export type SocialsResponse = Record<Core.SocialName, string>;
+/** Describes the response object returned by post search info post. */
+export type PostSearchInfoResponse = {
+    code: number;
+    message: string;
+};
+/** Describes the response object returned by a sitemap. */
+export interface SitemapAPIResponse {
+    /** Number of items */
+    totalItems: number;
+    /** Page id */
+    page: number;
+    /** Item response by API */
+    items: SitemapItems;
+    /** Url  */
+    url: URL;
+}
+/** Descripbes Language responses from Griddo API. */
+export interface LanguagesResponse {
+    /** Total of languages */
+    totalItems: number;
+    /** Array of languages objects */
+    items: Array<Core.SiteLanguage>;
+}
+/** Describes common props for api responses. */
+export interface APIRequest {
+    /** The URL of the API endpoint. */
+    endpoint: string;
+    /** The parameters to be sent in the request body. */
+    body?: unknown;
+    /** Reference id to manage cache between renders. */
+    cacheKey?: string;
+    /** Number of connection attempts (in case it fails on the first attempt). */
+    attempt?: number;
+    /** Headers for the post api fetch */
+    headers?: Record<string, unknown>;
+}
+/** Type with the POST request properties. */
+export interface PostAPI extends Omit<APIRequest, "headers"> {
+    headers?: {
+        lang?: number;
+    } & Record<string, unknown>;
+}
+/** Type with the GET request properties. */
+export type GetAPI = APIRequest;
+/** Type with the PUT request properties. */
+export type PutAPI = APIRequest;
+/** Response type for the start render API call */
+export interface StartPageRenderResponse {
+    /** Site hashes to publish */
+    publishIds: Array<number>;
+    /** Current site hash */
+    siteHash: string | null;
+    /** Site hashes to unpublish */
+    unpublishHashes: Array<string>;
+}
+/** Response type for the end render API call */
+export interface EndPageInfoResponse {
+    /** Response code */
+    code: number;
+    /** Response message */
+    message: string;
+}
+/** Describes a response type for GET all sites */
+export type AllSitesReponse = Array<Site>;
+/** Describes a response type for GET one page */
+export type PageResponse = APIPageObject;
+/** All types for the API response used in the api functions get, put, post */
+export type APIResponses = Domains | Robots | Settings | AllSitesReponse | Site | LanguagesResponse | StartPageRenderResponse | SitemapAPIResponse | SocialsResponse | PageResponse | EndPageInfoResponse | DistributorResponse | PostSearchInfoResponse;
+export interface ShowApiErrorOptions {
+    callInfo: {
+        endpoint?: string;
+        body?: unknown;
+        headers?: unknown;
+    };
+}
+export interface BuildMetaData {
+    buildProcessData: Record<string, EndSiteRenderBody>;
+    createdPages: Array<number>;
+    sitesToPublish: Array<Site>;
+}
+export {};

package/build/types/global.d.ts

@@ -0,0 +1,78 @@
+import type { EndSiteRenderBody } from "./api";
+import type { Core, Fields } from "@griddo/core";
+import { Site } from "./sites";
+interface Settings {
+    apiVersion?: string;
+    avoidCanonicalsOnSitemaps?: boolean;
+    avoidDebugMetas?: boolean;
+    avoidHrefLangsOnCanonicals?: boolean;
+    avoidHrefLangXDefault?: boolean;
+    avoidSelfReferenceCanonicals?: boolean;
+    cloudinaryName?: string;
+    forceMenuLinksLanguage?: boolean;
+    globalLogoBig?: string;
+    globalLogoMini?: string;
+    lastDBCheckVersion?: string;
+    schemasTimestamp?: string;
+    schemasVersion?: string;
+    showBasicMetaRobots?: boolean;
+    siteLogoBig?: string;
+    siteLogoMini?: string;
+    skipReviewOnPublish?: boolean;
+    useMetaTitle?: boolean;
+    useMetaKeywords?: boolean;
+    welcomeText1?: string;
+    welcomeText2?: string;
+}
+type Petition = Record<string, unknown>;
+interface PostSearchInfoProps {
+    title?: string;
+    description: string | null | undefined;
+    image: string | null | undefined;
+    pageId?: number;
+    siteId: number;
+    content: string;
+    languageId?: number;
+    template?: string | null | number;
+    url?: string;
+}
+interface FetchDataProps {
+    page: Core.Page;
+    component: {
+        data?: Fields.Reference<unknown>;
+    };
+    /** Reference id to manage cache between renders. */
+    cacheKey: string;
+}
+type Domains = Array<{
+    id: number;
+    slug: string;
+    url: string;
+}>;
+/** Describes the type of build process data object. */
+type BuildProcessData = Record<string, EndSiteRenderBody>;
+type Robot = {
+    path: string;
+    content: string;
+};
+type Robots = Array<Robot>;
+interface RenderInfo {
+    buildProcessData: BuildProcessData;
+    createdPages: Array<number>;
+    sitesToPublish: Array<Site>;
+}
+type LifeCyclesNames = "Prepare" | "Restore" | "Data" | "SSG" | "Relocation" | "Meta" | "Archive" | "Clean" | "__DEBUG__";
+type CXDir = "__exports" | "__caches" | "__cx" | "__ssg" | "__components" | "__root";
+interface CXConfig {
+    proDomain: string;
+    CXDir: {
+        EXPORTS: "__exports";
+        CACHE: "__caches";
+        CX: "__cx";
+        SSG: "__ssg";
+        COMPONENTS: "__components";
+        ROOT: "__root";
+    };
+    dirs: (domain?: string) => Record<CXDir, string>;
+}
+export { BuildProcessData, CXConfig, CXDir, Domains, FetchDataProps, LifeCyclesNames, Petition, PostSearchInfoProps, RenderInfo, Robot, Robots, Settings, };

package/build/types/navigation.d.ts

@@ -0,0 +1,28 @@
+/** Describes a Griddo Header */
+export type Header = {
+    component: "Header";
+    id: number;
+    isDefault: boolean;
+    language: number;
+    navigationLanguages: Array<{
+        navigationId: number;
+    }>;
+    setAsDefault: boolean;
+    theme: null | string;
+    title: string;
+    type: "header";
+};
+/** Describes a Griddo Footer */
+export type Footer = {
+    component: "Footer";
+    id: number;
+    isDefault: boolean;
+    language: number;
+    navigationLanguages: Array<{
+        navigationId: number;
+    }>;
+    setAsDefault: boolean;
+    theme: null | string;
+    title: string;
+    type: "header";
+};

package/build/types/pages.d.ts

@@ -0,0 +1,128 @@
+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;
+} & {
+    header: number | null;
+    footer: number | null;
+};
+export type CleanPage = Core.Page & {
+    isRoot: boolean;
+    defaultLang?: Core.SiteLanguage | undefined;
+};
+export type RenderPage = Core.Page & {
+    isRoot?: boolean;
+    multiPageElements: MultiPageElements;
+    defaultLang?: Core.SiteLanguage;
+    header: number;
+    footer: number;
+    id: number;
+    path: string;
+    component: "Page";
+    template_id: string;
+    mode: "list";
+};
+export type GriddoSinglePage = Core.Page & {
+    defaultLang?: Core.SiteLanguage;
+};
+export type GriddoListPage = Core.Page & {
+    page: APIPageObject;
+    pages: Array<Array<Fields.QueriedDataItem>>;
+    isRoot?: boolean;
+    defaultLang?: Core.SiteLanguage;
+    template: {
+        [key: string]: unknown;
+        type: "template";
+        templateType: string;
+        activeSectionSlug: string;
+        activeSectionBase: string;
+    };
+    totalQueriedItems: Array<Fields.QueriedDataItem>;
+};
+export type GriddoMultiPage = Core.Page & {
+    header: number | null;
+    footer: number | null;
+    isRoot?: boolean;
+    multiPageElements: MultiPageElements;
+    defaultLang?: Core.SiteLanguage | undefined;
+};
+export interface AdditionalInfo {
+    baseUrl: string;
+    cloudinaryName?: string;
+    griddoVersion: string;
+    instance?: string;
+    publicBaseUrl: string;
+    siteLangs: Array<Core.SiteLanguage>;
+    siteMetadata: Site["siteMetadata"];
+    siteSlug: string;
+    socials: SocialsResponse;
+    siteOptions: Pick<Settings, "useMetaTitle" | "useMetaKeywords" | "showBasicMetaRobots" | "avoidHrefLangsOnCanonicals" | "avoidSelfReferenceCanonicals" | "avoidHrefLangXDefault" | "avoidDebugMetas">;
+    siteScript: string;
+    theme: string;
+}
+export interface PageAdditionalInfo extends AdditionalInfo {
+    navigations: {
+        header: Record<string, unknown> | null;
+        footer: Record<string, unknown> | null;
+    };
+}
+export type MultiPageElement = {
+    component: string;
+    title: string | Required<Fields.Heading>;
+    elements: Array<Record<string, unknown>>;
+    componentModules: Array<Record<string, unknown>>;
+    sectionSlug: string;
+    metaTitle: string;
+    metaDescription: string;
+};
+export type MultiPageElements = Array<MultiPageElement>;
+/**
+ * Gatsby page object format.
+ */
+export type GriddoPageObject = {
+    matchPath?: string;
+    path: string;
+    /** Page size in bytes */
+    size?: number;
+    context: {
+        cloudinaryName?: string;
+        footer: Record<string, unknown> | null;
+        fullPath: Core.Page["fullPath"];
+        griddoVersion: string;
+        renderDate: string;
+        header: Record<string, unknown> | null;
+        id?: number;
+        languageId: number;
+        locale?: string;
+        openGraph: {
+            description?: string;
+            image?: string | null;
+            title?: string;
+            twitterImage?: string | null;
+            type: "website";
+        };
+        pageMetadata: {
+            canonical?: string | undefined;
+            description?: string;
+            follow?: "follow" | "nofollow";
+            index: "index" | "noindex";
+            locale?: string;
+            metaKeywords?: string;
+            metasAdvanced?: string;
+            pageLanguages?: Core.Page["pageLanguages"];
+            title?: string;
+            translate?: "notranslate" | "";
+            url?: string;
+        };
+        siteMetadata: Site["siteMetadata"];
+        theme: string;
+        title: string;
+        siteLangs: Array<Core.SiteLanguage>;
+        siteOptions: AdditionalInfo["siteOptions"];
+        siteScript: string;
+        socials: SocialsResponse;
+        page: GriddoSinglePage | GriddoListPage | GriddoMultiPage;
+    };
+};

package/build/types/sites.d.ts

@@ -0,0 +1,43 @@
+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.
+ */
+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>;
+    hash: string | null;
+    headers: Array<Header>;
+    languages: Array<Core.SiteLanguage>;
+    languageSites: Array<number>;
+    navigationModules: {
+        header?: string;
+        footer?: string;
+    } | null;
+    pages: Array<number>;
+    changedPages: Array<number>;
+    published: string;
+    rendering: boolean;
+    renderingHours: number;
+    shouldBeUpdated: boolean;
+    siteScript: string;
+    smallAvatar: string;
+    updated: boolean;
+}
+export interface SiteData {
+    siteInfo: Site;
+    validPagesIds: Array<number>;
+    siteHash: string | null;
+    unpublishHashes: Array<string>;
+    siteLangs: Array<Core.SiteLanguage>;
+    defaultLang: Core.SiteLanguage | undefined;
+    headers: Array<Header>;
+    footers: Array<Footer>;
+    socials: SocialsResponse;
+}
+export type SiteHash = string | null;
+export type HashSites = Record<string, number | string>;

package/build/types/templates.d.ts

@@ -0,0 +1,8 @@
+import type { Core, Fields } from "@griddo/core";
+/** Describes a template object from a Griddo Page */
+export type Template = Core.Page["template"];
+/** Describes a template with distributor data */
+export type TemplateWithDistributor = Template & {
+    queriedItems?: Fields.QueriedData<unknown>;
+    itemsPerPage?: number;
+};

package/build/utils/api.d.ts

@@ -0,0 +1,23 @@
+import type { APIResponses, GetAPI, PostAPI, PutAPI } from "../types/api";
+/**
+ * Make a GET request to the Griddo API.
+ *
+ * @template T Response Type returned.
+ * @returns A promise that is resolved with the data from the API response.
+ */
+declare function getApi<T extends APIResponses>(props: GetAPI): Promise<T>;
+/**
+ * Make a PUT request to the Griddo API.
+ *
+ * @template T Response Type returned.
+ * @returns A promise that is resolved with the data from the API response.
+ */
+declare function putApi<T extends APIResponses>(props: PutAPI): Promise<T>;
+/**
+ * Make a POST request to the Griddo API.
+ *
+ * @template T Response Type returned.
+ * @returns A promise that is resolved with the data from the API response.
+ */
+declare function postApi<T extends APIResponses>(props: PostAPI): Promise<T>;
+export { getApi as get, putApi as put, postApi as post };

package/build/utils/cache.d.ts

@@ -0,0 +1,35 @@
+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 { createSha256, updatedSiteHash, searchCacheData, saveCache, createAPICacheDir, };

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

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

package/build/utils/domains.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Return an array of domains name (string) of the current instance.
+ */
+declare function getInstanceDomains(): Promise<string[]>;
+export { getInstanceDomains };

package/build/utils/folders.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" />
+import { 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 const clearEmptyDirs: (baseDir?: string) => void;
+/**
+ * Creates multiple directories.
+ *
+ * @param dirs - An array of directory paths.
+ * @param options - Same option as `fs.mkdirSync()`
+ */
+declare function createDirsSync(dirs: Array<string>, options?: MakeDirectoryOptions): 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 copyDirsSync(src: string, dst: string, dirs: Array<string>, options?: {
+    withBackup: boolean;
+}): void;
+/**
+ * Move artifacts between CX valid directories.
+ *
+ * @param src - Source directory.
+ * @param dst - Destination directory.
+ * @param dirs - Directories to move.
+ * @param options - Options.
+ */
+declare function moveDirsSync(src: string, dst: string, dirs: Array<string>, options?: {
+    withBackup?: boolean;
+    override?: boolean;
+}): void;
+/**
+ * Remove directories from `basePath` directory.
+ *
+ * @param basePath - Base directory.
+ * @param dirs - Directory to remove.
+ */
+declare function removeDirsSync(basePath: string, dirs: Array<string>): void;
+declare function removeVirtualPagesFromStore(): Promise<void>;
+export { clearEmptyDirs, copyDirsSync, createDirsSync, moveDirsSync, removeDirsSync, removeVirtualPagesFromStore, };

package/build/utils/health-checks.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if the environment is secure to launch a render.
+ * If something fails then log an error message and exit from the process.
+ * Otherwise just return true.
+ */
+declare function checkRenderHealthOrExit(): boolean;
+export { checkRenderHealthOrExit };

package/build/utils/instance.d.ts

@@ -0,0 +1,21 @@
+declare const IS_COMPONENT_LIBRARY: boolean;
+declare const PROJECT_ALIASES: {
+    "@components": 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(): {
+    "@components": string;
+};
+export { IS_COMPONENT_LIBRARY, PROJECT_ALIASES, getComponentsJSConfig, getComponentsLibAliases, resolveComponentsPath, };

package/build/utils/messages.d.ts

@@ -0,0 +1,2 @@
+export declare const printWarningMessage: (message: string, location: string, expected: string) => void;
+export declare const printErrorMessage: (message: string, location: string, expected: string) => void;

package/build/utils/pages.d.ts

@@ -0,0 +1,34 @@
+import type { GriddoListPage, GriddoMultiPage, GriddoPageObject, GriddoSinglePage, MultiPageElements, PageAdditionalInfo } from "../types/pages";
+import type { TemplateWithDistributor } from "../types/templates";
+import type { Fields } from "@griddo/core";
+/**
+ * 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: TemplateWithDistributor): 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 distributor data included.
+ */
+declare function getPaginatedPages(listTemplate: TemplateWithDistributor): Fields.SimpleContentType<Omit<unknown, "__contentTypeKind">>[][];
+export { createGriddoListPages, createGriddoMultiPages, createGriddoSinglePage, getMultiPageElements, getPaginatedPages, };

package/build/utils/searches.d.ts

@@ -0,0 +1,14 @@
+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 uploadSearchContentToAPI(): Promise<void>;
+export { postSearchInfo, uploadSearchContentToAPI };