@griddo/cx 10.4.12 → 10.4.13

package/build/services/auth.d.ts

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

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

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

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

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

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

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

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

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