@platform-modules/civil-aviation-authority 2.3.280 → 2.3.281

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

@@ -1,55 +1,5 @@
-export type BilingualText = {
-    en: string;
-    ar: string;
-};
-type WorkflowChatI18nCatalog = {
-    workflowTemplates: Record<string, BilingualText>;
-    chatTemplates: Record<string, BilingualText>;
-    workflowStatusLabels: Record<string, string>;
-    chatStatusLabels: Record<string, string>;
-};
-/** Read-only view of the shared workflow/chat translation catalog. */
-export declare function getWorkflowChatI18nCatalog(): WorkflowChatI18nCatalog;
-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;
-export declare function resolveWorkflowStatusAr(status: string | null | undefined): string | null;
-export declare function resolveChatStatusAr(status: string | null | undefined): string | null;
-/** Arabic column value only — never falls back to English (for content_ar / message_ar). */
-export declare function pickArabicName(arabicName?: string | null): string;
-export declare function pickLocalizedName(englishName?: string | null, arabicName?: string | null, fallback?: string): string;
-/** EN from English columns; AR from Arabic columns only (no English in ar). */
-export declare function joinDeptSectionBilingualLabels(deptEn?: string | null, deptAr?: string | null, sectEn?: string | null, sectAr?: string | null): {
-    en: string;
-    ar: string;
-};
-/** @deprecated Use joinDeptSectionBilingualLabels */
-export declare function joinDeptSectionArabicLabels(deptArabic?: string | null, sectionArabic?: string | null): string;
-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;
-/** Resolve Arabic workflow content from a stored English content string (legacy rows). */
-export declare function resolveWorkflowContentAr(content: string | null | undefined): string | null;
-/** Resolve Arabic chat message from a stored English message string (legacy rows). */
-export declare function resolveChatMessageAr(message: string | null | undefined): string | null;
-export declare function enrichCancellationWorkflowLog(log: Record<string, unknown>): Record<string, unknown>;
-export declare function enrichCancellationChatMessage(chat: Record<string, unknown>): Record<string, unknown>;
-export {};
+/**
+ * Re-exports the CAA standard bilingual message builder.
+ * Import from '@platform-modules/civil-aviation-authority' in all services.
+ */
+export * from './workflow-chat-message.builder';

package/dist/i18n/workflow-chat-i18n.js

@@ -1,278 +1,21 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWorkflowChatI18nCatalog = getWorkflowChatI18nCatalog;
-exports.buildBilingualFromTemplate = buildBilingualFromTemplate;
-exports.workflowTemplate = workflowTemplate;
-exports.chatTemplate = chatTemplate;
-exports.resolveWorkflowStatusAr = resolveWorkflowStatusAr;
-exports.resolveChatStatusAr = resolveChatStatusAr;
-exports.pickArabicName = pickArabicName;
-exports.pickLocalizedName = pickLocalizedName;
-exports.joinDeptSectionBilingualLabels = joinDeptSectionBilingualLabels;
-exports.joinDeptSectionArabicLabels = joinDeptSectionArabicLabels;
-exports.buildApprovalWorkflowContent = buildApprovalWorkflowContent;
-exports.buildHumanApprovalWorkflowContent = buildHumanApprovalWorkflowContent;
-exports.buildApprovalChatMessage = buildApprovalChatMessage;
-exports.resolveWorkflowContentAr = resolveWorkflowContentAr;
-exports.resolveChatMessageAr = resolveChatMessageAr;
-exports.enrichCancellationWorkflowLog = enrichCancellationWorkflowLog;
-exports.enrichCancellationChatMessage = enrichCancellationChatMessage;
-const workflow_chat_i18n_json_1 = __importDefault(require("./workflow-chat-i18n.json"));
-const WORKFLOW_TEMPLATES = workflow_chat_i18n_json_1.default.workflowTemplates;
-const CHAT_TEMPLATES = workflow_chat_i18n_json_1.default.chatTemplates;
-const WORKFLOW_STATUS_LABELS = workflow_chat_i18n_json_1.default.workflowStatusLabels;
-const CHAT_STATUS_LABELS = workflow_chat_i18n_json_1.default.chatStatusLabels;
-/** Read-only view of the shared workflow/chat translation catalog. */
-function getWorkflowChatI18nCatalog() {
-    return workflow_chat_i18n_json_1.default;
-}
-function interpolate(template, params = {}) {
-    return template.replace(/\{\{(\w+)\}\}/g, (_, key) => params[key] ?? '');
-}
-function buildBilingualFromTemplate(templateCatalog, key, params = {}, arParams) {
-    const tpl = templateCatalog[key];
-    if (!tpl) {
-        return { en: key, ar: key };
-    }
-    const arabicParams = arParams ?? params;
-    return {
-        en: interpolate(tpl.en, params),
-        ar: interpolate(tpl.ar, arabicParams),
-    };
-}
-function workflowTemplate(key, params = {}, arParams) {
-    return buildBilingualFromTemplate(WORKFLOW_TEMPLATES, key, params, arParams);
-}
-function chatTemplate(key, params = {}, arParams) {
-    return buildBilingualFromTemplate(CHAT_TEMPLATES, key, params, arParams);
-}
-function resolveWorkflowStatusAr(status) {
-    if (status == null || status === '')
-        return null;
-    return WORKFLOW_STATUS_LABELS[status] ?? status;
-}
-function resolveChatStatusAr(status) {
-    if (status == null || status === '')
-        return null;
-    return CHAT_STATUS_LABELS[status] ?? status;
-}
-/** Arabic column value only — never falls back to English (for content_ar / message_ar). */
-function pickArabicName(arabicName) {
-    return arabicName?.trim() || '';
-}
-function pickLocalizedName(englishName, arabicName, fallback = '') {
-    const ar = arabicName?.trim();
-    if (ar)
-        return ar;
-    const en = englishName?.trim();
-    if (en)
-        return en;
-    return fallback;
-}
-function joinDeptSectionLabels(dept, section) {
-    return [dept, section].map((s) => s?.trim()).filter(Boolean).join(' - ');
-}
-/** EN from English columns; AR from Arabic columns only (no English in ar). */
-function joinDeptSectionBilingualLabels(deptEn, deptAr, sectEn, sectAr) {
-    return {
-        en: joinDeptSectionLabels(deptEn, sectEn),
-        ar: joinDeptSectionLabels(deptAr, sectAr),
-    };
-}
-/** @deprecated Use joinDeptSectionBilingualLabels */
-function joinDeptSectionArabicLabels(deptArabic, sectionArabic) {
-    return joinDeptSectionLabels(deptArabic, sectionArabic);
-}
-function formatWorkflowCommentSuffix(comment) {
-    const text = comment?.trim();
-    return text ? `: ${text}` : '';
-}
-function formatChatCommentSuffix(comment) {
-    const text = comment?.trim();
-    return text ? ` - ${text}` : '';
-}
-function buildWorkflowApprovalByName(templateKey, fallbackKey, nameEn, nameAr, comment) {
-    const commentSuffix = formatWorkflowCommentSuffix(comment);
-    return {
-        en: workflowTemplate(templateKey, { name: nameEn, comment: commentSuffix }).en,
-        ar: nameAr
-            ? workflowTemplate(templateKey, { name: nameAr, comment: '' }).ar
-            : workflowTemplate(fallbackKey, { comment: '' }).ar,
-    };
-}
-function buildWorkflowApprovalWithoutName(templateKey, comment) {
-    const commentSuffix = formatWorkflowCommentSuffix(comment);
-    return {
-        en: workflowTemplate(templateKey, { comment: commentSuffix }).en,
-        ar: workflowTemplate(templateKey, { comment: '' }).ar,
-    };
-}
-function buildWorkflowFromNamePair(templateWithNameKey, templateWithoutNameKey, nameEn, nameAr) {
-    return {
-        en: workflowTemplate(templateWithNameKey, { name: nameEn }).en,
-        ar: nameAr
-            ? workflowTemplate(templateWithNameKey, { name: nameAr }).ar
-            : workflowTemplate(templateWithoutNameKey).ar,
-    };
-}
-function buildApprovalWorkflowContent(params) {
-    const nameEn = params.roleName?.trim() || '';
-    const nameAr = pickArabicName(params.roleArabicName);
-    if (params.status === 'Approved') {
-        return nameEn
-            ? buildWorkflowApprovalByName('request_approved_by', 'request_approved', nameEn, nameAr, params.comment)
-            : buildWorkflowApprovalWithoutName('request_approved', params.comment);
-    }
-    if (params.status === 'Rejected') {
-        return nameEn
-            ? buildWorkflowApprovalByName('request_rejected_by', 'request_rejected', nameEn, nameAr, params.comment)
-            : buildWorkflowApprovalWithoutName('request_rejected', params.comment);
-    }
-    if (params.status === 'Returned for Modification') {
-        return nameEn
-            ? buildWorkflowApprovalByName('request_returned_for_modification_by', 'request_returned_for_modification', nameEn, nameAr, params.comment)
-            : buildWorkflowApprovalWithoutName('request_returned_for_modification', params.comment);
-    }
-    const commentSuffix = formatWorkflowCommentSuffix(params.comment);
-    if (nameEn) {
-        return {
-            en: workflowTemplate('request_approval_pending_from', { name: nameEn, comment: commentSuffix }).en,
-            ar: nameAr
-                ? workflowTemplate('request_approval_pending_from', { name: nameAr, comment: '' }).ar
-                : workflowTemplate('request_approval_pending', { comment: '' }).ar,
-        };
-    }
-    return {
-        en: workflowTemplate('request_approval_pending', { comment: commentSuffix }).en,
-        ar: workflowTemplate('request_approval_pending', { comment: '' }).ar,
-    };
-}
-function buildHumanApprovalWorkflowContent(params) {
-    const withNameKey = params.isFirst ? 'request_approval_in_progress_from' : 'request_approval_pending_from';
-    const withoutNameKey = params.isFirst ? 'request_approval_in_progress' : 'request_approval_pending';
-    if (params.roleName?.trim()) {
-        const nameEn = params.roleName.trim();
-        const nameAr = pickArabicName(params.roleArabicName);
-        return buildWorkflowFromNamePair(withNameKey, withoutNameKey, nameEn, nameAr);
-    }
-    const { en, ar } = joinDeptSectionBilingualLabels(params.deptName, params.deptArabicName, params.sectionName, params.sectionArabicName);
-    if (en) {
-        return buildWorkflowFromNamePair(withNameKey, withoutNameKey, en, ar);
-    }
-    return params.isFirst
-        ? workflowTemplate('request_approval_in_progress')
-        : workflowTemplate('request_approval_pending');
-}
-function buildApprovalChatMessage(params) {
-    const roleEn = params.roleName?.trim() || 'Unknown Role';
-    const roleAr = pickArabicName(params.roleArabicName);
-    const commentSuffix = formatChatCommentSuffix(params.comment);
-    let byRoleKey;
-    let withoutRoleKey;
-    if (params.status === 'Approved') {
-        byRoleKey = 'request_approved_by_role';
-        withoutRoleKey = 'request_approved';
-    }
-    else if (params.status === 'Rejected') {
-        byRoleKey = 'request_rejected_by_role';
-        withoutRoleKey = 'request_rejected';
-    }
-    else if (params.status === 'Returned for Modification') {
-        byRoleKey = 'request_returned_for_modification_by_role';
-        withoutRoleKey = 'request_returned_for_modification';
-    }
-    else {
-        byRoleKey = 'request_approved_by_role';
-        withoutRoleKey = 'request_approved';
-    }
-    return {
-        en: chatTemplate(byRoleKey, { roleName: roleEn, comment: commentSuffix }).en,
-        ar: roleAr
-            ? chatTemplate(byRoleKey, { roleName: roleAr, comment: '' }).ar
-            : chatTemplate(withoutRoleKey, { comment: '' }).ar,
-    };
-}
-/** Resolve Arabic workflow content from a stored English content string (legacy rows). */
-function resolveWorkflowContentAr(content) {
-    if (content == null || content.trim() === '')
-        return null;
-    const normalized = content.trim();
-    for (const tpl of Object.values(WORKFLOW_TEMPLATES)) {
-        if (tpl.en === normalized)
-            return tpl.ar;
-    }
-    const commentIdx = normalized.indexOf(': ');
-    if (commentIdx > 0) {
-        const baseEn = normalized.slice(0, commentIdx).trim();
-        for (const tpl of Object.values(WORKFLOW_TEMPLATES)) {
-            if (!tpl.en.includes('{{comment}}'))
-                continue;
-            const withoutComment = tpl.en.replace('{{comment}}', '');
-            if (withoutComment.includes('{{name}}')) {
-                const staticPrefix = withoutComment.replace('{{name}}', '').trim();
-                if (baseEn.startsWith(staticPrefix)) {
-                    const fallbackKey = Object.entries(WORKFLOW_TEMPLATES).find(([, t]) => t === tpl)?.[0] ?? '';
-                    if (fallbackKey.includes('_by')) {
-                        const genericKey = fallbackKey.replace('_by', '');
-                        if (WORKFLOW_TEMPLATES[genericKey]) {
-                            return WORKFLOW_TEMPLATES[genericKey].ar;
-                        }
-                    }
-                    return tpl.ar.split('{{name}}')[0].trim();
-                }
-            }
-            else if (withoutComment.trim() === baseEn) {
-                return interpolate(tpl.ar, { comment: '' });
-            }
-        }
-    }
-    const inProgressPrefix = WORKFLOW_TEMPLATES.request_approval_in_progress_from?.en.split('{{name}}')[0].trim();
-    if (inProgressPrefix && normalized.startsWith(inProgressPrefix)) {
-        return WORKFLOW_TEMPLATES.request_approval_in_progress.ar;
-    }
-    const pendingPrefix = WORKFLOW_TEMPLATES.request_approval_pending_from?.en.split('{{name}}')[0].trim();
-    if (pendingPrefix && normalized.startsWith(pendingPrefix)) {
-        return WORKFLOW_TEMPLATES.request_approval_pending.ar;
-    }
-    return null;
-}
-/** Resolve Arabic chat message from a stored English message string (legacy rows). */
-function resolveChatMessageAr(message) {
-    if (message == null || message.trim() === '')
-        return null;
-    const normalized = message.trim();
-    for (const tpl of Object.values(CHAT_TEMPLATES)) {
-        if (tpl.en === normalized)
-            return tpl.ar;
-    }
-    return null;
-}
-function enrichCancellationWorkflowLog(log) {
-    const status = log.status != null ? String(log.status) : null;
-    const content = log.content != null ? String(log.content) : null;
-    const storedAr = log.content_ar != null ? String(log.content_ar).trim() : '';
-    const hasEnglishInAr = storedAr && /[A-Za-z]/.test(storedAr);
-    return {
-        ...log,
-        content_ar: hasEnglishInAr
-            ? (resolveWorkflowContentAr(content) ?? storedAr)
-            : (log.content_ar ?? resolveWorkflowContentAr(content)),
-        status_ar: log.status_ar ?? resolveWorkflowStatusAr(status),
-    };
-}
-function enrichCancellationChatMessage(chat) {
-    const status = chat.status != null ? String(chat.status) : null;
-    const message = chat.message != null ? String(chat.message) : null;
-    const storedAr = chat.message_ar != null ? String(chat.message_ar).trim() : '';
-    const hasEnglishInAr = storedAr && /[A-Za-z]/.test(storedAr);
-    return {
-        ...chat,
-        message_ar: hasEnglishInAr
-            ? (resolveChatMessageAr(message) ?? storedAr)
-            : (chat.message_ar ?? resolveChatMessageAr(message)),
-        status_ar: chat.status_ar ?? resolveChatStatusAr(status),
-    };
-}
+/**
+ * Re-exports the CAA standard bilingual message builder.
+ * Import from '@platform-modules/civil-aviation-authority' in all services.
+ */
+__exportStar(require("./workflow-chat-message.builder"), exports);

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

@@ -0,0 +1,103 @@
+export type BilingualText = {
+    en: string;
+    ar: string;
+};
+export type WorkflowChatI18nCatalog = {
+    workflowTemplates: Record<string, BilingualText>;
+    chatTemplates: 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_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;
+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 resolveWorkflowStatusAr(status: string | null | undefined): string | null;
+export declare function resolveChatStatusAr(status: string | null | undefined): string | null;
+export declare function resolveWorkflowContentAr(content: string | null | undefined): string | null;
+export declare function resolveChatMessageAr(message: string | null | undefined): 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. */
+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;