@finsys/core 2.3.1 → 2.4.0

package/dist/index.d.cts

@@ -469,6 +469,60 @@ declare enum ExtractionFileType {
     Ic = "ic"
 }
 
+/**
+ * IHS application status — canonical source of truth, mirroring finsys-api's
+ * `IHS_STATUS` enum and `allowedIhsStatus` list in src/utils/appHelper.ts.
+ *
+ * finsys-api originates these values (it writes them to the `ihs.status`
+ * column). Consumer apps (finhub-adonisjs, finsys-client) read them off the
+ * wire and use them for validation and display.
+ *
+ * Lender rejection is not represented by a distinct status: when a lender
+ * rejects an application, finsys-api transitions the record back to
+ * `APPLICATION_FINALIZED` from `LENDER_EVALUATION`.
+ */
+declare enum IhsStatus {
+    CreatingApplication = "CREATING_APPLICATION",
+    ApplicationFinalized = "APPLICATION_FINALIZED",
+    LenderEvaluation = "LENDER_EVALUATION",
+    Approved = "APPROVED",
+    LouDelivered = "LOU_DELIVERED",
+    AwaitingDisbursement = "AWAITING_DISBURSEMENT",
+    Disbursement = "DISBURSEMENT",
+    Declined = "DECLINED",
+    Expired = "EXPIRED",
+    Canceled = "CANCELED"
+}
+/**
+ * All valid IHS status values, in display order (earliest lifecycle stage
+ * first, terminal states last).
+ */
+declare const IHS_VALID_STATUSES: readonly IhsStatus[];
+/**
+ * Terminal statuses — the application lifecycle has completed and no further
+ * transitions are expected. Useful for suppressing action UI (e.g. re-extract,
+ * status update controls) on the application detail view.
+ */
+declare const IHS_TERMINAL_STATUSES: readonly IhsStatus[];
+/**
+ * Failure statuses — a subset of terminal statuses that represent an
+ * unsuccessful outcome. Useful for badge colour / messaging.
+ */
+declare const IHS_FAILURE_STATUSES: readonly IhsStatus[];
+/**
+ * Type guard: narrows an unknown value to `IhsStatus` iff it is one of the
+ * canonical status strings.
+ */
+declare function isValidIhsStatus(status: unknown): status is IhsStatus;
+/**
+ * Type guard: terminal (no further transitions expected).
+ */
+declare function isTerminalIhsStatus(status: unknown): status is IhsStatus;
+/**
+ * Type guard: terminal and unsuccessful.
+ */
+declare function isFailureIhsStatus(status: unknown): status is IhsStatus;
+
 declare enum DocExtractionStatus {
     NotUploaded = "not_uploaded",
     Uploaded = "uploaded",
@@ -516,4 +570,4 @@ interface ExtractionStatusResult {
  */
 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 };
+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, IHS_FAILURE_STATUSES, IHS_TERMINAL_STATUSES, IHS_VALID_STATUSES, type IhsDetailCategory, type IhsFieldDetail, IhsStatus, 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, isFailureIhsStatus, isTerminalIhsStatus, isValidIhsStatus, processIhsDetails, resolveExtractionStatus, resolvePageFields, validateFormConfig, validateFormSpec, validatePagesConfig };

package/dist/index.d.ts

@@ -469,6 +469,60 @@ declare enum ExtractionFileType {
     Ic = "ic"
 }
 
+/**
+ * IHS application status — canonical source of truth, mirroring finsys-api's
+ * `IHS_STATUS` enum and `allowedIhsStatus` list in src/utils/appHelper.ts.
+ *
+ * finsys-api originates these values (it writes them to the `ihs.status`
+ * column). Consumer apps (finhub-adonisjs, finsys-client) read them off the
+ * wire and use them for validation and display.
+ *
+ * Lender rejection is not represented by a distinct status: when a lender
+ * rejects an application, finsys-api transitions the record back to
+ * `APPLICATION_FINALIZED` from `LENDER_EVALUATION`.
+ */
+declare enum IhsStatus {
+    CreatingApplication = "CREATING_APPLICATION",
+    ApplicationFinalized = "APPLICATION_FINALIZED",
+    LenderEvaluation = "LENDER_EVALUATION",
+    Approved = "APPROVED",
+    LouDelivered = "LOU_DELIVERED",
+    AwaitingDisbursement = "AWAITING_DISBURSEMENT",
+    Disbursement = "DISBURSEMENT",
+    Declined = "DECLINED",
+    Expired = "EXPIRED",
+    Canceled = "CANCELED"
+}
+/**
+ * All valid IHS status values, in display order (earliest lifecycle stage
+ * first, terminal states last).
+ */
+declare const IHS_VALID_STATUSES: readonly IhsStatus[];
+/**
+ * Terminal statuses — the application lifecycle has completed and no further
+ * transitions are expected. Useful for suppressing action UI (e.g. re-extract,
+ * status update controls) on the application detail view.
+ */
+declare const IHS_TERMINAL_STATUSES: readonly IhsStatus[];
+/**
+ * Failure statuses — a subset of terminal statuses that represent an
+ * unsuccessful outcome. Useful for badge colour / messaging.
+ */
+declare const IHS_FAILURE_STATUSES: readonly IhsStatus[];
+/**
+ * Type guard: narrows an unknown value to `IhsStatus` iff it is one of the
+ * canonical status strings.
+ */
+declare function isValidIhsStatus(status: unknown): status is IhsStatus;
+/**
+ * Type guard: terminal (no further transitions expected).
+ */
+declare function isTerminalIhsStatus(status: unknown): status is IhsStatus;
+/**
+ * Type guard: terminal and unsuccessful.
+ */
+declare function isFailureIhsStatus(status: unknown): status is IhsStatus;
+
 declare enum DocExtractionStatus {
     NotUploaded = "not_uploaded",
     Uploaded = "uploaded",
@@ -516,4 +570,4 @@ interface ExtractionStatusResult {
  */
 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 };
+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, IHS_FAILURE_STATUSES, IHS_TERMINAL_STATUSES, IHS_VALID_STATUSES, type IhsDetailCategory, type IhsFieldDetail, IhsStatus, 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, isFailureIhsStatus, isTerminalIhsStatus, isValidIhsStatus, processIhsDetails, resolveExtractionStatus, resolvePageFields, validateFormConfig, validateFormSpec, validatePagesConfig };

package/dist/index.js

@@ -9573,6 +9573,53 @@ var ExtractionFileType = /* @__PURE__ */ ((ExtractionFileType2) => {
   return ExtractionFileType2;
 })(ExtractionFileType || {});
 
+// src/ihs-status.ts
+var IhsStatus = /* @__PURE__ */ ((IhsStatus2) => {
+  IhsStatus2["CreatingApplication"] = "CREATING_APPLICATION";
+  IhsStatus2["ApplicationFinalized"] = "APPLICATION_FINALIZED";
+  IhsStatus2["LenderEvaluation"] = "LENDER_EVALUATION";
+  IhsStatus2["Approved"] = "APPROVED";
+  IhsStatus2["LouDelivered"] = "LOU_DELIVERED";
+  IhsStatus2["AwaitingDisbursement"] = "AWAITING_DISBURSEMENT";
+  IhsStatus2["Disbursement"] = "DISBURSEMENT";
+  IhsStatus2["Declined"] = "DECLINED";
+  IhsStatus2["Expired"] = "EXPIRED";
+  IhsStatus2["Canceled"] = "CANCELED";
+  return IhsStatus2;
+})(IhsStatus || {});
+var IHS_VALID_STATUSES = [
+  "CREATING_APPLICATION" /* CreatingApplication */,
+  "APPLICATION_FINALIZED" /* ApplicationFinalized */,
+  "LENDER_EVALUATION" /* LenderEvaluation */,
+  "APPROVED" /* Approved */,
+  "LOU_DELIVERED" /* LouDelivered */,
+  "AWAITING_DISBURSEMENT" /* AwaitingDisbursement */,
+  "DISBURSEMENT" /* Disbursement */,
+  "DECLINED" /* Declined */,
+  "EXPIRED" /* Expired */,
+  "CANCELED" /* Canceled */
+];
+var IHS_TERMINAL_STATUSES = [
+  "DISBURSEMENT" /* Disbursement */,
+  "DECLINED" /* Declined */,
+  "EXPIRED" /* Expired */,
+  "CANCELED" /* Canceled */
+];
+var IHS_FAILURE_STATUSES = [
+  "DECLINED" /* Declined */,
+  "EXPIRED" /* Expired */,
+  "CANCELED" /* Canceled */
+];
+function isValidIhsStatus(status) {
+  return typeof status === "string" && IHS_VALID_STATUSES.includes(status);
+}
+function isTerminalIhsStatus(status) {
+  return typeof status === "string" && IHS_TERMINAL_STATUSES.includes(status);
+}
+function isFailureIhsStatus(status) {
+  return typeof status === "string" && IHS_FAILURE_STATUSES.includes(status);
+}
+
 // src/extraction-status.ts
 var DocExtractionStatus = /* @__PURE__ */ ((DocExtractionStatus2) => {
   DocExtractionStatus2["NotUploaded"] = "not_uploaded";
@@ -9738,6 +9785,10 @@ export {
   FormFieldCategory,
   FormFieldValidator,
   FormSpec,
+  IHS_FAILURE_STATUSES,
+  IHS_TERMINAL_STATUSES,
+  IHS_VALID_STATUSES,
+  IhsStatus,
   IhsValueFormat,
   Role,
   applyDynamicTitles,
@@ -9762,6 +9813,9 @@ export {
   groupDetailsByCategory,
   groupFieldsByCategory,
   groupFieldsByPattern,
+  isFailureIhsStatus,
+  isTerminalIhsStatus,
+  isValidIhsStatus,
   processIhsDetails,
   resolveExtractionStatus,
   resolvePageFields,