@acorex-platform/module-communication-management-client 0.0.37 → 0.0.46

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

@@ -1,3 +1,6 @@
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+import { AXPModuleManifest } from '@acorex-platform/framework-shared/core';
+
 type CommunicationAggregateStatus = 'Pending' | 'Processing' | 'Completed' | 'Failed' | 'Cancelled';
 type CommunicationDeliveryStatus = 'Pending' | 'Queued' | 'Processing' | 'Accepted' | 'Sent' | 'Delivered' | 'Failed' | 'RetryScheduled' | 'Cancelled' | 'DeadLettered';
 interface CommunicationMessage {
@@ -57,6 +60,12 @@ interface CommunicationSendInput {
      * When omitted, channel adapters use the authenticated session tenant.
      */
     tenantId?: string;
+    /**
+     * When true, Communication/Delivery are inserted with empty `scopeInfo` (no tenant).
+     * With `catalog-read`, those rows are visible in any tenant session; inbox UI still
+     * filters by `recipientUserId`.
+     */
+    unscoped?: boolean;
     definitionKey?: string;
     correlationId?: string;
     idempotencyKey?: string;
@@ -208,9 +217,31 @@ interface CommunicationDeliveryMutationResult {
     affectedIds: string[];
 }
 
+type AXMEntityChangeNotifyOp = 'update';
+interface AXMEntityChangeNotifyRelated {
+    /** Related entity name (`PersonCore.Person`). */
+    entity: string;
+    /** FK on the primary entity that points at the related row (`personId`). */
+    via: string;
+}
+interface AXMEntityChangeNotifyPolicyEntityModel extends AXPEntityModel<string> {
+    name: string;
+    title?: string;
+    enabled: boolean;
+    entityName: string;
+    related?: AXMEntityChangeNotifyRelated[];
+    debounceSeconds?: number;
+    templateId?: string;
+    recipientRoleNames?: string[];
+    includeFields?: string[];
+    excludeFields?: string[];
+    channels?: string[];
+}
+
 declare const AXMCommunicationManagementMenuKeys: {
     readonly Root: "CommunicationManagement:Menu:Root";
     readonly Communications: "CommunicationManagement:Menu:Communications";
+    readonly EntityChangeNotifyPolicies: "CommunicationManagement:Menu:EntityChangeNotifyPolicies";
 };
 
 /**
@@ -262,6 +293,12 @@ declare const RootConfig: {
             readonly titlePlural: "@communication-management:entities.communication-delivery.plural";
             readonly icon: "fa-light fa-truck-fast";
         };
+        readonly entityChangeNotifyPolicy: {
+            readonly name: "EntityChangeNotifyPolicy";
+            readonly title: "@communication-management:entities.entity-change-notify-policy.title";
+            readonly titlePlural: "@communication-management:entities.entity-change-notify-policy.plural";
+            readonly icon: "fa-light fa-bell-on";
+        };
     };
     readonly widgets: {
         readonly myInAppInboxDashboard: string;
@@ -274,10 +311,18 @@ declare const RootConfig: {
 };
 declare const COMMUNICATION_ENTITY_NAME: string;
 declare const COMMUNICATION_DELIVERY_ENTITY_NAME: string;
+declare const ENTITY_CHANGE_NOTIFY_POLICY_ENTITY_NAME: string;
+declare const ENTITY_CHANGE_NOTIFY_JOB_PROVIDER_KEY = "communication-management";
+declare const DEFAULT_ENTITY_CHANGE_NOTIFY_DEBOUNCE_SECONDS = 60;
+/** Namespace for {@link tenantMasterId} when cloning notify policies per tenant. */
+declare const ENTITY_CHANGE_NOTIFY_POLICY_TENANT_MASTER_NAMESPACE: "communication";
+
+declare const CommunicationManagementManifest: AXPModuleManifest;
 
 declare const AXMCommunicationManagementServerCommands: {
     readonly Send: "CommunicationManagement:Server:Send";
     readonly Deliver: "CommunicationManagement:Server:Deliver";
+    readonly EntityChangeNotifyRun: "CommunicationManagement:EntityChangeNotify:Run";
     readonly InApp: {
         readonly MarkSeen: "CommunicationManagement:InApp:MarkSeen";
         readonly MarkRead: "CommunicationManagement:InApp:MarkRead";
@@ -290,6 +335,7 @@ declare const AXMCommunicationManagementServerCommands: {
         readonly Test: "CommunicationManagement:Smtp:Test";
     };
 };
+declare const AXM_ENTITY_CHANGE_NOTIFY_RUN_COMMAND_KEY: "CommunicationManagement:EntityChangeNotify:Run";
 
 /** Settings group slug → `/:app/settings/user/communication-notifications` */
 declare const AXP_COMMUNICATION_USER_NOTIFICATIONS_SETTINGS_GROUP = "communication-notifications";
@@ -331,5 +377,5 @@ declare const AXP_COMMUNICATION_STATUS_FAILED: "Failed";
 declare const AXP_COMMUNICATION_DELIVERY_STATUS_PENDING: "Pending";
 declare const AXP_COMMUNICATION_DELIVERY_STATUS_DELIVERED: "Delivered";
 
-export { AXMCommunicationManagementCommandKeys, AXMCommunicationManagementMenuKeys, AXMCommunicationManagementPermissionKeys, AXMCommunicationManagementServerCommands, AXPCollaborationPermissionKeys, AXPCommunicationManagementSettingKeys, AXP_COMMUNICATION_DELIVERY_CHANNELS_SETTINGS_SECTION, AXP_COMMUNICATION_DELIVERY_STATUS_DEFINITION_KEY, AXP_COMMUNICATION_DELIVERY_STATUS_DELIVERED, AXP_COMMUNICATION_DELIVERY_STATUS_PENDING, AXP_COMMUNICATION_SMTP_SETTING_DEFAULTS, AXP_COMMUNICATION_STATUS_COMPLETED, AXP_COMMUNICATION_STATUS_DEFINITION_KEY, AXP_COMMUNICATION_STATUS_FAILED, AXP_COMMUNICATION_STATUS_PENDING, AXP_COMMUNICATION_STATUS_PROCESSING, AXP_COMMUNICATION_USER_NOTIFICATIONS_SETTINGS_GROUP, AXP_COMMUNICATION_USER_NOTIFICATION_DEFAULTS, BUILTIN_CHANNEL_DEFINITIONS, COMMUNICATION_BUILTIN_CHANNEL_KEYS, COMMUNICATION_CHANNEL_ADAPTER, COMMUNICATION_CHANNEL_SEND_VALIDATOR, COMMUNICATION_DEBUG_REDIRECT_RESOLVER, COMMUNICATION_DELIVERY_ENTITY_NAME, COMMUNICATION_DELIVERY_EXECUTOR, COMMUNICATION_ENTITY_NAME, COMMUNICATION_MANAGEMENT_EMAIL_SEND_COMMAND_KEY, COMMUNICATION_MANAGEMENT_EMAIL_SHOW_DIALOG_COMMAND_KEY, RootConfig, formatCommunicationDeliveryJobTitle, getCommunicationChannel, isBuiltInCommunicationChannel, listCommunicationChannels, registerCommunicationChannel, resolveCommunicationMessage, resolveCommunicationRecipientLabel };
-export type { AXMCommunicationDeliveryModel, AXMCommunicationModel, CommunicationAggregateStatus, CommunicationBuiltinChannelKey, CommunicationChannelAdapter, CommunicationChannelAdapterContext, CommunicationChannelCapabilities, CommunicationChannelDefinition, CommunicationChannelDeliverResult, CommunicationChannelSendValidator, CommunicationDebugRedirectResolver, CommunicationDebugRedirectResult, CommunicationDeliverPayload, CommunicationDeliverResult, CommunicationDeliveryEngagementRequest, CommunicationDeliveryEngagementResult, CommunicationDeliveryExecutor, CommunicationDeliveryMutationResult, CommunicationDeliveryStatus, CommunicationManagementEmailSendInput, CommunicationManagementEmailSendResult, CommunicationManagementEmailShowDialogInput, CommunicationMessage, CommunicationNotificationAction, CommunicationPriority, CommunicationRecipientLabelInput, CommunicationSendInput, CommunicationSendResult, CommunicationSmtpSettings, CommunicationSmtpTestInput, CommunicationSmtpTestResult };
+export { AXMCommunicationManagementCommandKeys, AXMCommunicationManagementMenuKeys, AXMCommunicationManagementPermissionKeys, AXMCommunicationManagementServerCommands, AXM_ENTITY_CHANGE_NOTIFY_RUN_COMMAND_KEY, AXPCollaborationPermissionKeys, AXPCommunicationManagementSettingKeys, AXP_COMMUNICATION_DELIVERY_CHANNELS_SETTINGS_SECTION, AXP_COMMUNICATION_DELIVERY_STATUS_DEFINITION_KEY, AXP_COMMUNICATION_DELIVERY_STATUS_DELIVERED, AXP_COMMUNICATION_DELIVERY_STATUS_PENDING, AXP_COMMUNICATION_SMTP_SETTING_DEFAULTS, AXP_COMMUNICATION_STATUS_COMPLETED, AXP_COMMUNICATION_STATUS_DEFINITION_KEY, AXP_COMMUNICATION_STATUS_FAILED, AXP_COMMUNICATION_STATUS_PENDING, AXP_COMMUNICATION_STATUS_PROCESSING, AXP_COMMUNICATION_USER_NOTIFICATIONS_SETTINGS_GROUP, AXP_COMMUNICATION_USER_NOTIFICATION_DEFAULTS, BUILTIN_CHANNEL_DEFINITIONS, COMMUNICATION_BUILTIN_CHANNEL_KEYS, COMMUNICATION_CHANNEL_ADAPTER, COMMUNICATION_CHANNEL_SEND_VALIDATOR, COMMUNICATION_DEBUG_REDIRECT_RESOLVER, COMMUNICATION_DELIVERY_ENTITY_NAME, COMMUNICATION_DELIVERY_EXECUTOR, COMMUNICATION_ENTITY_NAME, COMMUNICATION_MANAGEMENT_EMAIL_SEND_COMMAND_KEY, COMMUNICATION_MANAGEMENT_EMAIL_SHOW_DIALOG_COMMAND_KEY, CommunicationManagementManifest, DEFAULT_ENTITY_CHANGE_NOTIFY_DEBOUNCE_SECONDS, ENTITY_CHANGE_NOTIFY_JOB_PROVIDER_KEY, ENTITY_CHANGE_NOTIFY_POLICY_ENTITY_NAME, ENTITY_CHANGE_NOTIFY_POLICY_TENANT_MASTER_NAMESPACE, RootConfig, formatCommunicationDeliveryJobTitle, getCommunicationChannel, isBuiltInCommunicationChannel, listCommunicationChannels, registerCommunicationChannel, resolveCommunicationMessage, resolveCommunicationRecipientLabel };
+export type { AXMCommunicationDeliveryModel, AXMCommunicationModel, AXMEntityChangeNotifyOp, AXMEntityChangeNotifyPolicyEntityModel, AXMEntityChangeNotifyRelated, CommunicationAggregateStatus, CommunicationBuiltinChannelKey, CommunicationChannelAdapter, CommunicationChannelAdapterContext, CommunicationChannelCapabilities, CommunicationChannelDefinition, CommunicationChannelDeliverResult, CommunicationChannelSendValidator, CommunicationDebugRedirectResolver, CommunicationDebugRedirectResult, CommunicationDeliverPayload, CommunicationDeliverResult, CommunicationDeliveryEngagementRequest, CommunicationDeliveryEngagementResult, CommunicationDeliveryExecutor, CommunicationDeliveryMutationResult, CommunicationDeliveryStatus, CommunicationManagementEmailSendInput, CommunicationManagementEmailSendResult, CommunicationManagementEmailShowDialogInput, CommunicationMessage, CommunicationNotificationAction, CommunicationPriority, CommunicationRecipientLabelInput, CommunicationSendInput, CommunicationSendResult, CommunicationSmtpSettings, CommunicationSmtpTestInput, CommunicationSmtpTestResult };

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

@@ -126,6 +126,7 @@ interface AXPInAppInboxI18nKeys {
     selectItems: string;
     clearFilters: string;
     liveUpdatesOffline: string;
+    pendingSync: string;
 }
 interface AXPInAppInboxConfig {
     headerIconClass: string;
@@ -199,6 +200,7 @@ 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.
+ * Offline writes enqueue on the local-entity outbox and flush over HTTP on reconnect.
  * Archived views always load from the API.
  */
 declare class AXPInAppInboxConnectorService {
@@ -206,6 +208,8 @@ declare class AXPInAppInboxConnectorService {
     private readonly realtime;
     private readonly engine;
     private readonly localBridge;
+    private readonly outbox;
+    private readonly connectivity;
     private readonly sessionService;
     private readonly destroyRef;
     private readonly entityKey;
@@ -266,6 +270,12 @@ declare class AXPInAppInboxConnectorService {
     private fetchActiveByIds;
     private loadArchivePage;
     private handleRealtimeEvent;
+    private canQueueWrites;
+    private commitOrEnqueue;
+    private flushOutboxOp;
+    private revertOutboxOp;
+    private reapplyPendingOutboxOps;
+    private applyOutboxOpLocally;
     private canLoadInbox;
     private clearInboxState;
     private readLocalItems;
@@ -374,6 +384,7 @@ declare class AXPInAppInboxSlotComponent {
         sideMenuWidth: _angular_core.Signal<number>;
         sideMenuCompactWidth: _angular_core.Signal<number>;
         menuVerticalMode: _angular_core.Signal<_acorex_platform_framework_client_themes_shared.AXPMenuVerticalMode>;
+        menuToggleCyclesStyle: _angular_core.Signal<boolean>;
         menuOrientation: _angular_core.Signal<_acorex_platform_framework_client_themes_shared.AXPMenuOrientation>;
         menuAppearance: _angular_core.Signal<_acorex_platform_framework_client_themes_shared.AXPMenuAppearance>;
         headerAppearance: _angular_core.Signal<_acorex_platform_framework_client_themes_shared.AXPHeaderAppearance>;
@@ -387,6 +398,7 @@ declare class AXPInAppInboxSlotComponent {
         overlayTaskCount: _angular_core.Signal<number>;
         isNavigationLoading: _angular_core.Signal<boolean>;
         isMenuHorizontal: _angular_core.Signal<boolean>;
+        menuToggleCyclesStyleEnabled: _angular_core.Signal<boolean>;
         effectiveMenuVerticalMode: _angular_core.Signal<_acorex_platform_framework_client_themes_shared.AXPMenuVerticalMode>;
         sideMenuDrawerWidth: _angular_core.Signal<number>;
         menuDarkEnabled: _angular_core.Signal<boolean>;
@@ -401,6 +413,7 @@ declare class AXPInAppInboxSlotComponent {
         setSideMenuWidth: (width: number) => void;
         setSideMenuCompactWidth: (width: number) => void;
         setSideMenuDrawerWidth: (width: number) => void;
+        setMenuVerticalMode: (mode: _acorex_platform_framework_client_themes_shared.AXPMenuVerticalMode) => void;
         toggleSideMenu: () => void;
         setNavigationLoading: (value: boolean, delay?: number) => void;
         setOverlayLoading: (value: boolean, delay?: number) => void;
@@ -423,6 +436,7 @@ declare class AXPInAppInboxSlotComponent {
         sideMenuWidth: number;
         sideMenuCompactWidth: number;
         menuVerticalMode: _acorex_platform_framework_client_themes_shared.AXPMenuVerticalMode;
+        menuToggleCyclesStyle: boolean;
         menuOrientation: _acorex_platform_framework_client_themes_shared.AXPMenuOrientation;
         menuAppearance: _acorex_platform_framework_client_themes_shared.AXPMenuAppearance;
         headerAppearance: _acorex_platform_framework_client_themes_shared.AXPHeaderAppearance;
@@ -430,8 +444,11 @@ declare class AXPInAppInboxSlotComponent {
         isPrinting: boolean;
     }>;
     private readonly connector;
+    private readonly outbox;
     private readonly syncStatus;
     protected liveUpdatesOffline: _angular_core.Signal<boolean>;
+    protected pendingSync: _angular_core.Signal<boolean>;
+    protected statusTitleKey: _angular_core.Signal<string>;
     protected badgeDisplay: _angular_core.Signal<string>;
     private popover;
     protected closePopover(): void;