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

package/build/exporter/services/db.d.ts

@@ -1,4 +0,0 @@
-import type { RenderDB } from "../types/render";
-declare function readDB(customDBPath?: string): Promise<RenderDB>;
-declare function writeDB(renderDB: RenderDB, customDBPath?: string): Promise<void>;
-export { readDB, writeDB };

package/build/exporter/services/navigation.d.ts

@@ -1,50 +0,0 @@
-import type { Footer, Header } from "../types/navigation";
-import type { APIPageObject } from "../types/pages";
-declare class NavigationService {
-    private _defaultHeaders;
-    private _defaultFooters;
-    private _navigations;
-    constructor();
-    set navigations(navigations: {
-        headers: Array<Header>;
-        footers: Array<Footer>;
-    });
-    get navigations(): {
-        headers: Array<Header>;
-        footers: Array<Footer>;
-    };
-    getDefaultFooters(): Record<number, Footer>;
-    getDefaultHeaders(): Record<number, Header>;
-    getRightLanguage(list: Array<{
-        language: number;
-        navigationLanguages: Array<{
-            navigationId: number;
-        }>;
-        id: number;
-    }>, id: number, language: number): {
-        language: number;
-        navigationLanguages: Array<{
-            navigationId: number;
-        }>;
-        id: number;
-    } | null;
-    getPageHeader(id: number, language: number): {
-        language: number;
-        navigationLanguages: Array<{
-            navigationId: number;
-        }>;
-        id: number;
-    } | null;
-    getPageFooter(id: number, language: number): {
-        language: number;
-        navigationLanguages: Array<{
-            navigationId: number;
-        }>;
-        id: number;
-    } | null;
-    getPageNavigations(page: APIPageObject): {
-        header: Header;
-        footer: Footer;
-    };
-}
-export { NavigationService };

package/build/exporter/services/reference-fields.d.ts

@@ -1,20 +0,0 @@
-import type { APIPageObject } from "../types/pages";
-/**
- * Compose the queriedItems prop from a ReferenceField data of a page.
- *
- * @param props
- * @param props.page The APIPage object
- * @param props.cacheKey A cache key to manage cached files or using fetch
- */
-declare function getReferenceFieldData({ page, cacheKey, }: {
-    page: APIPageObject;
-    /** Reference id to manage cache between renders. */
-    cacheKey: string;
-}): Promise<{
-    [key: string]: any;
-    type: "template" | "formTemplate";
-    templateType: string;
-    activeSectionSlug: string;
-    activeSectionBase: string;
-}>;
-export { getReferenceFieldData };

package/build/exporter/services/robots.d.ts

@@ -1,13 +0,0 @@
-import type { Robots } from "../types/global";
-declare class RobotsService {
-    robots: Robots;
-    settings: Record<string, unknown>;
-    constructor();
-    private getRobots;
-    /**
-     * Write robots.txt files for the domain.
-     */
-    writeFiles(domain: string): Promise<void>;
-}
-declare const robotsService: RobotsService;
-export { robotsService as RobotsService };

package/build/exporter/services/sites.d.ts

@@ -1,32 +0,0 @@
-import type { Core } from "@griddo/core";
-import type { AllSitesReponse, EndPageInfoResponse, EndSiteRenderBody, LanguagesResponse, ReferenceFieldBody, ReferenceFieldResponse, SitemapAPIResponse, SocialsResponse, StartPageRenderResponse } from "../types/api";
-import type { Site } from "../types/sites";
-/**
- * Get a list of site objects.
- */
-declare function getAllSites(domain: string): Promise<AllSitesReponse>;
-/**
- * Get a list of site objects from a domain.
- */
-declare function getAllSitesFromDomain(domain: string): Promise<Site[]>;
-/**
- * Fetch a page object from API.
- */
-declare function getPage(id: number, cacheKey: string): Promise<import("../types/pages").APIPageObject>;
-/**
- * Get site info
- */
-declare function getSiteInfo(id: number, cacheKey?: string): Promise<Site>;
-declare function getSiteLanguages(id: number, cacheKey?: string): Promise<LanguagesResponse>;
-declare function startSiteRender(id: number): Promise<StartPageRenderResponse>;
-/**
- * Send the end signal to API for a render site.
- */
-declare function endSiteRender(id: number, body: EndSiteRenderBody): Promise<EndPageInfoResponse>;
-declare function getReferenceFieldSiteData(page: Core.Page, body: ReferenceFieldBody, cacheKey: string, dataSiteId?: number, dataLangID?: number): Promise<ReferenceFieldResponse>;
-declare function getSitemap(options: {
-    siteId: number;
-    headers?: Record<string, string>;
-}): Promise<SitemapAPIResponse>;
-declare function getSiteSocials(id: number, cacheKey?: string): Promise<SocialsResponse>;
-export { endSiteRender, getAllSites, getAllSitesFromDomain, getPage, getReferenceFieldSiteData, getSiteInfo, getSiteLanguages, getSitemap, getSiteSocials, startSiteRender, };

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

@@ -1,15 +0,0 @@
-import type { RenderMode } from "../types/render";
-/**
- * Fetch, process and save object pages and sites data into the file system to
- * be consumed by other services (Griddo itself, Adapters, etc.)
- */
-declare function createStore(options: {
-    domain: string;
-    renderMode: RenderMode;
-    griddoVersion: string;
-    basePath: string;
-}): Promise<{
-    pagesToCreate: number[];
-    pagesToDelete: number[];
-}>;
-export { createStore };

package/build/exporter/types/api.d.ts

@@ -1,141 +0,0 @@
-import type { Core, Fields } from "@griddo/core";
-import type { Domains, Robots, Settings } from "./global";
-import type { APIPageObject } from "./pages";
-import type { Site } from "./sites";
-/** 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>;
-    /**  Page ids that publish */
-    publishPagesIds: Array<number>;
-};
-/** ReferenceField Body */
-export interface ReferenceFieldBody {
-    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 the props of the body object for the get page */
-/** 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 ReferenceField. */
-export type ReferenceFieldResponse = 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?: any;
-    /** 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>;
-    useApiCacheDir?: boolean;
-}
-/** 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;
-}
-/** Response type for the embedding answer in the ai search feature  */
-export type PostEmbeddingsResponse = 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 | ReferenceFieldResponse | PostSearchInfoResponse | PostSearchInfoResponse | PostEmbeddingsResponse;
-export interface ShowApiErrorOptions {
-    callInfo: Record<string, any>;
-}
-export interface BuildMetaData {
-    buildProcessData: Record<string, EndSiteRenderBody>;
-    createdPages: Array<number>;
-    sitesToPublish: Array<Site>;
-}
-export interface Auth {
-    Authorization: string;
-    "Cache-Control": string;
-}
-export interface AuthHeaders extends Auth {
-    lang?: string;
-}
-export {};

package/build/exporter/types/global.d.ts

@@ -1,84 +0,0 @@
-import type { Core, Fields } from "@griddo/core";
-import type { EndSiteRenderBody } from "./api";
-import type { 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 Domain = {
-    id: number;
-    slug: string;
-    url: string;
-};
-type Domains = Array<Domain>;
-/** 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 LifeCycleAction = (...args: Array<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" | "__cx_dist" | "__sites";
-interface CXConfig {
-    proDomain: string;
-    griddoVersion: string;
-    buildReportFileName: string;
-}
-interface AIEmbeddingsResponse {
-    code: number;
-    message: string;
-}
-interface Artifacts {
-    disposables: Array<string>;
-    cacheables: Array<string>;
-    initials: Array<string>;
-    archivables: Array<string>;
-    restaurable: Array<string>;
-}
-export type { AIEmbeddingsResponse, Artifacts, BuildProcessData, CXConfig, Domain, Domains, FetchDataProps, LifeCyclesNames, Petition, PlaceholderPath, PostSearchInfoProps, RenderInfo, Robot, Robots, Settings, LifeCycleAction, };

package/build/exporter/types/navigation.d.ts

@@ -1,28 +0,0 @@
-/** 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: "footer";
-};

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

@@ -1,144 +0,0 @@
-import type { Core, Fields } from "@griddo/core";
-import type { SocialsResponse } from "./api";
-import type { Settings } from "./global";
-import type { Site } from "./sites";
-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;
-    };
-};
-export interface Dimensions {
-    values: Record<string, string> | null;
-    contentSelect?: "group" | "individual" | null;
-    groupSelect?: string;
-    dimensionsSelect?: Array<string>;
-}
-export interface GatsbyPageTemplateProps extends Omit<GriddoPageObject, "context"> {
-    pageContext: GriddoPageObject["context"] & {
-        page: Core.Page;
-    };
-    location: {
-        pathname: string;
-        search: string;
-        hash: string;
-    };
-}

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

@@ -1,50 +0,0 @@
-import type { RenderInfo } from "./global";
-declare const RENDER_MODE: {
-    readonly FROM_SCRATCH: "FROM_SCRATCH";
-    readonly INCREMENTAL: "INCREMENTAL";
-    readonly IDLE: "IDLE";
-};
-type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
-export interface RenderModeTuple {
-    renderMode: RenderMode;
-    reason?: string;
-}
-type DomainLike = string;
-type RenderDB = {
-    proDomain: string;
-    griddoVersion: string;
-    buildReportFileName: string;
-    sortedDomains: Array<DomainLike>;
-    paths: {
-        root: string;
-        cx: string;
-        ssg: string;
-        cxCache: string;
-        components: string;
-        exportsDir: 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: Array<{
-        siteId: number;
-        publishHashes: Array<string>;
-        siteHash: string | null;
-        unpublishHashes: Array<string>;
-        publishPagesIds: Array<number>;
-    }>;
-}
-export { RENDER_MODE, type RenderDB, type RenderMode, type Report };

package/build/exporter/types/sites.d.ts

@@ -1,56 +0,0 @@
-import type { Core } from "@griddo/core";
-import type { SocialsResponse } from "./api";
-import type { Footer, Header } from "./navigation";
-/**
- * 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;
-    /**
-     * Array of all pages (from day 0): published, unpublished and deleted
-     * If you want the real used pages use this endpoint: `/site/:site/pages`
-     * `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>;
-    published: string;
-    rendering: boolean;
-    renderingHours: number;
-    shouldBeUpdated: boolean;
-    siteScript: string;
-    smallAvatar: string;
-    updated: boolean;
-    pagesStatus: {
-        active: Array<number>;
-        uploadPending: Array<number>;
-        offlinePending: Array<number>;
-        offline: Array<number>;
-        deleted: Array<number>;
-    };
-}
-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/exporter/types/templates.d.ts

@@ -1,8 +0,0 @@
-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 a ReferenceField data */
-export type TemplateWithReferenceField = Template & {
-    queriedItems?: Fields.QueriedData<unknown>;
-    itemsPerPage?: number;
-};

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

@@ -1,23 +0,0 @@
-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, postApi as post, putApi as put };

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

@@ -1,6 +0,0 @@
-import type { Artifacts } from "../types/global";
-/**
- * Returns the artifacts of CX.
- */
-declare function getCxArtifacts(domain: string): Promise<Artifacts>;
-export { getCxArtifacts };