@vnejs/plugins.scenario.autoread 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -0,0 +1 @@
+import "@vnejs/plugins.scenario.autoread.contract";

package/dist/index.js

@@ -0,0 +1,5 @@
+import "@vnejs/plugins.scenario.autoread.contract";
+import { regPlugin } from "@vnejs/shared";
+import { PARAMS, PLUGIN_NAME, SETTINGS_KEYS, SUBSCRIBE_EVENTS } from "@vnejs/plugins.scenario.autoread.contract";
+import { Autoread } from "./modules/autoread.js";
+regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: PARAMS, settings: SETTINGS_KEYS }, [Autoread]);

package/dist/modules/autoread.d.ts

@@ -0,0 +1,19 @@
+import { Module } from "@vnejs/module";
+import type { AutoreadSourcePayload } from "@vnejs/plugins.scenario.autoread.contract";
+import type { AutoreadPluginConstants, AutoreadPluginEvents, AutoreadPluginParams, AutoreadPluginSettings } from "../types.js";
+import type { SettingsChangedPayload } from "../utils/autoread.js";
+export declare class Autoread extends Module<AutoreadPluginEvents, AutoreadPluginConstants, AutoreadPluginSettings, AutoreadPluginParams> {
+    name: string;
+    disableSources: string[];
+    autoreadTimeout: ReturnType<typeof setTimeout> | undefined;
+    subscribe: () => void;
+    init: () => Promise<[unknown[] | undefined, unknown[] | undefined]>;
+    onTry: () => Promise<void | unknown[]>;
+    onPush: ({ source }?: AutoreadSourcePayload) => void;
+    onPop: ({ source }?: AutoreadSourcePayload) => void;
+    onSettingsChanged: ({ name, value }?: SettingsChangedPayload) => false | Promise<unknown[]> | undefined;
+    onStateSet: () => void;
+    createTimeout: () => void;
+    clearTimeout: () => void;
+    emitAutoread: () => Promise<unknown[]> | undefined;
+}

package/dist/modules/autoread.js

@@ -0,0 +1,55 @@
+import { Module } from "@vnejs/module";
+export class Autoread extends Module {
+    name = "autoread";
+    disableSources = [];
+    autoreadTimeout;
+    subscribe = () => {
+        this.on(this.EVENTS.AUTOREAD.TRY, this.onTry);
+        this.on(this.EVENTS.AUTOREAD.PUSH, this.onPush);
+        this.on(this.EVENTS.AUTOREAD.POP, this.onPop);
+        this.on(this.EVENTS.SETTINGS.CHANGED, this.onSettingsChanged);
+        this.on(this.EVENTS.STATE.CLEAR, this.clearTimeout);
+        this.on(this.EVENTS.STATE.SET, this.onStateSet);
+    };
+    init = () => Promise.all([
+        this.emit(this.EVENTS.SETTINGS.INIT, { name: this.SETTINGS.AUTOREAD.ENABLED, value: this.PARAMS.AUTOREAD.DEFAULT_ENABLED }),
+        this.emit(this.EVENTS.SETTINGS.INIT, { name: this.SETTINGS.AUTOREAD.DELAY, value: this.PARAMS.AUTOREAD.DEFAULT_DELAY }),
+    ]);
+    onTry = async () => {
+        this.emit(this.EVENTS.LOGS.EMIT, { module: this.name, value: { action: "try" } });
+        if (!this.shared.settings[this.SETTINGS.AUTOREAD.ENABLED] || this.disableSources.length)
+            return;
+        await this.waitRerender();
+        const elements = document.elementsFromPoint(window.innerHeight / 2, window.innerHeight / 2);
+        for (let i = 0; i < elements.length; i++) {
+            if (elements[i].hasAttribute("vne-autoread-allow"))
+                return this.emit(this.EVENTS.INTERACT.EMIT);
+            if (elements[i].hasAttribute("vne-autoread-disable"))
+                return this.createTimeout();
+        }
+        this.createTimeout();
+    };
+    onPush = ({ source = "" } = {}) => {
+        this.disableSources.push(source);
+        this.clearTimeout();
+    };
+    onPop = ({ source = "" } = {}) => {
+        this.disableSources = this.disableSources.filter((s) => s !== source);
+        if (!this.disableSources.length)
+            this.createTimeout();
+    };
+    onSettingsChanged = ({ name, value } = {}) => name === this.SETTINGS.AUTOREAD.ENABLED && this.emit(value ? this.EVENTS.AUTOREAD.POP : this.EVENTS.AUTOREAD.PUSH, { source: this.name });
+    onStateSet = () => {
+        this.disableSources = [];
+        this.clearTimeout();
+        this.createTimeout();
+    };
+    createTimeout = () => {
+        this.autoreadTimeout = setTimeout(this.emitAutoread, this.shared.settings[this.SETTINGS.AUTOREAD.DELAY] || 0);
+    };
+    clearTimeout = () => {
+        if (this.autoreadTimeout)
+            clearTimeout(this.autoreadTimeout);
+    };
+    emitAutoread = () => this.emit(this.EVENTS.AUTOREAD.TRY);
+}

package/dist/types.d.ts

@@ -0,0 +1,10 @@
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+import type { PluginName as InteractPluginName, SubscribeEvents as InteractSubscribeEvents } from "@vnejs/plugins.core.interact.contract";
+import type { PluginName as LogsPluginName, SubscribeEvents as LogsSubscribeEvents } from "@vnejs/plugins.core.logs.contract";
+import type { PluginName as SettingsPluginName, SubscribeEvents as SettingsSubscribeEvents } from "@vnejs/plugins.core.settings.contract";
+import type { PluginName as StatePluginName, SubscribeEvents as StateSubscribeEvents } from "@vnejs/plugins.core.state.contract";
+import type { Params, PluginName, SettingsKeys, SubscribeEvents } from "@vnejs/plugins.scenario.autoread.contract";
+export type AutoreadPluginEvents = VnePluginEventsMapRegistry & Record<PluginName, SubscribeEvents> & Record<InteractPluginName, InteractSubscribeEvents> & Record<LogsPluginName, LogsSubscribeEvents> & Record<SettingsPluginName, SettingsSubscribeEvents> & Record<StatePluginName, StateSubscribeEvents>;
+export type AutoreadPluginConstants = VnePluginConstantsMapRegistry;
+export type AutoreadPluginSettings = VnePluginSettingsMapRegistry & Record<PluginName, SettingsKeys>;
+export type AutoreadPluginParams = VnePluginParamsMapRegistry & Record<PluginName, Params>;

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/autoread.d.ts

@@ -0,0 +1,6 @@
+import type { AutoreadSourcePayload } from "@vnejs/plugins.scenario.autoread.contract";
+export type SettingsChangedPayload = {
+    name?: string;
+    value?: unknown;
+};
+export type { AutoreadSourcePayload };

package/dist/utils/autoread.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,17 +1,46 @@
 {
   "name": "@vnejs/plugins.scenario.autoread",
-  "version": "0.1.1",
-  "main": "index.js",
+  "version": "0.1.3",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "tsconfig.json"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npx @vnejs/monorepo package",
     "publish:major:plugin": "npm run publish:major",
     "publish:minor:plugin": "npm run publish:minor",
     "publish:patch:plugin": "npm run publish:patch",
-    "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"
+    "publish:major": "npx @vnejs/monorepo publish major --access public",
+    "publish:minor": "npx @vnejs/monorepo publish minor --access public",
+    "publish:patch": "npx @vnejs/monorepo publish patch --access public"
   },
   "author": "",
   "license": "ISC",
-  "description": ""
+  "dependencies": {
+    "@vnejs/plugins.scenario.autoread.contract": "~0.0.1"
+  },
+  "peerDependencies": {
+    "@vnejs/module": "~0.0.1",
+    "@vnejs/plugins.core.interact.contract": "~0.0.1",
+    "@vnejs/plugins.core.logs.contract": "~0.0.1",
+    "@vnejs/plugins.core.settings.contract": "~0.0.1",
+    "@vnejs/plugins.core.state.contract": "~0.0.1",
+    "@vnejs/shared": "~0.0.9"
+  },
+  "devDependencies": {
+    "@vnejs/configs.ts-common": "~0.0.1"
+  }
 }

package/src/index.ts

@@ -0,0 +1,8 @@
+import "@vnejs/plugins.scenario.autoread.contract";
+
+import { regPlugin } from "@vnejs/shared";
+import { PARAMS, PLUGIN_NAME, SETTINGS_KEYS, SUBSCRIBE_EVENTS } from "@vnejs/plugins.scenario.autoread.contract";
+
+import { Autoread } from "./modules/autoread.js";
+
+regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: PARAMS, settings: SETTINGS_KEYS }, [Autoread]);

package/{modules/autoread.js → src/modules/autoread.ts}

@@ -1,9 +1,14 @@
 import { Module } from "@vnejs/module";
+import type { AutoreadSourcePayload } from "@vnejs/plugins.scenario.autoread.contract";
 
-export class Autoread extends Module {
+import type { AutoreadPluginConstants, AutoreadPluginEvents, AutoreadPluginParams, AutoreadPluginSettings } from "../types.js";
+import type { SettingsChangedPayload } from "../utils/autoread.js";
+
+export class Autoread extends Module<AutoreadPluginEvents, AutoreadPluginConstants, AutoreadPluginSettings, AutoreadPluginParams> {
   name = "autoread";
 
-  disableSources = [];
+  disableSources: string[] = [];
+  autoreadTimeout: ReturnType<typeof setTimeout> | undefined;
 
   subscribe = () => {
     this.on(this.EVENTS.AUTOREAD.TRY, this.onTry);
@@ -38,17 +43,19 @@ export class Autoread extends Module {
 
     this.createTimeout();
   };
-  onPush = ({ source } = {}) => {
+
+  onPush = ({ source = "" }: AutoreadSourcePayload = {}) => {
     this.disableSources.push(source);
     this.clearTimeout();
   };
-  onPop = ({ source } = {}) => {
+
+  onPop = ({ source = "" }: AutoreadSourcePayload = {}) => {
     this.disableSources = this.disableSources.filter((s) => s !== source);
 
     if (!this.disableSources.length) this.createTimeout();
   };
 
-  onSettingsChanged = ({ name, value } = {}) =>
+  onSettingsChanged = ({ name, value }: SettingsChangedPayload = {}) =>
     name === this.SETTINGS.AUTOREAD.ENABLED && this.emit(value ? this.EVENTS.AUTOREAD.POP : this.EVENTS.AUTOREAD.PUSH, { source: this.name });
 
   onStateSet = () => {
@@ -61,7 +68,10 @@ export class Autoread extends Module {
   createTimeout = () => {
     this.autoreadTimeout = setTimeout(this.emitAutoread, this.shared.settings[this.SETTINGS.AUTOREAD.DELAY] || 0);
   };
-  clearTimeout = () => clearTimeout(this.autoreadTimeout);
+
+  clearTimeout = () => {
+    if (this.autoreadTimeout) clearTimeout(this.autoreadTimeout);
+  };
 
   emitAutoread = () => this.emit(this.EVENTS.AUTOREAD.TRY);
 }

package/src/types.ts

@@ -0,0 +1,19 @@
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+import type { PluginName as InteractPluginName, SubscribeEvents as InteractSubscribeEvents } from "@vnejs/plugins.core.interact.contract";
+import type { PluginName as LogsPluginName, SubscribeEvents as LogsSubscribeEvents } from "@vnejs/plugins.core.logs.contract";
+import type { PluginName as SettingsPluginName, SubscribeEvents as SettingsSubscribeEvents } from "@vnejs/plugins.core.settings.contract";
+import type { PluginName as StatePluginName, SubscribeEvents as StateSubscribeEvents } from "@vnejs/plugins.core.state.contract";
+import type { Params, PluginName, SettingsKeys, SubscribeEvents } from "@vnejs/plugins.scenario.autoread.contract";
+
+export type AutoreadPluginEvents = VnePluginEventsMapRegistry &
+  Record<PluginName, SubscribeEvents> &
+  Record<InteractPluginName, InteractSubscribeEvents> &
+  Record<LogsPluginName, LogsSubscribeEvents> &
+  Record<SettingsPluginName, SettingsSubscribeEvents> &
+  Record<StatePluginName, StateSubscribeEvents>;
+
+export type AutoreadPluginConstants = VnePluginConstantsMapRegistry;
+
+export type AutoreadPluginSettings = VnePluginSettingsMapRegistry & Record<PluginName, SettingsKeys>;
+
+export type AutoreadPluginParams = VnePluginParamsMapRegistry & Record<PluginName, Params>;

package/src/utils/autoread.ts

@@ -0,0 +1,8 @@
+import type { AutoreadSourcePayload } from "@vnejs/plugins.scenario.autoread.contract";
+
+export type SettingsChangedPayload = {
+  name?: string;
+  value?: unknown;
+};
+
+export type { AutoreadSourcePayload };

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@vnejs/configs.ts-common/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist", "node_modules"]
+}

package/const/events.js

@@ -1,6 +0,0 @@
-export const SUBSCRIBE_EVENTS = {
-  TRY: "vne:autoread:try",
-
-  PUSH: "vne:autoread:push",
-  POP: "vne:autoread:pop",
-};

package/const/params.js

@@ -1,2 +0,0 @@
-export const DEFAULT_DELAY = 5000;
-export const DEFAULT_ENABLED = false;

package/const/settings.js

@@ -1,4 +0,0 @@
-export const SETTINGS_KEYS = {
-  ENABLED: "vne:autoread:enabled",
-  DELAY: "vne:autoread:delay",
-};

package/index.js

@@ -1,10 +0,0 @@
-import { regPlugin } from "@vnejs/shared";
-
-import * as constants from "./const/const";
-import { SUBSCRIBE_EVENTS } from "./const/events";
-import * as params from "./const/params";
-import { SETTINGS_KEYS } from "./const/settings";
-
-import { Autoread } from "./modules/autoread";
-
-regPlugin("AUTOREAD", { constants, events: SUBSCRIBE_EVENTS, params, settings: SETTINGS_KEYS }, [Autoread]);