@abyss-project/commons-front-core 2.6.2 → 3.0.1

package/dist/components/Support/types.d.ts

@@ -55,16 +55,24 @@ export interface SupportTicketListProps {
         alias?: string | null;
         profilePictureThumbnailId?: string | null;
     }>;
+    /** Organization lookup map for displaying org info in ticket rows */
     organizations?: Record<string, {
         name?: string | null;
         pictureThumbnailId?: string | null;
     }>;
+    /** Extra filter UI injected into the filter bar (e.g. org filter, user search for admin) */
     renderExtraFilters?: () => ReactNode;
+    /** Custom title override */
     title?: string;
+    /** Custom subtitle */
     subtitle?: string;
+    /** Hide the create button */
     hideCreateButton?: boolean;
+    /** URL builder for user profile pictures (required when isAdmin is true) */
     getProfilePictureUrl: (userId: string) => string;
+    /** URL builder for organization logos (required when isAdmin is true) */
     getOrgLogoUrl: (orgId: string) => string;
+    /** Available tags for filtering (admin only) */
     availableTags?: ISupportTicketTag[];
 }
 export interface SupportTicketCreateValues {
@@ -84,6 +92,9 @@ export interface SupportTicketCreateStepperValues extends SupportTicketCreateVal
     projectId?: string | null;
     userId?: string | null;
     organizationId?: string | null;
+    /** Files staged in the create stepper's attachment drop zone. The stepper
+     *  only stages them locally — the host is responsible for creating the
+     *  ticket then uploading each staged file via the attachment mutation. */
     attachments?: File[];
 }
 export interface SupportTicketCreateStepperProps {
@@ -91,7 +102,10 @@ export interface SupportTicketCreateStepperProps {
     isSubmitting?: boolean;
     isAdmin?: boolean;
     onCancel?: () => void;
+    /** Optional prefilled values — used when launching the stepper from a
+     *  feature-specific "report issue" entry point (e.g. RCB feedback). */
     initialValues?: Partial<SupportTicketCreateStepperValues>;
+    /** Render prop for the entire "For Who?" step (admin only). Receives userId/orgId values and setters. */
     renderForWhoStep?: (userId: string | null, onUserChange: (userId: string | null) => void, orgId: string | null, onOrgChange: (orgId: string | null) => void) => ReactNode;
     renderProjectSelect?: (value: string | null, onChange: (projectId: string | null) => void) => ReactNode;
 }
@@ -123,6 +137,8 @@ export interface SupportMessageThreadProps {
     getProfilePictureUrl?: (userId: string) => string;
     getFileThumbnailUrl?: (id: string) => string;
     ticket?: ISupportTicket;
+    /** See SupportAttachmentsPanelProps — same render-prop contract, applied
+     * to each inline message attachment. */
     renderScanStatusBadge?: (attachment: ISupportTicketAttachment) => ReactNode;
 }
 export interface SupportMessageInputProps extends SupportCloudImportProps {
@@ -144,10 +160,27 @@ export interface SupportAttachmentsPanelProps extends SupportCloudImportProps {
     onUpload?: (file: File) => void;
     onDelete?: (attachmentId: string) => void;
     onDownload?: (attachment: ISupportTicketAttachment) => void;
+    /**
+     * Open a viewable attachment (image or PDF) in a new browser tab. Rendered
+     * as an "open" affordance only for viewable mime types; the host wraps it
+     * with the same scan-status guard as download.
+     */
     onOpenAttachment?: (attachment: ISupportTicketAttachment) => void;
+    /**
+     * Returns a viewable (presigned) URL for an image attachment, used to render
+     * an inline preview when the file has no separately-generated thumbnail.
+     * Host wires it to the attachment file-url endpoint; only called for images.
+     */
     getAttachmentPreviewUrl?: (attachment: ISupportTicketAttachment) => Promise<string | null>;
     isUploading?: boolean;
     maxAttachments?: number;
+    /**
+     * Render prop for the antivirus scan-status badge, injected by the host
+     * app (the shared `ScanStatusIndicator` lives in `apps/front`, which this
+     * package cannot depend on). Rendered next to each attachment's filename
+     * when the attachment's `scanStatus` warrants a badge (the host decides —
+     * this component just calls it unconditionally per row).
+     */
     renderScanStatusBadge?: (attachment: ISupportTicketAttachment) => ReactNode;
 }
 export interface SupportActivityLogProps {
@@ -200,9 +233,23 @@ export interface SupportSidebarProps extends SupportCloudImportProps {
         id: string;
         name: string;
     } | null;
+    /**
+     * Navigate to the requester's own page. Only a host that has one (the
+     * back-office) passes it; without it the requester stays plain text.
+     */
     onNavigateToUser?: (userId: string) => void;
+    /**
+     * Navigate to the organization's own page. Only a host that has one (the
+     * back-office) passes it; without it the organization stays plain text.
+     */
     onNavigateToOrganization?: (organizationId: string) => void;
+    /**
+     * Deep-link callback for the ticket's generic back-reference. The host
+     * builds the URL (e.g. AbyssExtract history) and navigates. Rendered only
+     * when ticket.contextType + ticket.contextId are set.
+     */
     onViewContext?: (contextType: string, contextId: string) => void;
+    /** See SupportAttachmentsPanelProps. */
     renderScanStatusBadge?: (attachment: ISupportTicketAttachment) => ReactNode;
 }
 export interface SupportTicketDetailProps extends SupportCloudImportProps {
@@ -250,9 +297,17 @@ export interface SupportTicketDetailProps extends SupportCloudImportProps {
         name: string;
     } | null;
     onUploadMessageAttachment?: (file: File) => void;
+    /** See SupportSidebarProps. */
     onNavigateToUser?: (userId: string) => void;
+    /** See SupportSidebarProps. */
     onNavigateToOrganization?: (organizationId: string) => void;
+    /**
+     * Deep-link callback for the ticket's generic back-reference. The host
+     * builds the URL (e.g. AbyssExtract history) and navigates. Rendered only
+     * when ticket.contextType + ticket.contextId are set.
+     */
     onViewContext?: (contextType: string, contextId: string) => void;
+    /** See SupportAttachmentsPanelProps. */
     renderScanStatusBadge?: (attachment: ISupportTicketAttachment) => ReactNode;
 }
 export interface SupportStatusBadgeProps {

package/dist/components/Utils/AbyssBackground/AbyssBackground.component.d.ts

@@ -1,8 +1,11 @@
 import { default as React } from 'react';
 export interface AbyssBackgroundProps {
     children?: React.ReactNode;
+    /** 'default' = standard app bg, 'subtle' = less glow, 'hero' = strong glow for landing */
     variant?: 'default' | 'subtle' | 'hero';
+    /** Render as fixed fullscreen (true) or relative container (false, default) */
     fixed?: boolean;
+    /** Extra sx for the wrapper */
     sx?: Record<string, any>;
 }
 declare const AbyssBackground: React.FC<AbyssBackgroundProps>;

package/dist/components/Utils/AbyssFamilyMenuSection/AbyssFamilyMenuSection.d.ts

@@ -1,5 +1,14 @@
 import { AbyssLayoutMenuSection } from '../AbyssLayoutMenu/AbyssLayoutMenu.component';
 import { CurrentFamilyInfo } from '../../Layouts/AbyssFamilyBanner/AbyssFamilyBanner.component';
+/**
+ * Builds the AbyssLayoutMenu section for the family entry.
+ * When `abyssUrl` is provided, elements use `href` (cross-origin external link).
+ * Without it, they use `path` (react-router internal navigation on abyss-main).
+ *
+ * `labels` allows the host to pass translated strings so that an EN-configured
+ * satellite does not show hard-coded French text. FR strings are kept as the
+ * in-package fallback (matches `commons.menu.family` / `family.banner.no-family-cta`).
+ */
 export declare function buildAbyssFamilyMenuSection(currentFamily: CurrentFamilyInfo | null | undefined, abyssUrl: string | undefined, labels?: {
     title?: string;
     createCta?: string;

package/dist/components/Utils/AbyssLayoutMenu/index.d.ts

@@ -1,3 +1,3 @@
 export { default as AbyssLayoutMenu } from './AbyssLayoutMenu.component';
 export { AbyssMenuItem } from './AbyssMenuItem.component';
-export type { AbyssLayoutMenuSection, AbyssLayoutMenuElement, AbyssLayoutMenuUser } from './AbyssLayoutMenu.component';
+export type { AbyssLayoutMenuSection, AbyssLayoutMenuElement, AbyssLayoutMenuUser, } from './AbyssLayoutMenu.component';

package/dist/components/Utils/AbyssLayoutNotifications/AbyssLayoutNotifications.component.d.ts

@@ -18,14 +18,18 @@ type Props = {
     actionButtonText: (notification: AbyssNotificationItem, user?: AbyssNotificationUser | null) => string | null;
     handleNotificationActionButton?: (notification: AbyssNotificationItem, user?: AbyssNotificationUser | null) => void;
     formatDate: (date: Date) => string;
+    /** Called on SSE message; return structured event or null to ignore */
     onSSEMessage?: (message: unknown) => SSENotificationEvent;
     sseUrl?: string;
     sid?: string;
     disableSSE?: boolean;
     enableSoundNotification?: boolean;
     onSoundToggle?: () => Promise<void>;
+    /** URL to an audio file for notifications (e.g. import NotificationSound from './notification.mp3') */
     notificationSoundUrl?: string;
+    /** Called when "see all" button is clicked (use instead of a router Link) */
     onAllNotificationsClick?: () => void;
+    /** Called when the settings icon is clicked — redirects to the notification preferences page */
     onPreferencesClick?: () => void;
 };
 declare const AbyssLayoutNotifications: React.FC<Props>;

package/dist/components/Utils/AbyssLayoutNotifications/index.d.ts

@@ -1,4 +1,4 @@
 export { default as AbyssLayoutNotifications } from './AbyssLayoutNotifications.component';
 export { default as AbyssNotifications } from './AbyssNotifications.component';
-export type { AbyssNotificationItem, AbyssNotificationUser } from './AbyssNotifications.component';
+export type { AbyssNotificationItem, AbyssNotificationUser, } from './AbyssNotifications.component';
 export type { SSENotificationEvent } from './AbyssLayoutNotifications.component';

package/dist/components/Utils/ImportButton/ImportButton.component.d.ts

@@ -10,6 +10,7 @@ type Props = {
     multiple?: boolean;
     maxSize?: number;
     accept?: string[];
+    /** User object — only used to determine if cloud is enabled */
     user?: {
         enabledService?: string[];
     } | null;
@@ -22,7 +23,10 @@ type Props = {
     fetchCloudRepository?: (cloudId: string) => Promise<IGetRepositoryCloudData>;
     onActivateService?: () => Promise<void>;
     onCreateCloud?: (name: string) => Promise<void>;
+    /** If true, show the cloud import option even without full cloud props */
     showCloudOption?: boolean;
+    /** Optional resolver injecting avatar + label per ISpace into the cloud
+     *  picker (so it matches the host's avatar conventions). */
     getSpaceDisplay?: (space: ISpace) => {
         label: string;
         avatar?: React.ReactNode;

package/dist/components/Utils/Toast/AbyssToast.component.d.ts

@@ -1,3 +1,9 @@
 import { default as React } from 'react';
+/**
+ * AbyssToast — Injects theme-aware CSS overrides for react-toastify.
+ * Place this component inside your ThemeProvider, next to <ToastContainer />.
+ *
+ * Adapts to light/dark mode automatically via MUI theme tokens.
+ */
 declare const AbyssToast: React.FC;
 export default AbyssToast;

package/dist/components/Utils/WaterParticles/WaterParticles.component.d.ts

@@ -1,5 +1,13 @@
 import { default as React } from 'react';
 interface Props {
+    /**
+     * Confine the effect to the nearest positioned ancestor instead of the
+     * viewport. Required whenever the backdrop belongs to ONE panel of a split
+     * layout: the default `fixed` layer spans the whole window and its glow bleeds
+     * over the neighbouring column.
+     *
+     * The host element must be `position: relative` (and usually `overflow: hidden`).
+     */
     contained?: boolean;
 }
 declare const WaterParticles: React.FC<Props>;

package/dist/cookie-consent.js

@@ -1,4 +1,4 @@
-import { A as s, c as a, C as n, a as C, D as i, R as t, V as r, d as A, f as k, r as c, e as l, u as D, b as E, w as I } from "./CookieConsentSettings.component-BUxrkECh.js";
+import { A as s, c as a, C as n, a as C, D as i, R as t, V as r, d as A, f as k, r as c, e as l, u as D, b as E, w as I } from "./CookieConsentSettings.component-BLgzLD-Z.js";
 export {
   s as AbyssCookieConsentProvider,
   a as COOKIE_NAME,

package/dist/hooks/use-public-users.hook.d.ts

@@ -1,14 +1,53 @@
 import { QueryClient, UseQueryResult } from '@tanstack/react-query';
+/**
+ * Public, lightweight user info shared across components/repos.
+ * Mirrors the shape returned by `sdk.user.getPublic`.
+ */
 export type PublicUser = {
     id: string;
     alias: string;
     profilePictureThumbnailId: string | null;
     emailVerifiedAt: Date | null;
 };
+/** Shared react-query key — re-export so consumers can prime/invalidate manually if needed. */
 export declare const publicUserQueryKey: (userId: string) => readonly ["public-user", string];
+/**
+ * Batched single-user fetcher. Multiple concurrent calls in a 50ms window
+ * collapse into one or more `getPublicUser` requests (one per chunk of
+ * MAX_ELEMENT_PUBLIC_USER ids). Returns null if the user isn't found in the
+ * response (deleted/never existed). Exported for unit testing the batch/chunk seam.
+ */
 export declare const fetchPublicUserBatched: (userId: string) => Promise<PublicUser | null>;
+/**
+ * React Query hook that returns a single public user. Uses a per-id query key
+ * so the cache is shared across the entire app — multiple components asking
+ * for the same userId benefit from a single network request, and refetches
+ * are coordinated by react-query.
+ *
+ *     const user = usePublicUser(someUserId);
+ */
 export declare const usePublicUser: (userId: string | null | undefined) => UseQueryResult<PublicUser | null, Error>;
+/**
+ * React Query hook that returns a Record of public users by id. Internally uses
+ * `useQueries` so each id has its own cache entry — sharing perfectly with
+ * other components calling `usePublicUser`.
+ *
+ *     const users = usePublicUsers([id1, id2, id3]);
+ *     const alias = users[id1]?.alias;
+ */
 export declare const usePublicUsers: (userIds: readonly (string | null | undefined)[]) => Record<string, PublicUser>;
+/**
+ * Imperatively prime the cache from data you already have (e.g. a search
+ * response). Subsequent `usePublicUser`/`usePublicUsers` calls hit the cache
+ * instead of triggering another `getPublicUser` round-trip.
+ */
 export declare const primePublicUsers: (queryClient: QueryClient, users: readonly PublicUser[]) => void;
+/**
+ * Hook variant for `primePublicUsers` — useful inside components.
+ */
 export declare const usePrimePublicUsers: () => (users: readonly PublicUser[]) => void;
+/**
+ * Imperatively invalidate one or more cached users (e.g. after the user
+ * updates their own profile).
+ */
 export declare const invalidatePublicUsers: (queryClient: QueryClient, userIds: readonly string[]) => void;

package/dist/hooks/use-rich-intl.hook.d.ts

@@ -206,6 +206,10 @@ export declare const translations: {
                         title: string;
                         content: string;
                     };
+                    "external-identity-candidate-named": {
+                        title: string;
+                        content: string;
+                    };
                     "internal-ticket-section-without-agents": {
                         title: string;
                         content: string;
@@ -1662,6 +1666,10 @@ export declare const translations: {
                         title: string;
                         content: string;
                     };
+                    "external-identity-candidate-named": {
+                        title: string;
+                        content: string;
+                    };
                     "internal-ticket-section-without-agents": {
                         title: string;
                         content: string;
@@ -2922,11 +2930,11 @@ export declare const flattenTranslations: {
 type FlattenObjectKeys<T extends Record<string, unknown>, Key = keyof T> = Key extends string ? T[Key] extends Record<string, unknown> ? `${Key}.${FlattenObjectKeys<T[Key]>}` : `${Key}` : never;
 export type ExistingTranslationKey = FlattenObjectKeys<(typeof translations)[UserLanguage.FRENCH]>;
 export declare const RICH_TAGS: {
-    break: import("react").JSX.Element;
-    bold: (...chunks: ReactNode[]) => import("react").JSX.Element;
-    italic: (...chunks: ReactNode[]) => import("react").JSX.Element;
-    primary: (...chunks: ReactNode[]) => import("react").JSX.Element;
-    focus: (...chunks: ReactNode[]) => import("react").JSX.Element;
+    break: import("react/jsx-runtime").JSX.Element;
+    bold: (...chunks: ReactNode[]) => import("react/jsx-runtime").JSX.Element;
+    italic: (...chunks: ReactNode[]) => import("react/jsx-runtime").JSX.Element;
+    primary: (...chunks: ReactNode[]) => import("react/jsx-runtime").JSX.Element;
+    focus: (...chunks: ReactNode[]) => import("react/jsx-runtime").JSX.Element;
 };
 export type ExistingMessageDescriptor = {
     [Key in keyof MessageDescriptor]: Key extends 'id' ? ExistingTranslationKey : MessageDescriptor['id'];

package/dist/hooks/use-theme-transition.hook.d.ts

@@ -1,4 +1,17 @@
 import { default as React } from 'react';
+/**
+ * Hook that provides a `triggerTransition` function to wrap theme changes
+ * with a circular reveal animation using the View Transitions API.
+ *
+ * Falls back to a direct call on unsupported browsers or when the user
+ * prefers reduced motion.
+ *
+ * @example
+ * const { triggerTransition } = useThemeTransition();
+ * <Button onClick={(e) => triggerTransition(() => setThemeMode('light'), e)}>
+ *   Switch theme
+ * </Button>
+ */
 export declare function useThemeTransition(): {
     triggerTransition: (callback: () => void, event?: React.MouseEvent | MouseEvent) => void;
 };

package/dist/{index-D_eg_k-b.js → index-13QCr6ei.js}

@@ -1,4 +1,4 @@
-import { P as L, N as M, k as $, D as E, l as y, T as S, I as j } from "./index-DtSoIucr.js";
+import { P as L, N as M, k as $, D as E, l as y, T as S, I as j } from "./index-BjbDo-BN.js";
 class v {
   /**
   @internal

package/dist/{index-uIeKLdVL.js → index-B4s0xpO9.js}

@@ -1,6 +1,6 @@
-import { E as d, L as y, h as b, a as _, p as g, e as u, s as S, i as T, f as k, j as W, t } from "./index-DtSoIucr.js";
-import { html as j } from "./index-CXjoTXWO.js";
-import { L as X, E as p } from "./index-D_eg_k-b.js";
+import { E as d, L as y, h as b, a as _, p as g, e as u, s as S, i as T, f as k, j as W, t } from "./index-BjbDo-BN.js";
+import { html as j } from "./index-x_CknZJ4.js";
+import { L as X, E as p } from "./index-13QCr6ei.js";
 const Y = 1, U = 2, G = 3, R = 179, z = 4, v = 180, x = 5, Z = 181, V = 6;
 function E(O) {
   return O >= 65 && O <= 90 || O >= 97 && O <= 122;

package/dist/{index-3FLJ3SfU.js → index-BBH7n9Up.js}

@@ -1,7 +1,7 @@
-import { a as p, L as u, p as n, s as l, t as e } from "./index-DtSoIucr.js";
-import { html as m } from "./index-CXjoTXWO.js";
-import { javascriptLanguage as b } from "./index-CIrG9_dY.js";
-import { L as S, a as r } from "./index-D_eg_k-b.js";
+import { a as p, L as u, p as n, s as l, t as e } from "./index-BjbDo-BN.js";
+import { html as m } from "./index-x_CknZJ4.js";
+import { javascriptLanguage as b } from "./index-Ci9slz4U.js";
+import { L as S, a as r } from "./index-13QCr6ei.js";
 const c = /* @__PURE__ */ S.deserialize({
   version: 14,
   states: "%pOVOWOOObQPOOOpOSO'#C_OOOO'#Cp'#CpQVOWOOQxQPOOO!TQQOOQ!YQPOOOOOO,58y,58yO!_OSO,58yOOOO-E6n-E6nO!dQQO'#CqQ{QPOOO!iQPOOQ{QPOOO!qQPOOOOOO1G.e1G.eOOQO,59],59]OOQO-E6o-E6oO!yOpO'#CiO#RO`O'#CiQOQPOOO#ZO#tO'#CmO#fO!bO'#CmOOQO,59T,59TO#qOpO,59TO#vO`O,59TOOOO'#Cr'#CrO#{O#tO,59XOOQO,59X,59XOOOO'#Cs'#CsO$WO!bO,59XOOQO1G.o1G.oOOOO-E6p-E6pOOQO1G.s1G.sOOOO-E6q-E6q",

package/dist/{index-C_WLdmTl.js → index-BI7XXRdP.js}

@@ -1,6 +1,6 @@
-import { L as V, E as X } from "./index-D_eg_k-b.js";
-import { s as d, t as $, a as Z, L as R, p as s, i as t, f as y, c, j as U, g as l } from "./index-DtSoIucr.js";
-import { html as w } from "./index-CXjoTXWO.js";
+import { L as V, E as X } from "./index-13QCr6ei.js";
+import { s as d, t as $, a as Z, L as R, p as s, i as t, f as y, c, j as U, g as l } from "./index-BjbDo-BN.js";
+import { html as w } from "./index-x_CknZJ4.js";
 const W = 1, p = 2, q = 275, u = 3, b = 276, _ = 277, f = 278, k = 4, m = 5, G = 6, x = 7, z = 8, h = 9, g = 10, v = 11, j = 12, E = 13, I = 14, N = 15, L = 16, F = 17, C = 18, H = 19, A = 20, K = 21, D = 22, B = 23, M = 24, J = 25, OO = 26, $O = 27, QO = 28, iO = 29, aO = 30, TO = 31, PO = 32, XO = 33, SO = 34, cO = 35, eO = 36, oO = 37, _O = 38, zO = 39, nO = 40, rO = 41, YO = 42, VO = 43, dO = 44, ZO = 45, RO = 46, sO = 47, tO = 48, yO = 49, UO = 50, lO = 51, wO = 52, WO = 53, pO = 54, qO = 55, uO = 56, bO = 57, fO = 58, kO = 59, mO = 60, GO = 61, xO = 62, e = 63, hO = 64, gO = 65, vO = 66, jO = {
   abstract: k,
   and: m,

package/dist/{index-7xq1GVwh.js → index-BbuvDSp0.js}

@@ -1,5 +1,5 @@
-import { L as s, E as R, a as Y, C as x } from "./index-D_eg_k-b.js";
-import { s as w, t as O, a as d, n as X, L as k, b as h, d as f, i as u, f as y, c as l, j as g, m as j, g as U, e as G, o as b, I as Z } from "./index-DtSoIucr.js";
+import { L as s, E as R, a as Y, C as x } from "./index-13QCr6ei.js";
+import { s as w, t as O, a as d, n as X, L as k, b as h, d as f, i as u, f as y, c as l, j as g, m as j, g as U, e as G, o as b, I as Z } from "./index-BjbDo-BN.js";
 const _ = 177, q = 179, E = 184, v = 12, C = 13, D = 17, z = 20, F = 25, B = 53, N = 95, I = 142, L = 144, A = 145, J = 148, M = 10, H = 13, K = 32, OO = 9, $ = 47, QO = 41, eO = 125, aO = new R((Q, e) => {
   for (let n = 0, a = Q.next; (e.context && (a < 0 || a == M || a == H || a == $ && Q.peek(n + 1) == $) || a == QO || a == eO) && Q.acceptToken(_), !(a != K && a != OO); )
     a = Q.peek(++n);

package/dist/{index-XwxG8_UP.js → index-Bhok95RO.js}

@@ -1,5 +1,5 @@
-import { L as G, E as A, C as N } from "./index-D_eg_k-b.js";
-import { s as I, t as p, E as Y, a as j, L as U, e as k, h as Z, i as B, f as D, H as M } from "./index-DtSoIucr.js";
+import { L as G, E as A, C as N } from "./index-13QCr6ei.js";
+import { s as I, t as p, E as Y, a as j, L as U, e as k, h as Z, i as B, f as D, H as M } from "./index-BjbDo-BN.js";
 const h = 1, F = 2, L = 3, H = 4, K = 5, J = 36, ee = 37, te = 38, Oe = 11, oe = 13;
 function re(e) {
   return e == 45 || e == 46 || e == 58 || e >= 65 && e <= 90 || e == 95 || e >= 97 && e <= 122 || e >= 161;