payservedb 8.4.6 → 8.4.8

package/src/models/zohoIntegration.js

@@ -1,262 +1,262 @@
-const mongoose = require("mongoose");
-
-const ZohoIntegrationSchema = new mongoose.Schema(
-  {
-    facilityId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "Facility",
-      required: [true, "Facility ID is required"],
-      unique: true,
-      index: true,
-    },
-
-    // Zoho API Credentials
-    // NOTE: clientSecret, refreshToken, and accessToken should be encrypted before storage
-    clientId: {
-      type: String,
-      required: [true, "Zoho Client ID is required"],
-      trim: true,
-    },
-    clientSecret: {
-      type: String,
-      required: [true, "Zoho Client Secret is required"],
-      trim: true,
-      // This field should be encrypted in the application layer
-    },
-    refreshToken: {
-      type: String,
-      required: [true, "Zoho Refresh Token is required"],
-      trim: true,
-      // This field should be encrypted in the application layer
-    },
-    accessToken: {
-      type: String,
-      trim: true,
-      default: null,
-      // This field should be encrypted in the application layer
-      // Auto-refreshed by the system
-    },
-    organizationId: {
-      type: String,
-      required: [true, "Zoho Organization ID is required"],
-      trim: true,
-    },
-
-    // Integration Status
-    isActive: {
-      type: Boolean,
-      default: true,
-    },
-    connectionStatus: {
-      type: String,
-      enum: ["connected", "disconnected", "error", "pending"],
-      default: "pending",
-    },
-    connectionError: {
-      type: String,
-      trim: true,
-      default: null,
-    },
-    lastConnectionTest: {
-      type: Date,
-      default: null,
-    },
-
-    // Token Management
-    tokenExpiresAt: {
-      type: Date,
-      default: null,
-    },
-    lastTokenRefreshAt: {
-      type: Date,
-      default: null,
-    },
-    tokenRefreshCount: {
-      type: Number,
-      default: 0,
-      min: [0, "Token refresh count cannot be negative"],
-    },
-
-    // Sync Statistics
-    lastSyncedAt: {
-      type: Date,
-      default: null,
-    },
-    totalInvoicesSynced: {
-      type: Number,
-      default: 0,
-      min: [0, "Total invoices synced cannot be negative"],
-    },
-    totalPaymentsSynced: {
-      type: Number,
-      default: 0,
-      min: [0, "Total payments synced cannot be negative"],
-    },
-    totalCustomersSynced: {
-      type: Number,
-      default: 0,
-      min: [0, "Total customers synced cannot be negative"],
-    },
-    successfulSyncs: {
-      type: Number,
-      default: 0,
-      min: [0, "Successful syncs cannot be negative"],
-    },
-    failedSyncs: {
-      type: Number,
-      default: 0,
-      min: [0, "Failed syncs cannot be negative"],
-    },
-
-    // Sync Configuration
-    autoSyncEnabled: {
-      type: Boolean,
-      default: true,
-    },
-    syncFrequency: {
-      type: String,
-      enum: ["realtime", "hourly", "daily", "manual"],
-      default: "realtime",
-    },
-    lastSyncError: {
-      type: String,
-      trim: true,
-      default: null,
-    },
-
-    // Invoice Sync Settings
-    syncInvoicesOnCreation: {
-      type: Boolean,
-      default: true,
-    },
-    syncPaymentsOnReceipt: {
-      type: Boolean,
-      default: true,
-    },
-    markInvoicesAsSent: {
-      type: Boolean,
-      default: true,
-    },
-
-    // API Configuration
-    apiBaseUrl: {
-      type: String,
-      trim: true,
-      default: "https://www.zohoapis.com/books/v3",
-    },
-    requestTimeout: {
-      type: Number,
-      default: 30000,
-      min: [1000, "Request timeout must be at least 1000ms"],
-    },
-    maxRetries: {
-      type: Number,
-      default: 3,
-      min: [0, "Max retries cannot be negative"],
-      max: [10, "Max retries cannot exceed 10"],
-    },
-
-    // Audit Fields
-    createdBy: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "User",
-      default: null,
-    },
-    updatedBy: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "User",
-      default: null,
-    },
-    lastModifiedBy: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "User",
-      default: null,
-    },
-
-    // Notes and metadata
-    notes: {
-      type: String,
-      trim: true,
-      default: null,
-    },
-    metadata: {
-      type: mongoose.Schema.Types.Mixed,
-      default: {},
-    },
-  },
-  {
-    timestamps: true,
-  }
-);
-
-// Indexes for better query performance
-ZohoIntegrationSchema.index({ facilityId: 1, isActive: 1 });
-ZohoIntegrationSchema.index({ connectionStatus: 1 });
-ZohoIntegrationSchema.index({ lastSyncedAt: -1 });
-
-// Virtual for success rate
-ZohoIntegrationSchema.virtual("syncSuccessRate").get(function () {
-  const total = this.successfulSyncs + this.failedSyncs;
-  if (total === 0) return 0;
-  return ((this.successfulSyncs / total) * 100).toFixed(2);
-});
-
-// Method to mask sensitive fields for API responses
-ZohoIntegrationSchema.methods.toSafeObject = function () {
-  const obj = this.toObject();
-
-  // Mask sensitive fields
-  if (obj.clientSecret) {
-    obj.clientSecret = "••••••••" + obj.clientSecret.slice(-4);
-  }
-  if (obj.refreshToken) {
-    obj.refreshToken = "••••••••" + obj.refreshToken.slice(-4);
-  }
-  if (obj.accessToken) {
-    obj.accessToken = "••••••••" + (obj.accessToken ? obj.accessToken.slice(-4) : "");
-  }
-
-  return obj;
-};
-
-// Method to check if token needs refresh (5 minutes buffer)
-ZohoIntegrationSchema.methods.needsTokenRefresh = function () {
-  if (!this.tokenExpiresAt) return true;
-  const bufferTime = 5 * 60 * 1000; // 5 minutes in milliseconds
-  return new Date().getTime() >= (this.tokenExpiresAt.getTime() - bufferTime);
-};
-
-// Method to increment sync counters
-ZohoIntegrationSchema.methods.incrementSyncCounters = function (type, success = true) {
-  this.lastSyncedAt = new Date();
-
-  if (type === "invoice") {
-    this.totalInvoicesSynced += 1;
-  } else if (type === "payment") {
-    this.totalPaymentsSynced += 1;
-  } else if (type === "customer") {
-    this.totalCustomersSynced += 1;
-  }
-
-  if (success) {
-    this.successfulSyncs += 1;
-    this.lastSyncError = null;
-  } else {
-    this.failedSyncs += 1;
-  }
-
-  return this.save();
-};
-
-// Pre-save hook to update timestamps
-ZohoIntegrationSchema.pre("save", function (next) {
-  this.updatedAt = new Date();
-  next();
-});
-
-const ZohoIntegration = mongoose.model(
-  "ZohoIntegration",
-  ZohoIntegrationSchema
-);
-
-module.exports = ZohoIntegration;
+const mongoose = require("mongoose");
+
+const ZohoIntegrationSchema = new mongoose.Schema(
+  {
+    facilityId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Facility",
+      required: [true, "Facility ID is required"],
+      unique: true,
+      index: true,
+    },
+
+    // Zoho API Credentials
+    // NOTE: clientSecret, refreshToken, and accessToken should be encrypted before storage
+    clientId: {
+      type: String,
+      required: [true, "Zoho Client ID is required"],
+      trim: true,
+    },
+    clientSecret: {
+      type: String,
+      required: [true, "Zoho Client Secret is required"],
+      trim: true,
+      // This field should be encrypted in the application layer
+    },
+    refreshToken: {
+      type: String,
+      required: [true, "Zoho Refresh Token is required"],
+      trim: true,
+      // This field should be encrypted in the application layer
+    },
+    accessToken: {
+      type: String,
+      trim: true,
+      default: null,
+      // This field should be encrypted in the application layer
+      // Auto-refreshed by the system
+    },
+    organizationId: {
+      type: String,
+      required: [true, "Zoho Organization ID is required"],
+      trim: true,
+    },
+
+    // Integration Status
+    isActive: {
+      type: Boolean,
+      default: true,
+    },
+    connectionStatus: {
+      type: String,
+      enum: ["connected", "disconnected", "error", "pending"],
+      default: "pending",
+    },
+    connectionError: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    lastConnectionTest: {
+      type: Date,
+      default: null,
+    },
+
+    // Token Management
+    tokenExpiresAt: {
+      type: Date,
+      default: null,
+    },
+    lastTokenRefreshAt: {
+      type: Date,
+      default: null,
+    },
+    tokenRefreshCount: {
+      type: Number,
+      default: 0,
+      min: [0, "Token refresh count cannot be negative"],
+    },
+
+    // Sync Statistics
+    lastSyncedAt: {
+      type: Date,
+      default: null,
+    },
+    totalInvoicesSynced: {
+      type: Number,
+      default: 0,
+      min: [0, "Total invoices synced cannot be negative"],
+    },
+    totalPaymentsSynced: {
+      type: Number,
+      default: 0,
+      min: [0, "Total payments synced cannot be negative"],
+    },
+    totalCustomersSynced: {
+      type: Number,
+      default: 0,
+      min: [0, "Total customers synced cannot be negative"],
+    },
+    successfulSyncs: {
+      type: Number,
+      default: 0,
+      min: [0, "Successful syncs cannot be negative"],
+    },
+    failedSyncs: {
+      type: Number,
+      default: 0,
+      min: [0, "Failed syncs cannot be negative"],
+    },
+
+    // Sync Configuration
+    autoSyncEnabled: {
+      type: Boolean,
+      default: true,
+    },
+    syncFrequency: {
+      type: String,
+      enum: ["realtime", "hourly", "daily", "manual"],
+      default: "realtime",
+    },
+    lastSyncError: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+
+    // Invoice Sync Settings
+    syncInvoicesOnCreation: {
+      type: Boolean,
+      default: true,
+    },
+    syncPaymentsOnReceipt: {
+      type: Boolean,
+      default: true,
+    },
+    markInvoicesAsSent: {
+      type: Boolean,
+      default: true,
+    },
+
+    // API Configuration
+    apiBaseUrl: {
+      type: String,
+      trim: true,
+      default: "https://www.zohoapis.com/books/v3",
+    },
+    requestTimeout: {
+      type: Number,
+      default: 30000,
+      min: [1000, "Request timeout must be at least 1000ms"],
+    },
+    maxRetries: {
+      type: Number,
+      default: 3,
+      min: [0, "Max retries cannot be negative"],
+      max: [10, "Max retries cannot exceed 10"],
+    },
+
+    // Audit Fields
+    createdBy: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "User",
+      default: null,
+    },
+    updatedBy: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "User",
+      default: null,
+    },
+    lastModifiedBy: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "User",
+      default: null,
+    },
+
+    // Notes and metadata
+    notes: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    metadata: {
+      type: mongoose.Schema.Types.Mixed,
+      default: {},
+    },
+  },
+  {
+    timestamps: true,
+  }
+);
+
+// Indexes for better query performance
+ZohoIntegrationSchema.index({ facilityId: 1, isActive: 1 });
+ZohoIntegrationSchema.index({ connectionStatus: 1 });
+ZohoIntegrationSchema.index({ lastSyncedAt: -1 });
+
+// Virtual for success rate
+ZohoIntegrationSchema.virtual("syncSuccessRate").get(function () {
+  const total = this.successfulSyncs + this.failedSyncs;
+  if (total === 0) return 0;
+  return ((this.successfulSyncs / total) * 100).toFixed(2);
+});
+
+// Method to mask sensitive fields for API responses
+ZohoIntegrationSchema.methods.toSafeObject = function () {
+  const obj = this.toObject();
+
+  // Mask sensitive fields
+  if (obj.clientSecret) {
+    obj.clientSecret = "••••••••" + obj.clientSecret.slice(-4);
+  }
+  if (obj.refreshToken) {
+    obj.refreshToken = "••••••••" + obj.refreshToken.slice(-4);
+  }
+  if (obj.accessToken) {
+    obj.accessToken = "••••••••" + (obj.accessToken ? obj.accessToken.slice(-4) : "");
+  }
+
+  return obj;
+};
+
+// Method to check if token needs refresh (5 minutes buffer)
+ZohoIntegrationSchema.methods.needsTokenRefresh = function () {
+  if (!this.tokenExpiresAt) return true;
+  const bufferTime = 5 * 60 * 1000; // 5 minutes in milliseconds
+  return new Date().getTime() >= (this.tokenExpiresAt.getTime() - bufferTime);
+};
+
+// Method to increment sync counters
+ZohoIntegrationSchema.methods.incrementSyncCounters = function (type, success = true) {
+  this.lastSyncedAt = new Date();
+
+  if (type === "invoice") {
+    this.totalInvoicesSynced += 1;
+  } else if (type === "payment") {
+    this.totalPaymentsSynced += 1;
+  } else if (type === "customer") {
+    this.totalCustomersSynced += 1;
+  }
+
+  if (success) {
+    this.successfulSyncs += 1;
+    this.lastSyncError = null;
+  } else {
+    this.failedSyncs += 1;
+  }
+
+  return this.save();
+};
+
+// Pre-save hook to update timestamps
+ZohoIntegrationSchema.pre("save", function (next) {
+  this.updatedAt = new Date();
+  next();
+});
+
+const ZohoIntegration = mongoose.model(
+  "ZohoIntegration",
+  ZohoIntegrationSchema
+);
+
+module.exports = ZohoIntegration;