@media-quest/builder 0.0.26 → 0.0.28

package/src/{Builder-page.ts → page/Builder-page.ts}

@@ -1,21 +1,22 @@
-import type { BuilderQuestionDto, BuilderQuestionType } from "./Builder-question";
-import { BuilderQuestion } from "./Builder-question";
-import { BuilderObject } from "./BuilderObject";
-import type { BuilderOptionDto } from "./Builder-option";
-import { BuilderOption } from "./Builder-option";
-import type { BuilderMainVideoDto } from "./BuilderMainVideoDto";
-import type { BuilderMainImageDto } from "./BuilderMainImageDto";
-import type { BuilderMainTextDto } from "./BuilderMainText";
-import { BuilderMainText } from "./BuilderMainText";
-import { RuleVariableOption, RuleQuestionVariable } from "./rulebuilder";
+import type { BuilderQuestionDto, BuilderQuestionType } from "../Builder-question";
+import { BuilderQuestion } from "../Builder-question";
+import { BuilderObject } from "../BuilderObject";
+import type { BuilderOptionDto } from "../Builder-option";
+import { BuilderOption } from "../Builder-option";
+import type { BuilderMainVideoDto } from "../BuilderMainVideoDto";
+import type { BuilderMainImageDto } from "../BuilderMainImageDto";
+import type { BuilderMainTextDto } from "../BuilderMainText";
+import { BuilderMainText } from "../BuilderMainText";
+import { RuleVariableOption, RuleQuestionVariable } from "../rulebuilder";
 import { DUtil } from "@media-quest/engine";
-import { PagePrefix, PagePrefixValue } from "./primitives/page-prefix";
-import { VarID } from "./primitives/varID";
-import { SchemaPrefix } from "./primitives/schema-prefix";
-import { PageID } from "./primitives/ID";
+import { PagePrefix, PagePrefixValue } from "../primitives/page-prefix";
+import { VarID } from "../primitives/varID";
+import { SchemaPrefix } from "../primitives/schema-prefix";
+import { PageID, SumScoreVariableID } from "../primitives/ID";
+import { SumScoreVariable } from "../sum-score/sum-score-variable";
 
 const U = DUtil;
-export type BuilderPageType = "info-page" | "question" | "multi-select" | "form";
+export type BuilderPageType = "info-page" | "question";
 
 export interface BuilderPageDto {
   readonly id: PageID;
@@ -25,6 +26,7 @@ export interface BuilderPageDto {
   nextButton: BuilderOptionDto;
   defaultQuestion: BuilderQuestionDto;
   mainMedia?: BuilderMainImageDto | BuilderMainVideoDto;
+  includedInSumScores: Array<{ sumScoreVariableId: SumScoreVariableID; weight: number }>;
   autoplaySequence: Array<string>;
   tags: ReadonlyArray<string>;
 }
@@ -36,6 +38,16 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
   private _prefix: PagePrefix;
   private readonly _tags: Set<string>;
   private _backgroundColor = "#FFFFFF";
+  private _includedInSumScores: Map<
+    SumScoreVariableID,
+    {
+      sumScoreVariableId: SumScoreVariableID;
+      weight: number;
+      name: string;
+      description: string;
+    }
+  > = new Map();
+
   mainMedia: BuilderMainVideoDto | BuilderMainImageDto | false = false;
   defaultQuestion: BuilderQuestion;
   mainText: BuilderMainText;
@@ -60,7 +72,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
       nextButton: nextButtonDto,
       mainText: mainTextDto,
       prefix: _prefix,
-      // questions: [],
+      includedInSumScores: [],
       tags: [],
     };
 
@@ -82,6 +94,15 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     this.nextButton = BuilderOption.fromJson(dto.nextButton);
     this.defaultQuestion = BuilderQuestion.fromJson(dto.defaultQuestion);
     const tagList: string[] = Array.isArray(dto.tags) ? dto.tags : [];
+    const sumScores = Array.isArray(dto.includedInSumScores) ? dto.includedInSumScores : [];
+    sumScores.forEach((item) => {
+      this._includedInSumScores.set(item.sumScoreVariableId, {
+        sumScoreVariableId: item.sumScoreVariableId,
+        weight: item.weight,
+        name: "",
+        description: "",
+      });
+    });
     this._tags = new Set(tagList);
     if (dto.mainMedia) {
       this.mainMedia = dto.mainMedia;
@@ -99,6 +120,10 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     this._pageType = value;
   }
 
+  get includedInSumScores() {
+    return [...this._includedInSumScores.values()];
+  }
+
   getQuestionVariables(
     modulePrefix: SchemaPrefix,
     pageNumber: number,
@@ -135,10 +160,38 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     this._prefix.value = value;
   }
 
+  /** @internal */
+  sumScoreVariableSet(sumScoreVariable: SumScoreVariable, weight: number) {
+    const { id, name, description } = sumScoreVariable;
+
+    this._includedInSumScores.set(sumScoreVariable.id, {
+      sumScoreVariableId: id,
+      weight,
+      name,
+      description,
+    });
+
+    return true;
+  }
+
+  /** @internal */
+  updateRelationShips(variables: ReadonlyArray<SumScoreVariable>) {
+    variables.forEach((v) => {
+      const sumScoreEntry = this._includedInSumScores.get(v.id);
+      if (sumScoreEntry) {
+        this.sumScoreVariableSet(v, sumScoreEntry.weight);
+      }
+    });
+  }
+
   toJson(): BuilderPageDto {
     const mainText = this.mainText.toJson();
     const nextButton = this.nextButton.toJson();
     const mainMedia = this.mainMedia;
+    const includedInSumScores = this.includedInSumScores.map(({ sumScoreVariableId, weight }) => ({
+      sumScoreVariableId,
+      weight,
+    }));
     const dto: BuilderPageDto = {
       _type: this.pageType,
       mainText,
@@ -146,6 +199,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
       nextButton,
       id: this.id,
       tags: [...this.tags],
+      includedInSumScores,
       prefix: this._prefix.value,
       defaultQuestion: this.defaultQuestion.toJson(),
     };
@@ -179,4 +233,18 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
       this._backgroundColor = color;
     }
   }
+
+  /**
+   * @internal
+   */
+  _isIncludedInSumScore(sumScoreId: SumScoreVariableID) {
+    return this._includedInSumScores.has(sumScoreId);
+  }
+
+  /**
+   * @internal
+   */
+  sumScoreVariableDelete(sumScoreVariableID: SumScoreVariableID) {
+    this._includedInSumScores.delete(sumScoreVariableID);
+  }
 }

package/src/primitives/ID.ts

@@ -1,138 +1,135 @@
-// The default length of an ID
-const ID_LENGTH = 32;
-
-// The minimum length of an ID
-const MIN_LENGTH = 10;
-
-export type ID<B extends string> = string & { __ID__: B };
-
-const isID = <const B extends string>(idName: B, id?: string): id is ID<B> => {
-  if (typeof id !== "string") return false;
-  return id.length >= MIN_LENGTH;
-};
-
-const createIDByName = <const B extends string>(idName: B): ID<B> => {
-  const letters = "abcdefghijklmnopqrstuvyz";
-  const all = letters + letters.toUpperCase();
-  let result = "";
-
-  for (let i = 0; i < ID_LENGTH; i++) {
-    const char = all.charAt(Math.floor(Math.random() * all.length));
-    result += char;
-  }
-
-  return result as ID<B>;
-};
-const createDummyID = <const B extends string>(idName: B, letter: string): ID<B> => {
-  return letter.repeat(ID_LENGTH) as ID<B>;
-};
-interface Id<T extends string> {
-  name: T;
-  is: (id: string) => id is ID<T>;
-  validateOrCreate: (id: string) => ID<T>;
-  validateOrThrow: (id: string) => ID<T>;
-  create: () => ID<T>;
-  dummy: {
-    a: ID<T>;
-    b: ID<T>;
-    c: ID<T>;
-    d: ID<T>;
-    e: ID<T>;
-    f: ID<T>;
-    g: ID<T>;
-    h: ID<T>;
-    i: ID<T>;
-    j: ID<T>;
-  };
-}
-
-/**
- * Creates a object with helper functions for a specific ID type
- * @param idName
- */
-export const createTypedIdSingleton = <const B extends string>(idName: B): Id<B> => {
-  /**
-   * Creates a new ID of the correct type
-   */
-  const create = (): ID<B> => createIDByName(idName);
-
-  /**
-   * Checks if the id is of the correct type
-   * @param id
-   */
-  const is = (id: string): id is ID<B> => isID(idName, id);
-
-  /**
-   * Checks if the id is of the correct type, if not it throws an error
-   * @param id
-   */
-  const validateOrThrow = (id: string): ID<B> => {
-    if (!is(id)) {
-      throw new Error(`Invalid id: ${id}`);
-    }
-    return id;
-  };
-
-  /**
-   * The lowercase name of the id (SCHEMA, PAGE, etc)
-   */
-  const name: B = idName;
-
-  /**
-   * Ensures that the id is of the correct type, if not it creates a new one
-   * @param id
-   */
-  const validateOrCreate = (id: string): ID<B> => {
-    return is(id) ? id : create();
-  };
-
-  const a = createDummyID(idName, "a");
-  const b = createDummyID(idName, "b");
-  const c = createDummyID(idName, "c");
-  const d = createDummyID(idName, "d");
-  const e = createDummyID(idName, "e");
-  const f = createDummyID(idName, "f");
-  const g = createDummyID(idName, "g");
-  const h = createDummyID(idName, "h");
-  const i = createDummyID(idName, "i");
-  const j = createDummyID(idName, "j");
-  const list = [a, b, c, d, e, f, g, h, i, j];
-
-  const dummy = {
-    a,
-    b,
-    c,
-    d,
-    e,
-    f,
-    g,
-    h,
-    i,
-    j,
-    list,
-  };
-
-  return Object.freeze({ create, is, validateOrCreate, validateOrThrow, name, dummy });
-};
-
-export type SchemaID = ID<"SCHEMA">;
-export const SchemaID = createTypedIdSingleton("SCHEMA");
-
-export type PageID = ID<"PAGE">;
-export const PageID = createTypedIdSingleton("PAGE");
-
-export type TagID = ID<"TAG">;
-export const TagID = createTypedIdSingleton("TAG");
-export type OptionID = ID<"OPTION">;
-export const OptionID = createTypedIdSingleton("OPTION");
-
-export type TextID = ID<"TEXT">;
-export const TextID = createTypedIdSingleton("TEXT");
-export type QuestionID = ID<"QUESTION">;
-export const QuestionID = createTypedIdSingleton("QUESTION");
-
-export type SumScoreVariableID = ID<"SUM_SCORE_VARIABLE">;
-export const SumScoreVariableID = createTypedIdSingleton("SUM_SCORE_VARIABLE");
-
-export type SumScoreMemberShipID = ID<"SUM_SCORE_MEMBERSHIP">;
-export const SumScoreMemberShipID = createTypedIdSingleton("SUM_SCORE_MEMBERSHIP");
+// The default length of an ID
+const ID_LENGTH = 32;
+
+// The minimum length of an ID
+const MIN_LENGTH = 10;
+
+export type ID<B extends string> = string & { __ID__: B };
+
+const isID = <const B extends string>(idName: B, id?: string): id is ID<B> => {
+  if (typeof id !== "string") return false;
+  return id.length >= MIN_LENGTH;
+};
+
+const createIDByName = <const B extends string>(idName: B): ID<B> => {
+  const letters = "abcdefghijklmnopqrstuvyz";
+  const all = letters + letters.toUpperCase();
+  let result = "";
+
+  for (let i = 0; i < ID_LENGTH; i++) {
+    const char = all.charAt(Math.floor(Math.random() * all.length));
+    result += char;
+  }
+
+  return result as ID<B>;
+};
+const createDummyID = <const B extends string>(idName: B, letter: string): ID<B> => {
+  return letter.repeat(ID_LENGTH) as ID<B>;
+};
+interface Id<T extends string> {
+  name: T;
+  is: (id: string) => id is ID<T>;
+  validateOrCreate: (id: string) => ID<T>;
+  validateOrThrow: (id: string) => ID<T>;
+  create: () => ID<T>;
+  dummy: {
+    a: ID<T>;
+    b: ID<T>;
+    c: ID<T>;
+    d: ID<T>;
+    e: ID<T>;
+    f: ID<T>;
+    g: ID<T>;
+    h: ID<T>;
+    i: ID<T>;
+    j: ID<T>;
+  };
+}
+
+/**
+ * Creates a object with helper functions for a specific ID type
+ * @param idName
+ */
+export const createTypedIdSingleton = <const B extends string>(idName: B): Id<B> => {
+  /**
+   * Creates a new ID of the correct type
+   */
+  const create = (): ID<B> => createIDByName(idName);
+
+  /**
+   * Checks if the id is of the correct type
+   * @param id
+   */
+  const is = (id: string): id is ID<B> => isID(idName, id);
+
+  /**
+   * Checks if the id is of the correct type, if not it throws an error
+   * @param id
+   */
+  const validateOrThrow = (id: string): ID<B> => {
+    if (!is(id)) {
+      throw new Error(`Invalid id: ${id}`);
+    }
+    return id;
+  };
+
+  /**
+   * The lowercase name of the id (SCHEMA, PAGE, etc)
+   */
+  const name: B = idName;
+
+  /**
+   * Ensures that the id is of the correct type, if not it creates a new one
+   * @param id
+   */
+  const validateOrCreate = (id: string): ID<B> => {
+    return is(id) ? id : create();
+  };
+
+  const a = createDummyID(idName, "a");
+  const b = createDummyID(idName, "b");
+  const c = createDummyID(idName, "c");
+  const d = createDummyID(idName, "d");
+  const e = createDummyID(idName, "e");
+  const f = createDummyID(idName, "f");
+  const g = createDummyID(idName, "g");
+  const h = createDummyID(idName, "h");
+  const i = createDummyID(idName, "i");
+  const j = createDummyID(idName, "j");
+  const list = [a, b, c, d, e, f, g, h, i, j];
+
+  const dummy = {
+    a,
+    b,
+    c,
+    d,
+    e,
+    f,
+    g,
+    h,
+    i,
+    j,
+    list,
+  };
+
+  return Object.freeze({ create, is, validateOrCreate, validateOrThrow, name, dummy });
+};
+
+export type SchemaID = ID<"SCHEMA">;
+export const SchemaID = createTypedIdSingleton("SCHEMA");
+
+export type PageID = ID<"PAGE">;
+export const PageID = createTypedIdSingleton("PAGE");
+
+export type TagID = ID<"TAG">;
+export const TagID = createTypedIdSingleton("TAG");
+export type OptionID = ID<"OPTION">;
+export const OptionID = createTypedIdSingleton("OPTION");
+
+export type TextID = ID<"TEXT">;
+export const TextID = createTypedIdSingleton("TEXT");
+export type QuestionID = ID<"QUESTION">;
+export const QuestionID = createTypedIdSingleton("QUESTION");
+
+export type SumScoreVariableID = ID<"SUM_SCORE_VARIABLE">;
+export const SumScoreVariableID = createTypedIdSingleton("SUM_SCORE_VARIABLE");

package/src/public-api.ts

@@ -1,28 +1,28 @@
-export { type BuilderOptionDto, BuilderOption } from "./Builder-option";
-export { type BuilderPageDto, type BuilderPageType, BuilderPage } from "./Builder-page";
-export {
-  type BuilderQuestionDto,
-  BuilderQuestion,
-  type BuilderQuestionType,
-} from "./Builder-question";
-export { BuilderSchema, type BuilderSchemaDto } from "./Builder-schema";
-export { BuilderText, type BuilderTextDto } from "./Builder-text";
-export { type BuilderMainImageDto } from "./BuilderMainImageDto";
-export { BuilderMainText, type BuilderMainTextDto } from "./BuilderMainText";
-export { type BuilderMainVideoDto } from "./BuilderMainVideoDto";
-export { type BuilderTagDto, BuilderTag, TagCollection } from "./BuilderTag";
-export { type AudioFile, type ImageFile, type VideoFile } from "./media-files";
-// Public Api of rule-builder
-export * from "./rulebuilder";
-export { PagePrefix, PagePrefixValue } from "./primitives/page-prefix";
-export { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
-export * from "./schema-config";
-export * from "./code-book/codebook";
-export { VarID } from "./primitives/varID";
-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 { SumScoreAnswer } from "./sum-score/sum-score-answer";
-export { SumScoreManager } from "./sum-score/sum-score-manager";
+export { type BuilderOptionDto, BuilderOption } from "./Builder-option";
+export { type BuilderPageDto, type BuilderPageType, BuilderPage } from "./page/Builder-page";
+export {
+  type BuilderQuestionDto,
+  BuilderQuestion,
+  type BuilderQuestionType,
+} from "./Builder-question";
+export { BuilderSchema, type BuilderSchemaDto } from "./Builder-schema";
+export { BuilderText, type BuilderTextDto } from "./Builder-text";
+export { type BuilderMainImageDto } from "./BuilderMainImageDto";
+export { BuilderMainText, type BuilderMainTextDto } from "./BuilderMainText";
+export { type BuilderMainVideoDto } from "./BuilderMainVideoDto";
+export { type BuilderTagDto, BuilderTag } from "./tag/BuilderTag";
+export { type AudioFile, type ImageFile, type VideoFile } from "./media-files";
+// Public Api of rule-builder
+export * from "./rulebuilder";
+export { PagePrefix, PagePrefixValue } from "./primitives/page-prefix";
+export { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
+export * from "./schema-config";
+export * from "./code-book/codebook";
+export { VarID } from "./primitives/varID";
+export * from "./primitives/ID";
+export * from "./code-book/codebook-variable";
+export * from "./builder-compiler";
+export * from "./sum-score/sum-score";
+export { SumScoreVariableDto, SumScoreVariable } from "./sum-score/sum-score-variable";
+export { SumScoreAnswer } from "./sum-score/sum-score-answer";
+export { TagCollection } from "./tag/Tag-Collection";