@softheon/armature 21.14.0 → 21.15.0

package/fesm2022/softheon-armature.mjs

@@ -13,7 +13,7 @@ import * as i2$1 from '@ngx-translate/core';
 import { TranslateModule, TranslateService } from '@ngx-translate/core';
 import * as i2 from '@ngbracket/ngx-layout/flex';
 import * as i3 from '@ngbracket/ngx-layout/extended';
-import { BehaviorSubject, of, Subscription, filter as filter$1, lastValueFrom, throwError, tap, ReplaySubject } from 'rxjs';
+import { BehaviorSubject, of, Subscription, filter as filter$1, lastValueFrom, throwError, tap, ReplaySubject, Subject } from 'rxjs';
 import * as i1$2 from 'angular-oauth2-oidc';
 import { AuthConfig } from 'angular-oauth2-oidc';
 import { STEPPER_GLOBAL_OPTIONS } from '@angular/cdk/stepper';
@@ -11722,11 +11722,210 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.1.3", ngImpor
                 type: Input
             }] } });
 
+class MfeEventBusData {
+    get globalId() {
+        return this.uuid;
+    }
+    constructor() {
+        this.uuid = newGuid();
+        this.eventScope = undefined;
+        this.eventData = undefined;
+    }
+}
+
+/**
+ * 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);
+ * });
+ */
+class MfeDataEventBus {
+    constructor() {
+        /** HTTP client for fetching the manifest configuration */
+        this.http = inject(HttpClient);
+        /** Map of MFE names to their event queues */
+        this.eventQueues = new Map();
+        /** Map of consumer keys (mfeName-consumer) to sets of retrieved event IDs */
+        this.retrievedEventIds = new Map();
+        /** Subscription container for cleanup on destroy */
+        this.subscription = new Subscription();
+        this.loadMfManifest();
+    }
+    /** Cleanup subscriptions when the service is destroyed */
+    ngOnDestroy() {
+        this.subscription.unsubscribe();
+    }
+    /**
+     * 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, data) {
+        let queue = this.eventQueues.get(mfeName);
+        if (queue == null) {
+            queue = { events: [], pendingRequest: null };
+            this.eventQueues.set(mfeName, queue);
+        }
+        // Add the event to the queue
+        queue.events.push(data);
+        // If there's a pending request, immediately deliver the event
+        if (queue.pendingRequest) {
+            const events = this.getAllUnretrievedEvents(mfeName, queue.pendingRequest.consumer, queue.pendingRequest.retrievedIds);
+            queue.pendingRequest.subject.next(events);
+            queue.pendingRequest.subject.complete();
+            queue.pendingRequest = null;
+        }
+    }
+    /**
+     * 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
+     */
+    getAllUnretrievedEvents(mfeName, consumer, retrievedIds) {
+        const queue = this.eventQueues.get(mfeName);
+        if (!queue) {
+            return [];
+        }
+        const events = [];
+        for (const event of queue.events) {
+            // Only include events not yet retrieved by this consumer
+            if (!retrievedIds.has(event.globalId)) {
+                retrievedIds.add(event.globalId);
+                if (event.eventScope === consumer) {
+                    events.push(event);
+                }
+            }
+        }
+        return events;
+    }
+    /**
+     * 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, consumer) {
+        // Create or get the key for tracking retrieved events per consumer
+        const key = `${mfeName}-${consumer}`;
+        if (!this.retrievedEventIds.has(key)) {
+            this.retrievedEventIds.set(key, new Set());
+        }
+        const retrievedIds = this.retrievedEventIds.get(key);
+        const subject = new Subject();
+        // Ensure the queue exists for this MFE
+        let queue = this.eventQueues.get(mfeName);
+        if (queue == null) {
+            queue = { events: [], pendingRequest: null };
+            this.eventQueues.set(mfeName, queue);
+        }
+        // Check for existing unretrieved events
+        const existingEvents = this.getAllUnretrievedEvents(mfeName, consumer, retrievedIds);
+        if (existingEvents.length > 0) {
+            // Emit immediately if there are existing events
+            setTimeout(() => {
+                subject.next(existingEvents);
+                subject.complete();
+            });
+        }
+        else {
+            // No events yet - set up a pending request to wait for new events
+            queue.pendingRequest = { consumer, subject, retrievedIds: new Set() };
+        }
+        return subject;
+    }
+    /**
+     * 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.
+     */
+    loadMfManifest() {
+        this.subscription.add(this.http.get('./assets/configurations/mf.manifest.json').subscribe({
+            next: manifest => {
+                this.parseManifest(manifest);
+            },
+            error: error => {
+                console.error('Failed to load mf.manifest.json:', error);
+            },
+        }));
+    }
+    /**
+     * Parses the manifest and initializes event queues for each MFE.
+     *
+     * @param manifest - A map of MFE names from the manifest configuration
+     */
+    parseManifest(manifest) {
+        Object.keys(manifest).forEach(key => {
+            if (!this.eventQueues.has(key)) {
+                this.eventQueues.set(key, { events: [], pendingRequest: null });
+            }
+        });
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.1.3", ngImport: i0, type: MfeDataEventBus, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.1.3", ngImport: i0, type: MfeDataEventBus, providedIn: 'root' }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.1.3", ngImport: i0, type: MfeDataEventBus, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }], ctorParameters: () => [] });
+
 /** Public API Surface of armature */
 
 /**
  * Generated bundle index. Do not edit.
  */
 
-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 };
+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 };
 //# sourceMappingURL=softheon-armature.mjs.map