@micromag/core 0.3.832 → 0.4.4

package/es/index.d.ts

@@ -0,0 +1,665 @@
+import { ReactNode, Ref as Ref$1 } from 'react';
+import EventEmitter from 'wolfy87-eventemitter';
+import { Tracking as Tracking$1 } from '@folklore/tracking';
+
+/**
+ * Core
+ */
+interface History {
+    listen: (...args: unknown[]) => void;
+    push: (path: string, state?: unknown) => void;
+}
+interface Location {
+    pathname?: string;
+    search?: string;
+}
+interface Intl {
+    locale: string;
+    formatMessage: (...args: unknown[]) => string;
+}
+interface DefaultMessageContent {
+    type?: number;
+    value?: string;
+}
+type DefaultMessage = string | DefaultMessageContent[];
+interface Message {
+    id?: string;
+    defaultMessage: DefaultMessage;
+    description?: string;
+}
+type Text = Message | string;
+type Label = Message | ReactNode;
+type StatusCode = 401 | 403 | 404 | 500;
+type Ref<T = unknown> = Ref$1<T>;
+type Target = '_blank' | '_self' | '_parent';
+type Interaction = 'tap' | 'swipe';
+type TrackingVariables = Record<string, string | number | unknown[]>;
+interface Progress {
+    currentTime?: number;
+    duration?: number;
+}
+/**
+ * Site
+ */
+interface User {
+    id?: number;
+    firstname?: string;
+    lastname?: string;
+    email?: string;
+    gender?: string;
+    birthdate?: string;
+}
+interface MenuItem {
+    id?: number | string;
+    label?: Label;
+    url?: string;
+    external?: boolean;
+    active?: boolean;
+}
+interface Breadcrumb {
+    label?: Label;
+    url?: string;
+}
+interface Device {
+    id: string;
+}
+interface Modal {
+    id: string;
+}
+interface Panel {
+    id: string;
+}
+interface Button {
+    label?: Label;
+    onClick?: (...args: unknown[]) => void;
+}
+type BootstrapTheme = 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark';
+type ButtonTheme = BootstrapTheme | 'outline-primary' | 'outline-secondary' | 'outline-success' | 'outline-danger' | 'outline-warning' | 'outline-info' | 'outline-light' | 'outline-dark' | 'outline-link' | null;
+type ButtonSize = 'lg' | 'sm' | null;
+type FormControlSize = 'lg' | 'sm' | null;
+type DropdownAlign = 'start' | 'end';
+type Component = Record<string, unknown> | ((...args: unknown[]) => unknown);
+/**
+ * Forms
+ */
+type Errors = string | string[];
+type FormErrors = Record<string, Errors>;
+type SelectOption = string | {
+    value: unknown;
+    label?: Label;
+};
+interface FormField {
+    name?: string;
+    component?: Component;
+}
+/**
+ * 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>;
+}
+type MediaType = 'image' | 'video' | 'audio' | 'closed-captions' | 'font';
+interface ImageMedia extends Omit<Media, 'type' | 'metadata'> {
+    type?: 'image' | 'video';
+    metadata?: MediaMetadata & {
+        width?: number;
+        height?: number;
+    };
+}
+interface FontMedia extends Omit<Media, 'type'> {
+    type?: 'font';
+}
+interface VideoMedia extends Omit<Media, 'type' | 'metadata'> {
+    type?: 'video';
+    metadata?: MediaMetadata & {
+        width?: number;
+        height?: number;
+        duration?: number;
+    };
+}
+interface AudioMedia extends Omit<Media, 'type' | 'metadata'> {
+    type?: 'audio';
+    metadata?: MediaMetadata & {
+        duration?: number;
+    };
+}
+interface ClosedCaptionsMedia extends Omit<Media, 'type'> {
+    type?: 'closed-captions';
+}
+/**
+ * Style
+ */
+interface CustomFont {
+    type?: 'system' | 'google' | 'custom';
+    name?: string;
+    media?: FontMedia;
+}
+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;
+}
+type BorderType = 'dotted' | 'dashed' | 'solid' | 'double' | 'groove' | 'ridge' | 'inset' | 'outset' | 'hidden';
+interface ShadowType {
+    shadowDistance?: number;
+    shadowBlur?: number;
+    shadowColor?: Color;
+}
+interface BorderStyle {
+    width?: number;
+    style?: BorderType;
+    radius?: number;
+    color?: Color;
+}
+interface BoxStyle {
+    backgroundColor?: Color;
+    borderRadius?: number;
+    borderWidth?: number;
+    borderColor?: Color;
+    borderStyle?: BorderType;
+    shadow?: ShadowType;
+}
+interface Margin {
+    top?: number;
+    bottom?: number;
+}
+interface GridLayoutItem {
+    rows?: number | number[];
+    columns?: number | number[];
+}
+type GridLayout = GridLayoutItem[];
+type ObjectFitSize = 'cover' | 'contain' | null;
+interface ObjectFit {
+    fit?: ObjectFitSize;
+    horizontalPosition?: 'left' | 'center' | 'right';
+    verticalPosition?: 'top' | 'center' | 'bottom';
+}
+/**
+ * Elements
+ */
+interface TextElement {
+    body?: string;
+    textStyle?: TextStyle;
+}
+type HeadingElement = TextElement;
+interface InputElement {
+    label?: string;
+    textStyle?: TextStyle;
+}
+interface ImageElement {
+    media?: ImageMedia;
+}
+interface VideoElement {
+    media?: VideoMedia;
+    autoPlay?: boolean;
+    loop?: boolean;
+    closedCaptions?: ClosedCaptionsMedia;
+    withSeekBar?: boolean;
+    withControls?: boolean;
+}
+interface VisualElement {
+    media?: ImageMedia;
+}
+interface AudioElement {
+    media?: AudioMedia;
+    autoPlay?: boolean;
+    loop?: boolean;
+    closedCaptions?: ClosedCaptionsMedia;
+    withPlayPause?: boolean;
+}
+interface ClosedCaptionsElement {
+    media?: ClosedCaptionsMedia;
+}
+interface BackgroundElement {
+    color?: Color;
+    image?: ImageMedia;
+    video?: VideoMedia;
+}
+interface ImageElementWithCaption {
+    image?: ImageMedia;
+    caption?: TextElement;
+}
+type StackDirection = 'horizontal' | 'vertical';
+type StackAlign = 'start' | 'center' | 'end';
+type StackSpacing = number | 'between' | 'evenly' | 'around';
+interface StackElement {
+    direction?: StackDirection;
+    align?: StackAlign;
+    width?: number;
+    height?: number;
+    spacing?: StackSpacing;
+    reverse?: boolean;
+}
+interface GridElement {
+    layout?: string[];
+    spacing?: number;
+}
+interface GeoPosition {
+    lat?: number;
+    lng?: number;
+}
+interface Marker {
+    id?: number;
+    geoPosition?: GeoPosition;
+    title?: HeadingElement;
+    subtitle?: HeadingElement;
+    description?: TextElement;
+}
+interface MarkerWithImage extends Marker {
+    image?: ImageMedia;
+}
+interface Answer {
+    id?: string;
+    label?: TextElement;
+}
+interface QuizAnswer extends Answer {
+    good?: boolean;
+}
+type CallToActionType = 'swipe-up' | 'button';
+interface CallToAction {
+    active?: boolean;
+    type?: CallToActionType;
+    url?: string;
+    label?: TextElement;
+    buttonStyle?: BoxStyle;
+}
+interface ShareIncentive {
+    active?: boolean;
+    label?: TextElement;
+    boxStyle?: BoxStyle;
+}
+interface ActiveForm {
+    active?: boolean;
+}
+interface Speaker {
+    id?: string;
+    name?: string;
+    avatar?: ImageMedia;
+    side?: 'left' | 'right';
+    color?: Color;
+}
+interface TimingOverrides {
+    enabled?: boolean;
+    appearDelay?: number;
+    writingStateDuration?: number;
+}
+interface ConversationMessage {
+    speaker?: string;
+    message?: string;
+    image?: ImageMedia;
+    audio?: AudioMedia;
+    timingOverrides?: TimingOverrides;
+}
+interface Conversation {
+    speakers?: Speaker[];
+    textStyle?: TextStyle;
+    messages?: ConversationMessage[];
+}
+interface Alternatives {
+    audio?: AudioElement;
+}
+/**
+ * Definitions
+ */
+interface Field {
+    name?: string;
+    type: string;
+    label?: Text;
+    isSection?: boolean;
+    fields?: Field[];
+}
+interface ScreenDefinition {
+    id: string;
+    type: 'screen';
+    title: Text;
+    layouts?: string[];
+    fields?: Field[];
+}
+interface FieldDefinition {
+    id: string;
+    type: 'field';
+    title: Text;
+    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[];
+}
+interface ViewerTheme extends Theme {
+    logo?: ImageMedia;
+}
+/**
+ * Metadata
+ */
+interface Metadata {
+    description?: string;
+    shareUrl?: string;
+    shareImage?: ImageMedia;
+    favIcon?: ImageMedia;
+}
+interface Tag {
+    label?: string;
+    value?: number | string;
+}
+/**
+ * Story
+ */
+interface Story {
+    id?: string;
+    theme?: Theme;
+    components?: ScreenComponent[];
+    metadata?: Metadata;
+}
+/**
+ * Render
+ */
+interface DeviceScreen {
+    name: string;
+    mediaQuery?: string;
+}
+interface ScreenSize {
+    screen?: string;
+    screens?: string[];
+    width?: number;
+    height?: number;
+    landscape?: boolean;
+}
+type RenderContext = 'view' | 'placeholder' | 'edit' | 'preview' | 'static' | 'capture';
+/**
+ * Screens
+ */
+interface AdFormats {
+    width?: number;
+    height?: number;
+}
+interface AdFormat {
+    width?: number;
+    height?: number;
+    url?: string;
+    target?: Target;
+    iframe?: string;
+    image?: ImageMedia;
+}
+interface AudioComponent {
+    src?: string;
+    track?: string;
+    trackLng?: number;
+    controls?: boolean;
+}
+interface Slide {
+    image?: ImageMedia;
+    text?: string;
+}
+type ContainerStyle = Record<string, unknown>;
+/**
+ * Transitions
+ */
+type TransitionName = 'fade' | 'scale' | 'slide';
+type TransitionEasing = 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear';
+interface TransitionConfig {
+    name: TransitionName;
+    duration?: number;
+    easing?: TransitionEasing;
+}
+type Transition = TransitionName | TransitionConfig;
+interface Transitions {
+    in?: Transition;
+    out?: Transition;
+}
+/**
+ * Search
+ */
+interface SearchFilter {
+    type?: string;
+    value?: string | number;
+}
+/**
+ * Payments
+ */
+interface PaymentItem {
+    id?: string | number;
+    date?: string;
+    type?: string;
+    invoice_link?: string;
+    amount?: string | number;
+}
+/**
+ * Page Metadata
+ */
+interface PageMetadata {
+    canonical?: string;
+    description?: string;
+    keywords?: string | string[];
+    image?: {
+        url?: string;
+    };
+    favicon?: {
+        url?: string;
+    };
+    rssUrl?: string;
+    atomUrl?: string;
+    microformats?: Record<string, unknown>[];
+}
+interface AuthorElement {
+    name?: TextElement;
+    avatar?: {
+        url?: string;
+    };
+}
+interface Visitor {
+    id?: string | number;
+    name?: string;
+}
+interface Badge {
+    label?: TextElement;
+    buttonStyle?: BoxStyle;
+}
+interface CustomAnswer {
+    active?: boolean;
+    placeholder?: TextElement;
+    textStyle?: TextStyle;
+    boxStyle?: BoxStyle;
+}
+interface Header {
+    badge?: Badge;
+}
+interface Footer {
+    callToAction?: CallToAction;
+}
+type Reload = Record<string, unknown>;
+interface ClosedCaptions {
+    file?: ClosedCaptionsMedia;
+    textStyle?: TextStyle;
+    boxStyle?: BoxStyle;
+}
+type ButtonLayout = 'label-bottom' | 'label-top' | 'no-label' | 'label-over' | 'label-left' | 'label-right';
+
+declare class ColorsParser {
+    constructor({ fieldsManager, screensManager }: {
+        fieldsManager: any;
+        screensManager: any;
+    });
+    parse(story: any): any;
+    getColorFieldPatterns(fields: any, namePrefix?: any): any;
+    static fieldIsColor({ id }: {
+        id?: any;
+    }): boolean;
+    static getColorsFromPath(data: any, patterns: any, colors?: any, keyPrefix?: any): any;
+}
+
+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 EventsManager extends EventEmitter {
+    constructor(element: any);
+    subscribe(event: any, callback: any): void;
+    unsubscribe(event: any, callback: any): void;
+    addEventListener(event: any): void;
+    removeEventListener(event: any): void;
+}
+
+declare class FieldsManager extends DefinitionsManager {
+    filter(filter: any): FieldsManager;
+}
+
+declare class MediasParser {
+    constructor({ fieldsManager, screensManager, fieldsPattern }: {
+        fieldsManager: any;
+        screensManager: any;
+        fieldsPattern?: {};
+    });
+    getParsedStoryTheme(storyId: any, theme: any): any;
+    getFieldsPatternByScreen(type: any): any;
+    toPath(story: any): any;
+    fromPath(story: any, defaultMedias?: any): any;
+    getFieldsPattern(fields: any, namePrefix?: any): any;
+    static fieldIsMedia({ media }: {
+        media?: boolean;
+    }): boolean;
+    static fieldIsFontFamily({ id }: {
+        id?: any;
+    }): boolean;
+    static replacePathsWithMedias(data: any, medias: any, patterns: any, keyPrefix?: any): any;
+    static getMediaPath({ id }: {
+        id?: any;
+    }): string;
+    static replaceMediasWithPaths(data: any, patterns: any, medias?: any, keyPrefix?: any): any;
+    static getMediaPatternsFromData(obj: any): RegExp[];
+    static dot(obj: any): any;
+    static keys(obj: any): any[];
+}
+
+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 class StoryParser {
+    constructor({ screensManager, fieldsManager, fieldsPattern }: {
+        screensManager: any;
+        fieldsManager: any;
+        fieldsPattern: any;
+    });
+    parse(story: any, { withTheme, withMedias, withFonts, withMigrations }?: {
+        withTheme?: boolean;
+        withMedias?: boolean;
+        withFonts?: boolean;
+        withMigrations?: boolean;
+    }): any;
+}
+
+declare class ThemeParser {
+    constructor({ screensManager }: {
+        screensManager: any;
+    });
+    getDefinitionByScreen(type: any, themeComponents: any): any;
+    getFieldsForDefinition(definition: any): any;
+    parse(story: any): any;
+    parseScreen(definition: any, value: any, themeValue: any, themeBackground: any, themeColors: any, themeTextStyles: any, themeBoxStyles: any): any;
+    parseField(value: any, fieldDefinition: any, themeValue: any, themeColors: any, themeTextStyles: any, themeBoxStyles: any): any;
+    parseInnerFields(value: any, fieldsOrDefinition: any, themeValue: any, themeColors: any, themeTextStyles: any, themeBoxStyles: any): {};
+    parseValue(initialValue: any, fieldTheme: any, themeValue: any, themeColors: any, themeTextStyles: any, themeBoxStyles: any): any;
+}
+
+declare class FontsParser {
+    constructor({ fieldsManager, screensManager, fieldsPattern }: {
+        fieldsManager: any;
+        screensManager: any;
+        fieldsPattern?: {};
+    });
+    getFieldsPatternByScreen(type: any): any;
+    parse(story: any): any;
+    getFieldsPattern(fields: any, namePrefix?: any): any;
+    static fieldIsFontFamily({ id }: {
+        id?: any;
+    }): boolean;
+    static valueIsFont({ type }: {
+        type?: any;
+    }): boolean;
+    static extractFontsWithPaths(data: any, patterns: any, keyPrefix?: any): any;
+}
+
+declare class Tracking extends Tracking$1 {
+    constructor(opts?: {});
+    trackScreenView(screen: any, screenIndex: any): void;
+    trackEvent(category?: any, action?: any, label?: any, opts?: any): void;
+    trackMedia(type?: any, media?: any, action?: any, opts?: any): void;
+}
+
+export { ColorsParser, ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, MediasParser, ScreensManager, StoryParser, ThemeParser, Tracking };
+export type { ActiveForm, AdFormat, AdFormats, Alternatives, Answer, AudioComponent, AudioElement, AudioMedia, AuthorElement, BackgroundElement, Badge, BootstrapTheme, BorderStyle, BorderType, BoxStyle, Breadcrumb, Button, ButtonLayout, ButtonSize, ButtonTheme, CallToAction, CallToActionType, ClosedCaptions, ClosedCaptionsElement, ClosedCaptionsMedia, Color, ColorObject, Component, ContainerStyle, Conversation, ConversationMessage, CustomAnswer, CustomFont, DefaultMessage, DefaultMessageContent, Device, DeviceScreen, DropdownAlign, Errors, Field, FieldDefinition, Font, FontMedia, FontStyle, Footer, FormControlSize, FormErrors, FormField, GeoPosition, GridElement, GridLayout, GridLayoutItem, Header, HeadingElement, History, ImageElement, ImageElementWithCaption, ImageMedia, InputElement, Interaction, Intl, Label, Location, Margin, Marker, MarkerWithImage, Media, MediaFile, MediaMetadata, MediaType, MenuItem, Message, Metadata, Modal, ObjectFit, ObjectFitSize, PageMetadata, Panel, PaymentItem, Progress, QuizAnswer, Ref, Reload, RenderContext, ScreenComponent, ScreenDefinition, ScreenSize, SearchFilter, SelectOption, ShadowType, ShareIncentive, Slide, Speaker, StackAlign, StackDirection, StackElement, StackSpacing, StatusCode, Story, StoryComponent, Tag, Target, Text, TextAlign, TextElement, TextStyle, Theme, TimingOverrides, TrackingVariables, Transition, TransitionConfig, TransitionEasing, TransitionName, Transitions, User, VideoElement, VideoMedia, ViewerTheme, Visitor, VisualElement };