@media-quest/builder 0.0.25 → 0.0.27

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);
+  });
+});

package/src/Builder-text.ts

@@ -1,57 +1,57 @@
-import { BuilderObject } from "./BuilderObject";
-import { TextID } from "./primitives/ID";
-
-export interface BuilderTextDto {
-  readonly id: TextID;
-  text: string;
-  name: string;
-  translationRequired: boolean;
-}
-
-export class BuilderText extends BuilderObject<"builder-text", BuilderTextDto> {
-  readonly objectType = "builder-text";
-  id: TextID;
-  text = "";
-  name = "";
-  translateRequired = false;
-  // audio: {id: B}
-  private constructor(dto: BuilderTextDto) {
-    super(dto);
-    this.id = dto.id;
-    this.translateRequired = dto.translationRequired;
-    this.name = dto.name;
-    this.text = dto.text;
-  }
-
-  public static create(name: string) {
-    const id = TextID.create();
-    const dto: BuilderTextDto = {
-      id,
-      name,
-      text: "",
-      translationRequired: false,
-    };
-    const instance = new BuilderText(dto);
-    return instance;
-  }
-  public static fromJson(dto: BuilderTextDto) {
-    const instance = new BuilderText(dto);
-    return instance;
-  }
-
-  clone(): BuilderTextDto {
-    const dto = this.toJson();
-    const withNewId: BuilderTextDto = { ...dto, id: TextID.create() };
-    return withNewId;
-  }
-
-  toJson(): BuilderTextDto {
-    const dto: BuilderTextDto = {
-      id: this.id,
-      name: this.name,
-      text: this.text,
-      translationRequired: this.translateRequired,
-    };
-    return dto;
-  }
-}
+import { BuilderObject } from "./BuilderObject";
+import { TextID } from "./primitives/ID";
+
+export interface BuilderTextDto {
+  readonly id: TextID;
+  text: string;
+  name: string;
+  translationRequired: boolean;
+}
+
+export class BuilderText extends BuilderObject<"builder-text", BuilderTextDto> {
+  readonly objectType = "builder-text";
+  id: TextID;
+  text = "";
+  name = "";
+  translateRequired = false;
+  // audio: {id: B}
+  private constructor(dto: BuilderTextDto) {
+    super(dto);
+    this.id = dto.id;
+    this.translateRequired = dto.translationRequired;
+    this.name = dto.name;
+    this.text = dto.text;
+  }
+
+  public static create(name: string) {
+    const id = TextID.create();
+    const dto: BuilderTextDto = {
+      id,
+      name,
+      text: "",
+      translationRequired: false,
+    };
+    const instance = new BuilderText(dto);
+    return instance;
+  }
+  public static fromJson(dto: BuilderTextDto) {
+    const instance = new BuilderText(dto);
+    return instance;
+  }
+
+  clone(): BuilderTextDto {
+    const dto = this.toJson();
+    const withNewId: BuilderTextDto = { ...dto, id: TextID.create() };
+    return withNewId;
+  }
+
+  toJson(): BuilderTextDto {
+    const dto: BuilderTextDto = {
+      id: this.id,
+      name: this.name,
+      text: this.text,
+      translationRequired: this.translateRequired,
+    };
+    return dto;
+  }
+}

package/src/BuilderObject.ts

@@ -1,29 +1,30 @@
-/**
- * Builder objects are complex objects that are embedded inside
- * a Builder-schema, and needs to be serialized to json. Often these objects
- * are used in collections, and that is why most of them need an id.
- */
-type BuilderObjectType =
-  | "builder-page"
-  | "builder-question-option"
-  | "builder-question"
-  | "builder-main-text"
-  | "builder-text"
-  | "builder-rule"
-  | "builder-tag"
-  | "builder-sum-score-variable"
-  | "builder-condition"
-  | "builder-variable"
-  | "builder-condition-group";
-
-export abstract class BuilderObject<T extends BuilderObjectType, Dto extends {}> {
-  // abstract readonly id: string;
-  abstract readonly objectType: T;
-  abstract toJson(): Dto;
-  abstract clone(): Dto;
-  protected readonly originalDto: Dto;
-  protected constructor(dto: Dto) {
-    this.originalDto = dto;
-    // this.objectId = dto.objectId;
-  }
-}
+/**
+ * Builder objects are complex objects that are embedded inside
+ * a Builder-schema, and needs to be serialized to json. Often these objects
+ * are used in collections, and that is why most of them need an id.
+ */
+type BuilderObjectType =
+  | "builder-page"
+  | "builder-question-option"
+  | "builder-question"
+  | "builder-main-text"
+  | "builder-text"
+  | "builder-rule"
+  | "builder-tag"
+  | "builder-sum-score-variable"
+  | "builder-sum-score-membership"
+  | "builder-condition"
+  | "builder-variable"
+  | "builder-condition-group";
+
+export abstract class BuilderObject<T extends BuilderObjectType, Dto extends {}> {
+  // abstract readonly id: string;
+  abstract readonly objectType: T;
+  abstract toJson(): Dto;
+  abstract clone(): Dto;
+  protected readonly originalDto: Dto;
+  protected constructor(dto: Dto) {
+    this.originalDto = dto;
+    // this.objectId = dto.objectId;
+  }
+}

package/src/builder-compiler.ts

@@ -1,5 +1,5 @@
 import { SchemaDto } from "@media-quest/engine";
-import { Codebook } from "./codebook";
+import { Codebook } from "./code-book/codebook";
 import { SchemaConfig } from "./schema-config";
 
 export interface CompilerOutput {

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

@@ -0,0 +1,27 @@
+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 }>;
+}

package/src/code-book/codebook.ts

@@ -0,0 +1,81 @@
+import { BuilderPageDto } from "../page/Builder-page";
+import { BuilderSchemaDto } from "../Builder-schema";
+import { CodeBookQuestionVariable, CodebookPredefinedVariable } from "./codebook-variable";
+import { SumScoreVariableDto } from "../sum-score/sum-score-variable";
+
+export interface Codebook {
+  readonly predefinedVariables: ReadonlyArray<CodebookPredefinedVariable>;
+  readonly pageVariables: ReadonlyArray<CodeBookQuestionVariable>;
+}
+
+const fromPage = (
+  page: BuilderPageDto,
+  sumScoreVariables: ReadonlyArray<SumScoreVariableDto>,
+  pagePosition: number,
+  modulePrefix: string,
+): CodeBookQuestionVariable[] => {
+  const variables: CodeBookQuestionVariable[] = [];
+
+  if (page._type !== "question") {
+    // TODO Implement form field variables
+    return [];
+  }
+
+  const options: CodeBookQuestionVariable["options"] = page.defaultQuestion.options.map((o) => {
+    return { value: o.value, label: o.label };
+  });
+
+  const varId = modulePrefix + "_" + page.prefix;
+
+  const includedInSumScores = page.includedInSumScores.filter((a) => true);
+
+  const variable: CodeBookQuestionVariable = {
+    kind: "codebook-question-variable",
+    label: page.mainText.text,
+    pageId: page.id,
+    pagePrefix: page.prefix,
+    options,
+    modulePrefix,
+    pagePosition,
+    varId,
+    includedInSumScores: [],
+  };
+
+  variables.push(variable);
+
+  return variables;
+};
+
+/**
+ * Converts a list of pages into a list of question-variables
+ * @param pages
+ * @param sumScoreVariables
+ * @param modulePrefix
+ */
+const getPageVariablesFromPages = (
+  pages: ReadonlyArray<BuilderPageDto>,
+  sumScoreVariables: ReadonlyArray<SumScoreVariableDto>,
+  modulePrefix: string,
+): CodeBookQuestionVariable[] => {
+  const variables: CodeBookQuestionVariable[] = [];
+  pages.forEach((page, index) => {
+    const pageVariables = fromPage(page, sumScoreVariables, index, modulePrefix);
+    variables.push(...pageVariables);
+  });
+  return variables;
+};
+
+const fromSchema = (schema: BuilderSchemaDto): Codebook => {
+  const modulePrefix = schema.prefix;
+  const sumScoreVariables = schema.sumScoreVariables ?? [];
+  const pageVariables = getPageVariablesFromPages(schema.pages, sumScoreVariables, modulePrefix);
+  const vs = schema.predefinedVariables;
+  const predefinedVariables: CodebookPredefinedVariable[] = vs ? [...vs] : [];
+  return { pageVariables, predefinedVariables };
+};
+
+export const _CodeBook = {
+  fromSchema,
+} as const;
+
+export const CodeBook = Object.freeze(_CodeBook);

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);
+    });
+  }
+}