@acorex-platform/module-communication-management-client 0.0.21

package/types/acorex-platform-module-communication-management-client.d.ts

@@ -0,0 +1,360 @@
+import * as _angular_core from '@angular/core';
+import { OnInit, InjectionToken, Signal } from '@angular/core';
+import * as i1 from '@acorex-platform/framework-client/core';
+import { CommunicationSendInput, CommunicationSendResult, CommunicationDeliveryEngagementRequest, CommunicationDeliveryEngagementResult, CommunicationDeliveryMutationResult, CommunicationSmtpTestInput, CommunicationSmtpTestResult } from '@acorex-platform/module-communication-management-client/contracts';
+import * as _acorex_platform_module_dashboard_management_client from '@acorex-platform/module-dashboard-management-client';
+import * as dist_libs_modules_dashboard_management_contracts_src from 'dist/libs/modules/dashboard-management/contracts/src';
+import { AXMCommonDashboardEntityModel } from '@acorex-platform/module-dashboard-management-contracts';
+import * as _acorex_platform_module_communication_management_client from '@acorex-platform/module-communication-management-client';
+import { AXPValueWidgetComponent } from '@acorex-platform/framework-client/layout/widget-core';
+import { AXPWidgetConfig } from '@acorex-platform/framework-shared/widget-core';
+import { AXPUserReference, AXPFilterQuery, AXPPagedListResult } from '@acorex-platform/framework-shared/core';
+import * as rxjs from 'rxjs';
+import * as _acorex_platform_framework_client_common from '@acorex-platform/framework-client/common';
+import { AXPSettingDefinitionProviderContext, AXPMenuProvider, AXPMenuProviderContext, AXPSearchCommandProvider, AXPSearchResult } from '@acorex-platform/framework-client/common';
+import { AXPPermissionDefinitionProvider, AXPPermissionDefinitionProviderContext } from '@acorex-platform/framework-client/auth';
+
+declare class AXMCommunicationManagementModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMCommunicationManagementModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXMCommunicationManagementModule, never, [typeof i1.AXPComponentSlotModule], never>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXMCommunicationManagementModule>;
+}
+
+declare abstract class AXPCommunicationManagementClient {
+    abstract send(input: CommunicationSendInput): Promise<CommunicationSendResult>;
+    abstract markInAppSeen(request: CommunicationDeliveryEngagementRequest): Promise<CommunicationDeliveryEngagementResult>;
+    abstract markInAppRead(request: CommunicationDeliveryEngagementRequest): Promise<CommunicationDeliveryEngagementResult>;
+    abstract markAllInAppRead(): Promise<CommunicationDeliveryEngagementResult>;
+    abstract toggleInAppPin(request: CommunicationDeliveryEngagementRequest): Promise<CommunicationDeliveryMutationResult>;
+    abstract archiveInApp(request: CommunicationDeliveryEngagementRequest): Promise<CommunicationDeliveryMutationResult>;
+    abstract deleteInApp(request: CommunicationDeliveryEngagementRequest): Promise<CommunicationDeliveryMutationResult>;
+    abstract testSmtp(input: CommunicationSmtpTestInput): Promise<CommunicationSmtpTestResult>;
+}
+
+/** Unread in-app inbox dashboard tile. */
+declare const AXP_MY_IN_APP_INBOX_DASHBOARD_DIMENSIONS: Required<Partial<Record<dist_libs_modules_dashboard_management_contracts_src.AXMDashboardBreakpoint, _acorex_platform_module_dashboard_management_client.AXPDashboardBreakpointDimensions>>>;
+
+type DashboardSeedWidget = AXMCommonDashboardEntityModel['widgets'][number];
+type DashboardSeedGridSize = readonly [width: number, height: number];
+declare function buildMyInAppInboxDashboardWidget(id: string, x: number, y: number, size?: DashboardSeedGridSize): DashboardSeedWidget;
+
+declare class AXPCommunicationInAppInboxWidgetViewComponent extends AXPValueWidgetComponent<unknown> implements OnInit {
+    private readonly cdr;
+    private readonly connector;
+    private readonly inboxActions;
+    protected readonly i18n: _acorex_platform_module_communication_management_client.AXPInAppInboxI18nKeys;
+    protected readonly maxItems: _angular_core.Signal<any>;
+    protected readonly showAvatar: _angular_core.Signal<any>;
+    protected readonly showDate: _angular_core.Signal<any>;
+    protected readonly inboxItems: _angular_core.Signal<_acorex_platform_module_communication_management_client.AXPInAppInboxItem[]>;
+    ngOnInit(): void;
+    protected onItemPress(id: string): Promise<void>;
+    protected onDismissUnread(id: string): Promise<void>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPCommunicationInAppInboxWidgetViewComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXPCommunicationInAppInboxWidgetViewComponent, "ng-component", never, {}, {}, never, never, true, never>;
+}
+
+declare const AXPMyInAppInboxDashboardWidget: AXPWidgetConfig;
+
+type AXPInAppInboxPriority = 'Notice' | 'Danger' | 'Warning';
+type AXPInAppInboxTabKey = 'Unread' | 'All' | (string & {});
+interface AXPInAppInboxCapabilities {
+    seenTracking: boolean;
+    readTracking: boolean;
+    pinSupport: boolean;
+    categoryTabs: boolean;
+}
+interface AXPInAppInboxItem {
+    id: string;
+    title: string;
+    body: string;
+    createdAt: Date;
+    seenAt?: Date | null;
+    readAt?: Date | null;
+    sender?: AXPUserReference;
+    /** Font Awesome classes for a circular leading icon (used instead of user avatar). */
+    iconClass?: string;
+    /** When false, hide the leading avatar/icon for this row. Omitted = show (if the host also allows it). */
+    showAvatar?: boolean;
+    priority?: AXPInAppInboxPriority;
+    isPinned?: boolean;
+    category?: string;
+    definitionKey?: string;
+    archivedAt?: Date | null;
+    actions?: Array<{
+        title: string;
+        command: {
+            name: string;
+            options?: Record<string, unknown>;
+        };
+    }>;
+}
+interface AXPInAppInboxLoadQuery {
+    skip?: number;
+    take?: number;
+    filters?: AXPFilterQuery[];
+    /** When true (default for tray), exclude archived deliveries. */
+    excludeArchived?: boolean;
+}
+interface AXPInAppInboxListResult$1 {
+    total: number;
+    items: AXPInAppInboxItem[];
+}
+interface AXPInAppInboxI18nKeys {
+    panelTitle: string;
+    unread: string;
+    all: string;
+    markAllAsRead: string;
+    viewAll: string;
+    emptyTitle: string;
+    emptyDescription: string;
+    pageTitle: string;
+    pageDescriptionNone: string;
+    pageDescriptionUnread: string;
+    pageDescriptionAllRead: string;
+    refresh: string;
+    pin: string;
+    unpin: string;
+    delete: string;
+    archive: string;
+    markAsRead: string;
+    selectItems: string;
+    clearFilters: string;
+    liveUpdatesOffline: string;
+}
+interface AXPInAppInboxConfig {
+    headerIconClass: string;
+    viewAllRoute: (appName: string) => string[];
+    settingsRoute?: (appName: string) => string[];
+}
+interface AXPInAppInboxChangeEvent {
+    type: 'created' | 'seen' | 'read' | 'refresh' | 'deleted' | 'archived' | 'pin';
+    item?: AXPInAppInboxItem;
+    ids?: string[];
+}
+
+declare function isInAppInboxUnread(readAt: Date | null | undefined): boolean;
+declare function isInAppInboxUnseen(seenAt: Date | null | undefined): boolean;
+declare function getInAppInboxPriorityClass(priority: AXPInAppInboxPriority | undefined): string;
+declare function sortInAppInboxItems<T extends AXPInAppInboxItem>(items: T[]): T[];
+declare function normalizeInAppInboxItem<T extends Partial<AXPInAppInboxItem>>(item: T): AXPInAppInboxItem;
+
+/**
+ * Module-backed inbox data source. Communication-management registers the primary
+ * implementation.
+ */
+interface AXPInAppInboxPort {
+    readonly capabilities: AXPInAppInboxCapabilities;
+    loadInbox(query?: AXPInAppInboxLoadQuery): Promise<AXPInAppInboxListResult$1>;
+    /** Fetch specific deliveries by id (used for realtime delta sync). */
+    loadByIds?(ids: string[]): Promise<AXPInAppInboxListResult$1>;
+    markSeen(ids: string[]): Promise<void>;
+    markRead(ids: string[]): Promise<void>;
+    markAllRead(): Promise<void>;
+    togglePin?(id: string): Promise<void>;
+    archive?(ids: string[]): Promise<void>;
+    deleteDeliveries?(ids: string[]): Promise<void>;
+}
+declare const AXP_IN_APP_INBOX_PORT: InjectionToken<AXPInAppInboxPort>;
+
+declare const AXP_IN_APP_INBOX_CONFIG: InjectionToken<AXPInAppInboxConfig>;
+declare const AXP_IN_APP_INBOX_I18N: InjectionToken<AXPInAppInboxI18nKeys>;
+
+interface AXPInAppInboxSyncStatus {
+    /** True when Socket.IO live updates are connected. */
+    liveUpdatesConnected: Signal<boolean>;
+}
+declare const AXP_IN_APP_INBOX_SYNC_STATUS: InjectionToken<AXPInAppInboxSyncStatus>;
+
+declare class AXPInAppInboxRealtimeService {
+    private readonly changedSubject;
+    readonly changed$: rxjs.Observable<AXPInAppInboxChangeEvent>;
+    notifyChanged(event: AXPInAppInboxChangeEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPInAppInboxRealtimeService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXPInAppInboxRealtimeService>;
+}
+
+/** Local-entity engine key for the active in-app inbox hot subset. */
+declare const AXP_IN_APP_INBOX_LOCAL_ENTITY_KEY = "CommunicationManagement.InAppInbox";
+/** Max active deliveries kept in the local hot subset. */
+declare const AXP_IN_APP_INBOX_LOCAL_MAX_ITEMS = 100;
+/** Legacy IndexedDB name from the inbox-only store (deleted on migrate). */
+declare const AXP_IN_APP_INBOX_LEGACY_DB_NAME = "ACoreXInAppInbox";
+
+declare function isArchiveCategoryFilter(filters: AXPFilterQuery[] | undefined): boolean;
+/**
+ * Filters and sorts active inbox items in memory (search, unread, priority).
+ * Archive is never applied here — callers must use the API for archived rows.
+ */
+declare function filterInAppInboxItemsLocally(items: AXPInAppInboxItem[], filters: AXPFilterQuery[] | undefined): AXPInAppInboxItem[];
+
+type AXPInAppInboxListResult = Awaited<ReturnType<AXPInAppInboxPort['loadInbox']>>;
+/**
+ * Single source of truth for active in-app inbox UI.
+ * Active items live in the shared local-entity engine (max 100) and sync via realtime / reconnect.
+ * Archived views always load from the API.
+ */
+declare class AXPInAppInboxConnectorService {
+    private readonly port;
+    private readonly realtime;
+    private readonly engine;
+    private readonly localBridge;
+    private readonly sessionService;
+    private readonly destroyRef;
+    private readonly entityKey;
+    private readonly localItems;
+    private readonly isLoading;
+    private readonly pageLoading;
+    private readonly error;
+    private readonly archivePageItems;
+    private readonly archiveTotalCount;
+    private readonly pageQuery;
+    private pendingRealtimeRefresh;
+    private bootstrapPromise;
+    private syncInFlight;
+    private boundUserKey;
+    private legacyDbCleanupDone;
+    readonly capabilities: _acorex_platform_module_communication_management_client.AXPInAppInboxCapabilities;
+    readonly loading: _angular_core.Signal<boolean>;
+    readonly pageLoadingState: _angular_core.Signal<boolean>;
+    readonly errorMessage: _angular_core.Signal<string | null>;
+    readonly inboxList: _angular_core.Signal<AXPInAppInboxItem[]>;
+    readonly total: _angular_core.Signal<number>;
+    readonly pagedInboxList: _angular_core.Signal<AXPInAppInboxItem[]>;
+    readonly pagedTotal: _angular_core.Signal<number>;
+    readonly unreadCount: _angular_core.Signal<number>;
+    constructor();
+    /** Hydrate from IndexedDB then sync active inbox from the server (idempotent). */
+    ensureReady(): Promise<void>;
+    refresh(): Promise<AXPInAppInboxListResult>;
+    loadPage(filtersOrSkip: AXPFilterQuery[] | number, skipOrTake?: number, takeArg?: number): Promise<AXPPagedListResult<AXPInAppInboxItem>>;
+    markUnseenAsSeen(): Promise<void>;
+    markAsRead(ids: string[]): Promise<void>;
+    markAllAsRead(): Promise<void>;
+    togglePin(id: string): Promise<void>;
+    archive(ids: string[]): Promise<void>;
+    deleteOne(id: string): Promise<void>;
+    private bootstrap;
+    private syncActiveFromServer;
+    private syncActiveFromServerInternal;
+    private fetchActiveHot;
+    private fetchActiveByIds;
+    private loadArchivePage;
+    private handleRealtimeEvent;
+    private canLoadInbox;
+    private clearInboxState;
+    private readLocalItems;
+    private toPayload;
+    private deleteLegacyInboxDb;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPInAppInboxConnectorService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXPInAppInboxConnectorService>;
+}
+
+declare class AXPInAppInboxItemComponent {
+    data: _angular_core.InputSignal<AXPInAppInboxItem>;
+    showAvatar: _angular_core.InputSignal<boolean>;
+    showDate: _angular_core.InputSignal<boolean>;
+    showPin: _angular_core.InputSignal<boolean>;
+    pinLabelKey: _angular_core.InputSignal<string>;
+    unpinLabelKey: _angular_core.InputSignal<string>;
+    /** When true, unread rows get a subtle background (use on mixed read/unread lists only). */
+    highlightUnreadBackground: _angular_core.InputSignal<boolean>;
+    showDismissUnread: _angular_core.InputSignal<boolean>;
+    markAsReadLabelKey: _angular_core.InputSignal<string>;
+    protected readonly priorityClass: _angular_core.Signal<string>;
+    protected readonly isUnread: _angular_core.Signal<boolean>;
+    protected readonly primaryAction: _angular_core.Signal<{
+        title: string;
+        command: {
+            name: string;
+            options?: Record<string, unknown>;
+        };
+    } | undefined>;
+    protected readonly hasDefaultAction: _angular_core.Signal<boolean>;
+    protected readonly headline: _angular_core.Signal<string>;
+    protected readonly itemIconClass: _angular_core.Signal<string | undefined>;
+    protected readonly showItemLeading: _angular_core.Signal<boolean>;
+    protected readonly showItemIcon: _angular_core.Signal<boolean>;
+    protected readonly showItemAvatar: _angular_core.Signal<boolean>;
+    itemPress: _angular_core.OutputEmitterRef<string>;
+    markAsRead: _angular_core.OutputEmitterRef<string>;
+    togglePin: _angular_core.OutputEmitterRef<string>;
+    closePopover: _angular_core.OutputEmitterRef<void>;
+    protected isI18nKey(value: string): boolean;
+    protected onPress(id: string): void;
+    protected onTogglePin(event: Event): void;
+    protected onDismissMarkAsRead(event: Event): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPInAppInboxItemComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXPInAppInboxItemComponent, "axp-in-app-inbox-item", never, { "data": { "alias": "data"; "required": true; "isSignal": true; }; "showAvatar": { "alias": "showAvatar"; "required": false; "isSignal": true; }; "showDate": { "alias": "showDate"; "required": false; "isSignal": true; }; "showPin": { "alias": "showPin"; "required": false; "isSignal": true; }; "pinLabelKey": { "alias": "pinLabelKey"; "required": false; "isSignal": true; }; "unpinLabelKey": { "alias": "unpinLabelKey"; "required": false; "isSignal": true; }; "highlightUnreadBackground": { "alias": "highlightUnreadBackground"; "required": false; "isSignal": true; }; "showDismissUnread": { "alias": "showDismissUnread"; "required": false; "isSignal": true; }; "markAsReadLabelKey": { "alias": "markAsReadLabelKey"; "required": false; "isSignal": true; }; }, { "itemPress": "itemPress"; "markAsRead": "markAsRead"; "togglePin": "togglePin"; "closePopover": "closePopover"; }, never, never, true, never>;
+}
+
+interface InboxTabData {
+    key: AXPInAppInboxTabKey;
+    labelKey: string;
+    count: number;
+}
+declare class AXPInAppInboxPanelComponent implements OnInit {
+    unreadCountChange: _angular_core.OutputEmitterRef<number>;
+    closePopover: _angular_core.OutputEmitterRef<void>;
+    private readonly connector;
+    private readonly inboxActions;
+    private readonly toastService;
+    private readonly router;
+    private readonly sessionService;
+    protected readonly i18n: _acorex_platform_module_communication_management_client.AXPInAppInboxI18nKeys;
+    protected readonly config: _acorex_platform_module_communication_management_client.AXPInAppInboxConfig;
+    protected readonly items: _angular_core.Signal<AXPInAppInboxItem[]>;
+    protected readonly isLoading: _angular_core.Signal<boolean>;
+    protected activeTab: _angular_core.WritableSignal<AXPInAppInboxTabKey>;
+    protected readonly tabItems: _angular_core.Signal<InboxTabData[]>;
+    protected readonly showPin: _angular_core.Signal<boolean>;
+    constructor();
+    ngOnInit(): Promise<void>;
+    protected changeActiveTab(tab: AXPInAppInboxTabKey): void;
+    protected getItems(tab: AXPInAppInboxTabKey): AXPInAppInboxItem[];
+    protected openInboxItem(id: string): Promise<void>;
+    protected dismissUnread(id: string): Promise<void>;
+    protected togglePin(id: string): Promise<void>;
+    protected markAllAsRead(): Promise<void>;
+    protected viewAll(): void;
+    protected openSettings(): void;
+    private buildTabItems;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPInAppInboxPanelComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXPInAppInboxPanelComponent, "axp-in-app-inbox-panel", never, {}, { "unreadCountChange": "unreadCountChange"; "closePopover": "closePopover"; }, never, never, true, never>;
+}
+
+declare class AXPInAppInboxSlotComponent {
+    protected readonly config: _acorex_platform_module_communication_management_client.AXPInAppInboxConfig;
+    protected readonly i18n: _acorex_platform_module_communication_management_client.AXPInAppInboxI18nKeys;
+    private readonly connector;
+    private readonly syncStatus;
+    protected liveUpdatesOffline: _angular_core.Signal<boolean>;
+    protected badgeDisplay: _angular_core.Signal<string>;
+    private popover;
+    protected closePopover(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPInAppInboxSlotComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXPInAppInboxSlotComponent, "axp-in-app-inbox-slot", never, {}, {}, never, never, true, never>;
+}
+
+declare function resolveCommunicationDeliveryChannelsSettingsSection(context: AXPSettingDefinitionProviderContext): _acorex_platform_framework_client_common.AXPSettingDefinitionSectionBuilder | null;
+
+declare class AXMCommunicationManagementMenuProvider implements AXPMenuProvider {
+    private readonly entityService;
+    provide(context: AXPMenuProviderContext): Promise<void>;
+}
+
+declare class AXMCommunicationManagementSearchCommandProvider extends AXPSearchCommandProvider {
+    commands: AXPSearchResult[];
+}
+
+/**
+ * Registers communication capabilities into the shared Collaboration group.
+ */
+declare class AXMCommunicationManagementPermissionDefinitionProvider implements AXPPermissionDefinitionProvider {
+    define(context: AXPPermissionDefinitionProviderContext): Promise<void>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMCommunicationManagementPermissionDefinitionProvider, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMCommunicationManagementPermissionDefinitionProvider>;
+}
+
+export { AXMCommunicationManagementMenuProvider, AXMCommunicationManagementModule, AXMCommunicationManagementPermissionDefinitionProvider, AXMCommunicationManagementSearchCommandProvider, AXPCommunicationInAppInboxWidgetViewComponent, AXPCommunicationManagementClient, AXPInAppInboxConnectorService, AXPInAppInboxItemComponent, AXPInAppInboxPanelComponent, AXPInAppInboxRealtimeService, AXPInAppInboxSlotComponent, AXPMyInAppInboxDashboardWidget, AXP_IN_APP_INBOX_CONFIG, AXP_IN_APP_INBOX_I18N, AXP_IN_APP_INBOX_LEGACY_DB_NAME, AXP_IN_APP_INBOX_LOCAL_ENTITY_KEY, AXP_IN_APP_INBOX_LOCAL_MAX_ITEMS, AXP_IN_APP_INBOX_PORT, AXP_IN_APP_INBOX_SYNC_STATUS, AXP_MY_IN_APP_INBOX_DASHBOARD_DIMENSIONS, buildMyInAppInboxDashboardWidget, filterInAppInboxItemsLocally, getInAppInboxPriorityClass, isArchiveCategoryFilter, isInAppInboxUnread, isInAppInboxUnseen, normalizeInAppInboxItem, resolveCommunicationDeliveryChannelsSettingsSection, sortInAppInboxItems };
+export type { AXPInAppInboxCapabilities, AXPInAppInboxChangeEvent, AXPInAppInboxConfig, AXPInAppInboxI18nKeys, AXPInAppInboxItem, AXPInAppInboxListResult$1 as AXPInAppInboxListResult, AXPInAppInboxLoadQuery, AXPInAppInboxPort, AXPInAppInboxPriority, AXPInAppInboxSyncStatus, AXPInAppInboxTabKey };