@media-quest/builder 0.0.27 → 0.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@media-quest/builder",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "Builder library for Media-quest schemas",
   "main": "dist/public-api.js",
   "types": "dist/public-api.d.js",
@@ -24,6 +24,6 @@
     "dts": true
   },
   "peerDependencies": {
-    "@media-quest/engine": "0.0.27"
+    "@media-quest/engine": "0.0.28"
   }
 }

package/src/Builder-schema.ts

@@ -98,6 +98,8 @@ export class BuilderSchema {
     const rulesDto = dto.rules ?? [];
     const ruleInput = schema.getRuleInput();
     schema._rules = rulesDto.map((r) => BuilderRule.fromDto(r, ruleInput));
+
+    schema.updateSumScoreRelations();
     return schema;
   }
 
@@ -145,16 +147,27 @@ export class BuilderSchema {
     return variable;
   }
   sumScoreVariableAddToPage(sumScoreVariable: SumScoreVariable, page: BuilderPage, weight: number) {
-    // this._pages.
-    return this._pageCollection.addSumScoreVariable(sumScoreVariable, page.id, weight);
+    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._pageCollection.updateAllData({ sumScoreVariables: this._sumScoreCollection.asArray() });
+    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);
   }
@@ -286,7 +299,7 @@ export class BuilderSchema {
   sumScoreVariableDelete(id: SumScoreVariableID) {
     const didDelete = this._sumScoreCollection._deleteVariable(id);
     const sumScoreVariables = [...this._sumScoreCollection];
-    this._pageCollection.updateAllData({ sumScoreVariables });
+    this._pageCollection.updateRelationShips({ sumScoreVariables });
     this._pageCollection.sumScoreVariableDelete(id);
     return didDelete;
   }

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

@@ -206,4 +206,14 @@ describe("Builder page collection", () => {
     expect(beforeSize).toBe(empty.size);
     expect(result).toBe(false);
   });
+  test("Will always update the page-number on every page.", () => {
+    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

@@ -99,9 +99,18 @@ export class BuilderPageCollection implements Iterable<BuilderPage> {
     return true;
   }
 
-  updateAllData(context: { sumScoreVariables: ReadonlyArray<SumScoreVariable> }) {
+  updateRelationShips(context: { sumScoreVariables: ReadonlyArray<SumScoreVariable> }) {
+    const { sumScoreVariables } = context;
+
+    // Update all relationships in pages.
     this._all.forEach((p) => {
-      p.sumScoreVariableUpdateData(context.sumScoreVariables);
+      p.updateRelationShips(context.sumScoreVariables);
+    });
+
+    // Set the used in pages array on every variable.
+    sumScoreVariables.forEach((v) => {
+      const usedInPages = this._all.filter((p) => p._isIncludedInSumScore(v.id));
+      v._setUsedInPages(usedInPages);
     });
   }
 
@@ -110,4 +119,11 @@ export class BuilderPageCollection implements Iterable<BuilderPage> {
       p.sumScoreVariableDelete(sumScoreVariableID);
     });
   }
+
+  sumScoreVariableDeleteFromPage(pageId: PageID, sumScoreVariableId: SumScoreVariableID) {
+    const maybePage = this.getPageById(pageId);
+    if (!maybePage) return false;
+    maybePage.sumScoreVariableDelete(sumScoreVariableId);
+    return true;
+  }
 }

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

@@ -4,7 +4,8 @@ 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 { OptionID, PageID, QuestionID, SumScoreVariableID } from "../primitives/ID";
+import { SumScoreVariable } from "../sum-score/sum-score-variable";
 
 const U = DUtil;
 const deleteIdsFromPage = (page: BuilderPageDto) => {
@@ -160,4 +161,17 @@ describe("Builder Page", () => {
     // expect(page1.questions.length).toBe(3);
     // expect(m1).toBe(false);
   });
+  test("Can check if page is included in sum-score-variable", () => {
+    const prefix = PagePrefix.fromStringOrThrow("as1");
+    const page = BuilderPage.create("question", prefix);
+    const ss1 = SumScoreVariable.create({ name: "ss1", description: "ss1_desc", useAvg: true });
+    const ss2 = SumScoreVariable.create({ name: "ss1", description: "ss1_desc", useAvg: true });
+    const success1 = page.sumScoreVariableSet(ss1, 1);
+    const success2 = page.sumScoreVariableSet(ss2, 1);
+    expect(success1).toBe(true);
+    expect(success2).toBe(true);
+    expect(page._isIncludedInSumScore(ss1.id)).toBe(true);
+    expect(page._isIncludedInSumScore(ss2.id)).toBe(true);
+    expect(page._isIncludedInSumScore(SumScoreVariableID.dummy.a)).toBe(false);
+  });
 });

package/src/page/Builder-page.ts

@@ -160,6 +160,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     this._prefix.value = value;
   }
 
+  /** @internal */
   sumScoreVariableSet(sumScoreVariable: SumScoreVariable, weight: number) {
     const { id, name, description } = sumScoreVariable;
 
@@ -173,7 +174,8 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     return true;
   }
 
-  sumScoreVariableUpdateData(variables: ReadonlyArray<SumScoreVariable>) {
+  /** @internal */
+  updateRelationShips(variables: ReadonlyArray<SumScoreVariable>) {
     variables.forEach((v) => {
       const sumScoreEntry = this._includedInSumScores.get(v.id);
       if (sumScoreEntry) {
@@ -232,6 +234,16 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     }
   }
 
+  /**
+   * @internal
+   */
+  _isIncludedInSumScore(sumScoreId: SumScoreVariableID) {
+    return this._includedInSumScores.has(sumScoreId);
+  }
+
+  /**
+   * @internal
+   */
   sumScoreVariableDelete(sumScoreVariableID: SumScoreVariableID) {
     this._includedInSumScores.delete(sumScoreVariableID);
   }

package/src/public-api.ts

@@ -23,6 +23,6 @@ export * from "./primitives/ID";
 export * from "./code-book/codebook-variable";
 export * from "./builder-compiler";
 export * from "./sum-score/sum-score";
-export { SumScoreVariableDto } from "./sum-score/sum-score-variable";
+export { SumScoreVariableDto, SumScoreVariable } from "./sum-score/sum-score-variable";
 export { SumScoreAnswer } from "./sum-score/sum-score-answer";
 export { TagCollection } from "./tag/Tag-Collection";

package/src/sum-score/sum-score-variable.spec.ts

@@ -160,6 +160,61 @@ describe("Sum score sum-score.", () => {
       basedOn.length,
     );
   });
+  test("variable will also have copy of all questions it used in.", () => {
+    const prefix = SchemaPrefix.fromValueOrThrow("dep4");
+    const schema = BuilderSchema.create(SchemaID.create(), "testing-dep4", prefix.value);
+    const p1 = schema.addPage("question");
+    const p2 = schema.addPage("question");
+    const p3 = schema.addPage("question");
+
+    // Setting question text
+    p1.mainText.text = "q1 text";
+    p2.mainText.text = "q2 text";
+    p3.mainText.text = "q3 text";
+    const v1 = schema.sumScoreVariableCreate({
+      name: "ss1",
+      description: "ss1-desc",
+      useAvg: true,
+    });
+    const v2 = schema.sumScoreVariableCreate({
+      name: "ss2",
+      description: "ss2-desc",
+      useAvg: true,
+    });
+    const v3 = schema.sumScoreVariableCreate({
+      name: "ss3",
+      description: "ss3-desc",
+      useAvg: true,
+    });
+    schema.sumScoreVariableAddToPage(v1, p1, 1);
+    schema.sumScoreVariableAddToPage(v1, p2, 1);
+    schema.sumScoreVariableAddToPage(v2, p2, 1);
+    schema.sumScoreVariableAddToPage(v3, p1, 1);
+    schema.sumScoreVariableAddToPage(v3, p2, 1);
+    schema.sumScoreVariableAddToPage(v3, p3, 1);
+
+    expect(v1.usedIn.length).toBe(2);
+    expect(v2.usedIn.length).toBe(1);
+    expect(v3.usedIn.length).toBe(3);
+    schema.sumScoreVariableDeleteFromPage(p3.id, v3.id);
+    expect(v3.usedIn.length).toBe(2);
+
+    schema.sumScoreVariableDeleteFromPage(p2.id, v3.id);
+    expect(v3.usedIn.length).toBe(1);
+
+    const json = schema.toJson();
+    const clone = BuilderSchema.fromJson(json);
+    const clonedVariables = clone.sumScoreVariables;
+    expect(clonedVariables.length).toBe(3);
+
+    const v1Clone = clonedVariables.find((v) => v.id === v1.id) as SumScoreVariable;
+    const v2Clone = clonedVariables.find((v) => v.id === v2.id) as SumScoreVariable;
+    const v3Clone = clonedVariables.find((v) => v.id === v3.id) as SumScoreVariable;
+    expect(v1Clone.usedIn.length).toBe(2);
+    expect(v2Clone.usedIn.length).toBe(1);
+    expect(v3Clone.usedIn.length).toBe(1);
+  });
+
   test("calculateAll", () => {
     const prefix = SchemaPrefix.fromValueOrThrow("angst");
     const schema = BuilderSchema.create(SchemaID.create(), "testing", prefix.value);

package/src/sum-score/sum-score-variable.ts

@@ -1,18 +1,14 @@
-import { SumScoreVariableID } from "../primitives/ID";
+import { PageID, SumScoreVariableID } from "../primitives/ID";
 import { BuilderObject } from "../BuilderObject";
 import { DUtil } from "@media-quest/engine";
+import { BuilderPage } from "../page/Builder-page";
 
 export interface SumScoreVariableDto {
   id: SumScoreVariableID;
   name: string;
   description: string;
   useAvg: boolean;
-  /**
-   * All variables that the sum-score should be based on.
-   */
-  // basedOn: Array<{ varId: string; varLabel: string; weight?: number }>;
 }
-
 export class SumScoreVariable extends BuilderObject<
   "builder-sum-score-variable",
   SumScoreVariableDto
@@ -23,7 +19,11 @@ export class SumScoreVariable extends BuilderObject<
   private _name = "";
   private _description = "";
   private _error = "";
+  private _usedIn: ReadonlyArray<BuilderPage> = [];
   // private _basedOn = new Map<pageId: Page>()
+  get usedIn() {
+    return [...this._usedIn];
+  }
 
   // private _basedOn: Array<{ varId: string }> = [];
   public static readonly create = (data: {
@@ -85,6 +85,10 @@ export class SumScoreVariable extends BuilderObject<
   _setError(error: "" | "Duplicate name") {
     this._error = error;
   }
+  /** @internal - used by sum-score-variable-collection */
+  _setUsedInPages(pages: BuilderPage[]) {
+    this._usedIn = [...pages];
+  }
 
   get name() {
     return this._name;