@goralys/core 1.5.0 → 1.6.1

package/dist/index.d.ts

@@ -74,11 +74,20 @@ type UserRole = {
 declare const USER_ROLES: readonly ["admin", "teacher", "student", "none"];
 type UserData = {
     username: string;
-    full_name: string;
+    fullName: string;
     role: UserRole["role"];
-    public_id: string;
+    publicId: string;
     email: string | null | undefined;
 };
+type UserProfile = {
+    id: number;
+    username: string;
+    pubId: string;
+    fullName: string;
+    role: UserRole["role"];
+    email: string;
+    createdAt: PHPDateTime;
+};
 type User = {
     username: string;
     publicId: string;
@@ -95,8 +104,8 @@ type AuthTokenContext = "admin-panel" | "profile";
 type AuthToken = {
     username: string;
     name: string;
-    expires: Date;
-    created: Date;
+    expires: PHPDateTime;
+    created: PHPDateTime;
 };
 
 declare function useAuthTokens(context: AuthTokenContext, target?: string | null): {
@@ -179,8 +188,8 @@ declare function useSupportTickets(): {
 
 interface UseSyncedResourceOptions<T> {
     name: string;
-    cacheKey: string;
-    syncKey: string;
+    cacheKey?: string;
+    syncKey?: string;
     fetcher: () => Promise<Response | null | undefined>;
     parse: (data: unknown) => T | null;
     requireAuth?: boolean;
@@ -232,8 +241,8 @@ declare const SUPPORT_TICKET_CACHE = "support-tickets-cache";
 declare const SUPPORT_TICKET_SYNC = "support-tickets-synced";
 declare const SUBJECT_SYNCS: Record<UserRole["role"], string>;
 declare const SUBJECT_CACHES: Record<UserRole["role"], string>;
-declare const AUTH_TOKEN_SYNCS: Record<AuthTokenContext, string>;
-declare const AUTH_TOKEN_CACHES: Record<AuthTokenContext, string>;
+declare const AUTH_TOKEN_SYNCS: Record<AuthTokenContext, string | undefined>;
+declare const AUTH_TOKEN_CACHES: Record<AuthTokenContext, string | undefined>;
 type UserType = {
     type: "users-virtual" | "users-real" | "admins-virtual" | "admins-real";
 };
@@ -266,6 +275,10 @@ declare function isFoolsDay(): boolean;
 declare function buildArray<T>(...items: (T | false | null | undefined)[]): T[];
 declare const fromPhpDate: (phpDate: PHPDateTime) => Date;
 declare const parsePhpDateTime: (phpDate: PHPDateTime) => string;
+declare function separateNames(fullName: string): {
+    firstName: string;
+    lastName: string;
+};
 
 declare function emitAuthEvent(event: AuthEvent): void;
 declare function onAuthEvent(callback: (event: AuthEvent) => void): () => void;
@@ -289,8 +302,11 @@ type HttpMethod = (typeof HTTP_METHODS)[number];
  * @returns true if the string is an HTTP method.
  */
 declare function isHTTPMethod(maybeMethod: string): maybeMethod is HttpMethod;
+type GoralysFetchOptions = RequestInit & {
+    suppressRedirect?: boolean;
+};
 
-declare function goralysFetchClient(method: HttpMethod, input: string | URL | Request, payload?: Record<string, string | number | boolean | null> | FormData, requestOptions?: RequestInit): Promise<Response>;
+declare function goralysFetchClient(method: HttpMethod, input: string | URL | Request, payload?: Record<string, string | number | boolean | null> | FormData, requestOptions?: GoralysFetchOptions): Promise<Response>;
 declare function fetchCsrfClient(formId: string): Promise<string | null>;
 declare function buildApiUrl(endpoint: string, params: Record<string, string | null>, domain?: boolean): string;
 declare function handleToastRequest(r: Response, showToast: ToastFn, redirect?: boolean, duration?: number): Promise<boolean>;
@@ -339,4 +355,4 @@ declare function fetchVirtualUsersClient(): Promise<Response>;
 declare function fetchAdminsClient(): Promise<Response>;
 declare function fetchVirtualAdminsClient(): Promise<Response>;
 
-export { ADMIN_CACHE_RADIX, ADMIN_SYNC_RADIX, AUTH_TOKEN_CACHES, AUTH_TOKEN_CACHE_RADIX, AUTH_TOKEN_SYNCS, AUTH_TOKEN_SYNC_RADIX, type AuthEvent, type AuthToken, type AuthTokenContext, COOKIES_DISMISSED_KEY, type CheckAuthImpl, type ConfirmOptions, type CookieValue, type CookiesAdapter, type DraftModalResult, EMAIL_KEY, FLASH_TOAST_KEY, FULL_NAME_KEY, GoralysActionHandler, type GoralysClientConfig, HTTP_METHODS, type HttpMethod, LOGO_PATH, PERSISTANT_COOKIES, PERSISTANT_LOCALS, type PHPDateTime, PUB_ID_KEY, ROLE_KEY, SUBJECT_CACHES, SUBJECT_CACHE_RADIX, SUBJECT_SYNCS, SUBJECT_SYNC_RADIX, SUPPORT_TICKET_CACHE, SUPPORT_TICKET_SYNC, type StorageAdapter, type Subject, type SubjectStatus, SubjectStatusConfig, type SubjectsSearchField, type SupportReasons, type SupportTicket, type Toast, type ToastConfig, type ToastFn, USERNAME_KEY, USER_CACHES, USER_CACHE_RADIX, USER_ROLES, USER_SYNCS, USER_SYNC_RADIX, type UseSyncedResourceOptions, type User, type UserData, type UserEvent, type UserRole, type UserType, buildApiUrl, buildArray, cacheUserDataClient, configGoralysCore, configureCheckAuth, configureCookies, configureGoralysClient, configureStorage, configureToast, cookiesGet, cookiesGetAll, cookiesOnChange, cookiesRemove, cookiesSet, emitAuthEvent, emitNavigationEvent, emitUserEvent, emptyUserCacheClient, fetchAdminsClient, fetchAuthTokensForContext, fetchCsrfClient, fetchSubjectsForRoleClient, fetchTokensAdminPanel, fetchTokensProfile, fetchUsersClient, fetchVirtualAdminsClient, fetchVirtualUsersClient, fromPhpDate, getGoralysClientConfig, getLongFromShort, getShortFromLong, getStatusHelper, getStatusLabel, getToastConfig, goralysFetchClient, handleToastRequest, helpContent, isAuthenticated, isFoolsDay, isHTTPMethod, onAuthEvent, onNavigationEvent, onUserEvent, parsePhpDateTime, reasonsConfig, searchFields, storageGet, storageKeyAt, storageRemove, storageSet, storageSize, useAdmins, useAuthTokens, useSubjects, useSupportTickets, useSyncedResource, useUsers, useVirtualAdmins, useVirtualUsers };
+export { ADMIN_CACHE_RADIX, ADMIN_SYNC_RADIX, AUTH_TOKEN_CACHES, AUTH_TOKEN_CACHE_RADIX, AUTH_TOKEN_SYNCS, AUTH_TOKEN_SYNC_RADIX, type AuthEvent, type AuthToken, type AuthTokenContext, COOKIES_DISMISSED_KEY, type CheckAuthImpl, type ConfirmOptions, type CookieValue, type CookiesAdapter, type DraftModalResult, EMAIL_KEY, FLASH_TOAST_KEY, FULL_NAME_KEY, GoralysActionHandler, type GoralysClientConfig, type GoralysFetchOptions, HTTP_METHODS, type HttpMethod, LOGO_PATH, PERSISTANT_COOKIES, PERSISTANT_LOCALS, type PHPDateTime, PUB_ID_KEY, ROLE_KEY, SUBJECT_CACHES, SUBJECT_CACHE_RADIX, SUBJECT_SYNCS, SUBJECT_SYNC_RADIX, SUPPORT_TICKET_CACHE, SUPPORT_TICKET_SYNC, type StorageAdapter, type Subject, type SubjectStatus, SubjectStatusConfig, type SubjectsSearchField, type SupportReasons, type SupportTicket, type Toast, type ToastConfig, type ToastFn, USERNAME_KEY, USER_CACHES, USER_CACHE_RADIX, USER_ROLES, USER_SYNCS, USER_SYNC_RADIX, type UseSyncedResourceOptions, type User, type UserData, type UserEvent, type UserProfile, type UserRole, type UserType, buildApiUrl, buildArray, cacheUserDataClient, configGoralysCore, configureCheckAuth, configureCookies, configureGoralysClient, configureStorage, configureToast, cookiesGet, cookiesGetAll, cookiesOnChange, cookiesRemove, cookiesSet, emitAuthEvent, emitNavigationEvent, emitUserEvent, emptyUserCacheClient, fetchAdminsClient, fetchAuthTokensForContext, fetchCsrfClient, fetchSubjectsForRoleClient, fetchTokensAdminPanel, fetchTokensProfile, fetchUsersClient, fetchVirtualAdminsClient, fetchVirtualUsersClient, fromPhpDate, getGoralysClientConfig, getLongFromShort, getShortFromLong, getStatusHelper, getStatusLabel, getToastConfig, goralysFetchClient, handleToastRequest, helpContent, isAuthenticated, isFoolsDay, isHTTPMethod, onAuthEvent, onNavigationEvent, onUserEvent, parsePhpDateTime, reasonsConfig, searchFields, separateNames, storageGet, storageKeyAt, storageRemove, storageSet, storageSize, useAdmins, useAuthTokens, useSubjects, useSupportTickets, useSyncedResource, useUsers, useVirtualAdmins, useVirtualUsers };

package/dist/index.js

@@ -111,11 +111,12 @@ var SUBJECT_CACHES = {
   none: SUBJECT_CACHE_RADIX + "unknown"
 };
 var AUTH_TOKEN_SYNCS = {
-  "admin-panel": AUTH_TOKEN_SYNC_RADIX + "admin-panel",
+  "admin-panel": void 0,
   profile: AUTH_TOKEN_SYNC_RADIX + "profile"
 };
 var AUTH_TOKEN_CACHES = {
-  "admin-panel": AUTH_TOKEN_CACHE_RADIX + "admin-panel",
+  "admin-panel": void 0,
+  // no caching
   profile: AUTH_TOKEN_CACHE_RADIX + "profile"
 };
 var USER_SYNCS = {
@@ -361,9 +362,9 @@ async function cacheUserDataClient() {
   }
   const data = (await res.json())["data"];
   cookiesSet(USERNAME_KEY, data.username, "/", 1.5 * 60 * 60);
-  cookiesSet(FULL_NAME_KEY, data.full_name, "/", 1.5 * 60 * 60);
+  cookiesSet(FULL_NAME_KEY, data.fullName, "/", 1.5 * 60 * 60);
   cookiesSet(ROLE_KEY, data.role, "/", 1.5 * 60 * 60);
-  cookiesSet(PUB_ID_KEY, data.public_id, "/", 1.5 * 60 * 60);
+  cookiesSet(PUB_ID_KEY, data.publicId, "/", 1.5 * 60 * 60);
   if (data?.email)
     cookiesSet(EMAIL_KEY, data.email, "/", 1.5 * 60 * 60);
   else
@@ -456,7 +457,7 @@ async function goralysFetchClient(method, input, payload, requestOptions) {
   if (!(contentType && contentType.toLowerCase().trim().includes("application/json")))
     return res;
   const data = await clone.json();
-  if (data?.redirect) {
+  if (data?.redirect && requestOptions?.suppressRedirect) {
     emitNavigationEvent({ type: "redirect", url: data.redirect });
   }
   if (res.status === 401) {
@@ -523,7 +524,8 @@ async function fetchTokensProfile() {
     console.error("[fetchTokensProfile] No username cookies, aborting");
     return null;
   }
-  return await goralysFetchClient("GET", "user/tokens");
+  const csrf = await fetchCsrfClient("get-auth-tokens");
+  return await goralysFetchClient("GET", buildApiUrl("user/tokens", { "csrf-token": csrf }));
 }
 async function fetchTokensAdminPanel(target) {
   const username = cookiesGet(USERNAME_KEY);
@@ -531,7 +533,8 @@ async function fetchTokensAdminPanel(target) {
     console.error("[fetchTokensProfile] No username cookies, aborting");
     return null;
   }
-  return await goralysFetchClient("GET", "user/tokens/any", { username: target });
+  const csrf = await fetchCsrfClient("get-auth-tokens");
+  return await goralysFetchClient("GET", buildApiUrl("user/tokens/any", { pubId: target, "csrf-token": csrf }));
 }
 async function fetchAuthTokensForContext(ctx, target = null) {
   switch (ctx) {
@@ -545,6 +548,7 @@ async function fetchAuthTokensForContext(ctx, target = null) {
 // src/hooks/use-synced-ressource.ts
 import { useCallback, useEffect, useMemo, useRef, useState } from "react";
 function useSyncedResource({ name, cacheKey, syncKey, fetcher, parse, requireAuth = true, guard }) {
+  const caching = !!cacheKey && !!syncKey;
   const [data, setData] = useState(null);
   const showToast = getToastConfig().getShowToast();
   const showToastRef = useRef(showToast);
@@ -569,48 +573,52 @@ function useSyncedResource({ name, cacheKey, syncKey, fetcher, parse, requireAut
       resolve = r;
     });
     try {
-      const syncValue = cookiesGet(syncKey);
-      if (syncValue == "1") {
-        const raw2 = storageGet(cacheKey);
-        if (raw2 === null || raw2 === void 0) {
-          cookiesSet(syncKey, "0");
-          storageRemove(cacheKey);
-          inFlightRef.current = null;
-          resolve();
-          await fetchResource();
+      if (caching) {
+        const syncValue = cookiesGet(syncKey);
+        if (syncValue == "1") {
+          const raw2 = storageGet(cacheKey);
+          if (raw2 === null || raw2 === void 0) {
+            cookiesSet(syncKey, "0");
+            storageRemove(cacheKey);
+            inFlightRef.current = null;
+            resolve();
+            await fetchResource();
+            return;
+          }
+          const cached = JSON.parse(raw2 ?? "null");
+          setData((prev) => JSON.stringify(prev) === JSON.stringify(cached) ? prev : cached);
           return;
         }
-        const cached = JSON.parse(raw2 ?? "null");
-        setData((prev) => JSON.stringify(prev) === JSON.stringify(cached) ? prev : cached);
-        return;
       }
       const res = await fetcher();
       if (res)
         await handleToastRequest(res, showToastRef.current, false);
       const raw = await res?.json();
-      cookiesSet(syncKey, "1");
-      storageSet(cacheKey, JSON.stringify(raw));
+      if (caching) {
+        cookiesSet(syncKey, "1");
+        storageSet(cacheKey, JSON.stringify(raw));
+      }
       const result = parse(raw);
       setData((prev) => JSON.stringify(prev) === JSON.stringify(result) ? prev : result);
     } finally {
       inFlightRef.current = null;
       resolve();
     }
-  }, [cacheKey, syncKey, fetcher, parse, requireAuth, guard, name]);
+  }, [cacheKey, syncKey, fetcher, parse, requireAuth, guard, name, caching]);
   useEffect(() => {
     const onChange = () => {
-      if (inFlightRef.current)
+      if (inFlightRef.current || !caching)
         return;
       if (cookiesGet(syncKey) != "1") {
         void fetchResource();
       }
     };
     return cookiesOnChange(onChange);
-  }, [fetchResource, syncKey]);
+  }, [fetchResource, syncKey, caching]);
   useEffect(() => {
     void fetchResource();
   }, [fetchResource]);
-  return useMemo(() => ({ data, refetch: fetchResource, syncKey }), [data, fetchResource, syncKey]);
+  return useMemo(() => ({ data, refetch: fetchResource, syncKey: syncKey ?? "" }), [data, fetchResource, syncKey]);
 }
 
 // src/hooks/use-auth-tokens.ts
@@ -749,6 +757,25 @@ var parsePhpDateTime = (phpDate) => {
     minute: "2-digit"
   });
 };
+function separateNames(fullName) {
+  const parts = fullName.split(" ");
+  const firstNameParts = [];
+  const lastNameParts = [];
+  let current = "first";
+  parts.forEach((p) => {
+    if (p.toUpperCase() === p)
+      current = "last";
+    switch (current) {
+      case "first":
+        firstNameParts.push(p);
+        break;
+      case "last":
+        lastNameParts.push(p);
+        break;
+    }
+  });
+  return { firstName: firstNameParts.join(" "), lastName: lastNameParts.join(" ") };
+}
 
 // src/lib/subjects/subjects-utils.ts
 var SUBJECTS = [
@@ -976,6 +1003,7 @@ export {
   parsePhpDateTime,
   reasonsConfig,
   searchFields,
+  separateNames,
   storageGet,
   storageKeyAt,
   storageRemove,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@goralys/core",
-    "version": "1.5.0",
+    "version": "1.6.1",
     "license": "LGPL-2.1-or-later",
     "description": "Shared business logic for the Goralys web application",
     "repository": {
@@ -31,7 +31,7 @@
         "build": "tsup",
         "typeCheck": "tsgo --noEmit",
         "dev": "tsup --watch",
-        "barrel": "rm ./src/index.ts && barrelsby -d ./src -l top"
+        "barrel": "node -e \"require('fs').rmSync('./src/index.ts',{force:true})\" && barrelsby -d ./src -l top"
     },
     "peerDependencies": {
         "react": ">=18"