payservedb 8.9.0 → 8.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (193) hide show
  1. package/.env +2 -2
  2. package/ZOHO_INTEGRATION_SCHEMA.md +644 -644
  3. package/index.js +327 -326
  4. package/package.json +17 -17
  5. package/src/models/account.js +52 -52
  6. package/src/models/agent_departments.js +59 -59
  7. package/src/models/agent_notifications.js +53 -53
  8. package/src/models/agent_performance.js +127 -127
  9. package/src/models/agent_roles.js +77 -77
  10. package/src/models/agents.js +154 -154
  11. package/src/models/apilog.js +18 -18
  12. package/src/models/approvalsWorkflows.js +49 -49
  13. package/src/models/archivedapilog.js +18 -18
  14. package/src/models/asset.js +92 -92
  15. package/src/models/assetsAssignment.js +64 -64
  16. package/src/models/auditTrail.js +346 -346
  17. package/src/models/bankdetails.js +47 -47
  18. package/src/models/billerAddress.js +124 -124
  19. package/src/models/booking_invoice.js +165 -165
  20. package/src/models/bookinganalytics.js +63 -63
  21. package/src/models/bookingconfig.js +45 -45
  22. package/src/models/bookingproperty.js +179 -179
  23. package/src/models/bookingreservation.js +239 -239
  24. package/src/models/bookingrevenuerecord.js +84 -84
  25. package/src/models/budget.js +95 -95
  26. package/src/models/budgetCategory.js +19 -19
  27. package/src/models/campaigns.js +108 -108
  28. package/src/models/cashpayment.js +290 -290
  29. package/src/models/combinedUnits.js +62 -62
  30. package/src/models/combined_invoice.js +424 -424
  31. package/src/models/common_area_electricity.js +38 -38
  32. package/src/models/common_area_generator.js +41 -41
  33. package/src/models/common_area_utility_alert.js +37 -37
  34. package/src/models/common_area_water.js +39 -39
  35. package/src/models/communication_status.js +33 -33
  36. package/src/models/communication_user_opt.js +32 -32
  37. package/src/models/community_guidelines.js +35 -35
  38. package/src/models/company.js +53 -53
  39. package/src/models/coreBaseSettings.js +16 -16
  40. package/src/models/coreInvoiceSettings.js +100 -100
  41. package/src/models/counter_schema.js +21 -21
  42. package/src/models/country_tax.js +42 -42
  43. package/src/models/currency_settings.js +39 -39
  44. package/src/models/customer.js +214 -214
  45. package/src/models/customer_preference.js +52 -52
  46. package/src/models/customer_satisfaction_survey.js +297 -297
  47. package/src/models/customer_surveys.js +139 -139
  48. package/src/models/customer_tickets.js +237 -237
  49. package/src/models/dailyChecklist.js +312 -312
  50. package/src/models/default_payment_details.js +17 -17
  51. package/src/models/deliveryTimeMarks.js +18 -18
  52. package/src/models/document_type.js +19 -19
  53. package/src/models/dutyRosterChecklist.js +250 -250
  54. package/src/models/dutyroster.js +136 -136
  55. package/src/models/email.js +37 -37
  56. package/src/models/email_sms_queue.js +61 -61
  57. package/src/models/email_thread.js +35 -35
  58. package/src/models/entry_exit.js +53 -53
  59. package/src/models/expense.js +99 -99
  60. package/src/models/expense_category.js +45 -45
  61. package/src/models/facility.js +76 -76
  62. package/src/models/facilityBillingPrices.js +29 -29
  63. package/src/models/facilityInvoice.js +240 -240
  64. package/src/models/facilityInvoicePayment.js +52 -52
  65. package/src/models/facilityInvoiceRecipient.js +32 -32
  66. package/src/models/facilityWalletTransactionsMetadata.js +236 -236
  67. package/src/models/facility_departements.js +20 -20
  68. package/src/models/facility_payment_details.js +20 -20
  69. package/src/models/facility_rating.js +78 -78
  70. package/src/models/facilityasset.js +25 -25
  71. package/src/models/faq.js +14 -14
  72. package/src/models/gl_account_double_entries.js +25 -25
  73. package/src/models/gl_accounts.js +56 -56
  74. package/src/models/gl_entries.js +49 -49
  75. package/src/models/goodsReceivedNotes.js +115 -115
  76. package/src/models/guard.js +47 -47
  77. package/src/models/handover.js +258 -258
  78. package/src/models/inspection_category.js +38 -38
  79. package/src/models/invoice.js +484 -480
  80. package/src/models/invoice_generation_approval.js +86 -86
  81. package/src/models/invoicing_schedule.js +40 -40
  82. package/src/models/item_inspection.js +96 -96
  83. package/src/models/knowledge_base.js +109 -109
  84. package/src/models/knowledge_base_rating.js +44 -44
  85. package/src/models/leaseagreement.js +243 -243
  86. package/src/models/leasetemplate.js +17 -17
  87. package/src/models/levy.js +223 -223
  88. package/src/models/levy_invoice_settings.js +26 -26
  89. package/src/models/levycontract.js +216 -216
  90. package/src/models/levytype.js +23 -23
  91. package/src/models/maintenance_service_vendor.js +38 -38
  92. package/src/models/maintenance_services.js +17 -17
  93. package/src/models/maintenancerequisition.js +31 -31
  94. package/src/models/master_workplan.js +32 -32
  95. package/src/models/master_workplan_child.js +34 -34
  96. package/src/models/message.js +38 -38
  97. package/src/models/module.js +21 -21
  98. package/src/models/movein_application.js +29 -29
  99. package/src/models/movein_landlord.js +18 -18
  100. package/src/models/movein_user.js +15 -15
  101. package/src/models/notification.js +44 -44
  102. package/src/models/paymentTermsMarks.js +19 -19
  103. package/src/models/penalty.js +76 -76
  104. package/src/models/pendingCredentials.js +32 -32
  105. package/src/models/powerMeterCommunicationProtocol.js +17 -17
  106. package/src/models/powerMeterCustomerAccount.js +78 -78
  107. package/src/models/powerMeterCustomerBand.js +14 -14
  108. package/src/models/powerMeterDailyReading.js +30 -30
  109. package/src/models/powerMeterGateways.js +40 -40
  110. package/src/models/powerMeterMonthlyReading.js +34 -34
  111. package/src/models/powerMeterPowerCharges.js +85 -85
  112. package/src/models/powerMeterSettings.js +159 -159
  113. package/src/models/powerMeterSingleDayReading.js +32 -32
  114. package/src/models/powerMeters.js +116 -116
  115. package/src/models/powerMetersManufacturer.js +14 -14
  116. package/src/models/power_invoice.js +471 -0
  117. package/src/models/power_meter_account.js +81 -81
  118. package/src/models/power_meter_command_logs.js +30 -30
  119. package/src/models/power_meter_command_queue.js +33 -33
  120. package/src/models/power_meter_negative_balance.js +44 -44
  121. package/src/models/power_prepaid_credits.js +47 -47
  122. package/src/models/power_prepaid_debits.js +53 -53
  123. package/src/models/power_prepaid_orders.js +78 -78
  124. package/src/models/power_sms_notification.js +26 -26
  125. package/src/models/privacy_policy.js +19 -19
  126. package/src/models/propertyManagerContract.js +556 -556
  127. package/src/models/propertyManagerRevenue.js +195 -195
  128. package/src/models/purchaseOrderInvoice.js +74 -74
  129. package/src/models/purchase_order.js +213 -213
  130. package/src/models/purchase_request.js +110 -110
  131. package/src/models/quickbooks_config.js +52 -52
  132. package/src/models/refresh_token.js +23 -23
  133. package/src/models/reminder.js +197 -197
  134. package/src/models/report.js +13 -13
  135. package/src/models/resident.js +121 -121
  136. package/src/models/rfq_details.js +131 -131
  137. package/src/models/rfq_response.js +153 -153
  138. package/src/models/service_charge_invoice_upload.js +42 -42
  139. package/src/models/service_charge_payments.js +27 -27
  140. package/src/models/servicerequest.js +55 -55
  141. package/src/models/settings.js +62 -62
  142. package/src/models/short_urls.js +21 -21
  143. package/src/models/smart_meter_daily_consumption.js +44 -44
  144. package/src/models/sms_africastalking.js +20 -20
  145. package/src/models/sms_balance_notification.js +26 -26
  146. package/src/models/sms_meliora.js +20 -20
  147. package/src/models/staff.js +36 -36
  148. package/src/models/stocksandspare.js +161 -161
  149. package/src/models/suppliers.js +74 -74
  150. package/src/models/terms_and_conditions.js +19 -19
  151. package/src/models/tickets.js +186 -186
  152. package/src/models/tickets_category.js +72 -72
  153. package/src/models/unitManagementTemplate.js +44 -44
  154. package/src/models/unitasset.js +25 -25
  155. package/src/models/units.js +130 -130
  156. package/src/models/user.js +186 -186
  157. package/src/models/valueaddedservices.js +21 -21
  158. package/src/models/vas_invoices_upload.js +50 -50
  159. package/src/models/vas_payments.js +24 -24
  160. package/src/models/vasinvoice.js +192 -192
  161. package/src/models/vasvendor.js +52 -52
  162. package/src/models/visitLog.js +95 -95
  163. package/src/models/visitor.js +67 -67
  164. package/src/models/waitlist.js +45 -45
  165. package/src/models/wallet.js +44 -44
  166. package/src/models/wallet_transactions.js +50 -50
  167. package/src/models/water_invoice.js +351 -351
  168. package/src/models/water_meter_Command_Queue.js +33 -33
  169. package/src/models/water_meter_account.js +86 -86
  170. package/src/models/water_meter_billing.js +58 -58
  171. package/src/models/water_meter_combined_accounts.js +92 -92
  172. package/src/models/water_meter_communication.js +17 -17
  173. package/src/models/water_meter_communication_logs.js +39 -39
  174. package/src/models/water_meter_concentrator.js +70 -70
  175. package/src/models/water_meter_daily_history.js +32 -32
  176. package/src/models/water_meter_high_risk.js +36 -36
  177. package/src/models/water_meter_iot_cards.js +34 -34
  178. package/src/models/water_meter_loan_deduction.js +134 -134
  179. package/src/models/water_meter_manufacturer.js +35 -35
  180. package/src/models/water_meter_monthly_history.js +36 -36
  181. package/src/models/water_meter_negative_amounts.js +44 -44
  182. package/src/models/water_meter_settings.js +290 -290
  183. package/src/models/water_meter_single_day_history.js +34 -34
  184. package/src/models/water_meter_size.js +15 -15
  185. package/src/models/water_meters.js +176 -176
  186. package/src/models/water_meters_delivery.js +76 -76
  187. package/src/models/water_prepaid_credit.js +47 -47
  188. package/src/models/water_prepaid_debit.js +50 -50
  189. package/src/models/whatsapp_conversation.js +23 -23
  190. package/src/models/workorder.js +49 -49
  191. package/src/models/zohoAccount.js +453 -453
  192. package/src/models/zohoIntegration.js +262 -262
  193. package/src/models/zohoItem.js +504 -504
@@ -1,21 +1,21 @@
1
- const mongoose = require('mongoose');
2
-
3
- const shortUrlSchema = new mongoose.Schema({
4
- shortCode: {
5
- type: String,
6
- required: true,
7
- unique: true,
8
- trim: true
9
- },
10
- originalUrl: {
11
- type: String,
12
- required: true,
13
- trim: true
14
- }
15
- }, {
16
- timestamps: true
17
- });
18
-
19
- const ShortUrl = mongoose.model('ShortUrl', shortUrlSchema);
20
-
21
- module.exports = ShortUrl;
1
+ const mongoose = require('mongoose');
2
+
3
+ const shortUrlSchema = new mongoose.Schema({
4
+ shortCode: {
5
+ type: String,
6
+ required: true,
7
+ unique: true,
8
+ trim: true
9
+ },
10
+ originalUrl: {
11
+ type: String,
12
+ required: true,
13
+ trim: true
14
+ }
15
+ }, {
16
+ timestamps: true
17
+ });
18
+
19
+ const ShortUrl = mongoose.model('ShortUrl', shortUrlSchema);
20
+
21
+ module.exports = ShortUrl;
@@ -1,45 +1,45 @@
1
- const mongoose = require('mongoose');
2
-
3
- const dailyConsumptionSchema = new mongoose.Schema({
4
- meterId: {
5
- type: mongoose.Schema.Types.ObjectId,
6
- ref: 'Meter',
7
- required: true,
8
- },
9
- date: {
10
- type: Date,
11
- required: true,
12
- },
13
- totalConsumption: {
14
- type: Number,
15
- default: 0,
16
- },
17
-
18
- updates: [{
19
- timestamp: {
20
- type: Date,
21
- default: Date.now
22
- },
23
- previousReading: {
24
- type: Number,
25
- required: true
26
- },
27
- currentReading: {
28
- type: Number,
29
- required: true
30
- },
31
- // Delta can be computed as (currentReading - previousReading)
32
- delta: {
33
- type: Number,
34
- required: true
35
- },
36
- }],
37
- }, {
38
- timestamps: true,
39
- });
40
-
41
- dailyConsumptionSchema.index({ meterId: 1, date: 1 }, { unique: true });
42
-
43
- const DailyConsumption = mongoose.model('DailyConsumption', dailyConsumptionSchema);
44
-
1
+ const mongoose = require('mongoose');
2
+
3
+ const dailyConsumptionSchema = new mongoose.Schema({
4
+ meterId: {
5
+ type: mongoose.Schema.Types.ObjectId,
6
+ ref: 'Meter',
7
+ required: true,
8
+ },
9
+ date: {
10
+ type: Date,
11
+ required: true,
12
+ },
13
+ totalConsumption: {
14
+ type: Number,
15
+ default: 0,
16
+ },
17
+
18
+ updates: [{
19
+ timestamp: {
20
+ type: Date,
21
+ default: Date.now
22
+ },
23
+ previousReading: {
24
+ type: Number,
25
+ required: true
26
+ },
27
+ currentReading: {
28
+ type: Number,
29
+ required: true
30
+ },
31
+ // Delta can be computed as (currentReading - previousReading)
32
+ delta: {
33
+ type: Number,
34
+ required: true
35
+ },
36
+ }],
37
+ }, {
38
+ timestamps: true,
39
+ });
40
+
41
+ dailyConsumptionSchema.index({ meterId: 1, date: 1 }, { unique: true });
42
+
43
+ const DailyConsumption = mongoose.model('DailyConsumption', dailyConsumptionSchema);
44
+
45
45
  module.exports = DailyConsumption;
@@ -1,21 +1,21 @@
1
- const mongoose = require('mongoose');
2
- const SMSAfricastalkingSchema = mongoose.Schema({
3
- user: {
4
- type: String,
5
- required: true
6
- },
7
- senderId: {
8
- type: String,
9
- required: true
10
- },
11
- userName: {
12
- type: String,
13
- required: true,
14
- },
15
- apiKey: {
16
- type: String,
17
- required: true
18
- }
19
- })
20
- const SMSAfricastalking = mongoose.model('SMSAfricastalking', SMSAfricastalkingSchema);
1
+ const mongoose = require('mongoose');
2
+ const SMSAfricastalkingSchema = mongoose.Schema({
3
+ user: {
4
+ type: String,
5
+ required: true
6
+ },
7
+ senderId: {
8
+ type: String,
9
+ required: true
10
+ },
11
+ userName: {
12
+ type: String,
13
+ required: true,
14
+ },
15
+ apiKey: {
16
+ type: String,
17
+ required: true
18
+ }
19
+ })
20
+ const SMSAfricastalking = mongoose.model('SMSAfricastalking', SMSAfricastalkingSchema);
21
21
  module.exports = SMSAfricastalking
@@ -1,27 +1,27 @@
1
- const mongoose = require('mongoose');
2
-
3
- const smsNotificationSchema = new mongoose.Schema({
4
- accountId: {
5
- type: mongoose.Schema.Types.ObjectId,
6
- ref: 'WaterMeterAccount',
7
- required: true
8
- },
9
- currentRange: {
10
- type: String,
11
- required: true
12
- },
13
- lastNotificationDate: {
14
- type: Date,
15
- default: Date.now
16
- },
17
- balance: {
18
- type: Number,
19
- required: true
20
- }
21
- }, {
22
- timestamps: true
23
- });
24
-
25
- const SmsNotification = mongoose.model('SmsNotification', smsNotificationSchema)
26
-
1
+ const mongoose = require('mongoose');
2
+
3
+ const smsNotificationSchema = new mongoose.Schema({
4
+ accountId: {
5
+ type: mongoose.Schema.Types.ObjectId,
6
+ ref: 'WaterMeterAccount',
7
+ required: true
8
+ },
9
+ currentRange: {
10
+ type: String,
11
+ required: true
12
+ },
13
+ lastNotificationDate: {
14
+ type: Date,
15
+ default: Date.now
16
+ },
17
+ balance: {
18
+ type: Number,
19
+ required: true
20
+ }
21
+ }, {
22
+ timestamps: true
23
+ });
24
+
25
+ const SmsNotification = mongoose.model('SmsNotification', smsNotificationSchema)
26
+
27
27
  module.exports = SmsNotification;
@@ -1,21 +1,21 @@
1
- const mongoose = require('mongoose');
2
- const SMSMelioraSchema = mongoose.Schema({
3
- user: {
4
- type: String,
5
- required: true
6
- },
7
- facilityId: {
8
- type: mongoose.Schema.Types.ObjectId,
9
- required: true
10
- },
11
- senderId: {
12
- type: String,
13
- required: true
14
- },
15
- apiKey: {
16
- type: String,
17
- required: true
18
- }
19
- })
20
- const SMSMeliora = mongoose.model('SMSMeliora', SMSMelioraSchema);
1
+ const mongoose = require('mongoose');
2
+ const SMSMelioraSchema = mongoose.Schema({
3
+ user: {
4
+ type: String,
5
+ required: true
6
+ },
7
+ facilityId: {
8
+ type: mongoose.Schema.Types.ObjectId,
9
+ required: true
10
+ },
11
+ senderId: {
12
+ type: String,
13
+ required: true
14
+ },
15
+ apiKey: {
16
+ type: String,
17
+ required: true
18
+ }
19
+ })
20
+ const SMSMeliora = mongoose.model('SMSMeliora', SMSMelioraSchema);
21
21
  module.exports = SMSMeliora
@@ -1,36 +1,36 @@
1
- const mongoose = require("mongoose");
2
-
3
- // Define the Staff schema
4
- const staffSchema = new mongoose.Schema(
5
- {
6
- facilityId: {
7
- type: mongoose.Schema.Types.ObjectId,
8
- ref: 'Facility',
9
- required: true,
10
- },
11
- name: {
12
- type: String,
13
- required: true,
14
- },
15
- contact: {
16
- type: String,
17
- required: true,
18
- },
19
- phoneNumber: {
20
- type: String,
21
- required: true,
22
- },
23
- service: [{
24
- type: mongoose.Schema.Types.ObjectId,
25
- ref: 'ValueAddedService',
26
- required: true,
27
- }],
28
- },
29
- {
30
- timestamps: true,
31
- }
32
- );
33
-
34
- const Staff = mongoose.model('Staff', staffSchema);
35
-
36
- module.exports = Staff;
1
+ const mongoose = require("mongoose");
2
+
3
+ // Define the Staff schema
4
+ const staffSchema = new mongoose.Schema(
5
+ {
6
+ facilityId: {
7
+ type: mongoose.Schema.Types.ObjectId,
8
+ ref: 'Facility',
9
+ required: true,
10
+ },
11
+ name: {
12
+ type: String,
13
+ required: true,
14
+ },
15
+ contact: {
16
+ type: String,
17
+ required: true,
18
+ },
19
+ phoneNumber: {
20
+ type: String,
21
+ required: true,
22
+ },
23
+ service: [{
24
+ type: mongoose.Schema.Types.ObjectId,
25
+ ref: 'ValueAddedService',
26
+ required: true,
27
+ }],
28
+ },
29
+ {
30
+ timestamps: true,
31
+ }
32
+ );
33
+
34
+ const Staff = mongoose.model('Staff', staffSchema);
35
+
36
+ module.exports = Staff;
@@ -1,161 +1,161 @@
1
- const mongoose = require("mongoose");
2
-
3
- // Metadata subdocument schema for tracking stock changes
4
- const stockMetadataSchema = new mongoose.Schema(
5
- {
6
- timestamp: {
7
- type: Date,
8
- default: Date.now,
9
- required: true,
10
- },
11
- description: {
12
- type: String,
13
- required: true,
14
- trim: true,
15
- },
16
- changeType: {
17
- type: String,
18
- enum: ["increment", "decrement", "adjustment", "initial", "edit"],
19
- required: true,
20
- },
21
- previousQuantity: {
22
- type: Number,
23
- min: 0,
24
- },
25
- newQuantity: {
26
- type: Number,
27
- min: 0,
28
- required: true,
29
- },
30
- quantityChanged: {
31
- type: Number,
32
- required: true,
33
- },
34
- userId: {
35
- type: mongoose.Schema.Types.ObjectId,
36
- ref: "User", // assuming you have a User model
37
- },
38
- },
39
- { _id: false },
40
- ); // _id: false to prevent auto-generation of _id for subdocuments
41
-
42
- const stockAndSparesSchema = new mongoose.Schema(
43
- {
44
- facilityId: {
45
- type: mongoose.Schema.Types.ObjectId,
46
- ref: "Facility",
47
- required: true,
48
- },
49
- name: {
50
- type: String,
51
- required: true,
52
- },
53
- description: {
54
- type: String,
55
- },
56
- skuDetails: {
57
- type: String,
58
- required: true,
59
- },
60
- quantityInStock: {
61
- type: Number,
62
- required: true,
63
- min: 0,
64
- },
65
- reOrderLevel: {
66
- type: Number,
67
- required: true,
68
- min: 0,
69
- },
70
- // New metadata field to track all stock changes
71
- metadata: [stockMetadataSchema],
72
- },
73
- {
74
- timestamps: true,
75
- },
76
- );
77
-
78
- // Pre-save middleware to automatically add metadata entry when quantity changes
79
- stockAndSparesSchema.pre("save", function (next) {
80
- if (this.isModified("quantityInStock") && !this.isNew) {
81
- // Get the original document to compare quantities
82
- const originalDoc = this.constructor.findById(this._id);
83
- originalDoc.then((original) => {
84
- if (original && original.quantityInStock !== this.quantityInStock) {
85
- const quantityChanged = this.quantityInStock - original.quantityInStock;
86
- const changeType =
87
- quantityChanged > 0
88
- ? "increment"
89
- : quantityChanged < 0
90
- ? "decrement"
91
- : "adjustment";
92
-
93
- // Add metadata entry (you can set description and userId from your controller)
94
- this.metadata.push({
95
- previousQuantity: original.quantityInStock,
96
- newQuantity: this.quantityInStock,
97
- quantityChanged: quantityChanged,
98
- changeType: changeType,
99
- description:
100
- this._metadataDescription ||
101
- `Stock ${changeType}: ${Math.abs(quantityChanged)} units`,
102
- userId: this._userId || null,
103
- });
104
- }
105
- });
106
- }
107
- next();
108
- });
109
-
110
- // Instance method to add stock with metadata
111
- stockAndSparesSchema.methods.addStock = function (
112
- quantity,
113
- description,
114
- userId,
115
- ) {
116
- const previousQuantity = this.quantityInStock;
117
- this.quantityInStock += quantity;
118
-
119
- this.metadata.push({
120
- previousQuantity: previousQuantity,
121
- newQuantity: this.quantityInStock,
122
- quantityChanged: quantity,
123
- changeType: "increment",
124
- description: description || `Added ${quantity} units to stock`,
125
- userId: userId,
126
- });
127
-
128
- return this.save();
129
- };
130
-
131
- // Instance method to reduce stock with metadata
132
- stockAndSparesSchema.methods.reduceStock = function (
133
- quantity,
134
- description,
135
- userId,
136
- ) {
137
- if (this.quantityInStock < quantity) {
138
- throw new Error("Insufficient stock quantity");
139
- }
140
-
141
- const previousQuantity = this.quantityInStock;
142
- this.quantityInStock -= quantity;
143
-
144
- this.metadata.push({
145
- previousQuantity: previousQuantity,
146
- newQuantity: this.quantityInStock,
147
- quantityChanged: -quantity,
148
- changeType: "decrement",
149
- description: description || `Removed ${quantity} units from stock`,
150
- userId: userId,
151
- });
152
-
153
- return this.save();
154
- };
155
-
156
- // Instance method to get stock history
157
- stockAndSparesSchema.methods.getStockHistory = function () {
158
- return this.metadata.sort((a, b) => b.timestamp - a.timestamp);
159
- };
160
-
161
- module.exports = mongoose.model("Stocksandspare", stockAndSparesSchema);
1
+ const mongoose = require("mongoose");
2
+
3
+ // Metadata subdocument schema for tracking stock changes
4
+ const stockMetadataSchema = new mongoose.Schema(
5
+ {
6
+ timestamp: {
7
+ type: Date,
8
+ default: Date.now,
9
+ required: true,
10
+ },
11
+ description: {
12
+ type: String,
13
+ required: true,
14
+ trim: true,
15
+ },
16
+ changeType: {
17
+ type: String,
18
+ enum: ["increment", "decrement", "adjustment", "initial", "edit"],
19
+ required: true,
20
+ },
21
+ previousQuantity: {
22
+ type: Number,
23
+ min: 0,
24
+ },
25
+ newQuantity: {
26
+ type: Number,
27
+ min: 0,
28
+ required: true,
29
+ },
30
+ quantityChanged: {
31
+ type: Number,
32
+ required: true,
33
+ },
34
+ userId: {
35
+ type: mongoose.Schema.Types.ObjectId,
36
+ ref: "User", // assuming you have a User model
37
+ },
38
+ },
39
+ { _id: false },
40
+ ); // _id: false to prevent auto-generation of _id for subdocuments
41
+
42
+ const stockAndSparesSchema = new mongoose.Schema(
43
+ {
44
+ facilityId: {
45
+ type: mongoose.Schema.Types.ObjectId,
46
+ ref: "Facility",
47
+ required: true,
48
+ },
49
+ name: {
50
+ type: String,
51
+ required: true,
52
+ },
53
+ description: {
54
+ type: String,
55
+ },
56
+ skuDetails: {
57
+ type: String,
58
+ required: true,
59
+ },
60
+ quantityInStock: {
61
+ type: Number,
62
+ required: true,
63
+ min: 0,
64
+ },
65
+ reOrderLevel: {
66
+ type: Number,
67
+ required: true,
68
+ min: 0,
69
+ },
70
+ // New metadata field to track all stock changes
71
+ metadata: [stockMetadataSchema],
72
+ },
73
+ {
74
+ timestamps: true,
75
+ },
76
+ );
77
+
78
+ // Pre-save middleware to automatically add metadata entry when quantity changes
79
+ stockAndSparesSchema.pre("save", function (next) {
80
+ if (this.isModified("quantityInStock") && !this.isNew) {
81
+ // Get the original document to compare quantities
82
+ const originalDoc = this.constructor.findById(this._id);
83
+ originalDoc.then((original) => {
84
+ if (original && original.quantityInStock !== this.quantityInStock) {
85
+ const quantityChanged = this.quantityInStock - original.quantityInStock;
86
+ const changeType =
87
+ quantityChanged > 0
88
+ ? "increment"
89
+ : quantityChanged < 0
90
+ ? "decrement"
91
+ : "adjustment";
92
+
93
+ // Add metadata entry (you can set description and userId from your controller)
94
+ this.metadata.push({
95
+ previousQuantity: original.quantityInStock,
96
+ newQuantity: this.quantityInStock,
97
+ quantityChanged: quantityChanged,
98
+ changeType: changeType,
99
+ description:
100
+ this._metadataDescription ||
101
+ `Stock ${changeType}: ${Math.abs(quantityChanged)} units`,
102
+ userId: this._userId || null,
103
+ });
104
+ }
105
+ });
106
+ }
107
+ next();
108
+ });
109
+
110
+ // Instance method to add stock with metadata
111
+ stockAndSparesSchema.methods.addStock = function (
112
+ quantity,
113
+ description,
114
+ userId,
115
+ ) {
116
+ const previousQuantity = this.quantityInStock;
117
+ this.quantityInStock += quantity;
118
+
119
+ this.metadata.push({
120
+ previousQuantity: previousQuantity,
121
+ newQuantity: this.quantityInStock,
122
+ quantityChanged: quantity,
123
+ changeType: "increment",
124
+ description: description || `Added ${quantity} units to stock`,
125
+ userId: userId,
126
+ });
127
+
128
+ return this.save();
129
+ };
130
+
131
+ // Instance method to reduce stock with metadata
132
+ stockAndSparesSchema.methods.reduceStock = function (
133
+ quantity,
134
+ description,
135
+ userId,
136
+ ) {
137
+ if (this.quantityInStock < quantity) {
138
+ throw new Error("Insufficient stock quantity");
139
+ }
140
+
141
+ const previousQuantity = this.quantityInStock;
142
+ this.quantityInStock -= quantity;
143
+
144
+ this.metadata.push({
145
+ previousQuantity: previousQuantity,
146
+ newQuantity: this.quantityInStock,
147
+ quantityChanged: -quantity,
148
+ changeType: "decrement",
149
+ description: description || `Removed ${quantity} units from stock`,
150
+ userId: userId,
151
+ });
152
+
153
+ return this.save();
154
+ };
155
+
156
+ // Instance method to get stock history
157
+ stockAndSparesSchema.methods.getStockHistory = function () {
158
+ return this.metadata.sort((a, b) => b.timestamp - a.timestamp);
159
+ };
160
+
161
+ module.exports = mongoose.model("Stocksandspare", stockAndSparesSchema);