@micromag/core 0.4.46 → 0.4.48

package/es/components.js

@@ -21,7 +21,6 @@ import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
 import isObject from 'lodash/isObject';
 import isArray from 'lodash/isArray';
 import isString from 'lodash/isString';
-import { Helmet } from 'react-helmet';
 import { createPortal } from 'react-dom';
 import queryString from 'query-string';
 import { faAd } from '@fortawesome/free-solid-svg-icons/faAd';
@@ -43,13 +42,13 @@ import { useSpringRef, useSpring } from '@react-spring/core';
 import { config, animated } from '@react-spring/web';
 
 /* eslint-disable react/jsx-props-no-spreading */
-var emptyObject$3 = {};
+var emptyObject$2 = {};
 function Label(_ref) {
   var children = _ref.children,
     _ref$isHtml = _ref.isHtml,
     isHtml = _ref$isHtml === void 0 ? false : _ref$isHtml,
     _ref$values = _ref.values,
-    values = _ref$values === void 0 ? emptyObject$3 : _ref$values;
+    values = _ref$values === void 0 ? emptyObject$2 : _ref$values;
   var Message = isHtml ? FormattedMessage : FormattedMessage;
   return isMessage(children) ? /*#__PURE__*/React.createElement(Message, Object.assign({
     values: values
@@ -173,10 +172,10 @@ function Button$1(_ref) {
 var styles$x = {"container":"micromag-core-buttons-container"};
 
 var _excluded$b = ["id", "name", "className", "onClick", "theme"];
-var emptyArray$a = [];
+var emptyArray$9 = [];
 function Buttons(_ref) {
   var _ref$buttons = _ref.buttons,
-    buttons = _ref$buttons === void 0 ? emptyArray$a : _ref$buttons,
+    buttons = _ref$buttons === void 0 ? emptyArray$9 : _ref$buttons,
     _ref$size = _ref.size,
     size = _ref$size === void 0 ? null : _ref$size,
     _ref$theme = _ref.theme,
@@ -259,8 +258,8 @@ function ClearButton(_ref) {
 
 var _excluded$8 = ["type"],
   _excluded2 = ["component", "id", "settings"];
-var emptyArray$9 = [];
-var emptyObject$2 = {};
+var emptyArray$8 = [];
+var emptyObject$1 = {};
 function FieldForm(_ref) {
   var _ref$name = _ref.name,
     name = _ref$name === void 0 ? null : _ref$name,
@@ -269,9 +268,9 @@ function FieldForm(_ref) {
     _ref$form = _ref.form,
     form = _ref$form === void 0 ? null : _ref$form,
     _ref$formComponents = _ref.formComponents,
-    formComponents = _ref$formComponents === void 0 ? emptyObject$2 : _ref$formComponents,
+    formComponents = _ref$formComponents === void 0 ? emptyObject$1 : _ref$formComponents,
     _ref$fields = _ref.fields,
-    fields = _ref$fields === void 0 ? emptyArray$9 : _ref$fields,
+    fields = _ref$fields === void 0 ? emptyArray$8 : _ref$fields,
     _ref$className = _ref.className,
     className = _ref$className === void 0 ? null : _ref$className,
     _ref$onChange = _ref.onChange,
@@ -342,13 +341,13 @@ function FieldForm(_ref) {
 
 var styles$v = {"container":"micromag-core-forms-form-container","panel":"micromag-core-forms-form-panel","actions":"micromag-core-forms-form-actions","left":"micromag-core-forms-form-left","right":"micromag-core-forms-form-right"};
 
-var emptyArray$8 = [];
+var emptyArray$7 = [];
 function Form(_ref) {
   var action = _ref.action,
     _ref$method = _ref.method,
     method = _ref$method === void 0 ? 'POST' : _ref$method,
     _ref$fields = _ref.fields,
-    initialFields = _ref$fields === void 0 ? emptyArray$8 : _ref$fields,
+    initialFields = _ref$fields === void 0 ? emptyArray$7 : _ref$fields,
     _ref$initialValue = _ref.initialValue,
     initialValue = _ref$initialValue === void 0 ? null : _ref$initialValue,
     _ref$postForm = _ref.postForm,
@@ -922,10 +921,10 @@ function UnmuteIcon(_ref) {
 
 var styles$r = {"container":"micromag-core-menus-breadcrumb-container","arrow":"micromag-core-menus-breadcrumb-arrow"};
 
-var emptyArray$7 = [];
+var emptyArray$6 = [];
 function Breadcrumb(_ref) {
   var _ref$items = _ref.items,
-    items = _ref$items === void 0 ? emptyArray$7 : _ref$items,
+    items = _ref$items === void 0 ? emptyArray$6 : _ref$items,
     _ref$theme = _ref.theme,
     theme = _ref$theme === void 0 ? null : _ref$theme,
     _ref$separator = _ref.separator,
@@ -969,10 +968,10 @@ function Breadcrumb(_ref) {
 }
 
 var _excluded$4 = ["type", "className", "label", "children", "onClick", "active"];
-var emptyArray$6 = [];
+var emptyArray$5 = [];
 function Dropdown(_ref) {
   var _ref$items = _ref.items,
-    items = _ref$items === void 0 ? emptyArray$6 : _ref$items,
+    items = _ref$items === void 0 ? emptyArray$5 : _ref$items,
     _ref$children = _ref.children,
     children = _ref$children === void 0 ? null : _ref$children,
     _ref$visible = _ref.visible,
@@ -1058,10 +1057,10 @@ function Dropdown(_ref) {
 }
 
 var _excluded$3 = ["id", "className", "linkClassName", "href", "label", "external", "items", "dropdown", "active", "onClick"];
-var emptyArray$5 = [];
+var emptyArray$4 = [];
 function Menu(_ref) {
   var _ref$items = _ref.items,
-    items = _ref$items === void 0 ? emptyArray$5 : _ref$items,
+    items = _ref$items === void 0 ? emptyArray$4 : _ref$items,
     _ref$tagName = _ref.tagName,
     tagName = _ref$tagName === void 0 ? 'ul' : _ref$tagName,
     _ref$itemTagName = _ref.itemTagName,
@@ -1374,10 +1373,10 @@ function PaginationMenu(_ref) {
 var styles$o = {"container":"micromag-core-menus-tabs-container"};
 
 /* eslint-disable react/no-array-index-key, react/jsx-props-no-spreading */
-var emptyArray$4 = [];
+var emptyArray$3 = [];
 function TabsMenu(_ref) {
   var _ref$items = _ref.items,
-    items = _ref$items === void 0 ? emptyArray$4 : _ref$items,
+    items = _ref$items === void 0 ? emptyArray$3 : _ref$items,
     _ref$size = _ref.size,
     size = _ref$size === void 0 ? null : _ref$size,
     _ref$theme = _ref.theme,
@@ -1552,10 +1551,10 @@ function ModalDialog(_ref) {
 
 var styles$k = {"container":"micromag-core-panels-container"};
 
-var emptyArray$3 = [];
+var emptyArray$2 = [];
 function PanelsContainer(_ref) {
   var _ref$panels = _ref.panels,
-    panels = _ref$panels === void 0 ? emptyArray$3 : _ref$panels,
+    panels = _ref$panels === void 0 ? emptyArray$2 : _ref$panels,
     _ref$setPanelsContain = _ref.setPanelsContainer,
     setPanelsContainer = _ref$setPanelsContain === void 0 ? null : _ref$setPanelsContain,
     _ref$className = _ref.className,
@@ -1826,12 +1825,12 @@ function PlaceholderBlock(_ref) {
 }
 
 /* eslint-disable react/jsx-props-no-spreading */
-var emptyObject$1 = {};
+var emptyObject = {};
 function ElementComponent(_ref) {
   var name = _ref.name,
     components = _ref.components,
     _ref$props = _ref.props,
-    props = _ref$props === void 0 ? emptyObject$1 : _ref$props,
+    props = _ref$props === void 0 ? emptyObject : _ref$props,
     _ref$isPlaceholder = _ref.isPlaceholder,
     isPlaceholder = _ref$isPlaceholder === void 0 ? false : _ref$isPlaceholder,
     _ref$className = _ref.className,
@@ -1873,7 +1872,7 @@ function Empty(_ref) {
   }, /*#__PURE__*/React.createElement(Label, null, children)));
 }
 
-var emptyArray$2 = [];
+var emptyArray$1 = [];
 var defaultFormats = ['eot', 'woff2', 'woff', {
   name: 'otf',
   format: 'opentype'
@@ -1911,7 +1910,7 @@ var getUrlsFromMedia = function getUrlsFromMedia(media, formats) {
 };
 function FontFaces(_ref4) {
   var _ref4$fonts = _ref4.fonts,
-    fonts = _ref4$fonts === void 0 ? emptyArray$2 : _ref4$fonts,
+    fonts = _ref4$fonts === void 0 ? emptyArray$1 : _ref4$fonts,
     _ref4$formats = _ref4.formats,
     formats = _ref4$formats === void 0 ? defaultFormats : _ref4$formats;
   var fontFaces = (fonts || []).filter(function (it) {
@@ -2019,8 +2018,6 @@ function Media(_ref) {
 }
 
 /* eslint-disable react/no-array-index-key */
-var emptyArray$1 = [];
-var emptyObject = {};
 function Meta(_ref) {
   var _ref$title = _ref.title,
     title = _ref$title === void 0 ? null : _ref$title,
@@ -2050,7 +2047,7 @@ function Meta(_ref) {
     _ref2$atomUrl = _ref2.atomUrl,
     atomUrl = _ref2$atomUrl === void 0 ? null : _ref2$atomUrl,
     _ref2$microformats = _ref2.microformats,
-    microformats = _ref2$microformats === void 0 ? emptyArray$1 : _ref2$microformats,
+    microformats = _ref2$microformats === void 0 ? null : _ref2$microformats,
     _ref2$language = _ref2.language,
     language = _ref2$language === void 0 ? null : _ref2$language;
   var realTitle = title !== null ? "".concat(title, " | ").concat(suffix) : fullTitle;
@@ -2058,7 +2055,7 @@ function Meta(_ref) {
     _ref3$url = _ref3.url,
     imageUrl = _ref3$url === void 0 ? null : _ref3$url,
     _ref3$metadata = _ref3.metadata,
-    imageMetadata = _ref3$metadata === void 0 ? emptyObject : _ref3$metadata;
+    imageMetadata = _ref3$metadata === void 0 ? null : _ref3$metadata;
   var _ref4 = imageMetadata || {},
     _ref4$width = _ref4.width,
     imageWidth = _ref4$width === void 0 ? null : _ref4$width,
@@ -2067,7 +2064,7 @@ function Meta(_ref) {
   var _ref5 = favicon || {},
     _ref5$url = _ref5.url,
     faviconUrl = _ref5$url === void 0 ? null : _ref5$url;
-  return /*#__PURE__*/React.createElement(Helmet, null, /*#__PURE__*/React.createElement("title", null, realTitle !== null && realTitle.length > 0 ? realTitle : 'Micromag'), description !== null ? /*#__PURE__*/React.createElement("meta", {
+  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("title", null, realTitle !== null && realTitle.length > 0 ? realTitle : 'Micromag'), description !== null ? /*#__PURE__*/React.createElement("meta", {
     name: "description",
     content: description
   }) : null, language !== null ? /*#__PURE__*/React.createElement("meta", {
@@ -2106,10 +2103,10 @@ function Meta(_ref) {
   }) : null, imageHeight !== null ? /*#__PURE__*/React.createElement("meta", {
     property: "og:image:height",
     content: imageHeight
-  }) : null, /*#__PURE__*/React.createElement("meta", {
+  }) : null, realTitle !== null ? /*#__PURE__*/React.createElement("meta", {
     property: "og:title",
     content: realTitle
-  }), description !== null ? /*#__PURE__*/React.createElement("meta", {
+  }) : null, description !== null ? /*#__PURE__*/React.createElement("meta", {
     property: "og:description",
     content: description
   }) : null, url !== null ? /*#__PURE__*/React.createElement("meta", {
@@ -2118,10 +2115,10 @@ function Meta(_ref) {
   }) : null, /*#__PURE__*/React.createElement("meta", {
     name: "twitter:card",
     content: imageUrl !== null ? 'summary_large_image' : 'summary'
-  }), /*#__PURE__*/React.createElement("meta", {
+  }), realTitle !== null ? /*#__PURE__*/React.createElement("meta", {
     name: "twitter:title",
     content: realTitle
-  }), description !== null ? /*#__PURE__*/React.createElement("meta", {
+  }) : null, description !== null ? /*#__PURE__*/React.createElement("meta", {
     name: "twitter:description",
     content: description
   }) : null, imageUrl !== null ? /*#__PURE__*/React.createElement("meta", {

package/es/contexts.d.ts

@@ -1,21 +1,13 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
-import React__default from 'react';
+import React__default, { ReactNode, ComponentType } from 'react';
 import EventEmitter from 'wolfy87-eventemitter';
+import { MessageDescriptor } from 'react-intl';
 export { RoutesContext, RoutesProvider, useRoutes, useUrlGenerator } from '@folklore/routes';
 export { TrackingContext } from '@folklore/tracking';
 
-interface DefaultMessageContent {
-    type?: number;
-    value?: string;
-}
-type DefaultMessage = string | DefaultMessageContent[];
-interface Message {
-    id?: string;
-    defaultMessage: DefaultMessage;
-    description?: string;
-}
-type Text = Message | string;
+type Text = MessageDescriptor | ReactNode;
+
 /**
  * Medias
  */
@@ -55,6 +47,33 @@ interface VideoMedia extends Omit<Media, 'type' | 'metadata'> {
         duration?: number;
     };
 }
+
+type Component = string | ComponentType;
+type ComponentsMap = Record<string, ComponentType>;
+interface Definition {
+    id: string;
+    component?: Component;
+}
+interface Field {
+    name?: string;
+    type: string;
+    label?: Text;
+    isSection?: boolean;
+    fields?: Field[];
+}
+interface ScreenDefinition extends Definition {
+    type: 'screen';
+    title: Text;
+    layouts?: string[];
+    fields?: Field[];
+}
+interface FieldDefinition$1 extends Definition {
+    id: string;
+    fields?: Field[];
+    settings?: Field[];
+    [key: string]: unknown;
+}
+
 type Font = Record<string, unknown> | string;
 type TextAlign = 'left' | 'right' | 'center';
 interface ColorObject {
@@ -77,64 +96,38 @@ interface TextStyle {
     letterSpacing?: number;
     lineHeight?: number;
 }
+
 interface BackgroundElement {
     color?: Color;
     image?: ImageMedia;
     video?: VideoMedia;
 }
-/**
- * Definitions
- */
-interface Field {
-    name?: string;
-    type: string;
-    label?: Text;
-    isSection?: boolean;
-    fields?: Field[];
-}
-interface ScreenDefinition$1 {
-    id: string;
-    type: 'screen';
-    title: Text;
-    layouts?: string[];
-    fields?: Field[];
-}
-/**
- * Components
- */
+
 interface StoryComponent {
     type: string;
     [key: string]: unknown;
 }
 type ScreenComponent = StoryComponent;
-/**
- * Theme
- */
-interface Theme {
+interface StoryMetadata {
+    description?: string;
+    shareUrl?: string;
+    shareImage?: ImageMedia;
+    favIcon?: ImageMedia;
+}
+interface StoryTheme {
     id?: string;
     textStyles?: Record<string, TextStyle>;
     background?: BackgroundElement;
     colors?: Record<string, Color>;
     components?: ScreenComponent[];
 }
-/**
- * Metadata
- */
-interface Metadata {
-    description?: string;
-    shareUrl?: string;
-    shareImage?: ImageMedia;
-    favIcon?: ImageMedia;
-}
-/**
- * Story
- */
 interface Story {
     id?: string;
-    theme?: Theme;
+    theme?: StoryTheme;
     components?: ScreenComponent[];
-    metadata?: Metadata;
+    metadata?: StoryMetadata;
 }
+
 interface ScreenSize {
     screen?: string;
     screens?: string[];
@@ -149,41 +142,48 @@ interface Visitor {
 }
 
 declare class ComponentsManager extends EventEmitter {
+    components: ComponentsMap;
     constructor(components?: {});
-    addComponent(name: any, component: any, namespace?: any): this;
-    addComponents(components: any, namespace?: any): this;
-    merge(manager: any, namespace?: any): this;
-    addNamespace(namespace: any): this;
-    getComponent(name: any, namespace?: any): any;
-    getComponents(namespace?: any): any;
-    hasComponent(name: any, namespace?: any): boolean;
+    addComponent(name: string, component: ComponentType, namespace?: string | null): this;
+    addComponents(components: ComponentsMap, namespace?: string | null): this;
+    merge(manager: ComponentsManager, namespace?: any): this;
+    addNamespace(namespace: string | null): this;
+    getComponent(name: string, namespace?: string | null): ComponentType;
+    getComponents(namespace?: string | null): ComponentsMap;
+    hasComponent(name: string, namespace?: string | null): boolean;
 }
 
-declare class DefinitionsManager extends EventEmitter {
-    constructor(definitions?: any[]);
-    addDefinition(definition: any): this;
-    addDefinitions(definitions: any): this;
-    merge(manager: any): this;
-    filter(filter: any): DefinitionsManager;
-    getDefinition(id: any): any;
-    getDefinitions(): any;
-    hasDefinition(id: any): boolean;
-    getComponent(id: any): any;
-    getComponents(): any;
+declare class DefinitionsManager<T extends Definition = Definition> extends EventEmitter {
+    definitions: T[];
+    constructor(definitions?: T[]);
+    addDefinition(definition: T | T[]): this;
+    addDefinitions(definitions: T[]): this;
+    merge(manager: DefinitionsManager<T>): this;
+    filter(filter: (definition: T) => boolean): DefinitionsManager<T>;
+    getDefinition(id: string): T;
+    getDefinitions(): T[];
+    hasDefinition(id: string): boolean;
+    getComponent(id: string): Component;
+    getComponents(): Record<string, Component>;
 }
 
-declare class FieldsManager extends DefinitionsManager {
-    filter(filter: any): FieldsManager;
+declare class FieldsManager extends DefinitionsManager<FieldDefinition$1> {
+    filter(filter: (definition: FieldDefinition$1) => boolean): FieldsManager;
 }
 
-declare class ScreensManager extends DefinitionsManager {
+type ScreensFieldsPattern = {
+    fonts?: Record<string, RegExp[]>;
+    medias?: Record<string, RegExp[]>;
+};
+declare class ScreensManager extends DefinitionsManager<ScreenDefinition> {
+    fieldsPattern: ScreensFieldsPattern | null;
     constructor(definitions?: any[]);
-    getFields(id: any): any;
-    getLayouts(id: any): any;
-    getFieldsPattern(): any;
-    setFieldsPattern(fieldsPattern: any): void;
-    filter(filter: any): ScreensManager;
-    merge(manager: any): this;
+    getFields(id: string): Field[];
+    getLayouts(id: string): string[];
+    getFieldsPattern(): ScreensFieldsPattern;
+    setFieldsPattern(fieldsPattern: ScreensFieldsPattern): void;
+    filter(filter: (definition: ScreenDefinition) => boolean): ScreensManager;
+    merge(manager: ScreensManager): this;
 }
 
 declare const MODALS_NAMESPACE = "modals";
@@ -411,7 +411,7 @@ declare const useScreenState: () => any;
 interface ScreenProviderProps {
     children: React__default.ReactNode;
     data?: ScreenComponent;
-    definition?: ScreenDefinition$1;
+    definition?: ScreenDefinition;
     renderContext?: RenderContext;
     screenState?: string;
 }
@@ -420,10 +420,10 @@ declare function ScreenProvider({ data, definition, renderContext, screenState,
 declare const ScreensContext: any;
 declare const useScreensManager: () => unknown;
 interface ScreensProviderProps {
-    screens?: ScreenDefinition[];
-    namespaces?: string[];
+    screens?: ScreenDefinition[] | null;
+    namespaces?: string[] | null;
     filterNamespaces?: boolean;
-    manager?: ScreensManager;
+    manager?: ScreensManager | null;
     children: React__default.ReactNode;
 }
 declare function ScreensProvider({ screens, namespaces, filterNamespaces, manager, children, }: ScreensProviderProps): react_jsx_runtime.JSX.Element;
@@ -436,12 +436,12 @@ interface ScreenSizeProviderProps {
 }
 declare function ScreenSizeProvider({ size, children }: ScreenSizeProviderProps): react_jsx_runtime.JSX.Element;
 
-declare const StoryContext: any;
-declare const useStoryContext: () => unknown;
-declare const useStory: () => unknown;
+declare const StoryContext: React.Context<Story>;
+declare const useStoryContext: () => Story;
+declare const useStory: () => Story;
 interface StoryProviderProps {
-    story?: Story | Theme;
-    children: React__default.ReactNode;
+    story?: Story | null;
+    children: ReactNode;
 }
 declare function StoryProvider({ story, children }: StoryProviderProps): react_jsx_runtime.JSX.Element;
 
@@ -491,17 +491,21 @@ interface ViewerProviderProps {
 }
 declare function ViewerProvider({ children, containerRef, events, menuVisible, menuOverScreen, width, height, topHeight, bottomHeight, bottomSidesWidth, gotoNextScreen, gotoPreviousScreen, disableInteraction, enableInteraction, }: ViewerProviderProps): react_jsx_runtime.JSX.Element;
 
-declare const VisitorContext: any;
-declare const useVisitorContext: () => {
-    visitor: any;
-    setVisitor: any;
+type VisitorContextType = {
+    visitor: Visitor | null;
+    setVisitor: (visitor: Visitor | string | null) => void;
+};
+declare const VisitorContext: React.Context<VisitorContextType>;
+declare function useVisitorContext(): {
+    visitor: Visitor;
+    setVisitor: (visitor: Visitor | string | null) => void;
 };
-declare const useVisitor: () => any;
-declare const useSetVisitor: () => any;
+declare function useVisitor(): Visitor;
+declare function useSetVisitor(): (visitor: Visitor | string | null) => void;
 interface VisitorProviderProps {
     children: React__default.ReactNode;
-    visitor?: Visitor;
+    visitor?: Visitor | string | null;
 }
-declare function VisitorProvider({ visitor: providedVisitor, children }: VisitorProviderProps): react_jsx_runtime.JSX.Element;
+declare function VisitorProvider({ visitor: providedVisitor, children, }: VisitorProviderProps): react_jsx_runtime.JSX.Element;
 
 export { ComponentsContext, ComponentsProvider, ConsentContext, ConsentProvider, ELEMENTS_NAMESPACE, EditorContext, EditorProvider, FIELDS_NAMESPACE, FORMS_NAMESPACE, FieldContext, FieldContextProvider, FieldsContext, FieldsProvider, FieldsValueContext, FieldsValueContextProvider, FontsContext, FontsProvider, GoogleApiClientContext, GoogleApiClientProvider, GoogleKeysContext, GoogleKeysProvider, GoogleMapsClientContext, GoogleMapsClientProvider, MODALS_NAMESPACE, ModalsContext, ModalsProvider, PanelsContext, PanelsProvider, PlaybackContext, PlaybackProvider, SCREENS_NAMESPACE, ScreenContext, ScreenProvider, ScreenSizeContext, ScreenSizeProvider, ScreensContext, ScreensProvider, SettingsContext, SettingsProvider, StoryContext, StoryProvider, TrackingProvider, ViewerContext, ViewerProvider, VisitorContext, VisitorProvider, useComponent, useComponents, useComponentsManager, useConsent, useEditor, useElementComponent, useElementsComponents, useElementsComponentsManager, useFieldComponent, useFieldContext, useFieldDefinition, useFieldsComponents, useFieldsComponentsManager, useFieldsManager, useFieldsValue, useFonts, useFormComponent, useFormsComponents, useFormsComponentsManager, useGetColors, useGoogleApiClient, useGoogleFonts, useGoogleKeys, useGoogleMapsClient, useModalComponent, useModals, useModalsComponents, useModalsComponentsManager, usePanels, usePlaybackContext, usePlaybackMediaRef, useRouteBack, useRoutePush, useScreen, useScreenComponent, useScreenData, useScreenDefinition, useScreenRenderContext, useScreenSize, useScreenState, useScreensComponents, useScreensComponentsManager, useScreensManager, useSetVisitor, useSetting, useSettings, useStory, useStoryContext, useTracking, useViewerContainer, useViewerContext, useViewerEvents, useViewerInteraction, useViewerNavigation, useViewerSize, useViewerWebView, useVisitor, useVisitorContext, withGoogleApiClient, withGoogleMapsClient, withModals, withPanels };