@micromag/core 0.4.69 → 0.4.74

package/es/contexts.d.ts

@@ -1,13 +1,15 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
-import React__default, { ReactNode, ComponentType } from 'react';
+import React__default, { ReactNode, ElementType, ComponentType } from 'react';
 import EventEmitter from 'wolfy87-eventemitter';
 import { MessageDescriptor } from 'react-intl';
-export { RoutesContext, RoutesProvider, useRoutes, useUrlGenerator } from '@folklore/routes';
+import * as _folklore_tracking from '@folklore/tracking';
 export { TrackingContext } from '@folklore/tracking';
+export { RoutesContext, RoutesProvider, useRoutes, useUrlGenerator } from '@folklore/routes';
 
 type Text = MessageDescriptor | ReactNode;
 
+type MediaElement = HTMLVideoElement | HTMLAudioElement | HTMLMediaElement;
 /**
  * Medias
  */
@@ -21,12 +23,12 @@ interface MediaFile {
     handle?: string;
     type?: string;
     mime?: string;
-    url?: string;
+    url: string;
 }
 interface Media {
     id?: string;
     type: string;
-    url?: string;
+    url: string;
     thumbnail_url?: string;
     name?: string;
     metadata?: MediaMetadata;
@@ -39,6 +41,9 @@ interface ImageMedia extends Omit<Media, 'type' | 'metadata'> {
         height?: number;
     };
 }
+interface FontMedia extends Omit<Media, 'type'> {
+    type?: 'font';
+}
 interface VideoMedia extends Omit<Media, 'type' | 'metadata'> {
     type?: 'video';
     metadata?: MediaMetadata & {
@@ -48,8 +53,8 @@ interface VideoMedia extends Omit<Media, 'type' | 'metadata'> {
     };
 }
 
-type Component = string | ComponentType;
-type ComponentsMap = Record<string, ComponentType>;
+type Component = ElementType;
+type ComponentsMap = Record<string, ElementType>;
 interface Definition {
     id: string;
     component?: Component;
@@ -67,14 +72,27 @@ interface ScreenDefinition extends Definition {
     layouts?: string[];
     fields?: Field[];
 }
-interface FieldDefinition$1 extends Definition {
+interface FieldDefinition extends Definition {
     id: string;
     fields?: Field[];
     settings?: Field[];
     [key: string]: unknown;
 }
 
-type Font = Record<string, unknown> | string;
+/**
+ * Style
+ */
+interface CustomFont {
+    type?: 'system' | 'google' | 'custom';
+    name?: string;
+    media?: FontMedia;
+    variants?: string[] | {
+        fvd?: string;
+        weight?: number;
+        style?: string;
+    }[];
+}
+type Font = CustomFont | string;
 type TextAlign = 'left' | 'right' | 'center';
 interface ColorObject {
     color?: string;
@@ -104,6 +122,7 @@ interface BackgroundElement {
 }
 
 interface StoryComponent {
+    id: string;
     type: string;
     [key: string]: unknown;
 }
@@ -113,6 +132,7 @@ interface StoryMetadata {
     shareUrl?: string;
     shareImage?: ImageMedia;
     favIcon?: ImageMedia;
+    language?: string;
 }
 interface StoryTheme {
     id?: string;
@@ -121,11 +141,31 @@ interface StoryTheme {
     colors?: Record<string, Color>;
     components?: ScreenComponent[];
 }
+interface Organisation {
+    slug?: string;
+    name?: string;
+    tracking?: TrackingSettings;
+}
+interface TrackingCode {
+    id: string;
+    type: string;
+}
+interface TrackingSettings {
+    codes?: TrackingCode[];
+}
+interface StorySettings {
+    tracking?: TrackingSettings;
+}
 interface Story {
     id?: string;
+    title?: string;
+    slug?: string;
+    document_id?: string;
     theme?: StoryTheme;
     components?: ScreenComponent[];
     metadata?: StoryMetadata;
+    settings?: StorySettings;
+    organisation?: Organisation;
 }
 
 interface ScreenSize {
@@ -148,7 +188,7 @@ declare class ComponentsManager extends EventEmitter {
     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;
+    getComponent(name: string, namespace?: string | null): React.ElementType;
     getComponents(namespace?: string | null): ComponentsMap;
     hasComponent(name: string, namespace?: string | null): boolean;
 }
@@ -167,8 +207,8 @@ declare class DefinitionsManager<T extends Definition = Definition> extends Even
     getComponents(): Record<string, Component>;
 }
 
-declare class FieldsManager extends DefinitionsManager<FieldDefinition$1> {
-    filter(filter: (definition: FieldDefinition$1) => boolean): FieldsManager;
+declare class FieldsManager extends DefinitionsManager<FieldDefinition> {
+    filter(filter: (definition: FieldDefinition) => boolean): FieldsManager;
 }
 
 type ScreensFieldsPattern = {
@@ -191,51 +231,51 @@ declare const FIELDS_NAMESPACE = "fields";
 declare const FORMS_NAMESPACE = "forms";
 declare const SCREENS_NAMESPACE = "screens";
 declare const ELEMENTS_NAMESPACE = "elements";
-declare const ComponentsContext: any;
+declare const ComponentsContext: React.Context<ComponentsManager>;
 /**
  * Hooks
  */
-declare const useComponentsManager: (namespace?: any) => unknown;
-declare const useComponents: (namespace?: any, defaultComponents?: {}) => any;
-declare const useComponent: (name: any, defaultComponent?: any, namespace?: any) => any;
+declare const useComponentsManager: (namespace?: string | null) => ComponentsManager | null;
+declare const useComponents: (namespace?: string | null, defaultComponents?: {}) => Record<string, ElementType>;
+declare const useComponent: (name: string | ElementType | null, defaultComponent?: ElementType | null, namespace?: string | null) => ElementType | null;
 /**
  * Fields hooks
  */
-declare const useFieldsComponentsManager: () => unknown;
-declare const useFieldsComponents: (defaultComponents?: {}) => any;
-declare const useFieldComponent: (name: any, defaultComponent?: any) => any;
+declare const useFieldsComponentsManager: () => ComponentsManager;
+declare const useFieldsComponents: (defaultComponents?: {}) => Record<string, ElementType>;
+declare const useFieldComponent: (name: string | ElementType | null, defaultComponent?: any) => ElementType;
 /**
  * Screens hooks
  */
-declare const useScreensComponentsManager: () => unknown;
-declare const useScreensComponents: (defaultComponents?: {}) => any;
-declare const useScreenComponent: (name: any, defaultComponent?: any) => any;
+declare const useScreensComponentsManager: () => ComponentsManager;
+declare const useScreensComponents: (defaultComponents?: {}) => Record<string, ElementType>;
+declare const useScreenComponent: (name: string | ElementType | null, defaultComponent?: any) => ElementType;
 /**
  * Forms hooks
  */
-declare const useFormsComponentsManager: () => unknown;
-declare const useFormsComponents: (defaultComponents?: {}) => any;
-declare const useFormComponent: (name: any, defaultComponent?: any) => any;
+declare const useFormsComponentsManager: () => ComponentsManager;
+declare const useFormsComponents: (defaultComponents?: {}) => Record<string, ElementType>;
+declare const useFormComponent: (name: string | ElementType | null, defaultComponent?: any) => ElementType;
 /**
  * Modals hooks
  */
-declare const useModalsComponentsManager: () => unknown;
-declare const useModalsComponents: (defaultComponents?: {}) => any;
-declare const useModalComponent: (name: any, defaultComponent?: any) => any;
+declare const useModalsComponentsManager: () => ComponentsManager;
+declare const useModalsComponents: (defaultComponents?: {}) => Record<string, ElementType>;
+declare const useModalComponent: (name: string | ElementType | null, defaultComponent?: any) => ElementType;
 /**
  * Elements hooks
  */
-declare const useElementsComponentsManager: () => unknown;
-declare const useElementsComponents: (defaultComponents?: {}) => any;
-declare const useElementComponent: (name: any, defaultComponent?: any) => any;
+declare const useElementsComponentsManager: () => ComponentsManager;
+declare const useElementsComponents: (defaultComponents?: {}) => Record<string, ElementType>;
+declare const useElementComponent: (name: string | ElementType | null, defaultComponent?: any) => ElementType;
 /**
  * Provider
  */
 interface ComponentsProviderProps {
     children: React__default.ReactNode;
-    namespace?: string;
-    manager?: ComponentsManager;
-    components?: Record<string, Record<string, unknown> | ((...args: unknown[]) => void)>;
+    namespace?: string | null;
+    manager?: ComponentsManager | null;
+    components?: Record<string, Record<string, ElementType>> | Record<string, ElementType>;
 }
 declare function ComponentsProvider({ components, manager, namespace, children, }: ComponentsProviderProps): react_jsx_runtime.JSX.Element;
 
@@ -258,13 +298,13 @@ interface EditorProviderProps {
 }
 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 const FieldsContext: React.Context<FieldsManager>;
+declare const useFieldsManager: () => FieldsManager;
+declare const useFieldDefinition: (id: string) => FieldDefinition;
 interface FieldsProviderProps {
-    fields?: FieldDefinition[];
-    manager?: FieldsManager;
-    children: React__default.ReactNode;
+    fields?: FieldDefinition[] | null;
+    manager?: FieldsManager | null;
+    children: ReactNode;
 }
 declare function FieldsProvider({ fields, manager, children }: FieldsProviderProps): react_jsx_runtime.JSX.Element;
 
@@ -309,11 +349,15 @@ interface GoogleApiClientProviderProps {
 }
 declare function GoogleApiClientProvider({ children }: GoogleApiClientProviderProps): react_jsx_runtime.JSX.Element;
 
-declare const GoogleKeysContext: any;
-declare const useGoogleKeys: () => unknown;
+declare const GoogleKeysContext: React.Context<{
+    apiKey: any;
+}>;
+declare const useGoogleKeys: () => {
+    apiKey: any;
+};
 interface GoogleKeysProviderProps {
-    children: React__default.ReactNode;
-    apiKey?: string;
+    children: ReactNode;
+    apiKey?: string | null;
 }
 declare function GoogleKeysProvider({ children, apiKey }: GoogleKeysProviderProps): react_jsx_runtime.JSX.Element;
 
@@ -359,8 +403,6 @@ interface PlaybackControlsTheme {
     color?: unknown;
     progressColor?: unknown;
 }
-type MediaElement = HTMLVideoElement | HTMLAudioElement | HTMLMediaElement;
-declare function mediaElementIsPlaying(media: MediaElement | null): boolean;
 interface PlaybackContext {
     playing: boolean;
     completed: boolean;
@@ -369,6 +411,7 @@ interface PlaybackContext {
     controlsSuggestPlay: boolean;
     controlsVisible: boolean;
     media: MediaElement | null;
+    mediaSrc: string | null;
     hasAudio: boolean | null;
     isBackground: boolean;
     controlsTheme: PlaybackControlsTheme | null;
@@ -383,6 +426,8 @@ interface PlaybackContext {
     setMedia: (media: MediaElement | null) => void;
     setCurrentQualityLevel: (qualityLevel: number | null, fromRef?: MediaElement | null) => void;
     setIsBackground: (isBackground: boolean) => void;
+    seekByProgress: (progress: number) => void;
+    seek: (time: number) => void;
 }
 declare const PlaybackContext: React.Context<PlaybackContext>;
 declare const usePlaybackContext: () => PlaybackContext;
@@ -442,14 +487,14 @@ interface ScreenProviderProps {
 }
 declare function ScreenProvider({ data, definition, renderContext, screenState, children, }: ScreenProviderProps): react_jsx_runtime.JSX.Element;
 
-declare const ScreensContext: any;
-declare const useScreensManager: () => unknown;
+declare const ScreensContext: React.Context<any>;
+declare const useScreensManager: () => any;
 interface ScreensProviderProps {
     screens?: ScreenDefinition[] | null;
     namespaces?: string[] | null;
     filterNamespaces?: boolean;
     manager?: ScreensManager | null;
-    children: React__default.ReactNode;
+    children: ReactNode;
 }
 declare function ScreensProvider({ screens, namespaces, filterNamespaces, manager, children, }: ScreensProviderProps): react_jsx_runtime.JSX.Element;
 
@@ -470,34 +515,61 @@ interface StoryProviderProps {
 }
 declare function StoryProvider({ story, children }: StoryProviderProps): react_jsx_runtime.JSX.Element;
 
-declare const useTracking: () => unknown;
+declare const useTracking: () => _folklore_tracking.Tracking;
 declare function TrackingProvider(options?: any): react_jsx_runtime.JSX.Element;
 
-declare const ViewerContext: any;
-declare const useViewerContext: () => unknown;
+interface ViewerContextType {
+    events: EventEmitter;
+    menuVisible: boolean;
+    menuOverScreen: boolean;
+    width: number | null;
+    height: number | null;
+    activityDetected: boolean;
+    topHeight: number;
+    bottomHeight: number;
+    bottomSidesWidth: number;
+    gotoNextScreen: () => void;
+    gotoPreviousScreen: () => void;
+    disableInteraction: () => void;
+    enableInteraction: () => void;
+    webView: {
+        url: string;
+        [key: string]: unknown;
+    } | null;
+    setWebView: (webView: {
+        url: string;
+        [key: string]: unknown;
+    } | null) => void;
+}
+declare const ViewerContext: React.Context<ViewerContextType>;
+declare const useViewerContext: () => ViewerContextType;
 declare const useViewerSize: () => {
-    width: any;
-    height: any;
+    width: number;
+    height: number;
 };
 declare const useViewerNavigation: () => {
-    gotoNextScreen: any;
-    gotoPreviousScreen: any;
+    gotoNextScreen: () => void;
+    gotoPreviousScreen: () => void;
 };
-declare const useViewerEvents: () => any;
-declare const useViewerContainer: () => any;
+declare const useViewerEvents: () => EventEmitter;
+declare const useViewerActivityDetected: () => boolean;
 declare const useViewerInteraction: () => {
-    disableInteraction: any;
-    enableInteraction: any;
+    disableInteraction: () => void;
+    enableInteraction: () => void;
+};
+declare const useViewerWebView: () => {
+    opened: boolean;
+    open: (newWebView: any) => void;
+    close: () => void;
+    update: (newWebView: any) => void;
+    url: string;
 };
-declare const useViewerWebView: () => any;
 interface ViewerProviderProps {
-    children: React__default.ReactNode;
-    events?: EventEmitter;
-    containerRef?: (...args: unknown[]) => void | {
-        current?: unknown;
-    };
+    children: ReactNode;
+    events: EventEmitter;
     menuVisible?: boolean;
     menuOverScreen?: boolean;
+    activityDetected?: boolean;
     width?: number;
     height?: number;
     topHeight?: number;
@@ -508,7 +580,7 @@ interface ViewerProviderProps {
     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 function ViewerProvider({ children, events, menuVisible, menuOverScreen, activityDetected, width, height, topHeight, bottomHeight, bottomSidesWidth, gotoNextScreen, gotoPreviousScreen, disableInteraction, enableInteraction, }: ViewerProviderProps): react_jsx_runtime.JSX.Element;
 
 type VisitorContextType = {
     visitor: Visitor | null;
@@ -527,4 +599,4 @@ interface VisitorProviderProps {
 }
 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, mediaElementIsPlaying, 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 };
+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, useViewerActivityDetected, useViewerContext, useViewerEvents, useViewerInteraction, useViewerNavigation, useViewerSize, useViewerWebView, useVisitor, useVisitorContext, withGoogleApiClient, withGoogleMapsClient, withModals, withPanels };