@media-quest/builder 0.0.25 → 0.0.26

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/BuilderTag.ts

@@ -1,96 +1,96 @@
-import { BuilderObject } from "./BuilderObject";
-import { TagID } from "./primitives/ID";
-
-export interface BuilderTagDto {
-  readonly id: TagID;
-  readonly tag: string;
-  readonly description: string;
-}
-
-export class BuilderTag extends BuilderObject<"builder-tag", BuilderTagDto> {
-  readonly objectType: "builder-tag" = "builder-tag";
-  readonly id: TagID;
-  tagText = "";
-  tagDescription = "";
-  public static readonly MAX_LENGTH = 20;
-  public static readonly MIN_LENGTH = 1;
-
-  public static readonly create = (tag: string, description: string = "") => {
-    const id = TagID.create();
-    const dto: BuilderTagDto = {
-      id,
-      tag,
-      description,
-    };
-    return new BuilderTag(dto);
-  };
-  public static readonly fromDto = (dto: BuilderTagDto) => {
-    return new BuilderTag(dto);
-  };
-  protected constructor(dto: BuilderTagDto) {
-    const id = TagID.validateOrCreate(dto.id);
-    const withId = { ...dto, id };
-    super(withId);
-    this.id = id;
-    this.tagText = dto.tag ?? "";
-    this.tagDescription = dto.description ?? "";
-  }
-  clone(): BuilderTagDto {
-    return this.toJson();
-  }
-
-  toJson(): BuilderTagDto {
-    return { tag: this.tagText, description: this.tagDescription, id: this.id };
-  }
-}
-
-export class TagCollection implements Iterable<BuilderTag> {
-  private readonly _tags = new Set<BuilderTag>();
-  public static readonly create = () => {
-    return new TagCollection([]);
-  };
-
-  [Symbol.iterator]() {
-    const list = [...this._tags];
-    return list[Symbol.iterator]();
-  }
-  private constructor(initialTags: ReadonlyArray<BuilderTag>) {
-    initialTags.forEach((tag) => {
-      this._tags.add(tag);
-    });
-  }
-
-  init(tags: ReadonlyArray<BuilderTagDto>) {
-    const dtoList: ReadonlyArray<BuilderTagDto> = Array.isArray(tags) ? tags : [];
-    const all = dtoList.map(BuilderTag.fromDto);
-    all.forEach((tag) => {
-      this._tags.add(tag);
-    });
-  }
-
-  add(tag: BuilderTag) {
-    this._tags.add(tag);
-  }
-
-  /**
-   * Delete this tag from collection;
-   * @param tag
-   */
-  delete(tag: BuilderTag) {
-    this._tags.delete(tag);
-  }
-
-  toJson(): ReadonlyArray<BuilderTagDto> {
-    const list = [...this._tags];
-    const dtoList = list.map((t) => t.toJson());
-    return dtoList;
-  }
-
-  deleteAll(tags: Iterable<BuilderTag>) {
-    const l = tags[Symbol.iterator]();
-    const asList = [...tags];
-    asList.forEach((t) => {
-      this.delete(t);
-    });
-  }
-}
+import { BuilderObject } from "./BuilderObject";
+import { TagID } from "./primitives/ID";
+
+export interface BuilderTagDto {
+  readonly id: TagID;
+  readonly tag: string;
+  readonly description: string;
+}
+
+export class BuilderTag extends BuilderObject<"builder-tag", BuilderTagDto> {
+  readonly objectType: "builder-tag" = "builder-tag";
+  readonly id: TagID;
+  tagText = "";
+  tagDescription = "";
+  public static readonly MAX_LENGTH = 20;
+  public static readonly MIN_LENGTH = 1;
+
+  public static readonly create = (tag: string, description: string = "") => {
+    const id = TagID.create();
+    const dto: BuilderTagDto = {
+      id,
+      tag,
+      description,
+    };
+    return new BuilderTag(dto);
+  };
+  public static readonly fromDto = (dto: BuilderTagDto) => {
+    return new BuilderTag(dto);
+  };
+  protected constructor(dto: BuilderTagDto) {
+    const id = TagID.validateOrCreate(dto.id);
+    const withId = { ...dto, id };
+    super(withId);
+    this.id = id;
+    this.tagText = dto.tag ?? "";
+    this.tagDescription = dto.description ?? "";
+  }
+  clone(): BuilderTagDto {
+    return this.toJson();
+  }
+
+  toJson(): BuilderTagDto {
+    return { tag: this.tagText, description: this.tagDescription, id: this.id };
+  }
+}
+
+export class TagCollection implements Iterable<BuilderTag> {
+  private readonly _tags = new Set<BuilderTag>();
+  public static readonly create = () => {
+    return new TagCollection([]);
+  };
+
+  [Symbol.iterator]() {
+    const list = [...this._tags];
+    return list[Symbol.iterator]();
+  }
+  private constructor(initialTags: ReadonlyArray<BuilderTag>) {
+    initialTags.forEach((tag) => {
+      this._tags.add(tag);
+    });
+  }
+
+  init(tags: ReadonlyArray<BuilderTagDto>) {
+    const dtoList: ReadonlyArray<BuilderTagDto> = Array.isArray(tags) ? tags : [];
+    const all = dtoList.map(BuilderTag.fromDto);
+    all.forEach((tag) => {
+      this._tags.add(tag);
+    });
+  }
+
+  add(tag: BuilderTag) {
+    this._tags.add(tag);
+  }
+
+  /**
+   * Delete this tag from collection;
+   * @param tag
+   */
+  delete(tag: BuilderTag) {
+    this._tags.delete(tag);
+  }
+
+  toJson(): ReadonlyArray<BuilderTagDto> {
+    const list = [...this._tags];
+    const dtoList = list.map((t) => t.toJson());
+    return dtoList;
+  }
+
+  deleteAll(tags: Iterable<BuilderTag>) {
+    const l = tags[Symbol.iterator]();
+    const asList = [...tags];
+    asList.forEach((t) => {
+      this.delete(t);
+    });
+  }
+}

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,29 @@
+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 }>;
+}

package/src/{codebook.ts → code-book/codebook.ts}

@@ -1,72 +1,72 @@
-import { BuilderPageDto } from "./Builder-page";
-import { BuilderSchemaDto } from "./Builder-schema";
-import { PageVariable, PredefinedVariable } from "./variable/b-variable";
-
-export interface Codebook {
-  readonly predefinedVariables: ReadonlyArray<PredefinedVariable>;
-  readonly pageVariables: ReadonlyArray<PageVariable>;
-}
-
-const fromPage = (
-  page: BuilderPageDto,
-  pagePosition: number,
-  modulePrefix: string,
-): PageVariable[] => {
-  const variables: PageVariable[] = [];
-
-  if (page._type !== "question") {
-    // TODO Implement form field variables
-    return [];
-  }
-
-  const options: PageVariable["options"] = page.defaultQuestion.options.map((o) => {
-    return { value: o.value, label: o.label };
-  });
-
-  const variable: PageVariable = {
-    kind: "numeric-variable",
-    label: page.mainText.text,
-    options,
-    modulePrefix,
-    origin: "question",
-    pageId: page.id,
-    pagePosition,
-    pagePrefix: page.prefix,
-    varId: modulePrefix + "_" + page.prefix,
-  };
-
-  variables.push(variable);
-
-  return variables;
-};
-
-/**
- * Converts a list of pages into a list of question-variables
- * @param pages
- * @param modulePrefix
- */
-const getPageVariablesFromPages = (
-  pages: BuilderPageDto[],
-  modulePrefix: string,
-): PageVariable[] => {
-  const variables: PageVariable[] = [];
-  pages.forEach((page, index) => {
-    const pageVariables = fromPage(page, index, modulePrefix);
-    variables.push(...pageVariables);
-  });
-  return variables;
-};
-
-const fromSchema = (schema: BuilderSchemaDto): Codebook => {
-  const modulePrefix = schema.prefix;
-  const pageVariables = getPageVariablesFromPages(schema.pages, modulePrefix);
-  const vs = schema.predefinedVariables;
-  const predefinedVariables: PredefinedVariable[] = vs ? [...vs] : [];
-  return { pageVariables, predefinedVariables };
-};
-
-export const _CodeBook = {
-  fromSchema,
-} as const;
-
-export const CodeBook = Object.freeze(_CodeBook);
+import { BuilderPageDto } from "../Builder-page";
+import { BuilderSchemaDto } from "../Builder-schema";
+import { CodeBookQuestionVariable, CodebookPredefinedVariable } from "./codebook-variable";
+
+export interface Codebook {
+  readonly predefinedVariables: ReadonlyArray<CodebookPredefinedVariable>;
+  readonly pageVariables: ReadonlyArray<CodeBookQuestionVariable>;
+}
+
+const fromPage = (
+  page: BuilderPageDto,
+  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 variable: CodeBookQuestionVariable = {
+    kind: "codebook-question-variable",
+    label: page.mainText.text,
+    pageId: page.id,
+    pagePrefix: page.prefix,
+    options,
+    modulePrefix,
+    pagePosition,
+    questionPrefix: "",
+    varId: modulePrefix + "_" + page.prefix,
+  };
+
+  variables.push(variable);
+
+  return variables;
+};
+
+/**
+ * Converts a list of pages into a list of question-variables
+ * @param pages
+ * @param modulePrefix
+ */
+const getPageVariablesFromPages = (
+  pages: BuilderPageDto[],
+  modulePrefix: string,
+): CodeBookQuestionVariable[] => {
+  const variables: CodeBookQuestionVariable[] = [];
+  pages.forEach((page, index) => {
+    const pageVariables = fromPage(page, index, modulePrefix);
+    variables.push(...pageVariables);
+  });
+  return variables;
+};
+
+const fromSchema = (schema: BuilderSchemaDto): Codebook => {
+  const modulePrefix = schema.prefix;
+  const pageVariables = getPageVariablesFromPages(schema.pages, 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/primitives/ID.spec.ts

@@ -1,39 +1,39 @@
-import { PageID, SchemaID } from "./ID";
-
-describe("ID Functions work", () => {
-  //Generate test for schema prefix
-  test("SCHEMA_ID isFunction works", () => {
-    const id = SchemaID.create();
-    expect(SchemaID.is(id)).toBe(true);
-    expect(SchemaID.is("")).toBe(false);
-    expect(SchemaID.is("a")).toBe(false);
-    expect(SchemaID.is("a".repeat(10))).toBe(true);
-    expect(SchemaID.is("a".repeat(9))).toBe(false);
-  });
-  test("SCHEMA_ID ensure works", () => {
-    const id = SchemaID.create();
-    expect(SchemaID.validateOrCreate(id)).toBe(id);
-    expect(SchemaID.validateOrCreate("")).not.toBe("");
-    expect(SchemaID.validateOrCreate("")).not.toBe("a");
-    expect(SchemaID.validateOrCreate("a".repeat(10))).toBe("a".repeat(10));
-    expect(SchemaID.validateOrCreate("a".repeat(9))).not.toBe("a".repeat(9));
-    expect(SchemaID.validateOrCreate("ABcdefghigKLML")).toBe("ABcdefghigKLML");
-  });
-  test("PageID isFunction works", () => {
-    const id = PageID.create();
-    expect(PageID.is(id)).toBe(true);
-    expect(PageID.is("")).toBe(false);
-    expect(PageID.is("a")).toBe(false);
-    expect(PageID.is("a".repeat(10))).toBe(true);
-    expect(PageID.is("a".repeat(9))).toBe(false);
-  });
-  test("PageID ensure works", () => {
-    const id = PageID.create();
-    expect(PageID.validateOrCreate(id)).toBe(id);
-    expect(PageID.validateOrCreate("")).not.toBe("");
-    expect(PageID.validateOrCreate("")).not.toBe("a");
-    expect(PageID.validateOrCreate("a".repeat(10))).toBe("a".repeat(10));
-    expect(PageID.validateOrCreate("a".repeat(9))).not.toBe("a".repeat(9));
-    expect(PageID.validateOrCreate("ABcdefghigKLML")).toBe("ABcdefghigKLML");
-  });
-});
+import { PageID, SchemaID } from "./ID";
+
+describe("ID Functions work", () => {
+  //Generate test for schema prefix
+  test("SCHEMA_ID isFunction works", () => {
+    const id = SchemaID.create();
+    expect(SchemaID.is(id)).toBe(true);
+    expect(SchemaID.is("")).toBe(false);
+    expect(SchemaID.is("a")).toBe(false);
+    expect(SchemaID.is("a".repeat(10))).toBe(true);
+    expect(SchemaID.is("a".repeat(9))).toBe(false);
+  });
+  test("SCHEMA_ID ensure works", () => {
+    const id = SchemaID.create();
+    expect(SchemaID.validateOrCreate(id)).toBe(id);
+    expect(SchemaID.validateOrCreate("")).not.toBe("");
+    expect(SchemaID.validateOrCreate("")).not.toBe("a");
+    expect(SchemaID.validateOrCreate("a".repeat(10))).toBe("a".repeat(10));
+    expect(SchemaID.validateOrCreate("a".repeat(9))).not.toBe("a".repeat(9));
+    expect(SchemaID.validateOrCreate("ABcdefghigKLML")).toBe("ABcdefghigKLML");
+  });
+  test("PageID isFunction works", () => {
+    const id = PageID.create();
+    expect(PageID.is(id)).toBe(true);
+    expect(PageID.is("")).toBe(false);
+    expect(PageID.is("a")).toBe(false);
+    expect(PageID.is("a".repeat(10))).toBe(true);
+    expect(PageID.is("a".repeat(9))).toBe(false);
+  });
+  test("PageID ensure works", () => {
+    const id = PageID.create();
+    expect(PageID.validateOrCreate(id)).toBe(id);
+    expect(PageID.validateOrCreate("")).not.toBe("");
+    expect(PageID.validateOrCreate("")).not.toBe("a");
+    expect(PageID.validateOrCreate("a".repeat(10))).toBe("a".repeat(10));
+    expect(PageID.validateOrCreate("a".repeat(9))).not.toBe("a".repeat(9));
+    expect(PageID.validateOrCreate("ABcdefghigKLML")).toBe("ABcdefghigKLML");
+  });
+});