@nitra/vite-boot 4.0.8 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitra/vite-boot",
-  "version": "4.0.8",
+  "version": "4.1.0",
   "description": "Vite boot",
   "type": "module",
   "exports": {
@@ -26,7 +26,7 @@
     "src"
   ],
   "dependencies": {
-    "@apollo/client": "^4.0.5",
+    "@apollo/client": "^4.0.6",
     "@nitra/jwt-decode": "^1.2.0",
     "graphql-ws": "^6.0.6",
     "pinia": "^3.0.3",

package/src/apollo.js

@@ -2,7 +2,6 @@ import { ApolloClient, InMemoryCache, createHttpLink, from, split } from '@apoll
 import { setContext } from '@apollo/client/link/context'
 import { GraphQLWsLink } from '@apollo/client/link/subscriptions'
 import { getMainDefinition } from '@apollo/client/utilities'
-// import { console } from '@nitra/console'
 import { createClient } from 'graphql-ws'
 import { checkToken, getToken } from './token.js'
 import { user } from './user.js'
@@ -26,9 +25,9 @@ export function logout() {
 }
 
 /**
- *
- * @param headers
- * @returns {object}
+ * Готує заголовки з JWT та роллю Hasura
+ * @param {Record<string, string>} headers - Початкові заголовки запиту
+ * @returns {{headers: Record<string, string>}} - Обʼєкт з підготовленими заголовками
  */
 function prepareHeaders(headers = {}) {
   const token = getToken()

package/src/login.js

@@ -8,7 +8,7 @@ import { setUser } from './user.js'
  * Автоматичний вхід користувача
  * @returns {Promise<void>}
  */
-export async function autoLogin() {
+export function autoLogin() {
   const token = getToken()
   if (!token) {
     return
@@ -19,16 +19,16 @@ export async function autoLogin() {
     return
   }
 
-  return defaultLogin(check.decoded, token)
+  defaultLogin(check.decoded, token)
 }
 
 /**
  * Вхід або на попередню або на кореневу сторінку
- * @param {object} decoded
- * @param {string} raw? - необов'язково, але потрібно якщо використовується localStorage
- * @param raw
+ * @param {object} decoded - Розкодований JWT з Hasura claims
+ * @param {string} raw - JWT як рядок (для localStorage)
+ * @returns {void}
  */
-export async function defaultLogin(decoded, raw) {
+export function defaultLogin(decoded, raw) {
   // Якщо задано що токен  з localStorage
   localStorage.setItem('__session', raw)
 

package/src/router.js

@@ -4,17 +4,17 @@ import { setUser, user } from './user.js'
 export let router
 
 /**
- *
- * @param r
+ * Зберігає інстанс роутера для подальшого використання
+ * @param {import('vue-router').Router} r - Інстанс роутера
  */
 export function setRouter(r) {
   router = r
 }
 
 /**
- *
- * @param to
- * @returns {boolean}
+ * Перевіряє доступ користувача до маршруту
+ * @param {import('vue-router').RouteLocationNormalized} to - Маршрут призначення
+ * @returns {boolean} - Чи дозволено доступ
  */
 export function canUserAccess(to) {
   // Якщо сторінка без обмеження по ролям то дозволяємо завжди
@@ -55,8 +55,9 @@ export function canUserAccess(to) {
 }
 
 /**
- *
- * @param to
+ * Перевіряє доступ за наявності ролей у метаданих маршруту
+ * @param {import('vue-router').RouteLocationNormalized} to - Маршрут призначення
+ * @returns {boolean} - Чи дозволено доступ
  */
 export function canUserAccessMetaRoles(to) {
   // Якщо сторінка без обмеження по ролям то дозволяємо завжди

package/src/token.js

@@ -7,10 +7,9 @@ import { setUser, unsetUser } from './user.js'
 const allowedRoles = import.meta.env.VITE_HASURA_ROLE.split(',')
 
 /**
- * Запам'ятовуємо поточну сторінку
- * та перенаправляємо на сторінку входу
+ * Перевіряє коректність JWT токена
  * @param {string} token - JWT токен
- * @returns {{result: string, decoded?: {}}} - Повертає результат перевірки токена
+ * @returns {{result: 'ok'|'expired'|'cleaned'|'broken-role', decoded?: object}} - Результат перевірки
  */
 export function checkToken(token) {
   const decoded = jwtDecode(token)

package/src/user.js

@@ -3,15 +3,15 @@ const allowedRoles = import.meta.env.VITE_HASURA_ROLE.split(',')
 export let user = {}
 
 /**
- *
+ * Очищає дані поточного користувача
  */
 export function unsetUser() {
   user = {}
 }
 
 /**
- *
- * @param u
+ * Встановлює дані користувача з розкодованого JWT
+ * @param {object} u - Обʼєкт з Hasura claims розкодованого токена
  */
 export function setUser(u) {
   user = u
@@ -23,10 +23,10 @@ export function setUser(u) {
 }
 
 /**
- *
- * @param a
- * @param b
- * @returns {string[]}
+ * Повертає спільні елементи двох масивів рядків
+ * @param {string[]} a - Перший масив рядків
+ * @param {string[]} b - Другий масив рядків
+ * @returns {string[]} - Масив спільних значень
  */
 function intersection(a, b) {
   const setA = new Set(a)