@mody-park-cha-raja/finance_common 1.0.3

package/dist/index.d.mts

@@ -0,0 +1,488 @@
+declare enum EntityHistoryOperation {
+    CREATE = "CREATE",
+    UPDATE = "UPDATE",
+    DELETE = "DELETE"
+}
+
+declare enum SponsorFor {
+    GHEE = "ghee",
+    PRASAD = "prasad",
+    BANNER = "banner"
+}
+
+interface IAuditColumnEntity {
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+}
+
+interface IDonationEntity extends IAuditColumnEntity {
+    id: number;
+    flatNo: string;
+    amount: number;
+}
+
+interface IBaseHistoryEntity extends IAuditColumnEntity {
+    id: number;
+    entityId: number;
+    data: string;
+    operation: EntityHistoryOperation;
+}
+
+interface IDonationHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface IExpenseEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    type: string;
+    vendorName: string;
+    amount: number;
+}
+
+interface IExpenseHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface ISponsorEntity extends IAuditColumnEntity {
+    id: number;
+    contactName: string;
+    contactNo: string;
+    sponsorFor: SponsorFor;
+    size: string;
+    amount: number;
+}
+
+interface ISponsorHistoryEntity extends IBaseHistoryEntity {
+}
+
+type TransactionType = 'Income' | 'Expense' | 'Sponsor';
+interface ITransactionEntity extends IAuditColumnEntity {
+    id: number;
+    date: string;
+    type: TransactionType;
+    particulars: string;
+    amount: number;
+    balanceAfter: number;
+    referenceId: string;
+}
+
+interface ITransactionHistoryEntity extends IBaseHistoryEntity {
+}
+
+interface IUserEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    password: string;
+    email: string;
+    phone: string;
+}
+
+interface IVendorEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    type: string;
+}
+
+interface IVendorHistoryEntity extends IBaseHistoryEntity {
+}
+
+/**
+ * Utility class for validating date codes in `YYYYMMDD` format.
+ *
+ * @example new DateCodeUtils(20240315)
+ *
+ * @methods
+ * - `isValidYYYYMMDD()` — checks if the date code is a real calendar date. e.g. `new DateCodeUtils(20240315).isValidYYYYMMDD() // true`
+ */
+declare class DateCodeUtils {
+    private readonly dateCode;
+    stringifiedDateCode: string;
+    constructor(dateCode: string | number);
+    isValidYYYYMMDD(): boolean;
+    toLongDateString(): string;
+    addMonths(months: number): string;
+    addDays(days: number): string;
+    addWeeks(weeks: number): string;
+    addYears(years: number): string;
+    private parseDateParts;
+    static getCurrentYear(): number;
+    static daysDiff(dateCode: string | number): number;
+    static getCurrentDateCode(): string;
+}
+
+declare class DateUtil {
+    static now(): number;
+    static toEpoch(date: Date): number;
+    static toDate(epoch: number): Date;
+    static toReadable(epoch: number): string;
+    static addDays(epoch: number, days: number): number;
+    static addMonths(epoch: number, months: number): number;
+    static addWeeks(epoch: number, weeks: number): number;
+    static addYears(epoch: number, years: number): number;
+    static daysDifference(epoch1: number, epoch2: number): number;
+    static isToday(epoch: number): boolean;
+    static isPast(epoch: number): boolean;
+    static isFuture(epoch: number): boolean;
+}
+
+declare class DonationHistoryModel extends BaseEntityModel implements IDonationHistoryEntity {
+    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.DONATION_HISTORY>>>;
+    static populateFromEntity(entity: IDonationHistoryEntity): DonationHistoryModel;
+}
+
+declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
+    id: number;
+    name: string;
+    type: string;
+    vendorName: string;
+    amount: number;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    protected constructor();
+    static populateFromEntity(entity: IExpenseEntity): ExpenseModel;
+}
+
+declare class ExpenseHistoryModel extends BaseEntityModel implements IExpenseHistoryEntity {
+    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.EXPENSE_HISTORY>>>;
+    static populateFromEntity(entity: IExpenseHistoryEntity): ExpenseHistoryModel;
+}
+
+declare class SponsorModel extends BaseEntityModel implements ISponsorEntity {
+    id: number;
+    contactName: string;
+    contactNo: string;
+    sponsorFor: SponsorFor;
+    size: string;
+    amount: number;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    protected constructor();
+    static populateFromEntity(entity: ISponsorEntity): SponsorModel;
+}
+
+declare class SponsorHistoryModel extends BaseEntityModel implements ISponsorHistoryEntity {
+    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.SPONSOR_HISTORY>>>;
+    static populateFromEntity(entity: ISponsorHistoryEntity): SponsorHistoryModel;
+}
+
+declare class TransactionModel extends BaseEntityModel implements ITransactionEntity {
+    id: number;
+    date: string;
+    type: TransactionType;
+    particulars: string;
+    amount: number;
+    balanceAfter: number;
+    referenceId: string;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    protected constructor();
+    static populateFromEntity(entity: ITransactionEntity): TransactionModel;
+}
+
+declare class TransactionHistoryModel extends BaseEntityModel implements ITransactionHistoryEntity {
+    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.TRANSACTION_HISTORY>>>;
+    static populateFromEntity(entity: ITransactionHistoryEntity): TransactionHistoryModel;
+}
+
+declare class UserModel extends BaseEntityModel implements IUserEntity {
+    id: number;
+    name: string;
+    password: string;
+    email: string;
+    phone: string;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    protected constructor();
+    static populateFromEntity(entity: IUserEntity): UserModel;
+}
+
+declare class VendorModel extends BaseEntityModel implements IVendorEntity {
+    id: number;
+    name: string;
+    type: string;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    protected constructor();
+    static populateFromEntity(entity: IVendorEntity): VendorModel;
+}
+
+declare class VendorHistoryModel extends BaseEntityModel implements IVendorHistoryEntity {
+    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.VENDOR_HISTORY>>>;
+    static populateFromEntity(entity: IVendorHistoryEntity): VendorHistoryModel;
+}
+
+declare const entityListEntityModelMap: {
+    donation: typeof DonationModel.populateFromEntity;
+    donation_history: typeof DonationHistoryModel.populateFromEntity;
+    user: typeof UserModel.populateFromEntity;
+    expense: typeof ExpenseModel.populateFromEntity;
+    expense_history: typeof ExpenseHistoryModel.populateFromEntity;
+    vendor: typeof VendorModel.populateFromEntity;
+    vendor_history: typeof VendorHistoryModel.populateFromEntity;
+    transaction: typeof TransactionModel.populateFromEntity;
+    transaction_history: typeof TransactionHistoryModel.populateFromEntity;
+    sponsor: typeof SponsorModel.populateFromEntity;
+    sponsor_history: typeof SponsorHistoryModel.populateFromEntity;
+};
+
+declare class HttpException extends Error {
+    readonly message: string;
+    readonly statusCode: number;
+    readonly key?: string | undefined;
+    readonly errors?: any | undefined;
+    constructor(message: string, statusCode: number, key?: string | undefined, errors?: any | undefined);
+    getResponse(): {
+        statusCode: number;
+        message: string;
+        key: string | undefined;
+        errors: any;
+    };
+    getStatus(): number;
+}
+declare class BadRequestException extends HttpException {
+    constructor(input: {
+        key: string;
+        message: string;
+    } | string | string[], errors?: any);
+}
+declare class NotFoundException extends HttpException {
+    constructor(input?: {
+        key: string;
+        message: string;
+    } | string);
+}
+declare class UnauthorizedException extends HttpException {
+    constructor(input?: {
+        key: string;
+        message: string;
+    } | string);
+}
+declare class ForbiddenException extends HttpException {
+    constructor(input?: {
+        key: string;
+        message: string;
+    } | string);
+}
+
+declare function getObjectDiffingKeys<T extends Record<string, any>>(oldObject: T, newObject: T): Partial<T>;
+/**
+ * Compares two arrays and returns the difference between them.
+ *
+ * @template T - The type of elements in the arrays
+ * @param {T[]} arr1 - The original array
+ * @param {T[]} arr2 - The new array to compare against
+ * @returns {{ present: T[], deleted: T[], added: T[] }} An object containing:
+ * - `present` — items found in both arrays (intersection)
+ * - `deleted` — items in `arr1` but not in `arr2`
+ * - `added`   — items in `arr2` but not in `arr1`
+ *
+ * @example
+ * const arr1 = [1, 2, 3, 4];
+ * const arr2 = [3, 4, 5, 6];
+ *
+ * diffArrays(arr1, arr2);
+ * // {
+ * //   present: [3, 4],
+ * //   deleted: [1, 2],
+ * //   added:   [5, 6]
+ * // }
+ */
+declare function diffArrays<T>(arr1: T[], arr2: T[]): {
+    present: T[];
+    deleted: T[];
+    added: T[];
+};
+/**
+ * Groups an array of objects by a specified key, returning a `Map` where each
+ * unique value of the key becomes an entry containing all items that share that value.
+ * Use this as a fallback if `Object.groupBy` (ES2024) is not available in your environment.
+ *
+ * @template T - The type of objects in the array
+ * @param items - The array of objects to group
+ * @param key - A key of `T` whose value will be used as the group identifier
+ * @returns A `Map` where each key maps to an array of items belonging to that group
+ *
+ * @example
+ * const grouped = groupBy(items, 'someKey');
+ * grouped.get('keyValue1'); // [item1, item2]
+ * grouped.get('keyValue2'); // [item3]
+ */
+declare function groupBy<T>(items: T[], key: keyof T): Map<string, T[]>;
+declare function definedValues<T>(arr: Array<T | undefined | null>): T[];
+
+declare enum RelationType {
+    ONE = "ONE",
+    MANY = "MANY"
+}
+interface IModelRelationConfig<T extends EntityList> {
+    relationType: RelationType;
+    mappingProperty: keyof EntityType<T> & string;
+    searchProperty: string;
+    entity: EntityList;
+}
+
+declare enum OrderByDirection {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+
+declare abstract class BaseEntityModel {
+    static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
+    populateRelations(searchResponse: ISearchV2Response, visited?: Set<string>): this;
+}
+
+declare class DonationModel extends BaseEntityModel implements IDonationEntity {
+    id: number;
+    flatNo: string;
+    amount: number;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    protected constructor();
+    static populateFromEntity(entity: IDonationEntity): DonationModel;
+}
+
+declare enum EntityList {
+    DONATION = "donation",
+    DONATION_HISTORY = "donation_history",
+    USER = "user",
+    EXPENSE = "expense",
+    EXPENSE_HISTORY = "expense_history",
+    VENDOR = "vendor",
+    VENDOR_HISTORY = "vendor_history",
+    TRANSACTION = "transaction",
+    TRANSACTION_HISTORY = "transaction_history",
+    SPONSOR = "sponsor",
+    SPONSOR_HISTORY = "sponsor_history"
+}
+type EntityType<T extends EntityList> = T extends EntityList.DONATION ? IDonationEntity : T extends EntityList.DONATION_HISTORY ? IDonationHistoryEntity : T extends EntityList.USER ? IUserEntity : 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 : 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.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 : never;
+type EntityListEntityModelMap = {
+    [T in EntityList]: EntityModelType<T>[];
+};
+
+type IEntityCreateDto<T> = Omit<T, "id" | keyof IAuditColumnEntity>;
+type IEntityUpdateDto<T> = Omit<Partial<T>, "id" | keyof IAuditColumnEntity>;
+type IEntityFilterSearchData<K extends EntityList = EntityList> = {
+    name: K;
+    include?: IEntityFilterData<EntityType<K>>;
+    relations?: IEntityFilterSearchData<EntityList>[];
+    columnKeys?: (keyof EntityType<K>)[];
+    orderBy?: Partial<Record<keyof EntityType<K>, OrderByDirection>>;
+    limit?: number;
+};
+type IEntityFilterData<T> = {
+    [K in keyof T]?: T[K][];
+} & {
+    include?: IEntityFilterData<EntityType<EntityList>>;
+    columnKeys?: (keyof T)[];
+    entities?: IEntityFilterSearchData<EntityList>[];
+    relations?: IEntityFilterSearchData<EntityList>[];
+    orderBy?: Partial<Record<keyof T, OrderByDirection>>;
+    limit?: number;
+};
+interface IEntityFilterSearchDataV2<K extends EntityList = EntityList> {
+    /**
+     * Root entity being queried
+     */
+    name: K;
+    /**
+     * Query configuration + filters
+     */
+    filter?: IEntityFilterData<EntityType<K>>;
+}
+type ISearchV2Response = {
+    [key in EntityList]?: EntityType<key>[];
+};
+
+/**
+ * Helper class for extracting typed entities from a `searchV2` response.
+ *
+ * @example new EntityFilterDataHelper(searchV2Response)
+ *
+ * @methods
+ * - `getEntityFromList(name)` — returns typed entity array for the given `EntityList` key. e.g. `helper.getEntityFromList(EntityList.USER) // IUserEntity[]`
+ */
+declare class EntityFilterDataHelper {
+    private readonly searchResponse;
+    entityModelsMap: EntityListEntityModelMap;
+    constructor(searchResponse: ISearchV2Response);
+    getEntityFromList<T extends EntityList>(name: T): EntityModelType<T>[];
+    private populateEntityModelsMap;
+    getEntityModelsByFilter<T extends EntityList>(entityName: T, filter: {
+        key: keyof EntityType<T> & string;
+        value: any[];
+    }): EntityModelType<T>[];
+    getEntityModelByFilter<T extends EntityList>(entityName: T, filter: {
+        key: keyof EntityType<T> & string;
+        value: any;
+    }): EntityModelType<T>;
+    populateRelationsFor(entityNames: EntityList[]): EntityListEntityModelMap;
+    mergeEntity<T extends EntityList>(entityName: T, savedEntity: EntityType<T>): EntityModelType<T>;
+}
+
+interface IDtoValidationError {
+    key: string;
+    message: string;
+}
+
+type Nullable<T> = T | null;
+
+export { BadRequestException, BaseEntityModel, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, type EntityType, ExpenseHistoryModel, ExpenseModel, ForbiddenException, HttpException, type IAuditColumnEntity, type IBaseHistoryEntity, type IDonationEntity, type IDonationHistoryEntity, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseEntity, type IExpenseHistoryEntity, type IModelRelationConfig, type ISearchV2Response, type ISponsorEntity, type ISponsorHistoryEntity, type ITransactionEntity, type ITransactionHistoryEntity, type IUserEntity, type IVendorEntity, type IVendorHistoryEntity, NotFoundException, type Nullable, OrderByDirection, RelationType, SponsorFor, SponsorHistoryModel, SponsorModel, TransactionHistoryModel, TransactionModel, type TransactionType, UnauthorizedException, UserModel, VendorHistoryModel, VendorModel, definedValues, diffArrays, entityListEntityModelMap, getObjectDiffingKeys, groupBy };