@sinequa/atomic-angular 2.0.0 → 2.2.0

package/types/sinequa-atomic-angular.d.ts

@@ -99,7 +99,7 @@ export type UserSettingsState = {
   assistants: Record<string, unknown>;
   collapseAssistant?: boolean;
   language?: string;
-  userTheme?: 'dark' | 'light' | 'system';
+  userTheme?: "dark" | "light" | "system";
   agents?: AgentUserSettings;
   /** Preview highlight categories the user has turned off (global, applied across documents). */
   disabledHighlightCategories?: string[];
@@ -6468,24 +6468,24 @@ export declare const THEMES: {
   id: string;
   private: boolean;
   colors: {
-    'button-primary-background': string;
+    "button-primary-background": string;
     background: string;
     foreground: string;
     card: string;
-    'card-foreground': string;
+    "card-foreground": string;
     active: string;
-    'active-foreground': string;
-    'active-background': string;
+    "active-foreground": string;
+    "active-background": string;
     primary: string;
-    'primary-foreground': string;
+    "primary-foreground": string;
     secondary: string;
-    'secondary-foreground': string;
+    "secondary-foreground": string;
     muted: string;
-    'muted-foreground': string;
+    "muted-foreground": string;
     accent: string;
-    'accent-foreground': string;
+    "accent-foreground": string;
     destructive: string;
-    'destructive-foreground': string;
+    "destructive-foreground": string;
     border: string;
     input: string;
     ring: string;
@@ -6494,20 +6494,20 @@ export declare const THEMES: {
     background: string;
     foreground: string;
     card: string;
-    'card-foreground': string;
+    "card-foreground": string;
     active: string;
-    'active-foreground': string;
-    'active-background': string;
+    "active-foreground": string;
+    "active-background": string;
     primary: string;
-    'primary-foreground': string;
+    "primary-foreground": string;
     secondary: string;
-    'secondary-foreground': string;
+    "secondary-foreground": string;
     muted: string;
-    'muted-foreground': string;
+    "muted-foreground": string;
     accent: string;
-    'accent-foreground': string;
+    "accent-foreground": string;
     destructive: string;
-    'destructive-foreground': string;
+    "destructive-foreground": string;
     border: string;
     input: string;
     ring: string;
@@ -9265,24 +9265,24 @@ export declare class ThemeSelectorComponent {
     id: string;
     private: boolean;
     colors: {
-      'button-primary-background': string;
+      "button-primary-background": string;
       background: string;
       foreground: string;
       card: string;
-      'card-foreground': string;
+      "card-foreground": string;
       active: string;
-      'active-foreground': string;
-      'active-background': string;
+      "active-foreground": string;
+      "active-background": string;
       primary: string;
-      'primary-foreground': string;
+      "primary-foreground": string;
       secondary: string;
-      'secondary-foreground': string;
+      "secondary-foreground": string;
       muted: string;
-      'muted-foreground': string;
+      "muted-foreground": string;
       accent: string;
-      'accent-foreground': string;
+      "accent-foreground": string;
       destructive: string;
-      'destructive-foreground': string;
+      "destructive-foreground": string;
       border: string;
       input: string;
       ring: string;
@@ -9291,20 +9291,20 @@ export declare class ThemeSelectorComponent {
       background: string;
       foreground: string;
       card: string;
-      'card-foreground': string;
+      "card-foreground": string;
       active: string;
-      'active-foreground': string;
-      'active-background': string;
+      "active-foreground": string;
+      "active-background": string;
       primary: string;
-      'primary-foreground': string;
+      "primary-foreground": string;
       secondary: string;
-      'secondary-foreground': string;
+      "secondary-foreground": string;
       muted: string;
-      'muted-foreground': string;
+      "muted-foreground": string;
       accent: string;
-      'accent-foreground': string;
+      "accent-foreground": string;
       destructive: string;
-      'destructive-foreground': string;
+      "destructive-foreground": string;
       border: string;
       input: string;
       ring: string;
@@ -19890,13 +19890,67 @@ export declare function provideDocumentLang(): EnvironmentProviders;
  * ```
  */
 export declare function provideKeyboardShortcuts(): EnvironmentProviders;
+export type SessionExpiryOptions = {
+  /** How long before the expiry the user is warned. Defaults to 5 minutes. */
+  warnBeforeMs?: number;
+  /**
+   * How long after start-up the interface language is considered settled. Defaults to 5000.
+   *
+   * A notification can be due right at start-up (a session already within the warning window). Transloco
+   * keeps answering in its default language until the application applies the user's one — typically once
+   * their settings are loaded — and nothing signals that moment, so without a delay the notification is
+   * worded in the wrong language. Later notifications, the usual case, are not affected. `0` disables it.
+   */
+  startupGraceMs?: number;
+  /**
+   * `duration` of the "session expired" notification. Defaults to `0`: the session is gone, so it stays
+   * until the user dismisses it or signs in again.
+   *
+   * The library has no toast layer of its own — it only emits `notify` events — so the meaning of a
+   * duration belongs to the application's bridge. `0` is "never closes on its own" for `sonner-a11y`
+   * (`Infinity` is not: a non-finite delay reaches a timer that fires straight away). Adapt it to yours.
+   */
+  expiredDuration?: number;
+  /** Action of the "session expired" notification. Defaults to reloading the page, which starts a new sign-in. */
+  onReconnect?: () => void;
+};
+/**
+ * Tells the user that the session is about to expire, and that it has.
+ *
+ * Two independent signals, because no single one works for every way of signing in:
+ *  - **Proactive**: when the stored token carries an expiry, a warning is scheduled shortly before it. The
+ *    date is re-read on every `tokenRefreshed`, so a server that renews the session as the user works
+ *    moves the window with them, and the warning only fires for a session that is really running out. With
+ *    a sign-in that leaves no readable token (ambient SSO) there is simply nothing to schedule.
+ *  - **Reactive**: a 401 that reaches its caller on a session that had been established says it is gone,
+ *    whatever the sign-in. It follows the client's `sessionLost` event (atomic 2.8), not `unauthorized`:
+ *    `unauthorized` fires before `auth.recoverFromUnauthorized` runs, so a session the recovery
+ *    re-establishes silently (SSO) would be announced lost. The client already leaves out the 401s that
+ *    are answers (sign-in, the start-up probe, audit) and the requests trailing behind a logout. The
+ *    `HttpClient` channel, which the client never sees, is reported by `errorInterceptorFn`.
+ *
+ * Both raise `notify` events (`warning` and `error`), rendered by the application's toast bridge.
+ *
+ * Not covered: a reverse proxy (OIDC) whose own session lapsed answers with a cross-origin redirect to the
+ * identity provider. `fetch` rejects with a `TypeError` before the client sees a response, so no event is
+ * raised and neither signal fires.
+ *
+ * Registered at the root it covers the root client; a second backend served by a scope has its own
+ * events, so register it in the scope's providers too.
+ *
+ * @example
+ * ```ts
+ * providers: [provideAtomicClient({ app: "my-app" }), provideSessionExpiry({ warnBeforeMs: 2 * 60_000 })]
+ * ```
+ */
+export declare function provideSessionExpiry(options?: SessionExpiryOptions): EnvironmentProviders;
 /**
  * Resolves the name of the default query from the application store.
  *
  * @returns The name of the default query or an empty string if not available.
  */
 export declare const queryNameResolver: ResolveFn<string>;
-export type PreviewHighlightName = 'company' | 'geo' | 'person' | 'extractslocations' | 'matchlocations';
+export type PreviewHighlightName = "company" | "geo" | "person" | "extractslocations" | "matchlocations";
 export type PreviewHighlight = {
   name: PreviewHighlightName;
   color: string;