@media-quest/builder 0.0.22 → 0.0.23

package/src/theme/icon-urls.ts

@@ -1,29 +1,29 @@
-export const IconUrls = {
-  ispeWhitePng:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fispe-hvit.png?alt=media&token=f6fe628b-2d99-472d-a2ea-e062873e2e22',
-  pauseSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fpause-24px.svg?alt=media&token=47337491-bb0d-4c56-9c89-a073ce19fad4',
-  pauseCircleOutlineSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fpause_circle_outline-24px.svg?alt=media&token=133aabc8-ab9a-4eaa-9914-4f0f82c22ee2',
-
-  pauseCircleFilledSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fpause_circle_filled-24px.svg?alt=media&token=af3f12c3-3199-4096-8ed2-76347b9a0a0a',
-  playCircleRegular:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fplay-circle-regular.svg?alt=media&token=0867b690-d7fd-475c-8e91-b2d7aeca54d1',
-  playArrowSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fplay_arrow-24px.svg?alt=media&token=2fa95e1f-61f7-4a18-afb3-210eabae8227',
-  playCircleOutline:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fplay_circle_outline-24px.svg?alt=media&token=3a9f62c5-dfa2-40ef-a50e-cf1bdd2d47f2',
-
-  stopCircleSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fstop_circle-24px.svg?alt=media&token=8fbc8b89-29bb-49ad-ae11-b8882ba3ca77',
-  stopSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fstop-24px.svg?alt=media&token=d2cd41f1-1331-4243-9b7a-dc0f0ccd255d',
-  replayCircleSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Freplay-24px.svg?alt=media&token=3c35ccf4-b467-4e81-85d6-b36ac64738ad',
-
-  volumeOffSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fvolume_off-24px.svg?alt=media&token=4e41cc10-9f4b-4967-b4df-ed0682e657a9',
-  volumeUpSvg:
-    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fvolume_up-24px.svg?alt=media&token=551bd0a6-a515-4f87-a245-da433f4833f9'
-};
+export const IconUrls = {
+  ispeWhitePng:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fispe-hvit.png?alt=media&token=f6fe628b-2d99-472d-a2ea-e062873e2e22',
+  pauseSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fpause-24px.svg?alt=media&token=47337491-bb0d-4c56-9c89-a073ce19fad4',
+  pauseCircleOutlineSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fpause_circle_outline-24px.svg?alt=media&token=133aabc8-ab9a-4eaa-9914-4f0f82c22ee2',
+
+  pauseCircleFilledSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fpause_circle_filled-24px.svg?alt=media&token=af3f12c3-3199-4096-8ed2-76347b9a0a0a',
+  playCircleRegular:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fplay-circle-regular.svg?alt=media&token=0867b690-d7fd-475c-8e91-b2d7aeca54d1',
+  playArrowSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fplay_arrow-24px.svg?alt=media&token=2fa95e1f-61f7-4a18-afb3-210eabae8227',
+  playCircleOutline:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fplay_circle_outline-24px.svg?alt=media&token=3a9f62c5-dfa2-40ef-a50e-cf1bdd2d47f2',
+
+  stopCircleSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fstop_circle-24px.svg?alt=media&token=8fbc8b89-29bb-49ad-ae11-b8882ba3ca77',
+  stopSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fstop-24px.svg?alt=media&token=d2cd41f1-1331-4243-9b7a-dc0f0ccd255d',
+  replayCircleSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Freplay-24px.svg?alt=media&token=3c35ccf4-b467-4e81-85d6-b36ac64738ad',
+
+  volumeOffSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fvolume_off-24px.svg?alt=media&token=4e41cc10-9f4b-4967-b4df-ed0682e657a9',
+  volumeUpSvg:
+    'https://firebasestorage.googleapis.com/v0/b/ispe-backend-dev.appspot.com/o/public-assets%2Fvolume_up-24px.svg?alt=media&token=551bd0a6-a515-4f87-a245-da433f4833f9'
+};

package/src/theme/theme-utils.ts

@@ -1,57 +1,57 @@
-import { DStyle } from "@media-quest/engine";
-import { DElementDto } from "@media-quest/engine";
-
-export namespace ThemeUtils {
-  export const spaceEvenlyX = <T extends Pick<DElementDto, "style">>(
-    items: ReadonlyArray<T>,
-    options: { startAt: number; endAt: number; defaultItemWidth: number } = {
-      startAt: 0,
-      endAt: 100,
-      defaultItemWidth: 5,
-    },
-  ): ReadonlyArray<T> => {
-    const startAt = options?.startAt ?? 0;
-    const endAt = options?.endAt ?? 100;
-    const range = Math.abs(endAt - startAt);
-    if (items.length === 0) {
-      return [];
-    }
-    const marginCount = items.length + 1;
-    const defaultWidth = options.defaultItemWidth ?? 150 / marginCount;
-
-    let totalWidthOfElements = items.reduce((prev, curr) => {
-      const w = curr.style.w ?? defaultWidth;
-      return prev + w;
-    }, 0);
-
-    let cursor = startAt;
-    const rest = Math.max(range - totalWidthOfElements, 0);
-    const margin = rest / marginCount;
-
-    items.forEach((item) => {
-      cursor = cursor + margin;
-      const w = item.style.w ?? defaultWidth;
-      const x = cursor;
-      cursor = cursor + w;
-      item.style.w = w;
-      item.style.x = x;
-    });
-
-    return items;
-  };
-
-  export const centerY = (): Pick<DStyle, "y" | "transform"> => ({
-    y: 50,
-    transform: "translate(0%, 50%)",
-  });
-  export const centerX = (): Pick<DStyle, "x" | "transform"> => ({
-    x: 50,
-    transform: "translate(-50%, 0%)",
-  });
-
-  export const centerXY = (): Pick<DStyle, "x" | "y" | "transform"> => ({
-    x: 50,
-    y: 50,
-    transform: "translate(-50%, 50%)",
-  });
-}
+import { DStyle } from "@media-quest/engine";
+import { DElementDto } from "@media-quest/engine";
+
+export namespace ThemeUtils {
+  export const spaceEvenlyX = <T extends Pick<DElementDto, "style">>(
+    items: ReadonlyArray<T>,
+    options: { startAt: number; endAt: number; defaultItemWidth: number } = {
+      startAt: 0,
+      endAt: 100,
+      defaultItemWidth: 5,
+    },
+  ): ReadonlyArray<T> => {
+    const startAt = options?.startAt ?? 0;
+    const endAt = options?.endAt ?? 100;
+    const range = Math.abs(endAt - startAt);
+    if (items.length === 0) {
+      return [];
+    }
+    const marginCount = items.length + 1;
+    const defaultWidth = options.defaultItemWidth ?? 150 / marginCount;
+
+    let totalWidthOfElements = items.reduce((prev, curr) => {
+      const w = curr.style.w ?? defaultWidth;
+      return prev + w;
+    }, 0);
+
+    let cursor = startAt;
+    const rest = Math.max(range - totalWidthOfElements, 0);
+    const margin = rest / marginCount;
+
+    items.forEach((item) => {
+      cursor = cursor + margin;
+      const w = item.style.w ?? defaultWidth;
+      const x = cursor;
+      cursor = cursor + w;
+      item.style.w = w;
+      item.style.x = x;
+    });
+
+    return items;
+  };
+
+  export const centerY = (): Pick<DStyle, "y" | "transform"> => ({
+    y: 50,
+    transform: "translate(0%, 50%)",
+  });
+  export const centerX = (): Pick<DStyle, "x" | "transform"> => ({
+    x: 50,
+    transform: "translate(-50%, 0%)",
+  });
+
+  export const centerXY = (): Pick<DStyle, "x" | "y" | "transform"> => ({
+    x: 50,
+    y: 50,
+    transform: "translate(-50%, 50%)",
+  });
+}

package/src/theme/theme1.spec.ts

@@ -1,52 +1,52 @@
-import { ThemeUtils } from "./theme-utils";
-import { DStyle } from "@media-quest/engine";
-
-describe("Theme1 works", () => {
-  test("Can space evenly when all is even", () => {
-    const btn1 = {};
-    const els = ThemeUtils.spaceEvenlyX<{ style: Partial<DStyle> }>([
-      { style: { w: 20 } },
-      { style: { w: 20 } },
-      { style: { w: 20 } },
-    ]);
-
-    const first = els[0];
-    const second = els[1];
-    const third = els[2];
-    expect(first.style.x).toBe(10);
-    expect(second.style.x).toBe(40);
-    expect(third.style.x).toBe(70);
-    // responseButtons.forEach((el) => {
-    //     expect(el._tag === "div").toBe(true);
-    //     expect(el.children.length).toBe(1);
-    // });
-  });
-
-  test("Can space evenly even if uneven lengths", () => {
-    const btn1 = {};
-    const els = ThemeUtils.spaceEvenlyX([
-      { style: { w: 10, x: 0 } },
-      { style: { w: 30, x: 10 } },
-      { style: { w: 20, x: 30 } },
-    ]);
-
-    const first = els[0];
-    const second = els[1];
-    const third = els[2];
-    expect(first.style.x).toBe(10);
-    expect(second.style.x).toBe(30);
-    expect(third.style.x).toBe(70);
-  });
-
-  test("Can space evenly on a shorter scale 10-90", () => {
-    const els = ThemeUtils.spaceEvenlyX([{ style: {} }, { style: {} }, { style: {} }], {
-      startAt: 10,
-      endAt: 90,
-      defaultItemWidth: 20,
-    }) as ReadonlyArray<{ style: { x: number; w: number } }>;
-
-    expect(els[0].style.x).toBe(15);
-    // expect(els[1].style.x).toBe(10);
-    // expect(els[2].style.x).toBe(10);
-  });
-});
+import { ThemeUtils } from "./theme-utils";
+import { DStyle } from "@media-quest/engine";
+
+describe("Theme1 works", () => {
+  test("Can space evenly when all is even", () => {
+    const btn1 = {};
+    const els = ThemeUtils.spaceEvenlyX<{ style: Partial<DStyle> }>([
+      { style: { w: 20 } },
+      { style: { w: 20 } },
+      { style: { w: 20 } },
+    ]);
+
+    const first = els[0];
+    const second = els[1];
+    const third = els[2];
+    expect(first.style.x).toBe(10);
+    expect(second.style.x).toBe(40);
+    expect(third.style.x).toBe(70);
+    // responseButtons.forEach((el) => {
+    //     expect(el._tag === "div").toBe(true);
+    //     expect(el.children.length).toBe(1);
+    // });
+  });
+
+  test("Can space evenly even if uneven lengths", () => {
+    const btn1 = {};
+    const els = ThemeUtils.spaceEvenlyX([
+      { style: { w: 10, x: 0 } },
+      { style: { w: 30, x: 10 } },
+      { style: { w: 20, x: 30 } },
+    ]);
+
+    const first = els[0];
+    const second = els[1];
+    const third = els[2];
+    expect(first.style.x).toBe(10);
+    expect(second.style.x).toBe(30);
+    expect(third.style.x).toBe(70);
+  });
+
+  test("Can space evenly on a shorter scale 10-90", () => {
+    const els = ThemeUtils.spaceEvenlyX([{ style: {} }, { style: {} }, { style: {} }], {
+      startAt: 10,
+      endAt: 90,
+      defaultItemWidth: 20,
+    }) as ReadonlyArray<{ style: { x: number; w: number } }>;
+
+    expect(els[0].style.x).toBe(15);
+    // expect(els[1].style.x).toBe(10);
+    // expect(els[2].style.x).toBe(10);
+  });
+});

package/src/variable/mq-variable.spec.ts

@@ -0,0 +1,91 @@
+import { MqVariable } from "./mq-variable";
+import { SumScoreVariable } from "./sum-score-variable";
+const createVariable = (value: number): MqVariable => {
+  return {
+    varId: "v" + value,
+    label: "label for v" + value,
+    numericValue: value,
+    origin: "question",
+    kind: "numeric-variable",
+  };
+};
+
+const createSumScore = (basedOn: Array<{ variable: MqVariable; weight?: number }>) => {
+  const sumVar1: SumScoreVariable = {
+    kind: "numeric-variable",
+    initialValue: 0,
+    min: 0,
+    origin: "sum-score",
+    label: "Sum 123",
+    varId: "sum-score-variable-id",
+    basedOn: basedOn.map((v) => ({ varId: v.variable.varId, weight: v.weight })),
+  };
+  return sumVar1;
+};
+
+const v0 = createVariable(0);
+const v1 = createVariable(1);
+const v2 = createVariable(2);
+const v3 = createVariable(3);
+const v4 = createVariable(4);
+const v5 = createVariable(5);
+const v6 = createVariable(6);
+const v7 = createVariable(7);
+const v8 = createVariable(8);
+const v9 = createVariable(9);
+
+const all = [v0, v1, v2, v3, v4, v5, v6, v7, v8, v9];
+describe("Sum score variable.", () => {
+  test("Will calculate 2", () => {
+    const ss1 = createSumScore([
+      { variable: v1, weight: 1 },
+      { variable: v2, weight: 1 },
+    ]);
+    const score = SumScoreVariable.calculate(ss1, all);
+    expect(score.sumScore).toBe(3);
+    expect(score.basedOn.length).toBe(2);
+  });
+  test("Will calculate 5 values", () => {
+    const ss1 = createSumScore([
+      { variable: v1, weight: 1 },
+      { variable: v2, weight: 1 },
+      { variable: v4, weight: 1 },
+      { variable: v5 },
+      { variable: v6, weight: 1 },
+    ]);
+    const score = SumScoreVariable.calculate(ss1, all);
+    expect(score.sumScore).toBe(18);
+    const basedOn1 = score.basedOn[0];
+    expect(basedOn1.value).toBe(v1.numericValue);
+    expect(basedOn1.weight).toBe(1);
+    expect(basedOn1.varId).toBe(v1.varId);
+    expect(basedOn1.varLabel).toBe(v1.label);
+  });
+  test("Will not include 9", () => {
+    const ss1 = createSumScore([
+      { variable: v1, weight: 1 },
+      { variable: v5, weight: 1 },
+      { variable: v9, weight: 1 },
+    ]);
+    const score = SumScoreVariable.calculate(ss1, all);
+    expect(score.sumScore).toBe(6);
+  });
+  test("Will not calculate weight", () => {
+    const ss1 = createSumScore([
+      { variable: v1, weight: 1 },
+      { variable: v8, weight: 0.5 },
+    ]);
+    const score = SumScoreVariable.calculate(ss1, all);
+    expect(score.sumScore).toBe(5);
+  });
+  test("Will not calculate many weighted variables.", () => {
+    const ss1 = createSumScore([
+      { variable: v1, weight: 1 },
+      { variable: v2, weight: 0.5 },
+      { variable: v5, weight: 1.2 },
+      { variable: v8, weight: 2 },
+    ]);
+    const score = SumScoreVariable.calculate(ss1, all);
+    expect(score.sumScore).toBe(24);
+  });
+});

package/src/{mq-variable.ts → variable/mq-variable.ts}

@@ -1,61 +1,63 @@
-export interface MqVariable {
-  readonly kind: "numeric-variable" | "numeric-range-variable" | "string-variable";
-
-  label: string;
-  varId: string;
-
-  // Values - The actual value of the variable.
-  stringValue?: string;
-  numericValue?: number;
-  minValue?: number;
-  initialValue?: number;
-  maxValue?: number;
-  defaultValue?: number | string;
-  defaultMinValue?: number;
-  defaultMaxValue?: number;
-
-  // Context
-  origin:
-    | "question"
-    | "form-field"
-    | "predefined"
-    | "event"
-    | "calculated"
-    | "sum-score"
-    | "predefined-or-question";
-
-  pageId?: string;
-  eventSource?: string;
-  pagePrefix?: string;
-  modulePrefix?: string;
-  moduleID?: string;
-  pageNumber?: number;
-
-  // Validations
-  min?: number;
-  max?: number;
-  stepSize?: number;
-  minLength?: number;
-  maxLength?: number;
-  rangeFloor?: number;
-  rangeCeiling?: number;
-
-  options?: Array<{ label: string; value: number }>;
-}
-
-export interface PageVariable extends MqVariable {
-  readonly pageId: string;
-  readonly pagePrefix: string;
-  readonly pagePosition: number;
-  readonly modulePrefix: string;
-  readonly origin: "question" | "form-field";
-}
-
-export interface PredefinedVariable extends MqVariable {
-  readonly origin: "predefined";
-  readonly modulePrefix: string;
-  readonly moduleID: string;
-  defaultValue: number;
-  requireManualSelection: boolean;
-  options: Array<{ label: string; value: number }>;
-}
+export interface MqVariable {
+  readonly kind: "numeric-variable" | "numeric-range-variable" | "string-variable";
+
+  label: string;
+  varId: string;
+  description?: string;
+
+  // Values - The actual value of the variable.
+  stringValue?: string;
+  numericValue?: number;
+  minValue?: number;
+  initialValue?: number;
+  maxValue?: number;
+  defaultValue?: number | string;
+  defaultMinValue?: number;
+  defaultMaxValue?: number;
+
+  // Context
+  origin:
+    | "question"
+    | "form-field"
+    | "predefined"
+    | "event"
+    | "calculated"
+    | "sum-score"
+    | "predefined-or-question";
+
+  pageId?: string;
+  eventSource?: string;
+  pagePrefix?: string;
+  modulePrefix?: string;
+  moduleID?: string;
+  pageNumber?: number;
+
+  // Validations
+  min?: number;
+  max?: number;
+  stepSize?: number;
+  minLength?: number;
+  maxLength?: number;
+  rangeFloor?: number;
+  rangeCeiling?: number;
+
+  // Analytics
+  options?: Array<{ label: string; value: number }>;
+  basedOn?: Array<{ varId: string; weight?: number }>;
+}
+
+export interface PageVariable extends MqVariable {
+  readonly pageId: string;
+  readonly pagePrefix: string;
+  readonly pagePosition: number;
+  readonly modulePrefix: string;
+  readonly origin: "question" | "form-field";
+}
+
+export interface PredefinedVariable extends MqVariable {
+  readonly origin: "predefined";
+  readonly modulePrefix: string;
+  readonly moduleID: string;
+  defaultValue: number;
+  options: Array<{ label: string; value: number }>;
+}

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

@@ -0,0 +1,56 @@
+import { MqVariable } from "./mq-variable";
+
+export interface SumScoreVariable extends MqVariable {
+  readonly origin: "sum-score";
+  initialValue: number;
+  basedOn: Array<{ varId: string; weight?: number }>;
+}
+
+/**
+ *
+ * A constant Array that contains all legal
+ */
+const ALLOWED_SUM_SCORE_VALUES = [1, 2, 3, 4, 5, 6, 7, 8] as const;
+export interface SumScoreResult {
+  sumScore: number;
+  basedOn: Array<{ varId: string; value: number; weight: number; varLabel: string }>;
+}
+const calculate = (
+  sumScoreVariable: SumScoreVariable,
+  allVariables: Array<Pick<MqVariable, "varId" | "numericValue" | "kind" | "label">>,
+): SumScoreResult => {
+  const basedOnList = sumScoreVariable.basedOn;
+  // let sum = sumScoreVariable.initialValue ?? 0;
+  const result: SumScoreResult = {
+    sumScore: sumScoreVariable.initialValue ?? 0,
+    basedOn: [],
+  };
+  const legalValues: Array<number> = [...ALLOWED_SUM_SCORE_VALUES];
+  allVariables.forEach((v) => {
+    if (v.kind !== "numeric-variable") return;
+    const numValue = v.numericValue;
+    if (typeof numValue !== "number") return;
+    if (!legalValues.includes(numValue)) return;
+
+    basedOnList.forEach((item) => {
+      if (item.varId === v.varId) {
+        const weight = typeof item.weight === "number" ? item.weight : 1;
+        const weightedValue = numValue * weight;
+
+        result.basedOn.push({
+          varId: item.varId,
+          weight: weight,
+          varLabel: v.label,
+          value: numValue,
+        });
+        result.sumScore = result.sumScore + weightedValue;
+        // sum = sum + weightedValue;
+      }
+    });
+  });
+  return result;
+};
+export const SumScoreVariable = {
+  ALLOWED_SUM_SCORE_VALUES,
+  calculate,
+};

package/tsconfig.json

@@ -1,15 +1,15 @@
-{
-  "compilerOptions": {
-    "target": "es2022",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "declaration": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "rootDir": "./src",
-    "composite": true,
-    "outDir": "./dist"
-  },
-}
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "rootDir": "./src",
+    "composite": true,
+    "outDir": "./dist"
+  },
+}