@abyss-project/commons-front-core 9.6.0 → 10.1.0

package/dist/rum/AbyssRumProvider.d.ts

@@ -23,7 +23,10 @@ export type AbyssRumProviderProps = PropsWithChildren<{
  * Starts the browser RUM of the front. Mount it under `<AbyssCookieConsentProvider>`: replay
  * requires the analytics consent, read at each decision of the SDK, so a consent given or withdrawn
  * after start is followed; without the consent provider, analytics reads as refused. Under
- * `<AuthProvider>`, the session's actor is the signed-in user (`null` once signed out); without it,
- * there is no actor.
+ * `<AuthProvider>`, the session's actor is the signed-in user (`null` once signed out) and the
+ * reply contact of the report dialog is their e-mail and alias; without it, there is neither. The
+ * report dialog and the feedback requests take the accent, the corner radius and the mode of the
+ * MUI theme, and the account menus below offer « Report a problem » while the environment accepts
+ * reports.
  */
 export declare const AbyssRumProvider: ({ config, children, }: AbyssRumProviderProps) => import("react/jsx-runtime").JSX.Element;

package/dist/rum/abyss-rum-report.context.d.ts

@@ -0,0 +1,14 @@
+import { Context } from 'react';
+export interface AbyssRumReport {
+    /**
+     * Opens the report dialog of the RUM in the front's language `locale` (`intl.locale`): English
+     * for an English locale, French otherwise.
+     */
+    showReportDialog(locale: string): void;
+}
+export declare const AbyssRumReportContext: Context<AbyssRumReport | null>;
+/**
+ * The report dialog of the front's RUM; `null` outside `AbyssRumProvider`, with `config={null}`, or
+ * while the environment does not accept reports.
+ */
+export declare const useAbyssRumReport: () => AbyssRumReport | null;

package/dist/rum/index.d.ts

@@ -5,3 +5,4 @@ export { ABYSS_MAIN_RUM_SESSION_ROUTE, abyssMainRumSessionPath, } from './abyss-
 export type { AbyssMainRumSessionContext } from './abyss-main-session-path';
 export { buildAbyssRumProviderConfig } from './rum-provider-config';
 export type { AbyssRumProviderConfigInput } from './rum-provider-config';
+export { trackKeyAction } from './track-key-action';

package/dist/rum/report-locale.d.ts

@@ -0,0 +1,3 @@
+import { RumReportLocale } from '@abyss-project/monitor-browser';
+/** The report dialog's language for a front locale (`en-GB` → English); French for any other. */
+export declare const reportLocaleOf: (locale: string) => RumReportLocale;

package/dist/rum/report-locale.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rum/track-key-action.d.ts

@@ -0,0 +1,7 @@
+import { AbyssKeyActionEvent } from '@abyss-project/main';
+/**
+ * Records `event` as a user action of the current RUM page view, at the success point of the user's
+ * key action. Does nothing while the RUM is not started (no `AbyssRumProvider`, `config={null}`,
+ * RUM disabled for the environment) and never throws to the caller.
+ */
+export declare const trackKeyAction: (event: AbyssKeyActionEvent) => void;

package/dist/rum/track-key-action.spec.d.ts

@@ -0,0 +1 @@
+export {};