@media-quest/builder 0.0.26 → 0.0.28

package/src/Builder-schema.spec.ts

@@ -1,8 +1,8 @@
 import type { BuilderSchemaDto } from "./Builder-schema";
 import { BuilderSchema } from "./Builder-schema";
-import { BuilderPage } from "./Builder-page";
-import type { BuilderTagDto } from "./BuilderTag";
-import { BuilderTag } from "./BuilderTag";
+import { BuilderPage } from "./page/Builder-page";
+import type { BuilderTagDto } from "./tag/BuilderTag";
+import { BuilderTag } from "./tag/BuilderTag";
 import { PagePrefix } from "./primitives/page-prefix";
 import { SchemaPrefix } from "./primitives/schema-prefix";
 
@@ -28,13 +28,14 @@ const schemaDto1: BuilderSchemaDto = {
       name: "label for dummy sum-score",
       description: "testId",
       useAvg: false,
-      basedOn: [],
+      // basedOn: [],
     },
   ],
   pages: [
     {
       id: PageID.validateOrCreate("a".repeat(24)),
       _type: "info-page",
+      includedInSumScores: [],
       prefix: PagePrefix.fromStringOrThrow("p1"),
       mainText: {
         text: "hello from test",
@@ -81,9 +82,10 @@ const schemaDto1: BuilderSchemaDto = {
     },
     {
       id: PageID.dummy.b,
-      _type: "multi-select",
+      _type: "question",
       prefix: PagePrefix.fromStringOrThrow("page2-prefix"),
       tags: [tag3.tag],
+      includedInSumScores: [],
       mainText: {
         text: "hello from test",
         autoplay: false,
@@ -180,30 +182,29 @@ describe("Builder schema", () => {
   });
 
   test("Can add page at concrete index", () => {
-    const p1 = s1.addPage("form");
-    expect(p1.pageType).toBe("form");
-    const p2 = s1.addPage("multi-select", 0);
-    expect(p2.pageType).toBe("multi-select");
-    const pages = s1.pages;
-    expect(pages[0].id).toBe(p2.id);
-    s1.addPage("form");
-    s1.addPage("form");
-    const last = s1.addPage("form");
+    const p1 = s1.addPage("question");
+    expect(p1.pageType).toBe("question");
+    const p2 = s1.addPage("info-page", 0);
+    expect(p2.pageType).toBe("info-page");
+    // const pages = s1.pages;
+    expect(s1.pages[0].id).toBe(p2.id);
+    s1.addPage("question");
+    s1.addPage("question");
+    const last = s1.addPage("question");
     expect(s1.pages[s1.pages.length - 1]).toBe(last);
     const p3 = s1.addPage("info-page", 4);
-    expect(pages[4].id).toBe(p3.id);
+    expect(s1.pages[4].id).toBe(p3.id);
   });
 
   test("Can move page up and down", () => {
-    const p1 = s1.addPage("form");
-    const p2 = s1.addPage("form");
-    const p3 = s1.addPage("form");
-    const p4 = s1.addPage("multi-select");
-    const last = s1.addPage("form");
-    const pages = s1.pages;
+    const p1 = s1.addPage("question");
+    const p2 = s1.addPage("question");
+    const p3 = s1.addPage("question");
+    const p4 = s1.addPage("info-page");
+    const last = s1.addPage("question");
     s1.movePage(p2, 0);
-    expect(pages[0]).toBe(p2);
-    expect(pages[1]).toBe(p1);
+    expect(s1.pages[0]).toBe(p2);
+    expect(s1.pages[1]).toBe(p1);
     expect(s1.movePage(p4, 4)).toBeTruthy();
     expect(s1.movePage(p4, 5)).toBeFalsy();
     expect(s1.movePage(p4, 10)).toBeFalsy();
@@ -212,11 +213,11 @@ describe("Builder schema", () => {
   });
 
   test("Can clone a page and insert at index", () => {
-    const p1 = s1.addPage("form");
-    const p2 = s1.addPage("form");
-    const p3 = s1.addPage("form");
+    const p1 = s1.addPage("question");
+    const p2 = s1.addPage("question");
+    const p3 = s1.addPage("question");
     const mainTextContent = "Hello from test";
-    const p4 = s1.addPage("multi-select");
+    const p4 = s1.addPage("info-page");
     p3.mainText.text = mainTextContent;
     const p1Clone = BuilderPage.fromJson(p1.clone());
     const beforeLen = s1.pages.length;
@@ -227,9 +228,9 @@ describe("Builder schema", () => {
   });
 
   test("Will not insert a page that is already in array.", () => {
-    const p1 = s1.addPage("form");
-    const p2 = s1.addPage("form");
-    const p3 = s1.addPage("form");
+    const p1 = s1.addPage("question");
+    const p2 = s1.addPage("question");
+    const p3 = s1.addPage("question");
     const beforeLen = s1.pages.length;
     const result = s1.insertPage(p1, 0);
     const pages = s1.pages;
@@ -292,38 +293,56 @@ describe("Builder schema", () => {
     });
   });
 
-  test("Can add sum-variables, but not twice", () => {
-    // p0.prefix = "info_page_prefix_";
-    const p1 = s1.addPage("question");
-    const p2 = s1.addPage("question");
-    p1.prefix = PagePrefix.fromStringOrThrow("p1_prefix");
-    p2.prefix = PagePrefix.fromStringOrThrow("p2_prefix");
-
-    const ss1: SumScoreVariableDto = {
-      id: SumScoreVariableID.dummy.a,
-      name: "ss1",
-      description: "",
-      useAvg: false,
-      basedOn: [],
-    };
+  test("Can add, update and delete sum-variable", () => {
+    const ssv = (name: string) =>
+      s1.sumScoreVariableCreate({ name, useAvg: true, description: "description for " + name });
 
-    s1.addSumScoreVariable(ss1);
-    s1.addSumScoreVariable(ss1);
+    const v1 = ssv("v1");
+    const v2 = ssv("v2");
+    const v3 = ssv("v3");
+    expect(s1.sumScoreVariables.length).toBe(3);
+    s1.sumScoreVariableUpdate(v1.id, { name: "updatedName" });
+    expect(s1.sumScoreVariables[0].name).toBe("updatedName");
+    const success = s1.sumScoreVariableDelete(v2.id);
+    expect(success).toBeTruthy();
+    expect(s1.sumScoreVariables.length).toBe(2);
+    const failure = s1.sumScoreVariableDelete(SumScoreVariableID.create());
+    expect(failure).toBeFalsy();
+    // s1.sumScoreVariableDelete(v2.id);
+  });
 
-    // expect(s1.sumScoreVariables.length).toBe(1);
+  test("When a sum-score updates, then the pages update as well", () => {
+    const p1 = s1.addPage("question");
+    const v1 = s1.sumScoreVariableCreate({
+      name: "v1",
+      useAvg: true,
+      description: "description for v1",
+    });
+    expect(s1.sumScoreVariables.length).toBe(1);
+    expect(s1.pages.length).toBe(1);
+    const success = s1.sumScoreVariableAddToPage(v1, p1, 1);
+    expect(success).toBe(true);
+    expect(p1.includedInSumScores.length).toBe(1);
+    const updateSuccess = s1.sumScoreVariableUpdate(v1.id, {
+      name: "updated_name",
+      description: "updated_description",
+      useAvg: !v1.useAvg,
+    });
+    expect(updateSuccess).toBe(true);
+    expect(p1.includedInSumScores[0].name).toBe("updated_name");
+    expect(p1.includedInSumScores[0].description).toBe("updated_description");
+  });
 
-    // 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);
-    // });
+  test("When a sum-score is deleted, then pages will delete from included in sum-scores.", () => {
+    const p1 = s1.addPage("question");
+    const v1 = s1.sumScoreVariableCreate({
+      name: "v1",
+      useAvg: true,
+      description: "description for v1",
+    });
+    const success = s1.sumScoreVariableAddToPage(v1, p1, 1);
+    expect(success).toBe(true);
+    s1.sumScoreVariableDelete(v1.id);
+    expect(p1.includedInSumScores.length).toBe(0);
   });
 });

package/src/Builder-schema.ts

@@ -1,5 +1,5 @@
-import type { BuilderPageDto, BuilderPageType } from "./Builder-page";
-import { BuilderPage } from "./Builder-page";
+import type { BuilderPageDto, BuilderPageType } from "./page/Builder-page";
+import { BuilderPage } from "./page/Builder-page";
 import type {
   BuilderRuleDto,
   ExcludeByPageAction,
@@ -9,8 +9,8 @@ import type {
 } from "./rulebuilder";
 import { BuilderRule, RuleInput } from "./rulebuilder";
 import type { RuleQuestionVariable } from "./rulebuilder/RuleVariable";
-import type { BuilderTagDto } from "./BuilderTag";
-import { BuilderTag, TagCollection } from "./BuilderTag";
+import type { BuilderTagDto } from "./tag/BuilderTag";
+import { BuilderTag } from "./tag/BuilderTag";
 import { DefaultThemeCompiler } from "./theme/default-theme-compiler";
 import { ImageFile } from "./media-files";
 import { DUtil } from "@media-quest/engine";
@@ -21,9 +21,11 @@ import { CodebookPredefinedVariable } from "./code-book/codebook-variable";
 import { SchemaConfig } from "./schema-config";
 import { CompilerOption, CompilerOutput } from "./builder-compiler";
 
-import { SumScoreVariableDto } from "./sum-score/sum-score-variable";
-import { SchemaID } from "./primitives/ID";
-import { SumScoreMembershipDto } from "./sum-score/sum-score-membership";
+import { SumScoreVariable, SumScoreVariableDto } from "./sum-score/sum-score-variable";
+import { PageID, SchemaID, SumScoreVariableID } from "./primitives/ID";
+import { SumScoreVariableCollection } from "./sum-score/sum-score-variable-collection";
+import { TagCollection } from "./tag/Tag-Collection";
+import { BuilderPageCollection } from "./page/Builder-page-collection";
 
 const U = DUtil;
 
@@ -33,35 +35,34 @@ export interface BuilderSchemaDto {
   readonly mainImage: ImageFile | false;
   readonly backgroundColor: string;
   readonly name: string;
-  readonly pages: BuilderPageDto[];
+  readonly pages: ReadonlyArray<BuilderPageDto>;
   readonly baseHeight: number;
   readonly baseWidth: number;
   readonly predefinedVariables?: Array<CodebookPredefinedVariable>;
   readonly sumScoreVariables?: ReadonlyArray<SumScoreVariableDto>;
-  readonly sumScoreMemberShips?: ReadonlyArray<SumScoreMembershipDto>;
   readonly rules: ReadonlyArray<BuilderRuleDto>;
   readonly tags: ReadonlyArray<BuilderTagDto>;
 }
 
-class SumScoreVariableCollection {
-  private _all: Array<SumScoreVariableDto> = [];
-}
-
 export class BuilderSchema {
   readonly prefix: SchemaPrefix;
   baseHeight = 1300;
   baseWidth = 1024;
   backgroundColor = "#000000";
-  pages: BuilderPage[] = [];
+  private readonly _pageCollection: BuilderPageCollection;
   mainImage: ImageFile | false = false;
   predefinedVariables: CodebookPredefinedVariable[] = [];
   private _rules: BuilderRule[] = [];
-  private _sumVariables: SumScoreVariableDto[] = [];
+  private readonly _sumScoreCollection;
   get rules(): ReadonlyArray<BuilderRule> {
     return [...this._rules];
   }
-  get sumScoreVariables(): ReadonlyArray<SumScoreVariableDto> {
-    return [...this._sumVariables];
+  get pages(): ReadonlyArray<BuilderPage> {
+    return [...this._pageCollection];
+  }
+
+  get sumScoreVariables(): ReadonlyArray<SumScoreVariable> {
+    return [...this._sumScoreCollection];
   }
 
   // get prefix(): SchemaPrefixValue {
@@ -80,29 +81,33 @@ export class BuilderSchema {
   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);
+    const sumScoreVariables = dto.sumScoreVariables ? [...dto.sumScoreVariables] : [];
+    const pagesDto = Array.isArray(dto.pages) ? dto.pages : [];
 
+    // Init collections.
     schema._tagCollection.init(dto.tags);
+    schema._sumScoreCollection.init(sumScoreVariables);
+
     schema.backgroundColor = dto.backgroundColor;
     schema.baseHeight = dto.baseHeight;
     schema.baseWidth = dto.baseWidth;
-    schema.pages = pages;
+    schema._pageCollection._init(pagesDto);
     schema.predefinedVariables = dto.predefinedVariables ?? [];
     schema.backgroundColor = dto.backgroundColor;
     schema.mainImage = dto.mainImage ?? false;
     const rulesDto = dto.rules ?? [];
     const ruleInput = schema.getRuleInput();
-
-    schema._sumVariables = Array.isArray(dto.sumScoreVariables) ? [...dto.sumScoreVariables] : [];
     schema._rules = rulesDto.map((r) => BuilderRule.fromDto(r, ruleInput));
+
+    schema.updateSumScoreRelations();
     return schema;
   }
 
   toJson(): BuilderSchemaDto {
-    const pages = this.pages.map((p) => p.toJson());
+    const pages = this._pageCollection.toJson();
     const tags = this._tagCollection.toJson();
     const rules = this._rules.map((rule) => rule.toJson());
-
+    const sumScoreVariables = this._sumScoreCollection.toJson();
     const dto: BuilderSchemaDto = {
       backgroundColor: this.backgroundColor,
       baseHeight: this.baseHeight,
@@ -113,7 +118,7 @@ export class BuilderSchema {
       rules,
       tags,
       predefinedVariables: this.predefinedVariables,
-      sumScoreVariables: [...this.sumScoreVariables],
+      sumScoreVariables,
       mainImage: this.mainImage,
       prefix: this.prefix.value,
     };
@@ -125,41 +130,50 @@ export class BuilderSchema {
     prefix: SchemaPrefix,
   ) {
     this.prefix = prefix;
+    this._sumScoreCollection = SumScoreVariableCollection.create([]);
+    this._pageCollection = BuilderPageCollection.create([]);
+    // this
   }
 
   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;
+    return this._pageCollection.add(type, atIndex);
   }
 
-  addSumScoreVariable(variable: SumScoreVariableDto) {
+  sumScoreVariableCreate(options: { name: string; description: string; useAvg: boolean }) {
     // TODO VALIDATE.
-    this._sumVariables.push({ ...variable });
+    // this._sumVariables.push({ ...variable });
+    const variable = this._sumScoreCollection.addNew(options);
 
     return variable;
   }
+  sumScoreVariableAddToPage(sumScoreVariable: SumScoreVariable, page: BuilderPage, weight: number) {
+    const added = this._pageCollection.addSumScoreVariable(sumScoreVariable, page.id, weight);
+    this.updateSumScoreRelations();
+    return added;
+  }
+
+  private updateSumScoreRelations() {
+    const sumScoreVariables = this._sumScoreCollection.asArray();
+    this._pageCollection.updateRelationShips({ sumScoreVariables });
+  }
+
+  sumScoreVariableUpdate(id: SumScoreVariableID, data: Partial<SumScoreVariableDto>) {
+    const didUpdate = this._sumScoreCollection._updateOne(id, data);
+    this.updateSumScoreRelations();
+    return didUpdate;
+  }
+
+  sumScoreVariableDeleteFromPage(pageId: PageID, sumScoreVariableId: SumScoreVariableID) {
+    this._pageCollection.sumScoreVariableDeleteFromPage(pageId, sumScoreVariableId);
+    this.updateSumScoreRelations();
+  }
 
   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;
+    return this._pageCollection.insertPage(page, atIndex);
   }
 
   addRule() {
@@ -185,25 +199,11 @@ export class BuilderSchema {
   }
 
   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;
+    return this._pageCollection.movePage(page, toIndex);
   }
 
   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;
+    return this._pageCollection.deleteById(page.id);
   }
 
   reevaluateRules() {
@@ -219,7 +219,7 @@ export class BuilderSchema {
     const pageIdActions: ExcludeByPageAction[] = [];
     const tagActions: ExcludeByTagAction[] = this.tags.map((t) => {
       const tag = t.tagText;
-      const pageCount = this.pages.reduce((count, curr) => {
+      const pageCount = this._pageCollection.pages.reduce((count, curr) => {
         return curr.tags.includes(tag) ? count + 1 : count;
       }, 0);
       const excludeByTagDto: ExcludeByTagAction = {
@@ -230,8 +230,10 @@ export class BuilderSchema {
       };
       return excludeByTagDto;
     });
+
     const jumpActions: JumpToPageAction[] = [];
-    this.pages.forEach((page, index) => {
+
+    this._pageCollection.pages.forEach((page, index) => {
       const pageVariables = page.getQuestionVariables(this.prefix, index);
       qVars.push(...pageVariables);
       const mainText = page.mainText.text;
@@ -273,7 +275,7 @@ export class BuilderSchema {
     const builderSchema = BuilderSchema.fromJson(this.toJson());
 
     // Overriding the
-    builderSchema.pages.forEach((p) => {
+    builderSchema._pageCollection.pages.forEach((p) => {
       if (options.blockAutoplayQuestion) {
         p.mainText.autoplay = false;
       }
@@ -293,4 +295,12 @@ export class BuilderSchema {
     const output: CompilerOutput = { codebook, schema, schemaConfig };
     return output;
   }
+
+  sumScoreVariableDelete(id: SumScoreVariableID) {
+    const didDelete = this._sumScoreCollection._deleteVariable(id);
+    const sumScoreVariables = [...this._sumScoreCollection];
+    this._pageCollection.updateRelationShips({ sumScoreVariables });
+    this._pageCollection.sumScoreVariableDelete(id);
+    return didDelete;
+  }
 }

package/src/code-book/codebook-variable.ts

@@ -1,29 +1,27 @@
-import { PageID } from "../primitives/ID";
-
-/**
- * Interface representing a code book question sum-score.
- *
- * @interface
- */
-export interface CodeBookQuestionVariable {
-  readonly kind: "codebook-question-variable";
-  readonly label: string;
-  readonly varId: string;
-  readonly pageId: PageID;
-  readonly pagePrefix: string;
-  readonly modulePrefix: string;
-  /**
-   * Show the position of the question on page (a, b, c, d, ...)
-   */
-  readonly questionPrefix: string;
-  readonly pagePosition: number;
-  readonly options: ReadonlyArray<{ label: string; value: number }>;
-}
-
-export interface CodebookPredefinedVariable {
-  readonly kind: "codebook-predefined-variable";
-  readonly modulePrefix: string;
-  readonly moduleID: string;
-  defaultValue: number;
-  options: Array<{ label: string; value: number }>;
-}
+import { PageID } from "../primitives/ID";
+import { SumScoreVariableDto } from "../sum-score/sum-score-variable";
+
+/**
+ * Interface representing a code book question sum-score.
+ *
+ * @interface
+ */
+export interface CodeBookQuestionVariable {
+  readonly kind: "codebook-question-variable";
+  readonly label: string;
+  readonly varId: string;
+  readonly pageId: PageID;
+  readonly pagePrefix: string;
+  readonly modulePrefix: string;
+  readonly pagePosition: number;
+  readonly options: ReadonlyArray<{ label: string; value: number }>;
+  readonly includedInSumScores: ReadonlyArray<SumScoreVariableDto>;
+}
+
+export interface CodebookPredefinedVariable {
+  readonly kind: "codebook-predefined-variable";
+  readonly modulePrefix: string;
+  readonly moduleID: string;
+  defaultValue: number;
+  options: Array<{ label: string; value: number }>;
+}