@pintahub/database-schemas 4.5.0 → 4.6.0

package/schemas/StoreSetting.js

@@ -13,92 +13,117 @@ const FooterSetting = require('./types/FooterSetting')
 const FreeShippingSetting = require('./types/FreeShippingSetting')
 
 
+/** Store configuration and integrations */
 const StoreSetting = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Store contact email */
     contact_email: {
         type: String,
         trim: true,
     },
 
+    /** Brand color settings */
     brand: {
         type: BrandSettings,
     },
 
+    /** Store logo image */
     logo: {
         type: ImageObject,
     },
 
+    /** Description */
     description: {
         type: String,
         trim: true,
     },
 
+    /** Store physical address */
     address: {
         type: String,
         trim: true,
     },
 
+    /** Trustpilot review integration */
     trustpilot: {
         type: TrustpilotObject,
     },
 
+    /** Social media profile links */
     socials: {
         type: SocialsObject,
     },
 
+    /** Merchize print-on-demand integration */
     merchize: {
         type: MerchizeSettings,
     },
 
+    /** Google Analytics tracking */
     google_analytics: {
         type: GoogleAnalytics,
     },
 
+    /** Klaviyo email marketing integration */
     klaviyo: {
         type: KlaviyoObject,
     },
 
+    /** Facebook pixel tracking */
     facebook: {
         type: FacebookObject,
     },
 
+    /** Top bar announcement settings */
     top_bar: {
         type: TopBarSettings,
     },
 
+    /** Disable add-to-cart button globally */
     disable_atc: {
         type: Boolean,
         default: false,
     },
 
+    /** DMCA protection badge */
     dmca: {
         type: DMCASetting,
     },
 
+    /** Footer content settings */
     footer: {
         type: FooterSetting,
     },
 
+    /** Free shipping threshold settings */
     free_shipping: {
         type: FreeShippingSetting,
     },
 
+    /**
+     * Product tags display mode:
+     * - show: display tags on product pages
+     * - hide: hide tags
+     */
     tags_mode: {
         type: String,
         trim: true,
         enum: ['show', 'hide']
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now
@@ -106,4 +131,3 @@ const StoreSetting = new Schema({
 })
 
 module.exports = StoreSetting
-

package/schemas/TrackPage.js

@@ -1,41 +1,49 @@
 const {Schema} = require('mongoose')
 
 
+/** Page access log — TTL: 7 days */
 const TrackPage = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** HTTP response status code */
     status_code: {
         type: Number,
     },
 
+    /** IP address */
     ip: {
         type: String,
         trim: true,
     },
 
+    /** Browser user agent string */
     user_agent: {
         type: String,
         trim: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** TTL: auto-expires after 7 days */
     created_at: {
         type: Date,
         default: Date.now,
-        expires: 3_600 * 24 * 7//2 days
+        expires: 3_600 * 24 * 7//7 days
     }
 })
 

package/schemas/TransferJob.js

@@ -1,39 +1,47 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded product field overrides for transfer */
 const OverrideProduct = new Schema({
     _id: false,
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
     },
 })
 
+/** Product transfer job between stores */
 const TransferJob = new Schema({
+    /** @ref Store — source store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Product — source product to transfer */
     product: {
         type: Schema.Types.ObjectId,
         required: true,
         index: true,
     },
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** @ref Store — destination store */
     destination_store: {
         type: Schema.Types.ObjectId,
         required: true,
     },
 
+    /** Transfer status, e.g. 'pending', 'processing', 'completed', 'failed' */
     status: {
         type: String,
         trim: true,
@@ -41,69 +49,83 @@ const TransferJob = new Schema({
         index: true,
     },
 
+    /** @ref Product — created product in destination store */
     destination_product: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Product field overrides for the destination */
     override_product: {
         type: OverrideProduct,
         default: {},
     },
 
+    /** Transfer step statuses */
     steps: {
         type: Schema.Types.Mixed,
         default: {}
     },
 
+    /** Current processing step name */
     current_step: {
         type: String,
         trim: true,
     },
 
+    /** Media files to transfer */
     media: {
         type: [Schema.Types.Mixed],
         default: []
     },
 
+    /** When processing started */
     processed_at: {
         type: Date,
         index: true,
     },
 
+    /** When job completed */
     completed_at: {
         type: Date,
     },
 
+    /** When job failed */
     failed_at: {
         type: Date,
     },
 
+    /** Processing retry count */
     attempts: {
         type: Number,
         default: 0,
         index: true
     },
 
+    /** Total processing time in milliseconds */
     total_time: {
         type: Number,
         default: 0,
     },
 
+    /** Error message if failed */
     error_message: {
         type: String,
         trim: true,
     },
 
+    /** Detailed error data */
     errors: {
         type: Schema.Types.Mixed,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now

package/schemas/User.js

@@ -1,30 +1,36 @@
 const {Schema} = require('mongoose')
 
 
+/** User-to-Store relationship (maps accounts to stores with roles) */
 const User = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Account */
     account: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** User role in this store, e.g. 'seller', 'admin' */
     role: {
         type: String,
         trim: true,
         default: 'seller'
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now

package/schemas/WebhookEvent.js

@@ -1,35 +1,42 @@
 const {Schema} = require('mongoose')
 
 
+/** Webhook event queue — TTL: 2 days */
 const WebhookEvent = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Event topic, e.g. 'orders/create', 'products/update' */
     topic: {
         type: String,
         index: true,
         required: true,
     },
 
+    /** Event payload data */
     payload: {
         type: Schema.Types.Mixed,
         default: {},
     },
 
+    /** Whether this is a test webhook */
     is_test: {
         type: Boolean,
         default: false,
     },
 
+    /** Processing status, e.g. 'pending', 'processed' */
     status: {
         type: String,
         default: 'pending',
         index: true,
     },
 
+    /** TTL: auto-expires after 2 days */
     created_at: {
         type: Date,
         default: Date.now,
@@ -40,4 +47,3 @@ const WebhookEvent = new Schema({
 
 
 module.exports = WebhookEvent
-

package/schemas/products/MediaObject.js

@@ -1,37 +1,45 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded product media sub-document */
 const MediaObject = new Schema({
     _id: false,
 
+    /** External identifier */
     id: {
         type: String,
         trim: true,
     },
 
+    /** URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** Alternative text for accessibility */
     alt_text: {
         type: String,
         trim: true,
     },
 
+    /** Width in pixels */
     width: {
         type: Number,
     },
 
+    /** Height in pixels */
     height: {
         type: Number,
     },
 
+    /** MIME type */
     mime_type: {
         type: String,
         trim: true,
     },
 
+    /** Media content type, e.g. 'IMAGE', 'VIDEO' */
     content_type: {
         type: String,
         trim: true,

package/schemas/products/SeoObject.js

@@ -1,14 +1,17 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded SEO metadata sub-document */
 const SeoObject = new Schema({
     _id: false,
 
+    /** Display title */
     title: {
         type: String,
         trim: true,
     },
 
+    /** Description */
     description: {
         type: String,
         trim: true,

package/schemas/products/VideoObject.js

@@ -1,27 +1,33 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded product video sub-document */
 const VideoObject = new Schema({
     _id: false,
 
+    /** External identifier */
     id: {
         type: String,
         trim: true,
     },
 
+    /** URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** Width in pixels */
     width: {
         type: Number,
     },
 
+    /** Height in pixels */
     height: {
         type: Number,
     },
 
+    /** MIME type */
     mime_type: {
         type: String,
         trim: true,

package/schemas/types/BrandSettings.js

@@ -1,14 +1,17 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded store brand color settings */
 const BrandSettings = new Schema({
     _id: false,
 
+    /** Primary brand color (hex) */
     primary_color: {
         type: String,
         trim: true,
     },
 
+    /** Secondary brand color (hex) */
     secondary_color: {
         type: String,
         trim: true,

package/schemas/types/DMCASetting.js

@@ -1,14 +1,17 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded DMCA protection settings */
 const DMCASetting = new Schema({
     _id: false,
 
+    /** DMCA status: 'enabled' or 'disabled' */
     status: {
         type: String,
         trim: true
     },
 
+    /** DMCA badge/certificate URL */
     url: {
         type: String,
         trim: true,

package/schemas/types/FacebookObject.js

@@ -1,14 +1,17 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded Facebook pixel integration settings */
 const FacebookObject = new Schema({
     _id: false,
 
+    /** Facebook Pixel ID */
     pixel_id: {
         type: String,
         trim: true,
     },
 
+    /** Facebook Conversions API access token */
     access_token: {
         type: String,
         trim: true,

package/schemas/types/FooterSetting.js

@@ -1,9 +1,11 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded store footer settings */
 const FooterSetting = new Schema({
     _id: false,
 
+    /** Footer display content */
     text: {
         type: String,
         trim: true,

package/schemas/types/FreeShippingSetting.js

@@ -1,15 +1,18 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded free shipping threshold settings */
 const FreeShippingSetting = new Schema({
     _id: false,
 
+    /** 'enabled' or 'disabled' */
     status: {
         type: String,
         trim: true,
         default: 'disabled',
     },
 
+    /** Minimum order amount to qualify for free shipping */
     threshold: {
         type: Number,
     }

package/schemas/types/GoogleAnalytics.js

@@ -1,9 +1,11 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded Google Analytics settings */
 const GoogleAnalytics = new Schema({
     _id: false,
 
+    /** GA4 Measurement ID, e.g. 'G-XXXXXXXXXX' */
     measurement_id: {
         type: String,
         trim: true,

package/schemas/types/KlaviyoObject.js

@@ -1,14 +1,17 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded Klaviyo email marketing settings */
 const KlaviyoObject = new Schema({
     _id: false,
 
+    /** Klaviyo public API key */
     public_api_key: {
         type: String,
         trim: true,
     },
 
+    /** Integration status: 'enabled' or 'disabled' */
     status: {
         type: String,
         trim: true,

package/schemas/types/MerchizeSettings.js

@@ -1,14 +1,17 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded Merchize print-on-demand integration settings */
 const MerchizeSettings = new Schema({
     _id: false,
 
+    /** Merchize API base URL */
     base_url: {
         type: String,
         trim: true,
     },
 
+    /** API access token */
     access_token: {
         type: String,
         trim: true,

package/schemas/types/SocialsObject.js

@@ -1,39 +1,47 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded social media profile links */
 const SocialsObject = new Schema({
     _id: false,
 
+    /** Facebook profile URL */
     facebook: {
         type: String,
         trim: true,
     },
 
+    /** Twitter profile URL */
     twitter: {
         type: String,
         trim: true,
     },
 
+    /** Instagram profile URL */
     instagram: {
         type: String,
         trim: true,
     },
 
+    /** Pinterest profile URL */
     pinterest: {
         type: String,
         trim: true,
     },
 
+    /** YouTube channel URL */
     youtube: {
         type: String,
         trim: true,
     },
 
+    /** LinkedIn profile URL */
     linkedin: {
         type: String,
         trim: true,
     },
 
+    /** TikTok profile URL */
     tiktok: {
         type: String,
         trim: true,

package/schemas/types/TopBarSettings.js

@@ -1,9 +1,11 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded top bar announcement settings */
 const TopBarSettings = new Schema({
     _id: false,
 
+    /** Announcement display text */
     content: {
         type: String,
         trim: true,