@mody-park-cha-raja/finance_common 4.29.0 → 4.29.1-beta.1

package/README.md

@@ -1,18 +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
+# 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

@@ -113,6 +113,7 @@ interface IDonationEntity extends IAuditColumnEntity {
     receiptNumber: string;
     flatNo: string;
     name?: string;
+    flatId: number;
     amount: number;
     mobileNumber?: string;
     paymentType: PaymentType;
@@ -292,11 +293,90 @@ declare class UserModel extends BaseEntityModel implements IUserEntity {
     static populateFromEntity(entity: IUserEntity): UserModel;
 }
 
+interface FlatDonationLike {
+    flatNo: string;
+    amount: number;
+    donationYear?: number;
+    createdOn?: number;
+    createdByUser?: Nullable<{
+        name?: string;
+    }>;
+    updatedByUser?: Nullable<{
+        name?: string;
+    }>;
+}
+type FlatCollectionStatus = "Paid" | "Pending";
+interface FlatCollectionEntry {
+    flatNumber: string;
+    status: FlatCollectionStatus;
+    amount: number;
+    latestDonation?: Nullable<FlatDonationLike>;
+}
+interface FlatParseResult {
+    wing?: string;
+    num?: string;
+    isSpecial: boolean;
+}
+interface FlatOption {
+    label: string;
+    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;
+    createdByUser?: UserModel;
+    updatedByUser?: UserModel;
+    donations?: DonationModel[];
+    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[];
+    static getDonationYear(): number;
+    static getTotalFlats(): number;
+    static getWingsFromFlats(flats: ReadonlyArray<{
+        wing?: string | null;
+    }>): string[];
+    static getSpecialsFromFlats(flats: ReadonlyArray<{
+        wing?: string | null;
+        unitNumber: string;
+    }>): string[];
+    static getRegularFlatCount(flats: ReadonlyArray<{
+        wing?: string | null;
+    }>): number;
+    static getWingFlatCount(flats: ReadonlyArray<{
+        wing?: string | null;
+    }>, wing: string): number;
+    static getFlatOptionsFromFlats(flats: ReadonlyArray<{
+        wing?: string | null;
+        unitNumber: string;
+    }>, wing: string): FlatOption[];
+    static buildFlatNumber(wing: string, num: string): string;
+    static isSpecialFlat(flatNo: string, specials?: readonly string[]): boolean;
+    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;
+    static computeCollectionStatus(donations: FlatDonationLike[], year: number, flats?: ReadonlyArray<{
+        wing?: string | null;
+        unitNumber: string;
+    }>): FlatCollectionEntry[];
+    static compareFlatNumbers(a: string, b: string, specials?: readonly string[]): number;
+    static convertNumberToWords(num: number): string;
+}
+
 declare class DonationModel extends BaseEntityModel implements IDonationEntity {
     id: number;
     receiptNumber: string;
     flatNo: string;
     name?: string;
+    flatId: number;
     amount: number;
     mobileNumber?: string;
     paymentType: PaymentType;
@@ -308,6 +388,7 @@ declare class DonationModel extends BaseEntityModel implements IDonationEntity {
     updatedBy: number;
     createdByUser?: UserModel;
     updatedByUser?: UserModel;
+    flat?: FlatModel;
     protected constructor();
     static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
     static populateFromEntity(entity: IDonationEntity): DonationModel;
@@ -432,60 +513,6 @@ declare class FlatHistoryModel extends BaseEntityModel implements IFlatHistoryEn
     static populateFromEntity(entity: IFlatHistoryEntity): FlatHistoryModel;
 }
 
-interface FlatDonationLike {
-    flatNo: string;
-    amount: number;
-    donationYear?: number;
-    createdOn?: number;
-    createdByUser?: Nullable<{
-        name?: string;
-    }>;
-    updatedByUser?: Nullable<{
-        name?: string;
-    }>;
-}
-type FlatCollectionStatus = "Paid" | "Pending";
-interface FlatCollectionEntry {
-    flatNumber: string;
-    status: FlatCollectionStatus;
-    amount: number;
-    latestDonation?: Nullable<FlatDonationLike>;
-}
-interface FlatParseResult {
-    wing?: string;
-    num?: string;
-    isSpecial: boolean;
-}
-interface FlatOption {
-    label: string;
-    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[];
-    static readonly WINGS: readonly string[];
-    static getDonationYear(): number;
-    static getTotalFlats(): 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;

package/dist/index.d.ts

@@ -113,6 +113,7 @@ interface IDonationEntity extends IAuditColumnEntity {
     receiptNumber: string;
     flatNo: string;
     name?: string;
+    flatId: number;
     amount: number;
     mobileNumber?: string;
     paymentType: PaymentType;
@@ -292,11 +293,90 @@ declare class UserModel extends BaseEntityModel implements IUserEntity {
     static populateFromEntity(entity: IUserEntity): UserModel;
 }
 
+interface FlatDonationLike {
+    flatNo: string;
+    amount: number;
+    donationYear?: number;
+    createdOn?: number;
+    createdByUser?: Nullable<{
+        name?: string;
+    }>;
+    updatedByUser?: Nullable<{
+        name?: string;
+    }>;
+}
+type FlatCollectionStatus = "Paid" | "Pending";
+interface FlatCollectionEntry {
+    flatNumber: string;
+    status: FlatCollectionStatus;
+    amount: number;
+    latestDonation?: Nullable<FlatDonationLike>;
+}
+interface FlatParseResult {
+    wing?: string;
+    num?: string;
+    isSpecial: boolean;
+}
+interface FlatOption {
+    label: string;
+    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;
+    createdByUser?: UserModel;
+    updatedByUser?: UserModel;
+    donations?: DonationModel[];
+    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[];
+    static getDonationYear(): number;
+    static getTotalFlats(): number;
+    static getWingsFromFlats(flats: ReadonlyArray<{
+        wing?: string | null;
+    }>): string[];
+    static getSpecialsFromFlats(flats: ReadonlyArray<{
+        wing?: string | null;
+        unitNumber: string;
+    }>): string[];
+    static getRegularFlatCount(flats: ReadonlyArray<{
+        wing?: string | null;
+    }>): number;
+    static getWingFlatCount(flats: ReadonlyArray<{
+        wing?: string | null;
+    }>, wing: string): number;
+    static getFlatOptionsFromFlats(flats: ReadonlyArray<{
+        wing?: string | null;
+        unitNumber: string;
+    }>, wing: string): FlatOption[];
+    static buildFlatNumber(wing: string, num: string): string;
+    static isSpecialFlat(flatNo: string, specials?: readonly string[]): boolean;
+    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;
+    static computeCollectionStatus(donations: FlatDonationLike[], year: number, flats?: ReadonlyArray<{
+        wing?: string | null;
+        unitNumber: string;
+    }>): FlatCollectionEntry[];
+    static compareFlatNumbers(a: string, b: string, specials?: readonly string[]): number;
+    static convertNumberToWords(num: number): string;
+}
+
 declare class DonationModel extends BaseEntityModel implements IDonationEntity {
     id: number;
     receiptNumber: string;
     flatNo: string;
     name?: string;
+    flatId: number;
     amount: number;
     mobileNumber?: string;
     paymentType: PaymentType;
@@ -308,6 +388,7 @@ declare class DonationModel extends BaseEntityModel implements IDonationEntity {
     updatedBy: number;
     createdByUser?: UserModel;
     updatedByUser?: UserModel;
+    flat?: FlatModel;
     protected constructor();
     static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
     static populateFromEntity(entity: IDonationEntity): DonationModel;
@@ -432,60 +513,6 @@ declare class FlatHistoryModel extends BaseEntityModel implements IFlatHistoryEn
     static populateFromEntity(entity: IFlatHistoryEntity): FlatHistoryModel;
 }
 
-interface FlatDonationLike {
-    flatNo: string;
-    amount: number;
-    donationYear?: number;
-    createdOn?: number;
-    createdByUser?: Nullable<{
-        name?: string;
-    }>;
-    updatedByUser?: Nullable<{
-        name?: string;
-    }>;
-}
-type FlatCollectionStatus = "Paid" | "Pending";
-interface FlatCollectionEntry {
-    flatNumber: string;
-    status: FlatCollectionStatus;
-    amount: number;
-    latestDonation?: Nullable<FlatDonationLike>;
-}
-interface FlatParseResult {
-    wing?: string;
-    num?: string;
-    isSpecial: boolean;
-}
-interface FlatOption {
-    label: string;
-    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[];
-    static readonly WINGS: readonly string[];
-    static getDonationYear(): number;
-    static getTotalFlats(): 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;

package/dist/index.js

@@ -778,6 +778,7 @@ var _DonationModel = class _DonationModel extends BaseEntityModel {
     this.id = 0;
     this.receiptNumber = "";
     this.flatNo = "";
+    this.flatId = 0;
     this.amount = 0;
     this.paymentType = "Cash" /* CASH */;
     this.status = "Active" /* ACTIVE */;
@@ -835,6 +836,12 @@ _DonationModel.relations = {
     ],
     searchProperty: "id",
     entity: "user" /* USER */
+  },
+  ["flat" /* FLAT */]: {
+    relationType: "ONE" /* ONE */,
+    mappingProperties: [{ sourceProperty: "flatId", targetProperty: "flat" }],
+    searchProperty: "id",
+    entity: "flat" /* FLAT */
   }
 };
 var DonationModel = _DonationModel;
@@ -1104,14 +1111,35 @@ var _FlatModel = class _FlatModel {
   static getTotalFlats() {
     return _FlatModel.FLAT_NUMBERS.length;
   }
+  static getWingsFromFlats(flats) {
+    return [
+      ...new Set(flats.map((f) => (f.wing ?? "").trim()).filter(Boolean))
+    ].sort();
+  }
+  static getSpecialsFromFlats(flats) {
+    return flats.filter((f) => !f.wing && !!f.unitNumber).map((f) => f.unitNumber);
+  }
+  static getRegularFlatCount(flats) {
+    return flats.filter((f) => !!f.wing).length;
+  }
+  static getWingFlatCount(flats, wing) {
+    return flats.filter((f) => f.wing === wing).length;
+  }
+  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 })),
+      ...specials.map((label) => ({ label, value: label }))
+    ];
+  }
   static buildFlatNumber(wing, num) {
     return `${wing}-${num}`;
   }
-  static isSpecialFlat(flatNo) {
-    return _FlatModel.SPECIAL_FLATS.includes(flatNo);
+  static isSpecialFlat(flatNo, specials) {
+    return (specials ?? _FlatModel.SPECIAL_FLATS).includes(flatNo);
   }
-  static parseFlatNumber(flatNo) {
-    if (_FlatModel.isSpecialFlat(flatNo)) {
+  static parseFlatNumber(flatNo, specials) {
+    if (_FlatModel.isSpecialFlat(flatNo, specials)) {
       return { isSpecial: true };
     }
     const match = /^([A-Za-z])-([0-9]{1,3}[A-Za-z]?)$/.exec(flatNo);
@@ -1120,21 +1148,29 @@ var _FlatModel = class _FlatModel {
     }
     return { isSpecial: false };
   }
-  static getFlatOptions(wing) {
+  static getFlatOptions(wing, specials) {
+    const effectiveSpecials = specials ?? _FlatModel.SPECIAL_FLATS;
     const wingFlats = _FlatModel.FLATS_BY_WING.get(wing) ?? [];
-    const all = [...wingFlats, ..._FlatModel.SPECIAL_FLATS];
+    const all = [...wingFlats, ...effectiveSpecials];
     return all.map((f) => ({
-      label: _FlatModel.isSpecialFlat(f) ? f : `${wing}-${f}`,
+      label: _FlatModel.isSpecialFlat(f, effectiveSpecials) ? f : `${wing}-${f}`,
       value: f
     }));
   }
-  static getDisplayLabel(wing, flatNo) {
+  static getDisplayLabel(wing, flatNo, specials) {
     if (!flatNo) return "";
-    if (_FlatModel.isSpecialFlat(flatNo)) return flatNo;
+    if (_FlatModel.isSpecialFlat(flatNo, specials)) return flatNo;
     return `${wing}-${flatNo}`;
   }
-  static computeCollectionStatus(donations, year) {
-    return _FlatModel.FLAT_NUMBERS.map((flatNumber) => {
+  static computeCollectionStatus(donations, year, flats) {
+    let flatNumbers = _FlatModel.FLAT_NUMBERS;
+    if (flats) {
+      const specials = _FlatModel.getSpecialsFromFlats(flats);
+      flatNumbers = flats.map(
+        (f) => _FlatModel.getDisplayLabel(f.wing ?? "", f.unitNumber ?? "", specials)
+      );
+    }
+    return flatNumbers.map((flatNumber) => {
       const flatDonations = donations.filter(
         (d) => d.donationYear === year && d.flatNo === flatNumber
       );
@@ -1146,17 +1182,18 @@ var _FlatModel = class _FlatModel {
       return { flatNumber, status, amount, latestDonation };
     });
   }
-  static compareFlatNumbers(a, b) {
-    const isA = _FlatModel.isSpecialFlat(a);
-    const isB = _FlatModel.isSpecialFlat(b);
+  static compareFlatNumbers(a, b, specials) {
+    const isA = _FlatModel.isSpecialFlat(a, specials);
+    const isB = _FlatModel.isSpecialFlat(b, specials);
     if (isA || isB) {
       if (isA && isB) {
-        return _FlatModel.SPECIAL_FLATS.indexOf(a) - _FlatModel.SPECIAL_FLATS.indexOf(b);
+        const effectiveSpecials = specials ?? _FlatModel.SPECIAL_FLATS;
+        return effectiveSpecials.indexOf(a) - effectiveSpecials.indexOf(b);
       }
       return isA ? 1 : -1;
     }
-    const pa = _FlatModel.parseFlatNumber(a);
-    const pb = _FlatModel.parseFlatNumber(b);
+    const pa = _FlatModel.parseFlatNumber(a, specials);
+    const pb = _FlatModel.parseFlatNumber(b, specials);
     if (!pa.wing || !pa.num || !pb.wing || !pb.num) {
       return a < b ? -1 : a > b ? 1 : 0;
     }
@@ -1180,6 +1217,25 @@ var _FlatModel = class _FlatModel {
     return convertNumberToWords(num);
   }
 };
+_FlatModel.relations = {
+  ["user" /* USER */]: {
+    relationType: "ONE" /* ONE */,
+    mappingProperties: [
+      { sourceProperty: "createdBy", targetProperty: "createdByUser" },
+      { sourceProperty: "updatedBy", targetProperty: "updatedByUser" }
+    ],
+    searchProperty: "id",
+    entity: "user" /* USER */
+  },
+  ["donation" /* DONATION */]: {
+    relationType: "MANY" /* MANY */,
+    mappingProperties: [
+      { sourceProperty: "id", targetProperty: "donations" }
+    ],
+    searchProperty: "flatId",
+    entity: "donation" /* DONATION */
+  }
+};
 _FlatModel.FLAT_NUMBERS = FLAT_NUMBERS;
 _FlatModel.FLATS_BY_WING = FLATS_BY_WING;
 _FlatModel.SPECIAL_FLATS = SPECIAL_FLATS;