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

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

@@ -0,0 +1,330 @@
+type CommunicationAggregateStatus = 'Pending' | 'Processing' | 'Completed' | 'Failed' | 'Cancelled';
+type CommunicationDeliveryStatus = 'Pending' | 'Queued' | 'Processing' | 'Accepted' | 'Sent' | 'Delivered' | 'Failed' | 'RetryScheduled' | 'Cancelled' | 'DeadLettered';
+interface CommunicationMessage {
+    subject: string;
+    body: string;
+}
+interface CommunicationNotificationAction {
+    title: string;
+    command: {
+        name: string;
+        options?: Record<string, unknown>;
+    };
+}
+type CommunicationPriority = 'Notice' | 'Danger' | 'Warning';
+interface AXMCommunicationModel {
+    id: string;
+    title: string;
+    message?: CommunicationMessage;
+    definitionKey?: string;
+    correlationId?: string;
+    idempotencyKey?: string;
+    actions?: CommunicationNotificationAction[];
+    status: CommunicationAggregateStatus;
+    primaryChannel?: string;
+    recipientSummary?: string;
+    priority?: CommunicationPriority;
+}
+interface AXMCommunicationDeliveryModel {
+    id: string;
+    communicationId: string;
+    channel: string;
+    providerKey?: string;
+    status: CommunicationDeliveryStatus;
+    recipientUserId?: string;
+    recipientAddress?: string;
+    /** Provider-assigned message id (SMTP Message-ID, Telegram message_id, WhatsApp wamid, etc.). */
+    providerMessageId?: string | null;
+    sentAt?: Date | null;
+    deliveredAt?: Date | null;
+    seenAt?: Date | null;
+    readAt?: Date | null;
+    repliedAt?: Date | null;
+    isPinned?: boolean;
+    archivedAt?: Date | null;
+    timelineSummary?: string;
+}
+interface CommunicationSendInput {
+    title: string;
+    message: CommunicationMessage;
+    channel: string;
+    recipientUserId?: string;
+    recipientAddress?: string;
+    /** Human-readable recipient label (e.g. employee full name) for summaries and job titles. */
+    recipientName?: string;
+    /**
+     * Tenant scope for system/unauthenticated sends (e.g. public password-reset).
+     * When omitted, channel adapters use the authenticated session tenant.
+     */
+    tenantId?: string;
+    definitionKey?: string;
+    correlationId?: string;
+    idempotencyKey?: string;
+    priority?: CommunicationPriority;
+    actions?: CommunicationNotificationAction[];
+}
+interface CommunicationSendResult {
+    communicationId: string;
+    deliveryId: string;
+    status: CommunicationDeliveryStatus;
+}
+interface CommunicationDeliverPayload {
+    deliveryId: string;
+    communicationId: string;
+    tenantId: string;
+}
+interface CommunicationDeliverResult {
+    deliveryId: string;
+    status: CommunicationDeliveryStatus;
+    messageId?: string;
+}
+interface CommunicationSmtpTestInput {
+    recipientAddress: string;
+}
+interface CommunicationSmtpTestResult {
+    recipientAddress: string;
+    messageId?: string;
+}
+
+interface CommunicationChannelCapabilities {
+    deliveryConfirmation: boolean;
+    deliveryReceipt: boolean;
+    seenTracking: boolean;
+    readReceipt: boolean;
+    replyTracking: boolean;
+    webhookCallbacks: boolean;
+}
+interface CommunicationChannelDefinition {
+    key: string;
+    title: string;
+    builtIn: boolean;
+    capabilities: CommunicationChannelCapabilities;
+}
+declare const COMMUNICATION_BUILTIN_CHANNEL_KEYS: readonly ["in-app", "email-smtp"];
+type CommunicationBuiltinChannelKey = (typeof COMMUNICATION_BUILTIN_CHANNEL_KEYS)[number];
+declare const BUILTIN_CHANNEL_DEFINITIONS: readonly CommunicationChannelDefinition[];
+
+interface CommunicationChannelAdapterContext {
+    communicationId: string;
+    deliveryId: string;
+    input: CommunicationSendInput;
+    channel: CommunicationChannelDefinition;
+    now: Date;
+}
+interface CommunicationChannelDeliverResult {
+    status: CommunicationDeliveryStatus;
+    sentAt?: Date | null;
+    deliveredAt?: Date | null;
+    timelineLines: string[];
+    communicationStatus: CommunicationAggregateStatus;
+}
+interface CommunicationChannelAdapter {
+    readonly channelKey: string;
+    deliver(context: CommunicationChannelAdapterContext): Promise<CommunicationChannelDeliverResult>;
+}
+
+declare const COMMUNICATION_CHANNEL_ADAPTER: unique symbol;
+declare const COMMUNICATION_DELIVERY_EXECUTOR: unique symbol;
+interface CommunicationDeliveryExecutor {
+    readonly channelKey: string;
+    execute(payload: CommunicationDeliverPayload): Promise<CommunicationDeliverResult>;
+}
+declare const COMMUNICATION_CHANNEL_SEND_VALIDATOR: unique symbol;
+interface CommunicationChannelSendValidator {
+    readonly channelKey: string;
+    validate(input: CommunicationSendInput): void;
+}
+
+declare function listCommunicationChannels(): CommunicationChannelDefinition[];
+declare function getCommunicationChannel(key: string): CommunicationChannelDefinition | undefined;
+declare function registerCommunicationChannel(definition: CommunicationChannelDefinition): void;
+declare function isBuiltInCommunicationChannel(key: string): boolean;
+
+declare const COMMUNICATION_DEBUG_REDIRECT_RESOLVER: unique symbol;
+interface CommunicationDebugRedirectResolver {
+    readonly channelKey: string;
+    resolveOverride(tenantId: string): Promise<string | null>;
+}
+interface CommunicationDebugRedirectResult {
+    effectiveRecipient: string | null;
+    redirected: boolean;
+    skipped: boolean;
+    timelineNote?: string;
+}
+
+declare const COMMUNICATION_MANAGEMENT_EMAIL_SHOW_DIALOG_COMMAND_KEY: "CommunicationManagement:Email:ShowDialog";
+declare const COMMUNICATION_MANAGEMENT_EMAIL_SEND_COMMAND_KEY: "CommunicationManagement:Email:Send";
+
+/** Opens the send-email layout dialog (optional text template pre-render). */
+interface CommunicationManagementEmailShowDialogInput {
+    dialogTitle?: string;
+    to?: string;
+    cc?: string;
+    bcc?: string;
+    subject?: string;
+    body?: string;
+    textTemplateId?: string;
+    merge?: Record<string, string>;
+}
+interface CommunicationManagementEmailSendInput {
+    to: string;
+    cc?: string;
+    bcc?: string;
+    subject: string;
+    body: string;
+    textTemplateId?: string;
+}
+interface CommunicationManagementEmailSendResult {
+    communicationId: string;
+    deliveryId: string;
+}
+
+declare const AXMCommunicationManagementCommandKeys: {
+    readonly Send: "CommunicationManagement:Communication:Send";
+    readonly TestSmtp: "CommunicationManagement:Communication:TestSmtp";
+    readonly EmailShowDialog: "CommunicationManagement:Email:ShowDialog";
+    readonly EmailSend: "CommunicationManagement:Email:Send";
+    readonly ShowSentMessage: "CommunicationManagement:Communication:ShowSentMessage";
+};
+
+declare function resolveCommunicationMessage(communication: Record<string, unknown>, fallbackTitle?: string): CommunicationMessage;
+
+type CommunicationRecipientLabelInput = Pick<CommunicationSendInput, 'recipientName' | 'recipientAddress' | 'recipientUserId'>;
+declare function resolveCommunicationRecipientLabel(input: CommunicationRecipientLabelInput): string;
+declare function formatCommunicationDeliveryJobTitle(channelLabel: string, input: CommunicationRecipientLabelInput): string;
+
+interface CommunicationDeliveryEngagementRequest {
+    deliveryIds: string[];
+}
+interface CommunicationDeliveryEngagementResult {
+    updatedIds: string[];
+}
+interface CommunicationDeliveryMutationResult {
+    affectedIds: string[];
+}
+
+declare const AXMCommunicationManagementMenuKeys: {
+    readonly Root: "CommunicationManagement:Menu:Root";
+    readonly Communications: "CommunicationManagement:Menu:Communications";
+};
+
+/**
+ * Collaboration capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPCollaborationPermissionKeys: {
+    readonly Access: "Collaboration:Permission:Access";
+    readonly MaintainConversations: "Collaboration:Permission:MaintainConversations";
+    readonly MaintainMeetings: "Collaboration:Permission:MaintainMeetings";
+    readonly MaintainCalendars: "Collaboration:Permission:MaintainCalendars";
+    readonly MaintainCommunications: "Collaboration:Permission:MaintainCommunications";
+    readonly MaintainReservations: "Collaboration:Permission:MaintainReservations";
+    readonly MaintainHelpDesk: "Collaboration:Permission:MaintainHelpDesk";
+    readonly Setup: "Collaboration:Permission:Setup";
+};
+/**
+ * @deprecated Prefer {@link AXPCollaborationPermissionKeys}.
+ * Legacy flat shape kept so existing imports compile during migration.
+ */
+declare const AXMCommunicationManagementPermissionKeys: {
+    readonly Management: "Collaboration:Permission:MaintainCommunications";
+    readonly Send: "Collaboration:Permission:MaintainCommunications";
+    readonly Email: {
+        readonly ShowDialog: "Collaboration:Permission:MaintainCommunications";
+        readonly Send: "Collaboration:Permission:MaintainCommunications";
+    };
+};
+
+declare const RootConfig: {
+    readonly config: {
+        i18n: string;
+    };
+    readonly module: {
+        readonly name: "CommunicationManagement";
+        readonly title: "@communication-management:module.title";
+        readonly icon: "fa-light fa-paper-plane";
+    };
+    readonly entities: {
+        readonly communication: {
+            readonly name: "Communications";
+            readonly title: "@communication-management:entities.communication.title";
+            readonly titlePlural: "@communication-management:entities.communication.plural";
+            readonly icon: "fa-light fa-envelope";
+        };
+        readonly communicationDelivery: {
+            readonly name: "CommunicationDeliveries";
+            readonly title: "@communication-management:entities.communication-delivery.title";
+            readonly titlePlural: "@communication-management:entities.communication-delivery.plural";
+            readonly icon: "fa-light fa-truck-fast";
+        };
+    };
+    readonly widgets: {
+        readonly myInAppInboxDashboard: string;
+    };
+    readonly queries: {
+        readonly dashboard: {
+            readonly deliveryStatusDonut: "CommunicationManagement:Dashboard:DeliveryStatusDonut";
+        };
+    };
+};
+declare const COMMUNICATION_ENTITY_NAME: string;
+declare const COMMUNICATION_DELIVERY_ENTITY_NAME: string;
+
+declare const AXMCommunicationManagementServerCommands: {
+    readonly Send: "CommunicationManagement:Server:Send";
+    readonly Deliver: "CommunicationManagement:Server:Deliver";
+    readonly InApp: {
+        readonly MarkSeen: "CommunicationManagement:InApp:MarkSeen";
+        readonly MarkRead: "CommunicationManagement:InApp:MarkRead";
+        readonly MarkAllRead: "CommunicationManagement:InApp:MarkAllRead";
+        readonly TogglePin: "CommunicationManagement:InApp:TogglePin";
+        readonly Archive: "CommunicationManagement:InApp:Archive";
+        readonly Delete: "CommunicationManagement:InApp:Delete";
+    };
+    readonly Smtp: {
+        readonly Test: "CommunicationManagement:Smtp:Test";
+    };
+};
+
+/** Settings group slug → `/:app/settings/user/communication-notifications` */
+declare const AXP_COMMUNICATION_USER_NOTIFICATIONS_SETTINGS_GROUP = "communication-notifications";
+/** Section within {@link AXP_COMMUNICATION_USER_NOTIFICATIONS_SETTINGS_GROUP}. */
+declare const AXP_COMMUNICATION_DELIVERY_CHANNELS_SETTINGS_SECTION = "delivery-channels";
+
+declare enum AXPCommunicationManagementSettingKeys {
+    EmailServer = "CommunicationManagement:Setting:Email.Server",
+    EmailPort = "CommunicationManagement:Setting:Email.Port",
+    EmailUsername = "CommunicationManagement:Setting:Email.Username",
+    EmailPassword = "CommunicationManagement:Setting:Email.Password",
+    EmailFromAddress = "CommunicationManagement:Setting:Email.FromAddress",
+    EmailUseSsl = "CommunicationManagement:Setting:Email.UseSSL",
+    EmailUseTls = "CommunicationManagement:Setting:Email.UseTLS",
+    DebugRedirectEmailAddress = "CommunicationManagement:Setting:Debug.Redirect.EmailAddress",
+    UserChannelInAppEnabled = "CommunicationManagement:Setting:User.Channel.InApp.Enabled",
+    UserChannelEmailEnabled = "CommunicationManagement:Setting:User.Channel.Email.Enabled"
+}
+declare const AXP_COMMUNICATION_USER_NOTIFICATION_DEFAULTS: Record<string, unknown>;
+declare const AXP_COMMUNICATION_SMTP_SETTING_DEFAULTS: Record<string, unknown>;
+interface CommunicationSmtpSettings {
+    server: string;
+    port: number;
+    username: string;
+    password: string;
+    fromAddress: string;
+    useSsl: boolean;
+    useTls: boolean;
+}
+
+/** Registered client status provider key for logical communications. */
+declare const AXP_COMMUNICATION_STATUS_DEFINITION_KEY = "communication-management.status.communication";
+/** Registered client status provider key for communication deliveries. */
+declare const AXP_COMMUNICATION_DELIVERY_STATUS_DEFINITION_KEY = "communication-management.status.communication-delivery";
+declare const AXP_COMMUNICATION_STATUS_PENDING: "Pending";
+declare const AXP_COMMUNICATION_STATUS_PROCESSING: "Processing";
+declare const AXP_COMMUNICATION_STATUS_COMPLETED: "Completed";
+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 };