@finsys/core 2.2.0 → 2.3.0

package/dist/index.d.cts

@@ -428,6 +428,8 @@ declare function getDisplayName(fieldName: string): string;
 declare function extractTimePeriods(columnNames: string[]): string[];
 declare function groupColumnsByTimePeriod(columnNames: string[]): Record<string, Record<string, string>>;
 declare function groupFieldsByPattern(fields: FieldData[]): Record<string, FieldData[]>;
+/** Returns human-friendly display names for field groups. */
+declare function getGroupDisplayNames(): Record<string, string>;
 declare function buildFileFieldTables(ihsData: Record<string, unknown>): Record<string, FileFieldTableData>;
 declare function processIhsDetails(ihsData: Record<string, unknown>): IhsFieldDetail[];
 declare function groupDetailsByCategory(details: IhsFieldDetail[]): IhsDetailCategory[];
@@ -467,4 +469,46 @@ declare enum ExtractionFileType {
     Ic = "ic"
 }
 
-export { BASE_FIELD_SPECS, BasicFormField, type Category, type Choice, DEFAULT_VALIDATOR_DEFINITIONS, type DropdownOption, type EditorValidator, ExtractionFileType, ExtractionJobStatus, FIELD_TYPE_DEFINITIONS, type FieldData, type FieldGroup, type FieldReference, FieldType, type FileFieldTableData, type FileFieldTableItem, FileFieldTableType, FileFormField, FormField, FormFieldCategory, type FormFieldInputType, type FormFieldType, type FormFieldTypeDefinitions, FormFieldValidator, FormSpec, type FormValidatorDefinitions, type IhsDetailCategory, type IhsFieldDetail, IhsValueFormat, type PageConfig, type RHFSchemaOutput, type RHFStep, type ResolvedField, Role, type SurveyElementJSON, type SurveyJSON, type SurveyPageJSON, type UnifiedFormConfig, type Validator, applyDynamicTitles, buildFileFieldTables, evaluateExpression, extractTimePeriods, generateRHFSchema, generateSurveyJson, getBaseCategories, getBaseFieldNames, getBaseFieldSpecMap, getBaseFieldSpecs, getCategoryName, getDisplayName, getDisplayNames, getPastMonthLabel, getPastYearLabel, getStepDefaultValues, getStepSchema, groupColumnsByTimePeriod, groupDetailsByCategory, groupFieldsByCategory, groupFieldsByPattern, processIhsDetails, resolvePageFields, validateFormConfig, validateFormSpec, validatePagesConfig };
+declare enum DocExtractionStatus {
+    NotUploaded = "not_uploaded",
+    Uploaded = "uploaded",
+    Queued = "queued",
+    Processing = "processing",
+    Extracted = "extracted",
+    Failed = "failed",
+    Unknown = "unknown"
+}
+interface ExtractionJobRecord {
+    fileType: string;
+    status: string;
+    errorMessage?: string | null;
+}
+interface DocExtractionResult {
+    fileType: ExtractionFileType;
+    status: DocExtractionStatus;
+    displayName: string;
+    populatedColumns: string[];
+    totalColumns: number;
+    errorMessage?: string | null;
+}
+interface ExtractionStatusResult {
+    documents: DocExtractionResult[];
+    summary: {
+        total: number;
+        extracted: number;
+        failed: number;
+        pending: number;
+        notUploaded: number;
+    };
+}
+/**
+ * Determines per-document extraction status from IHS record data.
+ *
+ * @param ihsRecord - The IHS application record (any shape satisfying Record<string, unknown>)
+ * @param jobRecords - Extraction job records for this IHS. Pass the array (even if empty)
+ *   when job records were fetched. Omit or pass undefined when job records are unavailable;
+ *   this produces `Unknown` status for uploaded-but-unextracted documents rather than `Uploaded`.
+ */
+declare function resolveExtractionStatus(ihsRecord: Record<string, unknown>, jobRecords?: ExtractionJobRecord[]): ExtractionStatusResult;
+
+export { BASE_FIELD_SPECS, BasicFormField, type Category, type Choice, DEFAULT_VALIDATOR_DEFINITIONS, type DocExtractionResult, DocExtractionStatus, type DropdownOption, type EditorValidator, ExtractionFileType, type ExtractionJobRecord, ExtractionJobStatus, type ExtractionStatusResult, FIELD_TYPE_DEFINITIONS, type FieldData, type FieldGroup, type FieldReference, FieldType, type FileFieldTableData, type FileFieldTableItem, FileFieldTableType, FileFormField, FormField, FormFieldCategory, type FormFieldInputType, type FormFieldType, type FormFieldTypeDefinitions, FormFieldValidator, FormSpec, type FormValidatorDefinitions, type IhsDetailCategory, type IhsFieldDetail, IhsValueFormat, type PageConfig, type RHFSchemaOutput, type RHFStep, type ResolvedField, Role, type SurveyElementJSON, type SurveyJSON, type SurveyPageJSON, type UnifiedFormConfig, type Validator, applyDynamicTitles, buildFileFieldTables, evaluateExpression, extractTimePeriods, generateRHFSchema, generateSurveyJson, getBaseCategories, getBaseFieldNames, getBaseFieldSpecMap, getBaseFieldSpecs, getCategoryName, getDisplayName, getDisplayNames, getGroupDisplayNames, getPastMonthLabel, getPastYearLabel, getStepDefaultValues, getStepSchema, groupColumnsByTimePeriod, groupDetailsByCategory, groupFieldsByCategory, groupFieldsByPattern, processIhsDetails, resolveExtractionStatus, resolvePageFields, validateFormConfig, validateFormSpec, validatePagesConfig };

package/dist/index.d.ts

@@ -428,6 +428,8 @@ declare function getDisplayName(fieldName: string): string;
 declare function extractTimePeriods(columnNames: string[]): string[];
 declare function groupColumnsByTimePeriod(columnNames: string[]): Record<string, Record<string, string>>;
 declare function groupFieldsByPattern(fields: FieldData[]): Record<string, FieldData[]>;
+/** Returns human-friendly display names for field groups. */
+declare function getGroupDisplayNames(): Record<string, string>;
 declare function buildFileFieldTables(ihsData: Record<string, unknown>): Record<string, FileFieldTableData>;
 declare function processIhsDetails(ihsData: Record<string, unknown>): IhsFieldDetail[];
 declare function groupDetailsByCategory(details: IhsFieldDetail[]): IhsDetailCategory[];
@@ -467,4 +469,46 @@ declare enum ExtractionFileType {
     Ic = "ic"
 }
 
-export { BASE_FIELD_SPECS, BasicFormField, type Category, type Choice, DEFAULT_VALIDATOR_DEFINITIONS, type DropdownOption, type EditorValidator, ExtractionFileType, ExtractionJobStatus, FIELD_TYPE_DEFINITIONS, type FieldData, type FieldGroup, type FieldReference, FieldType, type FileFieldTableData, type FileFieldTableItem, FileFieldTableType, FileFormField, FormField, FormFieldCategory, type FormFieldInputType, type FormFieldType, type FormFieldTypeDefinitions, FormFieldValidator, FormSpec, type FormValidatorDefinitions, type IhsDetailCategory, type IhsFieldDetail, IhsValueFormat, type PageConfig, type RHFSchemaOutput, type RHFStep, type ResolvedField, Role, type SurveyElementJSON, type SurveyJSON, type SurveyPageJSON, type UnifiedFormConfig, type Validator, applyDynamicTitles, buildFileFieldTables, evaluateExpression, extractTimePeriods, generateRHFSchema, generateSurveyJson, getBaseCategories, getBaseFieldNames, getBaseFieldSpecMap, getBaseFieldSpecs, getCategoryName, getDisplayName, getDisplayNames, getPastMonthLabel, getPastYearLabel, getStepDefaultValues, getStepSchema, groupColumnsByTimePeriod, groupDetailsByCategory, groupFieldsByCategory, groupFieldsByPattern, processIhsDetails, resolvePageFields, validateFormConfig, validateFormSpec, validatePagesConfig };
+declare enum DocExtractionStatus {
+    NotUploaded = "not_uploaded",
+    Uploaded = "uploaded",
+    Queued = "queued",
+    Processing = "processing",
+    Extracted = "extracted",
+    Failed = "failed",
+    Unknown = "unknown"
+}
+interface ExtractionJobRecord {
+    fileType: string;
+    status: string;
+    errorMessage?: string | null;
+}
+interface DocExtractionResult {
+    fileType: ExtractionFileType;
+    status: DocExtractionStatus;
+    displayName: string;
+    populatedColumns: string[];
+    totalColumns: number;
+    errorMessage?: string | null;
+}
+interface ExtractionStatusResult {
+    documents: DocExtractionResult[];
+    summary: {
+        total: number;
+        extracted: number;
+        failed: number;
+        pending: number;
+        notUploaded: number;
+    };
+}
+/**
+ * Determines per-document extraction status from IHS record data.
+ *
+ * @param ihsRecord - The IHS application record (any shape satisfying Record<string, unknown>)
+ * @param jobRecords - Extraction job records for this IHS. Pass the array (even if empty)
+ *   when job records were fetched. Omit or pass undefined when job records are unavailable;
+ *   this produces `Unknown` status for uploaded-but-unextracted documents rather than `Uploaded`.
+ */
+declare function resolveExtractionStatus(ihsRecord: Record<string, unknown>, jobRecords?: ExtractionJobRecord[]): ExtractionStatusResult;
+
+export { BASE_FIELD_SPECS, BasicFormField, type Category, type Choice, DEFAULT_VALIDATOR_DEFINITIONS, type DocExtractionResult, DocExtractionStatus, type DropdownOption, type EditorValidator, ExtractionFileType, type ExtractionJobRecord, ExtractionJobStatus, type ExtractionStatusResult, FIELD_TYPE_DEFINITIONS, type FieldData, type FieldGroup, type FieldReference, FieldType, type FileFieldTableData, type FileFieldTableItem, FileFieldTableType, FileFormField, FormField, FormFieldCategory, type FormFieldInputType, type FormFieldType, type FormFieldTypeDefinitions, FormFieldValidator, FormSpec, type FormValidatorDefinitions, type IhsDetailCategory, type IhsFieldDetail, IhsValueFormat, type PageConfig, type RHFSchemaOutput, type RHFStep, type ResolvedField, Role, type SurveyElementJSON, type SurveyJSON, type SurveyPageJSON, type UnifiedFormConfig, type Validator, applyDynamicTitles, buildFileFieldTables, evaluateExpression, extractTimePeriods, generateRHFSchema, generateSurveyJson, getBaseCategories, getBaseFieldNames, getBaseFieldSpecMap, getBaseFieldSpecs, getCategoryName, getDisplayName, getDisplayNames, getGroupDisplayNames, getPastMonthLabel, getPastYearLabel, getStepDefaultValues, getStepSchema, groupColumnsByTimePeriod, groupDetailsByCategory, groupFieldsByCategory, groupFieldsByPattern, processIhsDetails, resolveExtractionStatus, resolvePageFields, validateFormConfig, validateFormSpec, validatePagesConfig };

package/dist/index.js

@@ -9350,6 +9350,9 @@ var GROUP_DISPLAY_NAMES = {
   ssm_documents: "SSM Company Information",
   ic_documents: "Identification Card"
 };
+function getGroupDisplayNames() {
+  return GROUP_DISPLAY_NAMES;
+}
 function isNumericField(fieldName) {
   const patterns = [
     "balance",
@@ -9566,10 +9569,124 @@ var ExtractionFileType = /* @__PURE__ */ ((ExtractionFileType2) => {
   ExtractionFileType2["Ic"] = "ic";
   return ExtractionFileType2;
 })(ExtractionFileType || {});
+
+// src/extraction-status.ts
+var DocExtractionStatus = /* @__PURE__ */ ((DocExtractionStatus2) => {
+  DocExtractionStatus2["NotUploaded"] = "not_uploaded";
+  DocExtractionStatus2["Uploaded"] = "uploaded";
+  DocExtractionStatus2["Queued"] = "queued";
+  DocExtractionStatus2["Processing"] = "processing";
+  DocExtractionStatus2["Extracted"] = "extracted";
+  DocExtractionStatus2["Failed"] = "failed";
+  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;
+  return true;
+}
+function hasUploadedFile(fields, ihsRecord) {
+  return fields.some((field) => {
+    if (!field.name) return false;
+    return isPopulated(ihsRecord[field.name]);
+  });
+}
+function getExtractionColumns(fields) {
+  const columns = [];
+  for (const field of fields) {
+    if (field.ihs_column_names) {
+      columns.push(...field.ihs_column_names);
+    }
+  }
+  return columns;
+}
+function getPopulatedColumns(columns, ihsRecord) {
+  return columns.filter((col) => isPopulated(ihsRecord[col]));
+}
+function resolveExtractionStatus(ihsRecord, jobRecords) {
+  const documents = [];
+  for (const fileType of Object.values(ExtractionFileType)) {
+    const groupName = FILE_TYPE_TO_GROUP[fileType];
+    const fields = _grouped[groupName] ?? [];
+    const displayName = _groupDisplayNames[groupName] ?? fileType;
+    const uploaded = fields.length > 0 && hasUploadedFile(fields, ihsRecord);
+    const allColumns = getExtractionColumns(fields);
+    const populated = getPopulatedColumns(allColumns, ihsRecord);
+    const hasExtractedData = populated.length > 0;
+    let status;
+    let errorMessage;
+    if (!uploaded) {
+      status = "not_uploaded" /* NotUploaded */;
+    } else if (jobRecords) {
+      const job = jobRecords.find((j) => j.fileType === fileType);
+      if (job) {
+        if (job.status === "queued" /* Queued */) {
+          status = "queued" /* Queued */;
+        } else if (job.status === "processing" /* Processing */) {
+          status = "processing" /* Processing */;
+        } else if (job.status === "failed" /* Failed */) {
+          if (hasExtractedData) {
+            status = "extracted" /* Extracted */;
+            errorMessage = job.errorMessage;
+          } else {
+            status = "failed" /* Failed */;
+            errorMessage = job.errorMessage;
+          }
+        } else if (job.status === "succeeded" /* Succeeded */ || hasExtractedData) {
+          status = "extracted" /* Extracted */;
+        } else {
+          status = "uploaded" /* Uploaded */;
+        }
+      } else if (hasExtractedData) {
+        status = "extracted" /* Extracted */;
+      } else {
+        status = "uploaded" /* Uploaded */;
+      }
+    } else if (hasExtractedData) {
+      status = "extracted" /* Extracted */;
+    } else {
+      status = "unknown" /* Unknown */;
+    }
+    documents.push({
+      fileType,
+      status,
+      displayName,
+      populatedColumns: populated,
+      totalColumns: allColumns.length,
+      errorMessage
+    });
+  }
+  const summary = documents.reduce(
+    (acc, d) => {
+      if (d.status === "extracted" /* Extracted */) acc.extracted++;
+      else if (d.status === "failed" /* Failed */) acc.failed++;
+      else if (d.status === "not_uploaded" /* NotUploaded */) acc.notUploaded++;
+      else acc.pending++;
+      return acc;
+    },
+    { total: documents.length, extracted: 0, failed: 0, pending: 0, notUploaded: 0 }
+  );
+  return { documents, summary };
+}
 export {
   BASE_FIELD_SPECS,
   BasicFormField,
   DEFAULT_VALIDATOR_DEFINITIONS,
+  DocExtractionStatus,
   ExtractionFileType,
   ExtractionJobStatus,
   FIELD_TYPE_DEFINITIONS,
@@ -9595,6 +9712,7 @@ export {
   getCategoryName,
   getDisplayName,
   getDisplayNames,
+  getGroupDisplayNames,
   getPastMonthLabel,
   getPastYearLabel,
   getStepDefaultValues,
@@ -9604,6 +9722,7 @@ export {
   groupFieldsByCategory,
   groupFieldsByPattern,
   processIhsDetails,
+  resolveExtractionStatus,
   resolvePageFields,
   validateFormConfig,
   validateFormSpec,