@mody-park-cha-raja/finance_common 4.21.0 → 4.24.0

package/dist/index.d.mts

@@ -58,6 +58,13 @@ declare enum SponsorTier {
     GENERAL_SPONSOR = "General Sponsor"
 }
 
+declare enum TransactionEntityType {
+    DONATION = "donation",
+    SPONSOR = "sponsor",
+    EXPENSE = "expense",
+    DAAN_PETI = "daan_peti"
+}
+
 declare enum TransactionType {
     INCOME = "Income",
     EXPENSE = "Expense"
@@ -146,6 +153,13 @@ interface ISponsorEntity extends IAuditColumnEntity {
 interface ITransactionHistoryEntity extends IBaseHistoryEntity {
 }
 
+interface IDtoValidationError {
+    key: string;
+    message: string;
+}
+
+type Nullable<T> = T | null;
+
 interface ITransactionEntity extends IAuditColumnEntity {
     id: number;
     date: string;
@@ -153,7 +167,8 @@ interface ITransactionEntity extends IAuditColumnEntity {
     particulars: string;
     amount: number;
     balanceAfter: number;
-    referenceId: string;
+    referenceId: Nullable<number>;
+    entityType?: Nullable<TransactionEntityType>;
     paymentType: PaymentType;
     status?: EntityStatus;
 }
@@ -161,13 +176,6 @@ interface ITransactionEntity extends IAuditColumnEntity {
 interface IUserHistoryEntity extends IBaseHistoryEntity {
 }
 
-interface IDtoValidationError {
-    key: string;
-    message: string;
-}
-
-type Nullable<T> = T | null;
-
 /**
  * Utility class for validating date codes in `YYYYMMDD` format.
  *
@@ -346,19 +354,19 @@ interface FlatDonationLike {
     amount: number;
     donationYear?: number;
     createdOn?: number;
-    createdByUser?: {
+    createdByUser?: Nullable<{
         name?: string;
-    } | null;
-    updatedByUser?: {
+    }>;
+    updatedByUser?: Nullable<{
         name?: string;
-    } | null;
+    }>;
 }
 type FlatCollectionStatus = "Paid" | "Pending";
 interface FlatCollectionEntry {
     flatNumber: string;
     status: FlatCollectionStatus;
     amount: number;
-    latestDonation?: FlatDonationLike | null;
+    latestDonation?: Nullable<FlatDonationLike>;
 }
 interface FlatParseResult {
     wing?: string;
@@ -442,7 +450,8 @@ declare class TransactionModel extends BaseEntityModel implements ITransactionEn
     particulars: string;
     amount: number;
     balanceAfter: number;
-    referenceId: string;
+    referenceId: Nullable<number>;
+    entityType: Nullable<TransactionEntityType>;
     paymentType: PaymentType;
     status: EntityStatus;
     createdOn: number;
@@ -454,6 +463,7 @@ declare class TransactionModel extends BaseEntityModel implements ITransactionEn
     protected constructor();
     static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
     static populateFromEntity(entity: ITransactionEntity): TransactionModel;
+    static toReferenceId(entityType: Nullable<TransactionEntityType> | undefined, referenceId: Nullable<number> | undefined): string;
     static toCashBookEntry(tx: TransactionModel): ICashBookEntry;
     static toCashBook(txns: TransactionModel[]): ICashBookEntry[];
 }
@@ -601,7 +611,7 @@ declare function diffArrays<T>(arr1: T[], arr2: T[]): {
  * grouped.get('keyValue2'); // [item3]
  */
 declare function groupBy<T>(items: T[], key: keyof T): Map<string, T[]>;
-declare function definedValues<T>(arr: Array<T | undefined | null>): T[];
+declare function definedValues<T>(arr: Array<Nullable<T> | undefined>): T[];
 /**
  * Converts an epoch timestamp (milliseconds) into a human-readable date string.
  *
@@ -619,7 +629,7 @@ declare function definedValues<T>(arr: Array<T | undefined | null>): T[];
  * epochToReadableDate(1700000000000, 'short-dt'); // "14/11/23 18:13"
  * epochToReadableDate(1700000000000);          // "2023-11-14T18:13:20.000Z"
  */
-declare function epochToReadableDate(epoch: number | string, format?: 'short' | 'long' | 'short-dt' | 'iso'): string;
+declare function epochToReadableDate(epoch: number | string, format?: "short" | "long" | "short-dt" | "iso"): string;
 
 declare function convertNumberToWords(num: number): string;
 
@@ -797,4 +807,4 @@ interface IConfigurationUpdateDto extends IEntityUpdateDto<EntityType<EntityList
 interface IConfigurationSearchDto extends IEntityFilterData<EntityType<EntityList.CONFIGURATION>> {
 }
 
-export { BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHistoryModel, ExpenseModel, ExpenseType, FLATS_BY_WING, FLAT_NUMBERS, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatModel, type FlatOption, type FlatParseResult, ForbiddenException, HttpException, type IAuditColumnEntity, type IBaseHistoryEntity, type ICashBookEntry, type IConfigurationCreateDto, type IConfigurationEntity, type IConfigurationSearchDto, type IConfigurationUpdateDto, type IDonationCreateDto, type IDonationEntity, type IDonationHistoryEntity, type IDonationSearchDto, type IDonationUpdateDto, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseCreateDto, type IExpenseEntity, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IMappingPropertyEntry, type IModelRelationConfig, type ISearchV2Response, type ISponsorCreateDto, type ISponsorEntity, type ISponsorHistoryEntity, type ISponsorSearchDto, type ISponsorUpdateDto, type ITransactionCreateDto, type ITransactionEntity, type ITransactionHistoryEntity, type ITransactionSearchDto, type ITransactionUpdateDto, type IUserCreateDto, type IUserEntity, type IUserHistoryEntity, type IUserSearchDto, type IUserUpdateDto, type IVendorCreateDto, type IVendorEntity, type IVendorHistoryEntity, type IVendorSearchDto, type IVendorUpdateDto, NotFoundException, type Nullable, OrderByDirection, PAYMENT_OPTIONS, PaymentType, ReferenceIdPrefix, RelationType, SPECIAL_FLATS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getObjectDiffingKeys, groupBy };
+export { BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHistoryModel, ExpenseModel, ExpenseType, FLATS_BY_WING, FLAT_NUMBERS, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatModel, type FlatOption, type FlatParseResult, ForbiddenException, HttpException, type IAuditColumnEntity, type IBaseHistoryEntity, type ICashBookEntry, type IConfigurationCreateDto, type IConfigurationEntity, type IConfigurationSearchDto, type IConfigurationUpdateDto, type IDonationCreateDto, type IDonationEntity, type IDonationHistoryEntity, type IDonationSearchDto, type IDonationUpdateDto, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseCreateDto, type IExpenseEntity, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IMappingPropertyEntry, type IModelRelationConfig, type ISearchV2Response, type ISponsorCreateDto, type ISponsorEntity, type ISponsorHistoryEntity, type ISponsorSearchDto, type ISponsorUpdateDto, type ITransactionCreateDto, type ITransactionEntity, type ITransactionHistoryEntity, type ITransactionSearchDto, type ITransactionUpdateDto, type IUserCreateDto, type IUserEntity, type IUserHistoryEntity, type IUserSearchDto, type IUserUpdateDto, type IVendorCreateDto, type IVendorEntity, type IVendorHistoryEntity, type IVendorSearchDto, type IVendorUpdateDto, NotFoundException, type Nullable, OrderByDirection, PAYMENT_OPTIONS, PaymentType, ReferenceIdPrefix, RelationType, SPECIAL_FLATS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getObjectDiffingKeys, groupBy };

package/dist/index.d.ts

@@ -58,6 +58,13 @@ declare enum SponsorTier {
     GENERAL_SPONSOR = "General Sponsor"
 }
 
+declare enum TransactionEntityType {
+    DONATION = "donation",
+    SPONSOR = "sponsor",
+    EXPENSE = "expense",
+    DAAN_PETI = "daan_peti"
+}
+
 declare enum TransactionType {
     INCOME = "Income",
     EXPENSE = "Expense"
@@ -146,6 +153,13 @@ interface ISponsorEntity extends IAuditColumnEntity {
 interface ITransactionHistoryEntity extends IBaseHistoryEntity {
 }
 
+interface IDtoValidationError {
+    key: string;
+    message: string;
+}
+
+type Nullable<T> = T | null;
+
 interface ITransactionEntity extends IAuditColumnEntity {
     id: number;
     date: string;
@@ -153,7 +167,8 @@ interface ITransactionEntity extends IAuditColumnEntity {
     particulars: string;
     amount: number;
     balanceAfter: number;
-    referenceId: string;
+    referenceId: Nullable<number>;
+    entityType?: Nullable<TransactionEntityType>;
     paymentType: PaymentType;
     status?: EntityStatus;
 }
@@ -161,13 +176,6 @@ interface ITransactionEntity extends IAuditColumnEntity {
 interface IUserHistoryEntity extends IBaseHistoryEntity {
 }
 
-interface IDtoValidationError {
-    key: string;
-    message: string;
-}
-
-type Nullable<T> = T | null;
-
 /**
  * Utility class for validating date codes in `YYYYMMDD` format.
  *
@@ -346,19 +354,19 @@ interface FlatDonationLike {
     amount: number;
     donationYear?: number;
     createdOn?: number;
-    createdByUser?: {
+    createdByUser?: Nullable<{
         name?: string;
-    } | null;
-    updatedByUser?: {
+    }>;
+    updatedByUser?: Nullable<{
         name?: string;
-    } | null;
+    }>;
 }
 type FlatCollectionStatus = "Paid" | "Pending";
 interface FlatCollectionEntry {
     flatNumber: string;
     status: FlatCollectionStatus;
     amount: number;
-    latestDonation?: FlatDonationLike | null;
+    latestDonation?: Nullable<FlatDonationLike>;
 }
 interface FlatParseResult {
     wing?: string;
@@ -442,7 +450,8 @@ declare class TransactionModel extends BaseEntityModel implements ITransactionEn
     particulars: string;
     amount: number;
     balanceAfter: number;
-    referenceId: string;
+    referenceId: Nullable<number>;
+    entityType: Nullable<TransactionEntityType>;
     paymentType: PaymentType;
     status: EntityStatus;
     createdOn: number;
@@ -454,6 +463,7 @@ declare class TransactionModel extends BaseEntityModel implements ITransactionEn
     protected constructor();
     static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
     static populateFromEntity(entity: ITransactionEntity): TransactionModel;
+    static toReferenceId(entityType: Nullable<TransactionEntityType> | undefined, referenceId: Nullable<number> | undefined): string;
     static toCashBookEntry(tx: TransactionModel): ICashBookEntry;
     static toCashBook(txns: TransactionModel[]): ICashBookEntry[];
 }
@@ -601,7 +611,7 @@ declare function diffArrays<T>(arr1: T[], arr2: T[]): {
  * grouped.get('keyValue2'); // [item3]
  */
 declare function groupBy<T>(items: T[], key: keyof T): Map<string, T[]>;
-declare function definedValues<T>(arr: Array<T | undefined | null>): T[];
+declare function definedValues<T>(arr: Array<Nullable<T> | undefined>): T[];
 /**
  * Converts an epoch timestamp (milliseconds) into a human-readable date string.
  *
@@ -619,7 +629,7 @@ declare function definedValues<T>(arr: Array<T | undefined | null>): T[];
  * epochToReadableDate(1700000000000, 'short-dt'); // "14/11/23 18:13"
  * epochToReadableDate(1700000000000);          // "2023-11-14T18:13:20.000Z"
  */
-declare function epochToReadableDate(epoch: number | string, format?: 'short' | 'long' | 'short-dt' | 'iso'): string;
+declare function epochToReadableDate(epoch: number | string, format?: "short" | "long" | "short-dt" | "iso"): string;
 
 declare function convertNumberToWords(num: number): string;
 
@@ -797,4 +807,4 @@ interface IConfigurationUpdateDto extends IEntityUpdateDto<EntityType<EntityList
 interface IConfigurationSearchDto extends IEntityFilterData<EntityType<EntityList.CONFIGURATION>> {
 }
 
-export { BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHistoryModel, ExpenseModel, ExpenseType, FLATS_BY_WING, FLAT_NUMBERS, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatModel, type FlatOption, type FlatParseResult, ForbiddenException, HttpException, type IAuditColumnEntity, type IBaseHistoryEntity, type ICashBookEntry, type IConfigurationCreateDto, type IConfigurationEntity, type IConfigurationSearchDto, type IConfigurationUpdateDto, type IDonationCreateDto, type IDonationEntity, type IDonationHistoryEntity, type IDonationSearchDto, type IDonationUpdateDto, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseCreateDto, type IExpenseEntity, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IMappingPropertyEntry, type IModelRelationConfig, type ISearchV2Response, type ISponsorCreateDto, type ISponsorEntity, type ISponsorHistoryEntity, type ISponsorSearchDto, type ISponsorUpdateDto, type ITransactionCreateDto, type ITransactionEntity, type ITransactionHistoryEntity, type ITransactionSearchDto, type ITransactionUpdateDto, type IUserCreateDto, type IUserEntity, type IUserHistoryEntity, type IUserSearchDto, type IUserUpdateDto, type IVendorCreateDto, type IVendorEntity, type IVendorHistoryEntity, type IVendorSearchDto, type IVendorUpdateDto, NotFoundException, type Nullable, OrderByDirection, PAYMENT_OPTIONS, PaymentType, ReferenceIdPrefix, RelationType, SPECIAL_FLATS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getObjectDiffingKeys, groupBy };
+export { BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHistoryModel, ExpenseModel, ExpenseType, FLATS_BY_WING, FLAT_NUMBERS, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatModel, type FlatOption, type FlatParseResult, ForbiddenException, HttpException, type IAuditColumnEntity, type IBaseHistoryEntity, type ICashBookEntry, type IConfigurationCreateDto, type IConfigurationEntity, type IConfigurationSearchDto, type IConfigurationUpdateDto, type IDonationCreateDto, type IDonationEntity, type IDonationHistoryEntity, type IDonationSearchDto, type IDonationUpdateDto, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseCreateDto, type IExpenseEntity, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IMappingPropertyEntry, type IModelRelationConfig, type ISearchV2Response, type ISponsorCreateDto, type ISponsorEntity, type ISponsorHistoryEntity, type ISponsorSearchDto, type ISponsorUpdateDto, type ITransactionCreateDto, type ITransactionEntity, type ITransactionHistoryEntity, type ITransactionSearchDto, type ITransactionUpdateDto, type IUserCreateDto, type IUserEntity, type IUserHistoryEntity, type IUserSearchDto, type IUserUpdateDto, type IVendorCreateDto, type IVendorEntity, type IVendorHistoryEntity, type IVendorSearchDto, type IVendorUpdateDto, NotFoundException, type Nullable, OrderByDirection, PAYMENT_OPTIONS, PaymentType, ReferenceIdPrefix, RelationType, SPECIAL_FLATS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getObjectDiffingKeys, groupBy };

package/dist/index.js

@@ -51,6 +51,7 @@ __export(index_exports, {
   SponsorHistoryModel: () => SponsorHistoryModel,
   SponsorModel: () => SponsorModel,
   SponsorTier: () => SponsorTier,
+  TransactionEntityType: () => TransactionEntityType,
   TransactionHistoryModel: () => TransactionHistoryModel,
   TransactionModel: () => TransactionModel,
   TransactionType: () => TransactionType,
@@ -475,6 +476,15 @@ var SponsorTier = /* @__PURE__ */ ((SponsorTier2) => {
   return SponsorTier2;
 })(SponsorTier || {});
 
+// src/enums/transaction-entity-type.enum.ts
+var TransactionEntityType = /* @__PURE__ */ ((TransactionEntityType3) => {
+  TransactionEntityType3["DONATION"] = "donation";
+  TransactionEntityType3["SPONSOR"] = "sponsor";
+  TransactionEntityType3["EXPENSE"] = "expense";
+  TransactionEntityType3["DAAN_PETI"] = "daan_peti";
+  return TransactionEntityType3;
+})(TransactionEntityType || {});
+
 // src/enums/transaction-type.enum.ts
 var TransactionType = /* @__PURE__ */ ((TransactionType2) => {
   TransactionType2["INCOME"] = "Income";
@@ -769,7 +779,9 @@ var _DonationModel = class _DonationModel extends BaseEntityModel {
     return `MPCR-${year}-${flatNo}`;
   }
   static generateReceiptNumber(flatNo, existingDonations) {
-    const count = existingDonations.filter((d) => d.flatNo === flatNo).length + 1;
+    const count = existingDonations.filter(
+      (d) => d.status === "Active" /* ACTIVE */ && d.flatNo === flatNo
+    ).length + 1;
     const seq = String(count).padStart(2, "0");
     return `${_DonationModel.getReceiptPrefix(flatNo)}-${seq}`;
   }
@@ -1122,7 +1134,8 @@ var _TransactionModel = class _TransactionModel extends BaseEntityModel {
     this.particulars = "";
     this.amount = 0;
     this.balanceAfter = 0;
-    this.referenceId = "";
+    this.referenceId = null;
+    this.entityType = null;
     this.paymentType = "Cash" /* CASH */;
     this.status = "Active" /* ACTIVE */;
     this.createdOn = 0;
@@ -1133,9 +1146,16 @@ var _TransactionModel = class _TransactionModel extends BaseEntityModel {
   static populateFromEntity(entity) {
     return Object.assign(new _TransactionModel(), entity, {
       amount: Number(entity.amount),
-      balanceAfter: Number(entity.balanceAfter)
+      balanceAfter: Number(entity.balanceAfter),
+      referenceId: entity.referenceId != null ? Number(entity.referenceId) : null
     });
   }
+  static toReferenceId(entityType, referenceId) {
+    if (entityType == null) {
+      return referenceId != null ? String(referenceId) : "";
+    }
+    return referenceId != null ? `${entityType}-${referenceId}` : entityType;
+  }
   static toCashBookEntry(tx) {
     const isExpense = tx.type === "Expense" /* EXPENSE */;
     return {
@@ -1144,7 +1164,10 @@ var _TransactionModel = class _TransactionModel extends BaseEntityModel {
       receipt: isExpense ? 0 : tx.amount,
       payment: isExpense ? tx.amount : 0,
       balance: tx.balanceAfter,
-      referenceId: tx.referenceId
+      referenceId: _TransactionModel.toReferenceId(
+        tx.entityType,
+        tx.referenceId
+      )
     };
   }
   static toCashBook(txns) {
@@ -1615,6 +1638,7 @@ var USER_RELATION_CONFIG = {
   SponsorHistoryModel,
   SponsorModel,
   SponsorTier,
+  TransactionEntityType,
   TransactionHistoryModel,
   TransactionModel,
   TransactionType,