@goralys/core 1.0.0 → 1.1.1

package/dist/index.d.ts

@@ -1,3 +1,30 @@
+interface GoralysClientConfig {
+    apiDomain: string;
+}
+declare function configureGoralysClient(cfg: GoralysClientConfig): void;
+declare function getGoralysClientConfig(): GoralysClientConfig;
+
+interface StorageAdapter {
+    getItem(key: string): string | null | Promise<string | null>;
+    setItem(key: string, value: string): void | Promise<void>;
+    removeItem(key: string): void | Promise<void>;
+}
+declare function configureStorage(customAdapter: StorageAdapter): void;
+declare function storageGet(key: string): Promise<string | null>;
+declare function storageSet(key: string, value: string): Promise<void>;
+declare function storageRemove(key: string): Promise<void>;
+
+interface PHPDateTime {
+    date: string;
+    timezone_type: number;
+    timezone: string;
+}
+type CookieValue = string | boolean | number | null | undefined;
+
+type CheckAuthImpl = () => boolean;
+declare function configureCheckAuth(impl: CheckAuthImpl): void;
+declare function isAuthenticated(): boolean;
+
 type UserRole = {
     role: "admin" | "teacher" | "student" | "none";
 };
@@ -72,13 +99,6 @@ declare function useSubjects(role: UserRole["role"], showToast: ToastFn): {
     syncKey: string;
 };
 
-interface PHPDateTime {
-    date: string;
-    timezone_type: number;
-    timezone: string;
-}
-type CookieValue = string | boolean | number | null | undefined;
-
 declare const reasonsConfig: {
     readonly "password-forgot": {
         readonly label: "Mot de passe oublié";
@@ -168,8 +188,6 @@ type Section = {
 };
 declare const helpContent: Section[];
 
-declare function setCookiesExpire(duration: number): void;
-
 declare function isFoolsDay(): boolean;
 
 declare function buildArray<T>(...items: (T | false | null | undefined)[]): T[];
@@ -178,19 +196,9 @@ declare const parsePhpDateTime: (phpDate: PHPDateTime) => string;
 declare function emitAuthEvent(event: AuthEvent): void;
 declare function onAuthEvent(callback: (event: AuthEvent) => void): () => void;
 
-type CheckAuthImpl = () => boolean;
-declare function configureCheckAuth(impl: CheckAuthImpl): void;
-declare function isAuthenticated(): boolean;
-
 declare function emitUserEvent(event: UserEvent): void;
 declare function onUserEvent(callback: (event: UserEvent) => void): () => void;
 
-interface GoralysClientConfig {
-    apiDomain: string;
-}
-declare function configureGoralysClient(cfg: GoralysClientConfig): void;
-declare function getGoralysClientConfig(): GoralysClientConfig;
-
 /**
  * This filed is a slightly modified version of Next.js own http method declaration.
  */
@@ -227,16 +235,6 @@ type Listener = (event: NavigationEvent) => void;
 declare function emitNavigationEvent(event: NavigationEvent): void;
 declare function onNavigationEvent(listener: Listener): () => void;
 
-interface StorageAdapter {
-    getItem(key: string): string | null | Promise<string | null>;
-    setItem(key: string, value: string): void | Promise<void>;
-    removeItem(key: string): void | Promise<void>;
-}
-declare function configureStorage(customAdapter: StorageAdapter): void;
-declare function storageGet(key: string): Promise<string | null>;
-declare function storageSet(key: string, value: string): Promise<void>;
-declare function storageRemove(key: string): Promise<void>;
-
 /**
  * Returns the full name of a subject based on its short name or an alias.
  * It searches for the first subject in {@link SUBJECTS} whose short name starts with the given string.
@@ -248,7 +246,7 @@ declare function getLongFromShort(short: string): string;
 
 declare function fetchSubjectsForRoleClient(role: UserRole): Promise<Response | null>;
 
-declare function configUserCacheCallbacks(cache: () => Promise<void>, empty: () => void): void;
+declare function configureUserCacheCallbacks(cache: () => Promise<void>, empty: () => void): void;
 declare function cacheUserDataClient(): Promise<void>;
 declare function emptyUserCacheClient(): void;
 declare function fetchUsersClient(): Promise<Response>;
@@ -256,4 +254,4 @@ declare function fetchVirtualUsersClient(): Promise<Response>;
 declare function fetchAdminsClient(): Promise<Response>;
 declare function fetchVirtualAdminsClient(): Promise<Response>;
 
-export { ADMIN_CACHE_RADIX, ADMIN_SYNC_RADIX, type AuthEvent, type ConfirmOptions, type CookieValue, type DraftModalResult, EMAIL_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 ToastFn, USERNAME_KEY, USER_CACHES, USER_CACHE_RADIX, USER_ROLES, USER_SYNCS, USER_SYNC_RADIX, type User, type UserData, type UserEvent, type UserRole, type UserType, buildApiUrl, buildArray, cacheUserDataClient, configUserCacheCallbacks, configureCheckAuth, configureGoralysClient, configureStorage, emitAuthEvent, emitNavigationEvent, emitUserEvent, emptyUserCacheClient, fetchAdminsClient, fetchCsrfClient, fetchSubjectsForRoleClient, fetchUsersClient, fetchVirtualAdminsClient, fetchVirtualUsersClient, getGoralysClientConfig, getLongFromShort, getStatusHelper, getStatusLabel, goralysFetchClient, handleToastRequest, helpContent, isAuthenticated, isFoolsDay, isHTTPMethod, onAuthEvent, onNavigationEvent, onUserEvent, parsePhpDateTime, reasonsConfig, searchFields, setCookiesExpire, storageGet, storageRemove, storageSet, useAdmins, useSubjects, useSupportTickets, useUsers, useVirtualAdmins, useVirtualUsers };
+export { ADMIN_CACHE_RADIX, ADMIN_SYNC_RADIX, type AuthEvent, type CheckAuthImpl, type ConfirmOptions, type CookieValue, type DraftModalResult, EMAIL_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 ToastFn, USERNAME_KEY, USER_CACHES, USER_CACHE_RADIX, USER_ROLES, USER_SYNCS, USER_SYNC_RADIX, type User, type UserData, type UserEvent, type UserRole, type UserType, buildApiUrl, buildArray, cacheUserDataClient, configureCheckAuth, configureGoralysClient, configureStorage, configureUserCacheCallbacks, emitAuthEvent, emitNavigationEvent, emitUserEvent, emptyUserCacheClient, fetchAdminsClient, fetchCsrfClient, fetchSubjectsForRoleClient, fetchUsersClient, fetchVirtualAdminsClient, fetchVirtualUsersClient, getGoralysClientConfig, getLongFromShort, getStatusHelper, getStatusLabel, goralysFetchClient, handleToastRequest, helpContent, isAuthenticated, isFoolsDay, isHTTPMethod, onAuthEvent, onNavigationEvent, onUserEvent, parsePhpDateTime, reasonsConfig, searchFields, storageGet, storageRemove, storageSet, useAdmins, useSubjects, useSupportTickets, useUsers, useVirtualAdmins, useVirtualUsers };

package/dist/index.js

@@ -1,5 +1,65 @@
-// src/hooks/useSubjects.ts
-import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+// src/lib/fetch/config.ts
+var config = null;
+function configureGoralysClient(cfg) {
+  config = cfg;
+}
+function getGoralysClientConfig() {
+  if (!config) {
+    throw new Error("Goralys client not configured. Call configureGoralysClient() first.");
+  }
+  return config;
+}
+
+// src/lib/storage/storage-adapter.ts
+var adapter = null;
+function configureStorage(customAdapter) {
+  adapter = customAdapter;
+}
+function getAdapter() {
+  if (!adapter) {
+    throw new Error("Storage not configured. Call configureStorage() first.");
+  }
+  return adapter;
+}
+async function storageGet(key) {
+  return getAdapter().getItem(key);
+}
+async function storageSet(key, value) {
+  await getAdapter().setItem(key, value);
+}
+async function storageRemove(key) {
+  await getAdapter().removeItem(key);
+}
+
+// src/lib/storage/cookies-adapter.ts
+var adapter2 = null;
+function getAdapter2() {
+  if (!adapter2) {
+    throw new Error("Cookies not configured. Call configureCookies() first.");
+  }
+  return adapter2;
+}
+function cookiesGet(key) {
+  return getAdapter2().getCookies(key);
+}
+function cookiesSet(key, value, path = "/", maxAge = 1.5 * 60) {
+  getAdapter2().setCookies(key, value, path, maxAge);
+}
+function cookiesOnChange(callback) {
+  return getAdapter2().onChange(callback);
+}
+
+// src/lib/auth/check-auth.ts
+var checkAuthImpl;
+function configureCheckAuth(impl) {
+  checkAuthImpl = impl;
+}
+function isAuthenticated() {
+  if (!checkAuthImpl) {
+    throw new Error("Auth check not configured. Call configureAuthCheck() first.");
+  }
+  return checkAuthImpl();
+}
 
 // src/lib/auth/auth-event.ts
 var listeners = /* @__PURE__ */ new Set();
@@ -23,42 +83,6 @@ function onNavigationEvent(listener) {
   return () => listeners2.delete(listener);
 }
 
-// src/lib/user/user.client.ts
-var cacheUserClient;
-var emptyCacheUserClient;
-function configUserCacheCallbacks(cache, empty) {
-  cacheUserClient = cache;
-  emptyCacheUserClient = empty;
-}
-async function cacheUserDataClient() {
-  if (!cacheUserClient) {
-    throw new Error("User cache not configured. Call configUserCacheCallbacks() first.");
-  }
-  return await cacheUserClient();
-}
-function emptyUserCacheClient() {
-  if (!emptyCacheUserClient) {
-    throw new Error("User cache not configured. Call configUserCacheCallbacks() first.");
-  }
-  return emptyCacheUserClient();
-}
-async function fetchUsersClient() {
-  const csrfToken = await fetchCsrfClient("get-all-users");
-  return await goralysFetchClient("GET", buildApiUrl("users/all", { "csrf-token": csrfToken }));
-}
-async function fetchVirtualUsersClient() {
-  const csrfToken = await fetchCsrfClient("get-virtual-users");
-  return await goralysFetchClient("GET", buildApiUrl("users/virtual", { "csrf-token": csrfToken }));
-}
-async function fetchAdminsClient() {
-  const csrfToken = await fetchCsrfClient("get-all-admins");
-  return await goralysFetchClient("GET", buildApiUrl("admins/all", { "csrf-token": csrfToken }));
-}
-async function fetchVirtualAdminsClient() {
-  const csrfToken = await fetchCsrfClient("get-virtual-admins");
-  return await goralysFetchClient("GET", buildApiUrl("admins/virtual", { "csrf-token": csrfToken }));
-}
-
 // src/lib/auth/user-event.ts
 var listeners3 = /* @__PURE__ */ new Set();
 function emitUserEvent(event) {
@@ -93,18 +117,6 @@ var GoralysActionHandler = class {
   }
 };
 
-// src/lib/fetch/config.ts
-var config = null;
-function configureGoralysClient(cfg) {
-  config = cfg;
-}
-function getGoralysClientConfig() {
-  if (!config) {
-    throw new Error("Goralys client not configured. Call configureGoralysClient() first.");
-  }
-  return config;
-}
-
 // src/lib/fetch/fetch.client.ts
 var actionHandler = new GoralysActionHandler();
 async function goralysFetchClient(method, input, payload, requestOptions) {
@@ -174,6 +186,45 @@ async function handleToastRequest(r, showToast, redirect = true, duration) {
   return false;
 }
 
+// src/lib/user/user.client.ts
+var cacheUserClient;
+var emptyCacheUserClient;
+function configureUserCacheCallbacks(cache, empty) {
+  cacheUserClient = cache;
+  emptyCacheUserClient = empty;
+}
+async function cacheUserDataClient() {
+  if (!cacheUserClient) {
+    throw new Error("User cache not configured. Call configUserCacheCallbacks() first.");
+  }
+  return await cacheUserClient();
+}
+function emptyUserCacheClient() {
+  if (!emptyCacheUserClient) {
+    throw new Error("User cache not configured. Call configUserCacheCallbacks() first.");
+  }
+  return emptyCacheUserClient();
+}
+async function fetchUsersClient() {
+  const csrfToken = await fetchCsrfClient("get-all-users");
+  return await goralysFetchClient("GET", buildApiUrl("users/all", { "csrf-token": csrfToken }));
+}
+async function fetchVirtualUsersClient() {
+  const csrfToken = await fetchCsrfClient("get-virtual-users");
+  return await goralysFetchClient("GET", buildApiUrl("users/virtual", { "csrf-token": csrfToken }));
+}
+async function fetchAdminsClient() {
+  const csrfToken = await fetchCsrfClient("get-all-admins");
+  return await goralysFetchClient("GET", buildApiUrl("admins/all", { "csrf-token": csrfToken }));
+}
+async function fetchVirtualAdminsClient() {
+  const csrfToken = await fetchCsrfClient("get-virtual-admins");
+  return await goralysFetchClient("GET", buildApiUrl("admins/virtual", { "csrf-token": csrfToken }));
+}
+
+// src/hooks/useSubjects.ts
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+
 // src/lib/subjects/subjects.client.ts
 async function fetchStudentSubjectsClient() {
   const csrfToken = await fetchCsrfClient("get-student-subjects");
@@ -447,39 +498,6 @@ Attention : les administrateurs ont acc\xE8s \xE0 toutes les fonctionnalit\xE9s
   }
 ];
 
-// src/lib/auth/check-auth.ts
-var checkAuthImpl;
-function configureCheckAuth(impl) {
-  checkAuthImpl = impl;
-}
-function isAuthenticated() {
-  if (!checkAuthImpl) {
-    throw new Error("Auth check not configured. Call configureAuthCheck() first.");
-  }
-  return checkAuthImpl();
-}
-
-// src/lib/storage/storage-adapter.ts
-var adapter = null;
-function configureStorage(customAdapter) {
-  adapter = customAdapter;
-}
-function getAdapter() {
-  if (!adapter) {
-    throw new Error("Storage not configured. Call configureStorage() first.");
-  }
-  return adapter;
-}
-async function storageGet(key) {
-  return getAdapter().getItem(key);
-}
-async function storageSet(key, value) {
-  await getAdapter().setItem(key, value);
-}
-async function storageRemove(key) {
-  await getAdapter().removeItem(key);
-}
-
 // src/hooks/useSubjects.ts
 function useSubjects(role, showToast) {
   const [subjects, setSubjects] = useState(null);
@@ -505,11 +523,11 @@ function useSubjects(role, showToast) {
       resolve = r;
     });
     try {
-      const syncValue = await storageGet(syncKey);
+      const syncValue = cookiesGet(syncKey);
       if (syncValue == "1") {
         const raw = await storageGet(cacheKey);
         if (raw === null || raw === void 0) {
-          await storageSet(syncKey, "0");
+          cookiesSet(syncKey, "0");
           await storageRemove(cacheKey);
           await fetchSubjects();
           return;
@@ -526,7 +544,7 @@ function useSubjects(role, showToast) {
       if (res)
         await handleToastRequest(res, showToastRef.current, false);
       const data = await res?.json();
-      await storageSet(syncKey, "1");
+      cookiesSet(syncKey, "1");
       await storageSet(cacheKey, JSON.stringify(data));
       console.log("[useSubjects] set syncKey and cached to localStorage");
       const result = Array.isArray(data) ? data : null;
@@ -540,6 +558,16 @@ function useSubjects(role, showToast) {
       resolve();
     }
   }, [role]);
+  useEffect(() => {
+    const onChange = () => {
+      if (inFlightRef.current)
+        return;
+      if (cookiesGet(SUBJECT_SYNCS[role]) != "1") {
+        void fetchSubjects();
+      }
+    };
+    return cookiesOnChange(onChange);
+  }, [fetchSubjects, role]);
   useEffect(() => {
     void fetchSubjects();
   }, [fetchSubjects]);
@@ -575,11 +603,11 @@ function useSupportTickets(showToast) {
       resolve = r;
     });
     try {
-      const syncValue = await storageGet(syncKey) ?? "0";
+      const syncValue = cookiesGet(syncKey);
       if (syncValue == "1") {
         const raw = await storageGet(cacheKey);
         if (raw === null || raw === void 0) {
-          await storageSet(syncKey, "0");
+          cookiesSet(syncKey, "0");
           await storageRemove(cacheKey);
           await fetchSupportTickets();
           return;
@@ -596,9 +624,8 @@ function useSupportTickets(showToast) {
       if (res)
         await handleToastRequest(res, showToastRef.current, false);
       const data = await res?.json();
-      await storageSet(syncKey, "1");
+      cookiesSet(syncKey, "1");
       await storageSet(cacheKey, JSON.stringify(data));
-      console.log("[useSupportTickets] set syncKey and cached to localStorage");
       const result = Array.isArray(data) ? data : null;
       setSupportTickets((prev) => {
         if (JSON.stringify(prev) === JSON.stringify(result))
@@ -610,13 +637,23 @@ function useSupportTickets(showToast) {
       resolve();
     }
   }, []);
+  useEffect2(() => {
+    const onChange = () => {
+      if (inFlightRef.current)
+        return;
+      if (cookiesGet(SUPPORT_TICKET_SYNC) != "1") {
+        void fetchSupportTickets();
+      }
+    };
+    return cookiesOnChange(onChange);
+  }, [fetchSupportTickets]);
   useEffect2(() => {
     void fetchSupportTickets();
   }, [fetchSupportTickets]);
   return useMemo2(() => ({
     supportTickets,
     refetch: fetchSupportTickets,
-    syncKey: `support-tickets-synced`
+    syncKey: SUPPORT_TICKET_SYNC
   }), [supportTickets, fetchSupportTickets]);
 }
 
@@ -643,8 +680,16 @@ function useUserCollection(fetchFn, type, showToast) {
       resolve = r;
     });
     try {
-      if (await storageGet(syncKey) == "1") {
-        const cached = JSON.parse(await storageGet(cacheKey) ?? "null");
+      const syncValue = cookiesGet(syncKey);
+      if (syncValue == "1") {
+        const raw = await storageGet(cacheKey);
+        if (raw === null || raw === void 0) {
+          cookiesSet(syncKey, "0");
+          await storageRemove(cacheKey);
+          await fetchUsers();
+          return;
+        }
+        const cached = JSON.parse(raw ?? "null");
         setUsers((prev) => {
           if (JSON.stringify(prev) === JSON.stringify(cached))
             return prev;
@@ -657,7 +702,7 @@ function useUserCollection(fetchFn, type, showToast) {
         await handleToastRequest(res, showToastRef.current, false);
       const data = await res?.json();
       if (res?.ok) {
-        await storageSet(syncKey, "1");
+        cookiesSet(syncKey, "1");
         await storageSet(cacheKey, JSON.stringify(data));
       }
       const result = Array.isArray(data) ? data : null;
@@ -671,6 +716,16 @@ function useUserCollection(fetchFn, type, showToast) {
       resolve();
     }
   }, [fetchFn, cacheKey, syncKey]);
+  useEffect3(() => {
+    const onChange = () => {
+      if (inFlightRef.current)
+        return;
+      if (cookiesGet(syncKey) != "1") {
+        void fetchUsers();
+      }
+    };
+    return cookiesOnChange(onChange);
+  }, [fetchUsers, syncKey]);
   useEffect3(() => {
     void fetchUsers();
   }, [fetchUsers]);
@@ -695,11 +750,6 @@ var LOGO_PATH = {
   eye: "m599.07,393.76c7.76-.04,14.2,5.96,14.22,13.26.02,7.46-6.23,13.52-14.08,13.54-7.79.02-14.18-6.07-14.2-13.46-.02-7.3,6.32-13.3,14.06-13.34Z"
 };
 
-// src/lib/cookies.ts
-function setCookiesExpire(duration) {
-  storageSet("goralys-cookies-expire", String(Date.now() + duration * 1e3));
-}
-
 // src/lib/fools.ts
 function isFoolsDay() {
   const today = /* @__PURE__ */ new Date();
@@ -837,10 +887,10 @@ export {
   buildApiUrl,
   buildArray,
   cacheUserDataClient,
-  configUserCacheCallbacks,
   configureCheckAuth,
   configureGoralysClient,
   configureStorage,
+  configureUserCacheCallbacks,
   emitAuthEvent,
   emitNavigationEvent,
   emitUserEvent,
@@ -866,7 +916,6 @@ export {
   parsePhpDateTime,
   reasonsConfig,
   searchFields,
-  setCookiesExpire,
   storageGet,
   storageRemove,
   storageSet,

package/package.json

@@ -1,43 +1,43 @@
 {
-  "name": "@goralys/core",
-  "version": "1.0.0",
-  "license": "LGPL-2.1-or-later",
-  "description": "Shared business logic for the Goralys web application",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/SAMSAM-55/Goralys",
-    "directory": "goralys-core"
-  },
-  "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+    "name": "@goralys/core",
+    "version": "1.1.1",
+    "license": "LGPL-2.1-or-later",
+    "description": "Shared business logic for the Goralys web application",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/SAMSAM-55/Goralys",
+        "directory": "goralys-core"
+    },
+    "type": "module",
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        }
+    },
+    "files": [
+        "dist",
+        "LICENSE",
+        "README.md"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "build": "tsup",
+        "dev": "tsup --watch"
+    },
+    "peerDependencies": {
+        "react": ">=18"
+    },
+    "devDependencies": {
+        "barrelsby": "^2.8.1",
+        "esbuild-plugin-tsconfig-paths": "^1.0.2",
+        "react": "^18.0.0",
+        "tsup": "^8.0.0",
+        "typescript": "^5.0.0"
     }
-  },
-  "files": [
-    "dist",
-    "LICENSE",
-    "README.md"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "react": ">=18"
-  },
-  "devDependencies": {
-    "barrelsby": "^2.8.1",
-    "esbuild-plugin-tsconfig-paths": "^1.0.2",
-    "react": "^18.0.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.0.0"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch"
-  }
-}
+}