@mody-park-cha-raja/finance_common 4.18.0 → 4.19.0

package/dist/index.d.mts

@@ -1,3 +1,8 @@
+declare const SPECIAL_FLATS: readonly string[];
+declare const FLAT_NUMBERS: readonly string[];
+declare const FLATS_BY_WING: ReadonlyMap<string, readonly string[]>;
+declare const WINGS: readonly string[];
+
 declare enum ConfigurationKey {
     OPENING_BALANCE = "opening_balance",
     EDIT_ALLOWANCE_PERIOD = "edit_allowance_period",
@@ -312,6 +317,50 @@ declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
     get incurredByUserName(): string | undefined;
 }
 
+interface FlatDonationLike {
+    flatNo: string;
+    amount: number;
+    donationYear?: number;
+    createdOn?: number;
+    createdByUser?: {
+        name?: string;
+    } | null;
+    updatedByUser?: {
+        name?: string;
+    } | null;
+}
+type FlatCollectionStatus = "Paid" | "Pending";
+interface FlatCollectionEntry {
+    flatNumber: string;
+    status: FlatCollectionStatus;
+    amount: number;
+    latestDonation?: FlatDonationLike | null;
+}
+interface FlatParseResult {
+    wing?: string;
+    num?: string;
+    isSpecial: boolean;
+}
+interface FlatOption {
+    label: string;
+    value: string;
+}
+declare class FlatModel {
+    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[];
+    static getDonationYear(): number;
+    static buildFlatNumber(wing: string, num: string): string;
+    static isSpecialFlat(flatNo: string): boolean;
+    static parseFlatNumber(flatNo: string): FlatParseResult;
+    static getFlatOptions(wing: string): FlatOption[];
+    static getDisplayLabel(wing: string, flatNo: string): string;
+    static computeCollectionStatus(donations: FlatDonationLike[], year: number): FlatCollectionEntry[];
+    static compareFlatNumbers(a: string, b: string): number;
+    static convertNumberToWords(num: number): string;
+}
+
 declare class SponsorHistoryModel extends BaseEntityModel implements ISponsorHistoryEntity {
     id: number;
     entityId: number;
@@ -563,6 +612,8 @@ declare function definedValues<T>(arr: Array<T | undefined | null>): T[];
  */
 declare function epochToReadableDate(epoch: number | string, format?: 'short' | 'long' | 'short-dt' | 'iso'): string;
 
+declare function convertNumberToWords(num: number): string;
+
 declare enum RelationType {
     ONE = "ONE",
     MANY = "MANY"
@@ -737,4 +788,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, 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, PaymentType, ReferenceIdPrefix, RelationType, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, 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, 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 };

package/dist/index.d.ts

@@ -1,3 +1,8 @@
+declare const SPECIAL_FLATS: readonly string[];
+declare const FLAT_NUMBERS: readonly string[];
+declare const FLATS_BY_WING: ReadonlyMap<string, readonly string[]>;
+declare const WINGS: readonly string[];
+
 declare enum ConfigurationKey {
     OPENING_BALANCE = "opening_balance",
     EDIT_ALLOWANCE_PERIOD = "edit_allowance_period",
@@ -312,6 +317,50 @@ declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
     get incurredByUserName(): string | undefined;
 }
 
+interface FlatDonationLike {
+    flatNo: string;
+    amount: number;
+    donationYear?: number;
+    createdOn?: number;
+    createdByUser?: {
+        name?: string;
+    } | null;
+    updatedByUser?: {
+        name?: string;
+    } | null;
+}
+type FlatCollectionStatus = "Paid" | "Pending";
+interface FlatCollectionEntry {
+    flatNumber: string;
+    status: FlatCollectionStatus;
+    amount: number;
+    latestDonation?: FlatDonationLike | null;
+}
+interface FlatParseResult {
+    wing?: string;
+    num?: string;
+    isSpecial: boolean;
+}
+interface FlatOption {
+    label: string;
+    value: string;
+}
+declare class FlatModel {
+    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[];
+    static getDonationYear(): number;
+    static buildFlatNumber(wing: string, num: string): string;
+    static isSpecialFlat(flatNo: string): boolean;
+    static parseFlatNumber(flatNo: string): FlatParseResult;
+    static getFlatOptions(wing: string): FlatOption[];
+    static getDisplayLabel(wing: string, flatNo: string): string;
+    static computeCollectionStatus(donations: FlatDonationLike[], year: number): FlatCollectionEntry[];
+    static compareFlatNumbers(a: string, b: string): number;
+    static convertNumberToWords(num: number): string;
+}
+
 declare class SponsorHistoryModel extends BaseEntityModel implements ISponsorHistoryEntity {
     id: number;
     entityId: number;
@@ -563,6 +612,8 @@ declare function definedValues<T>(arr: Array<T | undefined | null>): T[];
  */
 declare function epochToReadableDate(epoch: number | string, format?: 'short' | 'long' | 'short-dt' | 'iso'): string;
 
+declare function convertNumberToWords(num: number): string;
+
 declare enum RelationType {
     ONE = "ONE",
     MANY = "MANY"
@@ -737,4 +788,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, 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, PaymentType, ReferenceIdPrefix, RelationType, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, UserHistoryModel, UserModel, VendorHistoryModel, VendorModel, VendorType, 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, 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 };