Implement events for external use + Rename interfaces with a I prefix + add some documentation (#26)

Implement events for external use
Rename interfaces with a I prefix
Add some documentation

Co-authored-by: Eric NGUYEN <enguyen@techform.fr>
Reviewed-on: https://git.siklos-chaneru.duckdns.org/Siklos/svg-layout-designer-react/pulls/26

.gitattributes

@@ -0,0 +1 @@
+*.drawio filter=lfs diff=lfs merge=lfs -text

public/Interfaces.d.ts

@@ -0,0 +1,65 @@
+declare interface IHistoryState {
+  LastAction: string
+  MainContainer: IContainerModel
+  SelectedContainer: IContainerModel | null
+  SelectedContainerId: string
+  TypeCounters: Record<string, number>
+}
+
+declare interface IAvailableContainer {
+  Type: string
+  Width: number
+  Height: number
+  XPositionReference?: XPositionReference
+  Style: React.CSSProperties
+}
+
+declare interface IEditorState {
+  history: IHistoryState[]
+  historyCurrentStep: number
+  configuration: IConfiguration
+}
+
+declare interface IConfiguration {
+  AvailableContainers: IAvailableContainer[]
+  AvailableSymbols: IAvailableSymbol[]
+  MainContainer: IAvailableContainer
+}
+
+declare interface IContainerModel {
+  children: IContainerModel[]
+  parent: IContainerModel | null
+  properties: IProperties
+  userData: Record<string, string | number>
+}
+
+declare interface IProperties extends React.CSSProperties {
+  id: string
+  parentId: string | null
+  x: number
+  y: number
+  isRigidBody: boolean
+  XPositionReference?: XPositionReference
+}
+
+declare enum XPositionReference {
+  Left,
+  Center,
+  Right
+}
+
+declare interface IAvailableSymbol {
+  Name: string
+  XPositionReference: XPositionReference
+  Image: IImage
+  Width: number
+  Height: number
+}
+
+declare interface IImage {
+  Name: string
+  Url: string
+  Base64Image: string
+  Svg: string
+}
+

src/Components/API/api.ts

@@ -1,10 +1,10 @@
-import { Configuration } from '../../Interfaces/Configuration';
+import { IConfiguration } from '../../Interfaces/IConfiguration';
 
 /**
  * Fetch the configuration from the API
  * @returns {Configation} The model of the configuration for the application
  */
-export async function fetchConfiguration(): Promise<Configuration> {
+export async function fetchConfiguration(): Promise<IConfiguration> {
   const url = `${import.meta.env.VITE_API_URL}`;
   // The test library cannot use the Fetch API
   // @ts-expect-error
@@ -15,7 +15,7 @@ export async function fetchConfiguration(): Promise<Configuration> {
     })
       .then(async(response) =>
         await response.json()
-      ) as Configuration;
+      ) as IConfiguration;
   }
   return await new Promise((resolve) => {
     const xhr = new XMLHttpRequest();

src/Components/App/App.tsx

@@ -1,8 +1,9 @@
 import React, { useEffect, useState } from 'react';
 import './App.scss';
 import { MainMenu } from '../MainMenu/MainMenu';
-import { ContainerModel } from '../../Interfaces/ContainerModel';
-import Editor, { IEditorState } from '../Editor/Editor';
+import { ContainerModel } from '../../Interfaces/IContainerModel';
+import Editor from '../Editor/Editor';
+import { IEditorState } from '../../Interfaces/IEditorState';
 import { LoadState } from './Load';
 import { LoadEditor, NewEditor } from './MenuActions';
 import { DEFAULT_CONFIG, DEFAULT_MAINCONTAINER_PROPS } from '../../utils/default';

src/Components/App/Load.ts

@@ -1,6 +1,6 @@
 import { Dispatch, SetStateAction } from 'react';
 import { Revive } from '../../utils/saveload';
-import { IEditorState } from '../Editor/Editor';
+import { IEditorState } from '../../Interfaces/IEditorState';
 
 export function LoadState(
   editorState: IEditorState,

src/Components/App/MenuActions.ts

@@ -1,8 +1,8 @@
 import { Dispatch, SetStateAction } from 'react';
-import { Configuration } from '../../Interfaces/Configuration';
-import { ContainerModel } from '../../Interfaces/ContainerModel';
+import { IConfiguration } from '../../Interfaces/IConfiguration';
+import { ContainerModel } from '../../Interfaces/IContainerModel';
 import { fetchConfiguration } from '../API/api';
-import { IEditorState } from '../Editor/Editor';
+import { IEditorState } from "../../Interfaces/IEditorState";
 import { LoadState } from './Load';
 
 export function NewEditor(
@@ -11,7 +11,7 @@ export function NewEditor(
 ): void {
   // Fetch the configuration from the API
   fetchConfiguration()
-    .then((configuration: Configuration) => {
+    .then((configuration: IConfiguration) => {
       // Set the main container from the given properties of the API
       const MainContainer = new ContainerModel(
         null,

src/Components/Editor/ContainerOperations.ts

@@ -1,7 +1,7 @@
 import { Dispatch, SetStateAction } from 'react';
-import { HistoryState } from '../../Interfaces/HistoryState';
-import { Configuration } from '../../Interfaces/Configuration';
-import { ContainerModel, IContainerModel } from '../../Interfaces/ContainerModel';
+import { IHistoryState } from '../../Interfaces/IHistoryState';
+import { IConfiguration } from '../../Interfaces/IConfiguration';
+import { ContainerModel, IContainerModel } from '../../Interfaces/IContainerModel';
 import { findContainerById } from '../../utils/itertools';
 import { getCurrentHistory } from './Editor';
 
@@ -11,9 +11,9 @@ import { getCurrentHistory } from './Editor';
  */
 export function SelectContainer(
   container: ContainerModel,
-  fullHistory: HistoryState[],
+  fullHistory: IHistoryState[],
   historyCurrentStep: number,
-  setHistory: Dispatch<SetStateAction<HistoryState[]>>,
+  setHistory: Dispatch<SetStateAction<IHistoryState[]>>,
   setHistoryCurrentStep: Dispatch<SetStateAction<number>>
 ): void {
   const history = getCurrentHistory(fullHistory, historyCurrentStep);
@@ -46,9 +46,9 @@ export function SelectContainer(
  */
 export function DeleteContainer(
   containerId: string,
-  fullHistory: HistoryState[],
+  fullHistory: IHistoryState[],
   historyCurrentStep: number,
-  setHistory: Dispatch<SetStateAction<HistoryState[]>>,
+  setHistory: Dispatch<SetStateAction<IHistoryState[]>>,
   setHistoryCurrentStep: Dispatch<SetStateAction<number>>
 ): void {
   const history = getCurrentHistory(fullHistory, historyCurrentStep);
@@ -108,10 +108,10 @@ export function DeleteContainer(
  */
 export function AddContainerToSelectedContainer(
   type: string,
-  configuration: Configuration,
-  fullHistory: HistoryState[],
+  configuration: IConfiguration,
+  fullHistory: IHistoryState[],
   historyCurrentStep: number,
-  setHistory: Dispatch<SetStateAction<HistoryState[]>>,
+  setHistory: Dispatch<SetStateAction<IHistoryState[]>>,
   setHistoryCurrentStep: Dispatch<SetStateAction<number>>
 ): void {
   const history = getCurrentHistory(fullHistory, historyCurrentStep);
@@ -151,10 +151,10 @@ export function AddContainer(
   index: number,
   type: string,
   parentId: string,
-  configuration: Configuration,
-  fullHistory: HistoryState[],
+  configuration: IConfiguration,
+  fullHistory: IHistoryState[],
   historyCurrentStep: number,
-  setHistory: Dispatch<SetStateAction<HistoryState[]>>,
+  setHistory: Dispatch<SetStateAction<IHistoryState[]>>,
   setHistoryCurrentStep: Dispatch<SetStateAction<number>>
 ): void {
   const history = getCurrentHistory(fullHistory, historyCurrentStep);

src/Components/Editor/Editor.tsx

@@ -1,32 +1,29 @@
-import React from 'react';
+import React, { useRef } from 'react';
 import './Editor.scss';
-import { Configuration } from '../../Interfaces/Configuration';
+import { IConfiguration } from '../../Interfaces/IConfiguration';
 import { SVG } from '../SVG/SVG';
-import { HistoryState } from '../../Interfaces/HistoryState';
+import { IHistoryState } from '../../Interfaces/IHistoryState';
 import { UI } from '../UI/UI';
 import { SelectContainer, DeleteContainer, AddContainerToSelectedContainer, AddContainer } from './ContainerOperations';
 import { SaveEditorAsJSON, SaveEditorAsSVG } from './Save';
 import { onKeyDown } from './Shortcuts';
 import { OnPropertyChange, OnPropertiesSubmit } from './PropertiesOperations';
+import EditorEvents from '../../Events/EditorEvents';
+import { IEditorState } from '../../Interfaces/IEditorState';
 
 interface IEditorProps {
-  configuration: Configuration
-  history: HistoryState[]
+  configuration: IConfiguration
+  history: IHistoryState[]
   historyCurrentStep: number
 }
 
-export interface IEditorState {
-  history: HistoryState[]
-  historyCurrentStep: number
-  configuration: Configuration
-}
-
-export const getCurrentHistory = (history: HistoryState[], historyCurrentStep: number): HistoryState[] => history.slice(0, historyCurrentStep + 1);
-export const getCurrentHistoryState = (history: HistoryState[], historyCurrentStep: number): HistoryState => history[historyCurrentStep];
+export const getCurrentHistory = (history: IHistoryState[], historyCurrentStep: number): IHistoryState[] => history.slice(0, historyCurrentStep + 1);
+export const getCurrentHistoryState = (history: IHistoryState[], historyCurrentStep: number): IHistoryState => history[historyCurrentStep];
 
 const Editor: React.FunctionComponent<IEditorProps> = (props) => {
-  const [history, setHistory] = React.useState<HistoryState[]>(structuredClone(props.history));
+  const [history, setHistory] = React.useState<IHistoryState[]>(structuredClone(props.history));
   const [historyCurrentStep, setHistoryCurrentStep] = React.useState<number>(props.historyCurrentStep);
+  const editorRef = useRef<HTMLDivElement>(null);
 
   React.useEffect(() => {
     const onKeyUp = (event: KeyboardEvent): void => onKeyDown(
@@ -38,6 +35,17 @@ const Editor: React.FunctionComponent<IEditorProps> = (props) => {
 
     window.addEventListener('keyup', onKeyUp);
 
+    const events = EditorEvents;
+    const editorState: IEditorState = {
+      history,
+      historyCurrentStep,
+      configuration: props.configuration
+    };
+
+    for (const event of events) {
+      editorRef.current?.addEventListener(event.name, () => event.func(editorState));
+    }
+
     return () => {
       window.removeEventListener('keyup', onKeyUp);
     };
@@ -46,7 +54,7 @@ const Editor: React.FunctionComponent<IEditorProps> = (props) => {
   const configuration = props.configuration;
   const current = getCurrentHistoryState(history, historyCurrentStep);
   return (
-    <div className="App font-sans h-full">
+    <div ref={editorRef} className="Editor font-sans h-full">
       <UI
         current={current}
         history={history}

src/Components/Editor/PropertiesOperations.ts

@@ -1,7 +1,7 @@
 import { Dispatch, SetStateAction } from 'react';
-import { IContainerModel, ContainerModel } from '../../Interfaces/ContainerModel';
-import { HistoryState } from '../../Interfaces/HistoryState';
-import Properties from '../../Interfaces/Properties';
+import { IContainerModel, ContainerModel } from '../../Interfaces/IContainerModel';
+import { IHistoryState } from '../../Interfaces/IHistoryState';
+import IProperties from '../../Interfaces/IProperties';
 import { findContainerById } from '../../utils/itertools';
 import { getCurrentHistory } from './Editor';
 import { RecalculatePhysics } from './RigidBodyBehaviors';
@@ -15,9 +15,9 @@ import { RecalculatePhysics } from './RigidBodyBehaviors';
 export function OnPropertyChange(
   key: string,
   value: string | number | boolean,
-  fullHistory: HistoryState[],
+  fullHistory: IHistoryState[],
   historyCurrentStep: number,
-  setHistory: Dispatch<SetStateAction<HistoryState[]>>,
+  setHistory: Dispatch<SetStateAction<IHistoryState[]>>,
   setHistoryCurrentStep: Dispatch<SetStateAction<number>>
 ): void {
   const history = getCurrentHistory(fullHistory, historyCurrentStep);
@@ -73,10 +73,10 @@ export function OnPropertyChange(
   */
 export function OnPropertiesSubmit(
   event: React.SyntheticEvent<HTMLFormElement>,
-  properties: Properties,
-  fullHistory: HistoryState[],
+  properties: IProperties,
+  fullHistory: IHistoryState[],
   historyCurrentStep: number,
-  setHistory: Dispatch<SetStateAction<HistoryState[]>>,
+  setHistory: Dispatch<SetStateAction<IHistoryState[]>>,
   setHistoryCurrentStep: Dispatch<SetStateAction<number>>
 ): void {
   event.preventDefault();

src/Components/Editor/RigidBodyBehaviors.ts

@@ -1,5 +1,5 @@
-import { IContainerModel } from '../../Interfaces/ContainerModel';
-import { SizePointer } from '../../Interfaces/SizePointer';
+import { IContainerModel } from '../../Interfaces/IContainerModel';
+import { ISizePointer } from '../../Interfaces/ISizePointer';
 
 /**
  * "Transform the container into a rigid body"
@@ -167,17 +167,17 @@ function constraintBodyInsideUnallocatedWidth(
  * (except the fact that disk space is divided by block).
  * @param container Container where to find an available width
  * @param exception Container to exclude of the widths (since a container will be moved, it might need to be excluded)
- * @returns {SizePointer[]} Array of unallocated widths (x=position of the unallocated space, width=size of the allocated space)
+ * @returns {ISizePointer[]} Array of unallocated widths (x=position of the unallocated space, width=size of the allocated space)
  */
 function getAvailableWidths(
   container: IContainerModel,
   exception: IContainerModel
-): SizePointer[] {
+): ISizePointer[] {
   // Initialize the first size pointer
   // which takes full width of the available space
   const x = 0;
   const width = Number(container.properties.width);
-  let unallocatedSpaces: SizePointer[] = [{ x, width }];
+  let unallocatedSpaces: ISizePointer[] = [{ x, width }];
 
   // We will only uses containers that also have the rigid bodies
   // as out-of-bound or enormouse containers should be ignored
@@ -192,7 +192,7 @@ function getAvailableWidths(
     }
 
     // get the space of the child that is inside the parent
-    let newUnallocatedSpace: SizePointer[] = [];
+    let newUnallocatedSpace: ISizePointer[] = [];
 
     // We will iterate on a mutable variable in order to divide it
     for (const unallocatedSpace of unallocatedSpaces) {
@@ -229,7 +229,7 @@ function getAvailableWidthsTwoLines(
   max1: number,
   min2: number,
   max2: number
-): SizePointer[] {
+): ISizePointer[] {
   if (min2 < min1 && max2 > max1) {
     // object 2 is overlapping full width
     return [];
@@ -276,5 +276,5 @@ function getAvailableWidthsTwoLines(
  */
 const isFitting = (
   container: IContainerModel,
-  sizePointer: SizePointer
+  sizePointer: ISizePointer
 ): boolean => Number(container.properties.width) <= sizePointer.width;

src/Components/Editor/Save.ts

@@ -1,13 +1,13 @@
-import { HistoryState } from '../../Interfaces/HistoryState';
-import { Configuration } from '../../Interfaces/Configuration';
+import { IHistoryState } from '../../Interfaces/IHistoryState';
+import { IConfiguration } from '../../Interfaces/IConfiguration';
 import { getCircularReplacer } from '../../utils/saveload';
 import { ID } from '../SVG/SVG';
-import { IEditorState } from './Editor';
+import { IEditorState } from '../../Interfaces/IEditorState';
 
 export function SaveEditorAsJSON(
-  history: HistoryState[],
+  history: IHistoryState[],
   historyCurrentStep: number,
-  configuration: Configuration
+  configuration: IConfiguration
 ): void {
   const exportName = 'state';
   const spaces = import.meta.env.DEV ? 4 : 0;

src/Components/Editor/Shortcuts.ts

@@ -1,9 +1,9 @@
 import { Dispatch, SetStateAction } from 'react';
-import { HistoryState } from '../../Interfaces/HistoryState';
+import { IHistoryState } from '../../Interfaces/IHistoryState';
 
 export function onKeyDown(
   event: KeyboardEvent,
-  history: HistoryState[],
+  history: IHistoryState[],
   historyCurrentStep: number,
   setHistoryCurrentStep: Dispatch<SetStateAction<number>>
 ): void {

src/Components/ElementsSidebar/ElementsSidebar.test.tsx

@@ -2,7 +2,7 @@ import { describe, expect, it, vi } from 'vitest';
 import * as React from 'react';
 import { fireEvent, render, screen } from '../../utils/test-utils';
 import { ElementsSidebar } from './ElementsSidebar';
-import { IContainerModel } from '../../Interfaces/ContainerModel';
+import { IContainerModel } from '../../Interfaces/IContainerModel';
 
 describe.concurrent('Elements sidebar', () => {
   it('With a MainContainer', () => {

src/Components/ElementsSidebar/ElementsSidebar.tsx

@@ -1,13 +1,13 @@
 import * as React from 'react';
 import { motion } from 'framer-motion';
 import { Properties } from '../Properties/Properties';
-import ContainerProperties from '../../Interfaces/Properties';
-import { IContainerModel } from '../../Interfaces/ContainerModel';
+import ContainerProperties from '../../Interfaces/IProperties';
+import { IContainerModel } from '../../Interfaces/IContainerModel';
 import { getDepth, MakeIterator } from '../../utils/itertools';
 import { Menu } from '../Menu/Menu';
 import { MenuItem } from '../Menu/MenuItem';
 import { handleDragLeave, handleDragOver, handleLeftClick, handleOnDrop, handleRightClick } from './MouseEventHandlers';
-import { Point } from '../../Interfaces/Point';
+import { IPoint } from '../../Interfaces/IPoint';
 
 interface IElementsSidebarProps {
   MainContainer: IContainerModel
@@ -64,7 +64,7 @@ export const ElementsSidebar: React.FC<IElementsSidebarProps> = (props: IElement
   // States
   const [isContextMenuOpen, setIsContextMenuOpen] = React.useState<boolean>(false);
   const [onClickContainerId, setOnClickContainerId] = React.useState<string>('');
-  const [contextMenuPosition, setContextMenuPosition] = React.useState<Point>({
+  const [contextMenuPosition, setContextMenuPosition] = React.useState<IPoint>({
     x: 0,
     y: 0
   });

src/Components/ElementsSidebar/MouseEventHandlers.ts

@@ -1,12 +1,12 @@
-import { IContainerModel } from '../../Interfaces/ContainerModel';
-import { Point } from '../../Interfaces/Point';
+import { IContainerModel } from '../../Interfaces/IContainerModel';
+import { IPoint } from '../../Interfaces/IPoint';
 import { findContainerById } from '../../utils/itertools';
 
 export function handleRightClick(
   event: MouseEvent,
   setIsContextMenuOpen: React.Dispatch<React.SetStateAction<boolean>>,
   setOnClickContainerId: React.Dispatch<React.SetStateAction<string>>,
-  setContextMenuPosition: React.Dispatch<React.SetStateAction<Point>>
+  setContextMenuPosition: React.Dispatch<React.SetStateAction<IPoint>>
 ): void {
   event.preventDefault();
 
@@ -16,7 +16,7 @@ export function handleRightClick(
     return;
   }
 
-  const contextMenuPosition: Point = { x: event.pageX, y: event.pageY };
+  const contextMenuPosition: IPoint = { x: event.pageX, y: event.pageY };
   setIsContextMenuOpen(true);
   setOnClickContainerId(event.target.id);
   setContextMenuPosition(contextMenuPosition);

src/Components/History/History.tsx

@@ -1,8 +1,8 @@
 import * as React from 'react';
-import { HistoryState } from "../../Interfaces/HistoryState";
+import { IHistoryState } from "../../Interfaces/IHistoryState";
 
 interface IHistoryProps {
-  history: HistoryState[]
+  history: IHistoryState[]
   historyCurrentStep: number
   isOpen: boolean
   jumpTo: (move: number) => void

src/Components/Properties/Properties.tsx

@@ -1,5 +1,5 @@
 import React, { useState } from 'react';
-import ContainerProperties from '../../Interfaces/Properties';
+import ContainerProperties from '../../Interfaces/IProperties';
 import { ToggleButton } from '../ToggleButton/ToggleButton';
 import { INPUT_TYPES } from './PropertiesInputTypes';
 

src/Components/SVG/Elements/Container.tsx

@@ -1,10 +1,10 @@
 import * as React from 'react';
 import { XPositionReference } from '../../../Enums/XPositionReference';
-import { IContainerModel } from '../../../Interfaces/ContainerModel';
+import { IContainerModel } from '../../../Interfaces/IContainerModel';
 import { getDepth } from '../../../utils/itertools';
 import { Dimension } from './Dimension';
 
-export interface IContainerProps {
+interface IContainerProps {
   model: IContainerModel
 }
 

src/Components/SVG/Elements/Selector.tsx

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { IContainerModel } from '../../../Interfaces/ContainerModel';
+import { IContainerModel } from '../../../Interfaces/IContainerModel';
 import { getAbsolutePosition } from '../../../utils/itertools';
 
 interface ISelectorProps {

src/Components/SVG/SVG.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { UncontrolledReactSVGPanZoom } from 'react-svg-pan-zoom';
 import { Container } from './Elements/Container';
-import { ContainerModel } from '../../Interfaces/ContainerModel';
+import { ContainerModel } from '../../Interfaces/IContainerModel';
 import { Selector } from './Elements/Selector';
 import { BAR_WIDTH } from '../Bar/Bar';
 

src/Components/Sidebar/Sidebar.tsx

@@ -1,9 +1,9 @@
 import * as React from 'react';
-import { AvailableContainer } from '../../Interfaces/AvailableContainer';
+import { IAvailableContainer } from '../../Interfaces/IAvailableContainer';
 import { truncateString } from '../../utils/stringtools';
 
 interface ISidebarProps {
-  componentOptions: AvailableContainer[]
+  componentOptions: IAvailableContainer[]
   isOpen: boolean
   buttonOnClick: (type: string) => void
 }

src/Components/UI/UI.tsx

@@ -2,23 +2,23 @@ import * as React from 'react';
 import { ElementsSidebar } from '../ElementsSidebar/ElementsSidebar';
 import { Sidebar } from '../Sidebar/Sidebar';
 import { History } from '../History/History';
-import { AvailableContainer } from '../../Interfaces/AvailableContainer';
-import { ContainerModel } from '../../Interfaces/ContainerModel';
-import { HistoryState } from '../../Interfaces/HistoryState';
+import { IAvailableContainer } from '../../Interfaces/IAvailableContainer';
+import { ContainerModel } from '../../Interfaces/IContainerModel';
+import { IHistoryState } from '../../Interfaces/IHistoryState';
 import { PhotographIcon, UploadIcon } from '@heroicons/react/outline';
 import { FloatingButton } from '../FloatingButton/FloatingButton';
 import { Bar } from '../Bar/Bar';
-import Properties from '../../Interfaces/Properties';
+import IProperties from '../../Interfaces/IProperties';
 
 interface IUIProps {
-  current: HistoryState
-  history: HistoryState[]
+  current: IHistoryState
+  history: IHistoryState[]
   historyCurrentStep: number
-  AvailableContainers: AvailableContainer[]
+  AvailableContainers: IAvailableContainer[]
   SelectContainer: (container: ContainerModel) => void
   DeleteContainer: (containerId: string) => void
   OnPropertyChange: (key: string, value: string | number | boolean) => void
-  OnPropertiesSubmit: (event: React.FormEvent<HTMLFormElement>, properties: Properties) => void
+  OnPropertiesSubmit: (event: React.FormEvent<HTMLFormElement>, properties: IProperties) => void
   AddContainerToSelectedContainer: (type: string) => void
   AddContainer: (index: number, type: string, parentId: string) => void
   SaveEditorAsJSON: () => void

src/Events/EditorEvents.ts

@@ -0,0 +1,26 @@
+import { IEditorState } from '../Interfaces/IEditorState';
+import { IHistoryState } from '../Interfaces/IHistoryState';
+
+const getEditorState = (editorState: IEditorState): void => {
+  const customEvent = new CustomEvent<IEditorState>('getEditorState', { detail: editorState });
+  document.dispatchEvent(customEvent);
+};
+
+const getCurrentHistoryState = (editorState: IEditorState): void => {
+  const customEvent = new CustomEvent<IHistoryState>(
+    'getCurrentHistoryState',
+    { detail: editorState.history[editorState.historyCurrentStep] });
+  document.dispatchEvent(customEvent);
+};
+
+export interface IEditorEvent {
+  name: string
+  func: (editorState: IEditorState) => void
+}
+
+const events: IEditorEvent[] = [
+  { name: 'getEditorState', func: getEditorState },
+  { name: 'getCurrentHistoryState', func: getCurrentHistoryState }
+];
+
+export default events;

src/Interfaces/Configuration.ts

@@ -1,9 +0,0 @@
-import { AvailableContainer } from './AvailableContainer';
-import { AvailableSymbolModel } from './AvailableSymbol';
-
-/** Model of configuration for the application to configure it */
-export interface Configuration {
-  AvailableContainers: AvailableContainer[]
-  AvailableSymbols: AvailableSymbolModel[]
-  MainContainer: AvailableContainer
-}

src/Interfaces/IAvailableContainer.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { XPositionReference } from '../Enums/XPositionReference';
 
 /** Model of available container used in application configuration */
-export interface AvailableContainer {
+export interface IAvailableContainer {
   Type: string
   Width: number
   Height: number

src/Interfaces/IAvailableSymbol.ts

@@ -1,12 +1,12 @@
 import { XPositionReference } from '../Enums/XPositionReference';
-import { Image } from './Image';
+import { IImage } from './IImage';
 
 /**
  * Model of available symbol to configure the application */
-export interface AvailableSymbolModel {
+export interface IAvailableSymbol {
   Name: string
   XPositionReference: XPositionReference
-  Image: Image
+  Image: IImage
   Width: number
   Height: number
 }

src/Interfaces/IConfiguration.ts

@@ -0,0 +1,9 @@
+import { IAvailableContainer } from './IAvailableContainer';
+import { IAvailableSymbol } from './IAvailableSymbol';
+
+/** Model of configuration for the application to configure it */
+export interface IConfiguration {
+  AvailableContainers: IAvailableContainer[]
+  AvailableSymbols: IAvailableSymbol[]
+  MainContainer: IAvailableContainer
+}

src/Interfaces/IContainerModel.ts

@@ -1,21 +1,21 @@
-import Properties from './Properties';
+import IProperties from './IProperties';
 
 export interface IContainerModel {
   children: IContainerModel[]
   parent: IContainerModel | null
-  properties: Properties
+  properties: IProperties
   userData: Record<string, string | number>
 }
 
 export class ContainerModel implements IContainerModel {
   public children: IContainerModel[];
   public parent: IContainerModel | null;
-  public properties: Properties;
+  public properties: IProperties;
   public userData: Record<string, string | number>;
 
   constructor(
     parent: IContainerModel | null,
-    properties: Properties,
+    properties: IProperties,
     children: IContainerModel[] = [],
     userData = {}) {
     this.parent = parent;

src/Interfaces/IEditorState.tsx

@@ -0,0 +1,8 @@
+import { IConfiguration } from './IConfiguration';
+import { IHistoryState } from './IHistoryState';
+
+export interface IEditorState {
+  history: IHistoryState[]
+  historyCurrentStep: number
+  configuration: IConfiguration
+}

src/Interfaces/IHistoryState.ts

@@ -1,6 +1,6 @@
-import { IContainerModel } from './ContainerModel';
+import { IContainerModel } from './IContainerModel';
 
-export interface HistoryState {
+export interface IHistoryState {
   LastAction: string
   MainContainer: IContainerModel
   SelectedContainer: IContainerModel | null

src/Interfaces/IImage.ts

@@ -1,5 +1,5 @@
 /** Model of an image with multiple source */
-export interface Image {
+export interface IImage {
   Name: string
   Url: string
   Base64Image: string

src/Interfaces/IPoint.ts

@@ -1,4 +1,4 @@
-export interface Point {
+export interface IPoint {
   x: number
   y: number
 }

src/Interfaces/IProperties.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { XPositionReference } from '../Enums/XPositionReference';
 
-export default interface Properties extends React.CSSProperties {
+export default interface IProperties extends React.CSSProperties {
   id: string
   parentId: string | null
   x: number

src/Interfaces/ISizePointer.ts

@@ -3,7 +3,7 @@
  * x being the address where the pointer is pointing
  * width being the overall (un)allocated space affected to the address
  */
-export interface SizePointer {
+export interface ISizePointer {
   x: number
   width: number
 }

src/utils/default.ts

@@ -1,7 +1,7 @@
-import { Configuration } from '../Interfaces/Configuration';
-import Properties from '../Interfaces/Properties';
+import { IConfiguration } from '../Interfaces/IConfiguration';
+import IProperties from '../Interfaces/IProperties';
 
-export const DEFAULT_CONFIG: Configuration = {
+export const DEFAULT_CONFIG: IConfiguration = {
   AvailableContainers: [
     {
       Type: 'Container',
@@ -25,7 +25,7 @@ export const DEFAULT_CONFIG: Configuration = {
   }
 };
 
-export const DEFAULT_MAINCONTAINER_PROPS: Properties = {
+export const DEFAULT_MAINCONTAINER_PROPS: IProperties = {
   id: 'main',
   parentId: 'null',
   x: 0,

src/utils/itertools.ts

@@ -1,4 +1,4 @@
-import { IContainerModel } from '../Interfaces/ContainerModel';
+import { IContainerModel } from '../Interfaces/IContainerModel';
 
 /**
  * Returns a Generator iterating of over the children depth-first

src/utils/saveload.ts

@@ -1,5 +1,5 @@
 import { findContainerById, MakeIterator } from './itertools';
-import { IEditorState } from '../Components/Editor/Editor';
+import { IEditorState } from '../Interfaces/IEditorState';
 
 /**
  * Revive the Editor state