@griddo/core 1.74.37 → 1.75.1

package/README.md

@@ -1,81 +1,75 @@
+<p align="center">
+  <img src="./src/assets/griddo-core-logo.png" alt="Griddo starter logo" width="280" />
+</p>
+
+<blockquote>
+  <p>The beauty of a living thing is not the atoms that go into it, but the way those atoms are put together.</p>
+  <footer>— <a href="https://en.wikipedia.org/wiki/Carl_Sagan">Carl Sagan</a></footer>
+</blockquote>
+
+<br/>
+
 # Griddo Core
 
-Componentes, hooks, utilidades e implementaciones comunes para todo Griddo y las instancias.
+Components, hooks and common utilities for the instances and the Griddo product itself written in Typescript.
 
-## Componentes
+## Types
 
-- `<CloudinaryBackgroundImage />`
-- `<CloudinaryImage />`
-- `<Component />`
-- `<GriddoBackgroundImage />`
-- `<GriddoImage />`
-- `<GriddoLink />`
-- `<LdJson />`
-- `<ModulePreview />`
-- `<Page />`
-- `<Preview />`
+- `Schema` Griddo schema types
+- `Fields` Griddo fields (API return for schema fields) types
+- `Core` Griddo common types
+- `Theme` Griddo theme creation types
 
-## Contextos
+## Components
 
-- I18n
-- Page
-- Site
+- `<CloudinaryBackgroundImage>`
+- `<CloudinaryImage>`
+- `<Component>`
+- `<GriddoBackgroundImage>`
+- `<GriddoImage>`
+- `<GriddoLink>`
+- `<LdJson>`
+- `<ModulePreview>`
+- `<Page>`
+- `<Preview>`
 
 ## Hooks
 
-- `useAvif()`
 - `useDataFilters()`
-- `useDistributorData()`
-- `useReferenceFieldData()` como alias for `useDistributorData()`
+- `useDistributorData()` alias for `useReferenceFieldData()`
 - `useGriddoImage()`
 - `useI18n()`
 - `useImage()`
-- `useLink()`
-- `usePage()`
+- `useList()`
 - `usePage()`
+- `useReferenceFieldData()`
 - `useSite()`
-- `useSitemap()`
-- `useWebp()`
-
-## Funciones para schemas
-
-Pretenden facilitar la creación de schemas, utilizando funciones y tipado en TypeScript. Activando sugerencias, autocompletado y checking en el editor. (Probado en VSCode)
-
-Las instancias que no usen TypeScript deben añadir la "directiva" `// @ts-check` para que el intellisense funcione como si se estuviera en un entorno TypeScript.
-
-```javascript
-// @ts-check
-import { createUISchema } from "@griddo/core";
-
-export default createUISChema({
-  component: "BascicContent",
-  ...
-});
-```
-
-<br/>
-<br/>
-
-<p align='center'><strong>Autocompletado FTW!</strong></p>
-
-<p align="center">
-<img src="./src/assets/autocomplete.png" width='600'/>
-</p>
-
-<br/>
-<br/>
-
-### Funciones
-
-- `createCategoriesSchema`: Crea un schema para un dato de tipo categoría (taxonomy).
-- `createDamDefaultsSchema`: Crea un schema para las opciones por defecto del DAM.
-- `createDataPackCategoriesSchema`: Crea un schema para una categoría de DataPack.
-- `createDataPackSchema`: Crea un schema para un DataPack.
-- `createLanguagesSchema`: Crea un schema para los idiomas de la instancia.
-- `createMenuSchema`: Crea un schema para un menú.
-- `createModuleCategoriesSchema`: Crea un schema de categorías de módulos.
-- `createPageDataSchema`: Crea un schema de UI para un dato estructurado de página.
-- `createPureDataSchema`: Crea un schema de UI para un dato estructurado puro.
-- `createThemesSchema`: Crea un schema para los temas.
-- `createTranslationsSchema`: Crea un schema de traducciones estáticas (i18n)
-- `createUISchema`: Crea un schema de UI para un componente, módulo o template.
+- `useuNavigation()`
+
+## Contexts and Providers
+
+- `<I18n>`
+- `<Page>`
+- `<Site>`
+- `<NavigationProvider>`
+
+## Functions
+
+**Schemas**
+
+- `createCategoryContentTypeSchema`
+- `createComponentSchema`
+- `createDamDefaultsSchema`
+- `createDataPackCategorySchema`
+- `createDataPackSchema`
+- `createFooterSchema`
+- `createHeaderSchema`
+- `createLanguagesSchema`
+- `createMenuSchema`
+- `createModuleCategoriesSchema`
+- `createModuleSchema`
+- `createPageContentTypeSchema`
+- `createSimpleContentTypeSchema`
+- `createTemplateSchema`
+- `createThemesSchema`
+- `createTranslationsSchema`

package/dist/assets/svg/Delete.d.ts

@@ -0,0 +1,3 @@
+import * as React from "react";
+declare const SvgDelete: (props: React.SVGProps<SVGSVGElement>) => JSX.Element;
+export default SvgDelete;

package/dist/assets/svg/Duplicate.d.ts

@@ -0,0 +1,3 @@
+import * as React from "react";
+declare const SvgDuplicate: (props: React.SVGProps<SVGSVGElement>) => JSX.Element;
+export default SvgDuplicate;

package/dist/components/CloudinaryBackgroundImage/index.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="react" />
+import "./styles.css";
+/**
+ * `<CloudinaryBackgroundImage>`
+ *
+ * @deprecated This component will be removed from Griddo in the future.
+ */
+declare function CloudinaryBackgroundImage({ backgroundRepeat, backgroundSize, backgroundPosition, children, overlayColor, overlayOpacity, overlayTransition, ratio, publicId, src, customLazyClassName, lazy, ...props }: {
+    [x: string]: any;
+    backgroundRepeat?: string | undefined;
+    backgroundSize?: string | undefined;
+    backgroundPosition?: string | undefined;
+    children: any;
+    overlayColor?: null | undefined;
+    overlayOpacity?: number | undefined;
+    overlayTransition?: string | undefined;
+    ratio: any;
+    publicId: any;
+    src: any;
+    customLazyClassName?: string | undefined;
+    lazy: any;
+}): JSX.Element;
+export { CloudinaryBackgroundImage };

package/dist/components/CloudinaryImage/index.d.ts

@@ -0,0 +1,30 @@
+import * as React from "react";
+import "react-aspect-ratio/aspect-ratio.css";
+import { CloudinaryImageCrop, CloudinaryImageFormat, CloudinaryResponsiveImageProps } from "../../hooks/useImage";
+import { ImageDecoding, ImageLoading } from "../../types/core";
+/**
+ * `<CloudinaryImage>`
+ *
+ * @deprecated This component will be removed from Griddo in the future.
+ */
+declare function CloudinaryImage(props: CloudinaryImageProps): JSX.Element;
+export interface CloudinaryImageProps {
+    alt?: string;
+    width?: string;
+    height?: string;
+    ratio?: number | string;
+    fixed?: boolean;
+    publicId?: string;
+    src?: string;
+    objectFit?: React.CSSProperties["objectFit"];
+    quality?: number;
+    crop?: CloudinaryImageCrop;
+    gravity?: string;
+    format?: CloudinaryImageFormat;
+    loading?: ImageLoading;
+    backgroundLazy?: boolean;
+    decoding?: ImageDecoding;
+    sizes?: string;
+    responsive?: Array<CloudinaryResponsiveImageProps>;
+}
+export { CloudinaryImage };

package/dist/components/Component/ComponentWrapper/index.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import "./style.css";
+/**
+ * `<Wrapper>`
+ */
+declare const Wrapper: (props: WrapperProps) => JSX.Element;
+interface WrapperProps {
+    selectedEditorID: number | null;
+    editorID?: number;
+    component: string;
+    type?: string;
+    parentEditorID?: number;
+    isSelectionAllowed: boolean;
+    children: JSX.Element;
+}
+export { Wrapper as ComponentWrapper };

package/dist/components/Component/index.d.ts

@@ -0,0 +1,27 @@
+import * as React from "react";
+/**
+ * `<Component>`
+ *
+ * Griddo core component to render dynamically a component/module (using the `component` prop) from the `libComponents` (a list of React components) with the props we provide to it
+ *
+ * @example
+ * import Hero from './Hero'
+ * import CardCollection from './CardCollection'
+ * const moduleList = { Hero, CardCollection }
+ *
+ * // Render the Hero component from `moduleList` with `props`
+ * <Component
+ *   libComponents={moduleList}
+ *   {{ component: 'Hero', ...props }}
+ * />
+ */
+declare function Component({ libComponents, ...props }: ComponentProps): JSX.Element | null;
+export interface ComponentProps {
+    libComponents: Record<string, React.FC<Omit<ComponentProps, "libComponents">>>;
+    editorID?: number;
+    component: string;
+    type?: string;
+    parentEditorID?: number;
+    [key: string]: unknown;
+}
+export { Component };

package/dist/components/GriddoBackgroundImage/index.d.ts

@@ -0,0 +1,7 @@
+import * as React from "react";
+import "./styles.css";
+/**
+ * `<GriddoBackgroundImage>`
+ */
+declare const GriddoBackgroundImage: React.ForwardRefExoticComponent<React.RefAttributes<unknown>>;
+export { GriddoBackgroundImage };

package/dist/components/GriddoImage/index.d.ts

@@ -0,0 +1,57 @@
+import * as React from "react";
+import "react-aspect-ratio/aspect-ratio.css";
+import { FetchPriority, ImageCropType, ImageDecoding, ImageLoading, ImagePosition, ImageTransform, ResponsiveImageProps } from "../../types/core";
+import "./styles.css";
+/**
+ * `<GriddoImage>`
+ *
+ * Renders an image from the **Griddo** cdn.
+ * Also return a ref with the `<picture>` tag.
+ * [Documentation](https://www.notion.so/griddoio/GriddoImage-a3973298b4e7447884f29185dae2d07e)
+ *
+ * @example
+ * <GriddoImage
+ *   url="https://images.griddo.io/butterfly"
+ *   width="640px"
+ *   height="480px"
+ *   quality={75}
+ * />
+ */
+declare const GriddoImage: React.ForwardRefExoticComponent<(Pick<GriddoImageJpgWebpAvif, "fixed" | "slot" | "style" | "title" | "children" | "color" | "lang" | "id" | "is" | "url" | "key" | "referrerPolicy" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "crop" | "responsive" | "decoding" | "format" | "height" | "loading" | "quality" | "width" | "alt" | "ratio" | "formats" | "position" | "transforms" | "crossOrigin" | "useMap" | "fetchpriority"> | Pick<GriddoImageGif, "fixed" | "slot" | "style" | "title" | "children" | "color" | "lang" | "id" | "is" | "url" | "key" | "referrerPolicy" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "crop" | "responsive" | "decoding" | "format" | "height" | "loading" | "quality" | "width" | "alt" | "ratio" | "formats" | "position" | "transforms" | "crossOrigin" | "useMap" | "fetchpriority"> | Pick<GriddoImageSvg, "fixed" | "slot" | "style" | "title" | "children" | "color" | "lang" | "id" | "is" | "url" | "key" | "referrerPolicy" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "crop" | "responsive" | "decoding" | "format" | "height" | "loading" | "quality" | "width" | "alt" | "ratio" | "formats" | "position" | "transforms" | "crossOrigin" | "useMap" | "fetchpriority">) & React.RefAttributes<HTMLPictureElement>>;
+interface GriddoImageCommonProps extends Omit<React.ComponentPropsWithRef<"img">, "src" | "srcSet" | "sizes" | "width" | "height"> {
+    crop?: ImageCropType;
+    fetchpriority?: FetchPriority;
+    height?: string;
+    position?: ImagePosition;
+    url?: string;
+    width?: string;
+    ratio?: number;
+    fixed?: boolean;
+    loading?: ImageLoading;
+    decoding?: ImageDecoding;
+    responsive?: Array<ResponsiveImageProps>;
+    quality?: number;
+    formats?: Array<"webp" | "avif">;
+    transforms?: ImageTransform;
+}
+interface GriddoImageSvg extends GriddoImageCommonProps {
+    format?: "svg";
+    responsive?: never;
+    quality?: never;
+    formats?: never;
+    transforms?: never;
+    ratio?: never;
+}
+interface GriddoImageGif extends GriddoImageCommonProps {
+    format?: "gif";
+    responsive?: never;
+    quality?: never;
+    formats?: never;
+    transforms?: never;
+}
+interface GriddoImageJpgWebpAvif extends GriddoImageCommonProps {
+    /** Format is set automatically based on formats prop */
+    format?: never;
+}
+export declare type GriddoImageProps = GriddoImageJpgWebpAvif | GriddoImageGif | GriddoImageSvg;
+export { GriddoImage };

package/dist/components/GriddoLink/index.d.ts

@@ -0,0 +1,59 @@
+import * as React from "react";
+import { UrlField } from "../../types/fields";
+/**
+ * <`GriddoLink>`
+ *
+ * Renders a router component from internal/external Griddo link.
+ * You may want to use `<GriddoLink>` instead of an `<a>` tag for internal Griddo pages.
+ * [Documentation](https://www.notion.so/griddoio/GriddoLink-bc4f7cddd1484648b024d4bebe4b74c3)
+ *
+ * @example
+ * <GriddoLink
+ *   activeClass="activeLink"
+ *   url={ linkToURL: 'https://...' }
+ * />
+ */
+declare function GriddoLink({ activeClassName, activeStyle, style, children, getProps, partiallyActive, state, url, title, className, ...props }: GriddoLinkProps): JSX.Element;
+export interface HLocation<S = unknown> {
+    pathname: string;
+    search: string;
+    state: S;
+    hash: string;
+    key?: string | undefined;
+}
+export declare type WindowLocation<S = unknown> = Window["location"] & HLocation<S>;
+export interface LinkGetProps {
+    /** `true` if the location.pathname is exactly the same as the anchor’s href. */
+    isCurrent: boolean;
+    /** `true` if the location.pathname is exactly the same as the anchor’s href. */
+    isPartiallyCurrent: boolean;
+    /** The fully resolved href of the link. */
+    href: string;
+    /** The app’s location. */
+    location: WindowLocation;
+}
+export interface GriddoLinkProps extends Omit<React.ComponentPropsWithoutRef<"a">, "href"> {
+    /** Griddo UrlField with the link data */
+    url?: UrlField;
+    /** Calls up to you to get props for the underlying anchor element. Useful for styling the anchor as active. */
+    getProps?: ((props: LinkGetProps) => Record<string, never>) | undefined;
+    /** A class name that will be applied the current item is active. */
+    activeClassName?: string;
+    /** A style object that will be applied when the current item is active. */
+    activeStyle?: React.CSSProperties;
+    /** Whether partial URLs are considered active (e.g. /blog#hello-world matches <Link to="/blog"> if partiallyActive is true). */
+    partiallyActive?: boolean;
+    /** If `true`, the latest entry on the history stack will be replaced with a new one. Use this when you don’t want the previous page to show up when the user clicks the back button. */
+    replace?: boolean;
+    /** Used to pass state data to the linked page.
+     * The linked page will have a `location` prop containing a nested `state` object structure containing the passed data. */
+    state?: Record<string, unknown>;
+    /** @deprecated If using React >= 16.4, use ref instead. */
+    innerRef?: React.Ref<HTMLAnchorElement> | undefined;
+    /** If using React >=16.4, Link will forward its ref to you. */
+    ref?: (node: HTMLAnchorElement | null) => React.ReactNode;
+    /** onCLick event */
+    onClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
+    children?: React.ReactNode;
+}
+export { GriddoLink };

package/dist/components/GriddoLink/utils.d.ts

@@ -0,0 +1,9 @@
+import { FullPath } from "../../types/core";
+export declare function getEnvironment(fullPath?: FullPath): "pre" | "pro";
+export declare function getRel(newTab: boolean, noFollow: boolean): string;
+export declare function getTarget(newTab: boolean): "_blank" | "_self";
+export declare function getRelativeToRootPath({ env, fullPath, to, }: {
+    env: string;
+    fullPath: FullPath;
+    to?: string;
+}): string | undefined;

package/dist/components/LdJson/index.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+/**
+ * `<LdJson>`
+ *
+ * Inject a google structured data into the `<header>`
+ *
+ * @example
+ * <LdJson data={schemaData} />
+ */
+declare function LdJson(props: LdJsonProps): JSX.Element;
+interface LdJsonProps {
+    data: Record<string, unknown>;
+}
+export { LdJson };

package/dist/components/Link/index.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+import { UrlField } from "../../types/fields";
+/**
+ * `<Link>`
+ *
+ * @deprecated This component will be removed from Griddo in the future.
+ */
+declare function Link(props: LinkProps): JSX.Element;
+interface LinkProps {
+    url: UrlField;
+    linkProp?: string;
+    children: JSX.Element;
+    [key: string]: unknown;
+}
+export { Link };

package/dist/components/ModulePreview/index.d.ts

@@ -0,0 +1,15 @@
+import * as React from "react";
+import { Page } from "../../types/core";
+import { ComponentProps } from "../Component";
+/**
+ * `<ModulePreview>`
+ */
+declare function ModulePreview(props: ModulePreviewProps): JSX.Element | null;
+export interface ModulePreviewProps {
+    component: string;
+    content: Pick<Page, "title" | "breadcrumb" | "fullPath" | "fullUrl" | "siteSlug" | "template" | "origin" | "site" | "modified" | "published" | "structuredDataContent" | "dimensions" | "isHome">;
+    library: {
+        components: Record<string, React.FC<Omit<ComponentProps, "libComponents">>>;
+    };
+}
+export { ModulePreview };

package/dist/components/Page/index.d.ts

@@ -0,0 +1,16 @@
+import * as React from "react";
+import { Page } from "../../types/core";
+import { ComponentProps } from "../Component";
+/**
+ * `<PageComponent>`
+ */
+declare function PageComponent(props: PageProps): JSX.Element;
+export interface PageProps extends Pick<Page, "apiUrl" | "footer" | "header" | "languageId" | "pageLanguages" | "siteMetadata"> {
+    content: Pick<Page, "breadcrumb" | "dimensions" | "fullPath" | "fullUrl" | "isHome" | "modified" | "origin" | "published" | "site" | "siteSlug" | "structuredDataContent" | "template" | "title">;
+    library: {
+        components: Record<string, React.FC<Omit<ComponentProps, "libComponents">>>;
+        templates: Record<string, React.FC<Omit<ComponentProps, "libComponents">>>;
+    };
+    children: JSX.Element;
+}
+export { PageComponent as Page };

package/dist/components/Preview/index.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { ModulePreviewProps } from "../ModulePreview";
+import { PageProps } from "../Page";
+/**
+ * `<Preview>`
+ */
+declare function Preview(props: PreviewProps): JSX.Element;
+export declare type PreviewProps = {
+    isPage?: boolean;
+} & (ModulePreviewProps | PageProps);
+export { Preview };

package/dist/components/index.d.ts

@@ -0,0 +1,12 @@
+import { CloudinaryBackgroundImage } from "./CloudinaryBackgroundImage";
+import { CloudinaryImage } from "./CloudinaryImage";
+import { Component } from "./Component";
+import { GriddoBackgroundImage } from "./GriddoBackgroundImage";
+import { GriddoImage } from "./GriddoImage";
+import { GriddoLink } from "./GriddoLink";
+import { LdJson } from "./LdJson";
+import { Link } from "./Link";
+import { ModulePreview } from "./ModulePreview";
+import { Page } from "./Page";
+import { Preview } from "./Preview";
+export { CloudinaryBackgroundImage, CloudinaryImage, Component, GriddoBackgroundImage, GriddoImage, GriddoLink, LdJson, Link, ModulePreview, Page, Preview, };

package/dist/constants/cloudinary.d.ts

@@ -0,0 +1,17 @@
+declare const _default: {
+    domain: string;
+    uploadFolder: string;
+    fallback404ImageId: string;
+    quality: number;
+    crop: string;
+    gravity: string;
+    format: string;
+    loading: string;
+    backgroundLazy: boolean;
+    decoding: string;
+    responsive: {
+        breakpoint: null;
+        width: string;
+    }[];
+};
+export default _default;

package/dist/contexts/I18n/index.d.ts

@@ -0,0 +1,24 @@
+import * as React from "react";
+import { LocaleTranslations } from "../../types/core";
+declare const I18nContext: React.Context<I18nContextProps>;
+/**
+ * `<I18nProvider>`
+ *
+ * This provider component inject the `translation` object in the context of the site. Then you can retrieve the translation based on the page language using the `useI18n()` hook.
+ */
+declare function I18nProvider(props: I18nProviderProps): JSX.Element;
+interface I18nContextProps {
+    translations?: LocaleTranslations;
+}
+interface I18nProviderProps {
+    children: JSX.Element;
+    /** Object with static translations using local i18n locale codes.
+     * @example
+     * {
+     *   es_ES: { hi: "Hola", ... }
+     *   en_US: { hi: "Hello", ... }
+     * }
+     */
+    translations?: LocaleTranslations;
+}
+export { I18nContext, I18nProvider };

package/dist/contexts/Navigation/index.d.ts

@@ -0,0 +1,13 @@
+import * as React from "react";
+declare const NavigationContext: React.Context<NavigationContextProps | null>;
+/**
+ * `<NavigationProvider>`
+ */
+declare function NavigationProvider(props: NavigationProviderProps): JSX.Element;
+export interface NavigationContextProps {
+    isNavigation: true;
+}
+interface NavigationProviderProps {
+    children: JSX.Element;
+}
+export { NavigationContext, NavigationProvider };

package/dist/contexts/Page/index.d.ts

@@ -0,0 +1,15 @@
+import * as React from "react";
+import { Page } from "../../types/core";
+declare const PageContext: React.Context<Partial<PageProps>>;
+/**
+ * `<PageProvider>`
+ *
+ * This provider component inject some props in the context of the page. Then you can retrieve the context values using the `usePage()` hook.
+ */
+declare function PageProvider(props: PageProviderProps): JSX.Element;
+declare type PageProps = Pick<Page, "activeSectionBase" | "activeSectionSlug" | "apiUrl" | "breadcrumb" | "componentList" | "dimensions" | "firstModule" | "footer" | "fullPath" | "fullUrl" | "header" | "isHome" | "isIndexed" | "languageId" | "metaDescription" | "metasAdvanced" | "metaTitle" | "modified" | "origin" | "pageLanguages" | "published" | "sectionModules" | "site" | "siteMetadata" | "siteSlug" | "socialDescription" | "socialImage" | "socialTitle" | "structuredDataContent" | "title">;
+export declare type PageContextProps = Partial<PageProps>;
+export interface PageProviderProps extends PageProps {
+    children: JSX.Element;
+}
+export { PageContext, PageProvider };

package/dist/contexts/Site/index.d.ts

@@ -0,0 +1,27 @@
+import * as React from "react";
+import { GriddoLinkProps } from "../../components/GriddoLink";
+import { Site } from "../../types/core";
+declare const SiteContext: React.Context<SiteContextProps>;
+/**
+ * `<SiteProvider>`
+ */
+declare function SiteProvider(props: SiteProviderProps): JSX.Element;
+export interface SiteContextProps extends Site {
+    [key: string]: unknown;
+    linkComponent: (props: GriddoLinkProps) => JSX.Element;
+    navigate: () => null;
+    selectEditorID?(selectedComponent: {
+        editorID?: number;
+        component: string;
+        type?: string;
+        parentEditorID?: number;
+    }, parentComponent: string | undefined | null, e: React.SyntheticEvent): void;
+    moduleActions?: {
+        deleteModuleAction: (editorID: number) => void;
+        duplicateModuleAction: (editorID: number) => void;
+    };
+}
+export interface SiteProviderProps extends Site {
+    children: JSX.Element;
+}
+export { SiteContext, SiteProvider };

package/dist/contexts/index.d.ts

@@ -0,0 +1,4 @@
+import { NavigationContext, NavigationProvider } from "./Navigation";
+import { PageContext, PageProvider } from "./Page";
+import { SiteContext, SiteProvider } from "./Site";
+export { PageContext, PageProvider, SiteContext, SiteProvider, NavigationContext, NavigationProvider, };