@media-quest/builder 0.0.22 → 0.0.23

package/src/Builder-schema.ts

@@ -1,254 +1,287 @@
-import type { BuilderPageDto, BuilderPageType } from "./Builder-page";
-import { BuilderPage } from "./Builder-page";
-import { RuleInput } from "./rulebuilder/RuleInput";
-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 { PagePrefix } from "./primitives/page-prefix";
-import { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
-import { Codebook, CodeBook } from "./codebook";
-import { PredefinedVariable } from "./mq-variable";
-import { SchemaConfig } from "./schema-config";
-const U = DUtil;
-
-export interface BuilderSchemaDto {
-  readonly id: SchemaID;
-  readonly prefix: SchemaPrefixValue;
-  readonly mainImage: ImageFile | false;
-  readonly backgroundColor: string;
-  readonly name: string;
-  readonly pages: BuilderPageDto[];
-  readonly baseHeight: number;
-  readonly baseWidth: number;
-  readonly predefinedVariables?: Array<PredefinedVariable>;
-  readonly rules: ReadonlyArray<BuilderRuleDto>;
-  readonly tags: ReadonlyArray<BuilderTagDto>;
-}
-
-export interface SchemaBuildOutput {
-  schema: SchemaDto;
-  codebook: Codebook;
-  schemaConfig: SchemaConfig;
-}
-
-export class BuilderSchema {
-  readonly prefix: SchemaPrefix;
-  baseHeight = 1300;
-  baseWidth = 1024;
-  backgroundColor = "#000000";
-  pages: BuilderPage[] = [];
-  mainImage: ImageFile | false = false;
-  predefinedVariables: PredefinedVariable[] = [];
-  private _rules: BuilderRule[] = [];
-  get rules(): ReadonlyArray<BuilderRule> {
-    return [...this._rules];
-  }
-
-  // get prefix(): SchemaPrefixValue {
-  //   return this._prefix.value;
-  // }
-
-  private readonly _tagCollection: TagCollection = TagCollection.create();
-  get tags(): ReadonlyArray<BuilderTag> {
-    return [...this._tagCollection];
-  }
-  public static create(id: SchemaID, name: string, prefix: SchemaPrefixValue) {
-    const schemaPrefix = SchemaPrefix.castOrCreateRandom(prefix);
-    return new BuilderSchema(id, name, schemaPrefix);
-  }
-
-  public static fromJson(dto: BuilderSchemaDto): BuilderSchema {
-    const schemaPrefix = SchemaPrefix.castOrCreateRandom(dto.prefix);
-    const schema = new BuilderSchema(dto.id, dto.name, schemaPrefix);
-    const pages = dto.pages.map(BuilderPage.fromJson);
-    schema._tagCollection.init(dto.tags);
-    schema.backgroundColor = dto.backgroundColor;
-    schema.baseHeight = dto.baseHeight;
-    schema.baseWidth = dto.baseWidth;
-    schema.pages = pages;
-    schema.predefinedVariables = dto.predefinedVariables ?? [];
-    schema.backgroundColor = dto.backgroundColor;
-    schema.mainImage = dto.mainImage ?? false;
-    const rulesDto = dto.rules ?? [];
-    const ruleInput = schema.getRuleInput();
-    schema._rules = rulesDto.map((r) => BuilderRule.fromDto(r, ruleInput));
-    return schema;
-  }
-
-  toJson(): BuilderSchemaDto {
-    const pages = this.pages.map((p) => p.toJson());
-    const tags = this._tagCollection.toJson();
-    const rules = this._rules.map((rule) => rule.toJson());
-
-    const dto: BuilderSchemaDto = {
-      backgroundColor: this.backgroundColor,
-      baseHeight: this.baseHeight,
-      baseWidth: this.baseWidth,
-      id: this.id,
-      name: this.name,
-      pages,
-      rules,
-      tags,
-      predefinedVariables: this.predefinedVariables,
-      mainImage: this.mainImage,
-      prefix: this.prefix.value,
-    };
-    return dto;
-  }
-  private constructor(
-    public readonly id: SchemaID,
-    public name: string,
-    prefix: SchemaPrefix,
-  ) {
-    this.prefix = prefix;
-  }
-
-  addPage(type: BuilderPageType, atIndex = -1): BuilderPage {
-    const pagePrefix = PagePrefix.create();
-    const newPage = BuilderPage.create(type, pagePrefix.value);
-    if (atIndex >= 0 && atIndex < this.pages.length) {
-      this.pages.splice(atIndex, 0, newPage);
-    } else {
-      this.pages.push(newPage);
-    }
-    return newPage;
-  }
-
-  insertPage(page: BuilderPage, atIndex: number): boolean {
-    return this.insertPageAtIndex(page, atIndex);
-  }
-
-  private insertPageAtIndex(page: BuilderPage, atIndex: number) {
-    const isValidIndex = U.isInRange(0, this.pages.length - 1);
-    if (!isValidIndex(atIndex)) {
-      return false;
-    }
-    const exists = !!this.pages.find((p) => p.id === page.id);
-    if (exists) {
-      return false;
-    }
-    this.pages.splice(atIndex, 0, page);
-    return true;
-  }
-
-  addRule() {
-    const input = this.getRuleInput();
-    const count = this._rules.length + 1;
-    const name = "Rule-number: " + count;
-    const rule = BuilderRule.fromDto(
-      {
-        conditions: [],
-        type: "all",
-        name,
-        excludeTags: [],
-        jumpToPage: false,
-        excludePages: [],
-      },
-      input,
-    );
-    this._rules.push(rule);
-    return rule;
-  }
-  deleteRule(rule: BuilderRule) {
-    this._rules = this._rules.filter((r) => r !== rule);
-  }
-
-  movePage(page: BuilderPage, toIndex: number): boolean {
-    const index = this.pages.indexOf(page);
-    if (index < 0) {
-      return false;
-    }
-    const isValidIndex = U.isInRange(0, this.pages.length - 1);
-    if (!isValidIndex(toIndex)) {
-      return false;
-    }
-    // console.log('Moving from :' + index + ' to: ' + toIndex);
-    this.pages.splice(index, 1);
-    this.pages.splice(toIndex, 0, page);
-    return true;
-  }
-
-  deletePage(page: BuilderPage): boolean {
-    const filtered = this.pages.filter((p) => p !== page);
-    const didDelete = filtered.length === this.pages.length - 1;
-    this.pages = filtered;
-    return didDelete;
-  }
-
-  reevaluateRules() {
-    console.log("Reevaluationg rulesInput");
-    const input = this.getRuleInput();
-    const rulesDto = this._rules.map((r) => r.toJson());
-    this._rules = rulesDto.map((dto) => BuilderRule.fromDto(dto, input));
-  }
-
-  getRuleInput(): RuleInput {
-    const qVars: QuestionVariable[] = [];
-    const cVars: CustomVariable[] = [];
-    const pageIdActions: ExcludeByPageAction[] = [];
-    const tagActions: ExcludeByTagAction[] = this.tags.map((t) => {
-      const tag = t.tagText;
-      const pageCount = this.pages.reduce((count, curr) => {
-        return curr.tags.includes(tag) ? count + 1 : count;
-      }, 0);
-      const excludeByTagDto: ExcludeByTagAction = {
-        kind: "exclude-by-tag",
-        pageCount,
-        tag,
-        description: t.tagDescription,
-      };
-      return excludeByTagDto;
-    });
-    const jumpActions: JumpToPageAction[] = [];
-    this.pages.forEach((page, index) => {
-      const pageVariables = page.getQuestionVariables(this.prefix, index);
-      qVars.push(...pageVariables);
-      const mainText = page.mainText.text;
-      const pagePrefix = page.prefix;
-      const jumpAction: JumpToPageAction = {
-        kind: "jump-to-page",
-        pageId: page.id,
-        pagePrefix,
-        pageNumber: index,
-        mainText: page.mainText.text,
-      };
-      const excludePageAction: ExcludeByPageAction = {
-        kind: "exclude-by-pageId",
-        pageId: page.id,
-        pagePrefix,
-        pageNumber: index,
-        mainText,
-      };
-      jumpActions.push(jumpAction);
-      pageIdActions.push(excludePageAction);
-    });
-    const ruleInput = new RuleInput(qVars, cVars, pageIdActions, tagActions, jumpActions);
-
-    return ruleInput;
-  }
-
-  deleteTags(tags: ReadonlyArray<BuilderTag>) {
-    this._tagCollection.deleteAll(tags);
-  }
-
-  addTag(builderTag: BuilderTag) {
-    this._tagCollection.add(builderTag);
-  }
-
-  compile(): SchemaBuildOutput {
-    const moduleDto = this.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 };
-    return output;
-  }
-}
+import type { BuilderPageDto, BuilderPageType } from "./Builder-page";
+import { BuilderPage } from "./Builder-page";
+import type {
+  BuilderRuleDto,
+  CustomVariable,
+  ExcludeByPageAction,
+  ExcludeByTagAction,
+  JumpToPageAction,
+} from "./rulebuilder";
+import { BuilderRule, RuleInput } from "./rulebuilder";
+import type { QuestionVariable } from "./rulebuilder/RuleVariable";
+import type { BuilderTagDto } from "./BuilderTag";
+import { BuilderTag, TagCollection } from "./BuilderTag";
+import { DefaultThemeCompiler } from "./theme/default-theme-compiler";
+import { ImageFile } from "./media-files";
+import { DUtil, SchemaID } from "@media-quest/engine";
+import { PagePrefix } from "./primitives/page-prefix";
+import { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
+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-variable";
+
+const U = DUtil;
+
+export interface BuilderSchemaDto {
+  readonly id: SchemaID;
+  readonly prefix: SchemaPrefixValue;
+  readonly mainImage: ImageFile | false;
+  readonly backgroundColor: string;
+  readonly name: string;
+  readonly pages: BuilderPageDto[];
+  readonly baseHeight: number;
+  readonly baseWidth: number;
+  readonly predefinedVariables?: Array<PredefinedVariable>;
+  readonly sumScoreVariables?: Array<SumScoreVariable>;
+  readonly rules: ReadonlyArray<BuilderRuleDto>;
+  readonly tags: ReadonlyArray<BuilderTagDto>;
+}
+
+class SumScoreVariableCollection {
+  private _all:Array<SumScoreVariable> = []
+
+}
+
+export class BuilderSchema {
+  readonly prefix: SchemaPrefix;
+  baseHeight = 1300;
+  baseWidth = 1024;
+  backgroundColor = "#000000";
+  pages: BuilderPage[] = [];
+  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;
+  // }
+
+  private readonly _tagCollection: TagCollection = TagCollection.create();
+  get tags(): ReadonlyArray<BuilderTag> {
+    return [...this._tagCollection];
+  }
+  public static create(id: SchemaID, name: string, prefix: SchemaPrefixValue) {
+    const schemaPrefix = SchemaPrefix.castOrCreateRandom(prefix);
+    return new BuilderSchema(id, name, schemaPrefix);
+  }
+
+  public static fromJson(dto: BuilderSchemaDto): BuilderSchema {
+    const schemaPrefix = SchemaPrefix.castOrCreateRandom(dto.prefix);
+    const schema = new BuilderSchema(dto.id, dto.name, schemaPrefix);
+    const pages = dto.pages.map(BuilderPage.fromJson);
+    schema._tagCollection.init(dto.tags);
+    schema.backgroundColor = dto.backgroundColor;
+    schema.baseHeight = dto.baseHeight;
+    schema.baseWidth = dto.baseWidth;
+    schema.pages = pages;
+    schema.predefinedVariables = dto.predefinedVariables ?? [];
+    schema.backgroundColor = dto.backgroundColor;
+    schema.mainImage = dto.mainImage ?? false;
+    const rulesDto = dto.rules ?? [];
+    const ruleInput = schema.getRuleInput();
+    schema._rules = rulesDto.map((r) => BuilderRule.fromDto(r, ruleInput));
+    return schema;
+  }
+
+  toJson(): BuilderSchemaDto {
+    const pages = this.pages.map((p) => p.toJson());
+    const tags = this._tagCollection.toJson();
+    const rules = this._rules.map((rule) => rule.toJson());
+
+    const dto: BuilderSchemaDto = {
+      backgroundColor: this.backgroundColor,
+      baseHeight: this.baseHeight,
+      baseWidth: this.baseWidth,
+      id: this.id,
+      name: this.name,
+      pages,
+      rules,
+      tags,
+      predefinedVariables: this.predefinedVariables,
+      mainImage: this.mainImage,
+      prefix: this.prefix.value,
+    };
+    return dto;
+  }
+  private constructor(
+    public readonly id: SchemaID,
+    public name: string,
+    prefix: SchemaPrefix,
+  ) {
+    this.prefix = prefix;
+  }
+
+  addPage(type: BuilderPageType, atIndex = -1): BuilderPage {
+    const pagePrefix = PagePrefix.create();
+    const newPage = BuilderPage.create(type, pagePrefix.value);
+    if (atIndex >= 0 && atIndex < this.pages.length) {
+      this.pages.splice(atIndex, 0, newPage);
+    } else {
+      this.pages.push(newPage);
+    }
+    return newPage;
+  }
+
+  addSumScoreVariable(variable: SumScoreVariable) {
+    // TODO VALIDATE.
+    this._sumVariables.push({ ...variable });
+  }
+
+  insertPage(page: BuilderPage, atIndex: number): boolean {
+    return this.insertPageAtIndex(page, atIndex);
+  }
+
+  private insertPageAtIndex(page: BuilderPage, atIndex: number) {
+    const isValidIndex = U.isInRange(0, this.pages.length - 1);
+    if (!isValidIndex(atIndex)) {
+      return false;
+    }
+    const exists = !!this.pages.find((p) => p.id === page.id);
+    if (exists) {
+      return false;
+    }
+    this.pages.splice(atIndex, 0, page);
+    return true;
+  }
+
+  addRule() {
+    const input = this.getRuleInput();
+    const count = this._rules.length + 1;
+    const name = "Rule-number: " + count;
+    const rule = BuilderRule.fromDto(
+      {
+        conditions: [],
+        type: "all",
+        name,
+        excludeTags: [],
+        jumpToPage: false,
+        excludePages: [],
+      },
+      input,
+    );
+    this._rules.push(rule);
+    return rule;
+  }
+  deleteRule(rule: BuilderRule) {
+    this._rules = this._rules.filter((r) => r !== rule);
+  }
+
+  movePage(page: BuilderPage, toIndex: number): boolean {
+    const index = this.pages.indexOf(page);
+    if (index < 0) {
+      return false;
+    }
+    const isValidIndex = U.isInRange(0, this.pages.length - 1);
+    if (!isValidIndex(toIndex)) {
+      return false;
+    }
+    // console.log('Moving from :' + index + ' to: ' + toIndex);
+    this.pages.splice(index, 1);
+    this.pages.splice(toIndex, 0, page);
+    return true;
+  }
+
+  deletePage(page: BuilderPage): boolean {
+    const filtered = this.pages.filter((p) => p !== page);
+    const didDelete = filtered.length === this.pages.length - 1;
+    this.pages = filtered;
+    return didDelete;
+  }
+
+  reevaluateRules() {
+    console.log("Reevaluationg rulesInput");
+    const input = this.getRuleInput();
+    const rulesDto = this._rules.map((r) => r.toJson());
+    this._rules = rulesDto.map((dto) => BuilderRule.fromDto(dto, input));
+  }
+
+  getRuleInput(): RuleInput {
+    const qVars: QuestionVariable[] = [];
+    const cVars: CustomVariable[] = [];
+    const pageIdActions: ExcludeByPageAction[] = [];
+    const tagActions: ExcludeByTagAction[] = this.tags.map((t) => {
+      const tag = t.tagText;
+      const pageCount = this.pages.reduce((count, curr) => {
+        return curr.tags.includes(tag) ? count + 1 : count;
+      }, 0);
+      const excludeByTagDto: ExcludeByTagAction = {
+        kind: "exclude-by-tag",
+        pageCount,
+        tag,
+        description: t.tagDescription,
+      };
+      return excludeByTagDto;
+    });
+    const jumpActions: JumpToPageAction[] = [];
+    this.pages.forEach((page, index) => {
+      const pageVariables = page.getQuestionVariables(this.prefix, index);
+      qVars.push(...pageVariables);
+      const mainText = page.mainText.text;
+      const pagePrefix = page.prefix;
+      const jumpAction: JumpToPageAction = {
+        kind: "jump-to-page",
+        pageId: page.id,
+        pagePrefix,
+        pageNumber: index,
+        mainText: page.mainText.text,
+      };
+      const excludePageAction: ExcludeByPageAction = {
+        kind: "exclude-by-pageId",
+        pageId: page.id,
+        pagePrefix,
+        pageNumber: index,
+        mainText,
+      };
+      jumpActions.push(jumpAction);
+      pageIdActions.push(excludePageAction);
+    });
+    const ruleInput = new RuleInput(qVars, cVars, pageIdActions, tagActions, jumpActions);
+
+    return ruleInput;
+  }
+
+  deleteTags(tags: ReadonlyArray<BuilderTag>) {
+    this._tagCollection.deleteAll(tags);
+  }
+
+  addTag(builderTag: BuilderTag) {
+    this._tagCollection.add(builderTag);
+  }
+
+  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: 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);
+    });
+});