@thzero/library_client_vue3_store_pinia 0.16.12 → 0.16.13

package/README.md

@@ -4,6 +4,17 @@
 
 # library_client_vue3_store_pinia
 
-An opinionated library for vue3 with pinia store for the library_client_vue3 using the [https://prazdevs.github.io/pinia-plugin-persistedstate](https://prazdevs.github.io/pinia-plugin-persistedstate) library.
+An opinionated library for vue3 with [Pinia](https://github.com/vuejs/pinia) store for the library_client_vue3 using the [pinia-plugin-persistedstate](https://prazdevs.github.io/pinia-plugin-persistedstate) or [pinia-plugin-persistedstate-2](https://github.com/iendeavor/pinia-plugin-persistedstate-2) library.
+
+## Installation
 
 [![NPM](https://nodei.co/npm/@thzero/library_common.png?compact=true)](https://npmjs.org/package/@thzero/library_client_vue3_store_pinia)
+
+### Requirements
+
+#### NodeJs
+
+Requires 
+* [library_common](https://npmjs.org/package/@thzero/library_common)
+* [library_client](https://npmjs.org/package/@thzero/library_client)
+* [library_client_vue3](https://npmjs.org/package/@thzero/library_client_vue3)

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@thzero/library_client_vue3_store_pinia",
-  "version": "0.16.12",
+  "version": "0.16.13",
   "version_major": 0,
   "version_minor": 16,
-  "version_patch": 12,
+  "version_patch": 13,
   "version_date": "11/25/2022",
   "description": "An opinionated library for vue3 with pinia store for the library_client_vue3 using the https://prazdevs.github.io/pinia-plugin-persistedstate library.",
   "author": "thZero",
@@ -25,6 +25,7 @@
     "@thzero/library_common": "^0.16",
     "pinia": "^2.0.26",
     "pinia-plugin-persistedstate": "^2.4.0",
+    "pinia-plugin-persistedstate-2": "^2.0.3",
     "vue": "^3.2.45"
   }
 }

package/store/index.js

@@ -0,0 +1,145 @@
+import { createPinia, defineStore } from 'pinia';
+import piniaPluginPersistedState from 'pinia-plugin-persistedstate';
+import { createPersistedStatePlugin } from 'pinia-plugin-persistedstate-2';
+
+import LibraryConstants from '@thzero/library_client/constants';
+
+import GlobalUtility from '@thzero/library_client/utility/global';
+
+import NotImplementedError from '@thzero/library_common/errors/notImplemented';
+
+// import adminNews from './admin/news/pinia';
+// import adminUsers from './admin/users/pinia';
+
+import news from './news';
+import user from './user';
+
+class BaseStore {
+	async initialize() {
+		this.pinia = createPinia();
+
+		this._initPluginPersist();
+
+		return this.pinia;
+	}
+
+	setup() {
+		const logger = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_LOGGER);
+		return {
+			func: {
+				install(app, options) {
+					const storeConfig = options.storeConfig;
+					
+					options.actionDispatcher = storeConfig.dispatcher;
+					if (!options.actionDispatcher) 
+						options.actionDispatcher = {};
+
+					if (options.pluginPersistSetup && options.pluginPersistType && options.pluginPersistConfig && options.pluginPersistConfig['root'])
+						options.pluginPersistSetup(options.pluginPersistType(), storeConfig, options.pluginPersistConfig['root'], options.pluginPersistSetupOverride);
+
+					const storeFunc = defineStore('main', storeConfig);
+					GlobalUtility.$store = storeFunc(options.pinia);
+					GlobalUtility.$store.$logger = options.logger;
+
+					// options.addModule('adminNews', adminNews, options.actionDispatcher, options.pluginPersistType(), options.pluginPersistConfig, options.pinia, logger);
+					// options.addModule('adminUsers', adminUsers, options.actionDispatcher, options.pluginPersistType(), options.pluginPersistConfig, options.pinia, logger);
+					options.addModule('news', news, options.actionDispatcher, options.pluginPersistType(), options.pluginPersistSetup, options.pluginPersistConfig, options.pluginPersistSetupOverride, options.pinia, logger);
+					options.addModule('user', user, options.actionDispatcher, options.pluginPersistType(), options.pluginPersistSetup, options.pluginPersistConfig, options.pluginPersistSetupOverride, options.pinia, logger);
+					options.initModules();
+					GlobalUtility.$store.dispatcher = options.actionDispatcher;
+				}
+			},
+			options: {
+				actionDispatcher: this.actionDispatcher,
+				addModule: this._addModule,
+				initModules: this._initModules,
+				logger: logger,
+				pinia: this.pinia,
+				pluginPersistConfig: this._initPluginPersistConfig(),
+				pluginPersistSetupOverride: this._initPluginPersistConfigSetupOverride,
+				pluginPersistSetup: this._initPluginPersistConfigSetup,
+				pluginPersistType: this._initPluginPersistType,
+				storeConfig: this._init()
+			}
+		};
+	}
+
+	_addModule(key, storeConfig, actionDispatcher, pluginPersistType, pluginPersistSetup, pluginPersistConfig, pluginPersistSetupOverride, pinia, logger) {
+		if (pluginPersistType && pluginPersistSetup && pluginPersistConfig && pluginPersistConfig[key])
+			pluginPersistSetup(pluginPersistType, storeConfig, pluginPersistConfig['root'], pluginPersistSetupOverride);
+		actionDispatcher[key] = storeConfig.dispatcher;
+		delete storeConfig.dispatcher;
+		const storeFunc = defineStore(key, storeConfig);
+		GlobalUtility.$store[key] = storeFunc(pinia);
+		GlobalUtility.$store[key].$logger = logger;
+	}
+
+	_init() {
+		throw new NotImplementedError();
+	}
+
+	_initModules() {
+		throw new NotImplementedError();
+	}
+
+	_initPluginPersist() {
+		if (this._initPluginPersistType() === BaseStore.PersistanceTypePersist) {
+			this.pinia.use(piniaPluginPersistedState);
+			return;
+		}
+		if (this._initPluginPersistType() === BaseStore.PersistanceTypePersist2) {
+			const installPersistedStatePlugin = createPersistedStatePlugin();
+			this.pinia.use((context) => installPersistedStatePlugin(context));
+			return;
+		}
+		if (this._initPluginPersistType() === BaseStore.PersistanceTypeOverride) {
+			const override = this._initPluginPersistOverride();
+			if (override) {
+				override(this.pinia);
+				return;
+			}
+		}
+
+		throw Error('Unknown persistance engine for Pinia store.');
+	}
+
+	_initPluginPersistConfig() {
+		return null;
+	}
+
+	_initPluginPersistOverride() {
+		return null;
+	}
+
+	_initPluginPersistType() {
+		return BaseStore.PersistanceTypePersist;
+	}
+
+	_initPluginPersistConfigSetup(type, storeConfig, persistConfig, override) {
+		if (type === BaseStore.PersistanceTypePersist) {
+			storeConfig.persist = persistConfig;
+			return;
+		}
+		if (type === BaseStore.PersistanceTypePersist2) {
+			storeConfig.persistedState = persistConfig;
+			return;
+		}
+		if (type === BaseStore.PersistanceTypeOverride) {
+			if (override) {
+				override(storeConfig, persistConfig);
+				return;
+			}
+		}
+
+		throw Error('Unknown persistance engine for Pinia store.');
+	}
+
+	_initPluginPersistConfigSetupOverride(storeConfig, persistConfig) {
+	}
+
+	static PersistanceTypeOverride = 'override';
+	static PersistanceTypePersist = 'persist';
+	static PersistanceTypePersist2 = 'persist2';
+}
+
+export default BaseStore;

package/store/pinia.js

@@ -1,89 +0,0 @@
-import { createPinia, defineStore } from 'pinia';
-import piniaPluginPersistedstate from 'pinia-plugin-persistedstate'
-
-import LibraryConstants from '@thzero/library_client/constants';
-
-import GlobalUtility from '@thzero/library_client/utility/global';
-
-import NotImplementedError from '@thzero/library_common/errors/notImplemented';
-
-// import adminNews from './admin/news/pinia';
-// import adminUsers from './admin/users/pinia';
-
-import news from './news/pinia';
-import user from './user/pinia';
-
-class BaseStore {
-	async initialize() {
-		this.pinia = createPinia();
-
-		const pluginPersist = this._initPluginPersist();
-		if (pluginPersist) {
-			this.pinia.use(piniaPluginPersistedstate);
-		}
-
-		return this.pinia;
-	}
-
-	setup() {
-		const logger = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_LOGGER);
-		return {
-			func: {
-				install(app, options) {
-					const storeConfig = options.storeConfig;
-					
-					options.actionDispatcher = storeConfig.dispatcher;
-					if (!options.actionDispatcher) 
-						options.actionDispatcher = {};
-
-					if (options.pluginPersist && options.pluginPersist['root'])
-						storeConfig.persist = options.pluginPersist['root'];
-
-					const storeFunc = defineStore('main', storeConfig);
-					GlobalUtility.$store = storeFunc(options.pinia);
-					GlobalUtility.$store.$logger = options.logger;
-
-					// options.addModule('adminNews', adminNews, options.actionDispatcher, options.pluginPersist, options.pinia, logger);
-					// options.addModule('adminUsers', adminUsers, options.actionDispatcher, options.pluginPersist, options.pinia, logger);
-					options.addModule('news', news, options.actionDispatcher, options.pluginPersist, options.pinia, logger);
-					options.addModule('user', user, options.actionDispatcher, options.pluginPersist, options.pinia, logger);
-					options.initModules();
-					GlobalUtility.$store.dispatcher = options.actionDispatcher;
-				}
-			},
-			options: {
-				actionDispatcher: this.actionDispatcher,
-				addModule: this._addModule,
-				initModules: this._initModules,
-				logger: logger,
-				pinia: this.pinia,
-				pluginPersist: this._initPluginPersist(),
-				storeConfig: this._init()
-			}
-		};
-	}
-
-	_addModule(key, storeConfig, actionDispatcher, pluginPersist, pinia, logger) {
-		if (pluginPersist && pluginPersist[key])
-			storeConfig.persist = pluginPersist[key];
-		actionDispatcher[key] = storeConfig.dispatcher;
-		delete storeConfig.dispatcher;
-		const storeFunc = defineStore(key, storeConfig);
-		GlobalUtility.$store[key] = storeFunc(pinia);
-		GlobalUtility.$store[key].$logger = logger;
-	}
-
-	_init() {
-		throw new NotImplementedError();
-	}
-
-	_initModules() {
-		throw new NotImplementedError();
-	}
-
-	_initPluginPersist() {
-		return null;
-	}
-}
-
-export default BaseStore;