@media-quest/builder 0.0.26 → 0.0.27

package/src/page/Builder-page-collection.spec.ts

@@ -0,0 +1,209 @@
+import { BuilderTag, BuilderTagDto } from "../tag/BuilderTag";
+import { PagePrefix } from "../primitives/page-prefix";
+import { BuilderPageCollection } from "./Builder-page-collection";
+import { OptionID, PageID, QuestionID } from "../primitives/ID";
+import { BuilderPage, BuilderPageDto } from "./Builder-page";
+import { SumScoreVariable } from "../sum-score/sum-score-variable";
+import { SumScoreVariableCollection } from "../sum-score/sum-score-variable-collection";
+
+const tag1: BuilderTagDto = BuilderTag.create("tag1", "This tag is defined in schemaDto1").toJson();
+
+const tag2: BuilderTagDto = BuilderTag.create("tag2", "This tag is defined in schemaDto1").toJson();
+const tag3: BuilderTagDto = BuilderTag.create("tag3", "This tag is defined in schemaDto1").toJson();
+
+const sumScoreVariable1 = SumScoreVariable.create({
+  name: "ss1",
+  useAvg: true,
+  description: "ss1 description",
+});
+const sumScoreVariable2 = SumScoreVariable.create({
+  name: "ss2",
+  useAvg: true,
+  description: "ss2 description",
+});
+const sumScoreVariable3 = SumScoreVariable.create({
+  name: "ss3",
+  useAvg: true,
+  description: "ss3 description",
+});
+
+const pages: BuilderPageDto[] = [
+  {
+    id: PageID.validateOrCreate("a".repeat(24)),
+    _type: "info-page",
+    prefix: PagePrefix.fromStringOrThrow("p1"),
+    mainText: {
+      text: "hello from test",
+      autoplay: false,
+      autoplayDelay: 0,
+      audioFile: false,
+    },
+    includedInSumScores: [{ sumScoreVariableId: sumScoreVariable1.id, weight: 1 }],
+
+    nextButton: {
+      id: OptionID.create(),
+      label: "Neste",
+      value: -1,
+    },
+    defaultQuestion: {
+      id: QuestionID.create(),
+      prefix: "one-prefix",
+      _type: "select-one",
+      text: "q1-text",
+      options: [
+        {
+          id: "opt-nei" as OptionID,
+          value: 0,
+          label: "Nei",
+        },
+        {
+          id: "opt-ja" as OptionID,
+          value: 1,
+          label: "Ja",
+        },
+        {
+          id: "opt-vet-ikke" as OptionID,
+          value: 9,
+          label: "Vet ikke",
+        },
+      ],
+    },
+    tags: [
+      tag1.tag,
+      tag2.tag,
+      // { tag: 'can_read', description: 'The patient can read' },
+      // { tag: 'is grown up', description: 'Is grownUp.' }
+    ],
+    autoplaySequence: [],
+  },
+  {
+    id: PageID.dummy.b,
+    _type: "question",
+    prefix: PagePrefix.fromStringOrThrow("page2-prefix"),
+    tags: [tag3.tag],
+    includedInSumScores: [],
+    mainText: {
+      text: "hello from test",
+      autoplay: false,
+      autoplayDelay: 0,
+      audioFile: false,
+    },
+    nextButton: {
+      id: "next-button-id-page2" as OptionID,
+      label: "Neste",
+      value: -1,
+    },
+    defaultQuestion: {
+      id: QuestionID.validateOrCreate("default-question-id"),
+      prefix: "one-prefix",
+      _type: "select-one",
+      text: "q1",
+      options: [],
+    },
+    autoplaySequence: [],
+  },
+];
+
+let sumScoreVariableCollection = SumScoreVariableCollection.create([
+  sumScoreVariable1,
+  sumScoreVariable2,
+  sumScoreVariable3,
+]);
+let empty = BuilderPageCollection.create([]);
+beforeEach(() => {
+  sumScoreVariableCollection = SumScoreVariableCollection.create([
+    sumScoreVariable1,
+    sumScoreVariable2,
+    sumScoreVariable3,
+  ]);
+  empty = BuilderPageCollection.create([]);
+});
+
+describe("Builder page collection", () => {
+  test("Can add pages.", () => {
+    const p1 = empty.add("question");
+    const p2 = empty.add("info-page");
+    expect(empty.size).toBe(2);
+  });
+
+  test("Can delete page by id,", () => {
+    const p1 = empty.add("question");
+    const p2 = empty.add("question");
+    const p3 = empty.add("info-page");
+    expect(empty.size).toBe(3);
+    const result = empty.deleteById(p1.id);
+    expect(empty.size).toBe(2);
+    expect(result).toBe(true);
+    const result2 = empty.deleteById(p2.id);
+    expect(result2).toBe(true);
+    expect(empty.size).toBe(1);
+    expect(empty.pages[0]).toBe(p3);
+    const result3 = empty.deleteById(PageID.create());
+    expect(result3).toBe(false);
+  });
+
+  test("fromJson === toJson", () => {
+    const col = BuilderPageCollection.create(pages);
+    const json = col.toJson();
+    expect(pages).toStrictEqual(json);
+  });
+  //
+
+  test("Can add page at concrete index", () => {
+    const p1 = empty.add("question");
+    expect(p1.pageType).toBe("question");
+    const p2 = empty.add("info-page", 0);
+    expect(p2.pageType).toBe("info-page");
+
+    expect(empty.pages[0].id).toBe(p2.id);
+    empty.add("question");
+    empty.add("question");
+    const last = empty.add("question");
+    expect(empty.pages[empty.pages.length - 1]).toBe(last);
+    const p3 = empty.add("info-page", 4);
+    expect(empty.pages[4].id).toBe(p3.id);
+  });
+  //
+  test("Can move page up and down", () => {
+    const p1 = empty.add("question");
+    const p2 = empty.add("question");
+    const p3 = empty.add("question");
+    const p4 = empty.add("info-page");
+    const last = empty.add("question");
+    empty.movePage(p2, 0);
+    expect(empty.pages[0]).toBe(p2);
+    expect(empty.pages[1]).toBe(p1);
+    expect(empty.movePage(p4, 4)).toBeTruthy();
+    expect(empty.movePage(p4, 5)).toBeFalsy();
+    expect(empty.movePage(p4, 10)).toBeFalsy();
+
+    expect(empty.pages[4].id).toBe(p4.id);
+    expect(empty.pages[3].id).toBe(last.id);
+  });
+  //
+  test("Can clone a page and insert at index", () => {
+    const p1 = empty.add("question");
+    const p2 = empty.add("question");
+    const p3 = empty.add("question");
+    const mainTextContent = "Hello from test";
+    const p4 = empty.add("info-page");
+    p3.mainText.text = mainTextContent;
+    const p1Clone = BuilderPage.fromJson(p1.clone());
+    const beforSize = empty.size;
+    empty.insertPage(p1Clone, 2);
+    // const pages = s1.pages;
+    expect(beforSize + 1).toBe(empty.size);
+    expect(empty.pages[2]).toBe(p1Clone);
+  });
+
+  test("Will not insert a page that is already in array.", () => {
+    const p1 = empty.add("question");
+    const p2 = empty.add("question");
+    const p3 = empty.add("question");
+    const beforeSize = empty.size;
+    const result = empty.insertPage(p1, 0);
+    const pages = empty.pages;
+    expect(beforeSize).toBe(empty.size);
+    expect(result).toBe(false);
+  });
+});

package/src/page/Builder-page-collection.ts

@@ -0,0 +1,113 @@
+import { DUtil } from "@media-quest/engine";
+import { BuilderPage, BuilderPageDto } from "./Builder-page";
+import { PageID, PagePrefix, SumScoreVariableID } from "../public-api";
+import { SumScoreVariableCollection } from "../sum-score/sum-score-variable-collection";
+import { SumScoreVariable } from "../sum-score/sum-score-variable";
+
+const U = DUtil;
+export type BuilderPageType = "info-page" | "question";
+
+export class BuilderPageCollection implements Iterable<BuilderPage> {
+  private _all: Array<BuilderPage> = [];
+
+  public static create(pages: BuilderPageDto[]) {
+    const page = new BuilderPageCollection(pages);
+    page._all = pages.map((p) => BuilderPage.fromJson(p));
+    return page;
+  }
+  private constructor(initialPages: BuilderPageDto[]) {}
+
+  /** @internal - used by Schema*/
+  _init(pages: BuilderPageDto[]) {
+    this._all = pages.map(BuilderPage.fromJson);
+  }
+
+  add(type: BuilderPageType, atIndex = -1): BuilderPage {
+    const pagePrefix = PagePrefix.create();
+    const newPage = BuilderPage.create(type, pagePrefix.value);
+    if (atIndex >= 0 && atIndex < this._all.length) {
+      this._all.splice(atIndex, 0, newPage);
+    } else {
+      this._all.push(newPage);
+    }
+    return newPage;
+  }
+
+  deleteById(id: PageID) {
+    const index = this._all.findIndex((p) => p.id === id);
+    if (index !== -1) {
+      this._all.splice(index, 1);
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  private getPageById(pageId: PageID) {
+    const maybePage = this._all.find((p) => p.id === pageId);
+    return maybePage ?? false;
+  }
+  get size() {
+    return this._all.length;
+  }
+  get pages(): ReadonlyArray<BuilderPage> {
+    return [...this._all];
+  }
+  toJson(): ReadonlyArray<BuilderPageDto> {
+    return this._all.map((p) => p.toJson());
+  }
+
+  [Symbol.iterator]() {
+    const list = [...this._all];
+    return list[Symbol.iterator]();
+  }
+
+  movePage(page: BuilderPage, toIndex: number) {
+    const index = this._all.indexOf(page);
+    if (index < 0) {
+      return false;
+    }
+    const isValidIndex = U.isInRange(0, this._all.length - 1);
+    if (!isValidIndex(toIndex)) {
+      return false;
+    }
+    // console.log('Moving from :' + index + ' to: ' + toIndex);
+    this._all.splice(index, 1);
+    this._all.splice(toIndex, 0, page);
+    return true;
+  }
+
+  insertPage(page: BuilderPage, atIndex: number) {
+    const isValidIndex = U.isInRange(0, this._all.length - 1);
+    if (!isValidIndex(atIndex)) {
+      return false;
+    }
+    const exists = !!this._all.find((p) => p.id === page.id);
+    if (exists) {
+      return false;
+    }
+    this._all.splice(atIndex, 0, page);
+    return true;
+  }
+
+  addSumScoreVariable(sumScoreVariable: SumScoreVariable, pageId: PageID, weight: number) {
+    const maybePage = this.getPageById(pageId);
+    if (!maybePage) return false;
+    maybePage.sumScoreVariableSet(sumScoreVariable, weight);
+
+    // maybePage.addSumScoreVariable(maybeVariable, weight);
+    return true;
+  }
+
+  updateAllData(context: { sumScoreVariables: ReadonlyArray<SumScoreVariable> }) {
+    this._all.forEach((p) => {
+      p.sumScoreVariableUpdateData(context.sumScoreVariables);
+    });
+  }
+
+  sumScoreVariableDelete(sumScoreVariableID: SumScoreVariableID) {
+    this._all.forEach((p) => {
+      p.sumScoreVariableDelete(sumScoreVariableID);
+    });
+  }
+}

package/src/{Builder-page.spec.ts → page/Builder-page.spec.ts}

@@ -1,11 +1,10 @@
 import { BuilderPage } from "./Builder-page";
 import type { BuilderPageDto } from "./Builder-page";
-import type { BuilderQuestionDto } from "./Builder-question";
-import { BuilderQuestion } from "./Builder-question";
+import type { BuilderQuestionDto } from "../Builder-question";
 import { DUtil } from "@media-quest/engine";
-import { PagePrefix } from "./primitives/page-prefix";
-import { SchemaPrefix } from "./primitives/schema-prefix";
-import { OptionID, PageID, QuestionID } from "./primitives/ID";
+import { PagePrefix } from "../primitives/page-prefix";
+import { SchemaPrefix } from "../primitives/schema-prefix";
+import { OptionID, PageID, QuestionID } from "../primitives/ID";
 
 const U = DUtil;
 const deleteIdsFromPage = (page: BuilderPageDto) => {
@@ -24,6 +23,7 @@ const pxx = PagePrefix.fromStringOrThrow("pxx");
 const questionPageDto: BuilderPageDto = {
   _type: "question",
   autoplaySequence: [],
+  includedInSumScores: [],
   mainText: {
     text: "Velkommen til denne undersøkelsen.",
     audioFile: false,
@@ -66,7 +66,8 @@ const questionPageDto: BuilderPageDto = {
 };
 
 const multiQuestionPageDto: BuilderPageDto = {
-  _type: "multi-select",
+  _type: "question",
+  includedInSumScores: [],
   mainText: {
     text: "Velkommen til denne undersøkelsen.",
     audioFile: false,

package/src/{Builder-page.ts → page/Builder-page.ts}

@@ -1,21 +1,22 @@
-import type { BuilderQuestionDto, BuilderQuestionType } from "./Builder-question";
-import { BuilderQuestion } from "./Builder-question";
-import { BuilderObject } from "./BuilderObject";
-import type { BuilderOptionDto } from "./Builder-option";
-import { BuilderOption } from "./Builder-option";
-import type { BuilderMainVideoDto } from "./BuilderMainVideoDto";
-import type { BuilderMainImageDto } from "./BuilderMainImageDto";
-import type { BuilderMainTextDto } from "./BuilderMainText";
-import { BuilderMainText } from "./BuilderMainText";
-import { RuleVariableOption, RuleQuestionVariable } from "./rulebuilder";
+import type { BuilderQuestionDto, BuilderQuestionType } from "../Builder-question";
+import { BuilderQuestion } from "../Builder-question";
+import { BuilderObject } from "../BuilderObject";
+import type { BuilderOptionDto } from "../Builder-option";
+import { BuilderOption } from "../Builder-option";
+import type { BuilderMainVideoDto } from "../BuilderMainVideoDto";
+import type { BuilderMainImageDto } from "../BuilderMainImageDto";
+import type { BuilderMainTextDto } from "../BuilderMainText";
+import { BuilderMainText } from "../BuilderMainText";
+import { RuleVariableOption, RuleQuestionVariable } from "../rulebuilder";
 import { DUtil } from "@media-quest/engine";
-import { PagePrefix, PagePrefixValue } from "./primitives/page-prefix";
-import { VarID } from "./primitives/varID";
-import { SchemaPrefix } from "./primitives/schema-prefix";
-import { PageID } from "./primitives/ID";
+import { PagePrefix, PagePrefixValue } from "../primitives/page-prefix";
+import { VarID } from "../primitives/varID";
+import { SchemaPrefix } from "../primitives/schema-prefix";
+import { PageID, SumScoreVariableID } from "../primitives/ID";
+import { SumScoreVariable } from "../sum-score/sum-score-variable";
 
 const U = DUtil;
-export type BuilderPageType = "info-page" | "question" | "multi-select" | "form";
+export type BuilderPageType = "info-page" | "question";
 
 export interface BuilderPageDto {
   readonly id: PageID;
@@ -25,6 +26,7 @@ export interface BuilderPageDto {
   nextButton: BuilderOptionDto;
   defaultQuestion: BuilderQuestionDto;
   mainMedia?: BuilderMainImageDto | BuilderMainVideoDto;
+  includedInSumScores: Array<{ sumScoreVariableId: SumScoreVariableID; weight: number }>;
   autoplaySequence: Array<string>;
   tags: ReadonlyArray<string>;
 }
@@ -36,6 +38,16 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
   private _prefix: PagePrefix;
   private readonly _tags: Set<string>;
   private _backgroundColor = "#FFFFFF";
+  private _includedInSumScores: Map<
+    SumScoreVariableID,
+    {
+      sumScoreVariableId: SumScoreVariableID;
+      weight: number;
+      name: string;
+      description: string;
+    }
+  > = new Map();
+
   mainMedia: BuilderMainVideoDto | BuilderMainImageDto | false = false;
   defaultQuestion: BuilderQuestion;
   mainText: BuilderMainText;
@@ -60,7 +72,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
       nextButton: nextButtonDto,
       mainText: mainTextDto,
       prefix: _prefix,
-      // questions: [],
+      includedInSumScores: [],
       tags: [],
     };
 
@@ -82,6 +94,15 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     this.nextButton = BuilderOption.fromJson(dto.nextButton);
     this.defaultQuestion = BuilderQuestion.fromJson(dto.defaultQuestion);
     const tagList: string[] = Array.isArray(dto.tags) ? dto.tags : [];
+    const sumScores = Array.isArray(dto.includedInSumScores) ? dto.includedInSumScores : [];
+    sumScores.forEach((item) => {
+      this._includedInSumScores.set(item.sumScoreVariableId, {
+        sumScoreVariableId: item.sumScoreVariableId,
+        weight: item.weight,
+        name: "",
+        description: "",
+      });
+    });
     this._tags = new Set(tagList);
     if (dto.mainMedia) {
       this.mainMedia = dto.mainMedia;
@@ -99,6 +120,10 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     this._pageType = value;
   }
 
+  get includedInSumScores() {
+    return [...this._includedInSumScores.values()];
+  }
+
   getQuestionVariables(
     modulePrefix: SchemaPrefix,
     pageNumber: number,
@@ -135,10 +160,36 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     this._prefix.value = value;
   }
 
+  sumScoreVariableSet(sumScoreVariable: SumScoreVariable, weight: number) {
+    const { id, name, description } = sumScoreVariable;
+
+    this._includedInSumScores.set(sumScoreVariable.id, {
+      sumScoreVariableId: id,
+      weight,
+      name,
+      description,
+    });
+
+    return true;
+  }
+
+  sumScoreVariableUpdateData(variables: ReadonlyArray<SumScoreVariable>) {
+    variables.forEach((v) => {
+      const sumScoreEntry = this._includedInSumScores.get(v.id);
+      if (sumScoreEntry) {
+        this.sumScoreVariableSet(v, sumScoreEntry.weight);
+      }
+    });
+  }
+
   toJson(): BuilderPageDto {
     const mainText = this.mainText.toJson();
     const nextButton = this.nextButton.toJson();
     const mainMedia = this.mainMedia;
+    const includedInSumScores = this.includedInSumScores.map(({ sumScoreVariableId, weight }) => ({
+      sumScoreVariableId,
+      weight,
+    }));
     const dto: BuilderPageDto = {
       _type: this.pageType,
       mainText,
@@ -146,6 +197,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
       nextButton,
       id: this.id,
       tags: [...this.tags],
+      includedInSumScores,
       prefix: this._prefix.value,
       defaultQuestion: this.defaultQuestion.toJson(),
     };
@@ -179,4 +231,8 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
       this._backgroundColor = color;
     }
   }
+
+  sumScoreVariableDelete(sumScoreVariableID: SumScoreVariableID) {
+    this._includedInSumScores.delete(sumScoreVariableID);
+  }
 }