@softheon/armature 21.13.0 → 21.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softheon/armature",
-  "version": "21.13.0",
+  "version": "21.15.0",
   "dependencies": {
     "tslib": "^2.8.1"
   },

package/types/softheon-armature.d.ts

@@ -5,7 +5,7 @@ import * as i6 from '@ngx-translate/core';
 import { TranslateService, TranslationObject } from '@ngx-translate/core';
 import { AuthConfig, OAuthService, OAuthStorage } from 'angular-oauth2-oidc';
 import * as rxjs from 'rxjs';
-import { Observable, Subscription, BehaviorSubject } from 'rxjs';
+import { Observable, Subscription, BehaviorSubject, Subject } from 'rxjs';
 import * as i3 from '@angular/router';
 import { Router, ActivatedRoute } from '@angular/router';
 import * as i2 from '@angular/common';
@@ -7497,5 +7497,117 @@ declare class EntityInjectWrapperComponent implements OnInit {
     static ɵcmp: i0.ɵɵComponentDeclaration<EntityInjectWrapperComponent, "lib-entity-inject-wrapper", never, { "defaultSize": { "alias": "defaultSize"; "required": false; }; }, { "expandClicked": "expandClicked"; "closeClicked": "closeClicked"; }, never, ["*"], true, never>;
 }
 
-export { ALERT_BANNER_CONFIG, AbstractSamlEntryService, AbstractSamlService, AbstractStartupService, AccessTokenClaims, AlertBannerComponent, AlertBannerModule, AlertBannerService, AlertService, AlphaNumericDirective, AppTemplateComponent, ApplicationUserModel, ArRoleNavService, ArmError, ArmatureFooterComponent, ArmatureFooterModule, ArmatureHeaderComponent, ArmatureHeaderModule, ArmatureModule, ArmatureNavigationComponent, ArmatureResizePanelsModule, Attribute, AuthorizationService, B2bNavComponent, BannerService, BannerType, BaseComponentModule, BaseConfigService, CacheExpirationType, ComponentSavePrintComponent, ComponentSavePrintService, Configuration, ConfirmAddressData, CoverageDetail, CssOverride, CssOverrideDirective, CustomAuthConfigService, DISABLE_ACCESS_FOR_NO_PAGES_ROLE, DISTRIBUTED_CACHE_BASE_PATH, DataStoreConfig, DateInputFilterDirective, DecodedAccessToken, DefaultConfigService, DialogResult, DistributedCacheModule, ENTITY_SESSION_STORAGE_PREFIX, ENTITY_SS_CONFIG_PREFIX, EntityBaseComponent, EntityHelperService, EntityInjectWrapperComponent, FAQ, FAQConfig, FEDERATED_MODULE_ID, FaqComponent, FaqModule, FeedbackToolComponent, FeedbackToolModule, FooterConfig, FormsModule, HYBRID_SAML_OAUTH_CONFIG, HeaderAuthSettings, HybridSamlOAuthConfig, HybridSamlOauthService, InputTrimDirective, LINE_OF_COVERAGE, LettersCharactersDirective, LettersOnlyDirective, MarketSelectionConfig, MarketSelectionService, MfeModule, MobileHeaderMenuComponent, ModalData, NavigationModule, NumbersOnlyDirective, Oauth2RoleService, OauthModule, PhoneFormatPipe, PolicyPerson, RBAC_CONFIG, RbacActionDirective, RbacConfig, RbacModule, RedirectSamlComponent, RedirectSamlRequest, RedirectSessionConfigs, ResizePanelsComponent, RoleAccess, RoleNavService, RoutePath, RumConfig, RumModule, RumService, SESSION_CONFIG, SOF_BLANK_LANGUAGE_OVERRIDE, SOF_DATE_PIPE_FORMATS, STATUS, SamlModule, SamlService, SelectedMarketContext, ServerCacheService, SessionConfig, SessionService, SharedErrorService, SiteMapComponent, SiteMapDirection, SnackbarService, SofAddressComponent, SofAlertComponent, SofArComponentSavePrintModule, SofBadgeComponent, SofBannerComponent, SofBlankPipe, SofBottomSheetComponent, SofBreadcrumbsHierarchyComponent, SofBreadcrumbsHistoryComponent, SofButtonToggleGroupComponent, SofCalloutComponent, SofChartSkeletonLoaderComponent, SofChipComponent, SofCompareAddressPipe, SofConfirmAddressComponent, SofConfirmAddressCountyChangeComponent, SofContextComponent, SofDatePipe, SofDropdownButtonComponent, SofErrorCommonComponent, SofHandleComponent, SofHeaderComponent, SofImageCheckboxComponent, SofInputStepperComponent, SofModalComponent, SofNavPanelComponent, SofPipeModule, SofProgressBarComponent, SofRadioCardComponent, SofSegmentedControlComponent, SofSelectComponent, SofSimpleAlertComponent, SofSkeletonLoaderComponent, SofSnackbarComponent, SofSsnPipe, SofStarRatingComponent, SofSubNavigationComponent, SofSvgLoaderComponent, SofTabsComponent, SofToastComponent, SofUtilityButtonComponent, SoftheonErrorHandlerService, SsoGatewayEntryService, SsoGatewayModel, States, TextOverflowEllipsisTooltipDirective, ThemeModule, ThemeService, ToastService, TypedSession, USER_ENTITY_SERVICE_CONFIG, UserEntityService, UserEntityServiceConfig, ValidationKeys, WINDOW, httpVerb, initializerFactory, keyPathPrefix, languageStorageKey, newGuid, pascalToCamel, preSignInRouteStorageKey, removeMenuRole, routeToPreLoginRoute, sessionBasePathFactory, userInitialsPipe };
+declare class MfeEventBusData {
+    private uuid;
+    get globalId(): string;
+    eventScope: string | undefined;
+    eventData: any | unknown;
+    constructor();
+}
+
+/**
+ * Event bus service for communication between MFEs (Micro Frontends).
+ *
+ * This service manages event queues for each registered MFE and provides:
+ * - Publishing events to MFE-specific queues
+ * - Retrieving unretrieved events for a given consumer
+ * - Automatic management of event consumption per consumer
+ *
+ * Events are tracked by a unique globalId to ensure each event is only
+ * retrieved once per consumer unless explicitly republished.
+ *
+ * @example
+ * // Publish an event
+ * eventBus.publishEvent('entity-mfe', { globalId: '123', eventScope: 'test', data: {} });
+ *
+ * // Subscribe to events
+ * eventBus.getLatestEvents('entity-mfe', 'my-consumer').subscribe(events => {
+ *   console.log('Received events:', events);
+ * });
+ */
+declare class MfeDataEventBus implements OnDestroy {
+    /** HTTP client for fetching the manifest configuration */
+    http: HttpClient;
+    /** Map of MFE names to their event queues */
+    private eventQueues;
+    /** Map of consumer keys (mfeName-consumer) to sets of retrieved event IDs */
+    private retrievedEventIds;
+    /** Subscription container for cleanup on destroy */
+    private subscription;
+    constructor();
+    /** Cleanup subscriptions when the service is destroyed */
+    ngOnDestroy(): void;
+    /**
+     * Publishes an event to a specific MFE's event queue.
+     *
+     * If there is a pending request for this MFE, the event will be immediately
+     * delivered to the waiting consumer. Otherwise, the event is stored in the queue.
+     *
+     * @param mfeName - The name of the target MFE
+     * @param data - The event data to publish
+     *
+     * @example
+     * eventBus.publishEvent('entity-mfe', {
+     *   globalId: 'evt-001',
+     *   eventScope: 'entity-update',
+     *   payload: { entityId: 123 }
+     * });
+     */
+    publishEvent(mfeName: string, data: MfeEventBusData): void;
+    /**
+     * Retrieves all unretrieved events from the queue that have not been seen
+     * by the pending request yet.
+     *
+     * @param mfeName - The name of the MFE
+     * @param consumer - The consumer identifier
+     * @param retrievedIds - Set of already retrieved event IDs for this request
+     * @returns Array of unretrieved events
+     */
+    private getAllUnretrievedEvents;
+    /**
+     * Gets events for a specific MFE that have not been retrieved yet.
+     *
+     * If there are existing unretrieved events, they are returned immediately.
+     * If the queue is empty, a pending request is set up to wait for new events.
+     *
+     * When using pending requests, events are batched and emitted all at once
+     * when publishEvent is called, ensuring the subscriber receives the final
+     * complete list of events.
+     *
+     * @param mfeName - The name of the MFE to get events from
+     * @param consumer - A unique identifier for the consumer (e.g., component name)
+     * @returns A Subject that will emit an array of unretrieved events and then complete
+     *
+     * @example
+     * // In a component
+     * eventBus.getLatestEvents('entity-mfe', 'my-component').subscribe(events => {
+     *   // events contains all events not previously retrieved
+     *   events.forEach(event => this.processEvent(event));
+     * });
+     *
+     * // When entity updates occur
+     * eventBus.publishEvent('entity-mfe', { globalId: '1', eventScope: 'update', data: {} });
+     * eventBus.publishEvent('entity-mfe', { globalId: '2', eventScope: 'update', data: {} });
+     *
+     * // The subscriber will receive both events in a single array
+     */
+    getLatestEvents(mfeName: string, consumer: string): Subject<MfeEventBusData[]>;
+    /**
+     * Loads the MFE manifest configuration from the server.
+     *
+     * The manifest is expected to be a Map where keys are MFE names.
+     * Each MFE in the manifest gets its own event queue initialized.
+     */
+    private loadMfManifest;
+    /**
+     * Parses the manifest and initializes event queues for each MFE.
+     *
+     * @param manifest - A map of MFE names from the manifest configuration
+     */
+    private parseManifest;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MfeDataEventBus, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MfeDataEventBus>;
+}
+
+export { ALERT_BANNER_CONFIG, AbstractSamlEntryService, AbstractSamlService, AbstractStartupService, AccessTokenClaims, AlertBannerComponent, AlertBannerModule, AlertBannerService, AlertService, AlphaNumericDirective, AppTemplateComponent, ApplicationUserModel, ArRoleNavService, ArmError, ArmatureFooterComponent, ArmatureFooterModule, ArmatureHeaderComponent, ArmatureHeaderModule, ArmatureModule, ArmatureNavigationComponent, ArmatureResizePanelsModule, Attribute, AuthorizationService, B2bNavComponent, BannerService, BannerType, BaseComponentModule, BaseConfigService, CacheExpirationType, ComponentSavePrintComponent, ComponentSavePrintService, Configuration, ConfirmAddressData, CoverageDetail, CssOverride, CssOverrideDirective, CustomAuthConfigService, DISABLE_ACCESS_FOR_NO_PAGES_ROLE, DISTRIBUTED_CACHE_BASE_PATH, DataStoreConfig, DateInputFilterDirective, DecodedAccessToken, DefaultConfigService, DialogResult, DistributedCacheModule, ENTITY_SESSION_STORAGE_PREFIX, ENTITY_SS_CONFIG_PREFIX, EntityBaseComponent, EntityHelperService, EntityInjectWrapperComponent, FAQ, FAQConfig, FEDERATED_MODULE_ID, FaqComponent, FaqModule, FeedbackToolComponent, FeedbackToolModule, FooterConfig, FormsModule, HYBRID_SAML_OAUTH_CONFIG, HeaderAuthSettings, HybridSamlOAuthConfig, HybridSamlOauthService, InputTrimDirective, LINE_OF_COVERAGE, LettersCharactersDirective, LettersOnlyDirective, MarketSelectionConfig, MarketSelectionService, MfeDataEventBus, MfeEventBusData, MfeModule, MobileHeaderMenuComponent, ModalData, NavigationModule, NumbersOnlyDirective, Oauth2RoleService, OauthModule, PhoneFormatPipe, PolicyPerson, RBAC_CONFIG, RbacActionDirective, RbacConfig, RbacModule, RedirectSamlComponent, RedirectSamlRequest, RedirectSessionConfigs, ResizePanelsComponent, RoleAccess, RoleNavService, RoutePath, RumConfig, RumModule, RumService, SESSION_CONFIG, SOF_BLANK_LANGUAGE_OVERRIDE, SOF_DATE_PIPE_FORMATS, STATUS, SamlModule, SamlService, SelectedMarketContext, ServerCacheService, SessionConfig, SessionService, SharedErrorService, SiteMapComponent, SiteMapDirection, SnackbarService, SofAddressComponent, SofAlertComponent, SofArComponentSavePrintModule, SofBadgeComponent, SofBannerComponent, SofBlankPipe, SofBottomSheetComponent, SofBreadcrumbsHierarchyComponent, SofBreadcrumbsHistoryComponent, SofButtonToggleGroupComponent, SofCalloutComponent, SofChartSkeletonLoaderComponent, SofChipComponent, SofCompareAddressPipe, SofConfirmAddressComponent, SofConfirmAddressCountyChangeComponent, SofContextComponent, SofDatePipe, SofDropdownButtonComponent, SofErrorCommonComponent, SofHandleComponent, SofHeaderComponent, SofImageCheckboxComponent, SofInputStepperComponent, SofModalComponent, SofNavPanelComponent, SofPipeModule, SofProgressBarComponent, SofRadioCardComponent, SofSegmentedControlComponent, SofSelectComponent, SofSimpleAlertComponent, SofSkeletonLoaderComponent, SofSnackbarComponent, SofSsnPipe, SofStarRatingComponent, SofSubNavigationComponent, SofSvgLoaderComponent, SofTabsComponent, SofToastComponent, SofUtilityButtonComponent, SoftheonErrorHandlerService, SsoGatewayEntryService, SsoGatewayModel, States, TextOverflowEllipsisTooltipDirective, ThemeModule, ThemeService, ToastService, TypedSession, USER_ENTITY_SERVICE_CONFIG, UserEntityService, UserEntityServiceConfig, ValidationKeys, WINDOW, httpVerb, initializerFactory, keyPathPrefix, languageStorageKey, newGuid, pascalToCamel, preSignInRouteStorageKey, removeMenuRole, routeToPreLoginRoute, sessionBasePathFactory, userInitialsPipe };
 export type { AccountManagementAssertionModel, AccountManagementResponseModel, Address, AlertBannerColors, AlertBannerConfig, AlertBannerContext, AssertedUserModel, BadgeTooltipData, BannerActionButtonConfig, BaseConfig, BottomSheetData, BrandingModel, Breadcrumb, ButtonBadgeConfig, ButtonData, ButtonToggleData, ButtonToggleTooltipData, CalloutActionButtonConfig, Chip, ConfigurationParameters, ConfirmAddressCountyChangeData, ContactInfo, ContextMenuItem, County, CreateCacheEntryRequestModel, CustomWorkFlowActionEvent, EntityConfigBase, EntityDto, ErrorModel, ErrorReference, Extension, Finance, Folder, FolderLink, HandleInput, HeaderConfig, HeaderExternalLinks, HeaderLanguageSettings, HeaderSettings, HeaderThemeSettings, HeaderUserMenuData, HttpVerb, ISamlRequest, ISamlResponse, ISsoResponseModel, IdentityProfile, MarketSelection, MobileHeaderNavSettings, NavBadgeUpdate, NavNode, NavNodeAvailableBadge, NavNodeBadgeConfig, NavPanelLogo, NavPanelNode, NavPanelSettings, NavigationAdvancedSettings, NavigationConfig, NavigationSettings, NavigationThemeSettings, OAuthModel, OidcAuthSettings, Person, Policy, PreferencesRow, Profile, ResizeEvent, RetrieveCacheEntryResponseModel, SegmentedControlData, SelectOption, SessionGetResponseModel, SessionPostRequestModel, SessionPostResponseModel, SessionPutRequestModel, SessionPutResponseModel, SessionResponseModel, SettingsProfile, SiteMapConfig, SiteMapLink, SiteMapNode, SkeletonAnimation, SkeletonBarChartDirection, SkeletonChartType, SkeletonShape, Snackbar, SofDatePipeFormat, Styles, SubNavNodes, SubNavigationData, SubdomainConfig, TabNavLink, ThemePaletteColorsModel, ThemePaletteModel, ToastModel, TrackingModel, UpdateCacheEntryRequestModel, UserFeedback, ValidationRecordsRow };