@media-quest/builder 0.0.25 → 0.0.26

package/src/Builder-question.ts

@@ -1,102 +1,102 @@
-import type { BuilderOptionDto } from "./Builder-option";
-import { BuilderOption } from "./Builder-option";
-import { BuilderObject } from "./BuilderObject";
-import { QuestionID } from "./primitives/ID";
-
-export type BuilderQuestionType =
-  | "select-one"
-  | "select-many"
-  | "text"
-  | "color"
-  | "radio"
-  | "email"
-  | "time"
-  | "checkbox"
-  | "textarea"
-  | "date"
-  | "numeric-range"
-  | "duration";
-
-export interface BuilderQuestionDto {
-  readonly id: QuestionID;
-  _type: BuilderQuestionType;
-  text: string;
-  options: ReadonlyArray<BuilderOptionDto>;
-  prefix: string;
-}
-
-export class BuilderQuestion extends BuilderObject<"builder-question", BuilderQuestionDto> {
-  readonly objectType = "builder-question";
-  id: QuestionID;
-  type: BuilderQuestionType;
-  questionText = "";
-  options: BuilderOption[] = [];
-  prefix = "";
-
-  static create = (type: BuilderQuestionType) => {
-    const id = QuestionID.create();
-
-    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 = QuestionID.validateOrCreate(dto.id);
-    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 = QuestionID.create();
-    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 } from "./BuilderObject";
+import { QuestionID } from "./primitives/ID";
+
+export type BuilderQuestionType =
+  | "select-one"
+  | "select-many"
+  | "text"
+  | "color"
+  | "radio"
+  | "email"
+  | "time"
+  | "checkbox"
+  | "textarea"
+  | "date"
+  | "numeric-range"
+  | "duration";
+
+export interface BuilderQuestionDto {
+  readonly id: QuestionID;
+  _type: BuilderQuestionType;
+  text: string;
+  options: ReadonlyArray<BuilderOptionDto>;
+  prefix: string;
+}
+
+export class BuilderQuestion extends BuilderObject<"builder-question", BuilderQuestionDto> {
+  readonly objectType = "builder-question";
+  id: QuestionID;
+  type: BuilderQuestionType;
+  questionText = "";
+  options: BuilderOption[] = [];
+  prefix = "";
+
+  static create = (type: BuilderQuestionType) => {
+    const id = QuestionID.create();
+
+    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 = QuestionID.validateOrCreate(dto.id);
+    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 = QuestionID.create();
+    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

@@ -6,8 +6,8 @@ import { BuilderTag } from "./BuilderTag";
 import { PagePrefix } from "./primitives/page-prefix";
 import { SchemaPrefix } from "./primitives/schema-prefix";
 
-import { SumScoreVariableDto } from "./variable/sum-score-variable";
-import { OptionID, PageID, QuestionID, SchemaID } from "./primitives/ID";
+import { SumScoreVariableDto } from "./sum-score/sum-score-variable";
+import { OptionID, PageID, QuestionID, SchemaID, SumScoreVariableID } from "./primitives/ID";
 
 const tag1: BuilderTagDto = BuilderTag.create("tag1", "This tag is defined in schemaDto1").toJson();
 
@@ -24,11 +24,10 @@ const schemaDto1: BuilderSchemaDto = {
   tags: [tag1, tag2, tag3],
   sumScoreVariables: [
     {
-      kind: "numeric-variable",
-      origin: "sum-score",
-      label: "label for dummy variable",
-      initialValue: 0,
-      varId: "testId",
+      id: SumScoreVariableID.dummy.a,
+      name: "label for dummy sum-score",
+      description: "testId",
+      useAvg: false,
       basedOn: [],
     },
   ],
@@ -78,11 +77,10 @@ const schemaDto1: BuilderSchemaDto = {
         // { tag: 'can_read', description: 'The patient can read' },
         // { tag: 'is grown up', description: 'Is grownUp.' }
       ],
-      questions: [],
       autoplaySequence: [],
     },
     {
-      id: PageID.validateOrCreate("b".repeat(24)),
+      id: PageID.dummy.b,
       _type: "multi-select",
       prefix: PagePrefix.fromStringOrThrow("page2-prefix"),
       tags: [tag3.tag],
@@ -104,31 +102,6 @@ const schemaDto1: BuilderSchemaDto = {
         text: "q1",
         options: [],
       },
-      questions: [
-        {
-          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",
-            },
-          ],
-        },
-      ],
       autoplaySequence: [],
     },
   ],
@@ -138,41 +111,41 @@ const schemaDto1: BuilderSchemaDto = {
 };
 
 const SCHEMA_ID = SchemaID.create();
-const schemaPrefixA = SchemaPrefix.castOrCreateRandom("a").value;
-let builderSchema = BuilderSchema.create(SCHEMA_ID, "test", schemaPrefixA);
+const SCHEMA_PREFIX_A = SchemaPrefix.castOrCreateRandom("a").value;
+let s1 = BuilderSchema.create(SCHEMA_ID, "test-name", SCHEMA_PREFIX_A);
 
 beforeEach(() => {
-  builderSchema = BuilderSchema.create(SCHEMA_ID, "test-name", schemaPrefixA);
+  s1 = BuilderSchema.create(SCHEMA_ID, "test-name", SCHEMA_PREFIX_A);
 });
 
 describe("Builder schema", () => {
   test("Can add pages.", () => {
-    builderSchema.addPage("question");
-    builderSchema.addPage("info-page");
-    expect(builderSchema.pages.length).toBe(2);
-    const dto = builderSchema.compile().schema;
+    s1.addPage("question");
+    s1.addPage("info-page");
+    expect(s1.pages.length).toBe(2);
+    const dto = s1.compile().schema;
     expect(dto.pages.length).toBe(2);
-    expect(dto.id).toBe(builderSchema.id);
-    expect(dto.baseHeight).toBe(builderSchema.baseHeight);
-    expect(dto.baseWidth).toBe(builderSchema.baseWidth);
-    expect(dto.backgroundColor).toBe(builderSchema.backgroundColor);
+    expect(dto.id).toBe(s1.id);
+    expect(dto.baseHeight).toBe(s1.baseHeight);
+    expect(dto.baseWidth).toBe(s1.baseWidth);
+    expect(dto.backgroundColor).toBe(s1.backgroundColor);
   });
 
   test("Can delete page by passing reference", () => {
-    const p1 = builderSchema.addPage("question");
-    const p2 = builderSchema.addPage("question");
-    const p3 = builderSchema.addPage("info-page");
-    expect(builderSchema.pages.length).toBe(3);
-    const result = builderSchema.deletePage(p1);
-    expect(builderSchema.pages.length).toBe(2);
+    const p1 = s1.addPage("question");
+    const p2 = s1.addPage("question");
+    const p3 = s1.addPage("info-page");
+    expect(s1.pages.length).toBe(3);
+    const result = s1.deletePage(p1);
+    expect(s1.pages.length).toBe(2);
     expect(result).toBe(true);
-    const result2 = builderSchema.deletePage(p2);
+    const result2 = s1.deletePage(p2);
     expect(result2).toBe(true);
-    expect(builderSchema.pages.length).toBe(1);
-    expect(builderSchema.pages[0]).toBe(p3);
-    const result3 = builderSchema.deletePage(p2);
+    expect(s1.pages.length).toBe(1);
+    expect(s1.pages[0]).toBe(p3);
+    const result3 = s1.deletePage(p2);
     expect(result3).toBe(false);
-    const result4 = builderSchema.deletePage(p3);
+    const result4 = s1.deletePage(p3);
     expect(result4).toBe(true);
   });
 
@@ -205,73 +178,77 @@ describe("Builder schema", () => {
     const json = s.toJson();
     expect(schemaDto1).toStrictEqual(json);
   });
+
   test("Can add page at concrete index", () => {
-    const p1 = builderSchema.addPage("form");
+    const p1 = s1.addPage("form");
     expect(p1.pageType).toBe("form");
-    const p2 = builderSchema.addPage("multi-select", 0);
+    const p2 = s1.addPage("multi-select", 0);
     expect(p2.pageType).toBe("multi-select");
-    const pages = builderSchema.pages;
+    const pages = s1.pages;
     expect(pages[0].id).toBe(p2.id);
-    builderSchema.addPage("form");
-    builderSchema.addPage("form");
-    const last = builderSchema.addPage("form");
-    expect(builderSchema.pages[builderSchema.pages.length - 1]).toBe(last);
-    const p3 = builderSchema.addPage("info-page", 4);
+    s1.addPage("form");
+    s1.addPage("form");
+    const last = s1.addPage("form");
+    expect(s1.pages[s1.pages.length - 1]).toBe(last);
+    const p3 = s1.addPage("info-page", 4);
     expect(pages[4].id).toBe(p3.id);
   });
+
   test("Can move page up and down", () => {
-    const p1 = builderSchema.addPage("form");
-    const p2 = builderSchema.addPage("form");
-    const p3 = builderSchema.addPage("form");
-    const p4 = builderSchema.addPage("multi-select");
-    const last = builderSchema.addPage("form");
-    const pages = builderSchema.pages;
-    builderSchema.movePage(p2, 0);
+    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;
+    s1.movePage(p2, 0);
     expect(pages[0]).toBe(p2);
     expect(pages[1]).toBe(p1);
-    expect(builderSchema.movePage(p4, 4)).toBeTruthy();
-    expect(builderSchema.movePage(p4, 5)).toBeFalsy();
-    expect(builderSchema.movePage(p4, 10)).toBeFalsy();
+    expect(s1.movePage(p4, 4)).toBeTruthy();
+    expect(s1.movePage(p4, 5)).toBeFalsy();
+    expect(s1.movePage(p4, 10)).toBeFalsy();
 
     // expect(pages[0].id).toBe(p4.id);
   });
+
   test("Can clone a page and insert at index", () => {
-    const p1 = builderSchema.addPage("form");
-    const p2 = builderSchema.addPage("form");
-    const p3 = builderSchema.addPage("form");
+    const p1 = s1.addPage("form");
+    const p2 = s1.addPage("form");
+    const p3 = s1.addPage("form");
     const mainTextContent = "Hello from test";
-    const p4 = builderSchema.addPage("multi-select");
+    const p4 = s1.addPage("multi-select");
     p3.mainText.text = mainTextContent;
     const p1Clone = BuilderPage.fromJson(p1.clone());
-    const beforeLen = builderSchema.pages.length;
-    builderSchema.insertPage(p1Clone, 2);
-    const pages = builderSchema.pages;
+    const beforeLen = s1.pages.length;
+    s1.insertPage(p1Clone, 2);
+    const pages = s1.pages;
     expect(beforeLen + 1).toBe(pages.length);
     expect(pages[2]).toBe(p1Clone);
   });
+
   test("Will not insert a page that is already in array.", () => {
-    const p1 = builderSchema.addPage("form");
-    const p2 = builderSchema.addPage("form");
-    const p3 = builderSchema.addPage("form");
-    const beforeLen = builderSchema.pages.length;
-    const result = builderSchema.insertPage(p1, 0);
-    const pages = builderSchema.pages;
+    const p1 = s1.addPage("form");
+    const p2 = s1.addPage("form");
+    const p3 = s1.addPage("form");
+    const beforeLen = s1.pages.length;
+    const result = s1.insertPage(p1, 0);
+    const pages = s1.pages;
     expect(beforeLen).toBe(pages.length);
     expect(result).toBe(false);
   });
 
   test("Can generate a info-page", () => {
-    const p1 = builderSchema.addPage("info-page");
-    const p2 = builderSchema.addPage("question");
+    const p1 = s1.addPage("info-page");
+    const p2 = s1.addPage("question");
     p2.defaultQuestion.addOption("Ja", 1, 0);
     p2.defaultQuestion.addOption("Nei", 0);
     p1.nextButton.label = "Neste";
-    builderSchema.backgroundColor = "red";
-    builderSchema.baseHeight = 600;
-    builderSchema.baseWidth = 500;
+    s1.backgroundColor = "red";
+    s1.baseHeight = 600;
+    s1.baseWidth = 500;
     // builderSchema.prefix = "as";
-    builderSchema.name = "depressed";
-    const schema = builderSchema.compile().schema;
+    s1.name = "depressed";
+    const schema = s1.compile().schema;
     expect(schema.backgroundColor).toBe("red");
     expect(schema.baseHeight).toBe(600);
     expect(schema.baseWidth).toBe(500);
@@ -287,17 +264,17 @@ describe("Builder schema", () => {
     // expect(schemaP2.elements.length).toBe(options.length + 1);
   });
   test("Can get ruleInput!", () => {
-    const p0 = builderSchema.addPage("info-page");
+    const p0 = s1.addPage("info-page");
     // p0.prefix = "info_page_prefix_";
-    const p1 = builderSchema.addPage("question");
+    const p1 = s1.addPage("question");
     // p1.prefix = "p1_prefix_";
-    const p2 = builderSchema.addPage("question");
+    const p2 = s1.addPage("question");
     // p2.prefix = "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 ruleInput = s1.getRuleInput();
     expect(ruleInput.questionVars.length).toBe(2);
     expect(ruleInput.jumpToPageActions.length).toBe(3);
     // TODO add TAGS!!
@@ -314,31 +291,26 @@ describe("Builder schema", () => {
       expect(allPageIds.has(v.pageId)).toBe(true);
     });
   });
-  test.skip("Can add sum-variables - and save as json", () => {
+
+  test("Can add sum-variables, but not twice", () => {
     // p0.prefix = "info_page_prefix_";
-    const p1 = builderSchema.addPage("question");
-    const p2 = builderSchema.addPage("question");
+    const p1 = s1.addPage("question");
+    const p2 = s1.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: SumScoreVariableDto = {
-      label: "ss1",
-      varId: "ss1_var_id",
-      initialValue: 0,
-      kind: "numeric-variable",
-      origin: "sum-score",
+      id: SumScoreVariableID.dummy.a,
+      name: "ss1",
+      description: "",
+      useAvg: false,
       basedOn: [],
     };
 
-    builderSchema.addSumScoreVariable(ss1);
+    s1.addSumScoreVariable(ss1);
+    s1.addSumScoreVariable(ss1);
 
-    expect(ruleInput.questionVars.length).toBe(2);
-    expect(ruleInput.jumpToPageActions.length).toBe(3);
+    // expect(s1.sumScoreVariables.length).toBe(1);
 
     // TODO add TAGS!!
     // expect(ruleInput.excludeByTagActions.length).toBe(0);

package/src/Builder-schema.ts

@@ -2,13 +2,13 @@ import type { BuilderPageDto, BuilderPageType } from "./Builder-page";
 import { BuilderPage } from "./Builder-page";
 import type {
   BuilderRuleDto,
-  CustomVariable,
   ExcludeByPageAction,
   ExcludeByTagAction,
   JumpToPageAction,
+  RuleCustomVariable,
 } from "./rulebuilder";
 import { BuilderRule, RuleInput } from "./rulebuilder";
-import type { QuestionVariable } from "./rulebuilder/RuleVariable";
+import type { RuleQuestionVariable } from "./rulebuilder/RuleVariable";
 import type { BuilderTagDto } from "./BuilderTag";
 import { BuilderTag, TagCollection } from "./BuilderTag";
 import { DefaultThemeCompiler } from "./theme/default-theme-compiler";
@@ -16,13 +16,14 @@ import { ImageFile } from "./media-files";
 import { DUtil } 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/b-variable";
+import { CodeBook } from "./code-book/codebook";
+import { CodebookPredefinedVariable } from "./code-book/codebook-variable";
 import { SchemaConfig } from "./schema-config";
 import { CompilerOption, CompilerOutput } from "./builder-compiler";
 
-import { SumScoreVariableDto } from "./variable/sum-score-variable";
+import { SumScoreVariableDto } from "./sum-score/sum-score-variable";
 import { SchemaID } from "./primitives/ID";
+import { SumScoreMembershipDto } from "./sum-score/sum-score-membership";
 
 const U = DUtil;
 
@@ -35,8 +36,9 @@ export interface BuilderSchemaDto {
   readonly pages: BuilderPageDto[];
   readonly baseHeight: number;
   readonly baseWidth: number;
-  readonly predefinedVariables?: Array<PredefinedVariable>;
+  readonly predefinedVariables?: Array<CodebookPredefinedVariable>;
   readonly sumScoreVariables?: ReadonlyArray<SumScoreVariableDto>;
+  readonly sumScoreMemberShips?: ReadonlyArray<SumScoreMembershipDto>;
   readonly rules: ReadonlyArray<BuilderRuleDto>;
   readonly tags: ReadonlyArray<BuilderTagDto>;
 }
@@ -52,7 +54,7 @@ export class BuilderSchema {
   backgroundColor = "#000000";
   pages: BuilderPage[] = [];
   mainImage: ImageFile | false = false;
-  predefinedVariables: PredefinedVariable[] = [];
+  predefinedVariables: CodebookPredefinedVariable[] = [];
   private _rules: BuilderRule[] = [];
   private _sumVariables: SumScoreVariableDto[] = [];
   get rules(): ReadonlyArray<BuilderRule> {
@@ -139,6 +141,8 @@ export class BuilderSchema {
   addSumScoreVariable(variable: SumScoreVariableDto) {
     // TODO VALIDATE.
     this._sumVariables.push({ ...variable });
+
+    return variable;
   }
 
   insertPage(page: BuilderPage, atIndex: number): boolean {
@@ -210,8 +214,8 @@ export class BuilderSchema {
   }
 
   getRuleInput(): RuleInput {
-    const qVars: QuestionVariable[] = [];
-    const cVars: CustomVariable[] = [];
+    const qVars: RuleQuestionVariable[] = [];
+    const cVars: RuleCustomVariable[] = [];
     const pageIdActions: ExcludeByPageAction[] = [];
     const tagActions: ExcludeByTagAction[] = this.tags.map((t) => {
       const tag = t.tagText;

package/src/Builder-text.spec.ts

@@ -1,24 +1,24 @@
-import type { BuilderTextDto } from "./Builder-text";
-import { BuilderText } from "./Builder-text";
-import { TextID } from "./primitives/ID";
-
-const textDto: BuilderTextDto = {
-  id: "dto1" as 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 { TextID } from "./primitives/ID";
+
+const textDto: BuilderTextDto = {
+  id: "dto1" as 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);
+  });
+});