@cendo/database-schemas 2.1.9 → 2.2.1

package/schemas/SourceOrder.js

@@ -1,45 +1,57 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * SourceOrder — Raw order data from the source platform.
+ * Used as a staging area before processing into internal Order records.
+ */
 const SourceOrder = new Schema({
+    /** Source platform type (default 'shopify') */
     type: {
         type: String,
         trim: true,
         default: 'shopify',
     },
 
+    /** Order ID on the source platform */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Order display name on the source platform (e.g., "#1001") */
     name: {
         type: String,
         trim: true,
     },
 
+    /** Payment status from the source platform (lowercase) */
     financial_status: {
         type: String,
         trim: true,
         lowercase: true,
     },
 
+    /** Fulfillment status from the source platform (lowercase) */
     fulfillment_status: {
         type: String,
         trim: true,
         lowercase: true,
     },
 
+    /** Last time this record was synced from the platform */
     synced_at: {
         type: Date,
     },
 
+    /** Last modification timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/TestResponse.js

@@ -1,30 +1,40 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * TestResponse — Test/webhook response logging.
+ * Records HTTP responses for debugging webhook deliveries.
+ */
 const TestResponse = new Schema({
+    /** URL that was called */
     url: {
         type: String,
         trim: true,
     },
 
+    /** HTTP response status code */
     code: {
         type: Number,
     },
 
+    /** Response message or error description */
     message: {
         type: String,
         trim: true,
     },
 
+    /** Full response body/data */
     data: {
         type: Schema.Types.Mixed,
     },
 
+    /** Last modification timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/WebhookEvent.js

@@ -1,39 +1,50 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * WebhookEvent — Webhook event queue.
+ * Stores incoming webhook payloads for processing. Auto-deleted after 7 days via TTL index.
+ */
 const WebhookEvent = new Schema({
+    /** Processing status */
     status: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Source platform type */
     type: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Webhook topic/event name */
     topic: {
         type: String,
         index: true,
         required: true,
     },
 
+    /** Raw webhook payload data */
     payload: {
         type: Schema.Types.Mixed,
         default: {},
     },
 
+    /** Whether this is a test webhook event */
     is_test: {
         type: Boolean,
         default: false,
     },
 
+    /** Last modification timestamp */
     updated_at: {
         type: Date,
     },
 
+    /** Creation timestamp (TTL: 7 days) */
     created_at: {
         type: Date,
         default: Date.now,
@@ -44,4 +55,3 @@ const WebhookEvent = new Schema({
 
 
 module.exports = WebhookEvent
-

package/schemas/types/AttachmentObject.js

@@ -1,9 +1,14 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * AttachmentObject — File attachment.
+ * Embedded as array in Order for customer-uploaded images.
+ */
 const AttachmentObject = new Schema({
     _id: false,
 
+    /** Attachment type: 'image' */
     type: {
         type: String,
         trim: true,
@@ -11,6 +16,7 @@ const AttachmentObject = new Schema({
         enum: ['image'],
     },
 
+    /** Public URL of the attachment */
     url: {
         type: String,
         trim: true,

package/schemas/types/DimensionObject.js

@@ -1,13 +1,19 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * DimensionObject — Image dimensions.
+ * Embedded in Media to store width/height in pixels.
+ */
 const DimensionObject = new Schema({
     _id: false,
 
+    /** Width in pixels */
     width: {
         type: Number,
     },
 
+    /** Height in pixels */
     height: {
         type: Number,
     }

package/schemas/types/FulfillmentObject.js

@@ -1,14 +1,20 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * FulfillmentObject — Fulfillment status summary.
+ * Embedded as array in Order to track fulfillment numbers and their production status.
+ */
 const FulfillmentObject = new Schema({
     _id: false,
 
+    /** Fulfillment/shipment number */
     number: {
         type: String,
         trim: true,
     },
 
+    /** Current production status */
     production_status: {
         type: String,
         trim: true,

package/schemas/types/MoneyObject.js

@@ -1,13 +1,19 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * MoneyObject — Currency-aware monetary amount.
+ * Embedded in Order. Default currency is VND (Vietnamese Dong).
+ */
 const MoneyObject = new Schema({
     _id: false,
 
+    /** Monetary value */
     amount: {
         type: Number,
     },
 
+    /** ISO currency code (default 'VND', uppercase) */
     currency: {
         type: String,
         trim: true,

package/schemas/types/ShippingAddress.js

@@ -1,73 +1,90 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * ShippingAddress — Recipient's shipping/delivery address.
+ * Embedded in Order. Includes Vietnam-specific fields (district, commune).
+ */
 const ShippingAddress = new Schema({
     _id: false,
 
+    /** Customer username/account name on the platform */
     username: {
         type: String,
         trim: true,
     },
 
+    /** Full name of the recipient */
     name: {
         type: String,
         trim: true,
     },
 
+    /** Primary address line */
     address1: {
         type: String,
         trim: true,
     },
 
+    /** Secondary address line (apartment, suite, etc.) */
     address2: {
         type: String,
         trim: true,
     },
 
+    /** City name */
     city: {
         type: String,
         trim: true,
     },
 
+    /** Postal/ZIP code */
     zip: {
         type: String,
         trim: true,
     },
 
+    /** Province or state */
     province: {
         type: String,
         trim: true
     },
 
+    /** District (Vietnam-specific administrative division) */
     district: {
         type: String,
         trim: true
     },
 
+    /** Commune/ward (Vietnam-specific administrative division) */
     commune: {
         type: String,
         trim: true
     },
 
+    /** Country name or code */
     country: {
         type: String,
         trim: true,
     },
 
+    /** Phone number (may include formatting) */
     phone: {
         type: String,
         trim: true,
     },
 
+    /** Phone number without formatting (digits only) */
     phone_plain_text: {
         type: String,
         trim: true,
     },
 
+    /** Customer email address */
     email: {
         type: String,
         trim: true,
     }
 })
 
-module.exports = ShippingAddress
+module.exports = ShippingAddress

package/schemas/types/TrackingObject.js

@@ -1,23 +1,30 @@
 const {Schema} = require('mongoose')
 
 
+/**
+ * TrackingObject — Shipping tracking info.
+ * Embedded in OrderFulfillment for carrier tracking details.
+ */
 const TrackingObject = new Schema({
     _id: false,
 
+    /** Carrier tracking number */
     tracking_number: {
         type: String,
         trim: true,
     },
 
+    /** URL to track the shipment */
     tracking_url: {
         type: String,
         trim: true,
     },
 
+    /** Carrier name or code */
     carrier: {
         type: String,
         trim: true,
     },
 })
 
-module.exports = TrackingObject
+module.exports = TrackingObject