@vnejs/plugins.feature.fastforward 0.0.1

package/const/events.js

@@ -0,0 +1,7 @@
+export const SUBSCRIBE_EVENTS = {
+  STOP: "vne:fastforward:stop",
+  START: "vne:fastforward:start",
+  CHECK: "vne:fastforward:check",
+  TOGGLE: "vne:fastforward:toggle",
+  CHANGED: "vne:fastforward:changed",
+};

package/const/settings.js

@@ -0,0 +1,4 @@
+export const SETTINGS_KEYS = {
+  CHECK: "vne:fastforward:check",
+  DELAY: "vne:fastforward:delay",
+};

package/index.js

@@ -0,0 +1,9 @@
+import { regPlugin } from "@vnejs/shared";
+
+import { SUBSCRIBE_EVENTS } from "./const/events";
+import { SETTINGS_KEYS } from "./const/settings";
+
+import { Fastforward } from "./modules/fastforward";
+import { FastforwardVisits } from "./modules/visits";
+
+regPlugin("FASTFORWARD", { events: SUBSCRIBE_EVENTS, settings: SETTINGS_KEYS }, [Fastforward, FastforwardVisits]);

package/modules/fastforward.js

@@ -0,0 +1,62 @@
+import { Module } from "@vnejs/module";
+
+const skipNFrames = (n, cb) => (n > 0 ? requestAnimationFrame(() => skipNFrames(n - 1, cb)) : setImmediate(cb));
+
+export class Fastforward extends Module {
+  name = "fastforward";
+
+  subscribe = () => {
+    this.on(this.EVENTS.FASTFORWARD.START, this.onStart);
+    this.on(this.EVENTS.FASTFORWARD.STOP, this.onStop);
+    this.on(this.EVENTS.FASTFORWARD.TOGGLE, this.onToggle);
+
+    this.on(this.EVENTS.INTERACT.ENDED, this.onInteractEnd);
+
+    this.EVENTS.CHOOSE && this.on(this.EVENTS.CHOOSE.OPTION, this.onInteractEnd);
+
+    this.on(this.EVENTS.STATE.CLEAR, this.onStop);
+    this.on(this.EVENTS.SYSTEM.STARTED, this.onStop);
+  };
+
+  init = async ({ platform = this.CONST.PLATFORMS.WEB } = {}) => {
+    await this.emit(this.EVENTS.SETTINGS.INIT, { name: this.SETTINGS.FASTFORWARD.CHECK, value: true });
+    await this.emit(this.EVENTS.SETTINGS.INIT, {
+      name: this.SETTINGS.FASTFORWARD.DELAY,
+      value: platform === this.CONST.PLATFORMS.WEB ? 10 : 1,
+    });
+  };
+
+  onToggle = () => this.setValue(!this.shared.isFastforwardOn);
+  onStart = () => this.setValue(true);
+  onStop = () => this.setValue(false);
+  onInteractEnd = () =>
+    this.shared.isFastforwardOn && skipNFrames(this.shared.settings[this.SETTINGS.FASTFORWARD.DELAY], this.interact);
+
+  setValue = (value) => {
+    this.shared.isFastforwardOn = value;
+
+    if (value) this.shared.mediaNoTimeoutSources.push(this.name);
+    else this.shared.mediaNoTimeoutSources = this.shared.mediaNoTimeoutSources.filter(this.notFastForward);
+
+    if (value) this.shared.textNoAnimationSources.push(this.name);
+    else this.shared.textNoAnimationSources = this.shared.textNoAnimationSources.filter(this.notFastForward);
+
+    if (value) this.shared.viewForceAnimationSources.push(this.name);
+    else this.shared.viewForceAnimationSources = this.shared.viewForceAnimationSources.filter(this.notFastForward);
+
+    this.emit(this.EVENTS.FASTFORWARD.CHANGED, { value });
+    value && this.interact();
+  };
+
+  checkVisited = async () => {
+    const [isVisited] = await this.emit(this.EVENTS.FASTFORWARD.CHECK);
+    !isVisited && this.setValue(false);
+  };
+
+  interact = async () => {
+    if (this.shared.settings[this.SETTINGS.FASTFORWARD.CHECK]) await this.checkVisited();
+    await this.emit(this.EVENTS.INTERACT.EMIT);
+  };
+
+  notFastForward = (s) => s !== this.name;
+}

package/modules/visits.js

@@ -0,0 +1,43 @@
+import { Module } from "@vnejs/module";
+
+export class FastforwardVisits extends Module {
+  name = "fastforward.visits";
+  visits = {};
+
+  subscribe = () => {
+    this.on(this.EVENTS.TEXT.EMIT, this.onText);
+
+    this.on(this.EVENTS.FASTFORWARD.CHECK, this.onVisitCheck);
+
+    this.on(this.EVENTS.STATE.CLEAR, this.setDefaultState);
+    this.on(this.EVENTS.STATE.SET, this.setStateFromGlobalState);
+  };
+
+  init = async () => {
+    const [visits = {}] = await this.emit(this.EVENTS.STORAGE.GET, { prefix: this.name });
+
+    this.visits = visits;
+  };
+
+  onText = async ({ text, speaker }) => {
+    const key = await this.getHash();
+
+    this.visits[key] = 1;
+    this.emit(this.EVENTS.STORAGE.SET, { prefix: this.name, key, value: 1 });
+
+    const { label } = this.globalState.scenario;
+    const meet = speaker ? this.globalState?.meet?.[speaker] : 0;
+
+    this.setState({ text, label, speaker, meet });
+  };
+
+  onVisitCheck = async () => Boolean(this.visits[await this.getHash()]);
+
+  getHash = async () => {
+    const [hash] = await this.emit(this.EVENTS.VENDORS.HASH, this.state);
+
+    return hash;
+  };
+
+  getDefaultState = () => ({ text: "", label: "", speaker: "", meet: 0 });
+}

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@vnejs/plugins.feature.fastforward",
+  "version": "0.0.1",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "publish:major": "npm version major && npm publish --access public",
+    "publish:minor": "npm version minor && npm publish --access public",
+    "publish:patch": "npm version patch && npm publish --access public"
+  },
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "peerDependencies": {
+    "@vnejs/shared": "*",
+    "@vnejs/module": "*"
+  }
+}