@micromag/core 0.4.69 → 0.4.74

package/es/index.d.ts

@@ -1,4 +1,5 @@
-import { ReactNode, ComponentType } from 'react';
+import * as react from 'react';
+import { ReactNode, ElementType, ComponentType } from 'react';
 import EventEmitter from 'wolfy87-eventemitter';
 import { MessageDescriptor } from 'react-intl';
 import { Tracking as Tracking$1 } from '@folklore/tracking';
@@ -20,6 +21,7 @@ type Text = MessageDescriptor | ReactNode;
 type Label = MessageDescriptor | ReactNode;
 type Target = '_blank' | '_self' | '_parent';
 
+type MediaElement = HTMLVideoElement | HTMLAudioElement | HTMLMediaElement;
 /**
  * Medias
  */
@@ -33,12 +35,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;
@@ -75,8 +77,8 @@ interface ClosedCaptionsMedia extends Omit<Media, 'type'> {
 
 type Errors = string | string[];
 type FormErrors = Record<string, Errors>;
-type Component = string | ComponentType;
-type ComponentsMap = Record<string, ComponentType>;
+type Component = ElementType;
+type ComponentsMap = Record<string, ElementType>;
 type SelectOption = string | {
     value: unknown;
     label?: Label;
@@ -129,7 +131,21 @@ interface Panel {
     id: string;
 }
 interface Button {
+    id?: string | number;
     label?: Label;
+    name?: string;
+    theme?: ButtonTheme | null;
+    size?: ButtonSize | null;
+    href?: string | null;
+    external?: boolean;
+    direct?: boolean;
+    target?: string;
+    focusable?: boolean;
+    active?: boolean;
+    icon?: React.ReactNode | null;
+    iconPosition?: 'left' | 'right' | 'inline';
+    disabled?: boolean;
+    className?: string | null;
     onClick?: (...args: unknown[]) => void;
 }
 type BootstrapTheme = 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark';
@@ -170,8 +186,13 @@ interface CustomFont {
     type?: 'system' | 'google' | 'custom';
     name?: string;
     media?: FontMedia;
+    variants?: string[] | {
+        fvd?: string;
+        weight?: number;
+        style?: string;
+    }[];
 }
-type Font = Record<string, unknown> | string;
+type Font = CustomFont | string;
 type TextAlign = 'left' | 'right' | 'center';
 interface ColorObject {
     color?: string;
@@ -377,6 +398,7 @@ interface ClosedCaptions {
 }
 
 interface StoryComponent {
+    id: string;
     type: string;
     [key: string]: unknown;
 }
@@ -386,6 +408,7 @@ interface StoryMetadata {
     shareUrl?: string;
     shareImage?: ImageMedia;
     favIcon?: ImageMedia;
+    language?: string;
 }
 interface StoryTheme {
     id?: string;
@@ -394,11 +417,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 DeviceScreen {
@@ -442,7 +485,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;
 }
@@ -568,4 +611,4 @@ declare class Tracking extends Tracking$1 {
 }
 
 export { ColorsParser, ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, MediasParser, ScreensManager, StoryParser, ThemeParser, Tracking };
-export type { ActiveForm, AdFormat, AdFormats, Alternatives, Answer, AudioElement, AudioMedia, AuthorElement, BackgroundElement, Badge, BootstrapTheme, BorderStyle, BorderType, BoxStyle, Breadcrumb, Button, ButtonLayout, ButtonSize, ButtonTheme, CallToAction, CallToActionType, ClosedCaptions, ClosedCaptionsElement, ClosedCaptionsMedia, Color, ColorObject, Component, ComponentsMap, Conversation, ConversationMessage, CustomAnswer, CustomFont, Definition, Device, DeviceScreen, DropdownAlign, Errors, Field, FieldDefinition, Font, FontMedia, FontStyle, Footer, FormControlSize, FormErrors, FormField, GeoPosition, GridElement, GridLayout, GridLayoutItem, Header, HeadingElement, ImageElement, ImageElementWithCaption, ImageMedia, InputElement, Interaction, Label, Margin, Marker, MarkerWithImage, Media, MediaFile, MediaMetadata, MediaType, MenuItem, Modal, ObjectFit, ObjectFitSize, Panel, QuizAnswer, RenderContext, ScreenComponent, ScreenDefinition, ScreenSize, SearchFilter, SelectOption, ShadowType, ShareIncentive, Speaker, StackAlign, StackDirection, StackElement, StackSpacing, Story, StoryComponent, StoryMetadata, StoryTheme, Target, Text, TextAlign, TextElement, TextStyle, TimingOverrides, TrackingVariables, Transition, TransitionConfig, TransitionEasing, TransitionName, Transitions, User, VideoElement, VideoMedia, ViewerTheme, Visitor, VisualElement };
+export type { ActiveForm, AdFormat, AdFormats, Alternatives, Answer, AudioElement, AudioMedia, AuthorElement, BackgroundElement, Badge, BootstrapTheme, BorderStyle, BorderType, BoxStyle, Breadcrumb, Button, ButtonLayout, ButtonSize, ButtonTheme, CallToAction, CallToActionType, ClosedCaptions, ClosedCaptionsElement, ClosedCaptionsMedia, Color, ColorObject, Component, ComponentsMap, Conversation, ConversationMessage, CustomAnswer, CustomFont, Definition, Device, DeviceScreen, DropdownAlign, Errors, Field, FieldDefinition, Font, FontMedia, FontStyle, Footer, FormControlSize, FormErrors, FormField, GeoPosition, GridElement, GridLayout, GridLayoutItem, Header, HeadingElement, ImageElement, ImageElementWithCaption, ImageMedia, InputElement, Interaction, Label, Margin, Marker, MarkerWithImage, Media, MediaElement, MediaFile, MediaMetadata, MediaType, MenuItem, Modal, ObjectFit, ObjectFitSize, Organisation, Panel, QuizAnswer, RenderContext, ScreenComponent, ScreenDefinition, ScreenSize, SearchFilter, SelectOption, ShadowType, ShareIncentive, Speaker, StackAlign, StackDirection, StackElement, StackSpacing, Story, StoryComponent, StoryMetadata, StorySettings, StoryTheme, Target, Text, TextAlign, TextElement, TextStyle, TimingOverrides, TrackingCode, TrackingSettings, TrackingVariables, Transition, TransitionConfig, TransitionEasing, TransitionName, Transitions, User, VideoElement, VideoMedia, ViewerTheme, Visitor, VisualElement };