@thzero/library_client_vue3_store_pinia 0.16.10

package/README.md

@@ -0,0 +1,9 @@
+![GitHub package.json version](https://img.shields.io/github/package-json/v/thzero/library_client_vue3_store_pinia)
+![David](https://img.shields.io/david/thzero/library_client_vue3_store_pinia)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# library_client_vue3_store_pinia
+
+An opinionated library for vue3 with pinia store for the library_client_vue3.
+
+[![NPM](https://nodei.co/npm/@thzero/library_common.png?compact=true)](https://npmjs.org/package/@thzero/library_client_vue3_store_pinia)

package/license.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2017 thZero.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@thzero/library_client_vue3_store_pinia",
+  "version": "0.16.10",
+  "version_major": 0,
+  "version_minor": 16,
+  "version_patch": 10,
+  "version_date": "11/23/2022",
+  "description": "An opinionated library of common functionality to bootstrap a VueJs based SPA application.",
+  "author": "thZero",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thzero/library_client_vue3_store_pinia.git"
+  },
+  "bugs": {
+    "url": "https://github.com/thzero/library_client_vue3_store_pinia/issues"
+  },
+  "homepage": "https://github.com/thzero/library_client_vue3_store_pinia#readme",
+  "scripts": {
+    "cli-update": "./node_modules/.bin/library-cli --updateversion --pi",
+    "cli-update-w": ".\\node_modules\\.bin\\library-cli --updateversion --pi",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@thzero/library_client": "^0.16",
+    "@thzero/library_client_vue3": "^0.16",
+    "@thzero/library_common": "^0.16",
+    "pinia": "^2.0.24",
+    "pinia-plugin-persist": "^1.0.0",
+    "vue": "^3.2.13"
+  }
+}

package/service/store/pinia.js

@@ -0,0 +1,19 @@
+import GlobalUtility from '@thzero/library_client/utility/global';
+
+import Service from '@thzero/library_client/service/index';
+
+class PiniaStoreService extends Service {
+	get dispatcher() {
+		return GlobalUtility.$store.dispatcher;
+	}
+
+	get getters() {
+		return GlobalUtility.$store;
+	}
+
+	get state() {
+		return GlobalUtility.$store;
+	}
+}
+
+export default PiniaStoreService;

package/store/admin/news/pinia.js

@@ -0,0 +1,76 @@
+import LibraryConstants from '@thzero/library_client/constants';
+
+import GlobalUtility from '@thzero/library_client/utility/global';
+import LibraryUtility from '@thzero/library_common/utility';
+
+import Response from '@thzero/library_common/response';
+
+const store = {
+	state: {
+		news: null
+	},
+	actions: {
+		async createAdminNews(correlationId, item) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_ADMIN_NEWS);
+			const response = await service.create(correlationId, item);
+			this.$logger.debug('store.admin.news', 'createAdminNews', 'response', response);
+			if (Response.hasSucceeded(response)) {
+				const item = response.success && response.results ? response.results : null;
+				this.$logger.debug('store.admin.news', 'setAdminNews', 'items.a', item, correlationId);
+				this.$logger.debug('store.admin.news', 'setAdminNews', 'items.b', this.news, correlationId);
+				this.news = LibraryUtility.updateArrayById(this.news, item);
+				this.$logger.debug('store.admin.news', 'setAdminNews', 'items.c', this.news, correlationId);
+			}
+			return response;
+		},
+		async deleteAdminNews(correlationId, id) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_ADMIN_NEWS);
+			const response = await service.delete(correlationId, id);
+			this.$logger.debug('store.admin.news', 'deleteAdminNews', 'response', response);
+			if (Response.hasSucceeded(response)) {
+				this.news = LibraryUtility.deleteArrayById(this.news, id);
+				GlobalUtility.$store.dispatcher.news.delete(correlationId, id);
+			}
+			return response;
+		},
+		async searchAdminNews(correlationId, params) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_ADMIN_NEWS);
+			const response = await service.search(correlationId, params);
+			this.$logger.debug('store.admin.news', 'searchAdminNews', 'response', response);
+			const list = response.success && response.results ? response.results.data : null;
+			this.$logger.debug('store.admin.news', 'setAdminNewsListing', 'list.a', list, correlationId);
+			this.$logger.debug('store.admin.news', 'setAdminNewsListing', 'list.b', this.news, correlationId);
+			this.news = list;
+			this.$logger.debug('store.admin.news', 'setAdminNewsListing', 'list.c', this.news, correlationId);
+		},
+		async updateAdminNews(correlationId, item) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_ADMIN_NEWS);
+			const response = await service.update(correlationId, item);
+			this.$logger.debug('store.admin.news', 'updateAdminNews', 'response', response);
+			if (Response.hasSucceeded(response)) {
+				const item = response.success && response.results ? response.results : null;
+				this.$logger.debug('store.admin.news', 'setAdminNews', 'items.a', item, correlationId);
+				this.$logger.debug('store.admin.news', 'setAdminNews', 'items.b', this.news, correlationId);
+				this.news = LibraryUtility.updateArrayById(this.news, item);
+				this.$logger.debug('store.admin.news', 'setAdminNews', 'items.c', this.news, correlationId);
+			}
+			return response;
+		}
+	},
+	dispatcher: {
+		async createAdminNews(correlationId, item) {
+			return await GlobalUtility.$store.createAdminNews(correlationId, item);
+		},
+		async deleteAdminNews(correlationId, id) {
+			return await GlobalUtility.$store.deleteAdminNews(correlationId, id);
+		},
+		async searchNews(correlationId, params) {
+			await GlobalUtility.$store.searchAdminNews(correlationId, params);
+		},
+		async updateAdminNews(correlationId, item) {
+			return await GlobalUtility.$store.updateAdminNews(correlationId, item);
+		}
+	}
+};
+
+export default store;

package/store/admin/users/pinia.js

@@ -0,0 +1,63 @@
+import LibraryConstants from '@thzero/library_client/constants';
+
+import GlobalUtility from '@thzero/library_client/utility/global';
+import LibraryUtility from '@thzero/library_common/utility';
+
+import Response from '@thzero/library_common/response';
+
+const store = {
+	state: {
+		users: null
+	},
+	actions: {
+		async deleteAdminUser(correlationId, id) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_ADMIN_USERS);
+			const response = await service.delete(correlationId, id);
+			this.$logger.debug('store.admin.users', 'deleteAdminUser', 'response', response);
+			if (Response.hasSucceeded(response)) {
+				commit('deleteAdminUser', { correlationId: correlationId, id: id });
+				this.users = LibraryUtility.deleteArrayById(this.users, id);
+				GlobalUtility.$store.dispatcher.users.delete(correlationId, id);
+			}
+			return response;
+		},
+		async searchAdminUsers(correlationId, params) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_ADMIN_USERS);
+			const response = await service.search(correlationId, params);
+			this.$logger.debug('store.admin.users', 'searchAdminUsers', 'response', response);
+			if (Response.hasSucceeded(response)) {
+				const list = response.success && response.results ? response.results.data : null;
+				this.$logger.debug('store.admin.users', 'setAdminUsersListing', 'list.a', list, correlationId);
+				this.$logger.debug('store.admin.users', 'setAdminUsersListing', 'list.b', this.users, correlationId);
+				this.users = list;
+				this.$logger.debug('store.admin.users', 'setAdminUsersListing', 'list.c', this.users, correlationId);
+			}
+		},
+		async updateAdminUser(correlationId, item) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_ADMIN_USERS);
+			const response = await service.update(correlationId, item);
+			this.$logger.debug('store.admin.users', 'updateAdminUser', 'response', response);
+			if (Response.hasSucceeded(response)) {
+				const item = response.results;
+				this.$logger.debug('store.admin.users', 'setAdminUsers', 'items.a', item, correlationId);
+				this.$logger.debug('store.admin.users', 'setAdminUsers', 'items.b', this.users, correlationId);
+				this.users = LibraryUtility.updateArrayById(this.users, item);
+				this.$logger.debug('store.admin.users', 'setAdminUsers', 'items.c', this.users, correlationId);
+			}
+			return response;
+		}
+	},
+	dispatcher: {
+		async deleteAdminUser(correlationId, id) {
+			return await GlobalUtility.$store.deleteAdminUser(correlationId, id);
+		},
+		async searchAdminUsers(correlationId, params) {
+			await GlobalUtility.$store.searchAdminUsers(correlationId, params);
+		},
+		async updateAdminUser(correlationId, item) {
+			return await GlobalUtility.$store.updateAdminUser(correlationId, item);
+		}
+	}
+};
+
+export default store;

package/store/news/pinia.js

@@ -0,0 +1,38 @@
+import LibraryConstants from '@thzero/library_client/constants';
+
+import GlobalUtility from '@thzero/library_client/utility/global';
+
+const store = {
+	state: () => ({
+		latest: null
+	}),
+	actions: {
+		async getLatestNews(correlationId) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_NEWS);
+			const response = await service.latest(correlationId);
+			this.$logger.debug('store.news', 'getLatestNews', 'response', response);
+			// commit('setLatestNews', { correlationId: correlationId, latest: response.success && response.results ? response.results.data : null });
+			const latest = response.success && response.results ? response.results.data : null;
+			this.$logger.debug('store.news', 'setLatest', 'item.a', latest, correlationId);
+			this.$logger.debug('store.news', 'setLatest', 'item.b', this.latest, correlationId);
+			this.latest = latest;
+			this.$logger.debug('store.news', 'setLatest', 'item.c', this.latest, correlationId);
+		}
+	},
+	mutations: {
+		// setLatestNews(state, params) {
+		// 	this.$logger.debug('store.news', 'setLatest', 'item.a', params.latest, params.correlationId);
+		// 	this.$logger.debug('store.news', 'setLatest', 'item.b', state.latest, params.correlationId);
+		// 	state.latest = params.latest;
+		// 	this.$logger.debug('store.news', 'setLatest', 'item.c', state.latest, params.correlationId);
+		// }
+	},
+	dispatcher: {
+		async getLatest(correlationId) {
+			// await GlobalUtility.$store.dispatch('getLatestNews', correlationId);
+			await GlobalUtility.$store.news.getLatestNews(correlationId);
+		}
+	}
+};
+
+export default store;

package/store/pinia.js

@@ -0,0 +1,73 @@
+import { createPinia, defineStore } from 'pinia';
+import piniaPersist from 'pinia-plugin-persist';
+
+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';
+// import adminUsers from './admin/users';
+
+import news from './news/pinia';
+import user from './user/pinia';
+
+class BaseStore {
+	async initialize() {
+		this.pinia = createPinia();
+
+		this.actionDispatcher = {};
+
+		const storeConfig = this._init();
+
+		const pluginPersist = this._initPluginPersist();
+		if (pluginPersist) {
+			storeConfig.persist = pluginPersist;
+			this.pinia.use(piniaPersist);
+		}
+
+		this.actionDispatcher = storeConfig.dispatcher;
+
+		const logger = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_LOGGER);
+
+		const storeFunc = defineStore('main', storeConfig);
+		GlobalUtility.$store = storeFunc(this.pinia);
+		GlobalUtility.$store.$logger = logger;
+
+		// this._addModule('adminNews', adminNews);
+		// this._addModule('adminUsers', adminUsers);
+		this._addModule('news', news, logger);
+		this._addModule('user', user, logger);
+		this._initModules();
+		GlobalUtility.$store.dispatcher = this.actionDispatcher;
+
+		console.debug(GlobalUtility);
+		console.debug(GlobalUtility.$store);
+		console.debug(GlobalUtility.$store.dispatcher);
+
+		return this.pinia;
+	}
+
+	_addModule(name, storeConfig, logger) {
+		this.actionDispatcher[name] = storeConfig.dispatcher;
+		delete storeConfig.dispatcher;
+		const storeFunc = defineStore(name, storeConfig);
+		GlobalUtility.$store[name] = storeFunc(this.pinia);
+		GlobalUtility.$store[name].$logger = logger;
+	}
+
+	_init() {
+		throw new NotImplementedError();
+	}
+
+	_initModules() {
+		throw new NotImplementedError();
+	}
+
+	_initPluginPersist() {
+		return null;
+	}
+}
+
+export default BaseStore;

package/store/user/pinia.js

@@ -0,0 +1,114 @@
+import LibraryConstants from '@thzero/library_client/constants';
+
+import GlobalUtility from '@thzero/library_client/utility/global';
+import VueUtility from '@thzero/library_client_vue3/utility';
+
+import Response from '@thzero/library_common/response';
+
+const store = {
+	state: () => ({
+		authCompleted: false,
+		claims: null,
+		isLoggedIn: false,
+		token: null,
+		tokenResult: null,
+		user: null
+	}),
+	actions: {
+		async refreshUserSettings(correlationId) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_USER);
+			const response = await service.refreshSettings(correlationId, this.user);
+			this.$logger.debug('store.user', 'refreshUserSettings', 'response', response);
+			if (Response.hasSucceeded(response) && response.results)
+				this.setUser(response.results);
+			return response;
+		},
+		async resetUser(correlationId) {
+			this.$patch({
+				claims: null,
+				isLoggedIn: false,
+				token: null,
+				tokenResult: null,
+				user: null
+			});
+		},
+		async setUserAuthCompleted(correlationId, authCompleted) {
+			this.authCompleted = authCompleted;
+		},
+		async setUserClaims(correlationId, claims) {
+			this.claims = claims;
+		},
+		async setUserLoggedIn(correlationId, isLoggedIn) {
+			this.isLoggedIn = isLoggedIn;
+		},
+		async setUserSettings(correlationId, settings) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_USER);
+			settings = VueUtility.settings().mergeUser(params.correlationId, settings);
+			const response = await service.updateSettings(params.correlationId, this.user, settings);
+			this.$logger.debug('store.user', 'setUserSettings', 'response', response);
+			if (Response.hasSucceeded(response) && response.results)
+				this.setUser(correlationId, response.results);
+			return response;
+		},
+		async setUserSettings2(correlationId, settings) {
+			const service = GlobalUtility.$injector.getService(LibraryConstants.InjectorKeys.SERVICE_USER);
+			settings = VueUtility.settings().mergeUser(params.correlationId, settings);
+			const response = await service.updateSettings(params.correlationId, this.user, settings);
+			this.$logger.debug('store.user', 'setUserSettings', 'response', response);
+			if (Response.hasSucceeded(response) && response.results) {
+				// commit('setUserSettings', { correlationId: params.correlationId, user: response.results });
+				const user = response.results;
+				user.settings = VueUtility.settings().mergeUser(correlationId, user.settings);
+				this.user = user;
+			}
+			return response;
+		},
+		async setUserTokenResult(correlationId, tokenResult) {
+			this.$patch({
+				tokenResult: null,
+				token: tokenResult ? tokenResult.token : null
+			});
+		},
+		async setUser(correlationId, user) {
+			if (user)
+				user.settings = VueUtility.settings().mergeUser(correlationId, user.settings);
+			this.user = user;
+		}
+	},
+	dispatcher: {
+		async refreshUserSettings(correlationId) {
+			// await GlobalUtility.$store.dispatch('refreshUserSettings', correlationId);
+			await GlobalUtility.$store.user.refreshUserSettings(correlationId);
+		},
+		async resetUser(correlationId) {
+			// await GlobalUtility.$store.dispatch('resetUser', correlationId);
+			await GlobalUtility.$store.user.resetUser(correlationId);
+		},
+		async setAuthCompleted(correlationId, authCompleted) {
+			// await GlobalUtility.$store.dispatch('setUserAuthCompleted', { correlationId: correlationId, authCompleted: authCompleted });
+			await GlobalUtility.$store.user.setUserAuthCompleted(correlationId, authCompleted);
+		},
+		async setClaims(correlationId, claims) {
+			// await GlobalUtility.$store.dispatch('setUserClaims', { correlationId: correlationId, authCompleted: claims });
+			await GlobalUtility.$store.user.setUserClaims(correlationId, claims);
+		},
+		async setLoggedIn(correlationId, isLoggedIn) {
+			// await GlobalUtility.$store.dispatch('setUserLoggedIn', { correlationId: correlationId, isLoggedIn: isLoggedIn });
+			await GlobalUtility.$store.user.setUserLoggedIn(correlationId, isLoggedIn);
+		},
+		async setUserSettings(correlationId, settings) {
+			// return await GlobalUtility.$store.dispatch('setUserSettings', { correlationId: correlationId, settings: settings });
+			await GlobalUtility.$store.user.setUserSettings(correlationId, settings);
+		},
+		async setTokenResult(correlationId, tokenResult) {
+			// await GlobalUtility.$store.dispatch('setUserTokenResult', { correlationId: correlationId, tokenResult: tokenResult });
+			await GlobalUtility.$store.user.setUserTokenResult(correlationId, tokenResult);
+		},
+		async setUser(correlationId, user) {
+			// await GlobalUtility.$store.dispatch('setUser', { correlationId: correlationId, user: user });
+			await GlobalUtility.$store.user.setUser(correlationId, user);
+		}
+	}
+};
+
+export default store;