@pintahub/database-schemas 4.4.8 → 4.6.0

package/schemas/ProductImport.js

@@ -1,58 +1,70 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded parsed product data from import */
 const Output = new Schema({
     _id: false,
 
+    /** Display title */
     title: {
         type: String,
         trim: true,
     },
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
     },
 
+    /** Tags */
     tags: {
         type: [String],
         default: [],
     },
 
+    /** Product vendor */
     vendor: {
         type: String,
         trim: true,
     },
 
+    /** Product options (e.g. size, color) */
     options: {
         type: [Schema.Types.Mixed],
         default: [],
     },
 
+    /** Product variants */
     variants: {
         type: [Schema.Types.Mixed],
         default: [],
     },
 
+    /** Product images */
     images: {
         type: [Schema.Types.Mixed],
         default: [],
     },
 })
 
+/** Product import job from external URL */
 const ProductImport = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Source URL to import from */
     url: {
         type: String,
         trim: true,
         required: true,
     },
 
+    /** Import status, e.g. 'pending', 'completed', 'failed' */
     status: {
         type: String,
         trim: true,
@@ -60,51 +72,65 @@ const ProductImport = new Schema({
         index: true,
     },
 
+    /** Source platform, e.g. 'aliexpress', 'amazon' */
     platform: {
         type: String,
         trim: true,
         default: '',
     },
 
+    /** Auto-detect source platform */
     auto_detect: {
         type: Boolean,
         default: false,
     },
 
+    /** @ref Product — products created from this import */
     products: {
         type: [Schema.Types.ObjectId],
         default: [],
     },
 
+    /**
+     * Imported product visibility:
+     * - sensitive: hidden by default
+     * - visible: shown on storefront
+     */
     visibility: {
         type: String,
         default: 'sensitive',
         enum: ['sensitive', 'visible']
     },
 
+    /** Raw scraped data from source */
     raw_data: {
         type: Schema.Types.Mixed,
     },
 
+    /** Parsed product data */
     output: {
         type: Output,
     },
 
+    /** Error message if failed */
     error_message: {
         type: String,
         trim: true,
     },
 
+    /** When processing completed */
     processed_at: {
         type: Date,
         default: Date.now,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now,
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/ProductRaw.js

@@ -3,110 +3,132 @@ const MediaObject = require('./products/MediaObject')
 const SeoObject = require('./products/SeoObject')
 
 
+/** Raw synced product data from source platform (Shopify, etc.) */
 const ProductRaw = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         required: true,
         index: true,
     },
 
+    /** Shopify product ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** URL-friendly slug */
     handle: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Raw image data from source */
     images: {
         type: Array,
         default: [],
     },
 
+    /** Raw product options from source */
     options: {
         type: Array,
         default: [],
     },
 
+    /** Raw variant data from source */
     variants: {
         type: Array,
         default: [],
     },
 
+    /** Product media (images, videos) */
     media: {
         type: [MediaObject],
         default: [],
     },
 
+    /** Index of the default variant */
     default_variant_index: {
         type: Number,
         default: 0,
     },
 
+    /** @ref Collection — collections from source */
     collections: {
         type: [Schema.Types.ObjectId],
         default: [],
     },
 
+    /** Featured image */
     featured_image: {
         type: Schema.Types.Mixed,
         default: {},
     },
 
+    /** Product description in HTML from source */
     description_html: {
         type: String,
         trim: true
     },
 
+    /** Description */
     description: {
         type: String,
         trim: true
     },
 
+    /** Shopify online store URL */
     onlineStore_url: {
         type: String,
         trim: true,
     },
 
+    /** Product vendor */
     vendor: {
         type: String,
         trim: true,
     },
 
+    /** Product features HTML from source */
     features_html: {
         type: String,
         trim: true,
     },
 
+    /** Last sync timestamp */
     synced_at: {
         type: Date,
     },
 
+    /** SEO metadata */
     seo: {
         type: SeoObject,
         default: {},
     },
 
+    /** Tags */
     tags: {
         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/ProductReport.js

@@ -0,0 +1,104 @@
+const {Schema} = require('mongoose')
+
+
+/**
+ * Product violation reports submitted by customers or third parties
+ * (brand owners, lawyers) when a product has trademark, copyright,
+ * counterfeit, or other policy issues.
+ */
+const ProductReport = new Schema({
+    /** @ref Store */
+    store: {
+        type: Schema.Types.ObjectId,
+        index: true,
+        required: true,
+    },
+
+    /** @ref Product — the reported product */
+    product: {
+        type: Schema.Types.ObjectId,
+        index: true,
+        required: true,
+    },
+
+    /**
+     * Violation type:
+     * - trademark: brand name, logo, slogan infringement
+     * - copyright: images, designs, content infringement
+     * - counterfeit: fake or knock-off products
+     * - other: other policy violations
+     */
+    type: {
+        type: String,
+        trim: true,
+        required: true,
+        index: true,
+        enum: ['trademark', 'copyright', 'counterfeit', 'other'],
+    },
+
+    /**
+     * Report status:
+     * - pending: awaiting review
+     * - resolved: action taken (product removed/modified)
+     * - dismissed: report rejected as invalid
+     */
+    status: {
+        type: String,
+        trim: true,
+        default: 'pending',
+        index: true,
+        enum: ['pending', 'resolved', 'dismissed'],
+    },
+
+    /** Detailed description of the violation */
+    description: {
+        type: String,
+        trim: true,
+    },
+
+    /** Name of the person submitting the report */
+    reporter_name: {
+        type: String,
+        trim: true,
+    },
+
+    /** Contact email of the reporter */
+    reporter_email: {
+        type: String,
+        trim: true,
+        index: true,
+    },
+
+    /** Company/organization of the reporter (e.g. brand owner, law firm) */
+    reporter_company: {
+        type: String,
+        trim: true,
+    },
+
+    /** Admin notes on how the report was resolved */
+    resolution_note: {
+        type: String,
+        trim: true,
+    },
+
+    /** When the report was resolved or dismissed */
+    resolved_at: {
+        type: Date,
+    },
+
+    /** Last update timestamp */
+    updated_at: {
+        type: Date,
+        default: Date.now,
+    },
+
+    /** Record creation timestamp */
+    created_at: {
+        type: Date,
+        default: Date.now,
+        index: true,
+    },
+})
+
+
+module.exports = ProductReport

package/schemas/ProductTag.js

@@ -1,13 +1,16 @@
 const {Schema} = require('mongoose')
 
 
+/** Product tag with aggregated counts */
 const ProductTag = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Tag display text */
     value: {
         type: String,
         trim: true,
@@ -15,6 +18,7 @@ const ProductTag = new Schema({
         index: true,
     },
 
+    /** Normalized uppercase tag code */
     code: {
         type: String,
         trim: true,
@@ -23,23 +27,27 @@ const ProductTag = new Schema({
         uppercase: true,
     },
 
+    /** Number of products with this tag */
     products_count: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Total sales from products with this tag */
     sales_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
@@ -47,4 +55,3 @@ const ProductTag = new Schema({
 })
 
 module.exports = ProductTag
-

package/schemas/ProductType.js

@@ -1,13 +1,16 @@
 const {Schema} = require('mongoose')
 
 
+/** Product type classification */
 const ProductType = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Display name */
     name: {
         type: String,
         trim: true,
@@ -15,33 +18,39 @@ const ProductType = new Schema({
         index: true,
     },
 
+    /** Number of products */
     products_count: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Allow creating new products of this type */
     enable_create_product: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** @ref Product — template product for this type */
     base_product: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Sort order (lower = higher priority) */
     position: {
         type: Number,
         default: 999,
         index: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now
@@ -49,4 +58,3 @@ const ProductType = new Schema({
 })
 
 module.exports = ProductType
-

package/schemas/Publication.js

@@ -1,25 +1,30 @@
 const {Schema} = require('mongoose')
 
 
+/** Product publication channel (e.g. online store, POS) */
 const Publication = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify publication ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Display name */
     name: {
         type: String,
         trim: true,
         required: true,
     },
 
+    /** Channel status, e.g. 'active', 'inactive' */
     status: {
         type: String,
         trim: true,
@@ -28,11 +33,13 @@ const Publication = new Schema({
         default: 'active',
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now

package/schemas/RecentView.js

@@ -1,24 +1,29 @@
 const {Schema} = require('mongoose')
 
 
+/** Recently viewed products — TTL: 90 days */
 const RecentView = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Visitor session identifier */
     session_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         required: true,
     },
 
+    /** TTL: auto-expires after 90 days */
     created_at: {
         type: Date,
         default: Date.now,
@@ -29,4 +34,3 @@ const RecentView = new Schema({
 
 
 module.exports = RecentView
-

package/schemas/Review.js

@@ -1,19 +1,23 @@
 const {Schema} = require('mongoose')
 
 
+/** Product review from a customer */
 const Review = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Review moderation status, e.g. 'pending', 'approved', 'rejected' */
     status: {
         type: String,
         trim: true,
@@ -21,77 +25,91 @@ const Review = new Schema({
         default: 'pending',
     },
 
+    /** Reviewer name */
     name: {
         type: String,
         trim: true,
         required: true,
     },
 
+    /** Reviewer email */
     email: {
         type: String,
         trim: true,
     },
 
+    /** Rating value 1-5 */
     vote_value: {
         type: Number,
         default: 5,
         index: true,
     },
 
+    /** Review text content */
     content: {
         type: String,
         trim: true,
     },
 
+    /** @ref Image — review photo */
     image: {
         type: Schema.Types.ObjectId,
         index: true
     },
 
+    /** Whether the reviewer is a verified buyer */
     is_verified: {
         type: Boolean,
         default: true,
     },
 
+    /** Reviewer country code, e.g. 'US', 'VN' */
     country_code: {
         type: String,
         default: 'US',
         trim: true,
     },
 
+    /** Highlighted as a featured review */
     is_featured: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Import source, e.g. 'aliexpress', 'manual' */
     source: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** External review ID from import source */
     external_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** When the review was submitted */
     submitted_at: {
         type: Date,
         default: Date.now,
         index: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now,
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,
@@ -101,4 +119,3 @@ const Review = new Schema({
 
 
 module.exports = Review
-

package/schemas/SearchTerm.js

@@ -1,19 +1,23 @@
 const {Schema} = require('mongoose')
 
 
+/** Search term tracking from the storefront */
 const SearchTerm = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Search query entered by the visitor */
     term: {
         type: String,
         trim: true,
         required: true,
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,