@griddo/cx 11.9.9-rc.0 → 11.9.9-rc.1

package/build/services/auth.d.ts

@@ -1,7 +1,10 @@
-import type { AuthHeaders } from "../shared/types/api";
+import type { AuthHeaders } from "../types/api";
+/**
+ * Service for authentication in the Griddo Private API
+ */
 declare class AuthService {
     headers: AuthHeaders | undefined;
-    login(): Promise<AuthHeaders>;
+    login(): Promise<AuthHeaders | undefined>;
 }
 declare const authService: AuthService;
 export { authService as AuthService };

package/build/services/domains.d.ts

@@ -1,5 +1,6 @@
+import type { Domains } from "../types/global";
 /**
- * Return an array of domains name (string) of the current instance.
+ * Get an array of available domain.
  */
-declare function getInstanceDomains(): Promise<string[]>;
-export { getInstanceDomains };
+declare function getAllDomains(): Promise<Domains>;
+export { getAllDomains };

package/build/services/navigation.d.ts

@@ -1,45 +1,45 @@
-import type { Footer, Header } from "../shared/types/navigation";
-import type { APIPageObject } from "../shared/types/pages";
+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: Header[];
-        footers: Footer[];
+        headers: Array<Header>;
+        footers: Array<Footer>;
     });
     get navigations(): {
-        headers: Header[];
-        footers: Footer[];
+        headers: Array<Header>;
+        footers: Array<Footer>;
     };
     getDefaultFooters(): Record<number, Footer>;
     getDefaultHeaders(): Record<number, Header>;
-    getRightLanguage(list: {
+    getRightLanguage(list: Array<{
         language: number;
-        navigationLanguages: {
+        navigationLanguages: Array<{
             navigationId: number;
-        }[];
+        }>;
         id: number;
-    }[], id: number, language: number): {
+    }>, id: number, language: number): {
         language: number;
-        navigationLanguages: {
+        navigationLanguages: Array<{
             navigationId: number;
-        }[];
+        }>;
         id: number;
     } | null;
     getPageHeader(id: number, language: number): {
         language: number;
-        navigationLanguages: {
+        navigationLanguages: Array<{
             navigationId: number;
-        }[];
+        }>;
         id: number;
     } | null;
     getPageFooter(id: number, language: number): {
         language: number;
-        navigationLanguages: {
+        navigationLanguages: Array<{
             navigationId: number;
-        }[];
+        }>;
         id: number;
     } | null;
     getPageNavigations(page: APIPageObject): {

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

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

package/build/services/register.d.ts

@@ -0,0 +1,36 @@
+type Entry = Record<string, unknown>;
+type EntryData = {
+    title: string;
+    description: string;
+    entries: Array<Entry>;
+};
+type Entries = Record<string, EntryData>;
+interface RegisterBase<T extends Entries> {
+    insert(name: keyof T, entry: Entry): void;
+    get(name: keyof T): EntryData;
+    getAll(): T;
+}
+declare class MemoryRegister<T extends Entries> implements RegisterBase<T> {
+    entries: T;
+    constructor(entries: T);
+    insert(name: keyof T, entry: Entry): void;
+    get(name: keyof T): T[keyof T];
+    getAll(): T;
+}
+declare class FileRegister<T extends Entries> implements RegisterBase<T> {
+    private readonly filePath;
+    entries: T;
+    constructor(filePath: string, entries: T);
+    private getCurrentEntries;
+    insert(name: keyof T, entry: Entry): void;
+    get(name: keyof T): EntryData;
+    getAll(): T;
+}
+declare class Register<T extends Entries> {
+    private strategy;
+    constructor(strategy: RegisterBase<T>);
+    insert<K extends keyof T>(name: K, entry: Entry): void;
+    get<K extends keyof T>(name: K): EntryData;
+    getAll(): T;
+}
+export { FileRegister, MemoryRegister, Register, type Entries, type Entry, type EntryData, };

package/build/services/robots.d.ts

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

package/build/services/settings.d.ts

@@ -0,0 +1,4 @@
+import type { Settings } from "../types/global";
+declare function getAllSettings(): Promise<Settings>;
+declare function resetRender(): Promise<void>;
+export { getAllSettings, resetRender };

package/build/services/sites.d.ts

@@ -1,6 +1,6 @@
+import type { AllSitesReponse, EndPageInfoResponse, EndSiteRenderBody, LanguagesResponse, ReferenceFieldBody, ReferenceFieldResponse, SitemapAPIResponse, SocialsResponse, StartPageRenderResponse } from "../types/api";
+import type { Site } from "../types/sites";
 import type { Core } from "@griddo/core";
-import type { AllSitesReponse, EndSiteRenderBody, LanguagesResponse, ReferenceFieldBody, ReferenceFieldResponse, SitemapAPIResponse, SocialsResponse, StartPageRenderResponse } from "../shared/types/api";
-import type { Site } from "../shared/types/sites";
 /**
  * Get a list of site objects.
  */
@@ -12,7 +12,7 @@ declare function getAllSitesFromDomain(domain: string): Promise<Site[]>;
 /**
  * Fetch a page object from API.
  */
-declare function getPage(id: number, cacheKey: string): Promise<import("../shared/types/pages").APIPageObject>;
+declare function getPage(id: number, cacheKey: string): Promise<import("../types/pages").APIPageObject>;
 /**
  * Get site info
  */
@@ -22,11 +22,8 @@ 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<void>;
+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 getSitemap(id: number): Promise<SitemapAPIResponse>;
 declare function getSiteSocials(id: number, cacheKey?: string): Promise<SocialsResponse>;
 export { endSiteRender, getAllSites, getAllSitesFromDomain, getPage, getReferenceFieldSiteData, getSiteInfo, getSiteLanguages, getSitemap, getSiteSocials, startSiteRender, };

package/build/services/store.d.ts

@@ -1,15 +1,6 @@
-import { type RenderMode } from "../shared/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[];
-}>;
+declare function createStore(domain: string): Promise<void>;
 export { createStore };