@finsys/core 3.5.0 → 4.0.0

package/dist/index.cjs

@@ -37,7 +37,6 @@ __export(index_exports, {
   BasicFormField: () => BasicFormField,
   DEFAULT_VALIDATOR_DEFINITIONS: () => DEFAULT_VALIDATOR_DEFINITIONS,
   DocExtractionStatus: () => DocExtractionStatus,
-  ExtractionFileType: () => ExtractionFileType,
   ExtractionJobStatus: () => ExtractionJobStatus,
   FIELD_TYPE_DEFINITIONS: () => FIELD_TYPE_DEFINITIONS,
   FieldType: () => FieldType,
@@ -57,6 +56,7 @@ __export(index_exports, {
   applyAggregation: () => applyAggregation,
   applyDynamicTitles: () => applyDynamicTitles,
   assertAdapterCategory: () => assertAdapterCategory,
+  assertDocumentType: () => assertDocumentType,
   buildDocumentRows: () => buildDocumentRows,
   buildFileFieldTables: () => buildFileFieldTables,
   categoryFieldsOf: () => categoryFieldsOf,
@@ -77,6 +77,7 @@ __export(index_exports, {
   getDisplayName: () => getDisplayName,
   getDisplayNames: () => getDisplayNames,
   getDocDisplayNames: () => getDocDisplayNames,
+  getDocumentTypeGroups: () => getDocumentTypeGroups,
   getExtractableDocTypes: () => getExtractableDocTypes,
   getGroupDisplayNames: () => getGroupDisplayNames,
   getPastMonthLabel: () => getPastMonthLabel,
@@ -89,6 +90,7 @@ __export(index_exports, {
   groupFieldsByCategory: () => groupFieldsByCategory,
   groupFieldsByPattern: () => groupFieldsByPattern,
   isAdapterCategory: () => isAdapterCategory,
+  isDocumentType: () => isDocumentType,
   isFailureIhsStatus: () => isFailureIhsStatus,
   isTerminalIhsStatus: () => isTerminalIhsStatus,
   isValidIhsStatus: () => isValidIhsStatus,
@@ -8002,7 +8004,13 @@ var form_field_base_specs_default = {
         "openingBalanceT1",
         "bankBalanceT1"
       ],
-      category: "13"
+      category: "13",
+      document_type: "bankStatements",
+      document_group: "bank_statements",
+      document_group_label: "Bank Statements",
+      wire_format: "path_array",
+      document_slot: 1,
+      time_period_unit: "month"
     },
     {
       name: "bank_statement_t2",
@@ -8018,7 +8026,13 @@ var form_field_base_specs_default = {
         "openingBalanceT2",
         "bankBalanceT2"
       ],
-      category: "13"
+      category: "13",
+      document_type: "bankStatements",
+      document_group: "bank_statements",
+      document_group_label: "Bank Statements",
+      wire_format: "path_array",
+      document_slot: 2,
+      time_period_unit: "month"
     },
     {
       name: "bank_statement_t3",
@@ -8034,7 +8048,13 @@ var form_field_base_specs_default = {
         "openingBalanceT3",
         "bankBalanceT3"
       ],
-      category: "13"
+      category: "13",
+      document_type: "bankStatements",
+      document_group: "bank_statements",
+      document_group_label: "Bank Statements",
+      wire_format: "path_array",
+      document_slot: 3,
+      time_period_unit: "month"
     },
     {
       name: "bank_statement_t4",
@@ -8050,7 +8070,13 @@ var form_field_base_specs_default = {
         "openingBalanceT4",
         "bankBalanceT4"
       ],
-      category: "13"
+      category: "13",
+      document_type: "bankStatements",
+      document_group: "bank_statements",
+      document_group_label: "Bank Statements",
+      wire_format: "path_array",
+      document_slot: 4,
+      time_period_unit: "month"
     },
     {
       name: "bank_statement_t5",
@@ -8066,7 +8092,13 @@ var form_field_base_specs_default = {
         "openingBalanceT5",
         "bankBalanceT5"
       ],
-      category: "13"
+      category: "13",
+      document_type: "bankStatements",
+      document_group: "bank_statements",
+      document_group_label: "Bank Statements",
+      wire_format: "path_array",
+      document_slot: 5,
+      time_period_unit: "month"
     },
     {
       name: "bank_statement_t6",
@@ -8082,7 +8114,13 @@ var form_field_base_specs_default = {
         "openingBalanceT6",
         "bankBalanceT6"
       ],
-      category: "13"
+      category: "13",
+      document_type: "bankStatements",
+      document_group: "bank_statements",
+      document_group_label: "Bank Statements",
+      wire_format: "path_array",
+      document_slot: 6,
+      time_period_unit: "month"
     },
     {
       name: "financials",
@@ -8103,7 +8141,13 @@ var form_field_base_specs_default = {
         "netOperatingCashFlow",
         "ebitda"
       ],
-      category: "13"
+      category: "13",
+      document_type: "financialStatements",
+      document_group: "financials",
+      document_group_label: "Audited Financial Statements",
+      wire_format: "path_array",
+      document_slot: 1,
+      time_period_unit: "year"
     },
     {
       name: "financials_fincap_t1",
@@ -8347,7 +8391,13 @@ var form_field_base_specs_default = {
         "depreciationOfInvestmentSecuritiesT2",
         "endOfYearCashT2"
       ],
-      category: "13"
+      category: "13",
+      document_type: "financialStatements",
+      document_group: "financials",
+      document_group_label: "Audited Financial Statements",
+      wire_format: "path_array",
+      document_slot: 1,
+      time_period_unit: "year"
     },
     {
       name: "financials_fincap_t2",
@@ -8473,7 +8523,13 @@ var form_field_base_specs_default = {
         "depreciationOfInvestmentSecuritiesT3",
         "endOfYearCashT3"
       ],
-      category: "13"
+      category: "13",
+      document_type: "financialStatements",
+      document_group: "financials",
+      document_group_label: "Audited Financial Statements",
+      wire_format: "path_array",
+      document_slot: 2,
+      time_period_unit: "year"
     },
     {
       name: "form9",
@@ -8484,7 +8540,11 @@ var form_field_base_specs_default = {
         "companyName",
         "companyRegNo"
       ],
-      category: "13"
+      category: "13",
+      document_type: "form9",
+      document_group: "form9",
+      document_group_label: "Form 9 / Section 17 / Form D",
+      wire_format: "url_string"
     },
     {
       name: "ssm",
@@ -8508,7 +8568,11 @@ var form_field_base_specs_default = {
         "businessOrigin",
         "registeredAddress"
       ],
-      category: "13"
+      category: "13",
+      document_type: "ssm",
+      document_group: "ssm_documents",
+      document_group_label: "SSM Company Information",
+      wire_format: "url_string"
     },
     {
       name: "ic",
@@ -8525,7 +8589,11 @@ var form_field_base_specs_default = {
         "icNationality",
         "icRace"
       ],
-      category: "13"
+      category: "13",
+      document_type: "ic",
+      document_group: "ic_documents",
+      document_group_label: "Identification Card",
+      wire_format: "url_string"
     },
     {
       name: "epf_statement_t1",
@@ -8542,7 +8610,13 @@ var form_field_base_specs_default = {
         "epfTotalContributionT1",
         "epfTotalCurrentContributionT1"
       ],
-      category: "13"
+      category: "13",
+      document_type: "epfStatements",
+      document_group: "epf_statements",
+      document_group_label: "EPF Statements",
+      wire_format: "path_array",
+      document_slot: 1,
+      time_period_unit: "year"
     },
     {
       name: "epf_statement_t2",
@@ -8559,7 +8633,13 @@ var form_field_base_specs_default = {
         "epfTotalContributionT2",
         "epfTotalCurrentContributionT2"
       ],
-      category: "13"
+      category: "13",
+      document_type: "epfStatements",
+      document_group: "epf_statements",
+      document_group_label: "EPF Statements",
+      wire_format: "path_array",
+      document_slot: 2,
+      time_period_unit: "year"
     },
     {
       name: "payslip_statement_t1",
@@ -8582,7 +8662,13 @@ var form_field_base_specs_default = {
         "payslipEmployeeTaxT1",
         "payslipOtherDeductionT1"
       ],
-      category: "13"
+      category: "13",
+      document_type: "payslips",
+      document_group: "payslip_statements",
+      document_group_label: "Payslip Statements",
+      wire_format: "path_array",
+      document_slot: 1,
+      time_period_unit: "month"
     },
     {
       name: "payslip_statement_t2",
@@ -8605,7 +8691,13 @@ var form_field_base_specs_default = {
         "payslipEmployeeTaxT2",
         "payslipOtherDeductionT2"
       ],
-      category: "13"
+      category: "13",
+      document_type: "payslips",
+      document_group: "payslip_statements",
+      document_group_label: "Payslip Statements",
+      wire_format: "path_array",
+      document_slot: 2,
+      time_period_unit: "month"
     },
     {
       name: "payslip_statement_t3",
@@ -8628,7 +8720,13 @@ var form_field_base_specs_default = {
         "payslipEmployeeTaxT3",
         "payslipOtherDeductionT3"
       ],
-      category: "13"
+      category: "13",
+      document_type: "payslips",
+      document_group: "payslip_statements",
+      document_group_label: "Payslip Statements",
+      wire_format: "path_array",
+      document_slot: 3,
+      time_period_unit: "month"
     },
     {
       name: "payslip_statement_t4",
@@ -8651,7 +8749,13 @@ var form_field_base_specs_default = {
         "payslipEmployeeTaxT4",
         "payslipOtherDeductionT4"
       ],
-      category: "13"
+      category: "13",
+      document_type: "payslips",
+      document_group: "payslip_statements",
+      document_group_label: "Payslip Statements",
+      wire_format: "path_array",
+      document_slot: 4,
+      time_period_unit: "month"
     },
     {
       name: "payslip_statement_t5",
@@ -8674,7 +8778,13 @@ var form_field_base_specs_default = {
         "payslipEmployeeTaxT5",
         "payslipOtherDeductionT5"
       ],
-      category: "13"
+      category: "13",
+      document_type: "payslips",
+      document_group: "payslip_statements",
+      document_group_label: "Payslip Statements",
+      wire_format: "path_array",
+      document_slot: 5,
+      time_period_unit: "month"
     },
     {
       name: "payslip_statement_t6",
@@ -8697,7 +8807,13 @@ var form_field_base_specs_default = {
         "payslipEmployeeTaxT6",
         "payslipOtherDeductionT6"
       ],
-      category: "13"
+      category: "13",
+      document_type: "payslips",
+      document_group: "payslip_statements",
+      document_group_label: "Payslip Statements",
+      wire_format: "path_array",
+      document_slot: 6,
+      time_period_unit: "month"
     }
   ]
 };
@@ -9191,6 +9307,55 @@ var FileFieldTableType = /* @__PURE__ */ ((FileFieldTableType2) => {
   return FileFieldTableType2;
 })(FileFieldTableType || {});
 
+// src/document-types.ts
+var cached = null;
+function buildDocumentTypeGroups() {
+  const fileFields = getBaseFieldSpecs().filter(
+    (f) => f.type === "file" && !!f.name
+  );
+  const order = [];
+  const byDocumentType = /* @__PURE__ */ new Map();
+  for (const f of fileFields) {
+    const documentType = f.document_type ?? f.name;
+    const documentGroup = f.document_group ?? documentType;
+    const label = f.document_group_label ?? f.displayName ?? documentType;
+    if (!byDocumentType.has(documentType)) {
+      order.push(documentType);
+      byDocumentType.set(documentType, {
+        documentGroup,
+        label,
+        wireFormat: f.wire_format,
+        fields: []
+      });
+    }
+    byDocumentType.get(documentType).fields.push(f);
+  }
+  return order.map((documentType) => {
+    const entry = byDocumentType.get(documentType);
+    return {
+      documentType,
+      documentGroup: entry.documentGroup,
+      label: entry.label,
+      wireFormat: entry.wireFormat,
+      fields: entry.fields
+    };
+  });
+}
+function getDocumentTypeGroups() {
+  if (!cached) cached = buildDocumentTypeGroups();
+  return cached;
+}
+function isDocumentType(id) {
+  return getDocumentTypeGroups().some((g) => g.documentType === id);
+}
+function assertDocumentType(id) {
+  if (!isDocumentType(id)) {
+    const known = getDocumentTypeGroups().map((g) => g.documentType);
+    throw new Error(`Unknown document type: "${id}". Available: ${known.join(", ")}`);
+  }
+  return id;
+}
+
 // src/data/form-field-display-names.json
 var form_field_display_names_default = {
   accountHolderName: "Account Holder Name",
@@ -9399,42 +9564,26 @@ function groupColumnsByTimePeriod(columnNames) {
   }
   return groups;
 }
-var FIELD_GROUP_PREFIXES = [
-  ["bank_statement", "bank_statements"],
-  ["financials", "financials"],
-  ["epf_statement", "epf_statements"],
-  ["payslip_statement", "payslip_statements"],
-  ["ssm", "ssm_documents"],
-  ["form9", "form9"],
-  ["ic", "ic_documents"]
-];
 function groupFieldsByPattern(fields) {
   const groups = {};
   for (const field of fields) {
     if (!field.name) continue;
-    let groupName = field.name;
-    for (const [prefix, group] of FIELD_GROUP_PREFIXES) {
-      if (field.name.startsWith(prefix)) {
-        groupName = group;
-        break;
-      }
-    }
+    const groupName = field.document_group ?? field.name;
     if (!groups[groupName]) groups[groupName] = [];
     groups[groupName].push(field);
   }
   return groups;
 }
-var GROUP_DISPLAY_NAMES = {
-  bank_statements: "Bank Statements",
-  financials: "Audited Financial Statements",
-  epf_statements: "EPF Statements",
-  payslip_statements: "Payslip Statements",
-  form9: "Form 9 / Section 17 / Form D",
-  ssm_documents: "SSM Company Information",
-  ic_documents: "Identification Card"
-};
+var cachedGroupDisplayNames = null;
 function getGroupDisplayNames() {
-  return GROUP_DISPLAY_NAMES;
+  if (!cachedGroupDisplayNames) {
+    const names = {};
+    for (const group of getDocumentTypeGroups()) {
+      names[group.documentGroup] = group.label;
+    }
+    cachedGroupDisplayNames = names;
+  }
+  return cachedGroupDisplayNames;
 }
 function isNumericField(fieldName) {
   const patterns = [
@@ -9479,7 +9628,7 @@ function buildTableForGroup(groupName, fields, ihsData, fieldProvenance) {
   const periods = extractTimePeriods(allColumns);
   const isTimeSeries = periods.length > 0;
   const tableType = isTimeSeries ? "timeSeries" /* TIME_SERIES */ : "keyValue" /* KEY_VALUE */;
-  const groupDisplayName = GROUP_DISPLAY_NAMES[groupName] || fields[0]?.displayName || getDisplayName(groupName);
+  const groupDisplayName = getGroupDisplayNames()[groupName] || fields[0]?.displayName || getDisplayName(groupName);
   if (isTimeSeries) {
     const columnGroups = groupColumnsByTimePeriod(allColumns);
     const items = [];
@@ -9800,16 +9949,6 @@ var ExtractionJobStatus = /* @__PURE__ */ ((ExtractionJobStatus2) => {
   ExtractionJobStatus2["Failed"] = "failed";
   return ExtractionJobStatus2;
 })(ExtractionJobStatus || {});
-var ExtractionFileType = /* @__PURE__ */ ((ExtractionFileType2) => {
-  ExtractionFileType2["FinancialStatement"] = "financialStatements";
-  ExtractionFileType2["BankStatement"] = "bankStatements";
-  ExtractionFileType2["Epf"] = "epfStatements";
-  ExtractionFileType2["Payslip"] = "payslips";
-  ExtractionFileType2["Ssm"] = "ssm";
-  ExtractionFileType2["Form9"] = "form9";
-  ExtractionFileType2["Ic"] = "ic";
-  return ExtractionFileType2;
-})(ExtractionFileType || {});
 
 // src/ihs-status.ts
 var IhsStatus = /* @__PURE__ */ ((IhsStatus2) => {
@@ -9869,19 +10008,6 @@ var DocExtractionStatus = /* @__PURE__ */ ((DocExtractionStatus2) => {
   DocExtractionStatus2["Unknown"] = "unknown";
   return DocExtractionStatus2;
 })(DocExtractionStatus || {});
-var FILE_TYPE_TO_GROUP = {
-  ["bankStatements" /* BankStatement */]: "bank_statements",
-  ["financialStatements" /* FinancialStatement */]: "financials",
-  ["epfStatements" /* Epf */]: "epf_statements",
-  ["payslips" /* Payslip */]: "payslip_statements",
-  ["ssm" /* Ssm */]: "ssm_documents",
-  ["form9" /* Form9 */]: "form9",
-  ["ic" /* Ic */]: "ic_documents"
-};
-var _specs = getBaseFieldSpecs();
-var _fileFields = _specs.filter((f) => f.type === "file" && f.ihs_column_names?.length);
-var _grouped = groupFieldsByPattern(_fileFields);
-var _groupDisplayNames = getGroupDisplayNames();
 function isPopulated(value) {
   if (value === null || value === void 0 || value === "") return false;
   if (value === "Not Specified") return false;
@@ -9945,10 +10071,10 @@ function resolveDocStatus(columns, ihsRecord, uploaded, jobRecord, hasJobRecords
 function resolveExtractionStatus(ihsRecord, jobRecords) {
   const documents = [];
   const hasJobRecords = jobRecords !== void 0;
-  for (const fileType of Object.values(ExtractionFileType)) {
-    const groupName = FILE_TYPE_TO_GROUP[fileType];
-    const fields = _grouped[groupName] ?? [];
-    const displayName = _groupDisplayNames[groupName] ?? fileType;
+  for (const group of getDocumentTypeGroups()) {
+    const fileType = group.documentType;
+    const fields = group.fields;
+    const displayName = group.label;
     const uploadedCount = countUploadedFiles(ihsRecord, fileType);
     const isUploaded = uploadedCount > 0 || fields.some((f) => f.name && isPopulated(ihsRecord[f.name]));
     const matchingJobs = jobRecords?.filter((j) => j.fileType === fileType) ?? [];
@@ -10598,7 +10724,6 @@ function assertAdapterCategory(id) {
   BasicFormField,
   DEFAULT_VALIDATOR_DEFINITIONS,
   DocExtractionStatus,
-  ExtractionFileType,
   ExtractionJobStatus,
   FIELD_TYPE_DEFINITIONS,
   FieldType,
@@ -10618,6 +10743,7 @@ function assertAdapterCategory(id) {
   applyAggregation,
   applyDynamicTitles,
   assertAdapterCategory,
+  assertDocumentType,
   buildDocumentRows,
   buildFileFieldTables,
   categoryFieldsOf,
@@ -10638,6 +10764,7 @@ function assertAdapterCategory(id) {
   getDisplayName,
   getDisplayNames,
   getDocDisplayNames,
+  getDocumentTypeGroups,
   getExtractableDocTypes,
   getGroupDisplayNames,
   getPastMonthLabel,
@@ -10650,6 +10777,7 @@ function assertAdapterCategory(id) {
   groupFieldsByCategory,
   groupFieldsByPattern,
   isAdapterCategory,
+  isDocumentType,
   isFailureIhsStatus,
   isTerminalIhsStatus,
   isValidIhsStatus,