@sinequa/atomic-angular 1.19.2 → 1.19.4

package/index.d.ts

@@ -4789,6 +4789,37 @@ declare class AutocompleteService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<AutocompleteService>;
 }
 
+interface EntityNavigation {
+    /** The entity value being navigated (i.e. "ALBERT EINSTEIN") */
+    value: string;
+    /** The 1-based index of the current occurrence */
+    index: number;
+}
+/**
+ * Cursor over the occurrences of an entity value highlighted in the preview.
+ *
+ * The number of occurrences is the one actually located in the preview (`PreviewService.getEntityLocations`),
+ * not the `count` of the indexed record, which can be greater (ES-32245).
+ */
+declare class EntityNavigationService {
+    private readonly previewService;
+    private lastPreviewData;
+    /** The current position, shared by the entities panels */
+    readonly navigation: _angular_core.WritableSignal<EntityNavigation | undefined>;
+    /** The value hovered in the panel */
+    readonly hovering: _angular_core.WritableSignal<string | undefined>;
+    /** The 1-based position of the hovered value, `0` when it is not the one being navigated */
+    readonly hoverIndex: _angular_core.Signal<number>;
+    /**
+     * Number of occurrences of `value` highlighted in the preview.
+     * `fallback` (the indexed count) is only used while no preview is loaded.
+     */
+    total(entity: string, value: string, fallback?: number): number;
+    navigate(entity: string, value: string, direction: "next" | "prev"): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EntityNavigationService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<EntityNavigationService>;
+}
+
 type Options = {
     headers?: HttpHeaders | {
         [header: string]: string | string[];
@@ -5708,6 +5739,20 @@ declare class PreviewService {
      * @returns the html id
      */
     getEntityId(entity: string, value: string, index: number): number | undefined;
+    /**
+     * Get the ids of every occurrence of an entity value that is actually highlighted in the preview,
+     * ordered by position in the document.
+     *
+     * This is the source of truth for entity navigation: the `count` carried by the indexed record can be
+     * greater than the number of occurrences located in the converted document (ES-32245).
+     *
+     * @param entity the entity type (i.e. "geo")
+     * @param value the entity value (i.e. "AUSTRALIA")
+     * @returns the html ids (`positionInCategories[entity]`), empty when nothing is highlighted
+     */
+    getEntityLocations(entity: string, value: string): number[];
+    /** Memoized `getEntityLocations` results, dropped with the `PreviewData` they were computed from. */
+    private readonly entityLocationsCache;
     /**
      * Send a message to the prewiew iFrame with the required data to retrieve HTML content for a specific highlight category
      *
@@ -8512,10 +8557,6 @@ declare class AdvancedSearch {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<AdvancedSearch, "advanced-search", never, { "article": { "alias": "article"; "required": true; "isSignal": true; }; "previewStrategy": { "alias": "previewStrategy"; "required": false; "isSignal": true; }; }, { "selected": "selected"; }, never, never, true, never>;
 }
 
-interface MetadataNavigation {
-    index: number;
-    value: string;
-}
 declare class ArticleEntities {
     cn: typeof cn;
     protected readonly appStore: {
@@ -8834,6 +8875,7 @@ declare class ArticleEntities {
         columnMap?: Record<string, _sinequa_atomic.CCColumn> | undefined;
     }>;
     protected readonly previewService: PreviewService;
+    protected readonly entityNavigation: EntityNavigationService;
     readonly article: _angular_core.InputSignal<Article$1>;
     protected readonly previewHighlights: _angular_core.Signal<{
         name: string;
@@ -8841,11 +8883,12 @@ declare class ArticleEntities {
         metadata: ArticleMetadata[];
     }[] | undefined>;
     getMetadata(article: Partial<Article$1 & Record<string, unknown>>, entity: string): ArticleMetadata[];
-    navigation: _angular_core.WritableSignal<MetadataNavigation | undefined>;
-    hovering: _angular_core.WritableSignal<string | undefined>;
-    hoverIndex: _angular_core.Signal<number>;
+    readonly navigation: _angular_core.WritableSignal<_sinequa_atomic_angular.EntityNavigation | undefined>;
+    readonly hovering: _angular_core.WritableSignal<string | undefined>;
+    readonly hoverIndex: _angular_core.Signal<number>;
+    /** Number of occurrences of the entity value highlighted in the preview (not the indexed `count`, see ES-32245) */
+    total(entity: string, data: ArticleMetadata): number;
     scrollTo(type: string | undefined, index: number, usePassageHighlighter?: boolean): void;
-    private navigate;
     navigateNext(entity: string, data: ArticleMetadata): void;
     navigatePrev(entity: string, data: ArticleMetadata): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<ArticleEntities, never>;
@@ -15801,8 +15844,8 @@ declare class UserProfileFormComponent {
     customData: _angular_core.Signal<string[]>;
     readonly allowChangePassword: _angular_core.Signal<boolean | undefined>;
     constructor();
-    protected userProfileResource: _angular_common_http.HttpResourceRef<_sinequa_atomic.UserProfile | undefined>;
-    readonly userProfile: _angular_core.WritableSignal<_sinequa_atomic.UserProfile | undefined>;
+    protected userProfileResource: _angular_common_http.HttpResourceRef<UserProfile | undefined>;
+    readonly userProfile: _angular_core.WritableSignal<UserProfile | undefined>;
     createUserProfile(): Promise<void>;
     /**
      * On editing a value, we save its former value to set it back in case of error
@@ -15819,6 +15862,15 @@ declare class UserProfileFormComponent {
     fieldState(key: string): "success" | "error" | undefined;
     /** Leaves the editor without saving. */
     onCancelEdit(): void;
+    /**
+     * Whether the profile holds a value for a property. Only then is there something to delete: a property
+     * that shows its configured default, or that is simply not set, is absent from the profile and the
+     * server answers 404 to a delete on it (ES-34462).
+     *
+     * @param category data or customData
+     * @param propertyName property name
+     */
+    hasStoredValue(category: "data" | "customData", propertyName: string): boolean;
     /**
      * On data property deletion, for now we make the property an empty string
      *
@@ -15826,6 +15878,8 @@ declare class UserProfileFormComponent {
      * @param propertyName property name
      */
     onDeleteData(category: "data" | "customData", propertyName: string): Promise<void>;
+    /** Takes a deleted property out of the stored profile; a custom property with a default shows that default again. */
+    private forgetProperty;
     /**
      * Saving a data property
      *
@@ -15833,6 +15887,14 @@ declare class UserProfileFormComponent {
      * @param propertyName property name
      */
     onSaveData(category: "data" | "customData", propertyName: string): Promise<void>;
+    /**
+     * Folds the answer of a PATCH back into the stored profile, so the form shows what was just saved.
+     *
+     * The answer depends on the server: before ES-34373 it is the whole updated profile (`{ data, customData, … }`),
+     * after it is the written value alone (`"fav-1AAA"`). Reading the latter as a profile used to leave the stored
+     * profile unchanged, and the form kept showing the old value (or the default) until the page was reloaded.
+     */
+    private foldSavedValue;
     /**
      * Get the value of a data key
      *
@@ -16391,5 +16453,5 @@ type AppFeatures = {
  */
 declare const APP_FEATURES: InjectionToken<AppFeatures>;
 
-export { AGGREGATIONS_NAMES, AGGREGATIONS_NAMES_PRESET_DEFAULT, APP_FEATURES, AdvancedFiltersComponent, AdvancedSearch, AdvancedSearchComponent, AggregationComponent, AggregationDateComponent, AggregationDateRangeDialogComponent, AggregationItemDirective, 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, FeatureFlagsDialogComponent, 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, __resetSignInMutexForTests, applyThemeToNativeElement, auditInterceptorFn, authInterceptorFn, bodyInterceptorFn, bootstrapApp, buildQuery, debouncedSignal, errorInterceptorFn, getCurrentPath, getCurrentQueryName, getQueryNameFromRoute, injectRouteNavigation, isAuthRoute, isSignInInFlight, legacyFilterToFilter, processCssVars, queryNameResolver, signIn, themeColorNameToCssVariable, themeColorsToCssVariables, toastInterceptorFn, withAggregationsFeatures, withAlertsFeatures, withAppFeatures, withApplicationFeatures, withAssistantFeatures, withBasketsFeatures, withBookmarkFeatures, withBootstrapApp, withExtractsFeatures, withFetch, withMultiSelectionFeatures, withQueryParamsFeatures, withRecentSearchesFeatures, withSavedSearchesFeatures, withSelectionFeatures, withThemeBodyHook, withThemes, withThemesFeatures, withUserSettingsFeatures };
-export type { AgentUserSettings, AggEx, AggregationEx, AggregationItemContext, AggregationListEx, AggregationListItem, AggregationSelection, AggregationTitle, AggregationTreeEx, AggregationTreeItemContext, AggregationsState, AppCJson, AppFeatures, ApplicationState, ArticleMetadata, AssistantDetails, Autocomplete, Basket, Bookmark, BookmarksConfig, CAggregation, CAggregationItem, CCAppState, CCWebServiceLabels, CConverter, CFeedback, CFilter, CFilterEx, CFilterItem, CJ, CJson, CJsonMint, CSources, CollectionsConfig, ComponentMapping, CssVars, CustomDataEntry, 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 };
+export { AGGREGATIONS_NAMES, AGGREGATIONS_NAMES_PRESET_DEFAULT, APP_FEATURES, AdvancedFiltersComponent, AdvancedSearch, AdvancedSearchComponent, AggregationComponent, AggregationDateComponent, AggregationDateRangeDialogComponent, AggregationItemDirective, 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, EntityNavigationService, ErrorComponent, ExportDialog, ExportService, FILTERS_BREAKPOINT, FILTER_DATE_ALLOW_CUSTOM_RANGE, FeatureFlagsDialogComponent, 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, __resetSignInMutexForTests, applyThemeToNativeElement, auditInterceptorFn, authInterceptorFn, bodyInterceptorFn, bootstrapApp, buildQuery, debouncedSignal, errorInterceptorFn, getCurrentPath, getCurrentQueryName, getQueryNameFromRoute, injectRouteNavigation, isAuthRoute, isSignInInFlight, legacyFilterToFilter, processCssVars, queryNameResolver, signIn, themeColorNameToCssVariable, themeColorsToCssVariables, toastInterceptorFn, withAggregationsFeatures, withAlertsFeatures, withAppFeatures, withApplicationFeatures, withAssistantFeatures, withBasketsFeatures, withBookmarkFeatures, withBootstrapApp, withExtractsFeatures, withFetch, withMultiSelectionFeatures, withQueryParamsFeatures, withRecentSearchesFeatures, withSavedSearchesFeatures, withSelectionFeatures, withThemeBodyHook, withThemes, withThemesFeatures, withUserSettingsFeatures };
+export type { AgentUserSettings, AggEx, AggregationEx, AggregationItemContext, AggregationListEx, AggregationListItem, AggregationSelection, AggregationTitle, AggregationTreeEx, AggregationTreeItemContext, AggregationsState, AppCJson, AppFeatures, ApplicationState, ArticleMetadata, AssistantDetails, Autocomplete, Basket, Bookmark, BookmarksConfig, CAggregation, CAggregationItem, CCAppState, CCWebServiceLabels, CConverter, CFeedback, CFilter, CFilterEx, CFilterItem, CJ, CJson, CJsonMint, CSources, CollectionsConfig, ComponentMapping, CssVars, CustomDataEntry, DateRange, DocumentOffsets, DocumentPages, DocumentTypeMap, DropdownItem, EntityNavigation, 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.19.2",
+  "version": "1.19.4",
   "publishConfig": {
     "access": "public"
   },