@griddo/cx 10.4.16 → 10.4.18

package/build/types/sites.d.ts

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

@@ -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 distributor data */
-export type TemplateWithDistributor = Template & {
-    queriedItems?: Fields.QueriedData<unknown>;
-    itemsPerPage?: number;
-};

package/build/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, putApi as put, postApi as post };

package/build/utils/cache.d.ts

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

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

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

package/build/utils/folders.d.ts

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

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

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

package/build/utils/messages.d.ts

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

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

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

package/build/utils/shared.d.ts

@@ -1,109 +0,0 @@
-import type { Adapters } from "../adapters";
-import type { APIResponses } from "../types/api";
-import type { LifeCyclesNames } from "../types/global";
-import type { Site } from "../types/sites";
-declare const CXRootDir: string;
-declare const instanceRootDir: string;
-/**
- * Walk a directory and returns the file pathts.
- *
- * @param dir A directory path.
- */
-declare function walk(dir: string): string[];
-/**
- * Custom log inside a line-box.
- *
- * @param stringValue The string to be logged.
- * @param paddingInline The number of white spaces inside the box at left and right.
- * @param paddingBlock The number of white spaces inside the box at top and bottom.
- */
-declare function logBox(stringValue: string, title?: string, paddingInline?: number, paddingBlock?: number): void;
-/**
- * Custom basic logging function controlled by a environment variable.
- * Strip double spaces.
- *
- * @param str The string to be logged.
- */
-declare function logInfo(str: string): void;
-/**
- * Internal log
- * @param values The values to be logged.
- */
-declare function debug(...values: Array<unknown>): void;
-/**
- * Custom delay using the "promise hack",
- *
- * @param ms Amount of miliseconds to be delayed
- */
-declare function delay(ms: number): Promise<unknown>;
-/**
- * Return a scale size colors with a number and a measure string (KB by default).
- *
- * @param size The page size in KB.
- * @param measure The measure string to be added in the log.
- */
-declare function logPageSize(size: number, measure?: string): string;
-/**
- * Converts milliseconds to seconds with a fixed number of decimals.
- *
- * @param ms The number in milliseconds.
- * @param fixed The amount of fixed decimals.
- * @returns The converted number in seconds with the fixed number of decimals.
- */
-export declare function msToSec(ms: number, decimals?: number): string;
-/**
- * Return a siteID from a response object if exist
- * @param response A response object
- */
-export declare function getSafeSiteId(response: APIResponses): number | undefined;
-/**
- * Remove props from an object
- *
- * @param obj The object
- * @param props An array of props to be removed
- */
-declare function removeProperties(obj: Record<string, unknown>, props: Array<string>): void;
-/**
- * Return a list of sites with their names and ids.
- *
- * @param sites An array of sites objects
- */
-declare function siteList(sites: Array<Site>): string;
-/**
- * Print the great Griddo Exporter logo in ASCII.
- */
-declare function printExporterLogo(adapter: Adapters): void;
-/**
- * Remove unused files (old) inside the `apiCache` dir
- *
- * @param dirPath The path for the `apiCache` dir
- * @todo remove other file types: sites, socials, etc..
- */
-declare function sanitizeAPICacheDir(dirPath: string): void;
-/**
- * Measures the execution time of a series of sync or async functions.
- * @param functions - Functions to be executed to measure their execution time.
- * @returns A promise that resolves with the total execution time in seconds.
- */
-declare function measureExecutionTime(...functions: Array<(...args: Array<unknown>) => unknown | Promise<any>>): Promise<number>;
-declare function pause(title: string): Promise<void> | undefined;
-declare function startLifeCycle(lifeCyleName: string): void;
-declare function successLifeCyle(value: string): void;
-/**
- * Executes a life cycle process, which involves executing an array of
- * functions, printing to the console, and handling errors with optional
- * retries.
- *
- * @async
- * @param args - The arguments object.
- * @param args.steps - An array of functions to execute.
- * @param args.name - The name of the life cycle.
- * @param [args.attempts=1] - The number of retry attempts allowed in case of errors.
- * @returns - A promise that resolves when the life cycle process is completed.
- */
-declare function doLifeCycle(args: {
-    steps: Array<(...args: Array<unknown>) => unknown | Promise<any>>;
-    name: LifeCyclesNames;
-    attempts?: number;
-}): Promise<void>;
-export { CXRootDir, debug, delay, doLifeCycle, instanceRootDir, logBox, logInfo, logPageSize, measureExecutionTime, pause, printExporterLogo, removeProperties, sanitizeAPICacheDir, siteList, startLifeCycle, successLifeCyle, walk, };

package/build/utils/sites.d.ts

@@ -1,36 +0,0 @@
-import type { Site, SiteData } from "../types/sites";
-/**
- * Check the instance sites and returns site prepared to be published and unpublished.
- */
-declare function checkSites(domain: string): Promise<{
-    sitesToPublish: Site[];
-    sitesToUnpublish: Site[];
-}>;
-/**
- * Unpublish an array of sites in two steps:
- * - Sending the information to the API
- *
- * @param sites An array of sites
- * @see https://griddoio.notion.site/Sites-d7bb0b7cb8d24894a5337e1139fc3d09#2019d3255bda4d219c7e19cf28d0c4fe
- */
-declare function unpublishSites(sites: Array<Site>): Promise<void>;
-/**
- * Return a single site generic data.
- *
- * @param siteID The site id.
- * @param cacheKey Boolean that indicates if we want to get cache version.
- *
- * @see SiteData
- */
-declare function getSiteData(siteID: number): Promise<SiteData>;
-/**
- * Save a file with the end of build process
- */
-declare function generateBuildReport(): Promise<void>;
-/**
- * Generate sitemaps and save them into file system.
- *
- * @param sites An array of sites
- */
-declare function generateSitemaps(): Promise<void>;
-export { checkSites, generateBuildReport, generateSitemaps, getSiteData, unpublishSites, };

package/build/utils/store.d.ts

@@ -1,63 +0,0 @@
-import type { BuildMetaData } from "../types/api";
-import type { RenderInfo } from "../types/global";
-import type { GriddoPageObject } from "../types/pages";
-import { Site } from "../types/sites";
-/**
- * Read all pages stored in `store` Griddo directory and return one by one with
- * a generator.
- */
-declare function getBuildPages<PageType extends GriddoPageObject>(basePath: string): AsyncGenerator<PageType, void, unknown>;
-/**
- * Get the build metadata from the Store.
- * TODO: Refactorizar para leer un solo archivo: __metadata__.json
- */
-declare function getBuildMetadata(): Promise<BuildMetaData>;
-/**
- * Creates an `store` dir to store pages transformed by createStore
- */
-declare function createStoreDir(storeDir: string): void;
-/**
- * Write render info into a file.
- * @param basePath - Absolute path of the dir from which files will be saved.
- * @param renderInfo - Data that will be saved related to the render process.
- */
-declare function saveRenderInfoInStore(basePath: string, renderInfo: RenderInfo): void;
-/**
- * Return an array of ids only from `.json` files (no dirs) in the `basePath` dir based in the file name.
- * @param basePath - Absolute path of the dir from which files will be read.
- * @returns A Array<number> of pages ids in `basePath` dir.
- */
-declare function getPageInStoreDir(basePath: string): Array<number>;
-/**
- * Save the pages into the file system.
- * @param basePath - Absolute path of the dir from which files will be saved.
- * @param pages - An array of Griddo page objects to be saved.
- */
-declare function savePagesInStore(basePath: string, pages: Array<GriddoPageObject>): void;
-/**
- * Remove files from dir.
- * @param basePath - Absolute path of the dir from which files will be removed.
- * @param filenames - An array of ids representing file page names.
- */
-declare function removePagesFromStore(basePath: string, filenames: Array<number>): void;
-/**
- * Returns pages that need to be created or deleted for a site in the store based on the provided arguments.
- * @param sitePages - Properties for page retrieval.
- * @param props.storeDir - Absolute path of the Griddo store.
- * @param props.pages - Exhaustive array of all pages in the site.
- * @param props.validPagesIds - Array of valid pages in the site.
- * @param props.changedPages - Array of pages that have been modified in the site.
- * @returns - An object containing the pages to be created and deleted in the site.
- */
-declare function getPagesToCreateOrDelete(storeDir: string, sitePages: {
-    sitesToPublish: Array<Site>;
-    pages: Array<number>;
-    validPagesIds: Array<number>;
-    changedPages: Array<number>;
-}): Promise<{
-    pagesInStore: number[];
-    pagesMissingInStore: number[];
-    pagesToDeleteFromStore: number[];
-    pagesToWriteToStore: number[];
-}>;
-export { createStoreDir, getBuildMetadata, getBuildPages, getPageInStoreDir, getPagesToCreateOrDelete, removePagesFromStore, savePagesInStore, saveRenderInfoInStore, };

package/build/utils/temp-utils.d.ts

@@ -1,10 +0,0 @@
-import { CXConfig } from "../types/global";
-declare function getConfig(): CXConfig;
-/**
- * Update the Griddo's `/dist` dir with the contents from `public` dir only
- * with files of type: js, json and css.
- */
-declare function legacy__createDistFromGatsbyPublic(domain: string, needsAssetPrefix: boolean): Promise<void>;
-declare function griddoCreateInitialDirectories(domain: string): Promise<void>;
-declare function griddoCleanDisposableDirectories(domain: string): Promise<void>;
-export { getConfig, griddoCleanDisposableDirectories, griddoCreateInitialDirectories, legacy__createDistFromGatsbyPublic, };

package/ssg/README.md

@@ -1 +0,0 @@
-# SGG Directory

package/ssg/gatsby/.eslintrc.json

@@ -1,51 +0,0 @@
-{
-	"env": {
-		"browser": true,
-		"node": true,
-		"es6": true
-	},
-	"extends": [
-		"plugin:node/recommended",
-		"eslint:recommended",
-		"plugin:@typescript-eslint/eslint-recommended",
-		"plugin:@typescript-eslint/recommended"
-	],
-	"plugins": ["node", "react", "prettier", "import"],
-	"parserOptions": {
-		"ecmaVersion": 2020,
-		"ecmaFeatures": { "jsx": true },
-		"sourceType": "module",
-		"allowImportExportEverywhere": true
-	},
-	"parser": "@typescript-eslint/parser",
-	"rules": {
-		"@typescript-eslint/explicit-module-boundary-types": 0,
-		"@typescript-eslint/no-explicit-any": 0,
-		"@typescript-eslint/no-non-null-assertion": 0,
-		"@typescript-eslint/array-type": ["error", { "default": "generic" }],
-		"no-process-exit": 0,
-		"node/no-missing-import": 0,
-		"node/no-unsupported-features/es-syntax": 0,
-		"node/no-extraneous-import": 0,
-		"react/jsx-uses-react": "error",
-		"react/jsx-uses-vars": "error",
-		"linebreak-style": ["error", "unix"],
-		"no-mixed-spaces-and-tabs": ["error", "smart-tabs"],
-		"import/order": [
-			"error",
-			{
-				"newlines-between": "always",
-				"groups": [
-					["type"],
-					["builtin"],
-					["external"],
-					["parent", "internal", "sibling", "index", "unknown"]
-				],
-				"alphabetize": {
-					"order": "asc",
-					"caseInsensitive": true
-				}
-			}
-		]
-	}
-}

package/ssg/gatsby/.prettierignore

@@ -1,6 +0,0 @@
-.cache
-apiCache
-build
-dist
-exports
-public

package/ssg/gatsby/.prettierrc.json

@@ -1,3 +0,0 @@
-{
-	"useTabs": true
-}

package/ssg/gatsby/package.json

@@ -1,12 +0,0 @@
-{
-	"name": "@griddo/gatsby",
-	"description": "gatsbyjs",
-	"license": "UNLICENSED",
-	"scripts": {
-		"clean": "gatsby clean; rm -rf .cache public assets",
-		"gatsby-build": "gatsby telemetry --disable && gatsby build --prefix-paths"
-	},
-	"dependencies": {
-		"gatsby": "^4.8.0"
-	}
-}

package/ssg/gatsby/tsconfig.json

@@ -1,15 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "esnext",
-		"lib": ["dom", "esnext"],
-		"jsx": "react",
-		"module": "esnext",
-		"moduleResolution": "node",
-		"esModuleInterop": true,
-		"forceConsistentCasingInFileNames": true,
-		"strict": true,
-		"skipLibCheck": true,
-		"resolveJsonModule": true
-	},
-	"include": ["./src/**/*", "./*.ts", "./*.tsx"]
-}