@media-quest/builder 0.0.26 → 0.0.28

package/src/rulebuilder/RuleAction.ts

@@ -1,106 +1,105 @@
-import { PageID } from "@media-quest/engine";
-
-import { PagePrefixValue } from "../primitives/page-prefix";
-
-export interface ExcludeByPageAction {
-  readonly kind: "exclude-by-pageId";
-  readonly pageId: PageID;
-  readonly pagePrefix: PagePrefixValue;
-  readonly mainText: string;
-  readonly pageNumber: number;
-}
-
-export interface JumpToPageAction {
-  readonly kind: "jump-to-page";
-  readonly pageId: PageID;
-  readonly pagePrefix: PagePrefixValue;
-  readonly mainText: string;
-  readonly pageNumber: number;
-}
-
-export interface ExcludeByTagAction {
-  readonly kind: "exclude-by-tag";
-  readonly tag: string;
-  readonly description: string;
-  readonly pageCount: number;
-}
-
-// interface ISearchable {
-//   getLabel(): string;
-//   getTooltip(): string;
-//   getSearchString(): string;
-// }
-// interface ISelectable {
-//   isSelected: boolean;
-// }
-//
-// export class PageAction implements ISearchable, ISelectable {
-//   public readonly description = "Will exclude this page from the survey.";
-//   private _isSelected: boolean = false;
-//   get isSelected(): boolean {
-//     return this._isSelected;
-//   }
-//   set isSelected(value: boolean) {
-//     const casted = value as unknown;
-//     if (typeof casted === "boolean") {
-//       this._isSelected = casted;
-//     }
-//   }
-//   get pageId(): PageID {
-//     return this.data.pageId;
-//   }
-//   get pagePrefix(): PagePrefixValue {
-//     return this.data.pagePrefix;
-//   }
-//   get mainText(): string {
-//     return this.data.mainText;
-//   }
-//   get pageNumber(): number {
-//     return this.data.pageNumber;
-//   }
-//   constructor(
-//     private readonly data: {
-//       pageId: PageID;
-//       pagePrefix: PagePrefixValue;
-//       mainText: string;
-//       pageNumber: number;
-//       isSelected: boolean;
-//     },
-//   ) {
-//     this.isSelected = this.data.isSelected;
-//   }
-//
-//   getLabel(): string {
-//     return this.data.pagePrefix + " (" + this.data.pageNumber + ")";
-//   }
-//   getTooltip(): string {
-//     return this.data.mainText;
-//   }
-//   getSearchString(): string {
-//     return this.data.pagePrefix + this.data.mainText;
-//   }
-// }
-// export class TagAction implements ISearchable {
-//   constructor(
-//     readonly tag: string,
-//     readonly description: string,
-//     readonly usedInPages: { pageNumber: number; pagePrefix: PagePrefixValue }[],
-//   ) {}
-//   getLabel(): string {
-//     return this.tag + " (" + this.usedInPages.length + ")";
-//   }
-//   getTooltip(): string {
-//     return this.description;
-//   }
-//   getSearchString(): string {
-//     return this.tag;
-//   }
-// }
-
-// class SelectableCollection<T> {
-//   private readonly _items: Array<T>;
-//   private selected: T | false = false;
-//   constructor(items: ReadonlyArray<T>) {
-//     this._items = [...items];
-//   }
-// }
+import { PagePrefixValue } from "../primitives/page-prefix";
+import { PageID } from "../primitives/ID";
+
+export interface ExcludeByPageAction {
+  readonly kind: "exclude-by-pageId";
+  readonly pageId: PageID;
+  readonly pagePrefix: PagePrefixValue;
+  readonly mainText: string;
+  readonly pageNumber: number;
+}
+
+export interface JumpToPageAction {
+  readonly kind: "jump-to-page";
+  readonly pageId: PageID;
+  readonly pagePrefix: PagePrefixValue;
+  readonly mainText: string;
+  readonly pageNumber: number;
+}
+
+export interface ExcludeByTagAction {
+  readonly kind: "exclude-by-tag";
+  readonly tag: string;
+  readonly description: string;
+  readonly pageCount: number;
+}
+
+// interface ISearchable {
+//   getLabel(): string;
+//   getTooltip(): string;
+//   getSearchString(): string;
+// }
+// interface ISelectable {
+//   isSelected: boolean;
+// }
+//
+// export class PageAction implements ISearchable, ISelectable {
+//   public readonly description = "Will exclude this page from the survey.";
+//   private _isSelected: boolean = false;
+//   get isSelected(): boolean {
+//     return this._isSelected;
+//   }
+//   set isSelected(value: boolean) {
+//     const casted = value as unknown;
+//     if (typeof casted === "boolean") {
+//       this._isSelected = casted;
+//     }
+//   }
+//   get pageId(): PageID {
+//     return this.data.pageId;
+//   }
+//   get pagePrefix(): PagePrefixValue {
+//     return this.data.pagePrefix;
+//   }
+//   get mainText(): string {
+//     return this.data.mainText;
+//   }
+//   get pageNumber(): number {
+//     return this.data.pageNumber;
+//   }
+//   constructor(
+//     private readonly data: {
+//       pageId: PageID;
+//       pagePrefix: PagePrefixValue;
+//       mainText: string;
+//       pageNumber: number;
+//       isSelected: boolean;
+//     },
+//   ) {
+//     this.isSelected = this.data.isSelected;
+//   }
+//
+//   getLabel(): string {
+//     return this.data.pagePrefix + " (" + this.data.pageNumber + ")";
+//   }
+//   getTooltip(): string {
+//     return this.data.mainText;
+//   }
+//   getSearchString(): string {
+//     return this.data.pagePrefix + this.data.mainText;
+//   }
+// }
+// export class TagAction implements ISearchable {
+//   constructor(
+//     readonly tag: string,
+//     readonly description: string,
+//     readonly usedInPages: { pageNumber: number; pagePrefix: PagePrefixValue }[],
+//   ) {}
+//   getLabel(): string {
+//     return this.tag + " (" + this.usedInPages.length + ")";
+//   }
+//   getTooltip(): string {
+//     return this.description;
+//   }
+//   getSearchString(): string {
+//     return this.tag;
+//   }
+// }
+
+// class SelectableCollection<T> {
+//   private readonly _items: Array<T>;
+//   private selected: T | false = false;
+//   constructor(items: ReadonlyArray<T>) {
+//     this._items = [...items];
+//   }
+// }

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

@@ -0,0 +1,68 @@
+import { SumScoreVariableCollection } from "./sum-score-variable-collection";
+import { SumScoreVariable } from "./sum-score-variable";
+
+const v = (name: string) => {
+  return SumScoreVariable.create({ name, description: "description for " + name, useAvg: true });
+};
+
+let empty = SumScoreVariableCollection.create([]);
+beforeEach(() => {
+  empty = SumScoreVariableCollection.create([]);
+});
+describe("Sum-score-variable-collection", () => {
+  test("Add, update, delete works", () => {
+    const v1 = empty.addNew({ name: "v1", description: "v1 desc", useAvg: true });
+    const v2 = empty.addNew({ name: "v2", description: "v2 desc", useAvg: true });
+
+    const v2_updated = empty._updateOne(v2.id, { name: "n2", description: "d2", useAvg: false });
+    expect(v2_updated).toBeTruthy();
+    expect(empty.size).toBe(2);
+    const variable = empty._getVariableById(v2.id);
+    expect(variable).toBeDefined();
+    expect(variable!.name).toBe("n2");
+    expect(variable!.description).toBe("d2");
+    expect(variable!.useAvg).toBe(false);
+    empty._deleteVariable(v1.id);
+    expect(empty.size).toBe(1);
+  });
+  test("Duplicate names are detected", () => {
+    const v1 = empty.addNew({ name: "v1", description: "desc", useAvg: true });
+    const v2 = empty.addNew({ name: "v1", description: "desc", useAvg: true });
+    expect(v1.hasErrors).toBe(true);
+    expect(v2.hasErrors).toBe(true);
+  });
+  test("Error are removed on update", () => {
+    const v1 = empty.addNew({ name: "v1", description: "desc", useAvg: true });
+    const v2 = empty.addNew({ name: "v1", description: "desc", useAvg: true });
+    expect(v1.hasErrors).toBe(true);
+    expect(v2.hasErrors).toBe(true);
+    empty._updateOne(v1.id, { name: "updated-name-updated" });
+    expect(v1.hasErrors).toBe(false);
+    expect(v2.hasErrors).toBe(false);
+  });
+  test("Error are removed on delete", () => {
+    const v1 = empty.addNew({ name: "v1", description: "desc", useAvg: true });
+    const v2 = empty.addNew({ name: "v1", description: "desc", useAvg: true });
+    expect(v1.hasErrors).toBe(true);
+    expect(v2.hasErrors).toBe(true);
+    empty._deleteVariable(v1.id);
+
+    expect(empty.size).toBe(1);
+    expect(v2.hasErrors).toBe(false);
+  });
+  test("Error are detected on construction", () => {
+    const col = SumScoreVariableCollection.create([v("v1"), v("v1")]);
+    expect(col.errorsCount).toBe(2);
+  });
+
+  test("Error are detected after init", () => {
+    const col = SumScoreVariableCollection.create([]);
+    const v1 = v("v1");
+    const v1_duplicate = v("v1");
+    const v3 = v("v3");
+    const v4 = v("v4");
+    col.init([v1, v1_duplicate, v3, v4]);
+    expect(col.errorsCount).toBe(2);
+    expect(col.size).toBe(4);
+  });
+});

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

@@ -0,0 +1,101 @@
+import { SumScoreVariable, SumScoreVariableDto } from "./sum-score-variable";
+import { SumScoreVariableID } from "../primitives/ID";
+
+export class SumScoreVariableCollection implements Iterable<SumScoreVariable> {
+  private _all: Array<SumScoreVariable> = [];
+
+  [Symbol.iterator]() {
+    const list = [...this._all];
+    return list[Symbol.iterator]();
+  }
+
+  asArray(): ReadonlyArray<SumScoreVariable> {
+    return [...this._all];
+  }
+
+  public static readonly create = (
+    variables?: SumScoreVariableDto[],
+  ): SumScoreVariableCollection => {
+    return new SumScoreVariableCollection(variables);
+  };
+
+  private constructor(sumScoreVariables?: SumScoreVariableDto[]) {
+    const all = Array.isArray(sumScoreVariables) ? sumScoreVariables : [];
+    this._all = all.map((dto) => SumScoreVariable.fromDto(dto));
+    this.checkForErrors();
+  }
+
+  init(variables: SumScoreVariableDto[]) {
+    this._all = variables.map((variable) => SumScoreVariable.fromDto(variable));
+    this.checkForErrors();
+  }
+  addNew(options: { name: string; description: string; useAvg: boolean }) {
+    // console.log(options);
+    const newVariable = SumScoreVariable.create({ ...options });
+    this._all.push(newVariable);
+    this.checkForErrors();
+    return newVariable;
+  }
+
+  get size() {
+    return this._all.length;
+  }
+
+  get errorsCount() {
+    return this._all.filter((variable) => variable.hasErrors).length;
+  }
+
+  toJson() {
+    return this._all.map((item) => item.toJson());
+  }
+
+  /**
+   *
+   */
+  _deleteVariable(id: SumScoreVariableID) {
+    const initialSize = this._all.length;
+    this._all = this._all.filter((variable) => variable.id !== id);
+    this.checkForErrors();
+    return initialSize === this.size + 1;
+  }
+
+  /**
+   * @internal
+   */
+  _updateOne(
+    id: SumScoreVariableID,
+    updates: { name?: string; description?: string; useAvg?: boolean },
+  ): boolean {
+    const variable = this._all.find((variable) => variable.id === id);
+    if (variable) {
+      variable._update(updates);
+      this.checkForErrors();
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  /** @internal */
+  _getVariableById(id: SumScoreVariableID): SumScoreVariable | undefined {
+    return this._all.find((variable) => variable.id === id);
+  }
+
+  private checkForErrors() {
+    const nameMap = new Map<string, SumScoreVariable[]>();
+    this._all.forEach((v) => {
+      const array = nameMap.get(v.name) ?? [];
+      array.push(v);
+      nameMap.set(v.name, array);
+    });
+    nameMap.forEach((sameNameArray) => {
+      sameNameArray.forEach((sameNameItem) => {
+        if (sameNameArray.length > 1) {
+          sameNameItem._setError("Duplicate name");
+        } else {
+          sameNameItem._setError("");
+        }
+      });
+    });
+  }
+}