@micromag/core 0.4.37 → 0.4.38

package/es/contexts.d.ts

@@ -1,9 +1,191 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import React__default from 'react';
+import EventEmitter from 'wolfy87-eventemitter';
 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;
+/**
+ * Medias
+ */
+interface MediaMetadata {
+    filename?: string;
+    size?: number;
+    mime?: string;
+}
+interface MediaFile {
+    id?: string;
+    handle?: string;
+    type?: string;
+    mime?: string;
+    url?: string;
+}
+interface Media {
+    id?: string;
+    type: string;
+    url?: string;
+    thumbnail_url?: string;
+    name?: string;
+    metadata?: MediaMetadata;
+    files?: Record<string, MediaFile>;
+}
+interface ImageMedia extends Omit<Media, 'type' | 'metadata'> {
+    type?: 'image' | 'video';
+    metadata?: MediaMetadata & {
+        width?: number;
+        height?: number;
+    };
+}
+interface VideoMedia extends Omit<Media, 'type' | 'metadata'> {
+    type?: 'video';
+    metadata?: MediaMetadata & {
+        width?: number;
+        height?: number;
+        duration?: number;
+    };
+}
+type Font = Record<string, unknown> | string;
+type TextAlign = 'left' | 'right' | 'center';
+interface ColorObject {
+    color?: string;
+    alpha?: number;
+}
+type Color = ColorObject | string;
+interface FontStyle {
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    upperCase?: boolean;
+}
+interface TextStyle {
+    fontFamily?: Font;
+    fontSize?: number;
+    fontStyle?: FontStyle;
+    align?: TextAlign;
+    color?: Color;
+    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 {
+    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;
+    components?: ScreenComponent[];
+    metadata?: Metadata;
+}
+interface ScreenSize {
+    screen?: string;
+    screens?: string[];
+    width?: number;
+    height?: number;
+    landscape?: boolean;
+}
+type RenderContext = 'view' | 'placeholder' | 'edit' | 'preview' | 'static' | 'capture';
+interface Visitor {
+    id?: string | number;
+    name?: string;
+}
+
+declare class ComponentsManager extends EventEmitter {
+    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;
+}
+
+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 FieldsManager extends DefinitionsManager {
+    filter(filter: any): FieldsManager;
+}
+
+declare class ScreensManager extends DefinitionsManager {
+    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;
+}
+
 declare const MODALS_NAMESPACE = "modals";
 declare const FIELDS_NAMESPACE = "fields";
 declare const FORMS_NAMESPACE = "forms";
@@ -46,12 +228,16 @@ declare const useModalComponent: (name: any, defaultComponent?: any) => any;
 declare const useElementsComponentsManager: () => unknown;
 declare const useElementsComponents: (defaultComponents?: {}) => any;
 declare const useElementComponent: (name: any, defaultComponent?: any) => any;
-declare function ComponentsProvider({ components, manager, namespace, children, }: {
-    components?: {};
-    manager?: any;
-    namespace?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+/**
+ * Provider
+ */
+interface ComponentsProviderProps {
+    children: React__default.ReactNode;
+    namespace?: string;
+    manager?: ComponentsManager;
+    components?: Record<string, Record<string, unknown> | ((...args: unknown[]) => void)>;
+}
+declare function ComponentsProvider({ components, manager, namespace, children, }: ComponentsProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const ConsentContext: any;
 declare const useConsent: () => unknown;
@@ -67,32 +253,36 @@ declare function ConsentProvider({ consent: providedConsent, consented: initialC
 declare const EditorContext: any;
 declare const useEditor: () => unknown;
 declare const useGetColors: () => any;
-declare function EditorProvider({ children }: {
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface EditorProviderProps {
+    children: React__default.ReactNode;
+}
+declare function EditorProvider({ children }: EditorProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const FieldsContext: any;
 declare const useFieldsManager: () => unknown;
 declare const useFieldDefinition: (id: any) => any;
-declare function FieldsProvider({ fields, manager, children }: {
-    fields?: any;
-    manager?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface FieldsProviderProps {
+    fields?: FieldDefinition[];
+    manager?: FieldsManager;
+    children: React__default.ReactNode;
+}
+declare function FieldsProvider({ fields, manager, children }: FieldsProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const FieldsValueContext: any;
 declare const useFieldsValue: () => unknown;
-declare function FieldsValueContextProvider({ value, children }: {
-    value?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface FieldsValueContextProviderProps {
+    value?: unknown;
+    children: React__default.ReactNode;
+}
+declare function FieldsValueContextProvider({ value, children }: FieldsValueContextProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const FieldContext: any;
 declare const useFieldContext: () => unknown;
-declare function FieldContextProvider({ context, children }: {
-    context?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface FieldContextProviderProps {
+    context?: unknown;
+    children: React__default.ReactNode;
+}
+declare function FieldContextProvider({ context, children }: FieldContextProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const FontsContext: any;
 declare const useGoogleFonts: ({ disabled, setFonts }?: {
@@ -106,11 +296,12 @@ declare const useFonts: ({ withoutGoogleFonts }?: {
     googleFonts: any;
     customFonts: any;
 };
-declare function FontsProvider({ systemFonts, customFonts, children, }: {
-    systemFonts?: string[];
-    customFonts?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface FontsProviderProps {
+    children: React__default.ReactNode;
+    systemFonts?: Font[];
+    customFonts?: Font[];
+}
+declare function FontsProvider({ systemFonts, customFonts, children, }: FontsProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const GoogleApiClientContext: any;
 declare const useGoogleApiClient: () => unknown;
@@ -118,16 +309,18 @@ declare const withGoogleApiClient: (WrappedComponent: any) => {
     (props: any): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
-declare function GoogleApiClientProvider({ children }: {
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface GoogleApiClientProviderProps {
+    children: React__default.ReactNode;
+}
+declare function GoogleApiClientProvider({ children }: GoogleApiClientProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const GoogleKeysContext: any;
 declare const useGoogleKeys: () => unknown;
-declare function GoogleKeysProvider({ children, apiKey }: {
-    children: any;
-    apiKey?: any;
-}): react_jsx_runtime.JSX.Element;
+interface GoogleKeysProviderProps {
+    children: React__default.ReactNode;
+    apiKey?: string;
+}
+declare function GoogleKeysProvider({ children, apiKey }: GoogleKeysProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const GoogleMapsClientContext: any;
 declare const useGoogleMapsClient: () => unknown;
@@ -135,11 +328,12 @@ declare const withGoogleMapsClient: (WrappedComponent: any) => {
     (props: any): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
-declare function GoogleMapsClientProvider({ children, locale, libraries }: {
-    children: any;
+interface GoogleMapsClientProviderProps {
+    children: React__default.ReactNode;
     locale?: string;
-    libraries?: any;
-}): react_jsx_runtime.JSX.Element;
+    libraries?: string[];
+}
+declare function GoogleMapsClientProvider({ children, locale, libraries }: GoogleMapsClientProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const ModalsContext: any;
 declare const useModals: () => unknown;
@@ -147,10 +341,11 @@ declare const withModals: (WrappedComponent: any) => {
     (props: any): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
-declare function ModalsProvider({ children, container: initialContainer }: {
-    children: any;
-    container?: any;
-}): react_jsx_runtime.JSX.Element;
+interface ModalsProviderProps {
+    children: React__default.ReactNode;
+    container?: Record<string, unknown>;
+}
+declare function ModalsProvider({ children, container: initialContainer }: ModalsProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const PanelsContext: any;
 declare const usePanels: () => unknown;
@@ -158,10 +353,11 @@ declare const withPanels: (WrappedComponent: any) => {
     (props: any): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
-declare function PanelsProvider({ children, container: initialContainer }: {
-    children: any;
-    container?: any;
-}): react_jsx_runtime.JSX.Element;
+interface PanelsProviderProps {
+    children: React__default.ReactNode;
+    container?: Record<string, unknown>;
+}
+declare function PanelsProvider({ children, container: initialContainer }: PanelsProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const PlaybackContext: any;
 declare const usePlaybackContext: () => unknown;
@@ -169,21 +365,22 @@ declare const usePlaybackMediaRef: (active?: boolean, background?: boolean, upda
     ref: React.RefObject<HTMLMediaElement>;
     isCurrent: boolean;
 };
-declare function PlaybackProvider({ muted: initialMuted, playing: initialPlaying, paused, controls: initialControls, controlsSuggestPlay: initialControlsSuggestPlay, controlsVisible: initialControlsVisible, controlsTheme: initialControlsTheme, currentQualityLevel: initialCurrentQualityLevel, children, }: {
-    muted?: boolean;
-    playing?: boolean;
-    paused?: boolean;
+interface PlaybackProviderProps {
+    children: React__default.ReactNode;
     controls?: boolean;
     controlsSuggestPlay?: boolean;
     controlsVisible?: boolean;
     controlsTheme?: {
-        seekBarOnly: boolean;
-        color: any;
-        progressColor: any;
+        seekBarOnly?: boolean;
+        color?: unknown;
+        progressColor?: unknown;
     };
-    currentQualityLevel?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+    muted?: boolean;
+    playing?: boolean;
+    paused?: boolean;
+    currentQualityLevel?: number;
+}
+declare function PlaybackProvider({ muted: initialMuted, playing: initialPlaying, paused, controls: initialControls, controlsSuggestPlay: initialControlsSuggestPlay, controlsVisible: initialControlsVisible, controlsTheme: initialControlsTheme, currentQualityLevel: initialCurrentQualityLevel, children, }: PlaybackProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const useRoutePush: () => (route: any, data: any, ...args: any[]) => void;
 declare const useRouteBack: () => () => void;
@@ -191,10 +388,11 @@ declare const useRouteBack: () => () => void;
 declare const SettingsContext: any;
 declare const useSettings: () => unknown;
 declare const useSetting: (key: any, defaultValue?: any) => any;
-declare function SettingsProvider({ children, settings }: {
-    children: any;
-    settings?: any;
-}): react_jsx_runtime.JSX.Element;
+interface SettingsProviderProps {
+    children: React__default.ReactNode;
+    settings?: Record<string, unknown>;
+}
+declare function SettingsProvider({ children, settings }: SettingsProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const ScreenContext: any;
 declare const useScreen: () => unknown;
@@ -210,46 +408,51 @@ declare const useScreenRenderContext: () => {
     isCapture: boolean;
 };
 declare const useScreenState: () => any;
-declare function ScreenProvider({ data, definition, renderContext, screenState, children, }: {
-    data?: any;
-    definition?: any;
-    renderContext?: any;
-    screenState?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface ScreenProviderProps {
+    children: React__default.ReactNode;
+    data?: ScreenComponent;
+    definition?: ScreenDefinition$1;
+    renderContext?: RenderContext;
+    screenState?: string;
+}
+declare function ScreenProvider({ data, definition, renderContext, screenState, children, }: ScreenProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const ScreensContext: any;
 declare const useScreensManager: () => unknown;
-declare function ScreensProvider({ screens, namespaces, filterNamespaces, manager, children, }: {
-    screens?: any;
-    namespaces?: any;
+interface ScreensProviderProps {
+    screens?: ScreenDefinition[];
+    namespaces?: string[];
     filterNamespaces?: boolean;
-    manager?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+    manager?: ScreensManager;
+    children: React__default.ReactNode;
+}
+declare function ScreensProvider({ screens, namespaces, filterNamespaces, manager, children, }: ScreensProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const ScreenSizeContext: any;
 declare const useScreenSize: () => unknown;
-declare function ScreenSizeProvider({ size, children }: {
-    size?: {};
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface ScreenSizeProviderProps {
+    children: React__default.ReactNode;
+    size?: ScreenSize;
+}
+declare function ScreenSizeProvider({ size, children }: ScreenSizeProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const StoryContext: any;
 declare const useStoryContext: () => unknown;
 declare const useStory: () => unknown;
-declare function StoryProvider({ story, children }: {
-    story?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface StoryProviderProps {
+    story?: Story | Theme;
+    children: React__default.ReactNode;
+}
+declare function StoryProvider({ story, children }: StoryProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const useTracking: () => unknown;
-declare function TrackingProvider({ variables, disabled, paused, children }: {
-    variables?: any;
+interface TrackingProviderProps {
+    children: React__default.ReactNode;
+    variables?: TrackingVariables;
     disabled?: boolean;
     paused?: boolean;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+}
+declare function TrackingProvider({ variables, disabled, paused, children }: TrackingProviderProps): react_jsx_runtime.JSX.Element;
 
 declare const ViewerContext: any;
 declare const useViewerContext: () => unknown;
@@ -268,22 +471,25 @@ declare const useViewerInteraction: () => {
     enableInteraction: any;
 };
 declare const useViewerWebView: () => any;
-declare function ViewerProvider({ children, containerRef, events, menuVisible, menuOverScreen, width, height, topHeight, bottomHeight, bottomSidesWidth, gotoNextScreen, gotoPreviousScreen, disableInteraction, enableInteraction, }: {
-    children: any;
-    containerRef: any;
-    events?: any;
+interface ViewerProviderProps {
+    children: React__default.ReactNode;
+    events?: EventEmitter;
+    containerRef?: (...args: unknown[]) => void | {
+        current?: unknown;
+    };
     menuVisible?: boolean;
     menuOverScreen?: boolean;
-    width: any;
-    height: any;
+    width?: number;
+    height?: number;
     topHeight?: number;
     bottomHeight?: number;
     bottomSidesWidth?: number;
-    gotoNextScreen?: () => void;
-    gotoPreviousScreen?: () => void;
-    disableInteraction?: () => void;
-    enableInteraction?: () => void;
-}): react_jsx_runtime.JSX.Element;
+    gotoNextScreen?: (...args: unknown[]) => void;
+    gotoPreviousScreen?: (...args: unknown[]) => void;
+    disableInteraction?: (...args: unknown[]) => void;
+    enableInteraction?: (...args: unknown[]) => void;
+}
+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: () => {
@@ -292,9 +498,10 @@ declare const useVisitorContext: () => {
 };
 declare const useVisitor: () => any;
 declare const useSetVisitor: () => any;
-declare function VisitorProvider({ visitor: providedVisitor, children }: {
-    visitor?: any;
-    children: any;
-}): react_jsx_runtime.JSX.Element;
+interface VisitorProviderProps {
+    children: React__default.ReactNode;
+    visitor?: Visitor;
+}
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@micromag/core",
-    "version": "0.4.37",
+    "version": "0.4.38",
     "private": false,
     "description": "",
     "keywords": [
@@ -161,6 +161,6 @@
         "access": "public",
         "registry": "https://registry.npmjs.org/"
     },
-    "gitHead": "03c7d78fb0745377eddbb04f6c7dfaca8aa42381",
+    "gitHead": "e984a8b97d5c87914dd4844ff29628a5690edd6f",
     "types": "es/index.d.ts"
 }