@pintahub/database-schemas 4.5.0 → 4.6.1

package/schemas/ImageObject.js

@@ -1,28 +1,34 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded image reference sub-document. Used in Product, Collection, Post, StoreSetting. */
 const ImageObject = new Schema({
     _id: false,
 
+    /** Image source ID */
     id: {
         type: String,
         trim: true,
     },
 
+    /** Alternative text for accessibility */
     altText: {
         type: String,
         trim: true,
     },
 
+    /** Image URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** Width in pixels */
     width: {
         type: Number,
     },
 
+    /** Height in pixels */
     height: {
         type: Number,
     }

package/schemas/LatestEvent.js

@@ -1,68 +1,82 @@
 const {Schema} = require('mongoose')
 
 
+/** Latest event snapshots — TTL: 30 days */
 const LatestEvent = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Product — related product (if applicable) */
     product: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Visitor session identifier */
     session_id: {
         type: String,
         trim: true,
     },
 
+    /** Event name, e.g. 'page_view', 'add_to_cart' */
     name: {
         type: String,
         trim: true,
         lowercase: true,
     },
 
+    /** URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** IP address */
     ip: {
         type: String,
         trim: true,
     },
 
+    /** ISO country code (uppercase) */
     country: {
         type: String,
         trim: true,
         uppercase: true,
     },
 
+    /** Browser user agent string */
     user_agent: {
         type: String,
         trim: true,
     },
 
+    /** Extra event data */
     meta: {
         type: Schema.Types.Mixed,
         default: {}
     },
 
+    /** Visitor type: 'human' or 'bot' */
     viewer_type: {
         type: String,
         trim: true,
     },
 
+    /** HTTP referrer domain */
     referrer_domain: {
         type: String,
         trim: true,
     },
 
+    /** @ref StoreEvent — original event this snapshot was derived from */
     from_event: {
         type: Schema.Types.ObjectId,
     },
 
+    /** TTL: auto-expires after 30 days */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/LogURL.js

@@ -1,33 +1,40 @@
 const {Schema} = require('mongoose')
 
 
+/** General URL logging */
 const LogURL = new Schema({
+    /** Original URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** Redirect target URL */
     destination_url: {
         type: String,
         trim: true,
     },
 
+    /** Country code (default 'VN') */
     country: {
         type: String,
         trim: true,
         default: 'VN'
     },
 
+    /** Domain name */
     domain: {
         type: String,
         trim: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now

package/schemas/MarketingCost.js

@@ -2,67 +2,80 @@ const {Schema} = require('mongoose')
 const MoneyObject = require('./MoneyObject')
 
 
+/** Ad campaign cost tracking per product */
 const MarketingCost = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         index: true
     },
 
+    /** When the associated product was published */
     product_published_at: {
         type: Date,
         index: true,
     },
 
+    /** Ad campaign name */
     campaign_name: {
         type: String,
         trim: true
     },
 
+    /** Ad platform campaign ID */
     campaign_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Date the campaign ran */
     campaign_date: {
         type: Date,
         index: true,
     },
 
+    /** Ad account name */
     account_name: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Campaign cost amount */
     cost: {
         type: MoneyObject,
         required: true
     },
 
+    /** Cost date */
     date: {
         type: Date,
         required: true,
         index: true
     },
 
+    /** Date as string "YYYY-MM-DD" for grouping */
     date_string: {
         type: String,
         required: true,
         index: true
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now

package/schemas/Media.js

@@ -1,24 +1,29 @@
 const {Schema} = require('mongoose')
 
 
+/** General media files */
 const Media = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** External media ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** Upload/processing status, e.g. 'pending', 'completed' */
     status: {
         type: String,
         trim: true,
@@ -26,32 +31,38 @@ const Media = new Schema({
         default: 'pending'
     },
 
+    /** Media type, e.g. 'MediaImage' */
     type: {
         type: String,
         trim: true,
         default: 'MediaImage',
     },
 
+    /** MIME type, e.g. image/png */
     mimetype: {
         type: String,
         trim: true,
     },
 
+    /** File size in bytes */
     size: {
         type: Number,
     },
 
+    /** Processing retry count */
     attempts: {
         type: Number,
         default: 0,
         index: true
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/MediaUpload.js

@@ -1,78 +1,93 @@
 const {Schema} = require('mongoose')
 
 
+/** Media upload tracking per product */
 const MediaUpload = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Sort order */
     position: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Variant color to match this media to */
     color: {
         type: String,
         trim: true,
     },
 
+    /** Whether this media has been matched to a variant */
     is_matched: {
         type: Boolean,
         default: false,
     },
 
+    /** Original file name */
     file_name: {
         type: String,
         trim: true,
     },
 
+    /** Storage file path */
     path_file: {
         type: String,
         trim: true,
     },
 
+    /** File size in bytes */
     size: {
         type: Number,
     },
 
+    /** MIME type, e.g. image/png */
     mimetype: {
         type: String,
         trim: true,
     },
 
+    /** Upload status, e.g. 'pending', 'completed' */
     status: {
         type: String,
         trim: true,
         default: 'pending',
     },
 
+    /** When the upload was processed */
     processed_at: {
         type: Date,
     },
 
+    /** External media ID */
     id: {
         type: String,
         trim: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now
     }
 })
 
-module.exports = MediaUpload
+module.exports = MediaUpload

package/schemas/Menu.js

@@ -1,46 +1,55 @@
 const {Schema} = require('mongoose')
 
 
+/** Navigation menu */
 const Menu = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify menu ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** URL-friendly slug */
     handle: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Display title */
     title: {
         type: String,
         trim: true,
     },
 
+    /** Number of menu items */
     items_count: {
         type: Number,
         default: 0,
     },
 
+    /** Shopify sync identifier */
     sync_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/MenuItem.js

@@ -1,73 +1,87 @@
 const {Schema} = require('mongoose')
 
 
+/** Navigation menu item (hierarchical via parent ref) */
 const MenuItem = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Menu */
     menu: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify menu item ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Display title */
     title: {
         type: String,
         trim: true,
     },
 
+    /** Link destination URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** Link type, e.g. 'http', 'collection', 'page' */
     type: {
         type: String,
         trim: true,
     },
 
+    /** Number of child menu items */
     items_count: {
         type: Number,
         default: 0,
     },
 
+    /** @ref MenuItem — parent item for nesting */
     parent: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Sort order */
     position: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Nesting level (0 = top level) */
     depth: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Shopify sync identifier */
     sync_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/MoneyObject.js

@@ -1,14 +1,17 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded sub-document for monetary values */
 const MoneyObject = new Schema({
     _id: false,
 
+    /** Monetary value */
     amount: {
         type: Number,
         index: true,
     },
 
+    /** ISO 4217 currency code, default 'USD' */
     currency: {
         type: String,
         trim: true,