@media-quest/builder 0.0.22 → 0.0.24

package/src/Builder-question.ts

@@ -1,101 +1,101 @@
-import type { BuilderOptionDto } from "./Builder-option";
-import { BuilderOption } from "./Builder-option";
-import { BuilderObject, BuilderObjectId } from "./BuilderObject";
-
-export type BuilderQuestionType =
-    | "select-one"
-    | "select-many"
-    | "text"
-    | "color"
-    | "radio"
-    | "email"
-    | "time"
-    | "checkbox"
-    | "textarea"
-    | "date"
-    | "numeric-range"
-    | "duration";
-
-export interface BuilderQuestionDto {
-    readonly id: BuilderObjectId.QuestionID;
-    _type: BuilderQuestionType;
-    text: string;
-    options: ReadonlyArray<BuilderOptionDto>;
-    prefix: string;
-}
-
-export class BuilderQuestion extends BuilderObject<"builder-question", BuilderQuestionDto> {
-    readonly objectType = "builder-question";
-    id: BuilderObjectId.QuestionID;
-    type: BuilderQuestionType;
-    questionText = "";
-    options: BuilderOption[] = [];
-    prefix = "";
-
-    static create = (type: BuilderQuestionType) => {
-        const id = BuilderObjectId.questionId();
-
-        return new BuilderQuestion({
-            id,
-            _type: type,
-            text: "",
-            options: [],
-            prefix: "",
-        });
-    };
-
-    public static fromJson(dto: BuilderQuestionDto): BuilderQuestion {
-        const question = new BuilderQuestion(dto);
-        return question;
-    }
-
-    private constructor(dto: BuilderQuestionDto) {
-        super(dto);
-        this.id = dto.id as BuilderObjectId.QuestionID;
-        this.type = dto._type;
-        this.questionText = dto.text;
-        this.prefix = dto.prefix;
-        this.options = dto.options.map((o) => BuilderOption.fromJson(o));
-    }
-
-    addOption(label: string, value: number, atIndex = -1) {
-        const option = BuilderOption.create(value, label);
-        if (atIndex >= 0 && atIndex < this.options.length) {
-            this.options.splice(atIndex, 0, option);
-        } else {
-            this.options.push(option);
-        }
-        return option;
-    }
-
-    deleteOption(option: BuilderOption): boolean {
-        const filtered = this.options.filter((o) => o.id !== option.id);
-        const didDelete = filtered.length === this.options.length - 1;
-        this.options = filtered;
-        return didDelete;
-    }
-
-    toJson() {
-        const optionsJson = this.options.map((o) => o.toJson());
-        const dto: BuilderQuestionDto = {
-            id: this.id,
-            prefix: this.prefix,
-            _type: this.type,
-            text: this.questionText,
-            options: optionsJson,
-        };
-        return dto;
-    }
-
-    clone(): BuilderQuestionDto {
-        const cloneId = BuilderObjectId.questionId();
-        const dto = this.toJson();
-        const optionsClone = this.options.map((o) => o.clone());
-        const clonedDto: BuilderQuestionDto = {
-            ...dto,
-            id: cloneId,
-            options: optionsClone,
-        };
-        return clonedDto;
-    }
-}
+import type { BuilderOptionDto } from "./Builder-option";
+import { BuilderOption } from "./Builder-option";
+import { BuilderObject, BuilderObjectId } from "./BuilderObject";
+
+export type BuilderQuestionType =
+    | "select-one"
+    | "select-many"
+    | "text"
+    | "color"
+    | "radio"
+    | "email"
+    | "time"
+    | "checkbox"
+    | "textarea"
+    | "date"
+    | "numeric-range"
+    | "duration";
+
+export interface BuilderQuestionDto {
+    readonly id: BuilderObjectId.QuestionID;
+    _type: BuilderQuestionType;
+    text: string;
+    options: ReadonlyArray<BuilderOptionDto>;
+    prefix: string;
+}
+
+export class BuilderQuestion extends BuilderObject<"builder-question", BuilderQuestionDto> {
+    readonly objectType = "builder-question";
+    id: BuilderObjectId.QuestionID;
+    type: BuilderQuestionType;
+    questionText = "";
+    options: BuilderOption[] = [];
+    prefix = "";
+
+    static create = (type: BuilderQuestionType) => {
+        const id = BuilderObjectId.questionId();
+
+        return new BuilderQuestion({
+            id,
+            _type: type,
+            text: "",
+            options: [],
+            prefix: "",
+        });
+    };
+
+    public static fromJson(dto: BuilderQuestionDto): BuilderQuestion {
+        const question = new BuilderQuestion(dto);
+        return question;
+    }
+
+    private constructor(dto: BuilderQuestionDto) {
+        super(dto);
+        this.id = dto.id as BuilderObjectId.QuestionID;
+        this.type = dto._type;
+        this.questionText = dto.text;
+        this.prefix = dto.prefix;
+        this.options = dto.options.map((o) => BuilderOption.fromJson(o));
+    }
+
+    addOption(label: string, value: number, atIndex = -1) {
+        const option = BuilderOption.create(value, label);
+        if (atIndex >= 0 && atIndex < this.options.length) {
+            this.options.splice(atIndex, 0, option);
+        } else {
+            this.options.push(option);
+        }
+        return option;
+    }
+
+    deleteOption(option: BuilderOption): boolean {
+        const filtered = this.options.filter((o) => o.id !== option.id);
+        const didDelete = filtered.length === this.options.length - 1;
+        this.options = filtered;
+        return didDelete;
+    }
+
+    toJson() {
+        const optionsJson = this.options.map((o) => o.toJson());
+        const dto: BuilderQuestionDto = {
+            id: this.id,
+            prefix: this.prefix,
+            _type: this.type,
+            text: this.questionText,
+            options: optionsJson,
+        };
+        return dto;
+    }
+
+    clone(): BuilderQuestionDto {
+        const cloneId = BuilderObjectId.questionId();
+        const dto = this.toJson();
+        const optionsClone = this.options.map((o) => o.clone());
+        const clonedDto: BuilderQuestionDto = {
+            ...dto,
+            id: cloneId,
+            options: optionsClone,
+        };
+        return clonedDto;
+    }
+}

package/src/Builder-schema.spec.ts

@@ -7,6 +7,7 @@ import type { BuilderObjectId } from "./BuilderObject";
 import { PageID, SchemaID } from "@media-quest/engine";
 import { PagePrefix } from "./primitives/page-prefix";
 import { SchemaPrefix } from "./primitives/schema-prefix";
+import { SumScoreVariable } from "./variable/sum-score";
 
 const tag1: BuilderTagDto = BuilderTag.create("tag1", "This tag is defined in schemaDto1").toJson();
 
@@ -21,6 +22,16 @@ const schemaDto1: BuilderSchemaDto = {
   id: SchemaID.create(),
   name: "dto1-name",
   tags: [tag1, tag2, tag3],
+  sumScoreVariables: [
+    {
+      kind: "numeric-variable",
+      origin: "sum-score",
+      label: "label for dummy variable",
+      initialValue: 0,
+      varId: "testId",
+      basedOn: [],
+    },
+  ],
   pages: [
     {
       id: PageID.ensure("a".repeat(24)),
@@ -303,4 +314,44 @@ describe("Builder schema", () => {
       expect(allPageIds.has(v.pageId)).toBe(true);
     });
   });
+  test.skip("Can add sum-variables - and save as json", () => {
+    // p0.prefix = "info_page_prefix_";
+    const p1 = builderSchema.addPage("question");
+    const p2 = builderSchema.addPage("question");
+    p1.prefix = PagePrefix.fromStringOrThrow("p1_prefix");
+    p2.prefix = PagePrefix.fromStringOrThrow("p2_prefix");
+    p1.defaultQuestion.addOption("Ja", 1, 0);
+    p1.defaultQuestion.addOption("Nei", 0, 0);
+    p2.defaultQuestion.addOption("Ja", 1, 0);
+    p2.defaultQuestion.addOption("Nei", 0);
+
+    const ruleInput = builderSchema.getRuleInput();
+    const ss1: SumScoreVariable = {
+      label: "ss1",
+      varId: "ss1_var_id",
+      initialValue: 0,
+      kind: "numeric-variable",
+      origin: "sum-score",
+      basedOn: [],
+    };
+
+    builderSchema.addSumScoreVariable(ss1);
+
+    expect(ruleInput.questionVars.length).toBe(2);
+    expect(ruleInput.jumpToPageActions.length).toBe(3);
+
+    // TODO add TAGS!!
+    // expect(ruleInput.excludeByTagActions.length).toBe(0);
+    // expect(ruleInput.excludeByPageIdActions.length).toBe(3);
+    // const allPageIds = new Set(ruleInput.jumpToPageActions.map((a) => a.pageId));
+    // expect(allPageIds.has(p0.id)).toBe(true);
+    // expect(allPageIds.has(p1.id)).toBe(true);
+    // expect(allPageIds.has(p2.id)).toBe(true);
+    // ruleInput.questionVars.forEach((v) => {
+    //   expect(allPageIds.has(v.varId)).toBe(true);
+    // });
+    // ruleInput.jumpToPageActions.forEach((v) => {
+    //   expect(allPageIds.has(v.pageId)).toBe(true);
+    // });
+  });
 });

package/src/Builder-schema.ts

@@ -1,21 +1,27 @@
 import type { BuilderPageDto, BuilderPageType } from "./Builder-page";
 import { BuilderPage } from "./Builder-page";
-import { RuleInput } from "./rulebuilder/RuleInput";
+import type {
+  BuilderRuleDto,
+  CustomVariable,
+  ExcludeByPageAction,
+  ExcludeByTagAction,
+  JumpToPageAction,
+} from "./rulebuilder";
+import { BuilderRule, RuleInput } from "./rulebuilder";
 import type { QuestionVariable } from "./rulebuilder/RuleVariable";
-import type { CustomVariable } from "./rulebuilder";
-import type { ExcludeByPageAction, ExcludeByTagAction, JumpToPageAction } from "./rulebuilder";
 import type { BuilderTagDto } from "./BuilderTag";
 import { BuilderTag, TagCollection } from "./BuilderTag";
-import type { BuilderRuleDto } from "./rulebuilder";
-import { BuilderRule } from "./rulebuilder";
 import { DefaultThemeCompiler } from "./theme/default-theme-compiler";
 import { ImageFile } from "./media-files";
-import { SchemaDto, DUtil, PageID, SchemaID } from "@media-quest/engine";
+import { DUtil, SchemaID } from "@media-quest/engine";
 import { PagePrefix } from "./primitives/page-prefix";
 import { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
-import { Codebook, CodeBook } from "./codebook";
-import { PredefinedVariable } from "./mq-variable";
+import { CodeBook } from "./codebook";
+import { PredefinedVariable } from "./variable/mq-variable";
 import { SchemaConfig } from "./schema-config";
+import { CompilerOption, CompilerOutput } from "./builder-compiler";
+import { SumScoreVariable } from "./variable/sum-score";
+
 const U = DUtil;
 
 export interface BuilderSchemaDto {
@@ -28,14 +34,13 @@ export interface BuilderSchemaDto {
   readonly baseHeight: number;
   readonly baseWidth: number;
   readonly predefinedVariables?: Array<PredefinedVariable>;
+  readonly sumScoreVariables?: Array<SumScoreVariable>;
   readonly rules: ReadonlyArray<BuilderRuleDto>;
   readonly tags: ReadonlyArray<BuilderTagDto>;
 }
 
-export interface SchemaBuildOutput {
-  schema: SchemaDto;
-  codebook: Codebook;
-  schemaConfig: SchemaConfig;
+class SumScoreVariableCollection {
+  private _all: Array<SumScoreVariable> = [];
 }
 
 export class BuilderSchema {
@@ -47,9 +52,13 @@ export class BuilderSchema {
   mainImage: ImageFile | false = false;
   predefinedVariables: PredefinedVariable[] = [];
   private _rules: BuilderRule[] = [];
+  private _sumVariables: SumScoreVariable[] = [];
   get rules(): ReadonlyArray<BuilderRule> {
     return [...this._rules];
   }
+  get sumScoreVariables(): ReadonlyArray<SumScoreVariable> {
+    return [...this._sumVariables];
+  }
 
   // get prefix(): SchemaPrefixValue {
   //   return this._prefix.value;
@@ -121,6 +130,11 @@ export class BuilderSchema {
     return newPage;
   }
 
+  addSumScoreVariable(variable: SumScoreVariable) {
+    // TODO VALIDATE.
+    this._sumVariables.push({ ...variable });
+  }
+
   insertPage(page: BuilderPage, atIndex: number): boolean {
     return this.insertPageAtIndex(page, atIndex);
   }
@@ -242,13 +256,31 @@ export class BuilderSchema {
     this._tagCollection.add(builderTag);
   }
 
-  compile(): SchemaBuildOutput {
-    const moduleDto = this.toJson();
+  compile(
+    options: CompilerOption = { blockAutoplayQuestion: false, blockAutoplayVideo: false },
+  ): CompilerOutput {
+    // const moduleDto = this.toJson();
+    const builderSchema = BuilderSchema.fromJson(this.toJson());
+
+    // Overriding the
+    builderSchema.pages.forEach((p) => {
+      if (options.blockAutoplayQuestion) {
+        p.mainText.autoplay = false;
+      }
+      if (options.blockAutoplayVideo && p.mainMedia) {
+        if (p.mainMedia.kind === "main-video") {
+          // TODO autoplay as boolean, so that we know if video is optional or required when override.
+          p.mainMedia.mode = "optional";
+        }
+      }
+    });
+    const moduleDto = builderSchema.toJson();
     const imp = new DefaultThemeCompiler();
+
     const codebook = CodeBook.fromSchema(moduleDto);
     const schema = imp.compile(moduleDto);
     const schemaConfig = SchemaConfig.fromSchema(moduleDto);
-    const output: SchemaBuildOutput = { codebook, schema, schemaConfig };
+    const output: CompilerOutput = { codebook, schema, schemaConfig };
     return output;
   }
 }

package/src/Builder-text.spec.ts

@@ -1,24 +1,24 @@
-import type { BuilderTextDto } from "./Builder-text";
-import { BuilderText } from "./Builder-text";
-import type { BuilderObjectId } from "./BuilderObject";
-
-const textDto: BuilderTextDto = {
-    id: "dto1" as BuilderObjectId.TextID,
-    name: "dto1-name",
-    text: "text one",
-    translationRequired: true,
-};
-
-let text1 = BuilderText.create("text one created");
-
-beforeEach(() => {
-    text1 = BuilderText.create("text one created");
-});
-
-describe("Builder Text", () => {
-    test("Can serialize", () => {
-        const instance1 = BuilderText.fromJson(textDto);
-        const json = instance1.toJson();
-        expect(textDto).toStrictEqual(json);
-    });
-});
+import type { BuilderTextDto } from "./Builder-text";
+import { BuilderText } from "./Builder-text";
+import type { BuilderObjectId } from "./BuilderObject";
+
+const textDto: BuilderTextDto = {
+    id: "dto1" as BuilderObjectId.TextID,
+    name: "dto1-name",
+    text: "text one",
+    translationRequired: true,
+};
+
+let text1 = BuilderText.create("text one created");
+
+beforeEach(() => {
+    text1 = BuilderText.create("text one created");
+});
+
+describe("Builder Text", () => {
+    test("Can serialize", () => {
+        const instance1 = BuilderText.fromJson(textDto);
+        const json = instance1.toJson();
+        expect(textDto).toStrictEqual(json);
+    });
+});

package/src/Builder-text.ts

@@ -1,57 +1,57 @@
-import { BuilderObjectId, BuilderObject } from './BuilderObject';
-
-export interface BuilderTextDto {
-  readonly id: BuilderObjectId.TextID;
-  text: string;
-  name: string;
-  translationRequired: boolean;
-}
-
-export class BuilderText extends BuilderObject<'builder-text', BuilderTextDto> {
-  readonly objectType = 'builder-text';
-  id: BuilderObjectId.TextID;
-  text = '';
-  name = '';
-  translateRequired = false;
-  // audio: {id: B}
-  private constructor(dto: BuilderTextDto) {
-    super(dto);
-    this.id = dto.id;
-    this.translateRequired = dto.translationRequired;
-    this.name = dto.name;
-    this.text = dto.text;
-  }
-
-  public static create(name: string) {
-    const id = BuilderObjectId.textId();
-    const dto: BuilderTextDto = {
-      id,
-      name,
-      text: '',
-      translationRequired: false
-    };
-    const instance = new BuilderText(dto);
-    return instance;
-  }
-  public static fromJson(dto: BuilderTextDto) {
-    const instance = new BuilderText(dto);
-    return instance;
-  }
-
-  clone(): BuilderTextDto {
-    const newId = BuilderObjectId.textId();
-    const dto = this.toJson();
-    const withNewId: BuilderTextDto = { ...dto, id: newId };
-    return withNewId;
-  }
-
-  toJson(): BuilderTextDto {
-    const dto: BuilderTextDto = {
-      id: this.id,
-      name: this.name,
-      text: this.text,
-      translationRequired: this.translateRequired
-    };
-    return dto;
-  }
-}
+import { BuilderObjectId, BuilderObject } from './BuilderObject';
+
+export interface BuilderTextDto {
+  readonly id: BuilderObjectId.TextID;
+  text: string;
+  name: string;
+  translationRequired: boolean;
+}
+
+export class BuilderText extends BuilderObject<'builder-text', BuilderTextDto> {
+  readonly objectType = 'builder-text';
+  id: BuilderObjectId.TextID;
+  text = '';
+  name = '';
+  translateRequired = false;
+  // audio: {id: B}
+  private constructor(dto: BuilderTextDto) {
+    super(dto);
+    this.id = dto.id;
+    this.translateRequired = dto.translationRequired;
+    this.name = dto.name;
+    this.text = dto.text;
+  }
+
+  public static create(name: string) {
+    const id = BuilderObjectId.textId();
+    const dto: BuilderTextDto = {
+      id,
+      name,
+      text: '',
+      translationRequired: false
+    };
+    const instance = new BuilderText(dto);
+    return instance;
+  }
+  public static fromJson(dto: BuilderTextDto) {
+    const instance = new BuilderText(dto);
+    return instance;
+  }
+
+  clone(): BuilderTextDto {
+    const newId = BuilderObjectId.textId();
+    const dto = this.toJson();
+    const withNewId: BuilderTextDto = { ...dto, id: newId };
+    return withNewId;
+  }
+
+  toJson(): BuilderTextDto {
+    const dto: BuilderTextDto = {
+      id: this.id,
+      name: this.name,
+      text: this.text,
+      translationRequired: this.translateRequired
+    };
+    return dto;
+  }
+}

package/src/BuilderMainImageDto.ts

@@ -1,7 +1,7 @@
-import { ImageFile } from "./media-files";
-
-export interface BuilderMainImageDto {
-    readonly kind: "main-image";
-    readonly file: ImageFile;
-    readonly overlay: { text: string; fontsize: number; xPos: number; yPos: number } | false;
-}
+import { ImageFile } from "./media-files";
+
+export interface BuilderMainImageDto {
+    readonly kind: "main-image";
+    readonly file: ImageFile;
+    readonly overlay: { text: string; fontsize: number; xPos: number; yPos: number } | false;
+}