@media-quest/engine 0.0.35 → 0.0.37

package/src/engine/dplayer.spec.ts

@@ -1,91 +1,92 @@
-import { DPlayer, DPlayerData } from "./dplayer";
-import { PageSequenceDto } from "./SchemaDto";
-import { Rule } from "../rules/rule";
-import { DTimestamp } from "../common/DTimestamp";
-import { RuleActionPageQue } from "./page-que-ruleengine-action";
-import { PageDto } from "../page/Page";
-import { PageResult } from "../page/page-result";
-
-const page = (id: number): PageDto => {
-  return PageDto.createDummy(id);
-  // return { id: PageID.create(), elements: [] };
-};
-const p1 = page(1);
-const p2 = page(2);
-const p3 = page(3);
-const p4 = page(4);
-const p5 = page(5);
-const p6 = page(6);
-const all = [p1, p2, p3, p4, p5, p6];
-const Seq1 = {
-  p10: page(10),
-  p11: page(11),
-  p12: page(12),
-};
-
-const seq1: PageSequenceDto = {
-  id: "s1",
-  pages: [Seq1.p10, Seq1.p11, Seq1.p12],
-  rules: [],
-};
-const data = (
-  pages: PageDto[],
-  pageSequences: PageSequenceDto[] = [],
-  rules: Rule<RuleActionPageQue, never>[] = [],
-): DPlayerData => ({ pages: pages, pageSequences, rules });
-// const seq = (pages: PageDto[], rules: Rule[]) => {};
-beforeEach(() => {
-  // data = { pages: [], rules: [], pageSequences: [] };
-});
-
-describe("DPlayer", () => {
-  it("should create an instance", () => {
-    const player = new DPlayer(data([p1, p1]));
-    expect(player).toBeTruthy();
-  });
-
-  it("can app pages, and get next", () => {
-    const player = new DPlayer(data([p1, p2]));
-
-    expect(player.getNextPage()).toBe(p1);
-    expect(player.getNextPage()).toBe(p2);
-    expect(player.getNextPage()).toBe(false);
-  });
-
-  it("Can insert a sequence", () => {
-    const player = new DPlayer(data(all, [seq1]));
-
-    expect(player.getNextPage()).toBe(p1);
-    expect(player.getNextPage()).toBe(p2);
-    player.insertSequence(seq1.id);
-    expect(player.getNextPage()).toBe(Seq1.p10);
-    expect(player.getNextPage()).toBe(Seq1.p11);
-    expect(player.getNextPage()).toBe(Seq1.p12);
-    expect(player.getNextPage()).toBe(p3);
-  });
-
-  it("Save history", () => {
-    const player = new DPlayer(data(all));
-
-    const curr = player.getNextPage() as PageDto;
-
-    const result: PageResult = {
-      pageId: curr.id,
-      pagePrefix: curr.id,
-      eventLog: [],
-      pageTime: DTimestamp.diff(DTimestamp.now(), DTimestamp.now()),
-      collectedFacts: [
-        {
-          referenceId: "as",
-          referenceLabel: "as-label",
-          kind: "numeric-fact",
-          label: "litt",
-          value: 2,
-        },
-      ],
-    };
-    player.saveHistory(result);
-    expect(player.getNextPage()).toBe(p2);
-    expect(player.getResults().answerFacts.length).toBe(1);
-  });
-});
+import { DPlayer, DPlayerData } from "./dplayer";
+import { PageSequenceDto } from "./SchemaDto";
+import { Rule } from "../rules/rule";
+import { DTimestamp } from "../common/DTimestamp";
+import { RuleActionPageQue } from "./page-que-ruleengine-action";
+import { PageDto } from "../page/Page";
+import { PageResult } from "../page/page-result";
+
+const page = (id: number): PageDto => {
+  return PageDto.createDummy(id);
+  // return { id: PageID.create(), elements: [] };
+};
+const p1 = page(1);
+const p2 = page(2);
+const p3 = page(3);
+const p4 = page(4);
+const p5 = page(5);
+const p6 = page(6);
+const all = [p1, p2, p3, p4, p5, p6];
+const Seq1 = {
+  p10: page(10),
+  p11: page(11),
+  p12: page(12),
+};
+
+const seq1: PageSequenceDto = {
+  id: "s1",
+  pages: [Seq1.p10, Seq1.p11, Seq1.p12],
+  rules: [],
+};
+const data = (
+  pages: PageDto[],
+  pageSequences: PageSequenceDto[] = [],
+  rules: Rule<RuleActionPageQue, never>[] = [],
+): DPlayerData => ({ pages: pages, pageSequences, rules });
+// const seq = (pages: PageDto[], rules: Rule[]) => {};
+beforeEach(() => {
+  // data = { pages: [], rules: [], pageSequences: [] };
+});
+
+describe("DPlayer", () => {
+  it("should create an instance", () => {
+    const player = new DPlayer(data([p1, p1]));
+    expect(player).toBeTruthy();
+  });
+
+  it("can app pages, and get next", () => {
+    const player = new DPlayer(data([p1, p2]));
+
+    expect(player.getNextPage()).toBe(p1);
+    expect(player.getNextPage()).toBe(p2);
+    expect(player.getNextPage()).toBe(false);
+  });
+
+  it("Can insert a sequence", () => {
+    const player = new DPlayer(data(all, [seq1]));
+
+    expect(player.getNextPage()).toBe(p1);
+    expect(player.getNextPage()).toBe(p2);
+    player.insertSequence(seq1.id);
+    expect(player.getNextPage()).toBe(Seq1.p10);
+    expect(player.getNextPage()).toBe(Seq1.p11);
+    expect(player.getNextPage()).toBe(Seq1.p12);
+    expect(player.getNextPage()).toBe(p3);
+  });
+
+  it("Save history", () => {
+    const player = new DPlayer(data(all));
+
+    const curr = player.getNextPage() as PageDto;
+
+    const result: PageResult = {
+      pageId: curr.id,
+      pagePrefix: curr.id,
+      pageNumber: 1,
+      eventLog: [],
+      pageTime: DTimestamp.diff(DTimestamp.now(), DTimestamp.now()),
+      collectedFacts: [
+        {
+          referenceId: "as",
+          referenceLabel: "as-label",
+          kind: "numeric-fact",
+          label: "litt",
+          value: 2,
+        },
+      ],
+    };
+    player.saveHistory(result);
+    expect(player.getNextPage()).toBe(p2);
+    expect(player.getResults().answerFacts.length).toBe(1);
+  });
+});

package/src/engine/dplayer.ts

@@ -28,10 +28,10 @@ export class DPlayer {
     this.eventLog.push(event);
   }
 
-  saveHistory(pageHistory: PageResult) {
+  saveHistory(pageResult: PageResult) {
     // console.log("SAVE HISTORY", pageHistory);
-    this.history.addToHistory(pageHistory);
-    this.eventLog.push(...pageHistory.eventLog);
+    this.history.addToHistory(pageResult);
+    this.eventLog.push(...pageResult.eventLog);
     // Evaluate rules
     const userGeneratedFact = this.history.getFacts();
     const predefinedFacts = this.predefinedFacts;
@@ -65,8 +65,10 @@ export class DPlayer {
     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 };
+    return { answerFacts, predefinedFacts, eventLog, pagesLeft, pageResults };
   }
 
   insertSequence(sequenceId: string) {

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

@@ -8,6 +8,7 @@ const p = (id: number): PageDto => {
   return {
     id: DUtil.randomObjectId(),
     prefix: "prefix" + id,
+    pageNumber: id,
     elements: [],
     initialTasks: [],
     // staticElements: [],
@@ -16,7 +17,7 @@ const p = (id: number): PageDto => {
   };
 };
 
-const pageResult = (id: number, value: number): PageResult => {
+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);
@@ -24,6 +25,7 @@ const pageResult = (id: number, value: number): PageResult => {
   const result: PageResult = {
     pageId: "_dummyId" + id,
     pagePrefix: "prefix" + id,
+    pageNumber,
     eventLog: [],
     pageTime,
     collectedFacts: [
@@ -61,7 +63,7 @@ describe("HistoryQue", () => {
   });
 
   it("Can add history, and get facts back", () => {
-    history.addToHistory(pageResult(1, 2));
+    history.addToHistory(pageResult(1, 0, 2));
     expect(history.getFacts().length).toBe(1);
   });
 });

package/src/engine/history-que.ts

@@ -1,17 +1,21 @@
-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);
-  }
-}
+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);
+  }
+}

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

@@ -10,6 +10,7 @@ let que = new NextQue();
 const createPage = (tags: string[]): PageDto => {
   const dto: PageDto = {
     id: DUtil.randomObjectId(),
+    pageNumber: 1,
     prefix: "prefix",
     elements: [],
     background: "white",

package/src/engine/next-que.ts

@@ -1,101 +1,101 @@
-import { PageDto } from "../page/Page";
-
-export class NextQue {
-  private originalOrder: ReadonlyArray<string> = [];
-  private allPages: PageDto[] = [];
-  private excludedTags = new Set<string>();
-  private excludedByPageId = new Set<string>();
-  private remaining: PageDto[] = [];
-  constructor(pages: PageDto[] = []) {
-    this.resetQue(pages);
-  }
-
-  /**
-   * Will reset que with the new pages.
-   * @param pages
-   */
-  resetQue(pages: PageDto[]) {
-    this.allPages = [...pages];
-    this.remaining = [...pages];
-    this.excludedTags = new Set();
-    this.excludedByPageId = new Set();
-    this.originalOrder = this.allPages.map((p) => p.id);
-  }
-
-  pop(): PageDto | false {
-    const next = this.remaining.shift();
-    // TODO CLONE??
-    return next ?? false;
-  }
-
-  peek(): PageDto | false {
-    const next = this.remaining[0];
-    return next ?? false;
-  }
-
-  jumpToPageById(pageId: string): boolean {
-    const index = this.remaining.findIndex((p) => p.id === pageId);
-    if (index < 0) {
-      return false;
-    }
-    this.remaining = this.remaining.slice(index);
-    return true;
-  }
-
-  removeByTag(tag: string | string[]) {
-    if (Array.isArray(tag)) {
-      tag.forEach((tag) => {
-        this.excludedTags.add(tag);
-      });
-    } else {
-      this.excludedTags.add(tag);
-    }
-    this.filterRemaining();
-  }
-
-  /**
-   * Will not be included
-   * @param pages
-   */
-  insertAsNextByForce(pages: PageDto[]) {
-    this.remaining.unshift(...pages);
-  }
-
-  removeByPageId(pageId: string | string[]) {
-    if (Array.isArray(pageId)) {
-      pageId.forEach((id) => {
-        this.excludedByPageId.add(id);
-      });
-    } else {
-      this.excludedByPageId.add(pageId);
-    }
-    this.filterRemaining();
-    // this.excludedByPageId.add(pageId);
-  }
-
-  private filterRemaining() {
-    this.remaining = this.remaining.filter((p) => {
-      const tags = p.tags ?? [];
-      const isIncluededByTag = !tags.some((tag) => this.excludedTags.has(tag));
-      const isIncludedByPageId = !this.excludedByPageId.has(p.id);
-      return isIncludedByPageId && isIncluededByTag;
-    });
-  }
-  get isEmpty(): boolean {
-    return this.remaining.length === 0;
-  }
-
-  /**
-   * Total number of pages left in que
-   */
-  get size(): number {
-    return this.remaining.length;
-  }
-
-  /**
-   * Total number of pages in test
-   */
-  get pageCount(): number {
-    return this.originalOrder.length;
-  }
-}
+import { PageDto } from "../page/Page";
+
+export class NextQue {
+  private originalOrder: ReadonlyArray<string> = [];
+  private allPages: PageDto[] = [];
+  private excludedTags = new Set<string>();
+  private excludedByPageId = new Set<string>();
+  private remaining: PageDto[] = [];
+  constructor(pages: PageDto[] = []) {
+    this.resetQue(pages);
+  }
+
+  /**
+   * Will reset que with the new pages.
+   * @param pages
+   */
+  resetQue(pages: PageDto[]) {
+    this.allPages = [...pages];
+    this.remaining = [...pages];
+    this.excludedTags = new Set();
+    this.excludedByPageId = new Set();
+    this.originalOrder = this.allPages.map((p) => p.id);
+  }
+
+  pop(): PageDto | false {
+    const next = this.remaining.shift();
+    // TODO CLONE??
+    return next ?? false;
+  }
+
+  peek(): PageDto | false {
+    const next = this.remaining[0];
+    return next ?? false;
+  }
+
+  jumpToPageById(pageId: string): boolean {
+    const index = this.remaining.findIndex((p) => p.id === pageId);
+    if (index < 0) {
+      return false;
+    }
+    this.remaining = this.remaining.slice(index);
+    return true;
+  }
+
+  removeByTag(tag: string | string[]) {
+    if (Array.isArray(tag)) {
+      tag.forEach((tag) => {
+        this.excludedTags.add(tag);
+      });
+    } else {
+      this.excludedTags.add(tag);
+    }
+    this.filterRemaining();
+  }
+
+  /**
+   * Will not be included
+   * @param pages
+   */
+  insertAsNextByForce(pages: PageDto[]) {
+    this.remaining.unshift(...pages);
+  }
+
+  removeByPageId(pageId: string | string[]) {
+    if (Array.isArray(pageId)) {
+      pageId.forEach((id) => {
+        this.excludedByPageId.add(id);
+      });
+    } else {
+      this.excludedByPageId.add(pageId);
+    }
+    this.filterRemaining();
+    // this.excludedByPageId.add(pageId);
+  }
+
+  private filterRemaining() {
+    this.remaining = this.remaining.filter((p) => {
+      const tags = p.tags ?? [];
+      const isIncluededByTag = !tags.some((tag) => this.excludedTags.has(tag));
+      const isIncludedByPageId = !this.excludedByPageId.has(p.id);
+      return isIncludedByPageId && isIncluededByTag;
+    });
+  }
+  get isEmpty(): boolean {
+    return this.remaining.length === 0;
+  }
+
+  /**
+   * Total number of pages left in que
+   */
+  get size(): number {
+    return this.remaining.length;
+  }
+
+  /**
+   * Total number of pages in test
+   */
+  get pageCount(): number {
+    return this.originalOrder.length;
+  }
+}

package/src/events/mq-events.ts

@@ -1,63 +1,76 @@
-import { DTimestamp } from "../common/DTimestamp";
-
-interface _MqEvent<K extends string, P extends object> {
-  readonly kind: K;
-  readonly timestamp: DTimestamp;
-  readonly payload: P;
-}
-
-export type MqEventEngineStart = _MqEvent<
-  "engine-start",
-  {
-    readonly schemaId: string;
-    readonly schemaPrefix: string;
-  }
->;
-export interface MqEventPageEnter
-  extends _MqEvent<"page-enter", { readonly pageId: string; readonly pagePrefix: string }> {}
-export interface MqEventPageLeave
-  extends _MqEvent<"page-leave", { readonly pageId: string; readonly pagePrefix: string }> {}
-
-export type MqEventUserClicked = _MqEvent<
-  "user-clicked",
-  { readonly pageId: string; pagePrefix: string; action: string; descriptions: string }
->;
-
-export type MqEvent = MqEventPageEnter | MqEventPageLeave | MqEventEngineStart | MqEventUserClicked;
-
-export const MqEvent = {
-  engineStart(schemaId: string, schemaPrefix: string): MqEventEngineStart {
-    return {
-      kind: "engine-start",
-      timestamp: DTimestamp.now(),
-      payload: { schemaId, schemaPrefix },
-    };
-  },
-  pageEnter(pageId: string, pagePrefix: string): MqEventPageEnter {
-    return {
-      kind: "page-enter",
-      timestamp: DTimestamp.now(),
-      payload: { pageId, pagePrefix },
-    };
-  },
-  pageLeave(pageId: string, pagePrefix: string): MqEventPageLeave {
-    return {
-      kind: "page-leave",
-      timestamp: DTimestamp.now(),
-      payload: { pageId, pagePrefix },
-    };
-  },
-  userClicked(data: {
-    pageId: string;
-    pagePrefix: string;
-    action: string;
-    descriptions: string;
-  }): MqEventUserClicked {
-    const { pageId, pagePrefix, action, descriptions } = data;
-    return {
-      kind: "user-clicked",
-      timestamp: DTimestamp.now(),
-      payload: { pageId, pagePrefix, action, descriptions },
-    };
-  },
-} as const;
+import { DTimestamp } from "../common/DTimestamp";
+interface _MqEvent<K extends string, P extends object> {
+  readonly kind: K;
+  readonly timestamp: DTimestamp;
+  readonly payload: P;
+}
+
+export type MqEventEngineStart = _MqEvent<
+  "engine-start",
+  {
+    readonly schemaId: string;
+    readonly schemaPrefix: string;
+  }
+>;
+export interface MqEventPageEnter
+  extends _MqEvent<
+    "page-enter",
+    { readonly pageId: string; readonly pageNumber: number; readonly pagePrefix: string }
+  > {}
+
+export interface MqEventPageLeave
+  extends _MqEvent<
+    "page-leave",
+    { readonly pageId: string; readonly pageNumber: number; readonly pagePrefix: string }
+  > {}
+
+export type MqEventUserClicked = _MqEvent<
+  "user-clicked",
+  {
+    readonly pageId: string;
+    readonly pagePrefix: string;
+    readonly pageNumber: number;
+    action: string;
+    descriptions: string;
+  }
+>;
+
+export type MqEvent = MqEventPageEnter | MqEventPageLeave | MqEventEngineStart | MqEventUserClicked;
+
+export const MqEvent = {
+  engineStart(schemaId: string, schemaPrefix: string): MqEventEngineStart {
+    return {
+      kind: "engine-start",
+      timestamp: DTimestamp.now(),
+      payload: { schemaId, schemaPrefix },
+    };
+  },
+  pageEnter(pageId: string, pagePrefix: string, pageNumber: number): MqEventPageEnter {
+    return {
+      kind: "page-enter",
+      timestamp: DTimestamp.now(),
+      payload: { pageId, pagePrefix, pageNumber },
+    };
+  },
+  pageLeave(pageId: string, pagePrefix: string, pageNumber: number): MqEventPageLeave {
+    return {
+      kind: "page-leave",
+      timestamp: DTimestamp.now(),
+      payload: { pageId, pagePrefix, pageNumber },
+    };
+  },
+  userClicked(data: {
+    pageId: string;
+    pagePrefix: string;
+    pageNumber: number;
+    action: string;
+    descriptions: string;
+  }): MqEventUserClicked {
+    const { pageId, pageNumber, pagePrefix, action, descriptions } = data;
+    return {
+      kind: "user-clicked",
+      timestamp: DTimestamp.now(),
+      payload: { pageId, pagePrefix, action, descriptions, pageNumber },
+    };
+  },
+} as const;