@media-quest/builder 0.0.30 → 0.0.32

package/dist/public-api.d.ts

@@ -1,4 +1,4 @@
-import { Condition, PageQueRules, SchemaDto } from '@media-quest/engine';
+import { Condition, PageQueRules, SchemaDto, DStyle } from '@media-quest/engine';
 
 /**
  * Builder objects are complex objects that are embedded inside
@@ -595,6 +595,179 @@ declare class BuilderTag extends BuilderObject<"builder-tag", BuilderTagDto> {
     toJson(): BuilderTagDto;
 }
 
+interface ThemeCompiler<ThemeSchema> {
+    currentTheme: ThemeSchema;
+    allThemes: ThemeSchema[];
+    setTheme(theme: ThemeSchema): void;
+    compile(schema: BuilderSchemaDto): SchemaDto;
+}
+
+interface CssTheme<S extends Partial<DStyle> = Partial<DStyle>> {
+    css: S;
+    cssEnabled: Partial<DStyle>;
+    cssDisabled: Partial<DStyle>;
+}
+
+type PStyle = Partial<DStyle>;
+interface IDefaultTheme {
+    name: string;
+    schemaBackgroundColor: string;
+    dimensions: {
+        baseHeight: number;
+        baseWidth: number;
+    };
+    pageBackGroundImage?: {
+        url: string;
+        style: PStyle;
+    };
+    pageBackGround?: {
+        style: PStyle;
+    };
+    backGroundArea1?: {
+        style: PStyle;
+    };
+    backGroundArea2?: {
+        style: PStyle;
+    };
+    backGroundArea3?: {
+        style: PStyle;
+    };
+    progressBar?: {
+        width: number;
+        height: number;
+        bottom: number;
+        left: number;
+        backgroundStyles: PStyle;
+        progressStyles: PStyle;
+        text?: {
+            style: PStyle;
+            textType: "percent" | "page-progress";
+        };
+    };
+    image: {
+        style: PStyle;
+    };
+    videoPlayer: {
+        playButton: {
+            iconUrl: string;
+            css: PStyle;
+            cssDisabled: PStyle;
+            cssEnabled: PStyle;
+            text?: {
+                text: string;
+                css: PStyle;
+            };
+        };
+        buttonBar?: PStyle;
+        pauseButton: {
+            iconUrl: string;
+            css: PStyle;
+            cssDisabled: PStyle;
+            cssEnabled: PStyle;
+            text?: {
+                text: string;
+                css: PStyle;
+            };
+        };
+        replayButton?: {
+            iconUrl: string;
+            css: PStyle;
+            cssDisabled: PStyle;
+            cssEnabled: PStyle;
+            text?: {
+                text: string;
+                css: PStyle;
+            };
+        };
+        muteButton?: {
+            iconUrl: string;
+            css: PStyle;
+            text?: {
+                text: string;
+                css: PStyle;
+            };
+        };
+        unMuteButton?: {
+            iconUrl: string;
+            css: PStyle;
+            text?: {
+                text: string;
+                css: PStyle;
+            };
+        };
+        videoElement: {
+            css: PStyle;
+        };
+    };
+    mainText: {
+        base: {
+            text: PStyle;
+            audio: {
+                css: PStyle;
+                cssDisabled: PStyle;
+                cssEnabled: PStyle;
+                iconUrl: string;
+            };
+        };
+        notMediaNotAudio: {
+            text: PStyle;
+        };
+        hasMediaNotAudio: {
+            text: PStyle;
+        };
+        hasMediaHasAudio: {
+            text: PStyle;
+            audio: PStyle;
+        };
+        notMediaHasAudio: {
+            text: PStyle;
+            audio: PStyle;
+        };
+    };
+    buttonBar: {
+        vibrateMs: number | false;
+        container: {
+            base: PStyle;
+            whenSingle: PStyle;
+            whenMany: PStyle;
+        };
+        responseButtons: BuilderOptionTheme;
+        nextButtonTheme: BuilderOptionTheme;
+    };
+}
+interface ButtonTheme {
+    btn: CssTheme;
+    divider: PStyle;
+    text1: PStyle;
+    text2: PStyle;
+}
+interface BuilderOptionTheme {
+    name: string;
+    normal: ButtonTheme;
+    dontKnow: ButtonTheme;
+}
+
+declare class DefaultThemeCompiler implements ThemeCompiler<IDefaultTheme> {
+    readonly name = "Ispe default theme.";
+    readonly defaultTheme: IDefaultTheme;
+    readonly theme2: IDefaultTheme;
+    currentTheme: IDefaultTheme;
+    allThemes: IDefaultTheme[];
+    private readonly TAG;
+    setTheme(theme: IDefaultTheme): void;
+    constructor();
+    private compileRules;
+    compile(source: BuilderSchemaDto): SchemaDto;
+    private compilePage;
+    private compileImage;
+    private compileMainText;
+    private compileMainTextAudio;
+    private compileVideo;
+    private compileQuestion;
+    private compileButtonBar;
+    private compileButton;
+}
+
 interface SumScoreVariableDto {
     id: SumScoreVariableID;
     name: string;
@@ -708,6 +881,7 @@ declare class BuilderSchema {
     readonly id: SchemaID;
     name: string;
     readonly prefix: SchemaPrefix;
+    readonly compiler: DefaultThemeCompiler;
     baseHeight: number;
     baseWidth: number;
     backgroundColor: string;
@@ -820,4 +994,6 @@ declare class TagCollection implements Iterable<BuilderTag> {
     deleteAll(tags: Iterable<BuilderTag>): void;
 }
 
-export { type AudioFile, BuilderCondition, type BuilderConditionDto, BuilderConditionGroup, type BuilderConditionGroupDto, type BuilderMainImageDto, BuilderMainText, type BuilderMainTextDto, type BuilderMainVideoDto, BuilderOperator, BuilderOption, type BuilderOptionDto, BuilderPage, type BuilderPageDto, type BuilderPageType, BuilderQuestion, type BuilderQuestionDto, type BuilderQuestionType, BuilderRule, type BuilderRuleDto, BuilderSchema, type BuilderSchemaDto, BuilderTag, type BuilderTagDto, BuilderText, type BuilderTextDto, CodeBook, type CodeBookQuestionVariable, type Codebook, type CodebookPredefinedVariable, type CompilerOption, type CompilerOutput, ConditionGroupType, type ExcludeByPageAction, ExcludeByPageIdSelectItem, type ExcludeByTagAction, ExcludeByTagSelectItem, type ID, type ImageFile, JumpToActionManager, type JumpToPageAction, JumpToPageSelectItem, MultiSelectItem, OperatorSelectItem, OptionID, PageActionManager, PageID, PagePrefix, type PagePrefixValue, QuestionID, RuleCustomVariable, RuleInput, RuleOptionSelectItem, RuleQuestionVariable, type RuleVariable, RuleVariableOption, RuleVariableSelectItem, SchemaConfig, SchemaID, SchemaPrefix, type SchemaPrefixValue, SingleSelectItem, SumScore, type SumScoreAnswer, SumScoreVariable, type SumScoreVariableDto, SumScoreVariableID, TagActionManager, TagCollection, TagID, TextID, VarID, type VideoFile, _CodeBook, createTypedIdSingleton };
+declare const DefaultTheme: IDefaultTheme;
+
+export { type AudioFile, BuilderCondition, type BuilderConditionDto, BuilderConditionGroup, type BuilderConditionGroupDto, type BuilderMainImageDto, BuilderMainText, type BuilderMainTextDto, type BuilderMainVideoDto, BuilderOperator, BuilderOption, type BuilderOptionDto, BuilderPage, type BuilderPageDto, type BuilderPageType, BuilderQuestion, type BuilderQuestionDto, type BuilderQuestionType, BuilderRule, type BuilderRuleDto, BuilderSchema, type BuilderSchemaDto, BuilderTag, type BuilderTagDto, BuilderText, type BuilderTextDto, CodeBook, type CodeBookQuestionVariable, type Codebook, type CodebookPredefinedVariable, type CompilerOption, type CompilerOutput, ConditionGroupType, DefaultTheme, type ExcludeByPageAction, ExcludeByPageIdSelectItem, type ExcludeByTagAction, ExcludeByTagSelectItem, type ID, type ImageFile, JumpToActionManager, type JumpToPageAction, JumpToPageSelectItem, MultiSelectItem, OperatorSelectItem, OptionID, PageActionManager, PageID, PagePrefix, type PagePrefixValue, QuestionID, RuleCustomVariable, RuleInput, RuleOptionSelectItem, RuleQuestionVariable, type RuleVariable, RuleVariableOption, RuleVariableSelectItem, SchemaConfig, SchemaID, SchemaPrefix, type SchemaPrefixValue, SingleSelectItem, SumScore, type SumScoreAnswer, SumScoreVariable, type SumScoreVariableDto, SumScoreVariableID, TagActionManager, TagCollection, TagID, TextID, VarID, type VideoFile, _CodeBook, createTypedIdSingleton };