@pintahub/database-schemas 4.4.8 → 4.6.0

package/schemas/CustomField.js

@@ -2,44 +2,53 @@ const {Schema} = require('mongoose')
 const FieldSetting= require('./FieldSetting')
 
 
+/** Dynamic field definition for product customization */
 const CustomField = new Schema({
+    /** @ref Customize — parent customization config */
     customize: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Field type, e.g. 'text', 'select', 'image' */
     type: {
         type: String,
         trim: true,
         required: true,
     },
 
+    /** Field display label */
     label: {
         type: String,
         trim: true,
         required: true,
     },
 
+    /** Description */
     description: {
         type: String,
         trim: true,
     },
 
+    /** Whether this field is required for the customer to fill */
     required: {
         type: Boolean,
         default: true,
     },
 
+    /** Field configuration (placeholder, max_length, etc.) */
     settings: {
         type: FieldSetting,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now

package/schemas/Customize.js

@@ -1,19 +1,23 @@
 const {Schema} = require('mongoose')
 
 
+/** Product customization configuration */
 const Customize = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Unique customization identifier */
     code: {
         type: String,
         required: true,
@@ -21,6 +25,11 @@ const Customize = new Schema({
         index: true,
     },
 
+    /**
+     * Customization status:
+     * - draft: not yet active
+     * - active: live on storefront
+     */
     status: {
         type: String,
         trim: true,
@@ -29,21 +38,25 @@ const Customize = new Schema({
         index: true,
     },
 
+    /** Description */
     description: {
         type: String,
         trim: true,
     },
 
+    /** Customization version, e.g. 'basic', 'advanced' */
     version: {
         type: String,
         default: 'basic'
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now

package/schemas/DimensionObject.js

@@ -1,13 +1,16 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded sub-document for width/height dimensions */
 const DimensionObject = new Schema({
     _id: false,
 
+    /** Width in pixels */
     width: {
         type: Number,
     },
 
+    /** Height in pixels */
     height: {
         type: Number,
     }

package/schemas/ExportJob.js

@@ -1,34 +1,46 @@
 const {Schema} = require('mongoose')
 
 
+/** Data export job for bulk data extraction */
 const ExportJob = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         required: true,
         index: true
     },
 
+    /** Export type, e.g. 'products', 'orders' */
     zone: {
         type: String,
         trim: true,
         required: true,
     },
 
+    /** Export template name */
     template: {
         type: String,
         trim: true,
     },
 
+    /** Query filter criteria */
     filter: {
         type: Schema.Types.Mixed,
         default: {}
     },
 
+    /** MongoDB query object */
     query: {
         type: Schema.Types.Mixed,
         default: {}
     },
 
+    /**
+     * Export job status:
+     * - pending: queued for processing
+     * - completed: export finished successfully
+     * - failed: export encountered an error
+     */
     status: {
         type: String,
         trim: true,
@@ -36,34 +48,41 @@ const ExportJob = new Schema({
         enum: ['pending', 'completed', 'failed']
     },
 
+    /** Number of rows processed so far */
     processing_rows: {
         type: Number,
         default: 0,
     },
 
+    /** Total number of rows to export */
     rows_count: {
         type: Number,
     },
 
+    /** Output file path */
     path_file: {
         type: String,
         trim: true
     },
 
+    /** Error message if failed */
     error_message: {
         type: String,
         trim: true
     },
 
+    /** @ref Account — who initiated the export */
     created_by: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,
@@ -72,4 +91,3 @@ const ExportJob = new Schema({
 })
 
 module.exports = ExportJob
-

package/schemas/FavoriteItem.js

@@ -1,13 +1,16 @@
 const {Schema} = require('mongoose')
 
 
+/** Favorited products per visitor session */
 const FavoriteItem = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Visitor session identifier */
     session_id: {
         type: String,
         trim: true,
@@ -15,23 +18,27 @@ const FavoriteItem = new Schema({
         required: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         required: true,
     },
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** ISO country code (uppercase) */
     country: {
         type: String,
         trim: true,
         uppercase: true
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,
@@ -39,6 +46,7 @@ const FavoriteItem = new Schema({
     }
 })
 
+/** Compound index: one favorite per product per session per store */
 FavoriteItem.index({
     store: 1,
     session_id: 1,
@@ -46,4 +54,3 @@ FavoriteItem.index({
 })
 
 module.exports = FavoriteItem
-

package/schemas/FieldSetting.js

@@ -1,14 +1,17 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded settings for CustomField configuration */
 const FieldSetting = new Schema({
     _id: false,
 
+    /** Input placeholder text */
     placeholder: {
         type: String,
         trim: true,
     },
 
+    /** Maximum character length for input */
     max_length: {
         type: Number,
     },

package/schemas/Fulfillment.js

@@ -1,30 +1,36 @@
 const {Schema} = require('mongoose')
 
 
+/** Shipment tracking for orders */
 const Fulfillment = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Order */
     order: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify fulfillment ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Display name */
     name: {
         type: String,
         trim: true,
     },
 
+    /** Shipment status, e.g. 'in_transit', 'delivered' */
     shipment_status: {
         type: String,
         trim: true,
@@ -32,36 +38,43 @@ const Fulfillment = new Schema({
         index: true,
     },
 
+    /** Shipment tracking number */
     tracking_number: {
         type: String,
         trim: true,
     },
 
+    /** Tracking URL for the shipment */
     tracking_url: {
         type: String,
         trim: true,
     },
 
+    /** Shipping carrier name */
     tracking_company: {
         type: String,
         trim: true,
     },
 
+    /** Whether to send tracking notification to customer */
     notify_customer: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** When the customer was notified */
     notified_at: {
         type: Date,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,
@@ -70,4 +83,3 @@ const Fulfillment = new Schema({
 })
 
 module.exports = Fulfillment
-

package/schemas/Group.js

@@ -1,13 +1,16 @@
 const {Schema} = require('mongoose')
 
 
+/** Product grouping/bundles */
 const Group = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Unique group identifier */
     code: {
         required: true,
         type: String,
@@ -15,50 +18,59 @@ const Group = new Schema({
         index: true
     },
 
+    /** External system ID (e.g. from import) */
     external_id: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Display title */
     title: {
         type: String,
         trim: true,
     },
 
+    /** Description */
     description: {
         type: String,
         trim: true,
     },
 
+    /** Display label on storefront */
     label: {
         type: String,
         trim: true,
     },
 
+    /** Number of products in this group */
     items_count: {
         type: Number,
         default: 0,
         index: true
     },
 
+    /** Display style, e.g. 'popup', 'inline' */
     style: {
         type: String,
         trim: true,
         default: 'popup'
     },
 
+    /** Group color for UI display */
     color: {
         type: String,
         trim: true,
     },
 
+    /** Tags */
     tags: {
         type: [String],
         default: [],
         index: true
     },
 
+    /** Group status, e.g. 'active', 'inactive' */
     status: {
         type: String,
         default: 'active',
@@ -66,6 +78,7 @@ const Group = new Schema({
         index: true
     },
 
+    /** Visibility on storefront: 'visible' or 'hidden' */
     visibility: {
         type: String,
         trim: true,
@@ -73,43 +86,51 @@ const Group = new Schema({
         default: 'visible',
     },
 
+    /** Extra metadata */
     meta: {
         type: Schema.Types.Mixed,
         default: {}
     },
 
+    /** @ref Product — representative product for this group */
     featured_product: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Trello card ID for project tracking */
     trello_id: {
         type: String,
         trim: true,
     },
 
+    /** Design idea or concept notes */
     user_idea: {
         type: String,
         trim: true,
     },
 
+    /** Total sales count */
     sales_count: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Total page views */
     views_count: {
         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,
@@ -118,4 +139,3 @@ const Group = new Schema({
 })
 
 module.exports = Group
-

package/schemas/GroupArtwork.js

@@ -1,35 +1,42 @@
 const {Schema} = require('mongoose')
 
 
+/** Artwork assigned to a product group */
 const GroupArtwork = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Group */
     group: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Artwork */
     artwork: {
         type: Schema.Types.ObjectId,
         required: true,
     },
 
+    /** Print placement, e.g. 'front', 'back' */
     location: {
         type: String,
         trim: true,
         default: 'front'
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now
@@ -37,4 +44,3 @@ const GroupArtwork = new Schema({
 })
 
 module.exports = GroupArtwork
-

package/schemas/GroupItem.js

@@ -1,46 +1,55 @@
 const {Schema} = require('mongoose')
 
+/** Item within a product group */
 const GroupItem = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Group */
     group: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Display label for this item in the group */
     label: {
         type: String,
         trim: true,
     },
 
+    /** Sort order within the group */
     index: {
         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
@@ -48,4 +57,3 @@ const GroupItem = new Schema({
 })
 
 module.exports = GroupItem
-

package/schemas/Image.js

@@ -2,36 +2,44 @@ const {Schema} = require('mongoose')
 const DimensionObject = require('./DimensionObject')
 
 
+/** Stored image file */
 const Image = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Storage file path */
     path: {
         type: String,
         trim: true
     },
 
+    /** Image width/height */
     dimension: {
         type: DimensionObject
     },
 
+    /** MIME type, e.g. image/png */
     mimetype: {
         type: String,
         trim: true,
     },
 
+    /** File size in bytes */
     size: {
         type: Number,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now