@platform-modules/foreign-ministry 1.3.334 → 1.3.336

package/dist/i18n/workflow-chat-message.builder.d.ts

@@ -0,0 +1,316 @@
+export type BilingualText = {
+    en: string;
+    ar: string;
+};
+export type WorkflowChatI18nCatalog = {
+    workflowTemplates: Record<string, BilingualText>;
+    chatTemplates: Record<string, BilingualText>;
+    notificationTemplates?: Record<string, BilingualText>;
+    workflowStatusLabels: Record<string, string>;
+    chatStatusLabels: Record<string, string>;
+};
+/** Master-data fields with English + Arabic columns (roles, departments, sections, users). */
+export type BilingualActorNames = {
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    deptName?: string | null;
+    deptArabicName?: string | null;
+    sectionName?: string | null;
+    sectionArabicName?: string | null;
+    userName?: string | null;
+    userArabicName?: string | null;
+    employeeId?: string | number | null;
+};
+export type WorkflowMessageAction = 'request_submitted' | 'notification_sent_pending' | 'notification_sent_successfully' | 'approval_in_progress' | 'approval_pending' | 'approved' | 'rejected' | 'returned_for_modification' | 'approval_pending_update';
+export type ChatMessageAction = 'cancellation_submitted' | 'request_submitted' | 'request_received' | 'approved' | 'rejected' | 'returned_for_modification';
+export type WorkflowMessageContext = BilingualActorNames & {
+    action: WorkflowMessageAction;
+    /** First human approval step → "in progress"; later steps → "pending". */
+    isFirstApprovalStep?: boolean;
+    comment?: string | null;
+};
+export type ChatMessageContext = BilingualActorNames & {
+    action: ChatMessageAction;
+    comment?: string | null;
+};
+export declare function getWorkflowChatI18nCatalog(): WorkflowChatI18nCatalog;
+/** Arabic DB column preferred; English fallback so AR keeps identical structure to EN. */
+export declare function resolveBilingualName(englishName?: string | null, arabicName?: string | null): string;
+export declare function pickLocalizedName(englishName?: string | null, arabicName?: string | null, fallback?: string): string;
+/** @deprecated Use resolveBilingualName */
+export declare function pickArabicName(arabicName?: string | null): string;
+/** Build parallel EN / AR actor label from role OR dept+section. */
+export declare function resolveActorDisplayNames(actors: BilingualActorNames): {
+    en: string;
+    ar: string;
+};
+/** @deprecated Use resolveActorDisplayNames */
+export declare function joinDeptSectionBilingualLabels(deptEn?: string | null, deptAr?: string | null, sectEn?: string | null, sectAr?: string | null): {
+    en: string;
+    ar: string;
+};
+/** @deprecated Use resolveActorDisplayNames */
+export declare function joinDeptSectionArabicLabels(deptArabic?: string | null, sectionArabic?: string | null): string;
+export declare function formatWorkflowCommentSuffix(comment?: string | null): string;
+export declare function formatChatCommentSuffix(comment?: string | null): string;
+/** Core renderer — always pass explicit EN and AR param objects with the same keys. */
+export declare function renderSynchronizedWorkflowMessage(templateKey: string, enParams: Record<string, string>, arParams: Record<string, string>): BilingualText;
+export declare function renderSynchronizedChatMessage(templateKey: string, enParams: Record<string, string>, arParams: Record<string, string>): BilingualText;
+export declare function buildBilingualFromTemplate(templateCatalog: Record<string, BilingualText>, key: string, params?: Record<string, string>, arParams?: Record<string, string>): BilingualText;
+export declare function workflowTemplate(key: string, params?: Record<string, string>, arParams?: Record<string, string>): BilingualText;
+export declare function chatTemplate(key: string, params?: Record<string, string>, arParams?: Record<string, string>): BilingualText;
+/**
+ * Standard entry point for workflow `content` + `content_ar`.
+ * Use for every workflow log insert/update across all CAA modules.
+ */
+export declare function buildSynchronizedWorkflowMessage(ctx: WorkflowMessageContext): BilingualText;
+/**
+ * Standard entry point for chat `message` + `message_ar`.
+ * Use for every chat insert/update across all CAA modules.
+ */
+export declare function buildSynchronizedChatMessage(ctx: ChatMessageContext): BilingualText;
+/** Standard workflow log UPDATE fields for all CAA module repositories. */
+export declare function buildWorkflowLogUpdateFields(params: {
+    approvalStatus: string;
+    workflowStatus: string;
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    comment?: string | null;
+}): {
+    content: string;
+    content_ar: string;
+    status: string;
+    status_ar: string | null;
+};
+/** Bilingual workflow insert fields from builder output. */
+export declare function toWorkflowPersistFields(bilingual: BilingualText, status: string): {
+    content: string;
+    content_ar: string;
+    status: string;
+    status_ar: string | null;
+};
+/** Bilingual chat insert fields from builder output (message column). */
+export declare function toChatPersistFields(bilingual: BilingualText, status: string): {
+    message: string;
+    message_ar: string;
+    status: string;
+    status_ar: string | null;
+};
+/** Bilingual chat insert fields for models using `content` column (Leave, Financial, etc.). */
+export declare function toContentChatPersistFields(bilingual: BilingualText, status: string): {
+    content: string;
+    content_ar: string;
+    status: string;
+    status_ar: string | null;
+};
+export declare function buildApprovalWorkflowContent(params: {
+    status: 'Approved' | 'Rejected' | 'Returned for Modification' | 'Pending' | string;
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    comment?: string | null;
+}): BilingualText;
+export declare function buildHumanApprovalWorkflowContent(params: {
+    isFirst: boolean;
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    deptName?: string | null;
+    deptArabicName?: string | null;
+    sectionName?: string | null;
+    sectionArabicName?: string | null;
+}): BilingualText;
+export declare function buildApprovalChatMessage(params: {
+    status: 'Approved' | 'Rejected' | 'Returned for Modification' | string;
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    comment?: string | null;
+}): BilingualText;
+export declare function buildClosedChatMessage(params: {
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    comment?: string | null;
+}): BilingualText;
+export declare function buildClosedWorkflowMessage(params: {
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    comment?: string | null;
+}): BilingualText;
+export declare function buildRequestForChangeChatMessage(params: {
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    comment?: string | null;
+    variant?: 'by' | 'requested_by';
+}): BilingualText;
+export declare function buildAttachmentUploadedChatMessage(fileName: string): BilingualText;
+/** User-typed chat text, or bilingual [Attachment] placeholder when empty. */
+export declare function buildUserOrAttachmentChatMessage(userMessage?: string | null): BilingualText;
+export declare function buildTaskInProgressChatMessage(params: {
+    roleName?: string | null;
+    roleArabicName?: string | null;
+}): BilingualText;
+export declare function buildTaskCompletedChatMessage(params: {
+    roleName?: string | null;
+    roleArabicName?: string | null;
+    comment?: string | null;
+}): BilingualText;
+export declare function buildTaskStatusUpdatedChatMessage(status: string, statusAr?: string | null): BilingualText;
+export declare function buildItHelpdeskAssignedChatMessage(params: {
+    level: number;
+    assignedRoleName?: string | null;
+    assignedRoleArabicName?: string | null;
+    assignedUserName?: string | null;
+    assignedUserArabicName?: string | null;
+    comment?: string | null;
+}): BilingualText;
+export declare function buildItHelpdeskReassignedChatMessage(params: {
+    level: number;
+    approverRoleName?: string | null;
+    approverRoleArabicName?: string | null;
+    reassignedRoleName?: string | null;
+    reassignedRoleArabicName?: string | null;
+    comment?: string | null;
+}): BilingualText;
+export declare function buildRequestSubmittedWithRefChatMessage(params: {
+    requestLabel: string;
+    requestLabelAr?: string | null;
+    requestId: number | string;
+    userName?: string | null;
+    userArabicName?: string | null;
+    employeeId?: string | number | null;
+}): BilingualText;
+export declare function buildSecurityAccessApprovalChatMessage(params: {
+    productLabel: string;
+    productLabelAr?: string | null;
+    requestId: number | string;
+    approvalLevel: number | string;
+    decision: 'approve' | 'reject';
+    comment?: string | null;
+}): BilingualText;
+export declare function buildItHelpdeskReassignModifiers(params: {
+    sectionFrom?: number | null;
+    sectionTo?: number | null;
+    departmentFrom?: number | null;
+    departmentTo?: number | null;
+}): {
+    en: string;
+    ar: string;
+};
+export type ItHelpdeskMuscatWorkflowParams = {
+    variant: 'hos_assigned';
+    approverRoleName: string;
+    approverRoleArabicName?: string | null;
+    assignedRoleName: string;
+    assignedRoleArabicName?: string | null;
+    comment?: string | null;
+} | {
+    variant: 'technician_assigned';
+    level: number;
+    approverRoleName: string;
+    approverRoleArabicName?: string | null;
+    comment?: string | null;
+} | {
+    variant: 'reassigned_technician' | 'reassigned_l3' | 'reassigned_generic';
+    approverRoleName: string;
+    approverRoleArabicName?: string | null;
+    level?: number;
+    comment?: string | null;
+    modifiers?: {
+        en: string;
+        ar: string;
+    };
+} | {
+    variant: 'closed_level1' | 'closed_level2';
+    approverRoleName: string;
+    approverRoleArabicName?: string | null;
+    comment?: string | null;
+} | {
+    variant: 'l3_approved' | 'l3_rejected';
+    roleName: string;
+    roleArabicName?: string | null;
+    userName: string;
+    userArabicName?: string | null;
+    comment?: string | null;
+} | {
+    variant: 'level_approved';
+    level: number;
+    approverRoleName: string;
+    approverRoleArabicName?: string | null;
+    comment?: string | null;
+} | {
+    variant: 'rejected' | 'l3_step_rejected';
+    approverRoleName: string;
+    approverRoleArabicName?: string | null;
+    comment?: string | null;
+} | {
+    variant: 'generic_status';
+    approverRoleName: string;
+    approverRoleArabicName?: string | null;
+    status: string;
+    comment?: string | null;
+} | {
+    variant: 'technician_completed' | 'routing_rejected';
+    roleName: string;
+    roleArabicName?: string | null;
+    comment?: string | null;
+} | {
+    variant: 'routing_resolved';
+};
+export declare function buildItHelpdeskMuscatWorkflowLog(params: ItHelpdeskMuscatWorkflowParams): BilingualText;
+export type LogisticsActualReturnParams = {
+    requestId?: number | string | null;
+    requestTypeLabel?: string | null;
+    actual_return_date?: string | Date | null;
+    actual_vehicle_return_time?: string | null;
+    reason?: string | null;
+};
+export declare function buildLogisticsActualReturnChatMessage(params: {
+    roleName: string;
+    roleArabicName?: string | null;
+    returnDetails: LogisticsActualReturnParams;
+}): BilingualText;
+export declare function buildLogisticsActualReturnNotificationBody(params: LogisticsActualReturnParams): BilingualText;
+export declare function buildLogisticsActualReturnNotificationTitle(params: LogisticsActualReturnParams): BilingualText;
+export declare function buildItHelpdeskCloseNotificationMessage(params: {
+    requestId: number | string;
+    status: 'Approved' | 'Rejected';
+}): BilingualText;
+/** Standard FM notification title + body for workflow events. */
+export declare function buildFmNotificationContent(params: {
+    event: 'submitted' | 'received_for_approval' | 'approved' | 'approved_intermediate' | 'rejected' | 'approval_required';
+    serviceLabel: string;
+    serviceLabelAr?: string | null;
+    requestId: number | string;
+    level?: number | string | null;
+    pendingCount?: number | string | null;
+    comment?: string | null;
+}): {
+    title: BilingualText;
+    body: BilingualText;
+};
+/** Build FM notification `content` JSON with bilingual title/data fields. */
+export declare function buildFmNotificationPayload(params: {
+    event: 'submitted' | 'received_for_approval' | 'approved' | 'approved_intermediate' | 'rejected' | 'approval_required';
+    serviceLabel: string;
+    serviceLabelAr?: string | null;
+    requestId: number | string;
+    requestType: string;
+    status: string;
+    level?: number | string | null;
+    pendingCount?: number | string | null;
+    comment?: string | null;
+    bypassedLevels?: string | null;
+    extra?: Record<string, unknown>;
+}): Record<string, unknown>;
+export declare function resolveWorkflowStatusAr(status: string | null | undefined): string | null;
+export declare function resolveChatStatusAr(status: string | null | undefined): string | null;
+/** Pull bilingual actor fields from joined relations on workflow/chat rows. */
+export declare function extractBilingualActorsFromRecord(record: Record<string, unknown>): BilingualActorNames;
+export declare function resolveWorkflowContentAr(content: string | null | undefined, actors?: BilingualActorNames): string | null;
+export declare function resolveChatMessageAr(message: string | null | undefined, actors?: BilingualActorNames): string | null;
+/** Generic workflow log enricher — use in all module repositories. */
+export declare function enrichWorkflowLog(log: Record<string, unknown>): Record<string, unknown>;
+/** Generic chat enricher — use in all module repositories. Handles `message` or `content` column. */
+export declare function enrichChatMessage(chat: Record<string, unknown>): Record<string, unknown>;
+/** @deprecated Use enrichWorkflowLog */
+export declare const enrichCancellationWorkflowLog: typeof enrichWorkflowLog;
+/** @deprecated Use enrichChatMessage */
+export declare const enrichCancellationChatMessage: typeof enrichChatMessage;