@fy-/fws-vue 2.1.6 → 2.1.8

package/env.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="vite/client" />
-declare module "*.vue" {
-  import type { DefineComponent } from "vue";
-  const component: DefineComponent<{}, {}, any>;
-  export default component;
+declare module '*.vue' {
+  import type { DefineComponent } from 'vue'
+
+  // eslint-disable-next-line ts/no-empty-object-type
+  const component: DefineComponent<{}, {}, any>
+  export default component
 }

package/index.ts

@@ -1,23 +1,33 @@
-import type { Plugin, App } from "vue";
-import i18next, { t } from "i18next";
-import mitt from "mitt";
-import { Emitter } from "mitt";
-import { useServerRouter } from "./stores/serverRouter";
-import { useEventBus, Events } from "./composables/event-bus";
-import { i18nextPromise, useTranslation } from "./composables/translations";
+import type { Emitter } from 'mitt'
+import type { App, Plugin } from 'vue'
+import type { Events } from './composables/event-bus'
+import i18next from 'i18next'
+import mitt from 'mitt'
+import CmsArticleBoxed from './components/fws/CmsArticleBoxed.vue'
+import CmsArticleSingle from './components/fws/CmsArticleSingle.vue'
+import DataTable from './components/fws/DataTable.vue'
+import FilterData from './components/fws/FilterData.vue'
+import UserData from './components/fws/UserData.vue'
+import { ClientOnly } from './components/ssr/ClientOnly'
+import DefaultBreadcrumb from './components/ui/DefaultBreadcrumb.vue'
+import DefaultConfirm from './components/ui/DefaultConfirm.vue'
+
+import DefaultDropdown from './components/ui/DefaultDropdown.vue'
+import DefaultDropdownLink from './components/ui/DefaultDropdownLink.vue'
+import DefaultGallery from './components/ui/DefaultGallery.vue'
+import CollapseTransition from './components/ui/transitions/CollapseTransition.vue'
+import ExpandTransition from './components/ui/transitions/ExpandTransition.vue'
+
+import FadeTransition from './components/ui/transitions/FadeTransition.vue'
+import ScaleTransition from './components/ui/transitions/ScaleTransition.vue'
+import { useEventBus } from './composables/event-bus'
+import { useRest } from './composables/rest'
+import { useSeo } from './composables/seo'
 import {
   initVueClient,
   initVueServer,
   isServerRendered,
-} from "./composables/ssr";
-import { useSeo } from "./composables/seo";
-import {
-  useUserStore,
-  useUserCheck,
-  useUserCheckAsync,
-  useUserCheckAsyncSimple,
-} from "./stores/user";
-import { ClientOnly } from "./components/ssr/ClientOnly";
+} from './composables/ssr'
 import {
   cropText,
   formatBytes,
@@ -25,118 +35,111 @@ import {
   formatDatetime,
   formatTimeago,
   getContrastingTextColor,
-} from "./composables/templating";
-import { useRest } from "./composables/rest";
-export * from "./stores/serverRouter";
-export type * from "./types";
-
+} from './composables/templating'
+import { i18nextPromise, useTranslation } from './composables/translations'
+import { useServerRouter } from './stores/serverRouter'
+import {
+  useUserCheck,
+  useUserCheckAsync,
+  useUserCheckAsyncSimple,
+  useUserStore,
+} from './stores/user'
 // Components/UI/Transitions
-import SlideTransition from "./components/ui/transitions/SlideTransition.vue";
-import ExpandTransition from "./components/ui/transitions/ExpandTransition.vue";
-import CollapseTransition from "./components/ui/transitions/CollapseTransition.vue";
-import ScaleTransition from "./components/ui/transitions/ScaleTransition.vue";
-import FadeTransition from "./components/ui/transitions/FadeTransition.vue";
-
+import SlideTransition from './components/ui/transitions/SlideTransition.vue'
 // Components/UI
-import DefaultInput from "./components/ui/DefaultInput.vue";
-import DefaultModal from "./components/ui/DefaultModal.vue";
-import DefaultConfirm from "./components/ui/DefaultConfirm.vue";
-import DefaultPaging from "./components/ui/DefaultPaging.vue";
-import DefaultBreadcrumb from "./components/ui/DefaultBreadcrumb.vue";
-import DefaultLoader from "./components/ui/DefaultLoader.vue";
-import DefaultSidebar from "./components/ui/DefaultSidebar.vue";
-import DefaultGallery from "./components/ui/DefaultGallery.vue";
-import DefaultDropdown from "./components/ui/DefaultDropdown.vue";
-import DefaultDropdownLink from "./components/ui/DefaultDropdownLink.vue";
-import DefaultTagInput from "./components/ui/DefaultTagInput.vue";
-import DefaultNotif from "./components/ui/DefaultNotif.vue";
+import DefaultInput from './components/ui/DefaultInput.vue'
+import DefaultLoader from './components/ui/DefaultLoader.vue'
+import DefaultModal from './components/ui/DefaultModal.vue'
+import DefaultNotif from './components/ui/DefaultNotif.vue'
+import DefaultPaging from './components/ui/DefaultPaging.vue'
+import DefaultSidebar from './components/ui/DefaultSidebar.vue'
+import DefaultTagInput from './components/ui/DefaultTagInput.vue'
 // Components/FWS
-import UserFlow from "./components/fws/UserFlow.vue";
-import DataTable from "./components/fws/DataTable.vue";
-import FilterData from "./components/fws/FilterData.vue";
-import CmsArticleBoxed from "./components/fws/CmsArticleBoxed.vue";
-import CmsArticleSingle from "./components/fws/CmsArticleSingle.vue";
-import UserOAuth2 from "./components/fws/UserOAuth2.vue";
-import UserData from "./components/fws/UserData.vue";
-import UserProfile from "./components/fws/UserProfile.vue";
-import UserProfileStrict from "./components/fws/UserProfileStrict.vue";
+import UserFlow from './components/fws/UserFlow.vue'
+import UserOAuth2 from './components/fws/UserOAuth2.vue'
+import UserProfile from './components/fws/UserProfile.vue'
+import UserProfileStrict from './components/fws/UserProfileStrict.vue'
 // Css
-import "./style.css";
+import './style.css'
+
+export * from './stores/serverRouter'
+export type * from './types'
 
 function createFWS(): Plugin {
-  const eventBus: Emitter<Events> = mitt<Events>();
+  // @ts-expect-error: Emitter<Events> is not assignable to Emitter<Events>
+  const eventBus: Emitter<Events> = mitt<Events>()
 
   return {
     install(app: App) {
       if (app.config.globalProperties) {
-        app.config.globalProperties.$eventBus = eventBus;
-        app.provide("fwsVueEventBus", eventBus);
+        app.config.globalProperties.$eventBus = eventBus
+        app.provide('fwsVueEventBus', eventBus)
 
         // i18next
-        app.config.globalProperties.$t = i18next.t;
-        app.provide("fwsVueTranslate", i18next.t);
+        app.config.globalProperties.$t = i18next.t
+        app.provide('fwsVueTranslate', i18next.t)
 
         // Templating
-        app.config.globalProperties.$cropText = cropText;
-        app.config.globalProperties.$formatBytes = formatBytes;
-        app.config.globalProperties.$formatTimeago = formatTimeago;
-        app.config.globalProperties.$formatDatetime = formatDatetime;
-        app.config.globalProperties.$formatDate = formatDate;
-        app.config.globalProperties.$getContrastingTextColor =
-          getContrastingTextColor;
+        app.config.globalProperties.$cropText = cropText
+        app.config.globalProperties.$formatBytes = formatBytes
+        app.config.globalProperties.$formatTimeago = formatTimeago
+        app.config.globalProperties.$formatDatetime = formatDatetime
+        app.config.globalProperties.$formatDate = formatDate
+        app.config.globalProperties.$getContrastingTextColor
+          = getContrastingTextColor
 
-        app.component("ClientOnly", ClientOnly);
+        app.component('ClientOnly', ClientOnly)
       }
     },
-  };
+  }
 }
 
 export {
-  i18nextPromise,
-  useTranslation,
-  createFWS,
-  useServerRouter,
-  useEventBus,
-  initVueClient,
-  initVueServer,
-  isServerRendered,
-  useSeo,
-  useUserStore,
-  useUserCheck,
-  useUserCheckAsync,
-  useRest,
-  useUserCheckAsyncSimple,
-
-  // Components
-  // UI/Transitions
-  SlideTransition,
-  ExpandTransition,
+  CmsArticleBoxed,
+  CmsArticleSingle,
   CollapseTransition,
-  ScaleTransition,
-  FadeTransition,
-
+  createFWS,
+  DataTable,
+  DefaultBreadcrumb,
+  DefaultConfirm,
+  DefaultDropdown,
+  DefaultDropdownLink,
+  DefaultGallery,
   // UI
   DefaultInput,
+  DefaultLoader,
   DefaultModal,
-  DefaultConfirm,
+  DefaultNotif,
+
   DefaultPaging,
-  DefaultBreadcrumb,
-  DefaultLoader,
   DefaultSidebar,
-  DefaultGallery,
-  DefaultDropdown,
-  DefaultDropdownLink,
   DefaultTagInput,
-  DefaultNotif,
+  ExpandTransition,
+  FadeTransition,
 
+  FilterData,
+  i18nextPromise,
+  initVueClient,
+  initVueServer,
+  isServerRendered,
+  ScaleTransition,
+  // Components
+  // UI/Transitions
+  SlideTransition,
+  useEventBus,
+  UserData,
+  useRest,
   // FWS
   UserFlow,
   UserOAuth2,
-  DataTable,
-  FilterData,
-  CmsArticleBoxed,
-  CmsArticleSingle,
-  UserData,
+
   UserProfile,
   UserProfileStrict,
-};
+  useSeo,
+  useServerRouter,
+  useTranslation,
+  useUserCheck,
+  useUserCheckAsync,
+  useUserCheckAsyncSimple,
+  useUserStore,
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@fy-/fws-vue",
-  "version": "2.1.06",
+  "version": "2.1.8",
   "author": "Florian 'Fy' Gasquez <m@fy.to>",
   "license": "MIT",
+  "homepage": "https://github.com/fy-to/FWJS#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fy-to/FWJS.git"
@@ -10,11 +11,6 @@
   "bugs": {
     "url": "https://github.com/fy-to/FWJS/issues"
   },
-  "homepage": "https://github.com/fy-to/FWJS#readme",
-  "main": "index.ts",
-  "module": "index.ts",
-  "typings": "index.ts",
-  "types": "index.ts",
   "exports": {
     ".": {
       "import": "./index.ts",
@@ -26,12 +22,16 @@
       "require": "./style.css"
     }
   },
+  "main": "index.ts",
+  "module": "index.ts",
+  "typings": "index.ts",
+  "types": "index.ts",
   "peerDependencies": {
     "@fy-/fws-js": "^0.0.x",
     "@fy-/fws-types": "^0.0.x",
+    "@unhead/schema-org": "1.9.x",
     "@unhead/ssr": "^1.9.x",
     "@unhead/vue": "^1.9.x",
-    "@unhead/schema-org": "1.9.x",
     "@vuelidate/core": "^2.0.x",
     "@vuelidate/validators": "^2.0.x",
     "@vueuse/core": "^10.x.x",

package/stores/serverRouter.ts

@@ -1,15 +1,15 @@
-import { defineStore, Pinia } from "pinia";
-import type { Router } from "vue-router";
+import type { Router } from 'vue-router'
+import { defineStore } from 'pinia'
 
 export interface ServerRouterState {
-  _router: any | null;
-  status: number;
-  redirect?: string;
-  results: Record<number, any | undefined>;
+  _router: any | null
+  status: number
+  redirect?: string
+  results: Record<number, any | undefined>
 }
 
 export const useServerRouter = defineStore({
-  id: "routerStore",
+  id: 'routerStore',
   state: () =>
     ({
       _router: null,
@@ -18,46 +18,46 @@ export const useServerRouter = defineStore({
       results: {},
     }) as ServerRouterState,
   getters: {
-    currentRoute: (state) => state._router?.currentRoute,
-    route: (state) => state._router?.currentRoute,
+    currentRoute: state => state._router?.currentRoute,
+    route: state => state._router?.currentRoute,
   },
   actions: {
     setStatus(status: number) {
-      this.status = status;
+      this.status = status
     },
     _setRouter(_router: Router | null) {
-      (this._router as unknown as Router | null) = _router;
+      (this._router as unknown as Router | null) = _router
     },
     push(path: any, status = 302) {
-      this.status = status;
-      if (status != 302) this.redirect = path;
-      return this._router?.push(path);
+      this.status = status
+      if (status !== 302) this.redirect = path
+      return this._router?.push(path)
     },
     replace(path: any, status = 302) {
-      this.status = status;
-      if (status != 302) this.redirect = path;
-      return this._router?.replace(path);
+      this.status = status
+      if (status !== 302) this.redirect = path
+      return this._router?.replace(path)
     },
     go(delta: number) {
-      this._router?.go(delta);
+      this._router?.go(delta)
     },
     back() {
-      this._router?.go(-1);
+      this._router?.go(-1)
     },
     forward() {
-      this._router?.go(1);
+      this._router?.go(1)
     },
     addResult(id: number, result: any) {
-      this.results[id] = result;
+      this.results[id] = result
     },
     hasResult(id: number) {
-      return this.results[id] !== undefined;
+      return this.results[id] !== undefined
     },
     getResult(id: number) {
-      return this.results[id];
+      return this.results[id]
     },
     removeResult(id: number) {
-      delete this.results[id];
+      delete this.results[id]
     },
   },
-});
+})

package/stores/user.ts

@@ -1,138 +1,145 @@
-import { defineStore } from "pinia";
-import type { User } from "@fy-/fws-types";
-import { APIResult } from "../composables/rest";
-import { rest } from "@fy-/fws-js";
-import { computed } from "vue";
-import { RouteLocation, useRouter } from "vue-router";
-import { useServerRouter } from "./serverRouter";
-import { useEventBus } from "../composables/event-bus";
+import type { User } from '@fy-/fws-types'
+import type { RouteLocation } from 'vue-router'
+import type { APIResult } from '../composables/rest'
+import { rest } from '@fy-/fws-js'
+import { defineStore } from 'pinia'
+import { computed } from 'vue'
+import { useServerRouter } from './serverRouter'
 
-export type UserStore = {
-  user: User | null;
-};
+export interface UserStore {
+  user: User | null
+}
 
 export const useUserStore = defineStore({
-  id: "userStore",
+  id: 'userStore',
   state: (): UserStore => ({
     user: null,
   }),
   getters: {
     isAuth: (state): boolean => {
-      return !(state.user === null);
+      return !(state.user === null)
     },
   },
   actions: {
     async refreshUser() {
-      const user: APIResult = await rest("User:get", "GET").catch((err) => {
-        this.setUser(null);
-      });
-      if (user.result === "success") {
-        this.setUser(user.data);
-      } else {
-        this.setUser(null);
+      const user: APIResult = await rest('User:get', 'GET').catch(() => {
+        this.setUser(null)
+      })
+      if (user.result === 'success') {
+        this.setUser(user.data)
+      }
+      else {
+        this.setUser(null)
       }
     },
     async logout() {
-      const user: APIResult = await rest("User:logout", "POST").catch((err) => {
-        this.setUser(null);
-      });
-      if (user.result === "success") {
-        this.setUser(null);
-      } else {
-        this.setUser(null);
+      const user: APIResult = await rest('User:logout', 'POST').catch(() => {
+        this.setUser(null)
+      })
+      if (user.result === 'success') {
+        this.setUser(null)
+      }
+      else {
+        this.setUser(null)
       }
     },
     setUser(user: User | null) {
-      this.user = user;
+      this.user = user
     },
   },
-});
+})
 
 export async function useUserCheckAsyncSimple(
-  path = "/login",
+  path = '/login',
   redirectLink = false,
 ) {
-  const userStore = useUserStore();
-  await userStore.refreshUser();
-  const isAuth = computed(() => userStore.isAuth);
-  const router = useServerRouter();
+  const userStore = useUserStore()
+  await userStore.refreshUser()
+  const isAuth = computed(() => userStore.isAuth)
+  const router = useServerRouter()
 
   const checkUser = (route: RouteLocation) => {
     if (route.meta.reqLogin) {
       if (!isAuth.value) {
-        if (!redirectLink) router.push(path);
+        if (!redirectLink) {
+          router.push(path)
+        }
         else {
-          router.status = 307;
-          router.push(`${path}?return_to=${route.path}`);
+          router.status = 307
+          router.push(`${path}?return_to=${route.path}`)
         }
       }
     }
-  };
-  checkUser(router.currentRoute);
+  }
+  checkUser(router.currentRoute)
 
   router._router.beforeEach((to: any) => {
-    if (to.fullPath != path) {
-      checkUser(to);
+    if (to.fullPath !== path) {
+      checkUser(to)
     }
-  });
+  })
 }
 
-export async function useUserCheckAsync(path = "/login", redirectLink = false) {
-  const userStore = useUserStore();
-  await userStore.refreshUser();
-  const isAuth = computed(() => userStore.isAuth);
-  const router = useServerRouter();
+export async function useUserCheckAsync(path = '/login', redirectLink = false) {
+  const userStore = useUserStore()
+  await userStore.refreshUser()
+  const isAuth = computed(() => userStore.isAuth)
+  const router = useServerRouter()
 
   const checkUser = (route: RouteLocation) => {
     if (route.meta.reqLogin) {
       if (!isAuth.value) {
-        if (!redirectLink) router.push(path);
+        if (!redirectLink) {
+          router.push(path)
+        }
         else {
-          router.status = 307;
-          router.push(`${path}?return_to=${route.path}`);
+          router.status = 307
+          router.push(`${path}?return_to=${route.path}`)
         }
       }
     }
-  };
-  checkUser(router.currentRoute);
+  }
+  checkUser(router.currentRoute)
 
   router._router.afterEach(async () => {
-    await userStore.refreshUser();
-  });
+    await userStore.refreshUser()
+  })
   router._router.beforeEach((to: any) => {
-    if (to.fullPath != path) {
-      checkUser(to);
+    if (to.fullPath !== path) {
+      checkUser(to)
     }
-  });
+  })
 }
 
-export function useUserCheck(path = "/login", redirectLink = false) {
-  const userStore = useUserStore();
-  const isAuth = computed(() => userStore.isAuth);
-  const router = useServerRouter();
+export function useUserCheck(path = '/login', redirectLink = false) {
+  const userStore = useUserStore()
+  const isAuth = computed(() => userStore.isAuth)
+  const router = useServerRouter()
 
   const checkUser = (route: RouteLocation) => {
     if (route.meta.reqLogin) {
       if (!isAuth.value) {
-        if (!redirectLink) router.push(path);
+        if (!redirectLink) {
+          router.push(path)
+        }
         else {
-          router.status = 307;
-          router.push(`${path}?return_to=${route.path}`);
+          router.status = 307
+          router.push(`${path}?return_to=${route.path}`)
         }
       }
     }
-  };
+  }
   userStore.refreshUser().then(() => {
     if (router.currentRoute) {
-      checkUser(router.currentRoute);
+      checkUser(router.currentRoute)
     }
-  });
+  })
   router._router.afterEach(async () => {
-    await userStore.refreshUser();
-  });
+    await userStore.refreshUser()
+  })
   router._router.beforeEach((to: any) => {
-    if (to.fullPath != path) {
-      checkUser(to);
+    if (to.fullPath !== path) {
+      checkUser(to)
     }
-  });
+  })
 }