Major

libs/api/src/lib/features/licensing/licensing.helpers.ts

@@ -69,6 +69,7 @@ export const STATUS_LABELS: Record<LicenseStatus, string> = {
   PAYMENT_PENDING: 'Payment Pending',
   PAID: 'Paid',
   PAYMENT_CONFIRMED: 'Preparing Certificate',
+  SCHEDULED: 'Pickup Scheduled',
   CERTIFICATE_ISSUED: 'Certificate Issued',
   COMPLETED: 'Completed',
   ELIGIBILITY_APPROVED: 'Eligible to Sit',
@@ -94,6 +95,7 @@ export const STATUS_COLORS: Record<LicenseStatus, string> = {
   PAYMENT_PENDING: 'yellow',
   PAID: 'lime',
   PAYMENT_CONFIRMED: 'teal',
+  SCHEDULED: 'cyan',
   CERTIFICATE_ISSUED: 'green',
   COMPLETED: 'green',
   ELIGIBILITY_APPROVED: 'teal',
@@ -125,6 +127,7 @@ export const STATUS_PROGRESS: Record<LicenseStatus, number> = {
   PAYMENT_PENDING: 80,
   PAID: 88,
   PAYMENT_CONFIRMED: 94,
+  SCHEDULED: 97,
   CERTIFICATE_ISSUED: 100,
   COMPLETED: 100,
   REJECTED: 100,
@@ -169,6 +172,82 @@ export const APPLICANT_NAME_TYPE_KEYS = [
   'ENDORSEMENT_GOC',
 ];
 
+/**
+ * Which business concept a licence type actually is, for terminology and
+ * navigation only — never a workflow or eligibility branch. Mirrors
+ * `resolveFamilyKind` in emaapi's `common/utils/family-terminology.ts`; the
+ * two must be kept in step by hand since the value isn't sent over the wire
+ * (nothing needs it server-side beyond notification copy, so a shared
+ * package felt like more plumbing than the duplication it would save).
+ *
+ * A permission granted to a logistics operator, a seafarer's proof of
+ * competence, and a seafarer/vessel's identity or statutory record are three
+ * different things to the people using this system, even though they run
+ * through the identical application pipeline — see BR-MTO-020.
+ */
+export type FamilyKind = 'LOGISTICS_LICENSE' | 'CERTIFICATE' | 'DOCUMENT';
+
+const FAMILY_KIND_BY_KEY: Partial<Record<string, FamilyKind>> = {
+  SEAMAN_BOOK: 'DOCUMENT',
+  VESSEL_REGISTRATION: 'DOCUMENT',
+  BTC_BASIC_TRAINING: 'CERTIFICATE',
+  CERTIFICATE_OF_COMPETENCY: 'CERTIFICATE',
+  CERTIFICATE_OF_PROFICIENCY: 'CERTIFICATE',
+  ENDORSEMENT_COC: 'CERTIFICATE',
+  ENDORSEMENT_GOC: 'CERTIFICATE',
+  FREIGHT_FORWARDER: 'LOGISTICS_LICENSE',
+  SHIPPING_AGENT: 'LOGISTICS_LICENSE',
+  COMBINED_SA_FF: 'LOGISTICS_LICENSE',
+  MULTIMODAL_TRANSPORT_OPERATOR: 'LOGISTICS_LICENSE',
+  JOINT_INVESTOR: 'LOGISTICS_LICENSE',
+};
+
+/**
+ * `FamilyKind` for a type key that may not be in the map yet. Falls back to
+ * `LOGISTICS_LICENSE`, reproducing today's "Licence ___" wording — the safe
+ * default for an unrecognised key, matching how the map above treats config
+ * it doesn't know about.
+ */
+export function resolveFamilyKind(licenseTypeKey: string | undefined | null): FamilyKind {
+  return (licenseTypeKey && FAMILY_KIND_BY_KEY[licenseTypeKey]) || 'LOGISTICS_LICENSE';
+}
+
+export interface FamilyLabels {
+  /** e.g. "Certificate", "Document", "Licence". */
+  typeLabel: string;
+  /** e.g. "Certificate Number", "Document Number", "Licence Number". */
+  numberLabel: string;
+  /** e.g. "Certificate Holder", "Document Holder", "Licence Holder". */
+  holderLabel: string;
+  /** e.g. "Certificate Review", "Document Review", "Licence Review". */
+  reviewLabel: string;
+}
+
+const FAMILY_LABELS: Record<FamilyKind, FamilyLabels> = {
+  CERTIFICATE: {
+    typeLabel: 'Certificate',
+    numberLabel: 'Certificate Number',
+    holderLabel: 'Certificate Holder',
+    reviewLabel: 'Certificate Review',
+  },
+  DOCUMENT: {
+    typeLabel: 'Document',
+    numberLabel: 'Document Number',
+    holderLabel: 'Document Holder',
+    reviewLabel: 'Document Review',
+  },
+  LOGISTICS_LICENSE: {
+    typeLabel: 'Licence',
+    numberLabel: 'Licence Number',
+    holderLabel: 'Licence Holder',
+    reviewLabel: 'Licence Review',
+  },
+};
+
+export function familyLabels(familyKind: FamilyKind): FamilyLabels {
+  return FAMILY_LABELS[familyKind];
+}
+
 /** Company name, or applicant name for licence types that have no company. */
 export function applicantOrCompanyName(app: LicenseApplication): string | undefined {
   if (!app.licenseType?.key || !APPLICANT_NAME_TYPE_KEYS.includes(app.licenseType.key)) {