@goralys/core 1.1.0 → 1.1.2

package/dist/index.d.ts

@@ -1,3 +1,49 @@
+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;
+
+interface CookiesAdapter {
+    onChange(callback: () => void): () => void;
+    getCookies(key: string): string | null;
+    setCookies(key: string, value: CookieValue, path: string, maxAge: number): void;
+    removeCookies(key: string): void;
+}
+
+type CheckAuthImpl = () => boolean;
+declare function configureCheckAuth(impl: CheckAuthImpl): void;
+declare function isAuthenticated(): boolean;
+
+interface GoralysCoreConfig {
+    client: GoralysClientConfig;
+    storage: StorageAdapter;
+    cookies: CookiesAdapter;
+    auth: CheckAuthImpl;
+    cache: {
+        cache: () => Promise<void>;
+        empty: () => void;
+    };
+}
+declare function configGoralysCore(cfg: GoralysCoreConfig): void;
+
 type UserRole = {
     role: "admin" | "teacher" | "student" | "none";
 };
@@ -72,13 +118,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é";
@@ -176,19 +215,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.
  */
@@ -225,16 +254,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.
@@ -254,4 +273,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 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 };
+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, configGoralysCore, 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,68 @@
-// 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 configureCookies(customAdapter) {
+  adapter2 = customAdapter;
+}
+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 +86,6 @@ function onNavigationEvent(listener) {
   return () => listeners2.delete(listener);
 }
 
-// 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/lib/auth/user-event.ts
 var listeners3 = /* @__PURE__ */ new Set();
 function emitUserEvent(event) {
@@ -93,18 +120,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 +189,54 @@ 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/config.ts
+function configGoralysCore(cfg) {
+  configureGoralysClient(cfg.client);
+  configureCookies(cfg.cookies);
+  configureStorage(cfg.storage);
+  configureCheckAuth(cfg.auth);
+  configureUserCacheCallbacks(cfg.cache.cache, cfg.cache.empty);
+}
+
+// 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,57 +510,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/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/hooks/useSubjects.ts
 function useSubjects(role, showToast) {
   const [subjects, setSubjects] = useState(null);
@@ -887,6 +899,7 @@ export {
   buildApiUrl,
   buildArray,
   cacheUserDataClient,
+  configGoralysCore,
   configureCheckAuth,
   configureGoralysClient,
   configureStorage,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@goralys/core",
-    "version": "1.1.0",
+    "version": "1.1.2",
     "license": "LGPL-2.1-or-later",
     "description": "Shared business logic for the Goralys web application",
     "repository": {