@finsys/core 2.0.1 → 2.2.0

package/dist/index.d.cts

@@ -442,4 +442,29 @@ declare enum Role {
     LENDER_AGENT = "Lender Agent"
 }
 
-export { BASE_FIELD_SPECS, BasicFormField, type Category, type Choice, DEFAULT_VALIDATOR_DEFINITIONS, type DropdownOption, type EditorValidator, 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 };
+/**
+ * Status of a document extraction job.
+ * Used by finsys-api (writes) and finhub/finsys-client (reads/displays).
+ */
+declare enum ExtractionJobStatus {
+    Queued = "queued",
+    Processing = "processing",
+    Succeeded = "succeeded",
+    Failed = "failed"
+}
+/**
+ * Document types that go through FinXtract extraction.
+ * Values must match the `type` field on finsys-api File entity
+ * and the config keys in finXtractApi.api.
+ */
+declare enum ExtractionFileType {
+    FinancialStatement = "financialStatements",
+    BankStatement = "bankStatements",
+    Epf = "epfStatements",
+    Payslip = "payslips",
+    Ssm = "ssm",
+    Form9 = "form9",
+    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 };

package/dist/index.d.ts

@@ -442,4 +442,29 @@ declare enum Role {
     LENDER_AGENT = "Lender Agent"
 }
 
-export { BASE_FIELD_SPECS, BasicFormField, type Category, type Choice, DEFAULT_VALIDATOR_DEFINITIONS, type DropdownOption, type EditorValidator, 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 };
+/**
+ * Status of a document extraction job.
+ * Used by finsys-api (writes) and finhub/finsys-client (reads/displays).
+ */
+declare enum ExtractionJobStatus {
+    Queued = "queued",
+    Processing = "processing",
+    Succeeded = "succeeded",
+    Failed = "failed"
+}
+/**
+ * Document types that go through FinXtract extraction.
+ * Values must match the `type` field on finsys-api File entity
+ * and the config keys in finXtractApi.api.
+ */
+declare enum ExtractionFileType {
+    FinancialStatement = "financialStatements",
+    BankStatement = "bankStatements",
+    Epf = "epfStatements",
+    Payslip = "payslips",
+    Ssm = "ssm",
+    Form9 = "form9",
+    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 };

package/dist/index.js

@@ -9321,9 +9321,9 @@ var FIELD_GROUP_PREFIXES = [
   ["financials", "financials"],
   ["epf_statement", "epf_statements"],
   ["payslip_statement", "payslip_statements"],
-  ["ssm", "ssm_company_profile"],
+  ["ssm", "ssm_documents"],
   ["form9", "form9"],
-  ["ic", "ic"]
+  ["ic", "ic_documents"]
 ];
 function groupFieldsByPattern(fields) {
   const groups = {};
@@ -9347,8 +9347,8 @@ var GROUP_DISPLAY_NAMES = {
   epf_statements: "EPF Statements",
   payslip_statements: "Payslip Statements",
   form9: "Form 9 / Section 17 / Form D",
-  ssm_company_profile: "SSM Company Profile",
-  ic: "Identification Card"
+  ssm_documents: "SSM Company Information",
+  ic_documents: "Identification Card"
 };
 function isNumericField(fieldName) {
   const patterns = [
@@ -9547,10 +9547,31 @@ var Role = /* @__PURE__ */ ((Role2) => {
   Role2["LENDER_AGENT"] = "Lender Agent";
   return Role2;
 })(Role || {});
+
+// src/extraction.ts
+var ExtractionJobStatus = /* @__PURE__ */ ((ExtractionJobStatus2) => {
+  ExtractionJobStatus2["Queued"] = "queued";
+  ExtractionJobStatus2["Processing"] = "processing";
+  ExtractionJobStatus2["Succeeded"] = "succeeded";
+  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 || {});
 export {
   BASE_FIELD_SPECS,
   BasicFormField,
   DEFAULT_VALIDATOR_DEFINITIONS,
+  ExtractionFileType,
+  ExtractionJobStatus,
   FIELD_TYPE_DEFINITIONS,
   FieldType,
   FileFieldTableType,