@pintahub/database-schemas 4.5.0 → 4.6.1

package/schemas/Product.js

@@ -3,202 +3,241 @@ const ImageObject = require('./ImageObject')
 const PriceRange = require('./PriceRange')
 
 
+/** Embedded product import source */
 const ProductSource = new Schema({
     _id: false,
 
+    /** @ref ProductImport */
     job: {
         type: Schema.Types.ObjectId,
     }
 })
 
+/** Embedded product metadata for Google Shopping */
 const ProductMeta = new Schema({
     _id: false,
 
+    /** Primary product color */
     main_color: {
         type: String,
         trim: true,
     },
 
+    /** Target age group */
     age_group: {
         type: String,
         trim: true,
     },
 
+    /** Target gender */
     gender: {
         type: String,
         trim: true,
     },
 })
 
+/** Core product */
 const Product = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Shop */
     shop: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Shopify product 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,
     },
 
+    /** Alternative/secondary title */
     alternative_title: {
         type: String,
         trim: true,
     },
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Product category */
     category: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Product status, e.g. 'draft', 'active', 'archived' */
     status: {
         type: String,
         default: 'draft',
         index: true
     },
 
+    /** Featured image */
     featured_image: {
         type: ImageObject,
     },
 
+    /** Current selling price range */
     price_range: {
         type: PriceRange,
         default: {},
     },
 
+    /** Original price range (before discount) */
     compare_at_price_range: {
         type: PriceRange,
         default: {},
     },
 
+    /** Publish date */
     published_at: {
         type: Date,
         index: true
     },
 
+    /** Tags */
     tags: {
         type: [String],
         trim: true,
         index: true,
     },
 
+    /** @ref Collection — collections this product belongs to */
     collections: {
         type: [Schema.Types.ObjectId],
         default: [],
         index: true,
     },
 
+    /** Publication channel IDs */
     publications: {
         type: [String],
         default: [],
         index: true,
     },
 
+    /** Number of carts containing this product */
     count_in_carts: {
         type: Number,
     },
 
+    /** @ref ProductFeature — extended product details */
     product_feature: {
         type: Schema.Types.ObjectId,
     },
 
+    /** @ref ProductRaw — raw synced data */
     raw: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Whether this product is on sale */
     is_sale_off: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** Product vendor */
     vendor: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** @ref Group — product group/bundle */
     group: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Last Shopify sync timestamp */
     last_synced_at: {
         type: Date,
         default: Date.now,
         index: true,
     },
 
+    /** Total page views */
     views_count: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** @ref Product — original product (for transfers) */
     source_product: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Google Shopping metadata */
     meta: {
         type: ProductMeta,
         default: {}
     },
 
-    is_imported: {//temporary filed for importing product
+    /** Temporary flag: product import in progress */
+    is_imported: {
         type: Boolean,
         default: false,
         index: true,
     },
 
-    is_uploaded: {//temporary filed for uploading product images
+    /** Temporary flag: image upload in progress */
+    is_uploaded: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** Trello card ID for project tracking */
     trello_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** SKU / internal product code */
     code: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Design idea or concept notes */
     user_idea: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Visibility on storefront: 'visible' or 'sensitive' */
     visibility: {
         type: String,
         trim: true,
@@ -206,120 +245,143 @@ const Product = new Schema({
         default: 'visible',
     },
 
+    /** Short description */
     short_description: {
         type: String,
         trim: true,
     },
 
+    /** Total sales count */
     sales_count: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Number of times favorited */
     favorites_count: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Import source info */
     source: {
         type: ProductSource,
     },
 
+    /** Whether this is the primary product in a group */
     is_primary: {
         type: Boolean,
         default: true,
         index: true,
     },
 
+    /** Whether product is available for purchase */
     available_for_sale: {
         type: Boolean,
         default: true,
         index: true,
     },
 
+    /** Version identifier */
     version: {
         type: String,
         trim: true,
     },
 
+    /** Highlighted as featured */
     is_featured: {
         type: Boolean,
         default: false,
     },
 
+    /** Marked as trending */
     is_trending: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** @ref Customize — customization config */
     customize: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Whether this product supports customization */
     customizable: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** Page template name */
     template: {
         type: String,
         trim: true,
     },
 
+    /** Featured statistics text */
     featured_stats: {
         type: String,
         trim: true,
     },
 
+    /** Internal notes (not shown to customers) */
     private_note: {
         type: String,
         trim: true,
     },
 
+    /** Advertising notes */
     ads_note: {
         type: String,
         trim: true,
     },
 
+    /** Show description on product page */
     show_description: {
         type: Boolean,
         default: false,
     },
 
+    /** Total media file size */
     media_size: {
         type: Number,
         trim: true,
     },
 
-    stage: {//temporary field for edit product
+    /** Temporary field for product editing workflow */
+    stage: {
         type: String,
         trim: true,
     },
 
-    external_id: {//For id when import from external source
+    /** External ID from import source */
+    external_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Number of times this product has been transferred */
     transfer_count: {
         type: Number,
         default: 0,
     },
 
+    /** Soft delete timestamp */
     deleted_at: {
         type: Date,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now,
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,
@@ -327,6 +389,7 @@ const Product = new Schema({
     }
 })
 
+/** Full-text search index */
 Product.index({
     title: 'text',
     alternative_title: 'text',
@@ -336,4 +399,3 @@ Product.index({
 
 
 module.exports = Product
-

package/schemas/ProductFeature.js

@@ -2,40 +2,49 @@ const {Schema} = require('mongoose')
 const VideoObject = require('./products/VideoObject')
 
 
+/** Embedded size guide image */
 const SizeGuide = new Schema({
     _id: false,
 
+    /** Size guide image URL */
     image_url: {
         type: String,
         trim: true,
     },
 })
 
+/** Embedded date range in days (from/to) */
 const DateRange = new Schema({
     _id: false,
 
+    /** Minimum days */
     from: {
         type: Number,
     },
 
+    /** Maximum days */
     to: {
         type: Number,
     }
 })
 
+/** Extended product details (description, shipping, sizing, etc.) */
 const ProductFeature = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify product ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
@@ -43,80 +52,97 @@ const ProductFeature = new Schema({
         index: true,
     },
 
+    /** Full product description in HTML */
     body_html: {
         type: String,
         trim: true,
     },
 
+    /** Description */
     description: {
         type: String,
         trim: true,
     },
 
+    /** Size guide */
     size_guide: {
         type: SizeGuide,
     },
 
+    /** Production time range in days */
     production_time: {
         type: DateRange,
     },
 
+    /** Shipping time range in days */
     shipping_time: {
         type: DateRange,
     },
 
+    /** Production process description */
     production_description: {
         type: String,
         trim: true,
     },
 
+    /** Ship-from country code */
     country_code: {
         type: String,
         trim: true,
     },
 
+    /** Origin/made-in text */
     origin_text: {
         type: String,
         trim: true,
     },
 
+    /** Product material */
     material: {
         type: String,
         trim: true,
     },
 
+    /** Google Shopping product category */
     google_product_category: {
         type: String,
         trim: true,
     },
 
+    /** Product weight */
     weight: {
         type: Number,
     },
 
+    /** Product video */
     video: {
         type: VideoObject,
     },
 
+    /** Number of reviews */
     reviews_count: {
         type: Number,
         default: 0,
     },
 
+    /** Average review rating (1-5) */
     avg_rating: {
         type: Number,
         default: 5,
     },
 
+    /** Last sync timestamp */
     synced_at: {
         type: Date,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now,
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/ProductImage.js

@@ -1,42 +1,51 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded image dimensions */
 const DimensionObject = new Schema({
     _id: false,
 
+    /** Width in pixels */
     width: {
         type: Number,
     },
 
+    /** Height in pixels */
     height: {
         type: Number,
     }
 })
 
+/** Product image with dimensions and upload status */
 const ProductImage = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify image 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,
@@ -44,30 +53,36 @@ const ProductImage = new Schema({
         default: 'pending'
     },
 
+    /** MIME type, e.g. image/png */
     mimetype: {
         type: String,
         trim: true,
     },
 
+    /** File size in bytes */
     size: {
         type: Number,
     },
 
+    /** Image width/height */
     dimension: {
         type: DimensionObject
     },
 
+    /** Upload 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,