@griddo/cx 10.4.16 → 10.4.18

package/build/build-complete.d.ts

@@ -1,18 +0,0 @@
-type Report = {
-    authControl: {
-        Authorization: string;
-        "Cache-Control": string;
-        lang?: string | undefined;
-    } | undefined;
-    sites: Array<{
-        siteId: number;
-        publishHashes: Array<string>;
-        siteHash: string | null;
-        unpublishHashes: Array<string>;
-    }>;
-};
-/**
- * Informa a la API del estado de publicación de los sites: published y unpublished.
- */
-export declare function buildComplete(report: Report): Promise<void>;
-export {};

package/build/index.d.ts

@@ -1,29 +0,0 @@
-/**
- *
- * Griddo CX library main export file.
- *
- * This file exports functions to use in both: adapters and SSG's frameworks.
- * Turning CX basically in a javascript library.
- *
- * # Browser context.
- * There is another export in the `/browser` directory to use exclusivelly in
- * the browser context where nodejs (path, fs, etc..) is not available.
- *
- * # Render script (bin)
- * The binary file of the package is `run-start-render.ts`.
- *
- * # Separate scripts.
- * There are some separate .ts files as build-complete.ts or reset-render.ts
- * that are intended to be used by infra via npm script like `npm run
- * build-complete`
- *
- */
-import type { SocialsResponse } from "./types/api";
-import type { AdditionalInfo, GriddoListPage, GriddoMultiPage, GriddoPageObject, GriddoSinglePage } from "./types/pages";
-import type { Site } from "./types/sites";
-import { startRender } from "./start-render";
-import { IS_COMPONENT_LIBRARY, PROJECT_ALIASES, resolveComponentsPath } from "./utils/instance";
-import { logInfo, logPageSize } from "./utils/shared";
-import { getBuildPages } from "./utils/store";
-import { getConfig } from "./utils/temp-utils";
-export { AdditionalInfo, GriddoListPage, GriddoMultiPage, GriddoPageObject, GriddoSinglePage, IS_COMPONENT_LIBRARY, PROJECT_ALIASES, Site, SocialsResponse, getBuildPages, getConfig, logInfo, logPageSize, resolveComponentsPath, startRender, };

package/build/move-assets.d.ts

@@ -1 +0,0 @@
-export {};

package/build/react/index.d.ts

@@ -1,2 +0,0 @@
-declare function Foo(): null;
-export { Foo };

package/build/reset-render.d.ts

@@ -1 +0,0 @@
-export {};

package/build/run-start-render.d.ts

@@ -1 +0,0 @@
-export {};

package/build/services/auth.d.ts

@@ -1,21 +0,0 @@
-/**
- * Service for authentication in the Griddo Private API
- */
-declare class AuthService {
-    user: string | undefined;
-    password: string | undefined;
-    baseUrl: string | undefined;
-    headers: {
-        Authorization: string;
-        "Cache-Control": string;
-        lang?: string;
-    } | undefined;
-    constructor();
-    login(): Promise<{
-        Authorization: string;
-        "Cache-Control": string;
-        lang?: string | undefined;
-    } | undefined>;
-}
-declare const authService: AuthService;
-export { authService as AuthService };

package/build/services/distributors.d.ts

@@ -1,45 +0,0 @@
-import type { FetchDataProps } from "../types/global";
-import type { APIPageObject } from "../types/pages";
-import type { Core, Fields } from "@griddo/core";
-/**
- * Service to work with distributors.
- */
-declare class DistributorService {
-    /**
-     * Get the body data from a ReferenceField.
-     * `auto`, `manual` or `navigation` mode.
-     *
-     * @param data The ReferenceField props.
-     * @returns The props for one of the ReferenceField mode.
-     */
-    static getBody(data: Fields.Reference<unknown>, page: Core.Page): Fields.Reference<unknown>;
-    /**
-     * Gets ContentType data from API
-     *
-     * @param props
-     * @param props.page The Page object
-     * @param props.component.data The ReferenceField, always in the data prop.
-     * @param props.cacheKey A cache key to manage cached files or using fetch
-     * @returns The ContentType data.
-     */
-    static fetchContentTypeData(props: FetchDataProps): Promise<import("../types/api").DistributorResponse>;
-    /**
-     * Compose the queriedItems prop from a distributor 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
-     */
-    static getDistributorData({ page, cacheKey, }: {
-        page: APIPageObject;
-        /** Reference id to manage cache between renders. */
-        cacheKey: string;
-    }): Promise<{
-        [key: string]: any;
-        type: "template";
-        templateType: string;
-        activeSectionSlug: string;
-        activeSectionBase: string;
-    }>;
-}
-export { DistributorService };

package/build/services/domains.d.ts

@@ -1,8 +0,0 @@
-import type { Domains } from "../types/global";
-/**
- * Get an array of domains availables.
- */
-declare class DomainsService {
-    static getAll(): Promise<Domains>;
-}
-export { DomainsService };

package/build/services/navigation.d.ts

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

package/build/services/robots.d.ts

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

package/build/services/settings.d.ts

@@ -1,23 +0,0 @@
-import type { Settings } from "../types/global";
-/**
- * TODO: JSDoc
- */
-declare class SettingsService {
-    baseURL?: string;
-    settings: Settings;
-    ENDPOINTS: {
-        settings: string;
-        resetRender: string;
-    };
-    constructor();
-    /**
-     * Get settings for a full domain render.
-     */
-    getAll(): Promise<void>;
-    /**
-     * TODO: JSDoc
-     */
-    resetRender(): Promise<void>;
-}
-declare const settingsService: SettingsService;
-export { settingsService as SettingsService };

package/build/services/sites.d.ts

@@ -1,42 +0,0 @@
-import type { AllSitesReponse, DistributorBody, DistributorResponse, EndPageInfoResponse, EndSiteRenderBody, LanguagesResponse, SitemapAPIResponse, SocialsResponse, StartPageRenderResponse } from "../types/api";
-import type { Site } from "../types/sites";
-import type { Core } from "@griddo/core";
-/**
- * TODO: JSDoc
- */
-declare class SitesService {
-    static getAll(): Promise<AllSitesReponse>;
-    /**
-     * Fetch a page object from API.
-     */
-    static getPage(id: number, cacheKey: string): Promise<import("../types/pages").APIPageObject>;
-    /**
-     * Get site info
-     */
-    static getInfo(id: number, cacheKey?: string): Promise<Site>;
-    /**
-     * TODO: JSDoc
-     */
-    static getLanguages(id: number, cacheKey?: string): Promise<LanguagesResponse>;
-    /**
-     * TODO: JSDoc
-     */
-    static startSiteRender(id: number): Promise<StartPageRenderResponse>;
-    /**
-     * Send the end signal to API for a render site.
-     */
-    static endSiteRender(id: number, body: EndSiteRenderBody): Promise<EndPageInfoResponse>;
-    /**
-     * TODO: JSDoc
-     */
-    static getDistributorData(page: Core.Page, body: DistributorBody, cacheKey: string, dataSiteId?: number, dataLangID?: number): Promise<DistributorResponse>;
-    /**
-     * TODO: JSDoc
-     */
-    static getSitemap(id: number): Promise<SitemapAPIResponse>;
-    /**
-     * TODO: JSDoc
-     */
-    static getSocials(id: number, cacheKey?: string): Promise<SocialsResponse>;
-}
-export { SitesService };

package/build/services/store.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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(storeDir: string, domain: string): Promise<void>;
-export { createStore };

package/build/start-render.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-declare function startRender(): Promise<void>;
-export { startRender };

package/build/types/api.d.ts

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

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

@@ -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: "header";
-};

package/build/types/pages.d.ts

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