@mody-park-cha-raja/finance_common 4.29.1-beta.2 → 4.29.1-beta.4

package/dist/index.d.mts

@@ -14,6 +14,12 @@ declare const FLAT_NUMBERS: readonly string[];
 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[];
+/**
+ * All single-letter wing alphabets (A–Z) available for Flat entity creation.
+ * Unlike the deprecated static WINGS (A–I seed), this covers every letter the
+ * FLAT_WING_PATTERN accepts, so new societies are not limited to the seeded set.
+ */
+declare const WING_ALPHABETS: readonly string[];
 
 declare enum ConfigurationKey {
     OPENING_BALANCE = "opening_balance",
@@ -321,7 +327,7 @@ interface FlatOption {
     label: string;
     value: string;
 }
-declare class FlatModel {
+declare class FlatModel extends BaseEntityModel implements IFlatEntity {
     id: number;
     wing: string;
     unitNumber: string;
@@ -334,11 +340,19 @@ declare class FlatModel {
     createdByUser?: UserModel;
     updatedByUser?: UserModel;
     donations?: DonationModel[];
+    /**
+     * True when at least one donation has been received against this flat.
+     * Expects the donations relation populated — when fetched server-side
+     * scoped to status = Active, this means an active donation exists.
+     */
+    isDonationReceived(): boolean;
     static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
     static readonly FLAT_NUMBERS: readonly string[];
     static readonly FLATS_BY_WING: ReadonlyMap<string, readonly string[]>;
     static readonly SPECIAL_FLATS: readonly string[];
     static readonly WINGS: readonly string[];
+    /** A–Z — every single-letter wing available for Flat entity creation. */
+    static readonly WING_ALPHABETS: readonly string[];
     static getDonationYear(): number;
     static getTotalFlats(): number;
     static getWingsFromFlats(flats: ReadonlyArray<{
@@ -1068,4 +1082,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, 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_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 };

package/dist/index.d.ts

@@ -14,6 +14,12 @@ declare const FLAT_NUMBERS: readonly string[];
 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[];
+/**
+ * All single-letter wing alphabets (A–Z) available for Flat entity creation.
+ * Unlike the deprecated static WINGS (A–I seed), this covers every letter the
+ * FLAT_WING_PATTERN accepts, so new societies are not limited to the seeded set.
+ */
+declare const WING_ALPHABETS: readonly string[];
 
 declare enum ConfigurationKey {
     OPENING_BALANCE = "opening_balance",
@@ -321,7 +327,7 @@ interface FlatOption {
     label: string;
     value: string;
 }
-declare class FlatModel {
+declare class FlatModel extends BaseEntityModel implements IFlatEntity {
     id: number;
     wing: string;
     unitNumber: string;
@@ -334,11 +340,19 @@ declare class FlatModel {
     createdByUser?: UserModel;
     updatedByUser?: UserModel;
     donations?: DonationModel[];
+    /**
+     * True when at least one donation has been received against this flat.
+     * Expects the donations relation populated — when fetched server-side
+     * scoped to status = Active, this means an active donation exists.
+     */
+    isDonationReceived(): boolean;
     static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
     static readonly FLAT_NUMBERS: readonly string[];
     static readonly FLATS_BY_WING: ReadonlyMap<string, readonly string[]>;
     static readonly SPECIAL_FLATS: readonly string[];
     static readonly WINGS: readonly string[];
+    /** A–Z — every single-letter wing available for Flat entity creation. */
+    static readonly WING_ALPHABETS: readonly string[];
     static getDonationYear(): number;
     static getTotalFlats(): number;
     static getWingsFromFlats(flats: ReadonlyArray<{
@@ -1068,4 +1082,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, 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_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 };

package/dist/index.js

@@ -81,6 +81,7 @@ __export(index_exports, {
   VendorModel: () => VendorModel,
   VendorType: () => VendorType,
   WINGS: () => WINGS,
+  WING_ALPHABETS: () => WING_ALPHABETS,
   buildUserExpenseReport: () => buildUserExpenseReport,
   buildUserExpenseWorkbook: () => buildUserExpenseWorkbook,
   buildWingWiseCollectionReport: () => buildWingWiseCollectionReport,
@@ -439,6 +440,10 @@ var WINGS = (() => {
   }
   return wings;
 })();
+var WING_ALPHABETS = Array.from(
+  { length: 26 },
+  (_, i) => String.fromCharCode(65 + i)
+);
 
 // src/enums/configuration-key.enum.ts
 var ConfigurationKey = /* @__PURE__ */ ((ConfigurationKey2) => {
@@ -1091,8 +1096,9 @@ function convertNumberToWords(num) {
 }
 
 // src/models/flat.entity.model.ts
-var _FlatModel = class _FlatModel {
+var _FlatModel = class _FlatModel extends BaseEntityModel {
   constructor() {
+    super(...arguments);
     this.id = 0;
     this.wing = "";
     this.unitNumber = "";
@@ -1105,6 +1111,14 @@ var _FlatModel = class _FlatModel {
   static populateFromEntity(entity) {
     return Object.assign(new _FlatModel(), entity);
   }
+  /**
+   * True when at least one donation has been received against this flat.
+   * Expects the donations relation populated — when fetched server-side
+   * scoped to status = Active, this means an active donation exists.
+   */
+  isDonationReceived() {
+    return (this.donations?.length ?? 0) > 0;
+  }
   static getDonationYear() {
     return (/* @__PURE__ */ new Date()).getFullYear();
   }
@@ -1128,7 +1142,10 @@ var _FlatModel = class _FlatModel {
   static getFlatOptionsFromFlats(flats, wing) {
     const specials = _FlatModel.getSpecialsFromFlats(flats);
     return [
-      ...flats.filter((f) => f.wing === wing).map((f) => ({ label: `${wing}-${f.unitNumber}`, value: f.unitNumber })),
+      ...flats.filter((f) => f.wing === wing).map((f) => ({
+        label: `${wing}-${f.unitNumber}`,
+        value: f.unitNumber
+      })),
       ...specials.map((label) => ({ label, value: label }))
     ];
   }
@@ -1240,6 +1257,8 @@ _FlatModel.FLAT_NUMBERS = FLAT_NUMBERS;
 _FlatModel.FLATS_BY_WING = FLATS_BY_WING;
 _FlatModel.SPECIAL_FLATS = SPECIAL_FLATS;
 _FlatModel.WINGS = WINGS;
+/** A–Z — every single-letter wing available for Flat entity creation. */
+_FlatModel.WING_ALPHABETS = WING_ALPHABETS;
 var FlatModel = _FlatModel;
 
 // src/models/sponsor-history.entity.model.ts
@@ -2219,6 +2238,7 @@ function validateFlatOrThrow(input) {
   VendorModel,
   VendorType,
   WINGS,
+  WING_ALPHABETS,
   buildUserExpenseReport,
   buildUserExpenseWorkbook,
   buildWingWiseCollectionReport,