@mody-park-cha-raja/finance_common 4.20.0 → 4.20.1-beta.3

package/dist/index.d.mts

@@ -70,6 +70,11 @@ declare enum VendorType {
     OTHER = "Other"
 }
 
+declare const PAYMENT_OPTIONS: readonly {
+    value: PaymentType;
+    label: string;
+}[];
+
 interface IAuditColumnEntity {
     createdOn: number;
     updatedOn: number;
@@ -114,9 +119,10 @@ interface IExpenseEntity extends IAuditColumnEntity {
     name: string;
     type: ExpenseType;
     incurredBy: number;
-    vendorName: string;
+    vendorId: number;
     billNumber?: string;
     remarks?: string;
+    description?: string;
     amount: number;
     paymentType: PaymentType;
     status?: EntityStatus;
@@ -223,6 +229,13 @@ interface IVendorEntity extends IAuditColumnEntity {
     name: string;
     type: string;
 }
+/**
+ * Common config for vendor entity
+ * used on the expense entity as a vendorId -> vendor relation
+ *
+ * Adding column keys reduce the bandwidth that is used
+ */
+declare const VENDOR_RELATION_CONFIG: IEntityFilterSearchData<EntityList.VENDOR>;
 
 declare class DonationHistoryModel extends BaseEntityModel implements IDonationHistoryEntity {
     id: number;
@@ -293,15 +306,31 @@ declare class ExpenseHistoryModel extends BaseEntityModel implements IExpenseHis
     static populateFromEntity(entity: IExpenseHistoryEntity): ExpenseHistoryModel;
 }
 
+declare class VendorModel extends BaseEntityModel implements IVendorEntity {
+    id: number;
+    name: string;
+    type: string;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    createdByUser?: UserModel;
+    updatedByUser?: UserModel;
+    protected constructor();
+    static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
+    static populateFromEntity(entity: IVendorEntity): VendorModel;
+}
+
 declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
     id: number;
     name: string;
     type: ExpenseType;
-    vendorName: string;
+    vendorId: number;
     incurredBy: number;
     amount: number;
     billNumber?: string;
     remarks?: string;
+    description?: string;
     paymentType: PaymentType;
     status: EntityStatus;
     createdOn: number;
@@ -311,10 +340,12 @@ declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
     createdByUser?: UserModel;
     updatedByUser?: UserModel;
     incurredByUser?: UserModel;
+    vendor?: VendorModel;
     protected constructor();
     static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
     static populateFromEntity(entity: IExpenseEntity): ExpenseModel;
     get incurredByUserName(): string | undefined;
+    get vendorName(): string;
 }
 
 interface FlatDonationLike {
@@ -462,21 +493,6 @@ declare class VendorHistoryModel extends BaseEntityModel implements IVendorHisto
     static populateFromEntity(entity: IVendorHistoryEntity): VendorHistoryModel;
 }
 
-declare class VendorModel extends BaseEntityModel implements IVendorEntity {
-    id: number;
-    name: string;
-    type: string;
-    createdOn: number;
-    updatedOn: number;
-    createdBy: number;
-    updatedBy: number;
-    createdByUser?: UserModel;
-    updatedByUser?: UserModel;
-    protected constructor();
-    static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
-    static populateFromEntity(entity: IVendorEntity): VendorModel;
-}
-
 declare class ConfigurationModel extends BaseEntityModel implements IConfigurationEntity {
     id: number;
     key: string;
@@ -788,4 +804,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, 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 };
+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, PAYMENT_OPTIONS, PaymentType, ReferenceIdPrefix, RelationType, SPECIAL_FLATS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, UserHistoryModel, UserModel, VENDOR_RELATION_CONFIG, VendorHistoryModel, VendorModel, VendorType, WINGS, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getObjectDiffingKeys, groupBy };

package/dist/index.d.ts

@@ -70,6 +70,11 @@ declare enum VendorType {
     OTHER = "Other"
 }
 
+declare const PAYMENT_OPTIONS: readonly {
+    value: PaymentType;
+    label: string;
+}[];
+
 interface IAuditColumnEntity {
     createdOn: number;
     updatedOn: number;
@@ -114,9 +119,10 @@ interface IExpenseEntity extends IAuditColumnEntity {
     name: string;
     type: ExpenseType;
     incurredBy: number;
-    vendorName: string;
+    vendorId: number;
     billNumber?: string;
     remarks?: string;
+    description?: string;
     amount: number;
     paymentType: PaymentType;
     status?: EntityStatus;
@@ -223,6 +229,13 @@ interface IVendorEntity extends IAuditColumnEntity {
     name: string;
     type: string;
 }
+/**
+ * Common config for vendor entity
+ * used on the expense entity as a vendorId -> vendor relation
+ *
+ * Adding column keys reduce the bandwidth that is used
+ */
+declare const VENDOR_RELATION_CONFIG: IEntityFilterSearchData<EntityList.VENDOR>;
 
 declare class DonationHistoryModel extends BaseEntityModel implements IDonationHistoryEntity {
     id: number;
@@ -293,15 +306,31 @@ declare class ExpenseHistoryModel extends BaseEntityModel implements IExpenseHis
     static populateFromEntity(entity: IExpenseHistoryEntity): ExpenseHistoryModel;
 }
 
+declare class VendorModel extends BaseEntityModel implements IVendorEntity {
+    id: number;
+    name: string;
+    type: string;
+    createdOn: number;
+    updatedOn: number;
+    createdBy: number;
+    updatedBy: number;
+    createdByUser?: UserModel;
+    updatedByUser?: UserModel;
+    protected constructor();
+    static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
+    static populateFromEntity(entity: IVendorEntity): VendorModel;
+}
+
 declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
     id: number;
     name: string;
     type: ExpenseType;
-    vendorName: string;
+    vendorId: number;
     incurredBy: number;
     amount: number;
     billNumber?: string;
     remarks?: string;
+    description?: string;
     paymentType: PaymentType;
     status: EntityStatus;
     createdOn: number;
@@ -311,10 +340,12 @@ declare class ExpenseModel extends BaseEntityModel implements IExpenseEntity {
     createdByUser?: UserModel;
     updatedByUser?: UserModel;
     incurredByUser?: UserModel;
+    vendor?: VendorModel;
     protected constructor();
     static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
     static populateFromEntity(entity: IExpenseEntity): ExpenseModel;
     get incurredByUserName(): string | undefined;
+    get vendorName(): string;
 }
 
 interface FlatDonationLike {
@@ -462,21 +493,6 @@ declare class VendorHistoryModel extends BaseEntityModel implements IVendorHisto
     static populateFromEntity(entity: IVendorHistoryEntity): VendorHistoryModel;
 }
 
-declare class VendorModel extends BaseEntityModel implements IVendorEntity {
-    id: number;
-    name: string;
-    type: string;
-    createdOn: number;
-    updatedOn: number;
-    createdBy: number;
-    updatedBy: number;
-    createdByUser?: UserModel;
-    updatedByUser?: UserModel;
-    protected constructor();
-    static relations: Partial<Record<EntityList, IModelRelationConfig<EntityList>>>;
-    static populateFromEntity(entity: IVendorEntity): VendorModel;
-}
-
 declare class ConfigurationModel extends BaseEntityModel implements IConfigurationEntity {
     id: number;
     key: string;
@@ -788,4 +804,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, 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 };
+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, PAYMENT_OPTIONS, PaymentType, ReferenceIdPrefix, RelationType, SPECIAL_FLATS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, UserHistoryModel, UserModel, VENDOR_RELATION_CONFIG, VendorHistoryModel, VendorModel, VendorType, WINGS, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getObjectDiffingKeys, groupBy };

package/dist/index.js

@@ -43,6 +43,7 @@ __export(index_exports, {
   HttpException: () => HttpException,
   NotFoundException: () => NotFoundException,
   OrderByDirection: () => OrderByDirection,
+  PAYMENT_OPTIONS: () => PAYMENT_OPTIONS,
   PaymentType: () => PaymentType,
   ReferenceIdPrefix: () => ReferenceIdPrefix,
   RelationType: () => RelationType,
@@ -57,6 +58,7 @@ __export(index_exports, {
   UnauthorizedException: () => UnauthorizedException,
   UserHistoryModel: () => UserHistoryModel,
   UserModel: () => UserModel,
+  VENDOR_RELATION_CONFIG: () => VENDOR_RELATION_CONFIG,
   VendorHistoryModel: () => VendorHistoryModel,
   VendorModel: () => VendorModel,
   VendorType: () => VendorType,
@@ -490,6 +492,13 @@ var VendorType = /* @__PURE__ */ ((VendorType2) => {
   return VendorType2;
 })(VendorType || {});
 
+// src/data/payment-options.ts
+var PAYMENT_OPTIONS = [
+  { value: "Cash" /* CASH */, label: "Cash" },
+  { value: "UPI" /* UPI */, label: "UPI" },
+  { value: "Bank Transfer" /* BANK_TRANSFER */, label: "Bank Transfer" }
+];
+
 // src/utils/date-code.utils.ts
 var DateCodeUtils = class _DateCodeUtils {
   constructor(dateCode) {
@@ -812,7 +821,7 @@ var _ExpenseModel = class _ExpenseModel extends BaseEntityModel {
     this.id = 0;
     this.name = "";
     this.type = "Miscellaneous" /* MISCELLANEOUS */;
-    this.vendorName = "";
+    this.vendorId = 0;
     this.incurredBy = 0;
     this.amount = 0;
     this.paymentType = "Cash" /* CASH */;
@@ -830,6 +839,9 @@ var _ExpenseModel = class _ExpenseModel extends BaseEntityModel {
   get incurredByUserName() {
     return this.incurredByUser?.name;
   }
+  get vendorName() {
+    return this.vendor?.name ?? "";
+  }
 };
 _ExpenseModel.relations = {
   ["user" /* USER */]: {
@@ -841,6 +853,14 @@ _ExpenseModel.relations = {
     ],
     searchProperty: "id",
     entity: "user" /* USER */
+  },
+  ["vendor" /* VENDOR */]: {
+    relationType: "ONE" /* ONE */,
+    mappingProperties: [
+      { sourceProperty: "vendorId", targetProperty: "vendor" }
+    ],
+    searchProperty: "id",
+    entity: "vendor" /* VENDOR */
   }
 };
 var ExpenseModel = _ExpenseModel;
@@ -1563,6 +1583,12 @@ var USER_RELATION_CONFIG = {
   name: "user" /* USER */,
   columnKeys: ["id", "name"]
 };
+
+// src/interfaces/entities/vendor.entity.interface.ts
+var VENDOR_RELATION_CONFIG = {
+  name: "vendor" /* VENDOR */,
+  columnKeys: ["id", "name"]
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BadRequestException,
@@ -1588,6 +1614,7 @@ var USER_RELATION_CONFIG = {
   HttpException,
   NotFoundException,
   OrderByDirection,
+  PAYMENT_OPTIONS,
   PaymentType,
   ReferenceIdPrefix,
   RelationType,
@@ -1602,6 +1629,7 @@ var USER_RELATION_CONFIG = {
   UnauthorizedException,
   UserHistoryModel,
   UserModel,
+  VENDOR_RELATION_CONFIG,
   VendorHistoryModel,
   VendorModel,
   VendorType,