@vnejs/plugins.core.storage 0.1.0 → 0.1.2

package/const/events.js

@@ -1,10 +1,17 @@
 export const SUBSCRIBE_EVENTS = {
   SET: "vne:storage:set",
   SET_ALL: "vne:storage:set_all",
+
   GET: "vne:storage:get",
   GET_ALL: "vne:storage:get_all",
+
   RM: "vne:storage:rm",
+  RM_ALL: "vne:storage:rm_all",
+
+  KEYS: "vne:storage:keys",
+  INIT: "vne:storage:init",
   CHANGED: "vne:storage:changed",
+
   IMPORT: "vne:storage:import",
   EXPORT: "vne:storage:export",
   CLEAR: "vne:storage:clear",

package/const/params.js

@@ -0,0 +1,3 @@
+export const VERSION = 1;
+
+export const GAMENAME = "vne-test-game";

package/index.js

@@ -1,7 +1,12 @@
 import { regPlugin } from "@vnejs/shared";
 
 import { SUBSCRIBE_EVENTS } from "./const/events";
+import * as params from "./const/params";
 
 import { Storage } from "./modules/storage";
+import { StorageGet } from "./modules/get";
+import { StorageSet } from "./modules/set";
+import { StorageActions } from "./modules/actions";
+import { StorageRm } from "./modules/rm";
 
-regPlugin("STORAGE", { events: SUBSCRIBE_EVENTS }, [Storage]);
+regPlugin("STORAGE", { events: SUBSCRIBE_EVENTS, params }, [Storage, StorageGet, StorageSet, StorageRm, StorageActions]);

package/modules/actions.js

@@ -0,0 +1,46 @@
+import { Module } from "@vnejs/module";
+
+export class StorageActions extends Module {
+  name = "storage.actions";
+
+  subscribe = () => {
+    this.on(this.EVENTS.STORAGE.EXPORT, this.onStorageExport);
+    this.on(this.EVENTS.STORAGE.IMPORT, this.onStorageImport);
+    this.on(this.EVENTS.STORAGE.CLEAR, this.onStorageClear);
+  };
+
+  onStorageExport = async () => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    const state = await this.emitOne(this.EVENTS.STORAGE.GET_ALL);
+
+    await this.emit(this.EVENTS.SYSTEM.FILE_LOAD, { obj: state, name: "state" });
+
+    return state;
+  };
+  onStorageImport = async () => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    const newStorage = await this.emitOne(this.EVENTS.SYSTEM.FILE_READ);
+    if (!newStorage) return;
+
+    const keys = await this.emitOne(this.EVENTS.STORAGE.KEYS);
+
+    await Promise.all(keys.map(this.emitRm));
+    await Promise.all(Object.keys(newStorage).map((key) => this.emitSet(key, newStorage[key])));
+
+    return this.emit(this.EVENTS.SYSTEM.RELOAD);
+  };
+  onStorageClear = async () => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    const keys = await this.emitOne(this.EVENTS.STORAGE.KEYS);
+
+    await Promise.all(keys.map(this.emitRm));
+
+    return this.emit(this.EVENTS.SYSTEM.RELOAD);
+  };
+
+  emitRm = (key) => this.emit(this.EVENTS.STORAGE.RM, { key });
+  emitSet = (key, value) => this.emit(this.EVENTS.STORAGE.SET, { key, value });
+}

package/modules/get.js

@@ -0,0 +1,38 @@
+import localforage from "localforage";
+
+import { Module } from "@vnejs/module";
+
+export class StorageGet extends Module {
+  name = "storage.get";
+
+  subscribe = () => {
+    this.on(this.EVENTS.STORAGE.GET, this.onStorageGet);
+    this.on(this.EVENTS.STORAGE.GET_ALL, this.onStorageGetAll);
+  };
+
+  onStorageGet = async ({ prefix = "", key = "" } = {}) => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    return this.getItem(key, prefix);
+  };
+  onStorageGetAll = async ({ prefix = "" } = {}) => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    const result = {};
+    const keys = await this.getKeys(prefix);
+
+    await Promise.all(keys.map((key) => this.setResultKey(result, prefix, key)));
+
+    return result;
+  };
+
+  setResultKey = async (result, prefix, key) => {
+    result[prefix ? key.slice(prefix.length + 1) : key] = await this.getItem(key);
+  };
+  getKeys = async (prefix) => {
+    const keys = await this.emitOne(this.EVENTS.STORAGE.KEYS);
+
+    return prefix ? keys.filter((key) => key.startsWith(prefix)) : keys;
+  };
+  getItem = (key, prefix) => localforage.getItem(prefix ? `${prefix}.${key}` : key);
+}

package/modules/rm.js

@@ -0,0 +1,36 @@
+import localforage from "localforage";
+
+import { Module } from "@vnejs/module";
+
+export class StorageRm extends Module {
+  name = "storage.rm";
+
+  subscribe = () => {
+    this.on(this.EVENTS.STORAGE.RM, this.onStorageRm);
+    this.on(this.EVENTS.STORAGE.RM_ALL, this.onStorageRmAll);
+  };
+
+  onStorageRm = async ({ prefix = "", key = "" } = {}) => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    await this.removeKey(prefix ? `${prefix}.${key}` : key);
+
+    this.emit(this.EVENTS.STORAGE.CHANGED);
+  };
+  onStorageRmAll = async ({ prefix = "" } = {}) => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    const keys = await this.getKeys(prefix);
+
+    await Promise.all(keys.map(this.removeKey));
+
+    this.emit(this.EVENTS.STORAGE.CHANGED);
+  };
+
+  getKeys = async (prefix) => {
+    const keys = await this.emitOne(this.EVENTS.STORAGE.KEYS);
+
+    return prefix ? keys.filter((key) => key.startsWith(prefix)) : keys;
+  };
+  removeKey = (key) => localforage.removeItem(key);
+}

package/modules/set.js

@@ -0,0 +1,54 @@
+import localforage from "localforage";
+
+import { Module } from "@vnejs/module";
+
+const eqTrue = (i) => i === true;
+
+export class StorageSet extends Module {
+  name = "storage.set";
+
+  subscribe = () => {
+    this.on(this.EVENTS.STORAGE.SET, this.onStorageSet);
+    this.on(this.EVENTS.STORAGE.SET_ALL, this.onStorageSetAll);
+  };
+
+  onStorageSet = async ({ prefix, key, value } = {}) => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    await this.setItem(prefix ? `${prefix}.${key}` : key, value);
+
+    this.emit(this.EVENTS.STORAGE.CHANGED);
+  };
+  onStorageSetAll = async ({ storage } = {}) => {
+    await this.emit(this.EVENTS.STORAGE.INIT);
+
+    const keys = await this.emitOne(this.EVENTS.STORAGE.KEYS);
+
+    const arrSet = await Promise.all(Object.entries(storage).map(this.setNewValueBykey));
+    const arrRm = await Promise.all(keys.map((key) => this.removeOldValue(storage, key)));
+
+    this.emit(this.EVENTS.STORAGE.CHANGED);
+
+    return [...arrSet, ...arrRm].some(eqTrue);
+  };
+
+  setNewValueBykey = async ([key, oldValue]) => {
+    const value = await this.emitOne(this.EVENTS.STORAGE.GET, { key });
+
+    if (value === oldValue) return false;
+
+    await this.setItem(key, oldValue);
+
+    return true;
+  };
+
+  removeOldValue = async (storage, key) => {
+    if (storage[key] !== undefined) return false;
+
+    await this.emit(this.EVENTS.STORAGE.RM, { key });
+
+    return true;
+  };
+
+  setItem = (key, value) => localforage.setItem(key, value);
+}

package/modules/storage.js

@@ -6,124 +6,21 @@ export class Storage extends Module {
   name = "storage";
 
   subscribe = () => {
-    this.on(this.EVENTS.STORAGE.SET, this.onStorageSet);
-    this.on(this.EVENTS.STORAGE.SET_ALL, this.onStorageSetAll);
-    this.on(this.EVENTS.STORAGE.GET, this.onStorageGet);
-    this.on(this.EVENTS.STORAGE.RM, this.onStorageRm);
-    this.on(this.EVENTS.STORAGE.EXPORT, this.onStorageExport);
-    this.on(this.EVENTS.STORAGE.IMPORT, this.onStorageImport);
-    this.on(this.EVENTS.STORAGE.CLEAR, this.onStorageClear);
+    this.on(this.EVENTS.STORAGE.KEYS, this.onStorageKeys);
+    this.on(this.EVENTS.STORAGE.INIT, this.onStorageInit);
+    this.on(this.EVENTS.STORAGE.CHANGED, this.onStorageChanged);
   };
   init = () =>
     new Promise((resolve) => {
-      const { version = 0, gameName = "defaultGameName" } = this.options?.global || {};
+      const name = `vne_store_${this.PARAMS.STORAGE.GAMENAME}`;
 
-      const name = `vne_store_${gameName}`;
       localforage.ready(resolve);
-      localforage.config({ driver: localforage.INDEXEDDB, name, storeName: name, description: name, version });
+      localforage.config({ driver: localforage.INDEXEDDB, name, storeName: name, description: name, version: this.PARAMS.STORAGE.VERSION });
     });
 
-  onStorageSet = async ({ prefix, key, value }) => {
-    if (!this.isReady) await this.waitIsReady();
+  onStorageChanged = () => this.emit(this.EVENTS.LOGS.EMIT, { module: this.name, value: { action: "changed" } });
 
-    await localforage.setItem(prefix ? `${prefix}.${key}` : key, value);
+  onStorageInit = () => !this.isReady && this.waitIsReady();
 
-    this.emit(this.EVENTS.STORAGE.CHANGED);
-  };
-
-  onStorageSetAll = async ({ storage }) => {
-    if (!this.isReady) await this.waitIsReady();
-
-    let wasChanged = false;
-
-    await Promise.all(
-      Object.keys(storage).map(async (key) => {
-        const value = await localforage.getItem(key);
-        if (value !== storage[key]) {
-          wasChanged = true;
-          await localforage.setItem(key, storage[key]);
-        }
-      }),
-    );
-
-    const keys = await localforage.keys();
-
-    await Promise.all(
-      keys.map(async (key) => {
-        if (storage[key] === undefined) {
-          wasChanged = true;
-          await localforage.removeItem(key);
-        }
-      }),
-    );
-
-    await this.emit(this.EVENTS.STORAGE.CHANGED);
-
-    return wasChanged;
-  };
-
-  onStorageGet = async ({ prefix = "", key = "" } = {}) => {
-    if (!this.isReady) await this.waitIsReady();
-
-    const result = {};
-
-    if (key) {
-      const keyWithPrefix = prefix ? `${prefix}.${key}` : key;
-
-      result[key] = await localforage.getItem(keyWithPrefix);
-    } else {
-      const keys = await localforage.keys();
-      const realKeys = prefix ? keys.filter((key) => key.startsWith(prefix)) : keys;
-
-      await Promise.all(
-        realKeys.map(async (key) => {
-          result[prefix ? key.slice(prefix.length + 1) : key] = await localforage.getItem(key);
-        }),
-      );
-    }
-
-    return result;
-  };
-
-  onStorageRm = async ({ prefix = "", key = "" } = {}) => {
-    if (!this.isReady) await this.waitIsReady();
-
-    localforage.removeItem(`${prefix}.${key}`);
-
-    this.emit(this.EVENTS.STORAGE.CHANGED);
-  };
-
-  onStorageExport = async () => {
-    if (!this.isReady) await this.waitIsReady();
-
-    const state = await this.emitOne(this.EVENTS.STORAGE.GET);
-
-    await this.emit(this.EVENTS.SYSTEM.FILE_LOAD, { obj: state, name: "state" });
-
-    return state;
-  };
-
-  onStorageImport = async () => {
-    if (!this.isReady) await this.waitIsReady();
-
-    const newStorage = await this.emitOne(this.EVENTS.SYSTEM.FILE_READ);
-    if (!newStorage) return;
-
-    const keys = await localforage.keys();
-
-    await Promise.all(keys.map((key) => localforage.removeItem(key)));
-    await Promise.all(Object.keys(newStorage).map((key) => localforage.setItem(key, newStorage[key])));
-
-    await this.emit(this.EVENTS.SYSTEM.RELOAD);
-  };
-
-  onStorageClear = async () => {
-    if (!this.isReady) await this.waitIsReady();
-
-    const keys = await localforage.keys();
-
-    await Promise.all(keys.map((key) => localforage.removeItem(key)));
-
-    await this.emit(this.EVENTS.SYSTEM.RELOAD);
-  };
+  onStorageKeys = () => localforage.keys();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnejs/plugins.core.storage",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -16,9 +16,5 @@
   "description": "",
   "dependencies": {
     "localforage": "1.10.0"
-  },
-  "peerDependencies": {
-    "@vnejs/shared": "*",
-    "@vnejs/module": "*"
   }
 }