@mody-park-cha-raja/finance_common 4.27.0 → 4.27.1-beta.0

package/README.md

@@ -0,0 +1,18 @@
+# Name
+### @mody-park-cha-raja/finance_common
+
+# Synopsis
+Common interfaces, models, enums, and utilities for the Mody Park Cha Raja finance ecosystem
+
+# Description
+
+# Example
+
+# Install:
+`npm install @mody-park-cha-raja/finance_common`
+
+# Test:
+`npm test`
+
+#License:
+ISC

package/dist/index.d.mts

@@ -1,8 +1,18 @@
 import * as XLSX from 'xlsx';
 
+/**
+ * @deprecated MPCR-60 — static flat data is being replaced by the persisted
+ * `flat` entity (see `models/flat.entity.model.ts` + `EntityList.FLAT`).
+ * Keep only as a seed/migration reference; do not add new usage.
+ * TODO MPCR-60 remove
+ */
+/** @deprecated Use FlatEntity from the database instead. Kept for migration reference. */
 declare const SPECIAL_FLATS: readonly string[];
+/** @deprecated Use FlatEntity from the database instead. Kept for migration reference. */
 declare const FLAT_NUMBERS: readonly string[];
+/** @deprecated Use FlatEntity from the database instead. Kept for migration reference. */
 declare const FLATS_BY_WING: ReadonlyMap<string, readonly string[]>;
+/** @deprecated Use FlatEntity from the database instead. Kept for migration reference. */
 declare const WINGS: readonly string[];
 
 declare enum ConfigurationKey {
@@ -137,6 +147,16 @@ interface IExpenseEntity extends IAuditColumnEntity {
     status?: EntityStatus;
 }
 
+interface IFlatHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface IFlatEntity extends IAuditColumnEntity {
+    id: number;
+    wing: string;
+    unitNumber: string;
+    status: EntityStatus;
+}
+
 interface ISponsorHistoryEntity extends IBaseHistoryEntity {
 }
 
@@ -351,6 +371,20 @@ declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
     get vendorName(): string;
 }
 
+declare class FlatHistoryModel extends BaseEntityModel implements IFlatHistoryEntity {
+    id: number;
+    entityId: number;
+    data: string;
+    operation: EntityHistoryOperation;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    protected constructor();
+    static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList.FLAT_HISTORY>>>;
+    static populateFromEntity(entity: IFlatHistoryEntity): FlatHistoryModel;
+}
+
 interface FlatDonationLike {
     flatNo: string;
     amount: number;
@@ -380,6 +414,15 @@ interface FlatOption {
     value: string;
 }
 declare class FlatModel {
+    id: number;
+    wing: string;
+    unitNumber: string;
+    status: EntityStatus;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    static populateFromEntity(entity: IFlatEntity): FlatModel;
     static readonly FLAT_NUMBERS: readonly string[];
     static readonly FLATS_BY_WING: ReadonlyMap<string, readonly string[]>;
     static readonly SPECIAL_FLATS: readonly string[];
@@ -528,6 +571,8 @@ declare const entityListEntityModelMap: {
     transaction_history: typeof TransactionHistoryModel.populateFromEntity;
     sponsor: typeof SponsorModel.populateFromEntity;
     sponsor_history: typeof SponsorHistoryModel.populateFromEntity;
+    flat: typeof FlatModel.populateFromEntity;
+    flat_history: typeof FlatHistoryModel.populateFromEntity;
     configuration: typeof ConfigurationModel.populateFromEntity;
 };
 
@@ -770,10 +815,12 @@ declare enum EntityList {
     TRANSACTION_HISTORY = "transaction_history",
     SPONSOR = "sponsor",
     SPONSOR_HISTORY = "sponsor_history",
+    FLAT = "flat",
+    FLAT_HISTORY = "flat_history",
     CONFIGURATION = "configuration"
 }
-type EntityType<T extends EntityList> = T extends EntityList.DONATION ? IDonationEntity : T extends EntityList.DONATION_HISTORY ? IDonationHistoryEntity : T extends EntityList.USER ? IUserEntity : T extends EntityList.USER_HISTORY ? IUserHistoryEntity : T extends EntityList.EXPENSE ? IExpenseEntity : T extends EntityList.EXPENSE_HISTORY ? IExpenseHistoryEntity : T extends EntityList.VENDOR ? IVendorEntity : T extends EntityList.VENDOR_HISTORY ? IVendorHistoryEntity : T extends EntityList.TRANSACTION ? ITransactionEntity : T extends EntityList.TRANSACTION_HISTORY ? ITransactionHistoryEntity : T extends EntityList.SPONSOR ? ISponsorEntity : T extends EntityList.SPONSOR_HISTORY ? ISponsorHistoryEntity : T extends EntityList.CONFIGURATION ? IConfigurationEntity : never;
-type EntityModelType<T extends EntityList> = T extends EntityList.DONATION ? DonationModel : T extends EntityList.DONATION_HISTORY ? DonationHistoryModel : T extends EntityList.USER ? UserModel : T extends EntityList.USER_HISTORY ? UserHistoryModel : T extends EntityList.EXPENSE ? ExpenseModel : T extends EntityList.EXPENSE_HISTORY ? ExpenseHistoryModel : T extends EntityList.VENDOR ? VendorModel : T extends EntityList.VENDOR_HISTORY ? VendorHistoryModel : T extends EntityList.TRANSACTION ? TransactionModel : T extends EntityList.TRANSACTION_HISTORY ? TransactionHistoryModel : T extends EntityList.SPONSOR ? SponsorModel : T extends EntityList.SPONSOR_HISTORY ? SponsorHistoryModel : T extends EntityList.CONFIGURATION ? ConfigurationModel : never;
+type EntityType<T extends EntityList> = T extends EntityList.DONATION ? IDonationEntity : T extends EntityList.DONATION_HISTORY ? IDonationHistoryEntity : T extends EntityList.USER ? IUserEntity : T extends EntityList.USER_HISTORY ? IUserHistoryEntity : T extends EntityList.EXPENSE ? IExpenseEntity : T extends EntityList.EXPENSE_HISTORY ? IExpenseHistoryEntity : T extends EntityList.VENDOR ? IVendorEntity : T extends EntityList.VENDOR_HISTORY ? IVendorHistoryEntity : T extends EntityList.TRANSACTION ? ITransactionEntity : T extends EntityList.TRANSACTION_HISTORY ? ITransactionHistoryEntity : T extends EntityList.SPONSOR ? ISponsorEntity : T extends EntityList.SPONSOR_HISTORY ? ISponsorHistoryEntity : T extends EntityList.FLAT ? IFlatEntity : T extends EntityList.FLAT_HISTORY ? IFlatHistoryEntity : T extends EntityList.CONFIGURATION ? IConfigurationEntity : never;
+type EntityModelType<T extends EntityList> = T extends EntityList.DONATION ? DonationModel : T extends EntityList.DONATION_HISTORY ? DonationHistoryModel : T extends EntityList.USER ? UserModel : T extends EntityList.USER_HISTORY ? UserHistoryModel : T extends EntityList.EXPENSE ? ExpenseModel : T extends EntityList.EXPENSE_HISTORY ? ExpenseHistoryModel : T extends EntityList.VENDOR ? VendorModel : T extends EntityList.VENDOR_HISTORY ? VendorHistoryModel : T extends EntityList.TRANSACTION ? TransactionModel : T extends EntityList.TRANSACTION_HISTORY ? TransactionHistoryModel : T extends EntityList.SPONSOR ? SponsorModel : T extends EntityList.SPONSOR_HISTORY ? SponsorHistoryModel : T extends EntityList.FLAT ? FlatModel : T extends EntityList.FLAT_HISTORY ? FlatHistoryModel : T extends EntityList.CONFIGURATION ? ConfigurationModel : never;
 type EntityListEntityModelMap = {
     [T in EntityList]: EntityModelType<T>[];
 };
@@ -895,4 +942,25 @@ interface IConfigurationUpdateDto extends IEntityUpdateDto<EntityType<EntityList
 interface IConfigurationSearchDto extends IEntityFilterData<EntityType<EntityList.CONFIGURATION>> {
 }
 
-export { ALL_WINGS_SELECTION, 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, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, 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, getObjectDiffingKeys, getWingSelectionLabel, getWingSelectionSlug, groupBy, serializeXlsx };
+interface IFlatCreateDto extends IEntityCreateDto<EntityType<EntityList.FLAT>> {
+}
+interface IFlatUpdateDto extends IEntityUpdateDto<EntityType<EntityList.FLAT>> {
+}
+interface IFlatSearchDto extends IEntityFilterData<EntityType<EntityList.FLAT>> {
+}
+
+declare const FLAT_WING_PATTERN: RegExp;
+declare const SHOP_WING = "SH";
+declare const SPECIAL_FLAT_LABELS: readonly ["Devotee", "Ex-Member Devotee", "Others"];
+declare const FLAT_UNIT_NUMBER_PATTERN: RegExp;
+declare const SHOP_UNIT_NUMBER_PATTERN: RegExp;
+type FlatValidationError = {
+    key: string;
+    message: string;
+};
+declare function isValidFlatWing(wing: string | null | undefined): boolean;
+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, ExpenseHistoryModel, ExpenseModel, ExpenseType, 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 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, 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, serializeXlsx, validateFlatOrThrow };

package/dist/index.d.ts

@@ -1,8 +1,18 @@
 import * as XLSX from 'xlsx';
 
+/**
+ * @deprecated MPCR-60 — static flat data is being replaced by the persisted
+ * `flat` entity (see `models/flat.entity.model.ts` + `EntityList.FLAT`).
+ * Keep only as a seed/migration reference; do not add new usage.
+ * TODO MPCR-60 remove
+ */
+/** @deprecated Use FlatEntity from the database instead. Kept for migration reference. */
 declare const SPECIAL_FLATS: readonly string[];
+/** @deprecated Use FlatEntity from the database instead. Kept for migration reference. */
 declare const FLAT_NUMBERS: readonly string[];
+/** @deprecated Use FlatEntity from the database instead. Kept for migration reference. */
 declare const FLATS_BY_WING: ReadonlyMap<string, readonly string[]>;
+/** @deprecated Use FlatEntity from the database instead. Kept for migration reference. */
 declare const WINGS: readonly string[];
 
 declare enum ConfigurationKey {
@@ -137,6 +147,16 @@ interface IExpenseEntity extends IAuditColumnEntity {
     status?: EntityStatus;
 }
 
+interface IFlatHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface IFlatEntity extends IAuditColumnEntity {
+    id: number;
+    wing: string;
+    unitNumber: string;
+    status: EntityStatus;
+}
+
 interface ISponsorHistoryEntity extends IBaseHistoryEntity {
 }
 
@@ -351,6 +371,20 @@ declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
     get vendorName(): string;
 }
 
+declare class FlatHistoryModel extends BaseEntityModel implements IFlatHistoryEntity {
+    id: number;
+    entityId: number;
+    data: string;
+    operation: EntityHistoryOperation;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    protected constructor();
+    static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList.FLAT_HISTORY>>>;
+    static populateFromEntity(entity: IFlatHistoryEntity): FlatHistoryModel;
+}
+
 interface FlatDonationLike {
     flatNo: string;
     amount: number;
@@ -380,6 +414,15 @@ interface FlatOption {
     value: string;
 }
 declare class FlatModel {
+    id: number;
+    wing: string;
+    unitNumber: string;
+    status: EntityStatus;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    static populateFromEntity(entity: IFlatEntity): FlatModel;
     static readonly FLAT_NUMBERS: readonly string[];
     static readonly FLATS_BY_WING: ReadonlyMap<string, readonly string[]>;
     static readonly SPECIAL_FLATS: readonly string[];
@@ -528,6 +571,8 @@ declare const entityListEntityModelMap: {
     transaction_history: typeof TransactionHistoryModel.populateFromEntity;
     sponsor: typeof SponsorModel.populateFromEntity;
     sponsor_history: typeof SponsorHistoryModel.populateFromEntity;
+    flat: typeof FlatModel.populateFromEntity;
+    flat_history: typeof FlatHistoryModel.populateFromEntity;
     configuration: typeof ConfigurationModel.populateFromEntity;
 };
 
@@ -770,10 +815,12 @@ declare enum EntityList {
     TRANSACTION_HISTORY = "transaction_history",
     SPONSOR = "sponsor",
     SPONSOR_HISTORY = "sponsor_history",
+    FLAT = "flat",
+    FLAT_HISTORY = "flat_history",
     CONFIGURATION = "configuration"
 }
-type EntityType<T extends EntityList> = T extends EntityList.DONATION ? IDonationEntity : T extends EntityList.DONATION_HISTORY ? IDonationHistoryEntity : T extends EntityList.USER ? IUserEntity : T extends EntityList.USER_HISTORY ? IUserHistoryEntity : T extends EntityList.EXPENSE ? IExpenseEntity : T extends EntityList.EXPENSE_HISTORY ? IExpenseHistoryEntity : T extends EntityList.VENDOR ? IVendorEntity : T extends EntityList.VENDOR_HISTORY ? IVendorHistoryEntity : T extends EntityList.TRANSACTION ? ITransactionEntity : T extends EntityList.TRANSACTION_HISTORY ? ITransactionHistoryEntity : T extends EntityList.SPONSOR ? ISponsorEntity : T extends EntityList.SPONSOR_HISTORY ? ISponsorHistoryEntity : T extends EntityList.CONFIGURATION ? IConfigurationEntity : never;
-type EntityModelType<T extends EntityList> = T extends EntityList.DONATION ? DonationModel : T extends EntityList.DONATION_HISTORY ? DonationHistoryModel : T extends EntityList.USER ? UserModel : T extends EntityList.USER_HISTORY ? UserHistoryModel : T extends EntityList.EXPENSE ? ExpenseModel : T extends EntityList.EXPENSE_HISTORY ? ExpenseHistoryModel : T extends EntityList.VENDOR ? VendorModel : T extends EntityList.VENDOR_HISTORY ? VendorHistoryModel : T extends EntityList.TRANSACTION ? TransactionModel : T extends EntityList.TRANSACTION_HISTORY ? TransactionHistoryModel : T extends EntityList.SPONSOR ? SponsorModel : T extends EntityList.SPONSOR_HISTORY ? SponsorHistoryModel : T extends EntityList.CONFIGURATION ? ConfigurationModel : never;
+type EntityType<T extends EntityList> = T extends EntityList.DONATION ? IDonationEntity : T extends EntityList.DONATION_HISTORY ? IDonationHistoryEntity : T extends EntityList.USER ? IUserEntity : T extends EntityList.USER_HISTORY ? IUserHistoryEntity : T extends EntityList.EXPENSE ? IExpenseEntity : T extends EntityList.EXPENSE_HISTORY ? IExpenseHistoryEntity : T extends EntityList.VENDOR ? IVendorEntity : T extends EntityList.VENDOR_HISTORY ? IVendorHistoryEntity : T extends EntityList.TRANSACTION ? ITransactionEntity : T extends EntityList.TRANSACTION_HISTORY ? ITransactionHistoryEntity : T extends EntityList.SPONSOR ? ISponsorEntity : T extends EntityList.SPONSOR_HISTORY ? ISponsorHistoryEntity : T extends EntityList.FLAT ? IFlatEntity : T extends EntityList.FLAT_HISTORY ? IFlatHistoryEntity : T extends EntityList.CONFIGURATION ? IConfigurationEntity : never;
+type EntityModelType<T extends EntityList> = T extends EntityList.DONATION ? DonationModel : T extends EntityList.DONATION_HISTORY ? DonationHistoryModel : T extends EntityList.USER ? UserModel : T extends EntityList.USER_HISTORY ? UserHistoryModel : T extends EntityList.EXPENSE ? ExpenseModel : T extends EntityList.EXPENSE_HISTORY ? ExpenseHistoryModel : T extends EntityList.VENDOR ? VendorModel : T extends EntityList.VENDOR_HISTORY ? VendorHistoryModel : T extends EntityList.TRANSACTION ? TransactionModel : T extends EntityList.TRANSACTION_HISTORY ? TransactionHistoryModel : T extends EntityList.SPONSOR ? SponsorModel : T extends EntityList.SPONSOR_HISTORY ? SponsorHistoryModel : T extends EntityList.FLAT ? FlatModel : T extends EntityList.FLAT_HISTORY ? FlatHistoryModel : T extends EntityList.CONFIGURATION ? ConfigurationModel : never;
 type EntityListEntityModelMap = {
     [T in EntityList]: EntityModelType<T>[];
 };
@@ -895,4 +942,25 @@ interface IConfigurationUpdateDto extends IEntityUpdateDto<EntityType<EntityList
 interface IConfigurationSearchDto extends IEntityFilterData<EntityType<EntityList.CONFIGURATION>> {
 }
 
-export { ALL_WINGS_SELECTION, 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, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, WINGS, 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, getObjectDiffingKeys, getWingSelectionLabel, getWingSelectionSlug, groupBy, serializeXlsx };
+interface IFlatCreateDto extends IEntityCreateDto<EntityType<EntityList.FLAT>> {
+}
+interface IFlatUpdateDto extends IEntityUpdateDto<EntityType<EntityList.FLAT>> {
+}
+interface IFlatSearchDto extends IEntityFilterData<EntityType<EntityList.FLAT>> {
+}
+
+declare const FLAT_WING_PATTERN: RegExp;
+declare const SHOP_WING = "SH";
+declare const SPECIAL_FLAT_LABELS: readonly ["Devotee", "Ex-Member Devotee", "Others"];
+declare const FLAT_UNIT_NUMBER_PATTERN: RegExp;
+declare const SHOP_UNIT_NUMBER_PATTERN: RegExp;
+type FlatValidationError = {
+    key: string;
+    message: string;
+};
+declare function isValidFlatWing(wing: string | null | undefined): boolean;
+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, ExpenseHistoryModel, ExpenseModel, ExpenseType, 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 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, 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, serializeXlsx, validateFlatOrThrow };

package/dist/index.js

@@ -49,6 +49,9 @@ __export(index_exports, {
   ExpenseType: () => ExpenseType,
   FLATS_BY_WING: () => FLATS_BY_WING,
   FLAT_NUMBERS: () => FLAT_NUMBERS,
+  FLAT_UNIT_NUMBER_PATTERN: () => FLAT_UNIT_NUMBER_PATTERN,
+  FLAT_WING_PATTERN: () => FLAT_WING_PATTERN,
+  FlatHistoryModel: () => FlatHistoryModel,
   FlatModel: () => FlatModel,
   ForbiddenException: () => ForbiddenException,
   HttpException: () => HttpException,
@@ -58,7 +61,10 @@ __export(index_exports, {
   PaymentType: () => PaymentType,
   ReferenceIdPrefix: () => ReferenceIdPrefix,
   RelationType: () => RelationType,
+  SHOP_UNIT_NUMBER_PATTERN: () => SHOP_UNIT_NUMBER_PATTERN,
+  SHOP_WING: () => SHOP_WING,
   SPECIAL_FLATS: () => SPECIAL_FLATS,
+  SPECIAL_FLAT_LABELS: () => SPECIAL_FLAT_LABELS,
   SponsorHistoryModel: () => SponsorHistoryModel,
   SponsorModel: () => SponsorModel,
   SponsorTier: () => SponsorTier,
@@ -84,11 +90,15 @@ __export(index_exports, {
   diffArrays: () => diffArrays,
   entityListEntityModelMap: () => entityListEntityModelMap,
   epochToReadableDate: () => epochToReadableDate,
+  getFlatValidationErrors: () => getFlatValidationErrors,
   getObjectDiffingKeys: () => getObjectDiffingKeys,
   getWingSelectionLabel: () => getWingSelectionLabel,
   getWingSelectionSlug: () => getWingSelectionSlug,
   groupBy: () => groupBy,
-  serializeXlsx: () => serializeXlsx
+  isSpecialFlatLabel: () => isSpecialFlatLabel,
+  isValidFlatWing: () => isValidFlatWing,
+  serializeXlsx: () => serializeXlsx,
+  validateFlatOrThrow: () => validateFlatOrThrow
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -898,6 +908,26 @@ _ExpenseModel.relations = {
 };
 var ExpenseModel = _ExpenseModel;
 
+// src/models/flat-history.entity.model.ts
+var _FlatHistoryModel = class _FlatHistoryModel extends BaseEntityModel {
+  constructor() {
+    super();
+    this.id = 0;
+    this.entityId = 0;
+    this.data = "";
+    this.operation = "CREATE" /* CREATE */;
+    this.createdOn = 0;
+    this.updatedOn = 0;
+    this.createdBy = 0;
+    this.updatedBy = 0;
+  }
+  static populateFromEntity(entity) {
+    return Object.assign(new _FlatHistoryModel(), entity);
+  }
+};
+_FlatHistoryModel.relations = {};
+var FlatHistoryModel = _FlatHistoryModel;
+
 // src/utils/numberToWords.ts
 function convertNumberToWords(num) {
   if (num === 0) return "Zero Rupees Only";
@@ -981,6 +1011,19 @@ function convertNumberToWords(num) {
 
 // src/models/flat.entity.model.ts
 var _FlatModel = class _FlatModel {
+  constructor() {
+    this.id = 0;
+    this.wing = "";
+    this.unitNumber = "";
+    this.status = "Active" /* ACTIVE */;
+    this.createdOn = 0;
+    this.updatedOn = 0;
+    this.createdBy = 0;
+    this.updatedBy = 0;
+  }
+  static populateFromEntity(entity) {
+    return Object.assign(new _FlatModel(), entity);
+  }
   static getDonationYear() {
     return (/* @__PURE__ */ new Date()).getFullYear();
   }
@@ -1350,6 +1393,8 @@ var EntityList = /* @__PURE__ */ ((EntityList2) => {
   EntityList2["TRANSACTION_HISTORY"] = "transaction_history";
   EntityList2["SPONSOR"] = "sponsor";
   EntityList2["SPONSOR_HISTORY"] = "sponsor_history";
+  EntityList2["FLAT"] = "flat";
+  EntityList2["FLAT_HISTORY"] = "flat_history";
   EntityList2["CONFIGURATION"] = "configuration";
   return EntityList2;
 })(EntityList || {});
@@ -1368,6 +1413,8 @@ var entityListEntityModelMap = {
   ["transaction_history" /* TRANSACTION_HISTORY */]: TransactionHistoryModel.populateFromEntity,
   ["sponsor" /* SPONSOR */]: SponsorModel.populateFromEntity,
   ["sponsor_history" /* SPONSOR_HISTORY */]: SponsorHistoryModel.populateFromEntity,
+  ["flat" /* FLAT */]: FlatModel.populateFromEntity,
+  ["flat_history" /* FLAT_HISTORY */]: FlatHistoryModel.populateFromEntity,
   ["configuration" /* CONFIGURATION */]: ConfigurationModel.populateFromEntity
 };
 
@@ -1855,6 +1902,79 @@ var USER_RELATION_CONFIG = {
   name: "user" /* USER */,
   columnKeys: ["id", "name"]
 };
+
+// src/validators/flat.validator.ts
+var FLAT_WING_PATTERN = /^[A-Z]$/;
+var SHOP_WING = "SH";
+var SPECIAL_FLAT_LABELS = [
+  "Devotee",
+  "Ex-Member Devotee",
+  "Others"
+];
+var FLAT_UNIT_NUMBER_PATTERN = /^[0-9]{1,3}[A-Za-z]?$/;
+var SHOP_UNIT_NUMBER_PATTERN = /^[0-9]{1,4}$/;
+function isValidFlatWing(wing) {
+  if (wing == null) return true;
+  if (wing === SHOP_WING) return true;
+  return FLAT_WING_PATTERN.test(wing);
+}
+function isSpecialFlatLabel(label) {
+  return SPECIAL_FLAT_LABELS.includes(label);
+}
+function getFlatValidationErrors(input) {
+  const errors = [];
+  const wing = input.wing ?? null;
+  const unitNumber = input.unitNumber ?? "";
+  if (!isValidFlatWing(wing)) {
+    errors.push({
+      key: "wing",
+      message: `Invalid wing "${input.wing}". Wing must be null, a single letter A-Z, or "${SHOP_WING}".`
+    });
+  }
+  if (unitNumber.length === 0) {
+    errors.push({
+      key: "unitNumber",
+      message: "unitNumber is required."
+    });
+    return errors;
+  }
+  if (wing == null) {
+    if (!isSpecialFlatLabel(unitNumber)) {
+      errors.push({
+        key: "unitNumber",
+        message: `Wing is null, so unitNumber must be one of the special flat labels: ${SPECIAL_FLAT_LABELS.join(", ")}.`
+      });
+    }
+  } else if (wing === SHOP_WING) {
+    if (!SHOP_UNIT_NUMBER_PATTERN.test(unitNumber)) {
+      errors.push({
+        key: "unitNumber",
+        message: `Invalid shop unitNumber "${unitNumber}". Must be numeric (e.g. "12").`
+      });
+    }
+  } else if (!FLAT_UNIT_NUMBER_PATTERN.test(unitNumber)) {
+    errors.push({
+      key: "unitNumber",
+      message: `Invalid flat unitNumber "${unitNumber}". Must match the format 1-3 digits with an optional letter suffix (e.g. "101", "101A").`
+    });
+  }
+  if (input.status != null && !Object.values(EntityStatus).includes(input.status)) {
+    errors.push({
+      key: "status",
+      message: `Invalid status "${input.status}". Allowed: ${Object.values(EntityStatus).join(", ")}.`
+    });
+  }
+  return errors;
+}
+function validateFlatOrThrow(input) {
+  const errors = getFlatValidationErrors(input);
+  if (errors.length > 0) {
+    throw new BadRequestException(
+      errors.map((e) => e.message),
+      errors
+    );
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ALL_WINGS_SELECTION,
@@ -1876,6 +1996,9 @@ var USER_RELATION_CONFIG = {
   ExpenseType,
   FLATS_BY_WING,
   FLAT_NUMBERS,
+  FLAT_UNIT_NUMBER_PATTERN,
+  FLAT_WING_PATTERN,
+  FlatHistoryModel,
   FlatModel,
   ForbiddenException,
   HttpException,
@@ -1885,7 +2008,10 @@ var USER_RELATION_CONFIG = {
   PaymentType,
   ReferenceIdPrefix,
   RelationType,
+  SHOP_UNIT_NUMBER_PATTERN,
+  SHOP_WING,
   SPECIAL_FLATS,
+  SPECIAL_FLAT_LABELS,
   SponsorHistoryModel,
   SponsorModel,
   SponsorTier,
@@ -1911,10 +2037,14 @@ var USER_RELATION_CONFIG = {
   diffArrays,
   entityListEntityModelMap,
   epochToReadableDate,
+  getFlatValidationErrors,
   getObjectDiffingKeys,
   getWingSelectionLabel,
   getWingSelectionSlug,
   groupBy,
-  serializeXlsx
+  isSpecialFlatLabel,
+  isValidFlatWing,
+  serializeXlsx,
+  validateFlatOrThrow
 });
 //# sourceMappingURL=index.js.map