@sinequa/atomic-angular 1.5.2 → 1.5.5

package/index.d.ts

@@ -224,8 +224,16 @@ declare class DocumentLocatorComponent implements OnDestroy {
 }
 
 declare class ErrorComponent {
+    private readonly route;
     router: Router;
-    reload(): void;
+    /**
+     * Human-readable error detail shown on the page, taken from the `message` query param.
+     * Callers navigating here can pass it, e.g. on an auth failure:
+     * `router.navigate(["error"], { queryParams: { message: err.message } })`.
+     */
+    readonly message: string | undefined;
+    /** Navigate home and re-bootstrap the application (fresh authentication attempt). */
+    goHome(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<ErrorComponent, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<ErrorComponent, "error-component, ErrorComponent", never, {}, {}, never, never, true, never>;
 }
@@ -3155,8 +3163,9 @@ declare class AppService {
      *
      * @remarks
      * This method constructs an HTTP GET request to fetch the application configuration
-     * using the `app` parameter from the global configuration. If the request fails,
-     * it logs the error to the console and returns an empty observable.
+     * using the `app` parameter from the global configuration. If the request fails, it logs the
+     * error and re-throws a normalized `Error` carrying the server's `errorMessage` when available
+     * (e.g. "app not found: '...'"), so callers can surface the reason on the error page.
      *
      * @example
      * ```typescript
@@ -4626,29 +4635,68 @@ type Theme = (typeof THEMES)[number];
 declare function withThemes(app: ApplicationRef, themes: Theme[]): ApplicationRef;
 
 /**
- * Signs in the user by checking the global configuration for authentication method and acting accordingly.
+ * Signs the user in according to the resolved {@link globalConfig.authMode}.
+ *
+ * The mode is expected to be resolved beforehand (by `initializeAppConfig`, awaited in
+ * `bootstrapApp`). This function clears any existing session, then:
+ * - `credentials` → redirect to the login form;
+ * - `sso` → reload the page so the browser/proxy performs the handshake;
+ * - `oauth` / `saml` → delegate to `login()`, which redirects to the provider;
+ * - `bearer` → delegate to `login()`;
+ * - `unknown` → `login()` tries SSO silently then resolves to credentials; on failure the login
+ *   form is shown.
  *
- * This function first clears any existing session tokens to ensure a clean authentication state. It then checks the
- * global configuration to determine whether to use credentials-based authentication or Single Sign-On (SSO). If
- * credentials are used, it redirects the user to the login page. If SSO is enabled, it reloads the page to trigger
- * the SSO login process. If neither method is specified, it attempts a standard login and handles any errors that
- * may occur during the process.
- * @returns A promise resolving to a boolean indicating the success of the sign-in operation.
+ * @returns A promise resolving to a boolean indicating whether the user is authenticated.
  */
 declare function signIn(): Promise<boolean>;
 
 /**
  * Bootstraps the application by ensuring the user is authenticated and initializing the application.
  *
- * This function first attempts to sign in the user using the provided `Router`. If authentication is successful,
- * it proceeds to initialize the application and create routes using the `applicationService`. Any errors during
- * authentication or initialization are logged to the console, but the returned promise always resolves.
+ * This function first attempts to sign in the user via `signIn()`. If authentication is successful,
+ * it initializes the application (stores and, optionally, dynamic routes) through `ApplicationService`
+ * and waits for the initialization to complete before resolving. Any errors during authentication or
+ * initialization are logged to the console, but the returned promise never rejects.
  *
- * @param Router - The application's router instance used for navigation and authentication.
- * @param applicationService - The service responsible for initializing the application and creating routes.
- * @returns A promise that resolves when the application is ready to be initialized, regardless of success or failure.
+ * Note: this function relies on Angular's injection context, so it must be called within one
+ * (e.g. from `provideAppInitializer`).
+ *
+ * @param options - Configuration options for the bootstrap process.
+ * @param options.createRoutes - Whether to create routes during initialization. Defaults to `true`.
+ * @returns A promise that resolves to `true` when the application has been fully initialized,
+ * or `false` when the user is not authenticated or an error occurred.
  */
-declare function withBootstrapApp(applicationService: ApplicationService, { createRoutes }: {
+declare function bootstrapApp({ createRoutes }?: {
+    createRoutes?: boolean | undefined;
+}): Promise<boolean>;
+/**
+ * Bootstraps the application by ensuring the user is authenticated and initializing the application.
+ *
+ * @deprecated Use {@link bootstrapApp} instead, and let it inject `ApplicationService` itself.
+ *
+ * Migration — in your `app.config.ts`, replace:
+ * ```ts
+ * // ❌ Deprecated: eagerly injecting ApplicationService in the factory constructs it (and its
+ * //    dependent stores/services) BEFORE bootstrapApp resolves the config, so services that build
+ * //    their API URL from `globalConfig.backendUrl` capture `undefined` (→ `/undefined/api/v1/...`).
+ * provideAppInitializer(() => withBootstrapApp(inject(ApplicationService), { createRoutes: true })),
+ * ```
+ * with:
+ * ```ts
+ * // ✅ bootstrapApp injects ApplicationService internally, AFTER initializeAppConfig() has set
+ * //    `backendUrl` and resolved the auth mode.
+ * provideAppInitializer(() => bootstrapApp({ createRoutes: true })),
+ * ```
+ * (Remove the now-unused `inject` / `ApplicationService` imports.)
+ *
+ * @param applicationService - Ignored; kept for backward compatibility. `ApplicationService` is
+ * provided in root and injected internally by {@link bootstrapApp}, so the instance is the same.
+ * Passing `inject(ApplicationService)` here is discouraged — see the migration note above.
+ * @param options - Configuration options for the bootstrap process.
+ * @param options.createRoutes - Whether to create routes during initialization. Defaults to `true`.
+ * @returns A promise that resolves when the bootstrap process is complete, regardless of success or failure.
+ */
+declare function withBootstrapApp(_applicationService: ApplicationService, { createRoutes }?: {
     createRoutes?: boolean | undefined;
 }): Promise<void>;
 
@@ -8144,13 +8192,19 @@ declare class AlertsComponent {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<AlertsComponent, "Alerts", never, {}, {}, never, never, true, never>;
 }
 
-type AuthView = "signin" | "changepassword" | "login" | "forgotpassword";
+type AuthView = "signin" | "changepassword" | "login" | "forgotpassword" | "signedout";
 declare class AuthPageComponent {
     mode: _angular_core.InputSignal<AuthView | undefined>;
     view: _angular_core.WritableSignal<AuthView>;
     readonly username: _angular_core.WritableSignal<string>;
     readonly alert: _angular_core.WritableSignal<string | undefined>;
     private readonly route;
+    /**
+     * Default view derived from the route. The `/logout` route renders the "signed out" confirmation
+     * (NOT the sign-in form): in external-auth modes the form would auto-restart the handshake and
+     * re-authenticate the user, defeating the logout. Everything else defaults to the sign-in form.
+     */
+    private routeView;
     constructor();
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AuthPageComponent, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<AuthPageComponent, "auth-page, AuthPage, authpage", never, { "mode": { "alias": "mode"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
@@ -8215,9 +8269,13 @@ declare class SignInComponent {
     } & Record<string, any>>;
     /**
      * True when authentication is handled outside the credentials form — i.e. by the
-     * browser/proxy (`useSSO`) or by an auto-configured OAuth/SAML provider. In those
-     * modes this screen shows a loader instead of a login form and initiates the
-     * handshake automatically by calling `handleLogin()`.
+     * browser/proxy (`sso`) or by an auto-configured OAuth/SAML provider. In those modes
+     * this screen shows a loader instead of a login form and initiates the handshake
+     * automatically by calling `handleLogin()`.
+     *
+     * Note: the ambiguous `unknown` mode is intentionally excluded — it is resolved upstream
+     * (in `login()`/`signIn()`) to either `sso` or `credentials` before this screen renders,
+     * so reaching here in `unknown` should still show the form, never a dead-end loader.
      */
     readonly externalAuth: boolean;
     class: _angular_core.InputSignal<string | undefined>;
@@ -8276,6 +8334,29 @@ declare class SignInComponent {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<SignInComponent, "signIn, signin, sign-in", never, { "class": { "alias": "class"; "required": false; "isSignal": true; }; "username": { "alias": "username"; "required": false; "isSignal": true; }; "password": { "alias": "password"; "required": false; "isSignal": true; }; }, { "forgotPassword": "forgotPassword"; "username": "usernameChange"; "password": "passwordChange"; }, never, never, true, never>;
 }
 
+/**
+ * Post-logout confirmation shown on the `/logout` route.
+ *
+ * Rendering this view (instead of the sign-in form) is essential for the external-auth modes
+ * (`sso` / `oauth` / `saml`): the sign-in form auto-initiates the handshake when
+ * `authMode` is external, so showing it on `/logout` would immediately re-authenticate the user
+ * (a spinner that loops back in). This view gives a clear "signed out" state and a single explicit
+ * action to sign in again.
+ */
+declare class SignedOutComponent {
+    private readonly router;
+    /**
+     * Navigate to the login screen, which then drives the normal sign-in handshake.
+     *
+     * A `returnUrl` is required: in the external-auth modes the sign-in screen only navigates away
+     * once the handshake completes IF a `returnUrl` is present (otherwise it stays on the loader).
+     * We send the user back to the app root after signing in again.
+     */
+    signInAgain(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SignedOutComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SignedOutComponent, "signed-out, SignedOut, signedout", never, {}, {}, never, never, true, never>;
+}
+
 declare class BookmarkButtonComponent {
     variant: _angular_core.InputSignal<"default" | "link" | "primary" | "secondary" | "outline" | "accent" | "tertiary" | "ghost" | "light-accent" | "destructive" | "icon" | "ai" | "none" | null | undefined>;
     size: _angular_core.InputSignal<"icon" | "xs" | "sm" | "md" | "lg" | null | undefined>;
@@ -14439,8 +14520,12 @@ declare const authInterceptorFn: HttpInterceptorFn;
 declare const bodyInterceptorFn: (request: HttpRequest<unknown>, next: HttpHandlerFn) => rxjs.Observable<_angular_common_http.HttpEvent<unknown>>;
 
 /**
- * Interceptor function that handles HTTP 401 errors by refreshing authentication
- * and retrying the original request. For 403 errors, logs out the user.
+ * Interceptor function that handles HTTP 401 errors by refreshing authentication and retrying the
+ * original request once. For 403 errors, the error is propagated as a permanent auth failure.
+ *
+ * The retry happens ONLY when `signIn()` reports the user is authenticated, and AT MOST once per
+ * request. Without these two guards a persistent 401 (credentials required, or an endpoint that
+ * keeps rejecting even after a successful CSRF handshake) would retry endlessly.
  *
  * @param request - The HTTP request object.
  * @param next - The HTTP handler function.
@@ -14922,5 +15007,5 @@ type AppFeatures = {
  */
 declare const APP_FEATURES: InjectionToken<AppFeatures>;
 
-export { AGGREGATIONS_NAMES, AGGREGATIONS_NAMES_PRESET_DEFAULT, APP_FEATURES, AdvancedFiltersComponent, AdvancedSearch, AdvancedSearchComponent, AggregationComponent, AggregationDateComponent, AggregationDateRangeDialogComponent, AggregationListComponent, AggregationPanelComponent, AggregationTreeComponent, AggregationsService, AggregationsStore, Alert, AlertDialog, AlertsComponent, AppService, AppStore, ApplicationService, ApplicationStore, ArticleEntities, ArticleExtracts, ArticleLabels, ArticleSimilarDocuments, AsideFiltersComponent, AuditFeedbackType, AuditService, AuthGuard, AuthPageComponent, AutocompleteService, BOOKMARKS_CONFIG, BOOKMARKS_OPTIONS, BackdropComponent, BackdropService, BookmarkButtonComponent, BookmarksComponent, COLLECTIONS_CONFIG, COLLECTIONS_OPTIONS, COMPONENTS_FOR_DOCUMENT_TYPE, ChangePasswordComponent, ChildMarkerDirective, CollectionsComponent, CollectionsDialog, DRAWER_COMPONENT, DRAWER_STACK_MAX_COUNT, DateComponent, DeleteCollectionDialog, DidYouMeanComponent, DocumentLocatorComponent, DrawerAdvancedFiltersComponent, DrawerComponent, DrawerNavbarComponent, DrawerPreviewComponent, DrawerService, DrawerStackComponent, DrawerStackService, DropdownInputComponent, DropdownListComponent, ErrorComponent, ExportDialog, ExportService, FILTERS_BREAKPOINT, FILTER_DATE_ALLOW_CUSTOM_RANGE, FeedbackDialogComponent, FileSizePipe, FilterButtonComponent, FiltersBarComponent, HIGHLIGHTS, HighlightWordPipe, InfinityScrollDirective, InlineWorker, JsonMethodPluginService, KeyboardNavigatorDirective, LabelService, LabelsEditDialog, LoadingComponent, MetadataComponent, MissingTermsComponent, MoreButtonComponent, MoreComponent, MultiSelectLabelsComponent, MultiSelectionToolbarComponent, NON_SEARCHABLE_COLUMNS, NON_SEARCHABLE_DEFAULTS, NavbarTabsComponent, NavigationService, NoResultComponent, OpenArticleOnCtrlEnterDirective, OperatorPipe, OverflowItemDirective, OverflowManagerDirective, OverflowStopDirective, OverrideUserDialogComponent, PREVIEW_CONFIG, PagerComponent, PreviewNavigator, PreviewService, PrincipalService, PrincipalStore, QueryParamsStore, QueryService, RECENT_SEARCHES_CONFIG, RECENT_SEARCHES_OPTIONS, ROUTE_COMPONENTS, RecentSearchesComponent, ResetUserSettingsDialogComponent, SAVED_SEARCHES_CONFIG, SAVED_SEARCHES_OPTIONS, SavedSearchDialog, SavedSearchesComponent, SavedSearchesService, SearchFeedbackComponent, SearchInputFooter, SearchService, SelectArticleDirective, SelectArticleOnClickDirective, SelectionHistoryService, SelectionService, SelectionStore, ShowBookmarkDirective, SidebarNavComponent, SignInComponent, SortSelectorComponent, SourceComponent, SourceIconPipe, SponsoredResultsComponent, SyslangPipe, THEMES, TextChunkService, ThemeProviderDirective, ThemeSelectorComponent, ThemeStore, ThemeToggleComponent, TranslocoDateImpurePipe, UserProfileDialog, UserProfileFormComponent, UserProfileService, UserSettingsStore, applyThemeToNativeElement, auditInterceptorFn, authInterceptorFn, bodyInterceptorFn, buildQuery, debouncedSignal, errorInterceptorFn, getCurrentPath, getCurrentQueryName, getQueryNameFromRoute, injectRouteNavigation, processCssVars, queryNameResolver, signIn, themeColorNameToCssVariable, themeColorsToCssVariables, toastInterceptorFn, withAggregationsFeatures, withAlertsFeatures, withAppFeatures, withApplicationFeatures, withAssistantFeatures, withBasketsFeatures, withBookmarkFeatures, withBootstrapApp, withExtractsFeatures, withFetch, withMultiSelectionFeatures, withPrincipalFeatures, withQueryParamsFeatures, withRecentSearchesFeatures, withSavedSearchesFeatures, withSelectionFeatures, withThemeBodyHook, withThemes, withThemesFeatures, withUserSettingsFeatures };
+export { AGGREGATIONS_NAMES, AGGREGATIONS_NAMES_PRESET_DEFAULT, APP_FEATURES, AdvancedFiltersComponent, AdvancedSearch, AdvancedSearchComponent, AggregationComponent, AggregationDateComponent, AggregationDateRangeDialogComponent, AggregationListComponent, AggregationPanelComponent, AggregationTreeComponent, AggregationsService, AggregationsStore, Alert, AlertDialog, AlertsComponent, AppService, AppStore, ApplicationService, ApplicationStore, ArticleEntities, ArticleExtracts, ArticleLabels, ArticleSimilarDocuments, AsideFiltersComponent, AuditFeedbackType, AuditService, AuthGuard, AuthPageComponent, AutocompleteService, BOOKMARKS_CONFIG, BOOKMARKS_OPTIONS, BackdropComponent, BackdropService, BookmarkButtonComponent, BookmarksComponent, COLLECTIONS_CONFIG, COLLECTIONS_OPTIONS, COMPONENTS_FOR_DOCUMENT_TYPE, ChangePasswordComponent, ChildMarkerDirective, CollectionsComponent, CollectionsDialog, DRAWER_COMPONENT, DRAWER_STACK_MAX_COUNT, DateComponent, DeleteCollectionDialog, DidYouMeanComponent, DocumentLocatorComponent, DrawerAdvancedFiltersComponent, DrawerComponent, DrawerNavbarComponent, DrawerPreviewComponent, DrawerService, DrawerStackComponent, DrawerStackService, DropdownInputComponent, DropdownListComponent, ErrorComponent, ExportDialog, ExportService, FILTERS_BREAKPOINT, FILTER_DATE_ALLOW_CUSTOM_RANGE, FeedbackDialogComponent, FileSizePipe, FilterButtonComponent, FiltersBarComponent, HIGHLIGHTS, HighlightWordPipe, InfinityScrollDirective, InlineWorker, JsonMethodPluginService, KeyboardNavigatorDirective, LabelService, LabelsEditDialog, LoadingComponent, MetadataComponent, MissingTermsComponent, MoreButtonComponent, MoreComponent, MultiSelectLabelsComponent, MultiSelectionToolbarComponent, NON_SEARCHABLE_COLUMNS, NON_SEARCHABLE_DEFAULTS, NavbarTabsComponent, NavigationService, NoResultComponent, OpenArticleOnCtrlEnterDirective, OperatorPipe, OverflowItemDirective, OverflowManagerDirective, OverflowStopDirective, OverrideUserDialogComponent, PREVIEW_CONFIG, PagerComponent, PreviewNavigator, PreviewService, PrincipalService, PrincipalStore, QueryParamsStore, QueryService, RECENT_SEARCHES_CONFIG, RECENT_SEARCHES_OPTIONS, ROUTE_COMPONENTS, RecentSearchesComponent, ResetUserSettingsDialogComponent, SAVED_SEARCHES_CONFIG, SAVED_SEARCHES_OPTIONS, SavedSearchDialog, SavedSearchesComponent, SavedSearchesService, SearchFeedbackComponent, SearchInputFooter, SearchService, SelectArticleDirective, SelectArticleOnClickDirective, SelectionHistoryService, SelectionService, SelectionStore, ShowBookmarkDirective, SidebarNavComponent, SignInComponent, SignedOutComponent, SortSelectorComponent, SourceComponent, SourceIconPipe, SponsoredResultsComponent, SyslangPipe, THEMES, TextChunkService, ThemeProviderDirective, ThemeSelectorComponent, ThemeStore, ThemeToggleComponent, TranslocoDateImpurePipe, UserProfileDialog, UserProfileFormComponent, UserProfileService, UserSettingsStore, applyThemeToNativeElement, auditInterceptorFn, authInterceptorFn, bodyInterceptorFn, bootstrapApp, buildQuery, debouncedSignal, errorInterceptorFn, getCurrentPath, getCurrentQueryName, getQueryNameFromRoute, injectRouteNavigation, processCssVars, queryNameResolver, signIn, themeColorNameToCssVariable, themeColorsToCssVariables, toastInterceptorFn, withAggregationsFeatures, withAlertsFeatures, withAppFeatures, withApplicationFeatures, withAssistantFeatures, withBasketsFeatures, withBookmarkFeatures, withBootstrapApp, withExtractsFeatures, withFetch, withMultiSelectionFeatures, withPrincipalFeatures, withQueryParamsFeatures, withRecentSearchesFeatures, withSavedSearchesFeatures, withSelectionFeatures, withThemeBodyHook, withThemes, withThemesFeatures, withUserSettingsFeatures };
 export type { AgentUserSettings, AggEx, AggregationEx, AggregationListEx, AggregationListItem, AggregationTitle, AggregationTreeEx, AggregationsState, AppCJson, AppFeatures, ApplicationState, ArticleMetadata, AssistantDetails, Autocomplete, Basket, Bookmark, BookmarksConfig, CAggregation, CAggregationItem, CCAppState, CCWebServiceLabels, CConverter, CFilter, CFilterEx, CFilterItem, CJ, CJson, CJsonMint, CSources, CollectionsConfig, ComponentMapping, CssVars, DateRange, DocumentOffsets, DocumentPages, DocumentTypeMap, DropdownItem, ExportQueryOptions, Extract, FilterDropdown, KeyboardNavigationOnSelectionHandlers, KeyboardNavigatorOptions, LabelsConfig, MultiSelectionState, MultiSelectionToolbarVariants, NavRouteTab, PageConfiguration, PreviewEvents, PreviewHighlight, PreviewHighlightName, PreviewHighlights, PrincipalState, SearchItem, SearchOptions, SearchesConfig, SelectionHistoryEvent, SelectionState, SelectionStrategy, SideCJson, SortingChoice, Theme, ThemeBodyHookParameters, ThemeScope, ThemeStoreState, UserSettingsState };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinequa/atomic-angular",
-  "version": "1.5.2",
+  "version": "1.5.5",
   "peerDependencies": {
     "@angular/core": "^20.0.0"
   },