@media-quest/engine 0.0.38 → 0.0.40

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,76 +1,63 @@
-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;
+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;