@media-quest/engine 0.0.39 → 0.0.41

package/src/engine/dplayer.ts

@@ -1,106 +1,104 @@
-import { HistoryQue } from "./history-que";
-import { RuleEngine } from "../rules/rule-engine";
-import { NextQue } from "./next-que";
-import { SchemaDto } from "./SchemaDto";
-import { RuleActionPageQue } from "./page-que-ruleengine-action";
-import { PageDto } from "../page/Page";
-import { PageResult } from "../page/page-result";
-import { Fact } from "../rules/fact";
-import { MqEvent } from "../events/mq-events";
-
-export type DPlayerData = Pick<SchemaDto, "pages" | "pageSequences" | "rules" | "predefinedFacts">;
-export class DPlayer {
-  private readonly eventLog: Array<MqEvent> = [];
-  private history = new HistoryQue();
-  private ruleEngine = new RuleEngine<RuleActionPageQue, never>();
-  private nextQue = new NextQue();
-  private data: DPlayerData;
-  private readonly predefinedFacts: ReadonlyArray<Fact>;
-
-  constructor(data: DPlayerData) {
-    this.data = data;
-    const pages = data.pages ?? [];
-    this.predefinedFacts = data.predefinedFacts ? [...data.predefinedFacts] : [];
-    this.nextQue.resetQue(pages);
-  }
-
-  saveEvent(event: MqEvent) {
-    this.eventLog.push(event);
-  }
-
-  saveHistory(pageResult: PageResult) {
-    // console.log("SAVE HISTORY", pageHistory);
-    this.history.addToHistory(pageResult);
-    this.eventLog.push(...pageResult.eventLog);
-    // Evaluate rules
-    const userGeneratedFact = this.history.getFacts();
-    const predefinedFacts = this.predefinedFacts;
-    const facts = [...userGeneratedFact, ...predefinedFacts];
-    const result = this.ruleEngine.solveAll(this.data.rules, facts);
-
-    const matchingRules = result.matching;
-    const actions = matchingRules.map((r) => r.actionList).flat(1);
-    // Execute actions
-    actions.forEach((a) => {
-      // console.log(a.payload);
-      switch (a.kind) {
-        case "jumpToPage":
-          this.nextQue.jumpToPageById(a.pageId);
-          break;
-        case "excludeByPageId":
-          this.nextQue.removeByPageId(a.pageIds);
-          break;
-        case "excludeByTag":
-          this.nextQue.removeByTag(a.tagIds);
-          break;
-        default:
-          console.log("UNKNOWN ACTION", a);
-          const check: never = a;
-      }
-    });
-  }
-
-  getResults() {
-    const pagesLeft = this.nextQue.size;
-    const answerFacts = this.history.getFacts();
-    const predefinedFacts = this.predefinedFacts;
-    const eventLog = [...this.eventLog];
-    const pageResults = this.history.getPageResults();
-    // const pageResults = this.history.;
-    // console.log(answerFacts);
-    return { answerFacts, predefinedFacts, eventLog, pagesLeft, pageResults };
-  }
-
-  insertSequence(sequenceId: string) {
-    this.insertSequenceById(sequenceId);
-  }
-
-  getNextPage(): PageDto | false {
-    const next = this.nextQue.pop();
-    return next ?? false;
-  }
-
-  private insertSequenceById(id: string) {
-    const seq = this.data.pageSequences?.find((s) => s.id === id);
-    if (seq) {
-      this.nextQue.insertAsNextByForce([...seq.pages]);
-    } else {
-      // HOW TO HANDLE INVALID ID_REFS?? LOGGER??
-      // LOG INVALID COMMAND.
-    }
-  }
-
-  /**
-   * Total number of pages left in que
-   */
-  get pagesLeft(): number {
-    return this.nextQue.pageCount;
-  }
-
-  /**
-   * Total number of pages in test
-   */
-  get totalPageCount(): number {
-    return this.data.pages.length;
-  }
-}
+import { HistoryQue } from "./history-que";
+import { RuleEngine } from "../rules/rule-engine";
+import { NextQue } from "./next-que";
+import { SchemaDto } from "./SchemaDto";
+import { RuleActionPageQue } from "./page-que-ruleengine-action";
+import { PageDto } from "../page/Page";
+import { PageResult } from "../page/page-result";
+import { Fact } from "../rules/fact";
+import { MqEvent } from "../events/mq-events";
+
+export type DPlayerData = Pick<SchemaDto, "pages" | "pageSequences" | "rules" | "predefinedFacts">;
+export class DPlayer {
+  private readonly eventLog: Array<MqEvent> = [];
+  private history = new HistoryQue();
+  private ruleEngine = new RuleEngine<RuleActionPageQue, never>();
+  private nextQue = new NextQue();
+  private data: DPlayerData;
+  private readonly predefinedFacts: ReadonlyArray<Fact>;
+
+  constructor(data: DPlayerData) {
+    this.data = data;
+    const pages = data.pages ?? [];
+    this.predefinedFacts = data.predefinedFacts ? [...data.predefinedFacts] : [];
+    this.nextQue.resetQue(pages);
+  }
+
+  saveEvent(event: MqEvent) {
+    this.eventLog.push(event);
+  }
+
+  saveHistory(pageHistory: PageResult) {
+    // console.log("SAVE HISTORY", pageHistory);
+    this.history.addToHistory(pageHistory);
+    this.eventLog.push(...pageHistory.eventLog);
+    // Evaluate rules
+    const userGeneratedFact = this.history.getFacts();
+    const predefinedFacts = this.predefinedFacts;
+    const facts = [...userGeneratedFact, ...predefinedFacts];
+    const result = this.ruleEngine.solveAll(this.data.rules, facts);
+
+    const matchingRules = result.matching;
+    const actions = matchingRules.map((r) => r.actionList).flat(1);
+    // Execute actions
+    actions.forEach((a) => {
+      // console.log(a.payload);
+      switch (a.kind) {
+        case "jumpToPage":
+          this.nextQue.jumpToPageById(a.pageId);
+          break;
+        case "excludeByPageId":
+          this.nextQue.removeByPageId(a.pageIds);
+          break;
+        case "excludeByTag":
+          this.nextQue.removeByTag(a.tagIds);
+          break;
+        default:
+          console.log("UNKNOWN ACTION", a);
+          const check: never = a;
+      }
+    });
+  }
+
+  getResults() {
+    const pagesLeft = this.nextQue.size;
+    const answerFacts = this.history.getFacts();
+    const predefinedFacts = this.predefinedFacts;
+    const eventLog = [...this.eventLog];
+    // console.log(answerFacts);
+    return { answerFacts, predefinedFacts, eventLog, pagesLeft };
+  }
+
+  insertSequence(sequenceId: string) {
+    this.insertSequenceById(sequenceId);
+  }
+
+  getNextPage(): PageDto | false {
+    const next = this.nextQue.pop();
+    return next ?? false;
+  }
+
+  private insertSequenceById(id: string) {
+    const seq = this.data.pageSequences?.find((s) => s.id === id);
+    if (seq) {
+      this.nextQue.insertAsNextByForce([...seq.pages]);
+    } else {
+      // HOW TO HANDLE INVALID ID_REFS?? LOGGER??
+      // LOG INVALID COMMAND.
+    }
+  }
+
+  /**
+   * Total number of pages left in que
+   */
+  get pagesLeft(): number {
+    return this.nextQue.pageCount;
+  }
+
+  /**
+   * Total number of pages in test
+   */
+  get totalPageCount(): number {
+    return this.data.pages.length;
+  }
+}

package/src/engine/history-que.spec.ts

@@ -1,69 +1,67 @@
-import { HistoryQue } from "./history-que";
-import { DTimestamp } from "../common/DTimestamp";
-import { PageDto } from "../page/Page";
-import { PageResult } from "../page/page-result";
-import { DUtil } from "../utils/DUtil";
-
-const p = (id: number): PageDto => {
-  return {
-    id: DUtil.randomObjectId(),
-    prefix: "prefix" + id,
-    pageNumber: id,
-    elements: [],
-    initialTasks: [],
-    // staticElements: [],
-    background: "",
-    tags: [],
-  };
-};
-
-const pageResult = (id: number, pageNumber: number, value: number): PageResult => {
-  const pageEntered = DTimestamp.now();
-  const pageExited = DTimestamp.addMills(pageEntered, 1000);
-  const pageTime = DTimestamp.diff(pageEntered, pageExited);
-
-  const result: PageResult = {
-    pageId: "_dummyId" + id,
-    pagePrefix: "prefix" + id,
-    pageNumber,
-    eventLog: [],
-    pageTime,
-    collectedFacts: [
-      {
-        referenceId: "" + id,
-        referenceLabel: "label-for-" + id,
-        value,
-        label: "value-label " + value,
-        kind: "numeric-fact",
-      },
-    ],
-  };
-  return result;
-};
-// const h = (page: PageDto, answeredQuestions: AnsweredQuestion[]): PageResult => ({
-//   pageId: page.id,
-//   answeredQuestions,
-// });
-const p1 = p(1);
-const p2 = p(2);
-const p3 = p(3);
-const p4 = p(4);
-const p5 = p(5);
-const p6 = p(6);
-const all = [p1, p2, p3, p4, p5, p6];
-
-let history = new HistoryQue();
-beforeEach(() => {
-  history = new HistoryQue();
-});
-
-describe("HistoryQue", () => {
-  it("should create an instance", () => {
-    expect(history).toBeTruthy();
-  });
-
-  it("Can add history, and get facts back", () => {
-    history.addToHistory(pageResult(1, 0, 2));
-    expect(history.getFacts().length).toBe(1);
-  });
-});
+import { HistoryQue } from "./history-que";
+import { DTimestamp } from "../common/DTimestamp";
+import { PageDto } from "../page/Page";
+import { PageResult } from "../page/page-result";
+import { DUtil } from "../utils/DUtil";
+
+const p = (id: number): PageDto => {
+  return {
+    id: DUtil.randomObjectId(),
+    prefix: "prefix" + id,
+    elements: [],
+    initialTasks: [],
+    // staticElements: [],
+    background: "",
+    tags: [],
+  };
+};
+
+const pageResult = (id: number, value: number): PageResult => {
+  const pageEntered = DTimestamp.now();
+  const pageExited = DTimestamp.addMills(pageEntered, 1000);
+  const pageTime = DTimestamp.diff(pageEntered, pageExited);
+
+  const result: PageResult = {
+    pageId: "_dummyId" + id,
+    pagePrefix: "prefix" + id,
+    eventLog: [],
+    pageTime,
+    collectedFacts: [
+      {
+        referenceId: "" + id,
+        referenceLabel: "label-for-" + id,
+        value,
+        label: "value-label " + value,
+        kind: "numeric-fact",
+      },
+    ],
+  };
+  return result;
+};
+// const h = (page: PageDto, answeredQuestions: AnsweredQuestion[]): PageResult => ({
+//   pageId: page.id,
+//   answeredQuestions,
+// });
+const p1 = p(1);
+const p2 = p(2);
+const p3 = p(3);
+const p4 = p(4);
+const p5 = p(5);
+const p6 = p(6);
+const all = [p1, p2, p3, p4, p5, p6];
+
+let history = new HistoryQue();
+beforeEach(() => {
+  history = new HistoryQue();
+});
+
+describe("HistoryQue", () => {
+  it("should create an instance", () => {
+    expect(history).toBeTruthy();
+  });
+
+  it("Can add history, and get facts back", () => {
+    history.addToHistory(pageResult(1, 2));
+    expect(history.getFacts().length).toBe(1);
+  });
+});

package/src/engine/history-que.ts

@@ -1,21 +1,17 @@
-import { Fact } from "../rules/fact";
-import { PageResult } from "../page/page-result";
-
-export class HistoryQue {
-  private history: PageResult[] = [];
-
-  getFacts(): Array<Fact> {
-    const answers = this.history.map((h) => h.collectedFacts).flat(1);
-    // const facts = answers.map((a) => a.fact);
-    // TODO FIND LATEST FACT (answer) if have multiple.
-    return answers;
-  }
-
-  getPageResults(): PageResult[] {
-    return [...this.history];
-  }
-
-  addToHistory(result: PageResult) {
-    this.history.push(result);
-  }
-}
+import { Fact } from "../rules/fact";
+import { PageResult } from "../page/page-result";
+
+export class HistoryQue {
+  private history: PageResult[] = [];
+
+  getFacts(): Array<Fact> {
+    const answers = this.history.map((h) => h.collectedFacts).flat(1);
+    // const facts = answers.map((a) => a.fact);
+    // TODO FIND LATEST FACT (answer) if have multiple.
+    return answers;
+  }
+
+  addToHistory(result: PageResult) {
+    this.history.push(result);
+  }
+}

package/src/engine/next-que.spec.ts

@@ -1,122 +1,121 @@
-import { NextQue } from "./next-que";
-import { PageDto } from "../page/Page";
-import { DUtil } from "../utils/DUtil";
-
-const tag1 = "tag1";
-const tag2 = "tag2";
-const tag3 = "tag3";
-
-let que = new NextQue();
-const createPage = (tags: string[]): PageDto => {
-  const dto: PageDto = {
-    id: DUtil.randomObjectId(),
-    pageNumber: 1,
-    prefix: "prefix",
-    elements: [],
-    background: "white",
-    // components: [],
-    initialTasks: [],
-    tags,
-  };
-  return dto;
-};
-
-const p1 = createPage([tag1]);
-const p2 = createPage([]);
-const p3 = createPage([tag2]);
-const p4 = createPage([]);
-const p5 = createPage([tag3, tag2]);
-const p6 = createPage([tag3]);
-const all = [p1, p2, p3, p4, p5, p6];
-
-beforeEach(() => {
-  que = new NextQue();
-});
-
-describe("NextQue testing", () => {
-  it("Can pop", () => {
-    que.resetQue(all);
-    expect(que.pop()).toBe(p1);
-    expect(que.pop()).toBe(p2);
-    expect(que.size).toBe(all.length - 2);
-  });
-
-  it("Can remove by tag", () => {
-    que.resetQue(all);
-    expect(que.size).toBe(6);
-    que.removeByTag(tag3);
-    expect(que.size).toBe(4);
-    expect(que.peek()).toBe(p1);
-    que.pop();
-    expect(que.peek()).toBe(p2);
-    expect(que.size).toBe(3);
-  });
-
-  it("Can remove by tags[]", () => {
-    que.resetQue(all);
-    que.removeByTag([tag3, tag2, tag1]);
-    expect(que.size).toBe(2);
-  });
-
-  it("Can remove by pageIds[]", () => {
-    que.resetQue(all);
-    que.removeByPageId([p1.id, p2.id, p3.id]);
-    expect(que.pop()).toBe(p4);
-    expect(que.size).toBe(2);
-  });
-
-  it("Can remove by pageId", () => {
-    que.resetQue(all);
-    que.removeByPageId(p1.id);
-    expect(que.peek()).toBe(p2);
-    que.pop();
-    expect(que.peek()).toBe(p3);
-    expect(que.size).toBe(4);
-    que.removeByPageId(p3.id);
-    expect(que.size).toBe(3);
-  });
-
-  it("Can set pages in constuctor", () => {
-    que = new NextQue(all);
-    expect(que.size).toBe(all.length);
-  });
-
-  it("Can set pages in constuctor", () => {
-    que = new NextQue(all);
-    expect(que.size).toBe(all.length);
-  });
-
-  it("Can reset que to start over.", () => {
-    que = new NextQue(all);
-    expect(que.size).toBe(all.length);
-  });
-
-  it("Can insert new pages in the middle of the test.", () => {
-    que = new NextQue(all);
-    que.pop();
-    que.pop();
-    que.pop();
-    expect(que.peek()).toBe(p4);
-    que.insertAsNextByForce([p1, p2]);
-    expect(que.peek()).toBe(p1);
-    expect(que.size).toBe(5);
-    expect(que.pop()).toBe(p1);
-    expect(que.pop()).toBe(p2);
-    expect(que.pop()).toBe(p4);
-  });
-
-  it("Can jump to page by id", () => {
-    que = new NextQue(all);
-    que.pop();
-    que.jumpToPageById(p5.id);
-    // expect(que.size).toBe(5);
-    expect(que.peek()).toBe(p5);
-    que.jumpToPageById("noncence");
-    expect(que.peek()).toBe(p5);
-    // CAn not jump back
-    que.jumpToPageById(p2.id);
-    expect(que.peek()).toBe(p5);
-    que.jumpToPageById(p6.id);
-    expect(que.peek()).toBe(p6);
-  });
-});
+import { NextQue } from "./next-que";
+import { PageDto } from "../page/Page";
+import { DUtil } from "../utils/DUtil";
+
+const tag1 = "tag1";
+const tag2 = "tag2";
+const tag3 = "tag3";
+
+let que = new NextQue();
+const createPage = (tags: string[]): PageDto => {
+  const dto: PageDto = {
+    id: DUtil.randomObjectId(),
+    prefix: "prefix",
+    elements: [],
+    background: "white",
+    // components: [],
+    initialTasks: [],
+    tags,
+  };
+  return dto;
+};
+
+const p1 = createPage([tag1]);
+const p2 = createPage([]);
+const p3 = createPage([tag2]);
+const p4 = createPage([]);
+const p5 = createPage([tag3, tag2]);
+const p6 = createPage([tag3]);
+const all = [p1, p2, p3, p4, p5, p6];
+
+beforeEach(() => {
+  que = new NextQue();
+});
+
+describe("NextQue testing", () => {
+  it("Can pop", () => {
+    que.resetQue(all);
+    expect(que.pop()).toBe(p1);
+    expect(que.pop()).toBe(p2);
+    expect(que.size).toBe(all.length - 2);
+  });
+
+  it("Can remove by tag", () => {
+    que.resetQue(all);
+    expect(que.size).toBe(6);
+    que.removeByTag(tag3);
+    expect(que.size).toBe(4);
+    expect(que.peek()).toBe(p1);
+    que.pop();
+    expect(que.peek()).toBe(p2);
+    expect(que.size).toBe(3);
+  });
+
+  it("Can remove by tags[]", () => {
+    que.resetQue(all);
+    que.removeByTag([tag3, tag2, tag1]);
+    expect(que.size).toBe(2);
+  });
+
+  it("Can remove by pageIds[]", () => {
+    que.resetQue(all);
+    que.removeByPageId([p1.id, p2.id, p3.id]);
+    expect(que.pop()).toBe(p4);
+    expect(que.size).toBe(2);
+  });
+
+  it("Can remove by pageId", () => {
+    que.resetQue(all);
+    que.removeByPageId(p1.id);
+    expect(que.peek()).toBe(p2);
+    que.pop();
+    expect(que.peek()).toBe(p3);
+    expect(que.size).toBe(4);
+    que.removeByPageId(p3.id);
+    expect(que.size).toBe(3);
+  });
+
+  it("Can set pages in constuctor", () => {
+    que = new NextQue(all);
+    expect(que.size).toBe(all.length);
+  });
+
+  it("Can set pages in constuctor", () => {
+    que = new NextQue(all);
+    expect(que.size).toBe(all.length);
+  });
+
+  it("Can reset que to start over.", () => {
+    que = new NextQue(all);
+    expect(que.size).toBe(all.length);
+  });
+
+  it("Can insert new pages in the middle of the test.", () => {
+    que = new NextQue(all);
+    que.pop();
+    que.pop();
+    que.pop();
+    expect(que.peek()).toBe(p4);
+    que.insertAsNextByForce([p1, p2]);
+    expect(que.peek()).toBe(p1);
+    expect(que.size).toBe(5);
+    expect(que.pop()).toBe(p1);
+    expect(que.pop()).toBe(p2);
+    expect(que.pop()).toBe(p4);
+  });
+
+  it("Can jump to page by id", () => {
+    que = new NextQue(all);
+    que.pop();
+    que.jumpToPageById(p5.id);
+    // expect(que.size).toBe(5);
+    expect(que.peek()).toBe(p5);
+    que.jumpToPageById("noncence");
+    expect(que.peek()).toBe(p5);
+    // CAn not jump back
+    que.jumpToPageById(p2.id);
+    expect(que.peek()).toBe(p5);
+    que.jumpToPageById(p6.id);
+    expect(que.peek()).toBe(p6);
+  });
+});