@media-quest/engine 0.0.34 → 0.0.36

package/dist/public-api.d.ts

@@ -40,39 +40,53 @@ type MqEventEngineStart = _MqEvent<"engine-start", {
 }>;
 interface MqEventPageEnter extends _MqEvent<"page-enter", {
     readonly pageId: string;
+    readonly pageNumber: number;
     readonly pagePrefix: string;
 }> {
 }
 interface MqEventPageLeave extends _MqEvent<"page-leave", {
     readonly pageId: string;
+    readonly pageNumber: number;
     readonly pagePrefix: string;
 }> {
 }
 type MqEventUserClicked = _MqEvent<"user-clicked", {
     readonly pageId: string;
-    pagePrefix: string;
+    readonly pagePrefix: string;
+    readonly pageNumber: number;
     action: string;
     descriptions: string;
 }>;
 type MqEvent = MqEventPageEnter | MqEventPageLeave | MqEventEngineStart | MqEventUserClicked;
 declare const MqEvent: {
     readonly engineStart: (schemaId: string, schemaPrefix: string) => MqEventEngineStart;
-    readonly pageEnter: (pageId: string, pagePrefix: string) => MqEventPageEnter;
-    readonly pageLeave: (pageId: string, pagePrefix: string) => MqEventPageLeave;
+    readonly pageEnter: (pageId: string, pagePrefix: string, pageNumber: number) => MqEventPageEnter;
+    readonly pageLeave: (pageId: string, pagePrefix: string, pageNumber: number) => MqEventPageLeave;
     readonly userClicked: (data: {
         pageId: string;
         pagePrefix: string;
+        pageNumber: number;
         action: string;
         descriptions: string;
     }) => MqEventUserClicked;
 };
 
+interface PageResult {
+    readonly pageId: string;
+    readonly pagePrefix: string;
+    readonly pageNumber: number;
+    readonly eventLog: ReadonlyArray<MqEvent>;
+    readonly pageTime: DTimestamp.Diff;
+    readonly collectedFacts: Fact[];
+}
+
 interface SchemaResult {
     readonly schemaId: string;
     readonly pagesLeft: number;
     readonly predefinedFacts: ReadonlyArray<Fact>;
     readonly eventLog: ReadonlyArray<MqEvent>;
     readonly answers: ReadonlyArray<Fact>;
+    readonly pageResults: ReadonlyArray<PageResult>;
 }
 
 type Condition = Condition.String | Condition.Numeric | Condition.Complex;
@@ -438,6 +452,10 @@ interface VideoPlayerDto {
 interface PageDto {
     readonly id: string;
     readonly prefix: string;
+    /**
+     * Page number in the sequence (starts at 1)
+     */
+    readonly pageNumber: number;
     readonly tags: string[];
     background: string;
     elements: Array<DElementDto>;

package/dist/public-api.js

@@ -46,6 +46,9 @@ var HistoryQue = class {
     const answers = this.history.map((h) => h.collectedFacts).flat(1);
     return answers;
   }
+  getPageResults() {
+    return [...this.history];
+  }
   addToHistory(result) {
     this.history.push(result);
   }
@@ -432,9 +435,9 @@ var DPlayer = class {
   saveEvent(event) {
     this.eventLog.push(event);
   }
-  saveHistory(pageHistory) {
-    this.history.addToHistory(pageHistory);
-    this.eventLog.push(...pageHistory.eventLog);
+  saveHistory(pageResult) {
+    this.history.addToHistory(pageResult);
+    this.eventLog.push(...pageResult.eventLog);
     const userGeneratedFact = this.history.getFacts();
     const predefinedFacts = this.predefinedFacts;
     const facts = [...userGeneratedFact, ...predefinedFacts];
@@ -463,7 +466,8 @@ var DPlayer = class {
     const answerFacts = this.history.getFacts();
     const predefinedFacts = this.predefinedFacts;
     const eventLog = [...this.eventLog];
-    return { answerFacts, predefinedFacts, eventLog, pagesLeft };
+    const pageResults = this.history.getPageResults();
+    return { answerFacts, predefinedFacts, eventLog, pagesLeft, pageResults };
   }
   insertSequence(sequenceId) {
     this.insertSequenceById(sequenceId);
@@ -1178,26 +1182,26 @@ var MqEvent = {
       payload: { schemaId, schemaPrefix }
     };
   },
-  pageEnter(pageId, pagePrefix) {
+  pageEnter(pageId, pagePrefix, pageNumber) {
     return {
       kind: "page-enter",
       timestamp: DTimestamp.now(),
-      payload: { pageId, pagePrefix }
+      payload: { pageId, pagePrefix, pageNumber }
     };
   },
-  pageLeave(pageId, pagePrefix) {
+  pageLeave(pageId, pagePrefix, pageNumber) {
     return {
       kind: "page-leave",
       timestamp: DTimestamp.now(),
-      payload: { pageId, pagePrefix }
+      payload: { pageId, pagePrefix, pageNumber }
     };
   },
   userClicked(data) {
-    const { pageId, pagePrefix, action, descriptions } = data;
+    const { pageId, pageNumber, pagePrefix, action, descriptions } = data;
     return {
       kind: "user-clicked",
       timestamp: DTimestamp.now(),
-      payload: { pageId, pagePrefix, action, descriptions }
+      payload: { pageId, pagePrefix, action, descriptions, pageNumber }
     };
   }
 };
@@ -1207,6 +1211,7 @@ var PageDto = {
   createDummy: (id) => {
     return {
       id: "id" + id,
+      pageNumber: id,
       prefix: "prefix" + id,
       tags: [],
       background: "white",
@@ -1228,6 +1233,7 @@ var Page = class {
     this.taskManager = taskManager;
     this.scaleService = scaleService;
     this.onCompleted = onCompleted;
+    this.pageNumber = dto.pageNumber;
     dto.elements.forEach((el) => {
       const element = createDElement(el, scaleService);
       element.registerClickHandler((action) => {
@@ -1247,20 +1253,20 @@ var Page = class {
   }
   TAG = "[ DPage ]: ";
   elements = [];
-  // private elements: PageComponent[] = [];
-  // private layoutComponents: PageLayoutComponent[] = [];
+  pageNumber;
   pageEntered = DTimestamp.now();
   previousState = false;
   eventLog = new Array();
   createPageResult(facts) {
     const pageExited = DTimestamp.now();
     const pageTime = DTimestamp.diff(this.pageEntered, pageExited);
-    const pageExit = MqEvent.pageLeave(this.dto.id, this.dto.prefix);
+    const pageExit = MqEvent.pageLeave(this.dto.id, this.dto.prefix, this.pageNumber);
     this.eventLog.push(pageExit);
     const eventLog = [...this.eventLog];
     return {
       pagePrefix: this.dto.prefix,
       pageId: this.dto.id,
+      pageNumber: this.pageNumber,
       eventLog,
       pageTime,
       collectedFacts: facts
@@ -1270,6 +1276,7 @@ var Page = class {
     const event = MqEvent.userClicked({
       pageId: this.dto.id,
       pagePrefix: this.dto.prefix,
+      pageNumber: this.pageNumber,
       action: a.kind,
       descriptions: ButtonClickAction.describe(a)
     });
@@ -1316,7 +1323,7 @@ var Page = class {
     }
   }
   appendYourself(parent) {
-    const pageEnterEvent = MqEvent.pageEnter(this.dto.id, this.dto.prefix);
+    const pageEnterEvent = MqEvent.pageEnter(this.dto.id, this.dto.prefix, this.pageNumber);
     this.pageEntered = DTimestamp.now();
     this.eventLog.push(pageEnterEvent);
     this.elements.forEach((el) => {
@@ -1652,6 +1659,7 @@ var SchemaEngine = class {
     const currentResults = this.player.getResults();
     const a = {
       schemaId: this.schema.id,
+      pageResults: currentResults.pageResults,
       pagesLeft: currentResults.pagesLeft,
       predefinedFacts: currentResults.predefinedFacts,
       eventLog: currentResults.eventLog,
@@ -1705,6 +1713,9 @@ var SchemaEngine = class {
       this.currentPage.destroy();
       this.uiLayer.innerHTML = "";
     }
+    if (this.tickerRef) {
+      window.clearInterval(this.tickerRef);
+    }
   }
   _onProgress = false;
   onProgress(handler) {