@mody-park-cha-raja/finance_common 4.29.1-beta.8 → 4.30.0

package/dist/index.d.mts

@@ -157,31 +157,6 @@ interface IExpenseEntity extends IAuditColumnEntity {
 interface IFlatHistoryEntity extends IBaseHistoryEntity {
 }
 
-interface IFlatEntity extends IAuditColumnEntity {
-    id: number;
-    wing: string;
-    unitNumber: string;
-    status: EntityStatus;
-}
-
-interface ISponsorHistoryEntity extends IBaseHistoryEntity {
-}
-
-interface ISponsorEntity extends IAuditColumnEntity {
-    id: number;
-    sponsorName: string;
-    contactName: string;
-    contactNo: string;
-    sponsorFor: string;
-    size: string;
-    amount: number;
-    paymentType: PaymentType;
-    status?: EntityStatus;
-}
-
-interface ITransactionHistoryEntity extends IBaseHistoryEntity {
-}
-
 interface IDtoValidationError {
     key: string;
     message: string;
@@ -189,22 +164,6 @@ interface IDtoValidationError {
 
 type Nullable<T> = T | null;
 
-interface ITransactionEntity extends IAuditColumnEntity {
-    id: number;
-    date: string;
-    type: TransactionType;
-    particulars: string;
-    amount: number;
-    balanceAfter: number;
-    referenceId: Nullable<number>;
-    entityType?: Nullable<TransactionEntityType>;
-    paymentType: PaymentType;
-    status?: EntityStatus;
-}
-
-interface IUserHistoryEntity extends IBaseHistoryEntity {
-}
-
 /**
  * Utility class for validating date codes in `YYYYMMDD` format.
  *
@@ -258,6 +217,56 @@ interface ICashBookEntry {
     referenceId: string;
 }
 
+interface ISponsorHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface ISponsorEntity extends IAuditColumnEntity {
+    id: number;
+    sponsorName: string;
+    contactName: string;
+    contactNo: string;
+    sponsorFor: string;
+    size: string;
+    amount: number;
+    paymentType: PaymentType;
+    status?: EntityStatus;
+}
+
+interface ITransactionHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface ITransactionEntity extends IAuditColumnEntity {
+    id: number;
+    date: string;
+    type: TransactionType;
+    particulars: string;
+    amount: number;
+    balanceAfter: number;
+    referenceId: Nullable<number>;
+    entityType?: Nullable<TransactionEntityType>;
+    paymentType: PaymentType;
+    status?: EntityStatus;
+}
+
+interface IUserHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface IUserEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    password: string;
+    email: string;
+    phone: string;
+}
+/**
+ * This is a common config for user entity
+ * this will be used for createdBy & updatedBy
+ * for the tables
+ *
+ * Adding column keys reduce the bandwidth that is used
+ */
+declare const USER_RELATION_CONFIG: IEntityFilterSearchData<EntityList.USER>;
+
 interface IVendorHistoryEntity extends IBaseHistoryEntity {
 }
 
@@ -314,10 +323,16 @@ interface FlatDonationLike {
 type FlatCollectionStatus = "Paid" | "Pending";
 interface FlatCollectionEntry {
     flatNumber: string;
+    /** Flat entity id — present on entries built by computeCollectionStatusByFlatId. */
+    flatId?: number;
     status: FlatCollectionStatus;
     amount: number;
     latestDonation?: Nullable<FlatDonationLike>;
 }
+/** Donation shape matched by flat entity id (flatId-only reads). */
+interface FlatIdDonationLike extends Omit<FlatDonationLike, "flatNo"> {
+    flatId?: number | null;
+}
 interface FlatParseResult {
     wing?: string;
     num?: string;
@@ -377,10 +392,30 @@ declare class FlatModel extends BaseEntityModel implements IFlatEntity {
     static parseFlatNumber(flatNo: string, specials?: readonly string[]): FlatParseResult;
     static getFlatOptions(wing: string, specials?: readonly string[]): FlatOption[];
     static getDisplayLabel(wing: string, flatNo: string, specials?: readonly string[]): string;
+    /**
+     * Builds the display label ("A-101", or the special label itself) from a
+     * flat entity. Returns "" when no flat is available. This is the single
+     * source for donation-facing labels — the stored `donation.flatNo` string
+     * must never be read by application logic.
+     */
+    static getFlatLabel(flat?: Nullable<{
+        wing?: string | null;
+        unitNumber?: string;
+    }> | null): string;
     static computeCollectionStatus(donations: FlatDonationLike[], year: number, flats?: ReadonlyArray<{
         wing?: string | null;
         unitNumber: string;
     }>): FlatCollectionEntry[];
+    /**
+     * flatId-keyed variant of computeCollectionStatus — one entry per flat
+     * ENTITY (specials included by id), donations matched by `d.flatId`.
+     * Donations without a resolvable flatId are silently excluded.
+     */
+    static computeCollectionStatusByFlatId(flats: ReadonlyArray<{
+        id: number;
+        wing?: string | null;
+        unitNumber: string;
+    }>, donations: readonly FlatIdDonationLike[], year: number): FlatCollectionEntry[];
     static compareFlatNumbers(a: string, b: string, specials?: readonly string[]): number;
     static convertNumberToWords(num: number): string;
 }
@@ -419,6 +454,19 @@ declare class DonationModel extends BaseEntityModel implements IDonationEntity {
     static sumActiveDonations(donations: DonationModel[]): number;
     static getReceiptPrefix(flatNo: string): string;
     static generateReceiptNumber(flatNo: string, existingDonations: DonationModel[]): string;
+    /**
+     * flatId-keyed variant of generateReceiptNumber — sequence is counted per
+     * flat ENTITY id and the prefix label is derived from the flat itself
+     * (wing-unitNumber, or the special label). Never reads `donation.flatNo`.
+     */
+    static generateReceiptNumberForFlat(flat: {
+        id: number;
+        wing?: string | null;
+        unitNumber?: string;
+    }, existing: ReadonlyArray<{
+        flatId?: number | null;
+        status?: EntityStatus;
+    }>): string;
     static toWhatsAppNumber(mobile: string): string;
 }
 
@@ -870,6 +918,26 @@ type FlatScopeRow = {
 declare function getWingSelectionLabel(selection: string, specials?: readonly string[]): string;
 declare function getWingSelectionSlug(selection: string, specials?: readonly string[]): string;
 declare function buildWingWiseCollectionReport(donations: WingCollectionDonationLike[], year: number, selection: string, flats?: readonly FlatScopeRow[]): WingCollectionReport;
+/** Donation shape matched by flat entity id (flatId-only reads). */
+interface WingCollectionDonationByIdLike {
+    flatId?: Nullable<number>;
+    amount: number;
+    receiptNumber?: string;
+    paymentType?: string;
+    createdOn?: number;
+}
+type FlatIdScopeRow = {
+    id: number;
+    wing?: string | null;
+    unitNumber: string;
+};
+/**
+ * flatId-keyed variant of buildWingWiseCollectionReport — donations are
+ * grouped by their flat ENTITY id and labels derive from the flat itself.
+ * Donations without a resolvable flat are silently excluded. The flats list
+ * is required (ids cannot be inferred from statics).
+ */
+declare function buildWingWiseCollectionReportByFlatId(donations: WingCollectionDonationByIdLike[], year: number, selection: string, flats: readonly FlatIdScopeRow[]): WingCollectionReport;
 declare function buildWingWiseCollectionWorkbook(report: WingCollectionReport): XLSX.WorkBook;
 
 type XlsxSerializationType = 'base64' | 'array' | 'binary';
@@ -895,21 +963,18 @@ interface XlsxSheetInput {
 declare function buildXlsxWorkbook(sheets: XlsxSheetInput[]): XLSX.WorkBook;
 declare function serializeXlsx(workbook: XLSX.WorkBook, type: XlsxSerializationType): string | ArrayBuffer;
 
-interface IUserEntity extends IAuditColumnEntity {
+interface IFlatEntity extends IAuditColumnEntity {
     id: number;
-    name: string;
-    password: string;
-    email: string;
-    phone: string;
+    wing: string;
+    unitNumber: string;
+    status: EntityStatus;
 }
 /**
- * This is a common config for user entity
- * this will be used for createdBy & updatedBy
- * for the tables
- *
- * Adding column keys reduce the bandwidth that is used
+ * Relation entry for hydrating the flat referenced by a donation.
+ * Attach via searchV2 `relations` so donations carry their flat entity
+ * (label = wing-unitNumber, or unitNumber alone for specials).
  */
-declare const USER_RELATION_CONFIG: IEntityFilterSearchData<EntityList.USER>;
+declare const FLAT_DONATION_RELATION_CONFIG: IEntityFilterSearchData<EntityList.FLAT>;
 
 declare enum EntityList {
     DONATION = "donation",
@@ -1082,4 +1147,4 @@ declare function isSpecialFlatLabel(label: string): boolean;
 declare function getFlatValidationErrors(input: Partial<IFlatEntity>): FlatValidationError[];
 declare function validateFlatOrThrow(input: Partial<IFlatEntity>): void;
 
-export { ALL_WINGS_SELECTION, BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHeadHistoryModel, ExpenseHeadModel, ExpenseHistoryModel, ExpenseModel, FLATS_BY_WING, FLAT_NUMBERS, FLAT_UNIT_NUMBER_PATTERN, FLAT_WING_PATTERN, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatHistoryModel, FlatModel, type FlatOption, type FlatParseResult, type FlatValidationError, 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 IExpenseHeadCreateDto, type IExpenseHeadEntity, type IExpenseHeadHistoryEntity, type IExpenseHeadSearchDto, type IExpenseHeadUpdateDto, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IFlatCreateDto, type IFlatEntity, type IFlatHistoryEntity, type IFlatSearchDto, type IFlatUpdateDto, 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, SHOP_UNIT_NUMBER_PATTERN, SHOP_WING, SPECIAL_FLATS, SPECIAL_FLAT_LABELS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, WING_ALPHABETS, type WingCollectionDonationLike, type WingCollectionReport, type WingCollectionRow, type WingCollectionTotals, type XlsxCellAddress, type XlsxMergeRange, type XlsxSerializationType, type XlsxSheetInput, type XlsxSheetOptions, buildUserExpenseReport, buildUserExpenseWorkbook, buildWingWiseCollectionReport, buildWingWiseCollectionWorkbook, buildXlsxWorkbook, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getFlatValidationErrors, getObjectDiffingKeys, getWingSelectionLabel, getWingSelectionSlug, groupBy, isSpecialFlatLabel, isValidFlatWing, roundToTwoDecimals, serializeXlsx, validateFlatOrThrow };
+export { ALL_WINGS_SELECTION, BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHeadHistoryModel, ExpenseHeadModel, ExpenseHistoryModel, ExpenseModel, FLATS_BY_WING, FLAT_DONATION_RELATION_CONFIG, FLAT_NUMBERS, FLAT_UNIT_NUMBER_PATTERN, FLAT_WING_PATTERN, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatHistoryModel, type FlatIdDonationLike, FlatModel, type FlatOption, type FlatParseResult, type FlatValidationError, 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 IExpenseHeadCreateDto, type IExpenseHeadEntity, type IExpenseHeadHistoryEntity, type IExpenseHeadSearchDto, type IExpenseHeadUpdateDto, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IFlatCreateDto, type IFlatEntity, type IFlatHistoryEntity, type IFlatSearchDto, type IFlatUpdateDto, 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, SHOP_UNIT_NUMBER_PATTERN, SHOP_WING, SPECIAL_FLATS, SPECIAL_FLAT_LABELS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, WING_ALPHABETS, type WingCollectionDonationByIdLike, type WingCollectionDonationLike, type WingCollectionReport, type WingCollectionRow, type WingCollectionTotals, type XlsxCellAddress, type XlsxMergeRange, type XlsxSerializationType, type XlsxSheetInput, type XlsxSheetOptions, buildUserExpenseReport, buildUserExpenseWorkbook, buildWingWiseCollectionReport, buildWingWiseCollectionReportByFlatId, buildWingWiseCollectionWorkbook, buildXlsxWorkbook, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getFlatValidationErrors, getObjectDiffingKeys, getWingSelectionLabel, getWingSelectionSlug, groupBy, isSpecialFlatLabel, isValidFlatWing, roundToTwoDecimals, serializeXlsx, validateFlatOrThrow };

package/dist/index.d.ts

@@ -157,31 +157,6 @@ interface IExpenseEntity extends IAuditColumnEntity {
 interface IFlatHistoryEntity extends IBaseHistoryEntity {
 }
 
-interface IFlatEntity extends IAuditColumnEntity {
-    id: number;
-    wing: string;
-    unitNumber: string;
-    status: EntityStatus;
-}
-
-interface ISponsorHistoryEntity extends IBaseHistoryEntity {
-}
-
-interface ISponsorEntity extends IAuditColumnEntity {
-    id: number;
-    sponsorName: string;
-    contactName: string;
-    contactNo: string;
-    sponsorFor: string;
-    size: string;
-    amount: number;
-    paymentType: PaymentType;
-    status?: EntityStatus;
-}
-
-interface ITransactionHistoryEntity extends IBaseHistoryEntity {
-}
-
 interface IDtoValidationError {
     key: string;
     message: string;
@@ -189,22 +164,6 @@ interface IDtoValidationError {
 
 type Nullable<T> = T | null;
 
-interface ITransactionEntity extends IAuditColumnEntity {
-    id: number;
-    date: string;
-    type: TransactionType;
-    particulars: string;
-    amount: number;
-    balanceAfter: number;
-    referenceId: Nullable<number>;
-    entityType?: Nullable<TransactionEntityType>;
-    paymentType: PaymentType;
-    status?: EntityStatus;
-}
-
-interface IUserHistoryEntity extends IBaseHistoryEntity {
-}
-
 /**
  * Utility class for validating date codes in `YYYYMMDD` format.
  *
@@ -258,6 +217,56 @@ interface ICashBookEntry {
     referenceId: string;
 }
 
+interface ISponsorHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface ISponsorEntity extends IAuditColumnEntity {
+    id: number;
+    sponsorName: string;
+    contactName: string;
+    contactNo: string;
+    sponsorFor: string;
+    size: string;
+    amount: number;
+    paymentType: PaymentType;
+    status?: EntityStatus;
+}
+
+interface ITransactionHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface ITransactionEntity extends IAuditColumnEntity {
+    id: number;
+    date: string;
+    type: TransactionType;
+    particulars: string;
+    amount: number;
+    balanceAfter: number;
+    referenceId: Nullable<number>;
+    entityType?: Nullable<TransactionEntityType>;
+    paymentType: PaymentType;
+    status?: EntityStatus;
+}
+
+interface IUserHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface IUserEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    password: string;
+    email: string;
+    phone: string;
+}
+/**
+ * This is a common config for user entity
+ * this will be used for createdBy & updatedBy
+ * for the tables
+ *
+ * Adding column keys reduce the bandwidth that is used
+ */
+declare const USER_RELATION_CONFIG: IEntityFilterSearchData<EntityList.USER>;
+
 interface IVendorHistoryEntity extends IBaseHistoryEntity {
 }
 
@@ -314,10 +323,16 @@ interface FlatDonationLike {
 type FlatCollectionStatus = "Paid" | "Pending";
 interface FlatCollectionEntry {
     flatNumber: string;
+    /** Flat entity id — present on entries built by computeCollectionStatusByFlatId. */
+    flatId?: number;
     status: FlatCollectionStatus;
     amount: number;
     latestDonation?: Nullable<FlatDonationLike>;
 }
+/** Donation shape matched by flat entity id (flatId-only reads). */
+interface FlatIdDonationLike extends Omit<FlatDonationLike, "flatNo"> {
+    flatId?: number | null;
+}
 interface FlatParseResult {
     wing?: string;
     num?: string;
@@ -377,10 +392,30 @@ declare class FlatModel extends BaseEntityModel implements IFlatEntity {
     static parseFlatNumber(flatNo: string, specials?: readonly string[]): FlatParseResult;
     static getFlatOptions(wing: string, specials?: readonly string[]): FlatOption[];
     static getDisplayLabel(wing: string, flatNo: string, specials?: readonly string[]): string;
+    /**
+     * Builds the display label ("A-101", or the special label itself) from a
+     * flat entity. Returns "" when no flat is available. This is the single
+     * source for donation-facing labels — the stored `donation.flatNo` string
+     * must never be read by application logic.
+     */
+    static getFlatLabel(flat?: Nullable<{
+        wing?: string | null;
+        unitNumber?: string;
+    }> | null): string;
     static computeCollectionStatus(donations: FlatDonationLike[], year: number, flats?: ReadonlyArray<{
         wing?: string | null;
         unitNumber: string;
     }>): FlatCollectionEntry[];
+    /**
+     * flatId-keyed variant of computeCollectionStatus — one entry per flat
+     * ENTITY (specials included by id), donations matched by `d.flatId`.
+     * Donations without a resolvable flatId are silently excluded.
+     */
+    static computeCollectionStatusByFlatId(flats: ReadonlyArray<{
+        id: number;
+        wing?: string | null;
+        unitNumber: string;
+    }>, donations: readonly FlatIdDonationLike[], year: number): FlatCollectionEntry[];
     static compareFlatNumbers(a: string, b: string, specials?: readonly string[]): number;
     static convertNumberToWords(num: number): string;
 }
@@ -419,6 +454,19 @@ declare class DonationModel extends BaseEntityModel implements IDonationEntity {
     static sumActiveDonations(donations: DonationModel[]): number;
     static getReceiptPrefix(flatNo: string): string;
     static generateReceiptNumber(flatNo: string, existingDonations: DonationModel[]): string;
+    /**
+     * flatId-keyed variant of generateReceiptNumber — sequence is counted per
+     * flat ENTITY id and the prefix label is derived from the flat itself
+     * (wing-unitNumber, or the special label). Never reads `donation.flatNo`.
+     */
+    static generateReceiptNumberForFlat(flat: {
+        id: number;
+        wing?: string | null;
+        unitNumber?: string;
+    }, existing: ReadonlyArray<{
+        flatId?: number | null;
+        status?: EntityStatus;
+    }>): string;
     static toWhatsAppNumber(mobile: string): string;
 }
 
@@ -870,6 +918,26 @@ type FlatScopeRow = {
 declare function getWingSelectionLabel(selection: string, specials?: readonly string[]): string;
 declare function getWingSelectionSlug(selection: string, specials?: readonly string[]): string;
 declare function buildWingWiseCollectionReport(donations: WingCollectionDonationLike[], year: number, selection: string, flats?: readonly FlatScopeRow[]): WingCollectionReport;
+/** Donation shape matched by flat entity id (flatId-only reads). */
+interface WingCollectionDonationByIdLike {
+    flatId?: Nullable<number>;
+    amount: number;
+    receiptNumber?: string;
+    paymentType?: string;
+    createdOn?: number;
+}
+type FlatIdScopeRow = {
+    id: number;
+    wing?: string | null;
+    unitNumber: string;
+};
+/**
+ * flatId-keyed variant of buildWingWiseCollectionReport — donations are
+ * grouped by their flat ENTITY id and labels derive from the flat itself.
+ * Donations without a resolvable flat are silently excluded. The flats list
+ * is required (ids cannot be inferred from statics).
+ */
+declare function buildWingWiseCollectionReportByFlatId(donations: WingCollectionDonationByIdLike[], year: number, selection: string, flats: readonly FlatIdScopeRow[]): WingCollectionReport;
 declare function buildWingWiseCollectionWorkbook(report: WingCollectionReport): XLSX.WorkBook;
 
 type XlsxSerializationType = 'base64' | 'array' | 'binary';
@@ -895,21 +963,18 @@ interface XlsxSheetInput {
 declare function buildXlsxWorkbook(sheets: XlsxSheetInput[]): XLSX.WorkBook;
 declare function serializeXlsx(workbook: XLSX.WorkBook, type: XlsxSerializationType): string | ArrayBuffer;
 
-interface IUserEntity extends IAuditColumnEntity {
+interface IFlatEntity extends IAuditColumnEntity {
     id: number;
-    name: string;
-    password: string;
-    email: string;
-    phone: string;
+    wing: string;
+    unitNumber: string;
+    status: EntityStatus;
 }
 /**
- * This is a common config for user entity
- * this will be used for createdBy & updatedBy
- * for the tables
- *
- * Adding column keys reduce the bandwidth that is used
+ * Relation entry for hydrating the flat referenced by a donation.
+ * Attach via searchV2 `relations` so donations carry their flat entity
+ * (label = wing-unitNumber, or unitNumber alone for specials).
  */
-declare const USER_RELATION_CONFIG: IEntityFilterSearchData<EntityList.USER>;
+declare const FLAT_DONATION_RELATION_CONFIG: IEntityFilterSearchData<EntityList.FLAT>;
 
 declare enum EntityList {
     DONATION = "donation",
@@ -1082,4 +1147,4 @@ declare function isSpecialFlatLabel(label: string): boolean;
 declare function getFlatValidationErrors(input: Partial<IFlatEntity>): FlatValidationError[];
 declare function validateFlatOrThrow(input: Partial<IFlatEntity>): void;
 
-export { ALL_WINGS_SELECTION, BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHeadHistoryModel, ExpenseHeadModel, ExpenseHistoryModel, ExpenseModel, FLATS_BY_WING, FLAT_NUMBERS, FLAT_UNIT_NUMBER_PATTERN, FLAT_WING_PATTERN, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatHistoryModel, FlatModel, type FlatOption, type FlatParseResult, type FlatValidationError, 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 IExpenseHeadCreateDto, type IExpenseHeadEntity, type IExpenseHeadHistoryEntity, type IExpenseHeadSearchDto, type IExpenseHeadUpdateDto, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IFlatCreateDto, type IFlatEntity, type IFlatHistoryEntity, type IFlatSearchDto, type IFlatUpdateDto, 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, SHOP_UNIT_NUMBER_PATTERN, SHOP_WING, SPECIAL_FLATS, SPECIAL_FLAT_LABELS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, WING_ALPHABETS, type WingCollectionDonationLike, type WingCollectionReport, type WingCollectionRow, type WingCollectionTotals, type XlsxCellAddress, type XlsxMergeRange, type XlsxSerializationType, type XlsxSheetInput, type XlsxSheetOptions, buildUserExpenseReport, buildUserExpenseWorkbook, buildWingWiseCollectionReport, buildWingWiseCollectionWorkbook, buildXlsxWorkbook, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getFlatValidationErrors, getObjectDiffingKeys, getWingSelectionLabel, getWingSelectionSlug, groupBy, isSpecialFlatLabel, isValidFlatWing, roundToTwoDecimals, serializeXlsx, validateFlatOrThrow };
+export { ALL_WINGS_SELECTION, BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHeadHistoryModel, ExpenseHeadModel, ExpenseHistoryModel, ExpenseModel, FLATS_BY_WING, FLAT_DONATION_RELATION_CONFIG, FLAT_NUMBERS, FLAT_UNIT_NUMBER_PATTERN, FLAT_WING_PATTERN, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatHistoryModel, type FlatIdDonationLike, FlatModel, type FlatOption, type FlatParseResult, type FlatValidationError, 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 IExpenseHeadCreateDto, type IExpenseHeadEntity, type IExpenseHeadHistoryEntity, type IExpenseHeadSearchDto, type IExpenseHeadUpdateDto, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IFlatCreateDto, type IFlatEntity, type IFlatHistoryEntity, type IFlatSearchDto, type IFlatUpdateDto, 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, SHOP_UNIT_NUMBER_PATTERN, SHOP_WING, SPECIAL_FLATS, SPECIAL_FLAT_LABELS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, WING_ALPHABETS, type WingCollectionDonationByIdLike, type WingCollectionDonationLike, type WingCollectionReport, type WingCollectionRow, type WingCollectionTotals, type XlsxCellAddress, type XlsxMergeRange, type XlsxSerializationType, type XlsxSheetInput, type XlsxSheetOptions, buildUserExpenseReport, buildUserExpenseWorkbook, buildWingWiseCollectionReport, buildWingWiseCollectionReportByFlatId, buildWingWiseCollectionWorkbook, buildXlsxWorkbook, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getFlatValidationErrors, getObjectDiffingKeys, getWingSelectionLabel, getWingSelectionSlug, groupBy, isSpecialFlatLabel, isValidFlatWing, roundToTwoDecimals, serializeXlsx, validateFlatOrThrow };